1 \chapter{New Features in 5.2.0}
2 This chapter presents the new features that have been added to the current
3 Community version of Bacula that is now released.
5 There are additional features (plugins) available in the Enterprise version
6 that are described in another chapter. A subscription to Bacula Systems
7 is required for the Enterprise version.
9 \section{LZO Compression}
11 LZO compression was added in the Unix File Daemon. From the user point of view, it
12 works like the GZIP compression (just replace {\bf compression=GZIP} with {\bf
18 Options { compression=LZO }
24 LZO provides much faster compression and decompression speed but lower
25 compression ratio than GZIP. It is a good option when you backup to disk. For
26 tape, the built-in compression may be a better option.
28 LZO is a good altenative for GZIP1 when you don't want to slow down your
29 backup. On a modern CPU it should be able to run almost as fast as:
32 \item your client can read data from disk. Unless you have very fast disks like
33 SSD or large/fast RAID array.
34 \item the data transfers between the file daemon and the storage daemon even on
38 Note that bacula only use one compression level LZO1X-1.
41 The code for this feature was contributed by Laurent Papier.
43 \section{New Tray Monitor}
45 Since the old integrated Windows tray monitor doesn't work with
46 recent Windows versions, we have written a new Qt Tray Monitor that is available
47 for both Linux and Windows. In addition to all the previous features,
48 this new version allows you to run Backups from
49 the tray monitor menu.
53 \includegraphics[width=10cm]{\idir tray-monitor}
54 \label{fig:traymonitor}
55 \caption{New tray monitor}
60 \includegraphics[width=10cm]{\idir tray-monitor1}
61 \label{fig:traymonitor1}
62 \caption{Run a Job through the new tray monitor}
66 To be able to run a job from the tray monitor, you need to
67 allow specific commands in the Director monitor console:
72 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
73 ClientACL = *all* # you can restrict to a specific host
85 This project was funded by Bacula Systems and is available with Bacula
86 the Enterprise Edition and the Community Edition.
88 \section{Purge Migration Job}
90 The new {\bf Purge Migration Job} directive may be added to the Migration
91 Job definition in the Director's configuration file. When it is enabled
92 the Job that was migrated during a migration will be purged at
93 the end of the migration job.
101 Client = localhost-fd
104 Storage = DiskChanger
107 Selection Pattern = ".*Save"
109 Purge Migrated Job = yes
115 This project was submited by Dunlap Blake; testing and documentation was funded
118 \section{Changes in Bvfs (Bacula Virtual FileSystem)}
120 Bat has now a bRestore panel that uses Bvfs to display files and
125 \includegraphics[width=12cm]{\idir bat-brestore}
126 \label{fig:batbrestore}
127 \caption{Bat Brestore Panel}
130 \texttt{Important}, the Bvfs module does not yet work correctly with BaseJobs,
131 Copy and Migration jobs.
134 This project was funded by Bacula Systems.
136 \subsection*{General notes}
139 \item All fields are separated by a tab
140 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
141 records in very big directories
142 \item All operations (except cache creation) are designed to run instantly
143 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
144 can contribute new faster SQL queries we will be happy, else don't complain
146 \item The cache creation is dependent of the number of directories. As Bvfs
147 shares information accross jobs, the first creation can be slow
148 \item All fields are separated by a tab
149 \item Due to potential encoding problem, it's advised to allways use pathid in
153 \subsection*{Get dependent jobs from a given JobId}
155 Bvfs allows you to query the catalog against any combination of jobs. You
156 can combine all Jobs and all FileSet for a Client in a single session.
158 To get all JobId needed to restore a particular job, you can use the
159 \texttt{.bvfs\_get\_jobids} command.
162 .bvfs_get_jobids jobid=num [all]
166 .bvfs_get_jobids jobid=10
168 .bvfs_get_jobids jobid=10 all
172 In this example, a normal restore will need to use JobIds 1,2,5,10 to
173 compute a complete restore of the system.
175 With the \texttt{all} option, the Director will use all defined FileSet for
178 \subsection*{Generating Bvfs cache}
180 The \texttt{.bvfs\_update} command computes the directory cache for jobs
181 specified in argument, or for all jobs if unspecified.
184 .bvfs_update [jobid=numlist]
189 .bvfs_update jobid=1,2,3
192 You can run the cache update process in a RunScript after the catalog backup.
194 \subsection*{Get all versions of a specific file}
196 Bvfs allows you to find all versions of a specific file for a given Client with
197 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
198 function uses only PathId and FilenameId. The jobid argument is mandatory but
202 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
203 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
204 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
211 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
212 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
215 \subsection*{List directories}
217 Bvfs allows you to list directories in a specific path.
219 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
220 PathId FilenameId FileId JobId LStat Path
221 PathId FilenameId FileId JobId LStat Path
222 PathId FilenameId FileId JobId LStat Path
226 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
227 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
228 listed is a directory.
231 .bvfs_lsdirs pathid=4 jobid=1,11,12
232 4 0 0 0 A A A A A A A A A A A A A A .
233 5 0 0 0 A A A A A A A A A A A A A A ..
234 3 0 0 0 A A A A A A A A A A A A A A regress/
237 In this example, to list directories present in \texttt{regress/}, you can use
239 .bvfs_lsdirs pathid=3 jobid=1,11,12
240 3 0 0 0 A A A A A A A A A A A A A A .
241 4 0 0 0 A A A A A A A A A A A A A A ..
242 2 0 0 0 A A A A A A A A A A A A A A tmp/
245 \subsection*{List files}
247 Bvfs allows you to list files in a specific path.
249 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
250 PathId FilenameId FileId JobId LStat Path
251 PathId FilenameId FileId JobId LStat Path
252 PathId FilenameId FileId JobId LStat Path
256 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
257 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
261 .bvfs_lsfiles pathid=4 jobid=1,11,12
262 4 0 0 0 A A A A A A A A A A A A A A .
263 5 0 0 0 A A A A A A A A A A A A A A ..
264 1 0 0 0 A A A A A A A A A A A A A A regress/
267 In this example, to list files present in \texttt{regress/}, you can use
269 .bvfs_lsfiles pathid=1 jobid=1,11,12
270 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
271 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
272 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
273 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
274 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
277 \subsection*{Restore set of files}
279 Bvfs allows you to create a SQL table that contains files that you want to
280 restore. This table can be provided to a restore command with the file option.
283 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
285 restore file=?b2num ...
288 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
289 select all files. This query could be time consuming.
291 \texttt{hardlink} list is always composed of a serie of two numbers (jobid,
292 fileindex). This information can be found in the LinkFI field of the LStat
295 The \texttt{path} argument represents the name of the table that Bvfs will
296 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
297 b2 and followed by digits).
302 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
306 \subsection*{Cleanup after Restore}
308 To drop the table used by the restore command, you can use the
309 \texttt{.bvfs\_cleanup} command.
312 .bvfs_cleanup path=b20001
315 \section{Changes in the Pruning Algorithm}
317 We rewrote the job pruning algorithm in this version. Previously, in some users
318 reported that the pruning process at the end of jobs was very long. It should
319 not be longer the case. Now, Bacula won't prune automatically a Job if this
320 particular Job is needed to restore data. Example:
324 JobId: 2 Level: Incremental
325 JobId: 3 Level: Incremental
326 JobId: 4 Level: Differential
327 .. Other incrementals up to now
330 In this example, if the Job Retention defined in the Pool or in the Client
331 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
332 detect that JobId 1 and 4 are essential to restore data at the current state
333 and will prune only JobId 2 and 3.
335 \texttt{Important}, this change affect only the automatic pruning step after a
336 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
337 \texttt{VolumeRetention} period, important jobs can be pruned.
339 \section{Ability to Verify any specified Job}
340 You now have the ability to tell Bacula which Job should verify instead of
341 automatically verify just the last one.
343 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
345 To verify a given job, just specify the Job jobid in argument when starting the
348 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
350 JobName: VerifyVolume
351 Level: VolumeToCatalog
354 Pool: Default (From Job resource)
355 Storage: File (From Job resource)
356 Verify Job: VerifyVol.2010-09-08_14.17.17_03
357 Verify List: /tmp/regress/working/VerifyVol.bsr
358 When: 2010-09-08 14:17:31
360 OK to run? (yes/mod/no):
364 This project was funded by Bacula Systems and is available with Bacula
365 Enterprise Edition and Community Edition.
367 \section{Additions to RunScript variables}
368 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
369 command. The Client address is now available through \%h.
372 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
375 %\section{Changes in drivetype.exe}
377 %Now the \texttt{drivetype.exe} program allows you to list all local hard
378 %drives. It can help to build dynamic FileSet on Windows.
381 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
385 \section{Additions to the Plugin API}
386 The bfuncs structure has been extended to include a number of
390 The bFuncs structure defines the callback entry points within Bacula
391 that the plugin can use register events, get Bacula values, set
392 Bacula values, and send messages to the Job output or debug output.
394 The exact definition as of this writing is:
396 typedef struct s_baculaFuncs {
399 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
400 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
401 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
402 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
403 int type, utime_t mtime, const char *fmt, ...);
404 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
405 int level, const char *fmt, ...);
406 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
408 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
410 /* New functions follow */
411 bRC (*AddExclude)(bpContext *ctx, const char *file);
412 bRC (*AddInclude)(bpContext *ctx, const char *file);
413 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
414 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
415 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
416 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
422 \item [AddExclude] can be called to exclude a file. The file
423 string passed may include wildcards that will be interpreted by
424 the {\bf fnmatch} subroutine. This function can be called
425 multiple times, and each time the file specified will be added
426 to the list of files to be excluded. Note, this function only
427 permits adding excludes of specific file or directory names,
428 or files matched by the rather simple fnmatch mechanism.
429 See below for information on doing wild-card and regex excludes.
431 \item [NewInclude] can be called to create a new Include block. This
432 block will be added before any user defined Include blocks. This
433 function can be called multiple times, but each time, it will create
434 a new Include section (not normally needed). This function should
435 be called only if you want to add an entirely new Include block.
437 \item [AddInclude] can be called to add new files/directories to
438 be included. They are added to the current Include block. If
439 NewInclude has not been included, the current Include block is
440 the last one that the user created. This function
441 should be used only if you want to add totally new files/directories
442 to be included in the backup.
444 \item [NewOptions] adds a new Options block to the current Include
445 in front of any other Options blocks. This permits the plugin to
446 add exclude directives (wild-cards and regexes) in front of the
447 user Options, and thus prevent certain files from being backed up.
448 This can be useful if the plugin backs up files, and they should
449 not be also backed up by the main Bacula code. This function
450 may be called multiple times, and each time, it creates a new
451 prepended Options block. Note: normally you want to call this
452 entry point prior to calling AddOptions, AddRegex, or AddWild.
454 \item [AddOptions] allows the plugin it set options in
455 the current Options block, which is normally created with the
456 NewOptions call just prior to adding Include Options.
457 The permitted options are passed as a character string, where
458 each character has a specific meaning as defined below:
461 \item [a] always replace files (default).
462 \item [e] exclude rather than include.
463 \item [h] no recursion into subdirectories.
464 \item [H] do not handle hard links.
465 \item [i] ignore case in wildcard and regex matches.
466 \item [M] compute an MD5 sum.
467 \item [p] use a portable data format on Windows (not recommended).
468 \item [R] backup resource forks and Findr Info.
469 \item [r] read from a fifo
470 \item [S1] compute an SHA1 sum.
471 \item [S2] compute an SHA256 sum.
472 \item [S3] comput an SHA512 sum.
473 \item [s] handle sparse files.
474 \item [m] use st\_mtime only for file differences.
475 \item [k] restore the st\_atime after accessing a file.
476 \item [A] enable ACL backup.
477 \item [Vxxx:] specify verify options. Must terminate with :
478 \item [Cxxx:] specify accurate options. Must terminate with :
479 \item [Jxxx:] specify base job Options. Must terminate with :
480 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
482 \item [Zn] specify gzip compression level n.
483 \item [K] do not use st\_atime in backup decision.
484 \item [c] check if file changed during backup.
485 \item [N] honor no dump flag.
486 \item [X] enable backup of extended attributes.
489 \item [AddRegex] adds a regex expression to the current Options block.
490 The fillowing options are permitted:
492 \item [ ] (a blank) regex applies to whole path and filename.
493 \item [F] regex applies only to the filename (directory or path stripped).
494 \item [D] regex applies only to the directory (path) part of the name.
497 \item [AddWild] adds a wildcard expression to the current Options block.
498 The fillowing options are permitted:
500 \item [ ] (a blank) regex applies to whole path and filename.
501 \item [F] regex applies only to the filename (directory or path stripped).
502 \item [D] regex applies only to the directory (path) part of the name.
505 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
506 that can use Accurate code to compare the file information in argument with
507 the previous file information. The \texttt{delta\_seq} attribute of the
508 \texttt{save\_pkt} will be updated, and the call will return
509 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
514 \subsection{Bacula events}
515 The list of events has been extended to include:
521 bEventStartBackupJob = 3,
522 bEventEndBackupJob = 4,
523 bEventStartRestoreJob = 5,
524 bEventEndRestoreJob = 6,
525 bEventStartVerifyJob = 7,
526 bEventEndVerifyJob = 8,
527 bEventBackupCommand = 9,
528 bEventRestoreCommand = 10,
533 bEventCancelCommand = 13,
534 bEventVssBackupAddComponents = 14,
535 bEventVssRestoreLoadComponentMetadata = 15,
536 bEventVssRestoreSetComponentsSelected = 16,
537 bEventRestoreObject = 17,
538 bEventEndFileSet = 18,
539 bEventPluginCommand = 19,
540 bEventVssBeforeCloseRestore = 20,
541 bEventVssPrepareSnapshot = 21
547 \item [bEventCancelCommand] is called whenever the currently
548 running Job is cancelled */
550 \item [bEventVssBackupAddComponents]
552 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
553 provides a char[27] table where the plugin can add Windows drives that will
554 be used during the Job. You need to add them without duplicates, and you can
555 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
559 \section{ACL enhancements}
561 The following enhancements are made to the Bacula Filed with regards to
562 Access Control Lists (ACLs)
565 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
566 POSIX and NFSv4 ACLs.
567 \item Added support for new acl types on FreeBSD 8.1 and later which supports
568 POSIX and NFSv4 ACLs.
569 \item Some generic cleanups for internal ACL handling.
570 \item Fix for acl storage on OSX
571 \item Cleanup of configure checks for ACL detection, now configure only
572 tests for a certain interface type based on the operating system
573 this should give less false possitives on detection. Also when acls
574 are detected no other acl checks are performed anymore.
578 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
579 and is available with Bacula Enterprise Edition and Community Edition.
581 \section{XATTR enhancements}
583 The following enhancements are made to the Bacula Filed with regards to
584 Extended Attributes (XATTRs)
587 \item Added support for IRIX extended attributes using the attr\_get interface.
588 \item Added support for Tru64 (OSF1) extended attributes using the
589 getproplist interface.
590 \item Added support for AIX extended attributes available in AIX 6.x
591 and higher using the listea/getea/setea interface.
592 \item Added some debugging to generic xattr code so it easier to
594 \item Cleanup of configure checks for XATTR detection, now configure only
595 tests for a certain interface type based on the operating system
596 this should give less false possitives on detection. Also when xattrs
597 are detected no other xattr checks are performed anymore.
601 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
602 and is available with Bacula Enterprise Edition and Community Edition.
604 \section{Class Based Database Backend Drivers}
606 All current database backend drivers for catalog information are rewritten
607 to use a set of multi inherited C++ classes which abstract the specific
608 database specific internals and make sure we have a more stable generic
609 interface with the rest of sql code. From now on there is a strict boundery
610 between the SQL code and the low-level database functions. This new interface
611 should also make it easier to add a new backend for a currently unsupported
612 database. As part of the rewrite the SQLite 2 code was removed (e.g. only
613 SQLite 3 is now supported). An extra bonus of the new code is that you can
614 configure multiple backends in the configure and build all backends in one
615 compile session and select the correct database backend at install time.
616 This should make it a lot easier for packages maintainers.
619 We also added cursor support for PostgreSQL backend, this improves memory usage
620 for large installation.
623 This project was implemented by Planets Communications B.V. and ELM Consultancy B.V.
624 and Bacula Systems and is available with both the Bacula Enterprise Edition and
625 the Community Edition.
627 \section{Hash List Enhancements}
629 The htable hash table class has been extended with extra hash functions for
630 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
631 Also the hash table initialization routines have been enhanced with
632 support for passing a hint as to the number of initial pages to use
633 for the size of the hash table. Until now the hash table always used
634 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
635 cache have been rewritten to use the new htable class with a small memory
639 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
640 and Bacula Systems and is available with Bacula Enterprise Edition and
645 %%% =====================================================================
650 \chapter{Release Version 5.0.3}
652 There are no new features in version 5.0.2. This version simply fixes a
653 number of bugs found in version 5.0.1 during the onging development
656 \chapter{Release Version 5.0.2}
658 There are no new features in version 5.0.2. This version simply fixes a
659 number of bugs found in version 5.0.1 during the onging development
665 \chapter{New Features in 5.0.1}
667 This chapter presents the new features that are in the released Bacula version
668 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
669 the onging development process.
671 \section{Truncate Volume after Purge}
672 \label{sec:actiononpurge}
674 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
675 the volume when it is purged with the new command \texttt{purge volume
676 action}. It is useful to prevent disk based volumes from consuming too much
682 Action On Purge = Truncate
687 As usual you can also set this property with the \texttt{update volume} command
689 *update volume=xxx ActionOnPurge=Truncate
690 *update volume=xxx actiononpurge=None
693 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
694 following command in interactive mode or in a RunScript as shown after:
696 *purge volume action=truncate storage=File allpools
697 # or by default, action=all
698 *purge volume action storage=File pool=Default
701 This is possible to specify the volume name, the media type, the pool, the
702 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
703 idle when you decide to run this command.
712 Console = "purge volume action=all allpools storage=File"
717 \textbf{Important note}: This feature doesn't work as
718 expected in version 5.0.0. Please do not use it before version 5.0.1.
720 \section{Allow Higher Duplicates}
721 This directive did not work correctly and has been depreciated
722 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
723 file as it will be removed in a future rlease.
725 \section{Cancel Lower Level Duplicates}
726 This directive was added in Bacula version 5.0.1. It compares the
727 level of a new backup job to old jobs of the same name, if any,
728 and will kill the job which has a lower level than the other one.
729 If the levels are the same (i.e. both are Full backups), then
730 nothing is done and the other Cancel XXX Duplicate directives
733 \chapter{New Features in 5.0.0}
735 \section{Maximum Concurrent Jobs for Devices}
736 \label{sec:maximumconcurrentjobdevice}
738 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
739 Daemon configuration permits setting the maximum number of Jobs that can
740 run concurrently on a specified Device. Using this directive, it is
741 possible to have different Jobs using multiple drives, because when the
742 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
743 Jobs on any other available compatible drive. This facilitates writing to
744 multiple drives with multiple Jobs that all use the same Pool.
746 This project was funded by Bacula Systems.
748 \section{Restore from Multiple Storage Daemons}
749 \index[general]{Restore}
751 Previously, you were able to restore from multiple devices in a single Storage
752 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
753 example, if your full backup runs on a Storage Daemon with an autochanger, and
754 your incremental jobs use another Storage Daemon with lots of disks, Bacula
755 will switch automatically from one Storage Daemon to an other within the same
758 You must upgrade your File Daemon to version 3.1.3 or greater to use this
761 This project was funded by Bacula Systems with the help of Equiinet.
763 \section{File Deduplication using Base Jobs}
764 A base job is sort of like a Full save except that you will want the FileSet to
765 contain only files that are unlikely to change in the future (i.e. a snapshot
766 of most of your system after installing it). After the base job has been run,
767 when you are doing a Full save, you specify one or more Base jobs to be used.
768 All files that have been backed up in the Base job/jobs but not modified will
769 then be excluded from the backup. During a restore, the Base jobs will be
770 automatically pulled in where necessary.
772 This is something none of the competition does, as far as we know (except
773 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
774 win for the user, it makes Bacula stand out as offering a unique optimization
775 that immediately saves time and money. Basically, imagine that you have 100
776 nearly identical Windows or Linux machine containing the OS and user files.
777 Now for the OS part, a Base job will be backed up once, and rather than making
778 100 copies of the OS, there will be only one. If one or more of the systems
779 have some files updated, no problem, they will be automatically restored.
781 See the \ilink{Base Job Chapter}{basejobs} for more information.
783 This project was funded by Bacula Systems.
785 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
786 \index[dir]{AllowCompression}
788 This new directive may be added to Storage resource within the Director's
789 configuration to allow users to selectively disable the client compression for
790 any job which writes to this storage resource.
796 Address = ultrium-tape
797 Password = storage_password # Password for Storage Daemon
800 AllowCompression = No # Tape drive has hardware compression
803 The above example would cause any jobs running with the UltriumTape storage
804 resource to run without compression from the client file daemons. This
805 effectively overrides any compression settings defined at the FileSet level.
807 This feature is probably most useful if you have a tape drive which supports
808 hardware compression. By setting the \texttt{AllowCompression = No} directive
809 for your tape drive storage resource, you can avoid additional load on the file
810 daemon and possibly speed up tape backups.
812 This project was funded by Collaborative Fusion, Inc.
814 \section{Accurate Fileset Options}
815 \label{sec:accuratefileset}
817 In previous versions, the accurate code used the file creation and modification
818 times to determine if a file was modified or not. Now you can specify which
819 attributes to use (time, size, checksum, permission, owner, group, \dots),
820 similar to the Verify options.
836 \item {\bf i} compare the inodes
837 \item {\bf p} compare the permission bits
838 \item {\bf n} compare the number of links
839 \item {\bf u} compare the user id
840 \item {\bf g} compare the group id
841 \item {\bf s} compare the size
842 \item {\bf a} compare the access time
843 \item {\bf m} compare the modification time (st\_mtime)
844 \item {\bf c} compare the change time (st\_ctime)
845 \item {\bf d} report file size decreases
846 \item {\bf 5} compare the MD5 signature
847 \item {\bf 1} compare the SHA1 signature
850 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
851 the File Daemon will have to read all files even if they normally would not
852 be saved. This increases the I/O load, but also the accuracy of the
853 deduplication. By default, Bacula will check modification/creation time
856 This project was funded by Bacula Systems.
858 \section{Tab-completion for Bconsole}
859 \label{sec:tabcompletion}
861 If you build \texttt{bconsole} with readline support, you will be able to use
862 the new auto-completion mode. This mode supports all commands, gives help
863 inside command, and lists resources when required. It works also in the restore
866 To use this feature, you should have readline development package loaded on
867 your system, and use the following option in configure.
869 ./configure --with-readline=/usr/include/readline --disable-conio ...
872 The new bconsole won't be able to tab-complete with older directors.
874 This project was funded by Bacula Systems.
876 \section{Pool File and Job Retention}
877 \label{sec:poolfilejobretention}
879 We added two new Pool directives, \texttt{FileRetention} and
880 \texttt{JobRetention}, that take precedence over Client directives of the same
881 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
882 example, you can decide to increase Retention times for Archive or OffSite Pool.
884 It seems obvious to us, but apparently not to some users, that given the
885 definition above that the Pool File and Job Retention periods is a global
886 override for the normal Client based prunning, which means that when the
887 Job is prunned, the prunning will apply globally to that particular Job.
889 Currently, there is a bug in the implementation that causes any Pool
890 retention periods specified to apply to {\bf all} Pools for that
891 particular Client. Thus we suggest that you avoid using these two
892 directives until this implementation problem is corrected.
894 \section{Read-only File Daemon using capabilities}
895 \label{sec:fdreadonly}
896 This feature implements support of keeping \textbf{ReadAll} capabilities after
897 UID/GID switch, this allows FD to keep root read but drop write permission.
899 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
900 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
903 root@localhost:~# bacula-fd -k -u nobody -g nobody
906 The code for this feature was contributed by our friends at AltLinux.
911 To help developers of restore GUI interfaces, we have added new \textsl{dot
912 commands} that permit browsing the catalog in a very simple way.
915 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
916 the Bvfs cache in the catalog. You need to run it before any access to the
919 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
920 will list all directories in the specified \texttt{path} or
921 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
922 encoding of path/filenames.
924 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
925 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
926 \texttt{pathid} avoids problems with character encoding.
929 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
930 data that will be displayed.
933 * .bvfs_update jobid=1,2
935 * .bvfs_lsdir path=/ jobid=1,2
938 This project was funded by Bacula Systems.
940 \section{Testing your Tape Drive}
941 \label{sec:btapespeed}
943 To determine the best configuration of your tape drive, you can run the new
944 \texttt{speed} command available in the \texttt{btape} program.
946 This command can have the following arguments:
948 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
949 (between 1 and 5GB). This counter is in GB.
950 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
951 of data should be greater than your memory ($file\_size*nb\_file$).
952 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
954 \item[\texttt{skip\_random}] This flag permits to skip tests with random
956 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
957 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
962 *speed file_size=3 skip_raw
963 btape.c:1078 Test with zero data and bacula block structure.
964 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
965 ++++++++++++++++++++++++++++++++++++++++++
966 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
967 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
969 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
971 btape.c:1090 Test with random data, should give the minimum throughput.
972 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
973 +++++++++++++++++++++++++++++++++++++++++++
974 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
975 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
976 +++++++++++++++++++++++++++++++++++++++++++
978 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
982 When using compression, the random test will give your the minimum throughput
983 of your drive . The test using constant string will give you the maximum speed
984 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
986 You can change the block size in the Storage Daemon configuration file.
988 \section{New {\bf Block Checksum} Device Directive}
989 You may now turn off the Block Checksum (CRC32) code
990 that Bacula uses when writing blocks to a Volume. This is
997 doing so can reduce the Storage daemon CPU usage slightly. It
998 will also permit Bacula to read a Volume that has corrupted data.
1000 The default is {\bf yes} -- i.e. the checksum is computed on write
1001 and checked on read.
1003 We do not recommend to turn this off particularly on older tape
1004 drives or for disk Volumes where doing so may allow corrupted data
1007 \section{New Bat Features}
1009 Those new features were funded by Bacula Systems.
1011 \subsection{Media List View}
1013 By clicking on ``Media'', you can see the list of all your volumes. You will be
1014 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1015 in the table. The old ``Media'' view is now known as ``Pool''.
1016 \begin{figure}[htbp]
1018 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
1019 \label{fig:mediaview}
1023 \subsection{Media Information View}
1025 By double-clicking on a volume (on the Media list, in the Autochanger content
1026 or in the Job information panel), you can access a detailed overview of your
1027 Volume. (cf \ref{fig:mediainfo}.)
1028 \begin{figure}[htbp]
1030 \includegraphics[width=13cm]{\idir bat11.eps}
1031 \caption{Media information}
1032 \label{fig:mediainfo}
1035 \subsection{Job Information View}
1037 By double-clicking on a Job record (on the Job run list or in the Media
1038 information panel), you can access a detailed overview of your Job. (cf
1040 \begin{figure}[htbp]
1042 \includegraphics[width=13cm]{\idir bat12.eps}
1043 \caption{Job information}
1047 \subsection{Autochanger Content View}
1049 By double-clicking on a Storage record (on the Storage list panel), you can
1050 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
1051 \begin{figure}[htbp]
1053 \includegraphics[width=13cm]{\idir bat13.eps}
1054 \caption{Autochanger content}
1055 \label{fig:achcontent}
1058 To use this feature, you need to use the latest mtx-changer script
1059 version. (With new \texttt{listall} and \texttt{transfer} commands)
1061 \section{Bat on Windows}
1062 We have ported {\bf bat} to Windows and it is now installed
1063 by default when the installer is run. It works quite well
1064 on Win32, but has not had a lot of testing there, so your
1065 feedback would be welcome. Unfortunately, eventhough it is
1066 installed by default, it does not yet work on 64 bit Windows
1069 \section{New Win32 Installer}
1070 The Win32 installer has been modified in several very important
1073 \item You must deinstall any current version of the
1074 Win32 File daemon before upgrading to the new one.
1075 If you forget to do so, the new installation will fail.
1076 To correct this failure, you must manually shutdown
1077 and deinstall the old File daemon.
1078 \item All files (other than menu links) are installed
1079 in {\bf c:/Program Files/Bacula}.
1080 \item The installer no longer sets this
1081 file to require administrator privileges by default. If you want
1082 to do so, please do it manually using the {\bf cacls} program.
1085 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1087 \item The server daemons (Director and Storage daemon) are
1088 no longer included in the Windows installer. If you want the
1089 Windows servers, you will either need to build them yourself (note
1090 they have not been ported to 64 bits), or you can contact
1091 Bacula Systems about this.
1094 \section{Win64 Installer}
1095 We have corrected a number of problems that required manual
1096 editing of the conf files. In most cases, it should now
1097 install and work. {\bf bat} is by default installed in
1098 {\bf c:/Program Files/Bacula/bin32} rather than
1099 {\bf c:/Program Files/Bacula} as is the case with the 32
1100 bit Windows installer.
1102 \section{Linux Bare Metal Recovery USB Key}
1103 We have made a number of significant improvements in the
1104 Bare Metal Recovery USB key. Please see the README files
1105 it the {\bf rescue} release for more details.
1107 We are working on an equivalent USB key for Windows bare
1108 metal recovery, but it will take some time to develop it (best
1109 estimate 3Q2010 or 4Q2010)
1112 \section{bconsole Timeout Option}
1113 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1114 for commands. This is useful with GUI programs that use {\bf bconsole}
1115 to interface to the Director.
1117 \section{Important Changes}
1118 \label{sec:importantchanges}
1121 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1122 to the same Pool. The Storage daemon ensures that you do not read and
1123 write to the same Volume.
1124 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1126 \item Virtually all the features of {\bf mtx-changer} have
1127 now been parameterized, which allows you to configure
1128 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1129 that contains variables that you can set to configure mtx-changer.
1130 This configuration file will not be overwritten during upgrades.
1131 We encourage you to submit any changes
1132 that are made to mtx-changer and to parameterize it all in
1133 mtx-changer.conf so that all configuration will be done by
1134 changing only mtx-changer.conf.
1135 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1136 and \texttt{transfer}. Please configure them as appropriate
1137 in mtx-changer.conf.
1138 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1139 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1140 password. If you want to use the new script, you will need to
1141 manually change the \texttt{BackupCatalog} Job definition.
1142 \item The \texttt{bconsole} \texttt{help} command now accepts
1143 an argument, which if provided produces information on that
1144 command (ex: \texttt{help run}).
1148 \subsubsection*{Truncate volume after purge}
1150 Note that the Truncate Volume after purge feature doesn't work as expected
1151 in 5.0.0 version. Please, don't use it before version 5.0.1.
1153 \subsection{Custom Catalog queries}
1155 If you wish to add specialized commands that list the contents of the catalog,
1156 you can do so by adding them to the \texttt{query.sql} file. This
1157 \texttt{query.sql} file is now empty by default. The file
1158 \texttt{examples/sample-query.sql} has an a number of sample commands
1159 you might find useful.
1161 \subsection{Deprecated parts}
1163 The following items have been \textbf{deprecated} for a long time, and are now
1164 removed from the code.
1167 \item Support for SQLite 2
1170 \section{Misc Changes}
1171 \label{sec:miscchanges}
1174 \item Updated Nagios check\_bacula
1175 \item Updated man files
1176 \item Added OSX package generation script in platforms/darwin
1177 \item Added Spanish and Ukrainian Bacula translations
1178 \item Enable/disable command shows only Jobs that can change
1179 \item Added \texttt{show disabled} command to show disabled Jobs
1180 \item Many ACL improvements
1181 \item Added Level to FD status Job output
1182 \item Begin Ingres DB driver (not yet working)
1183 \item Split RedHat spec files into bacula, bat, mtx, and docs
1184 \item Reorganized the manuals (fewer separate manuals)
1185 \item Added lock/unlock order protection in lock manager
1186 \item Allow 64 bit sizes for a number of variables
1187 \item Fixed several deadlocks or potential race conditions in the SD
1190 \chapter{Released Version 3.0.3 and 3.0.3a}
1192 There are no new features in version 3.0.3. This version simply fixes a
1193 number of bugs found in version 3.0.2 during the onging development
1196 \chapter{New Features in Released Version 3.0.2}
1198 This chapter presents the new features added to the
1199 Released Bacula Version 3.0.2.
1201 \section{Full Restore from a Given JobId}
1202 \index[general]{Restore menu}
1204 This feature allows selecting a single JobId and having Bacula
1205 automatically select all the other jobs that comprise a full backup up to
1206 and including the selected date (through JobId).
1208 Assume we start with the following jobs:
1210 +-------+--------------+---------------------+-------+----------+------------+
1211 | jobid | client | starttime | level | jobfiles | jobbytes |
1212 +-------+--------------+---------------------+-------+----------+------------
1213 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1214 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1215 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1216 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1217 +-------+--------------+---------------------+-------+----------+------------+
1220 Below is an example of this new feature (which is number 12 in the
1225 To select the JobIds, you have the following choices:
1226 1: List last 20 Jobs run
1227 2: List Jobs where a given File is saved
1229 12: Select full restore to a specified Job date
1232 Select item: (1-13): 12
1233 Enter JobId to get the state to restore: 5
1234 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1235 You have selected the following JobIds: 1,3,5
1237 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1238 1,444 files inserted into the tree.
1241 This project was funded by Bacula Systems.
1243 \section{Source Address}
1244 \index[general]{Source Address}
1246 A feature has been added which allows the administrator to specify the address
1247 from which the Director and File daemons will establish connections. This
1248 may be used to simplify system configuration overhead when working in complex
1249 networks utilizing multi-homing and policy-routing.
1251 To accomplish this, two new configuration directives have been implemented:
1254 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1258 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1262 Simply adding specific host routes on the OS
1263 would have an undesirable side-effect: any
1264 application trying to contact the destination host would be forced to use the
1265 more specific route possibly diverting management traffic onto a backup VLAN.
1266 Instead of adding host routes for each client connected to a multi-homed backup
1267 server (for example where there are management and backup VLANs), one can
1268 use the new directives to specify a specific source address at the application
1271 Additionally, this allows the simplification and abstraction of firewall rules
1272 when dealing with a Hot-Standby director or storage daemon configuration. The
1273 Hot-standby pair may share a CARP address, which connections must be sourced
1274 from, while system services listen and act from the unique interface addresses.
1276 This project was funded by Collaborative Fusion, Inc.
1278 \section{Show volume availability when doing restore}
1280 When doing a restore the selection dialog ends by displaying this
1284 The job will require the following
1285 Volume(s) Storage(s) SD Device(s)
1286 ===========================================================================
1287 *000741L3 LTO-4 LTO3
1288 *000866L3 LTO-4 LTO3
1289 *000765L3 LTO-4 LTO3
1290 *000764L3 LTO-4 LTO3
1291 *000756L3 LTO-4 LTO3
1292 *001759L3 LTO-4 LTO3
1293 *001763L3 LTO-4 LTO3
1297 Volumes marked with ``*'' are online (in the autochanger).
1300 This should help speed up large restores by minimizing the time spent
1301 waiting for the operator to discover that he must change tapes in the library.
1303 This project was funded by Bacula Systems.
1305 \section{Accurate estimate command}
1307 The \texttt{estimate} command can now use the accurate code to detect changes
1308 and give a better estimation.
1310 You can set the accurate behavior on the command line by using
1311 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1314 * estimate listing accurate=yes level=incremental job=BackupJob
1317 This project was funded by Bacula Systems.
1319 \chapter{New Features in 3.0.0}
1320 \label{NewFeaturesChapter}
1321 \index[general]{New Features}
1323 This chapter presents the new features added to the development 2.5.x
1324 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1326 \section{Accurate Backup}
1327 \index[general]{Accurate Backup}
1329 As with most other backup programs, by default Bacula decides what files to
1330 backup for Incremental and Differental backup by comparing the change
1331 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1332 backup completed. If one of those two times is later than the last backup
1333 time, then the file will be backed up. This does not, however, permit tracking
1334 what files have been deleted and will miss any file with an old time that may
1335 have been restored to or moved onto the client filesystem.
1337 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1338 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1339 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1340 backup, there is no difference, but for {\bf Differential} and {\bf
1341 Incremental} backups, the Director will send a list of all previous files
1342 backed up, and the File daemon will use that list to determine if any new files
1343 have been added or or moved and if any files have been deleted. This allows
1344 Bacula to make an accurate backup of your system to that point in time so that
1345 if you do a restore, it will restore your system exactly.
1348 about using Accurate backup is that it requires more resources (CPU and memory)
1349 on both the Director and the Client machines to create the list of previous
1350 files backed up, to send that list to the File daemon, for the File daemon to
1351 keep the list (possibly very big) in memory, and for the File daemon to do
1352 comparisons between every file in the FileSet and the list. In particular,
1353 if your client has lots of files (more than a few million), you will need
1354 lots of memory on the client machine.
1356 Accurate must not be enabled when backing up with a plugin that is not
1357 specially designed to work with Accurate. If you enable it, your restores
1358 will probably not work correctly.
1360 This project was funded by Bacula Systems.
1365 \index[general]{Copy Jobs}
1367 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1368 existing Migration feature with the exception that the Job that is copied is
1369 left unchanged. This essentially creates two identical copies of the same
1370 backup. However, the copy is treated as a copy rather than a backup job, and
1371 hence is not directly available for restore. The {\bf restore} command lists
1372 copy jobs and allows selection of copies by using \texttt{jobid=}
1373 option. If the keyword {\bf copies} is present on the command line, Bacula will
1374 display the list of all copies for selected jobs.
1379 These JobIds have copies as follows:
1380 +-------+------------------------------------+-----------+------------------+
1381 | JobId | Job | CopyJobId | MediaType |
1382 +-------+------------------------------------+-----------+------------------+
1383 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1384 +-------+------------------------------------+-----------+------------------+
1385 +-------+-------+----------+----------+---------------------+------------------+
1386 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1387 +-------+-------+----------+----------+---------------------+------------------+
1388 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1389 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1390 +-------+-------+----------+----------+---------------------+------------------+
1391 You have selected the following JobIds: 19,2
1393 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1394 5,611 files inserted into the tree.
1399 The Copy Job runs without using the File daemon by copying the data from the
1400 old backup Volume to a different Volume in a different Pool. See the Migration
1401 documentation for additional details. For copy Jobs there is a new selection
1402 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1403 not already copied to another Pool.
1405 As with Migration, the Client, Volume, Job, or SQL query, are
1406 other possible ways of selecting the Jobs to be copied. Selection
1407 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1408 work, but are probably more suited for Migration Jobs.
1410 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1411 it will promote the Copy to a \textsl{real} backup job and will make it available for
1412 automatic restore. If more than one Copy is available, it will promote the copy
1413 with the smallest JobId.
1415 A nice solution which can be built with the new Copy feature is often
1416 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1417 look something like the one below:
1421 Name = FullBackupsVirtualPool
1423 Purge Oldest Volume = Yes
1425 NextPool = FullBackupsTapePool
1429 Name = FullBackupsTapePool
1433 Volume Retention = 365 days
1434 Storage = superloader
1438 # Fake fileset for copy jobs
1450 # Fake client for copy jobs
1460 # Default template for a CopyDiskToTape Job
1463 Name = CopyDiskToTape
1465 Messages = StandardCopy
1468 Selection Type = PoolUncopiedJobs
1469 Maximum Concurrent Jobs = 10
1471 Allow Duplicate Jobs = Yes
1472 Cancel Queued Duplicates = No
1473 Cancel Running Duplicates = No
1478 Name = DaySchedule7:00
1479 Run = Level=Full daily at 7:00
1483 Name = CopyDiskToTapeFullBackups
1485 Schedule = DaySchedule7:00
1486 Pool = FullBackupsVirtualPool
1487 JobDefs = CopyDiskToTape
1491 The example above had 2 pool which are copied using the PoolUncopiedJobs
1492 selection criteria. Normal Full backups go to the Virtual pool and are copied
1493 to the Tape pool the next morning.
1495 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1500 +-------+------------------------------------+-----------+------------------+
1501 | JobId | Job | CopyJobId | MediaType |
1502 +-------+------------------------------------+-----------+------------------+
1503 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1504 +-------+------------------------------------+-----------+------------------+
1507 \section{ACL Updates}
1508 \index[general]{ACL Updates}
1509 The whole ACL code had been overhauled and in this version each platforms has
1510 different streams for each type of acl available on such an platform. As ACLs
1511 between platforms tend to be not that portable (most implement POSIX acls but
1512 some use an other draft or a completely different format) we currently only
1513 allow certain platform specific ACL streams to be decoded and restored on the
1514 same platform that they were created on. The old code allowed to restore ACL
1515 cross platform but the comments already mention that not being to wise. For
1516 backward compatability the new code will accept the two old ACL streams and
1517 handle those with the platform specific handler. But for all new backups it
1518 will save the ACLs using the new streams.
1520 Currently the following platforms support ACLs:
1524 \item {\bf Darwin/OSX}
1533 Currently we support the following ACL types (these ACL streams use a reserved
1534 part of the stream numbers):
1537 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1539 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1540 string representation from acl\_to\_text (POSIX acl)
1541 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1542 string representation from acl\_to\_text (POSIX acl) for default acls.
1543 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1544 string representation from acl\_to\_text (POSIX acl) for access acls.
1545 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1546 string representation from acltostr (POSIX acl)
1547 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1548 representation from acl\_to\_text (POSIX acl) for default acls.
1549 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1550 representation from acl\_to\_text (POSIX acl) for access acls.
1551 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1552 string representation from acl\_to\_text (POSIX acl) for default acls.
1553 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1554 representation from acl\_to\_text (POSIX acl) for access acls.
1555 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1556 string representation from acl\_to\_text (POSIX acl) for default acls.
1557 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1558 string representation from acl\_to\_text (POSIX acl) for default acls.
1559 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1560 representation from acl\_to\_text (POSIX acl) for access acls.
1561 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1562 string representation from acltotext or acl\_totext (POSIX acl)
1563 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1564 representation from from acl\_totext (NFSv4 or ZFS acl)
1567 In future versions we might support conversion functions from one type of acl
1568 into an other for types that are either the same or easily convertable. For now
1569 the streams are seperate and restoring them on a platform that doesn't
1570 recognize them will give you a warning.
1572 \section{Extended Attributes}
1573 \index[general]{Extended Attributes}
1574 Something that was on the project list for some time is now implemented for
1575 platforms that support a similar kind of interface. Its the support for backup
1576 and restore of so called extended attributes. As extended attributes are so
1577 platform specific these attributes are saved in seperate streams for each
1578 platform. Restores of the extended attributes can only be performed on the
1579 same platform the backup was done. There is support for all types of extended
1580 attributes, but restoring from one type of filesystem onto an other type of
1581 filesystem on the same platform may lead to supprises. As extended attributes
1582 can contain any type of data they are stored as a series of so called
1583 value-pairs. This data must be seen as mostly binary and is stored as such.
1584 As security labels from selinux are also extended attributes this option also
1585 stores those labels and no specific code is enabled for handling selinux
1588 Currently the following platforms support extended attributes:
1590 \item {\bf Darwin/OSX}
1596 On linux acls are also extended attributes, as such when you enable ACLs on a
1597 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1598 and not the same exteneded attribute.
1600 To enable the backup of extended attributes please add the following to your
1615 \section{Shared objects}
1616 \index[general]{Shared objects}
1617 A default build of Bacula will now create the libraries as shared objects
1618 (.so) rather than static libraries as was previously the case.
1619 The shared libraries are built using {\bf libtool} so it should be quite
1622 An important advantage of using shared objects is that on a machine with the
1623 Directory, File daemon, the Storage daemon, and a console, you will have only
1624 one copy of the code in memory rather than four copies. Also the total size of
1625 the binary release is smaller since the library code appears only once rather
1626 than once for every program that uses it; this results in significant reduction
1627 in the size of the binaries particularly for the utility tools.
1629 In order for the system loader to find the shared objects when loading the
1630 Bacula binaries, the Bacula shared objects must either be in a shared object
1631 directory known to the loader (typically /usr/lib) or they must be in the
1632 directory that may be specified on the {\bf ./configure} line using the {\bf
1633 {-}{-}libdir} option as:
1636 ./configure --libdir=/full-path/dir
1639 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1640 no need to modify your loader configuration provided that
1641 the shared objects are installed in that directory (Bacula
1642 does this with the make install command). The shared objects
1643 that Bacula references are:
1652 These files are symbolically linked to the real shared object file,
1653 which has a version number to permit running multiple versions of
1654 the libraries if desired (not normally the case).
1656 If you have problems with libtool or you wish to use the old
1657 way of building static libraries, or you want to build a static
1658 version of Bacula you may disable
1659 libtool on the configure command line with:
1662 ./configure --disable-libtool
1666 \section{Building Static versions of Bacula}
1667 \index[general]{Static linking}
1668 In order to build static versions of Bacula, in addition
1669 to configuration options that were needed you now must
1670 also add --disable-libtool. Example
1673 ./configure --enable-static-client-only --disable-libtool
1677 \section{Virtual Backup (Vbackup)}
1678 \index[general]{Virtual Backup}
1679 \index[general]{Vbackup}
1681 Bacula's virtual backup feature is often called Synthetic Backup or
1682 Consolidation in other backup products. It permits you to consolidate the
1683 previous Full backup plus the most recent Differential backup and any
1684 subsequent Incremental backups into a new Full backup. This new Full
1685 backup will then be considered as the most recent Full for any future
1686 Incremental or Differential backups. The VirtualFull backup is
1687 accomplished without contacting the client by reading the previous backup
1688 data and writing it to a volume in a different pool.
1690 In some respects the Vbackup feature works similar to a Migration job, in
1691 that Bacula normally reads the data from the pool specified in the
1692 Job resource, and writes it to the {\bf Next Pool} specified in the
1693 Job resource. Note, this means that usually the output from the Virtual
1694 Backup is written into a different pool from where your prior backups
1695 are saved. Doing it this way guarantees that you will not get a deadlock
1696 situation attempting to read and write to the same volume in the Storage
1697 daemon. If you then want to do subsequent backups, you may need to
1698 move the Virtual Full Volume back to your normal backup pool.
1699 Alternatively, you can set your {\bf Next Pool} to point to the current
1700 pool. This will cause Bacula to read and write to Volumes in the
1701 current pool. In general, this will work, because Bacula will
1702 not allow reading and writing on the same Volume. In any case, once
1703 a VirtualFull has been created, and a restore is done involving the
1704 most current Full, it will read the Volume or Volumes by the VirtualFull
1705 regardless of in which Pool the Volume is found.
1707 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1708 a level of {\bf VirtualFull}.
1710 A typical Job resource definition might look like the following:
1717 FileSet = "Full Set"
1724 # Default pool definition
1728 Recycle = yes # Automatically recycle Volumes
1729 AutoPrune = yes # Prune expired volumes
1730 Volume Retention = 365d # one year
1738 Recycle = yes # Automatically recycle Volumes
1739 AutoPrune = yes # Prune expired volumes
1740 Volume Retention = 365d # one year
1741 Storage = DiskChanger
1744 # Definition of file storage device
1749 Device = FileStorage
1751 Maximum Concurrent Jobs = 5
1754 # Definition of DDS Virtual tape disk storage device
1757 Address = localhost # N.B. Use a fully qualified name here
1759 Device = DiskChanger
1760 Media Type = DiskChangerMedia
1761 Maximum Concurrent Jobs = 4
1766 Then in bconsole or via a Run schedule, you would run the job as:
1769 run job=MyBackup level=Full
1770 run job=MyBackup level=Incremental
1771 run job=MyBackup level=Differential
1772 run job=MyBackup level=Incremental
1773 run job=MyBackup level=Incremental
1776 So providing there were changes between each of those jobs, you would end up
1777 with a Full backup, a Differential, which includes the first Incremental
1778 backup, then two Incremental backups. All the above jobs would be written to
1779 the {\bf Default} pool.
1781 To consolidate those backups into a new Full backup, you would run the
1785 run job=MyBackup level=VirtualFull
1788 And it would produce a new Full backup without using the client, and the output
1789 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1791 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1794 Note, the Start and End time of the Virtual Full backup is set to the
1795 values for the last job included in the Virtual Full (in the above example,
1796 it is an Increment). This is so that if another incremental is done, which
1797 will be based on the Virtual Full, it will backup all files from the
1798 last Job included in the Virtual Full rather than from the time the Virtual
1799 Full was actually run.
1803 \section{Catalog Format}
1804 \index[general]{Catalog Format}
1805 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1806 operation will convert the FileId field of the File table from 32 bits (max 4
1807 billion table entries) to 64 bits (very large number of items). The
1808 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1809 your catalog during the conversion. Also you won't be able to run jobs during
1810 this conversion period. For example, a 3 million file catalog will take 2
1811 minutes to upgrade on a normal machine. Please don't forget to make a valid
1812 backup of your database before executing the upgrade script. See the
1813 ReleaseNotes for additional details.
1815 \section{64 bit Windows Client}
1816 \index[general]{Win64 Client}
1817 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1818 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1819 As a consequence, we are also releasing a 64 bit version of the Bacula
1820 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1821 These binaries should only be installed on 64 bit Windows operating systems.
1822 What is important is not your hardware but whether or not you have
1823 a 64 bit version of the Windows OS.
1825 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1827 \item Before installing the Win64 Bacula Client, you must totally
1828 deinstall any prior 2.4.x Client installation using the
1829 Bacula deinstallation (see the menu item). You may want
1830 to save your .conf files first.
1831 \item Only the Client (File daemon) is ported to Win64, the Director
1832 and the Storage daemon are not in the 64 bit Windows installer.
1833 \item bwx-console is not yet ported.
1834 \item bconsole is ported but it has not been tested.
1835 \item The documentation is not included in the installer.
1836 \item Due to Vista security restrictions imposed on a default installation
1837 of Vista, before upgrading the Client, you must manually stop
1838 any prior version of Bacula from running, otherwise the install
1840 \item Due to Vista security restrictions imposed on a default installation
1841 of Vista, attempting to edit the conf files via the menu items
1842 will fail. You must directly edit the files with appropriate
1843 permissions. Generally double clicking on the appropriate .conf
1844 file will work providing you have sufficient permissions.
1845 \item All Bacula files are now installed in
1846 {\bf C:/Program Files/Bacula} except the main menu items,
1847 which are installed as before. This vastly simplifies the installation.
1848 \item If you are running on a foreign language version of Windows, most
1849 likely {\bf C:/Program Files} does not exist, so you should use the
1850 Custom installation and enter an appropriate location to install
1852 \item The 3.0.0 Win32 Client continues to install files in the locations used
1853 by prior versions. For the next version we will convert it to use
1854 the same installation conventions as the Win64 version.
1857 This project was funded by Bacula Systems.
1860 \section{Duplicate Job Control}
1861 \index[general]{Duplicate Jobs}
1862 The new version of Bacula provides four new directives that
1863 give additional control over what Bacula does if duplicate jobs
1864 are started. A duplicate job in the sense we use it here means
1865 a second or subsequent job with the same name starts. This
1866 happens most frequently when the first job runs longer than expected because no
1867 tapes are available.
1869 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1870 are specified in the Job resource.
1874 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1875 \index[general]{Allow Duplicate Jobs}
1876 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1877 the directive is set to {\bf no} (default) then only one job of a given name
1878 may run at one time, and the action that Bacula takes to ensure only
1879 one job runs is determined by the other directives (see below).
1881 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1882 are present and none of the three directives given below permit
1883 cancelling a job, then the current job (the second one started)
1886 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1887 \index[general]{Allow Higher Duplicates}
1888 This directive was in version 5.0.0, but does not work as
1889 expected. If used, it should always be set to no. In later versions
1890 of Bacula the directive is disabled (disregarded).
1892 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1893 \index[general]{Cancel Running Duplicates}
1894 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1895 if this directive is set to {\bf yes} any job that is already running
1896 will be canceled. The default is {\bf no}.
1898 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1899 \index[general]{Cancel Queued Duplicates}
1900 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1901 if this directive is set to {\bf yes} any job that is
1902 already queued to run but not yet running will be canceled.
1903 The default is {\bf no}.
1906 \section{TLS Authentication}
1907 \index[general]{TLS Authentication}
1908 In Bacula version 2.5.x and later, in addition to the normal Bacula
1909 CRAM-MD5 authentication that is used to authenticate each Bacula
1910 connection, you can specify that you want TLS Authentication as well,
1911 which will provide more secure authentication.
1913 This new feature uses Bacula's existing TLS code (normally used for
1914 communications encryption) to do authentication. To use it, you must
1915 specify all the TLS directives normally used to enable communications
1916 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1919 \subsection{TLS Authenticate = yes}
1921 TLS Authenticate = yes
1924 in the main daemon configuration resource (Director for the Director,
1925 Client for the File daemon, and Storage for the Storage daemon).
1927 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1928 authentication, Bacula will also do TLS authentication, then TLS
1929 encryption will be turned off, and the rest of the communication between
1930 the two Bacula daemons will be done without encryption.
1932 If you want to encrypt communications data, use the normal TLS directives
1933 but do not turn on {\bf TLS Authenticate}.
1935 \section{bextract non-portable Win32 data}
1936 \index[general]{bextract handles Win32 non-portable data}
1937 {\bf bextract} has been enhanced to be able to restore
1938 non-portable Win32 data to any OS. Previous versions were
1939 unable to restore non-portable Win32 data to machines that
1940 did not have the Win32 BackupRead and BackupWrite API calls.
1942 \section{State File updated at Job Termination}
1943 \index[general]{State File}
1944 In previous versions of Bacula, the state file, which provides a
1945 summary of previous jobs run in the {\bf status} command output was
1946 updated only when Bacula terminated, thus if the daemon crashed, the
1947 state file might not contain all the run data. This version of
1948 the Bacula daemons updates the state file on each job termination.
1950 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1951 \index[general]{MaxFullInterval}
1952 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1953 can be used to specify the maximum time interval between {\bf Full} backup
1954 jobs. When a job starts, if the time since the last Full backup is
1955 greater than the specified interval, and the job would normally be an
1956 {\bf Incremental} or {\bf Differential}, it will be automatically
1957 upgraded to a {\bf Full} backup.
1959 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1960 \index[general]{MaxDiffInterval}
1961 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1962 can be used to specify the maximum time interval between {\bf Differential} backup
1963 jobs. When a job starts, if the time since the last Differential backup is
1964 greater than the specified interval, and the job would normally be an
1965 {\bf Incremental}, it will be automatically
1966 upgraded to a {\bf Differential} backup.
1968 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1969 \index[general]{MaxDiffInterval}
1970 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1971 by the user, and when it is set it is an indication to backup programs
1972 to not backup that particular file. This version of Bacula contains a
1973 new Options directive within a FileSet resource, which instructs Bacula to
1974 obey this flag. The new directive is:
1977 Honor No Dump Flag = yes\vb{}no
1980 The default value is {\bf no}.
1983 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1984 \index[general]{IgnoreDir}
1985 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1986 can be added to the Include section of the FileSet resource. If the specified
1987 filename ({\bf filename-string}) is found on the Client in any directory to be
1988 backed up, the whole directory will be ignored (not backed up). For example:
1991 # List of files to be backed up
1999 Exclude Dir Containing = .excludeme
2004 But in /home, there may be hundreds of directories of users and some
2005 people want to indicate that they don't want to have certain
2006 directories backed up. For example, with the above FileSet, if
2007 the user or sysadmin creates a file named {\bf .excludeme} in
2008 specific directories, such as
2011 /home/user/www/cache/.excludeme
2012 /home/user/temp/.excludeme
2015 then Bacula will not backup the two directories named:
2018 /home/user/www/cache
2022 NOTE: subdirectories will not be backed up. That is, the directive
2023 applies to the two directories in question and any children (be they
2024 files, directories, etc).
2027 \section{Bacula Plugins}
2028 \index[general]{Plugin}
2029 Support for shared object plugins has been implemented in the Linux, Unix
2030 and Win32 File daemons. The API will be documented separately in
2031 the Developer's Guide or in a new document. For the moment, there is
2032 a single plugin named {\bf bpipe} that allows an external program to
2033 get control to backup and restore a file.
2035 Plugins are also planned (partially implemented) in the Director and the
2038 \subsection{Plugin Directory}
2039 \index[general]{Plugin Directory}
2040 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2041 be added to the daemon definition resource. The directory takes a quoted
2042 string argument, which is the name of the directory in which the daemon can
2043 find the Bacula plugins. If this directive is not specified, Bacula will not
2044 load any plugins. Since each plugin has a distinctive name, all the daemons
2045 can share the same plugin directory.
2047 \subsection{Plugin Options}
2048 \index[general]{Plugin Options}
2049 The {\bf Plugin Options} directive takes a quoted string
2050 arguement (after the equal sign) and may be specified in the
2051 Job resource. The options specified will be passed to all plugins
2052 when they are run. This each plugin must know what it is looking
2053 for. The value defined in the Job resource can be modified
2054 by the user when he runs a Job via the {\bf bconsole} command line
2057 Note: this directive may be specified, and there is code to modify
2058 the string in the run command, but the plugin options are not yet passed to
2059 the plugin (i.e. not fully implemented).
2061 \subsection{Plugin Options ACL}
2062 \index[general]{Plugin Options ACL}
2063 The {\bf Plugin Options ACL} directive may be specified in the
2064 Director's Console resource. It functions as all the other ACL commands
2065 do by permitting users running restricted consoles to specify a
2066 {\bf Plugin Options} that overrides the one specified in the Job
2067 definition. Without this directive restricted consoles may not modify
2070 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2071 \index[general]{Plugin}
2072 The {\bf Plugin} directive is specified in the Include section of
2073 a FileSet resource where you put your {\bf File = xxx} directives.
2084 Plugin = "bpipe:..."
2089 In the above example, when the File daemon is processing the directives
2090 in the Include section, it will first backup all the files in {\bf /home}
2091 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2092 the Plugin Directory. The syntax and semantics of the Plugin directive
2093 require the first part of the string up to the colon (:) to be the name
2094 of the plugin. Everything after the first colon is ignored by the File daemon but
2095 is passed to the plugin. Thus the plugin writer may define the meaning of the
2096 rest of the string as he wishes.
2098 Please see the next section for information about the {\bf bpipe} Bacula
2101 \section{The bpipe Plugin}
2102 \index[general]{The bpipe Plugin}
2103 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2104 the Bacula source distribution. When the plugin is compiled and linking into
2105 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2106 Please note that this is a very simple plugin that was written for
2107 demonstration and test purposes. It is and can be used in production, but
2108 that was never really intended.
2110 The purpose of the plugin is to provide an interface to any system program for
2111 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2112 the Include section of your Job's FileSet resource. The full syntax of the
2113 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2114 to specify the sytax as it wishes) is:
2117 Plugin = "<field1>:<field2>:<field3>:<field4>"
2122 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2123 stripped off, so in this case, we would put {\bf bpipe} in this field.
2125 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2126 pseudo path and filename under which the backup will be saved. This pseudo
2127 path and filename will be seen by the user in the restore file tree.
2128 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2129 backed up by the plugin will be put under that "pseudo" path and filename.
2130 You must be careful to choose a naming convention that is unique to avoid
2131 a conflict with a path and filename that actually exists on your system.
2133 \item {\bf field3} for the {\bf bpipe} plugin
2134 specifies the "reader" program that is called by the plugin during
2135 backup to read the data. {\bf bpipe} will call this program by doing a
2138 \item {\bf field4} for the {\bf bpipe} plugin
2139 specifies the "writer" program that is called by the plugin during
2140 restore to write the data back to the filesystem.
2143 Please note that for two items above describing the "reader" and "writer"
2144 fields, these programs are "executed" by Bacula, which
2145 means there is no shell interpretation of any command line arguments
2146 you might use. If you want to use shell characters (redirection of input
2147 or output, ...), then we recommend that you put your command or commands
2148 in a shell script and execute the script. In addition if you backup a
2149 file with the reader program, when running the writer program during
2150 the restore, Bacula will not automatically create the path to the file.
2151 Either the path must exist, or you must explicitly do so with your command
2152 or in a shell script.
2154 Putting it all together, the full plugin directive line might look
2158 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2159 --opt --databases bacula:mysql"
2162 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2163 would be written on a single line.
2165 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2166 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2167 program {\bf mysqldump -f --opt --database bacula} to read the data during
2168 backup. The mysqldump command outputs all the data for the database named
2169 {\bf bacula}, which will be read by the plugin and stored in the backup.
2170 During restore, the data that was backed up will be sent to the program
2171 specified in the last field, which in this case is {\bf mysql}. When
2172 {\bf mysql} is called, it will read the data sent to it by the plugn
2173 then write it back to the same database from which it came ({\bf bacula}
2176 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2177 the data from a specified program to Bacula for backup, and then from Bacula to
2178 a specified program for restore.
2180 By using different command lines to {\bf bpipe},
2181 you can backup any kind of data (ASCII or binary) depending
2182 on the program called.
2184 \section{Microsoft Exchange Server 2003/2007 Plugin}
2185 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2186 \subsection{Background}
2187 The Exchange plugin was made possible by a funded development project
2188 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2189 The code for the plugin was written by James Harper, and the Bacula core
2190 code by Kern Sibbald. All the code for this funded development has become
2191 part of the Bacula project. Thanks to everyone who made it happen.
2193 \subsection{Concepts}
2194 Although it is possible to backup Exchange using Bacula VSS the Exchange
2195 plugin adds a good deal of functionality, because while Bacula VSS
2196 completes a full backup (snapshot) of Exchange, it does
2197 not support Incremental or Differential backups, restoring is more
2198 complicated, and a single database restore is not possible.
2200 Microsoft Exchange organises its storage into Storage Groups with
2201 Databases inside them. A default installation of Exchange will have a
2202 single Storage Group called 'First Storage Group', with two Databases
2203 inside it, "Mailbox Store (SERVER NAME)" and
2204 "Public Folder Store (SERVER NAME)",
2205 which hold user email and public folders respectively.
2207 In the default configuration, Exchange logs everything that happens to
2208 log files, such that if you have a backup, and all the log files since,
2209 you can restore to the present time. Each Storage Group has its own set
2210 of log files and operates independently of any other Storage Groups. At
2211 the Storage Group level, the logging can be turned off by enabling a
2212 function called "Enable circular logging". At this time the Exchange
2213 plugin will not function if this option is enabled.
2215 The plugin allows backing up of entire storage groups, and the restoring
2216 of entire storage groups or individual databases. Backing up and
2217 restoring at the individual mailbox or email item is not supported but
2218 can be simulated by use of the "Recovery" Storage Group (see below).
2220 \subsection{Installing}
2221 The Exchange plugin requires a DLL that is shipped with Microsoft
2222 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2223 correctly the Exchange plugin should find this automatically and run
2224 without any additional installation.
2226 If the DLL can not be found automatically it will need to be copied into
2227 the Bacula installation
2228 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2229 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2230 default Exchange installation.
2232 \subsection{Backing Up}
2233 To back up an Exchange server the Fileset definition must contain at
2234 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2235 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2236 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2237 up files are prefixed with something that isn't going to share a name
2238 with something outside the plugin, and the 'Microsoft Information Store'
2239 bit is required also. It is also possible to add the name of a storage
2240 group to the "Plugin =" line, eg \\
2241 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2242 if you want only a single storage group backed up.
2244 Additionally, you can suffix the 'Plugin =' directive with
2245 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2246 database at the end of a full backup.
2248 An Incremental or Differential backup will backup only the database logs
2249 for each Storage Group by inspecting the "modified date" on each
2250 physical log file. Because of the way the Exchange API works, the last
2251 logfile backed up on each backup will always be backed up by the next
2252 Incremental or Differential backup too. This adds 5MB to each
2253 Incremental or Differential backup size but otherwise does not cause any
2256 By default, a normal VSS fileset containing all the drive letters will
2257 also back up the Exchange databases using VSS. This will interfere with
2258 the plugin and Exchange's shared ideas of when the last full backup was
2259 done, and may also truncate log files incorrectly. It is important,
2260 therefore, that the Exchange database files be excluded from the backup,
2261 although the folders the files are in should be included, or they will
2262 have to be recreated manually if a baremetal restore is done.
2267 File = C:/Program Files/Exchsrvr/mdbdata
2268 Plugin = "exchange:..."
2271 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2272 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2273 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2274 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2275 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2276 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2277 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2282 The advantage of excluding the above files is that you can significantly
2283 reduce the size of your backup since all the important Exchange files
2284 will be properly saved by the Plugin.
2287 \subsection{Restoring}
2288 The restore operation is much the same as a normal Bacula restore, with
2289 the following provisos:
2292 \item The {\bf Where} restore option must not be specified
2293 \item Each Database directory must be marked as a whole. You cannot just
2294 select (say) the .edb file and not the others.
2295 \item If a Storage Group is restored, the directory of the Storage Group
2297 \item It is possible to restore only a subset of the available log files,
2298 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2299 if a log file is missing from the sequence of log files
2300 \item Each database to be restored must be dismounted and marked as "Can be
2301 overwritten by restore"
2302 \item If an entire Storage Group is to be restored (eg all databases and
2303 logs in the Storage Group), then it is best to manually delete the
2304 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2305 as Exchange can get confused by stray log files lying around.
2308 \subsection{Restoring to the Recovery Storage Group}
2309 The concept of the Recovery Storage Group is well documented by
2311 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2312 but to briefly summarize...
2314 Microsoft Exchange allows the creation of an additional Storage Group
2315 called the Recovery Storage Group, which is used to restore an older
2316 copy of a database (e.g. before a mailbox was deleted) into without
2317 messing with the current live data. This is required as the Standard and
2318 Small Business Server versions of Exchange can not ordinarily have more
2319 than one Storage Group.
2321 To create the Recovery Storage Group, drill down to the Server in Exchange
2322 System Manager, right click, and select
2323 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2324 locations and click OK. On the Recovery Storage Group, right click and
2325 select {\bf "Add Database to Recover..."} and select the database you will
2328 Restore only the single database nominated as the database in the
2329 Recovery Storage Group. Exchange will redirect the restore to the
2330 Recovery Storage Group automatically.
2331 Then run the restore.
2333 \subsection{Restoring on Microsoft Server 2007}
2334 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2335 2007, and henc you use a new proceedure for recovering a single mail box.
2336 This procedure is ducomented by Microsoft at:
2337 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2338 and involves using the {\bf Restore-Mailbox} and {\bf
2339 Get-MailboxStatistics} shell commands.
2341 \subsection{Caveats}
2342 This plugin is still being developed, so you should consider it
2343 currently in BETA test, and thus use in a production environment
2344 should be done only after very careful testing.
2346 When doing a full backup, the Exchange database logs are truncated by
2347 Exchange as soon as the plugin has completed the backup. If the data
2348 never makes it to the backup medium (eg because of spooling) then the
2349 logs will still be truncated, but they will also not have been backed
2350 up. A solution to this is being worked on. You will have to schedule a
2351 new Full backup to ensure that your next backups will be usable.
2353 The "Enable Circular Logging" option cannot be enabled or the plugin
2356 Exchange insists that a successful Full backup must have taken place if
2357 an Incremental or Differential backup is desired, and the plugin will
2358 fail if this is not the case. If a restore is done, Exchange will
2359 require that a Full backup be done before an Incremental or Differential
2362 The plugin will most likely not work well if another backup application
2363 (eg NTBACKUP) is backing up the Exchange database, especially if the
2364 other backup application is truncating the log files.
2366 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2367 we recommend either carefully testing or that you avoid this option for
2370 The Exchange plugin is not called during processing the bconsole {\bf
2371 estimate} command, and so anything that would be backed up by the plugin
2372 will not be added to the estimate total that is displayed.
2375 \section{libdbi Framework}
2376 \index[general]{libdbi Framework}
2377 As a general guideline, Bacula has support for a few catalog database drivers
2378 (MySQL, PostgreSQL, SQLite)
2379 coded natively by the Bacula team. With the libdbi implementation, which is a
2380 Bacula driver that uses libdbi to access the catalog, we have an open field to
2381 use many different kinds database engines following the needs of users.
2383 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2384 implements a database-independent abstraction layer in C, similar to the
2385 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2386 leverage the power of multiple databases and multiple simultaneous database
2387 connections by using this framework.
2389 Currently the libdbi driver in Bacula project only supports the same drivers
2390 natively coded in Bacula. However the libdbi project has support for many
2391 others database engines. You can view the list at
2392 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2393 supported by Bacula, however, they must be tested properly by the Bacula team.
2395 Some of benefits of using libdbi are:
2397 \item The possibility to use proprietary databases engines in which your
2398 proprietary licenses prevent the Bacula team from developing the driver.
2399 \item The possibility to use the drivers written for the libdbi project.
2400 \item The possibility to use other database engines without recompiling Bacula
2401 to use them. Just change one line in bacula-dir.conf
2402 \item Abstract Database access, this is, unique point to code and profiling
2403 catalog database access.
2406 The following drivers have been tested:
2408 \item PostgreSQL, with and without batch insert
2409 \item Mysql, with and without batch insert
2414 In the future, we will test and approve to use others databases engines
2415 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2417 To compile Bacula to support libdbi we need to configure the code with the
2418 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2419 [database] is the database engine to be used with Bacula (of course we can
2420 change the driver in file bacula-dir.conf, see below). We must configure the
2421 access port of the database engine with the option --with-db-port, because the
2422 libdbi framework doesn't know the default access port of each database.
2424 The next phase is checking (or configuring) the bacula-dir.conf, example:
2428 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2429 dbname = regress; user = regress; password = ""
2433 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2434 mysql database. Currently the drivers supported by Bacula are: postgresql,
2435 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2437 The following limitations apply when Bacula is set to use the libdbi framework:
2438 - Not tested on the Win32 platform
2439 - A little performance is lost if comparing with native database driver.
2440 The reason is bound with the database driver provided by libdbi and the
2441 simple fact that one more layer of code was added.
2443 It is important to remember, when compiling Bacula with libdbi, the
2444 following packages are needed:
2446 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2447 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2450 You can download them and compile them on your system or install the packages
2451 from your OS distribution.
2453 \section{Console Command Additions and Enhancements}
2454 \index[general]{Console Additions}
2456 \subsection{Display Autochanger Content}
2457 \index[general]{StatusSlots}
2459 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2460 autochanger content.
2464 Slot | Volume Name | Status | Media Type | Pool |
2465 ------+---------------+----------+-------------------+------------|
2466 1 | 00001 | Append | DiskChangerMedia | Default |
2467 2 | 00002 | Append | DiskChangerMedia | Default |
2468 3*| 00003 | Append | DiskChangerMedia | Scratch |
2473 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2474 {\bf update slots} command to synchronize autochanger content with your
2477 \subsection{list joblog job=xxx or jobid=nnn}
2478 \index[general]{list joblog}
2479 A new list command has been added that allows you to list the contents
2480 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2481 or for a particular JobId. The {\bf llist} command will include a line with
2482 the time and date of the entry.
2484 Note for the catalog to have Job Log entries, you must have a directive
2491 In your Director's {\bf Messages} resource.
2493 \subsection{Use separator for multiple commands}
2494 \index[general]{Command Separator}
2495 When using bconsole with readline, you can set the command separator with
2496 \textbf{@separator} command to one
2497 of those characters to write commands who require multiple input in one line.
2499 !$%&'()*+,-/:;<>?[]^`{|}~
2502 \subsection{Deleting Volumes}
2503 The delete volume bconsole command has been modified to
2504 require an asterisk (*) in front of a MediaId otherwise the
2505 value you enter is a taken to be a Volume name. This is so that
2506 users may delete numeric Volume names. The previous Bacula versions
2507 assumed that all input that started with a number was a MediaId.
2509 This new behavior is indicated in the prompt if you read it
2512 \section{Bare Metal Recovery}
2513 The old bare metal recovery project is essentially dead. One
2514 of the main features of it was that it would build a recovery
2515 CD based on the kernel on your system. The problem was that
2516 every distribution has a different boot procedure and different
2517 scripts, and worse yet, the boot procedures and scripts change
2518 from one distribution to another. This meant that maintaining
2519 (keeping up with the changes) the rescue CD was too much work.
2521 To replace it, a new bare metal recovery USB boot stick has been developed
2522 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2523 boot from a USB key.
2527 \item Recovery can be done from within graphical environment.
2528 \item Recovery can be done in a shell.
2529 \item Ubuntu boots on a large number of Linux systems.
2530 \item The process of updating the system and adding new
2531 packages is not too difficult.
2532 \item The USB key can easily be upgraded to newer Ubuntu versions.
2533 \item The USB key has writable partitions for modifications to
2534 the OS and for modification to your home directory.
2535 \item You can add new files/directories to the USB key very easily.
2536 \item You can save the environment from multiple machines on
2538 \item Bacula Systems is funding its ongoing development.
2541 The disadvantages are:
2543 \item The USB key is usable but currently under development.
2544 \item Not everyone may be familiar with Ubuntu (no worse
2546 \item Some older OSes cannot be booted from USB. This can
2547 be resolved by first booting a Ubuntu LiveCD then plugging
2549 \item Currently the documentation is sketchy and not yet added
2550 to the main manual. See below ...
2553 The documentation and the code can be found in the {\bf rescue} package
2554 in the directory {\bf linux/usb}.
2556 \section{Miscellaneous}
2557 \index[general]{Misc New Features}
2559 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2560 \index[general]{Allow Mixed Priority}
2561 This directive is only implemented in version 2.5 and later. When
2562 set to {\bf yes} (default {\bf no}), this job may run even if lower
2563 priority jobs are already running. This means a high priority job
2564 will not have to wait for other jobs to finish before starting.
2565 The scheduler will only mix priorities when all running jobs have
2568 Note that only higher priority jobs will start early. Suppose the
2569 director will allow two concurrent jobs, and that two jobs with
2570 priority 10 are running, with two more in the queue. If a job with
2571 priority 5 is added to the queue, it will be run as soon as one of
2572 the running jobs finishes. However, new priority 10 jobs will not
2573 be run until the priority 5 job has finished.
2575 \subsection{Bootstrap File Directive -- FileRegex}
2576 \index[general]{Bootstrap File Directive}
2577 {\bf FileRegex} is a new command that can be added to the bootstrap
2578 (.bsr) file. The value is a regular expression. When specified, only
2579 matching filenames will be restored.
2581 During a restore, if all File records are pruned from the catalog
2582 for a Job, normally Bacula can restore only all files saved. That
2583 is there is no way using the catalog to select individual files.
2584 With this new feature, Bacula will ask if you want to specify a Regex
2585 expression for extracting only a part of the full backup.
2588 Building directory tree for JobId(s) 1,3 ...
2589 There were no files inserted into the tree, so file selection
2590 is not possible.Most likely your retention policy pruned the files
2592 Do you want to restore all the files? (yes\vb{}no): no
2594 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2595 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2598 \subsection{Bootstrap File Optimization Changes}
2599 In order to permit proper seeking on disk files, we have extended the bootstrap
2600 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2601 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2602 address range and end address range respectively. These two directives replace
2603 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2604 VolEndBlock} directives. Bootstrap files containing the old directives will
2605 still work, but will not properly take advantage of proper disk seeking, and
2606 may read completely to the end of a disk volume during a restore. With the new
2607 format (automatically generated by the new Director), restores will seek
2608 properly and stop reading the volume when all the files have been restored.
2610 \subsection{Solaris ZFS/NFSv4 ACLs}
2611 This is an upgrade of the previous Solaris ACL backup code
2612 to the new library format, which will backup both the old
2613 POSIX(UFS) ACLs as well as the ZFS ACLs.
2615 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2616 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2617 be used to transfer from UFS to ZFS filesystems.
2620 \subsection{Virtual Tape Emulation}
2621 \index[general]{Virtual Tape Emulation}
2622 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2623 the tape code but actually reading and writing to a disk file. Used with the
2624 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2625 and 700 slots. This feature is most useful in testing. It is enabled
2626 by using {\bf Device Type = vtape} in the Storage daemon's Device
2627 directive. This feature is only implemented on Linux machines and should not be
2628 used for production.
2630 \subsection{Bat Enhancements}
2631 \index[general]{Bat Enhancements}
2632 Bat (the Bacula Administration Tool) GUI program has been significantly
2633 enhanced and stabilized. In particular, there are new table based status
2634 commands; it can now be easily localized using Qt4 Linguist.
2636 The Bat communications protocol has been significantly enhanced to improve
2637 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2638 the Director you are using otherwise the communications protocol will not
2641 \subsection{RunScript Enhancements}
2642 \index[general]{RunScript Enhancements}
2643 The {\bf RunScript} resource has been enhanced to permit multiple
2644 commands per RunScript. Simply specify multiple {\bf Command} directives
2651 Command = "/bin/echo test"
2652 Command = "/bin/echo an other test"
2653 Command = "/bin/echo 3 commands in the same runscript"
2660 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2661 implemented, which runs the command after the Volume Shadow Copy has been made.
2663 Console commands can be specified within a RunScript by using:
2664 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2665 carefully tested and debugged and is known to easily crash the Director.
2666 We would appreciate feedback. Due to the recursive nature of this command, we
2667 may remove it before the final release.
2669 \subsection{Status Enhancements}
2670 \index[general]{Status Enhancements}
2671 The bconsole {\bf status dir} output has been enhanced to indicate
2672 Storage daemon job spooling and despooling activity.
2674 \subsection{Connect Timeout}
2675 \index[general]{Connect Timeout}
2676 The default connect timeout to the File
2677 daemon has been set to 3 minutes. Previously it was 30 minutes.
2679 \subsection{ftruncate for NFS Volumes}
2680 \index[general]{ftruncate for NFS Volumes}
2681 If you write to a Volume mounted by NFS (say on a local file server),
2682 in previous Bacula versions, when the Volume was recycled, it was not
2683 properly truncated because NFS does not implement ftruncate (file
2684 truncate). This is now corrected in the new version because we have
2685 written code (actually a kind user) that deletes and recreates the Volume,
2686 thus accomplishing the same thing as a truncate.
2688 \subsection{Support for Ubuntu}
2689 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2690 version of Linux, and thus now provides correct autostart routines.
2691 Since Ubuntu officially supports Bacula, you can also obtain any
2692 recent release of Bacula from the Ubuntu repositories.
2694 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2695 \index[general]{Recycle Pool}
2696 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2697 be placed (moved) when it is recycled. Without this directive, a Volume will
2698 remain in the same pool when it is recycled. With this directive, it can be
2699 moved automatically to any existing pool during a recycle. This directive is
2700 probably most useful when defined in the Scratch pool, so that volumes will
2701 be recycled back into the Scratch pool.
2703 \subsection{FD Version}
2704 \index[general]{FD Version}
2705 The File daemon to Director protocol now includes a version
2706 number, which although there is no visible change for users,
2707 will help us in future versions automatically determine
2708 if a File daemon is not compatible.
2710 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2711 \index[general]{Max Run Sched Time}
2712 The time specifies the maximum allowed time that a job may run, counted from
2713 when the job was scheduled. This can be useful to prevent jobs from running
2714 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2717 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2718 \index[general]{Max Wait Time}
2719 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2720 of checking the maximum allowed time that a job may block for a resource,
2721 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2722 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2723 their job depending on the level. Now, they have to use
2724 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2725 directives are now deprecated.
2727 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2728 \index[general]{Incremental Max Wait Time}
2729 \index[general]{Differential Max Wait Time}
2731 These directives have been deprecated in favor of
2732 \texttt{Incremental|Differential Max Run Time}.
2734 \subsection{Max Run Time directives}
2735 \index[general]{Max Run Time directives}
2736 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2737 maximum allowed time that a job can run depending on the level.
2739 \addcontentsline{lof}{figure}{Job time control directives}
2740 \includegraphics{\idir different_time.eps}
2742 \subsection{Statistics Enhancements}
2743 \index[general]{Statistics Enhancements}
2744 If you (or probably your boss) want to have statistics on your backups to
2745 provide some \textit{Service Level Agreement} indicators, you could use a few
2746 SQL queries on the Job table to report how many:
2750 \item jobs have been successful
2751 \item files have been backed up
2755 However, these statistics are accurate only if your job retention is greater
2756 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2757 be able to use them.
2759 Now, you can use the \textbf{update stats [days=num]} console command to fill
2760 the JobHistory table with new Job records. If you want to be sure to take in
2761 account only \textbf{good jobs}, ie if one of your important job has failed but
2762 you have fixed the problem and restarted it on time, you probably want to
2763 delete the first \textit{bad} job record and keep only the successful one. For
2764 that simply let your staff do the job, and update JobHistory table after two or
2765 three days depending on your organization using the \textbf{[days=num]} option.
2767 These statistics records aren't used for restoring, but mainly for
2768 capacity planning, billings, etc.
2770 The Bweb interface provides a statistics module that can use this feature. You
2771 can also use tools like Talend or extract information by yourself.
2773 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2774 the length of time that Bacula will keep statistics job records in the Catalog
2775 database after the Job End time. (In \texttt{JobHistory} table) When this time
2776 period expires, and if user runs \texttt{prune stats} command, Bacula will
2777 prune (remove) Job records that are older than the specified period.
2779 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2780 job to maintain statistics.
2783 Name = BackupCatalog
2786 Console = "update stats days=3"
2787 Console = "prune stats yes"
2794 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2795 \index[general]{ScratchPool}
2796 This directive permits to specify a specific \textsl{Scratch} pool for the
2797 current pool. This is useful when using multiple storage sharing the same
2798 mediatype or when you want to dedicate volumes to a particular set of pool.
2800 \subsection{Enhanced Attribute Despooling}
2801 \index[general]{Attribute Despooling}
2802 If the storage daemon and the Director are on the same machine, the spool file
2803 that contains attributes is read directly by the Director instead of being
2804 transmitted across the network. That should reduce load and speedup insertion.
2806 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2807 \index[general]{SpoolSize}
2808 A new Job directive permits to specify the spool size per job. This is used
2809 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2811 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2812 \index[general]{MaximumConsoleConnections}
2813 A new director directive permits to specify the maximum number of Console
2814 Connections that could run concurrently. The default is set to 20, but you may
2815 set it to a larger number.
2817 \subsection{VerId = \lt{}string\gt{}}
2818 \index[general]{VerId}
2819 A new director directive permits to specify a personnal identifier that will be
2820 displayed in the \texttt{version} command.
2822 \subsection{dbcheck enhancements}
2823 \index[general]{dbcheck enhancements}
2824 If you are using Mysql, dbcheck will now ask you if you want to create
2825 temporary indexes to speed up orphaned Path and Filename elimination.
2827 A new \texttt{-B} option allows you to print catalog information in a simple
2828 text based format. This is useful to backup it in a secure way.
2843 You can now specify the database connection port in the command line.
2845 \subsection{{-}{-}docdir configure option}
2846 \index[general]{{-}{-}docdir configure option}
2847 You can use {-}{-}docdir= on the ./configure command to
2848 specify the directory where you want Bacula to install the
2849 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2850 {\bf /usr/share/doc/bacula}.
2852 \subsection{{-}{-}htmldir configure option}
2853 \index[general]{{-}{-}htmldir configure option}
2854 You can use {-}{-}htmldir= on the ./configure command to
2855 specify the directory where you want Bacula to install the bat html help
2856 files. The default is {\bf /usr/share/doc/bacula/html}
2858 \subsection{{-}{-}with-plugindir configure option}
2859 \index[general]{{-}{-}plugindir configure option}
2860 You can use {-}{-}plugindir= on the ./configure command to
2861 specify the directory where you want Bacula to install
2862 the plugins (currently only bpipe-fd). The default is