1 \chapter{New Features in 5.2.x}
2 This chapter presents the new features that have been added to the next
3 Community version of Bacula that is not yet released.
5 \chapter{New Features in 5.2.2}
6 This chapter presents the new features that have been added to the current
7 Community version of Bacula that is now released.
9 \section{Additions to RunScript variables}
10 You can have access to Director name using \%D in your runscript
14 RunAfterJob = "/bin/echo Director=%D
17 \chapter{New Features in 5.2.1}
18 This chapter presents the new features were added in the
19 Community release version 5.2.1.
21 There are additional features (plugins) available in the Enterprise version
22 that are described in another chapter. A subscription to Bacula Systems
23 is required for the Enterprise version.
25 \section{LZO Compression}
27 LZO compression has been to the File daemon. From the user's point of view,
28 it works like the GZIP compression (just replace {\bf compression=GZIP} with
29 {\bf compression=LZO}).
34 Options { compression=LZO }
40 LZO provides a much faster compression and decompression speed but lower
41 compression ratio than GZIP. It is a good option when you backup to disk. For
42 tape, the hardware compression is almost always a better option.
44 LZO is a good alternative for GZIP1 when you don't want to slow down your
45 backup. With a modern CPU it should be able to run almost as fast as:
48 \item your client can read data from disk. Unless you have very fast disks like
49 SSD or large/fast RAID array.
50 \item the data transfers between the file daemon and the storage daemon even on
54 Note, Bacula uses compression level LZO1X-1.
57 The code for this feature was contributed by Laurent Papier.
59 \section{New Tray Monitor}
61 Since the old integrated Windows tray monitor doesn't work with
62 recent Windows versions, we have written a new Qt Tray Monitor that is available
63 for both Linux and Windows. In addition to all the previous features,
64 this new version allows you to run Backups from
65 the tray monitor menu.
69 \includegraphics[width=10cm]{\idir tray-monitor}
70 \label{fig:traymonitor}
71 \caption{New tray monitor}
76 \includegraphics[width=10cm]{\idir tray-monitor1}
77 \label{fig:traymonitor1}
78 \caption{Run a Job through the new tray monitor}
82 To be able to run a job from the tray monitor, you need to
83 allow specific commands in the Director monitor console:
88 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
89 ClientACL = *all* # you can restrict to a specific host
101 This project was funded by Bacula Systems and is available with Bacula
102 the Enterprise Edition and the Community Edition.
104 \section{Purge Migration Job}
106 The new {\bf Purge Migration Job} directive may be added to the Migration
107 Job definition in the Director's configuration file. When it is enabled
108 the Job that was migrated during a migration will be purged at
109 the end of the migration job.
117 Client = localhost-fd
120 Storage = DiskChanger
123 Selection Pattern = ".*Save"
125 Purge Migration Job = yes
131 This project was submitted by Dunlap Blake; testing and documentation was funded
134 \section{Changes in Bvfs (Bacula Virtual FileSystem)}
136 Bat has now a bRestore panel that uses Bvfs to display files and
141 \includegraphics[width=12cm]{\idir bat-brestore}
142 \label{fig:batbrestore}
143 \caption{Bat Brestore Panel}
146 the Bvfs module works correctly with BaseJobs, Copy and Migration jobs.
149 This project was funded by Bacula Systems.
151 \subsection*{General notes}
154 \item All fields are separated by a tab
155 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
156 records in very big directories
157 \item All operations (except cache creation) are designed to run instantly
158 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
159 can contribute new faster SQL queries we will be happy, else don't complain
161 \item The cache creation is dependent of the number of directories. As Bvfs
162 shares information across jobs, the first creation can be slow
163 \item All fields are separated by a tab
164 \item Due to potential encoding problem, it's advised to always use pathid in
168 \subsection*{Get dependent jobs from a given JobId}
170 Bvfs allows you to query the catalog against any combination of jobs. You
171 can combine all Jobs and all FileSet for a Client in a single session.
173 To get all JobId needed to restore a particular job, you can use the
174 \texttt{.bvfs\_get\_jobids} command.
177 .bvfs_get_jobids jobid=num [all]
181 .bvfs_get_jobids jobid=10
183 .bvfs_get_jobids jobid=10 all
187 In this example, a normal restore will need to use JobIds 1,2,5,10 to
188 compute a complete restore of the system.
190 With the \texttt{all} option, the Director will use all defined FileSet for
193 \subsection*{Generating Bvfs cache}
195 The \texttt{.bvfs\_update} command computes the directory cache for jobs
196 specified in argument, or for all jobs if unspecified.
199 .bvfs_update [jobid=numlist]
204 .bvfs_update jobid=1,2,3
207 You can run the cache update process in a RunScript after the catalog backup.
209 \subsection*{Get all versions of a specific file}
211 Bvfs allows you to find all versions of a specific file for a given Client with
212 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
213 function uses only PathId and FilenameId. The jobid argument is mandatory but
217 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
218 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
219 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
226 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
227 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
230 \subsection*{List directories}
232 Bvfs allows you to list directories in a specific path.
234 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
235 PathId FilenameId FileId JobId LStat Path
236 PathId FilenameId FileId JobId LStat Path
237 PathId FilenameId FileId JobId LStat Path
241 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
242 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
243 listed is a directory.
246 .bvfs_lsdirs pathid=4 jobid=1,11,12
247 4 0 0 0 A A A A A A A A A A A A A A .
248 5 0 0 0 A A A A A A A A A A A A A A ..
249 3 0 0 0 A A A A A A A A A A A A A A regress/
252 In this example, to list directories present in \texttt{regress/}, you can use
254 .bvfs_lsdirs pathid=3 jobid=1,11,12
255 3 0 0 0 A A A A A A A A A A A A A A .
256 4 0 0 0 A A A A A A A A A A A A A A ..
257 2 0 0 0 A A A A A A A A A A A A A A tmp/
260 \subsection*{List files}
262 Bvfs allows you to list files in a specific path.
264 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
265 PathId FilenameId FileId JobId LStat Path
266 PathId FilenameId FileId JobId LStat Path
267 PathId FilenameId FileId JobId LStat Path
271 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
272 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
276 .bvfs_lsfiles pathid=4 jobid=1,11,12
277 4 0 0 0 A A A A A A A A A A A A A A .
278 5 0 0 0 A A A A A A A A A A A A A A ..
279 1 0 0 0 A A A A A A A A A A A A A A regress/
282 In this example, to list files present in \texttt{regress/}, you can use
284 .bvfs_lsfiles pathid=1 jobid=1,11,12
285 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
286 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
287 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
288 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
289 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
292 \subsection*{Restore set of files}
294 Bvfs allows you to create a SQL table that contains files that you want to
295 restore. This table can be provided to a restore command with the file option.
298 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
300 restore file=?b2num ...
303 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
304 select all files. This query could be time consuming.
306 \texttt{hardlink} list is always composed of a series of two numbers (jobid,
307 fileindex). This information can be found in the LinkFI field of the LStat
310 The \texttt{path} argument represents the name of the table that Bvfs will
311 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
312 b2 and followed by digits).
317 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
321 \subsection*{Cleanup after Restore}
323 To drop the table used by the restore command, you can use the
324 \texttt{.bvfs\_cleanup} command.
327 .bvfs_cleanup path=b20001
330 \subsection*{Clearing the BVFS Cache}
332 To clear the BVFS cache, you can use the \texttt{.bvfs\_clear\_cache} command.
335 .bvfs_clear_cache yes
339 \section{Changes in the Pruning Algorithm}
341 We rewrote the job pruning algorithm in this version. Previously, in some users
342 reported that the pruning process at the end of jobs was very long. It should
343 not be longer the case. Now, Bacula won't prune automatically a Job if this
344 particular Job is needed to restore data. Example:
348 JobId: 2 Level: Incremental
349 JobId: 3 Level: Incremental
350 JobId: 4 Level: Differential
351 .. Other incrementals up to now
354 In this example, if the Job Retention defined in the Pool or in the Client
355 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
356 detect that JobId 1 and 4 are essential to restore data at the current state
357 and will prune only JobId 2 and 3.
359 \texttt{Important}, this change affect only the automatic pruning step after a
360 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
361 \texttt{VolumeRetention} period, important jobs can be pruned.
363 \section{Ability to Verify any specified Job}
364 You now have the ability to tell Bacula which Job should verify instead of
365 automatically verify just the last one.
367 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
369 To verify a given job, just specify the Job jobid in argument when starting the
372 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
374 JobName: VerifyVolume
375 Level: VolumeToCatalog
378 Pool: Default (From Job resource)
379 Storage: File (From Job resource)
380 Verify Job: VerifyVol.2010-09-08_14.17.17_03
381 Verify List: /tmp/regress/working/VerifyVol.bsr
382 When: 2010-09-08 14:17:31
384 OK to run? (yes/mod/no):
388 This project was funded by Bacula Systems and is available with Bacula
389 Enterprise Edition and Community Edition.
391 \section{Additions to RunScript variables}
392 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
393 command. The Client address is now available through \%h.
396 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
399 %\section{Changes in drivetype.exe}
401 %Now the \texttt{drivetype.exe} program allows you to list all local hard
402 %drives. It can help to build dynamic FileSet on Windows.
405 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
409 \section{Additions to the Plugin API}
410 The bfuncs structure has been extended to include a number of
414 The bFuncs structure defines the callback entry points within Bacula
415 that the plugin can use register events, get Bacula values, set
416 Bacula values, and send messages to the Job output or debug output.
418 The exact definition as of this writing is:
420 typedef struct s_baculaFuncs {
423 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
424 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
425 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
426 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
427 int type, utime_t mtime, const char *fmt, ...);
428 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
429 int level, const char *fmt, ...);
430 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
432 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
434 /* New functions follow */
435 bRC (*AddExclude)(bpContext *ctx, const char *file);
436 bRC (*AddInclude)(bpContext *ctx, const char *file);
437 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
438 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
439 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
440 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
446 \item [AddExclude] can be called to exclude a file. The file
447 string passed may include wildcards that will be interpreted by
448 the {\bf fnmatch} subroutine. This function can be called
449 multiple times, and each time the file specified will be added
450 to the list of files to be excluded. Note, this function only
451 permits adding excludes of specific file or directory names,
452 or files matched by the rather simple fnmatch mechanism.
453 See below for information on doing wild-card and regex excludes.
455 \item [NewPreInclude] can be called to create a new Include block. This
456 block will be added after the current defined Include block. This
457 function can be called multiple times, but each time, it will create
458 a new Include section (not normally needed). This function should
459 be called only if you want to add an entirely new Include block.
461 \item [NewInclude] can be called to create a new Include block. This
462 block will be added before any user defined Include blocks. This
463 function can be called multiple times, but each time, it will create
464 a new Include section (not normally needed). This function should
465 be called only if you want to add an entirely new Include block.
467 \item [AddInclude] can be called to add new files/directories to
468 be included. They are added to the current Include block. If
469 NewInclude has not been included, the current Include block is
470 the last one that the user created. This function
471 should be used only if you want to add totally new files/directories
472 to be included in the backup.
474 \item [NewOptions] adds a new Options block to the current Include
475 in front of any other Options blocks. This permits the plugin to
476 add exclude directives (wild-cards and regexes) in front of the
477 user Options, and thus prevent certain files from being backed up.
478 This can be useful if the plugin backs up files, and they should
479 not be also backed up by the main Bacula code. This function
480 may be called multiple times, and each time, it creates a new
481 prepended Options block. Note: normally you want to call this
482 entry point prior to calling AddOptions, AddRegex, or AddWild.
484 \item [AddOptions] allows the plugin it set options in
485 the current Options block, which is normally created with the
486 NewOptions call just prior to adding Include Options.
487 The permitted options are passed as a character string, where
488 each character has a specific meaning as defined below:
491 \item [a] always replace files (default).
492 \item [e] exclude rather than include.
493 \item [h] no recursion into subdirectories.
494 \item [H] do not handle hard links.
495 \item [i] ignore case in wildcard and regex matches.
496 \item [M] compute an MD5 sum.
497 \item [p] use a portable data format on Windows (not recommended).
498 \item [R] backup resource forks and Findr Info.
499 \item [r] read from a fifo
500 \item [S1] compute an SHA1 sum.
501 \item [S2] compute an SHA256 sum.
502 \item [S3] comput an SHA512 sum.
503 \item [s] handle sparse files.
504 \item [m] use st\_mtime only for file differences.
505 \item [k] restore the st\_atime after accessing a file.
506 \item [A] enable ACL backup.
507 \item [Vxxx:] specify verify options. Must terminate with :
508 \item [Cxxx:] specify accurate options. Must terminate with :
509 \item [Jxxx:] specify base job Options. Must terminate with :
510 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
512 \item [Zn] specify gzip compression level n.
513 \item [K] do not use st\_atime in backup decision.
514 \item [c] check if file changed during backup.
515 \item [N] honor no dump flag.
516 \item [X] enable backup of extended attributes.
519 \item [AddRegex] adds a regex expression to the current Options block.
520 The following options are permitted:
522 \item [ ] (a blank) regex applies to whole path and filename.
523 \item [F] regex applies only to the filename (directory or path stripped).
524 \item [D] regex applies only to the directory (path) part of the name.
527 \item [AddWild] adds a wildcard expression to the current Options block.
528 The following options are permitted:
530 \item [ ] (a blank) regex applies to whole path and filename.
531 \item [F] regex applies only to the filename (directory or path stripped).
532 \item [D] regex applies only to the directory (path) part of the name.
535 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
536 that can use Accurate code to compare the file information in argument with
537 the previous file information. The \texttt{delta\_seq} attribute of the
538 \texttt{save\_pkt} will be updated, and the call will return
539 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
544 \subsection{Bacula events}
545 The list of events has been extended to include:
551 bEventStartBackupJob = 3,
552 bEventEndBackupJob = 4,
553 bEventStartRestoreJob = 5,
554 bEventEndRestoreJob = 6,
555 bEventStartVerifyJob = 7,
556 bEventEndVerifyJob = 8,
557 bEventBackupCommand = 9,
558 bEventRestoreCommand = 10,
563 bEventCancelCommand = 13,
564 bEventVssBackupAddComponents = 14,
565 bEventVssRestoreLoadComponentMetadata = 15,
566 bEventVssRestoreSetComponentsSelected = 16,
567 bEventRestoreObject = 17,
568 bEventEndFileSet = 18,
569 bEventPluginCommand = 19,
570 bEventVssBeforeCloseRestore = 20,
571 bEventVssPrepareSnapshot = 21
577 \item [bEventCancelCommand] is called whenever the currently
578 running Job is canceled */
580 \item [bEventVssBackupAddComponents]
582 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
583 provides a char[27] table where the plugin can add Windows drives that will
584 be used during the Job. You need to add them without duplicates, and you can
585 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
589 \section{ACL enhancements}
591 The following enhancements are made to the Bacula Filed with regards to
592 Access Control Lists (ACLs)
595 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
596 POSIX and NFSv4 ACLs.
597 \item Added support for new acl types on FreeBSD 8.1 and later which supports
598 POSIX and NFSv4 ACLs.
599 \item Some generic cleanups for internal ACL handling.
600 \item Fix for acl storage on OSX
601 \item Cleanup of configure checks for ACL detection, now configure only
602 tests for a certain interface type based on the operating system
603 this should give less false positives on detection. Also when ACLs
604 are detected no other acl checks are performed anymore.
608 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
609 and is available with Bacula Enterprise Edition and Community Edition.
611 \section{XATTR enhancements}
613 The following enhancements are made to the Bacula Filed with regards to
614 Extended Attributes (XATTRs)
617 \item Added support for IRIX extended attributes using the attr\_get interface.
618 \item Added support for Tru64 (OSF1) extended attributes using the
619 getproplist interface.
620 \item Added support for AIX extended attributes available in AIX 6.x
621 and higher using the listea/getea/setea interface.
622 \item Added some debugging to generic xattr code so it easier to
624 \item Cleanup of configure checks for XATTR detection, now configure only
625 tests for a certain interface type based on the operating system
626 this should give less false positives on detection. Also when xattrs
627 are detected no other xattr checks are performed anymore.
631 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
632 and is available with Bacula Enterprise Edition and Community Edition.
634 \section{Class Based Database Backend Drivers}
636 The main Bacula Director code is independent of the SQL backend
637 in version 5.2.0 and greater. This means that the Bacula Director can be
638 packaged by itself, then each of the different SQL backends supported can
639 be packaged separately. It is possible to build all the DB backends at the
640 same time by including multiple database options at the same time.
642 ./configure can be run with multiple database configure options.
649 Order of testing for databases is:
656 Each configured backend generates a file named:
657 \verb+libbaccats-<sql_backend_name>-<version>.so+
658 A dummy catalog library is created named libbaccats-version.so
660 At configure time the first detected backend is used as the so called
661 default backend and at install time the dummy
662 \verb+libbaccats-<version>.so+ is replaced with the default backend type.
664 If you configure all three backends you get three backend libraries and the
665 postgresql gets installed as the default.
667 When you want to switch to another database, first save any old catalog you
668 may have then you can copy one of the three backend libraries over the
669 \verb+libbaccats-<version>.so+ e.g.
671 An actual command, depending on your Bacula version might be:
673 cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
676 where the \verb+5.2.2+ must be replaced by the Bacula release
679 Then you must update the default backend in the following files:
682 create_bacula_database
685 grant_bacula_privileges
691 And re-run all the above scripts. Please note, this means
692 you will have a new empty database and if you had a previous
695 All current database backend drivers for catalog information are rewritten
696 to use a set of multi inherited C++ classes which abstract the specific
697 database specific internals and make sure we have a more stable generic
698 interface with the rest of SQL code. From now on there is a strict
699 boundary between the SQL code and the low-level database functions. This
700 new interface should also make it easier to add a new backend for a
701 currently unsupported database. As part of the rewrite the SQLite 2 code
702 was removed (e.g. only SQLite 3 is now supported). An extra bonus of the
703 new code is that you can configure multiple backends in the configure and
704 build all backends in one compile session and select the correct database
705 backend at install time. This should make it a lot easier for packages
711 We also added cursor support for PostgreSQL backend, this improves memory
712 usage for large installation.
715 This project was implemented by Planets Communications B.V. and ELM
716 Consultancy B.V. and Bacula Systems and is available with both the Bacula
717 Enterprise Edition and the Community Edition.
719 \section{Hash List Enhancements}
721 The htable hash table class has been extended with extra hash functions for
722 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
723 Also the hash table initialization routines have been enhanced with
724 support for passing a hint as to the number of initial pages to use
725 for the size of the hash table. Until now the hash table always used
726 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
727 cache have been rewritten to use the new htable class with a small memory
731 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
732 and Bacula Systems and is available with Bacula Enterprise Edition and
737 %%% =====================================================================
742 \chapter{Release Version 5.0.3}
744 There are no new features in version 5.0.2. This version simply fixes a
745 number of bugs found in version 5.0.1 during the ongoing development
748 \chapter{Release Version 5.0.2}
750 There are no new features in version 5.0.2. This version simply fixes a
751 number of bugs found in version 5.0.1 during the ongoing development
757 \chapter{New Features in 5.0.1}
759 This chapter presents the new features that are in the released Bacula version
760 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
761 the ongoing development process.
763 \section{Truncate Volume after Purge}
764 \label{sec:actiononpurge}
766 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
767 the volume when it is purged with the new command \texttt{purge volume
768 action}. It is useful to prevent disk based volumes from consuming too much
774 Action On Purge = Truncate
779 As usual you can also set this property with the \texttt{update volume} command
781 *update volume=xxx ActionOnPurge=Truncate
782 *update volume=xxx actiononpurge=None
785 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
786 following command in interactive mode or in a RunScript as shown after:
788 *purge volume action=truncate storage=File allpools
789 # or by default, action=all
790 *purge volume action storage=File pool=Default
793 This is possible to specify the volume name, the media type, the pool, the
794 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
795 idle when you decide to run this command.
804 Console = "purge volume action=all allpools storage=File"
809 \textbf{Important note}: This feature doesn't work as
810 expected in version 5.0.0. Please do not use it before version 5.0.1.
812 \section{Allow Higher Duplicates}
813 This directive did not work correctly and has been depreciated
814 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
815 file as it will be removed in a future release.
817 \section{Cancel Lower Level Duplicates}
818 This directive was added in Bacula version 5.0.1. It compares the
819 level of a new backup job to old jobs of the same name, if any,
820 and will kill the job which has a lower level than the other one.
821 If the levels are the same (i.e. both are Full backups), then
822 nothing is done and the other Cancel XXX Duplicate directives
825 \chapter{New Features in 5.0.0}
827 \section{Maximum Concurrent Jobs for Devices}
828 \label{sec:maximumconcurrentjobdevice}
830 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
831 Daemon configuration permits setting the maximum number of Jobs that can
832 run concurrently on a specified Device. Using this directive, it is
833 possible to have different Jobs using multiple drives, because when the
834 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
835 Jobs on any other available compatible drive. This facilitates writing to
836 multiple drives with multiple Jobs that all use the same Pool.
838 This project was funded by Bacula Systems.
840 \section{Restore from Multiple Storage Daemons}
841 \index[general]{Restore}
843 Previously, you were able to restore from multiple devices in a single Storage
844 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
845 example, if your full backup runs on a Storage Daemon with an autochanger, and
846 your incremental jobs use another Storage Daemon with lots of disks, Bacula
847 will switch automatically from one Storage Daemon to an other within the same
850 You must upgrade your File Daemon to version 3.1.3 or greater to use this
853 This project was funded by Bacula Systems with the help of Equiinet.
855 \section{File Deduplication using Base Jobs}
856 A base job is sort of like a Full save except that you will want the FileSet to
857 contain only files that are unlikely to change in the future (i.e. a snapshot
858 of most of your system after installing it). After the base job has been run,
859 when you are doing a Full save, you specify one or more Base jobs to be used.
860 All files that have been backed up in the Base job/jobs but not modified will
861 then be excluded from the backup. During a restore, the Base jobs will be
862 automatically pulled in where necessary.
864 This is something none of the competition does, as far as we know (except
865 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
866 win for the user, it makes Bacula stand out as offering a unique optimization
867 that immediately saves time and money. Basically, imagine that you have 100
868 nearly identical Windows or Linux machine containing the OS and user files.
869 Now for the OS part, a Base job will be backed up once, and rather than making
870 100 copies of the OS, there will be only one. If one or more of the systems
871 have some files updated, no problem, they will be automatically restored.
873 See the \ilink{Base Job Chapter}{basejobs} for more information.
875 This project was funded by Bacula Systems.
877 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
878 \index[dir]{AllowCompression}
880 This new directive may be added to Storage resource within the Director's
881 configuration to allow users to selectively disable the client compression for
882 any job which writes to this storage resource.
888 Address = ultrium-tape
889 Password = storage_password # Password for Storage Daemon
892 AllowCompression = No # Tape drive has hardware compression
895 The above example would cause any jobs running with the UltriumTape storage
896 resource to run without compression from the client file daemons. This
897 effectively overrides any compression settings defined at the FileSet level.
899 This feature is probably most useful if you have a tape drive which supports
900 hardware compression. By setting the \texttt{AllowCompression = No} directive
901 for your tape drive storage resource, you can avoid additional load on the file
902 daemon and possibly speed up tape backups.
904 This project was funded by Collaborative Fusion, Inc.
906 \section{Accurate Fileset Options}
907 \label{sec:accuratefileset}
909 In previous versions, the accurate code used the file creation and modification
910 times to determine if a file was modified or not. Now you can specify which
911 attributes to use (time, size, checksum, permission, owner, group, \dots),
912 similar to the Verify options.
928 \item {\bf i} compare the inodes
929 \item {\bf p} compare the permission bits
930 \item {\bf n} compare the number of links
931 \item {\bf u} compare the user id
932 \item {\bf g} compare the group id
933 \item {\bf s} compare the size
934 \item {\bf a} compare the access time
935 \item {\bf m} compare the modification time (st\_mtime)
936 \item {\bf c} compare the change time (st\_ctime)
937 \item {\bf d} report file size decreases
938 \item {\bf 5} compare the MD5 signature
939 \item {\bf 1} compare the SHA1 signature
942 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
943 the File Daemon will have to read all files even if they normally would not
944 be saved. This increases the I/O load, but also the accuracy of the
945 deduplication. By default, Bacula will check modification/creation time
948 This project was funded by Bacula Systems.
950 \section{Tab-completion for Bconsole}
951 \label{sec:tabcompletion}
953 If you build \texttt{bconsole} with readline support, you will be able to use
954 the new auto-completion mode. This mode supports all commands, gives help
955 inside command, and lists resources when required. It works also in the restore
958 To use this feature, you should have readline development package loaded on
959 your system, and use the following option in configure.
961 ./configure --with-readline=/usr/include/readline --disable-conio ...
964 The new bconsole won't be able to tab-complete with older directors.
966 This project was funded by Bacula Systems.
968 \section{Pool File and Job Retention}
969 \label{sec:poolfilejobretention}
971 We added two new Pool directives, \texttt{FileRetention} and
972 \texttt{JobRetention}, that take precedence over Client directives of the same
973 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
974 example, you can decide to increase Retention times for Archive or OffSite Pool.
976 It seems obvious to us, but apparently not to some users, that given the
977 definition above that the Pool File and Job Retention periods is a global
978 override for the normal Client based pruning, which means that when the
979 Job is pruned, the pruning will apply globally to that particular Job.
981 Currently, there is a bug in the implementation that causes any Pool
982 retention periods specified to apply to {\bf all} Pools for that
983 particular Client. Thus we suggest that you avoid using these two
984 directives until this implementation problem is corrected.
986 \section{Read-only File Daemon using capabilities}
987 \label{sec:fdreadonly}
988 This feature implements support of keeping \textbf{ReadAll} capabilities after
989 UID/GID switch, this allows FD to keep root read but drop write permission.
991 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
992 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
995 root@localhost:~# bacula-fd -k -u nobody -g nobody
998 The code for this feature was contributed by our friends at AltLinux.
1003 To help developers of restore GUI interfaces, we have added new \textsl{dot
1004 commands} that permit browsing the catalog in a very simple way.
1007 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
1008 the Bvfs cache in the catalog. You need to run it before any access to the
1011 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
1012 will list all directories in the specified \texttt{path} or
1013 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
1014 encoding of path/filenames.
1016 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
1017 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
1018 \texttt{pathid} avoids problems with character encoding.
1021 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
1022 data that will be displayed.
1025 * .bvfs_update jobid=1,2
1027 * .bvfs_lsdir path=/ jobid=1,2
1030 This project was funded by Bacula Systems.
1032 \section{Testing your Tape Drive}
1033 \label{sec:btapespeed}
1035 To determine the best configuration of your tape drive, you can run the new
1036 \texttt{speed} command available in the \texttt{btape} program.
1038 This command can have the following arguments:
1040 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
1041 (between 1 and 5GB). This counter is in GB.
1042 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
1043 of data should be greater than your memory ($file\_size*nb\_file$).
1044 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
1046 \item[\texttt{skip\_random}] This flag permits to skip tests with random
1048 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
1049 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
1054 *speed file_size=3 skip_raw
1055 btape.c:1078 Test with zero data and bacula block structure.
1056 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1057 ++++++++++++++++++++++++++++++++++++++++++
1058 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1059 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
1061 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
1063 btape.c:1090 Test with random data, should give the minimum throughput.
1064 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1065 +++++++++++++++++++++++++++++++++++++++++++
1066 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1067 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
1068 +++++++++++++++++++++++++++++++++++++++++++
1070 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
1074 When using compression, the random test will give your the minimum throughput
1075 of your drive . The test using constant string will give you the maximum speed
1076 of your hardware chain. (CPU, memory, SCSI card, cable, drive, tape).
1078 You can change the block size in the Storage Daemon configuration file.
1080 \section{New {\bf Block Checksum} Device Directive}
1081 You may now turn off the Block Checksum (CRC32) code
1082 that Bacula uses when writing blocks to a Volume. This is
1089 doing so can reduce the Storage daemon CPU usage slightly. It
1090 will also permit Bacula to read a Volume that has corrupted data.
1092 The default is {\bf yes} -- i.e. the checksum is computed on write
1093 and checked on read.
1095 We do not recommend to turn this off particularly on older tape
1096 drives or for disk Volumes where doing so may allow corrupted data
1099 \section{New Bat Features}
1101 Those new features were funded by Bacula Systems.
1103 \subsection{Media List View}
1105 By clicking on ``Media'', you can see the list of all your volumes. You will be
1106 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1107 in the table. The old ``Media'' view is now known as ``Pool''.
1108 \begin{figure}[htbp]
1110 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
1111 \label{fig:mediaview}
1115 \subsection{Media Information View}
1117 By double-clicking on a volume (on the Media list, in the Autochanger content
1118 or in the Job information panel), you can access a detailed overview of your
1119 Volume. (cf \ref{fig:mediainfo}.)
1120 \begin{figure}[htbp]
1122 \includegraphics[width=13cm]{\idir bat11.eps}
1123 \caption{Media information}
1124 \label{fig:mediainfo}
1127 \subsection{Job Information View}
1129 By double-clicking on a Job record (on the Job run list or in the Media
1130 information panel), you can access a detailed overview of your Job. (cf
1132 \begin{figure}[htbp]
1134 \includegraphics[width=13cm]{\idir bat12.eps}
1135 \caption{Job information}
1139 \subsection{Autochanger Content View}
1141 By double-clicking on a Storage record (on the Storage list panel), you can
1142 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
1143 \begin{figure}[htbp]
1145 \includegraphics[width=13cm]{\idir bat13.eps}
1146 \caption{Autochanger content}
1147 \label{fig:achcontent}
1150 To use this feature, you need to use the latest mtx-changer script
1151 version. (With new \texttt{listall} and \texttt{transfer} commands)
1153 \section{Bat on Windows}
1154 We have ported {\bf bat} to Windows and it is now installed
1155 by default when the installer is run. It works quite well
1156 on Win32, but has not had a lot of testing there, so your
1157 feedback would be welcome. Unfortunately, even though it is
1158 installed by default, it does not yet work on 64 bit Windows
1161 \section{New Win32 Installer}
1162 The Win32 installer has been modified in several very important
1165 \item You must deinstall any current version of the
1166 Win32 File daemon before upgrading to the new one.
1167 If you forget to do so, the new installation will fail.
1168 To correct this failure, you must manually shutdown
1169 and deinstall the old File daemon.
1170 \item All files (other than menu links) are installed
1171 in {\bf c:/Program Files/Bacula}.
1172 \item The installer no longer sets this
1173 file to require administrator privileges by default. If you want
1174 to do so, please do it manually using the {\bf cacls} program.
1177 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1179 \item The server daemons (Director and Storage daemon) are
1180 no longer included in the Windows installer. If you want the
1181 Windows servers, you will either need to build them yourself (note
1182 they have not been ported to 64 bits), or you can contact
1183 Bacula Systems about this.
1186 \section{Win64 Installer}
1187 We have corrected a number of problems that required manual
1188 editing of the conf files. In most cases, it should now
1189 install and work. {\bf bat} is by default installed in
1190 {\bf c:/Program Files/Bacula/bin32} rather than
1191 {\bf c:/Program Files/Bacula} as is the case with the 32
1192 bit Windows installer.
1194 \section{Linux Bare Metal Recovery USB Key}
1195 We have made a number of significant improvements in the
1196 Bare Metal Recovery USB key. Please see the README files
1197 it the {\bf rescue} release for more details.
1199 We are working on an equivalent USB key for Windows bare
1200 metal recovery, but it will take some time to develop it (best
1201 estimate 3Q2010 or 4Q2010)
1204 \section{bconsole Timeout Option}
1205 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1206 for commands. This is useful with GUI programs that use {\bf bconsole}
1207 to interface to the Director.
1209 \section{Important Changes}
1210 \label{sec:importantchanges}
1213 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1214 to the same Pool. The Storage daemon ensures that you do not read and
1215 write to the same Volume.
1216 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1218 \item Virtually all the features of {\bf mtx-changer} have
1219 now been parametrized, which allows you to configure
1220 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1221 that contains variables that you can set to configure mtx-changer.
1222 This configuration file will not be overwritten during upgrades.
1223 We encourage you to submit any changes
1224 that are made to mtx-changer and to parametrize it all in
1225 mtx-changer.conf so that all configuration will be done by
1226 changing only mtx-changer.conf.
1227 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1228 and \texttt{transfer}. Please configure them as appropriate
1229 in mtx-changer.conf.
1230 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1231 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1232 password. If you want to use the new script, you will need to
1233 manually change the \texttt{BackupCatalog} Job definition.
1234 \item The \texttt{bconsole} \texttt{help} command now accepts
1235 an argument, which if provided produces information on that
1236 command (ex: \texttt{help run}).
1240 \subsubsection*{Truncate volume after purge}
1242 Note that the Truncate Volume after purge feature doesn't work as expected
1243 in 5.0.0 version. Please, don't use it before version 5.0.1.
1245 \subsection{Custom Catalog queries}
1247 If you wish to add specialized commands that list the contents of the catalog,
1248 you can do so by adding them to the \texttt{query.sql} file. This
1249 \texttt{query.sql} file is now empty by default. The file
1250 \texttt{examples/sample-query.sql} has an a number of sample commands
1251 you might find useful.
1253 \subsection{Deprecated parts}
1255 The following items have been \textbf{deprecated} for a long time, and are now
1256 removed from the code.
1259 \item Support for SQLite 2
1262 \section{Misc Changes}
1263 \label{sec:miscchanges}
1266 \item Updated Nagios check\_bacula
1267 \item Updated man files
1268 \item Added OSX package generation script in platforms/darwin
1269 \item Added Spanish and Ukrainian Bacula translations
1270 \item Enable/disable command shows only Jobs that can change
1271 \item Added \texttt{show disabled} command to show disabled Jobs
1272 \item Many ACL improvements
1273 \item Added Level to FD status Job output
1274 \item Begin Ingres DB driver (not yet working)
1275 \item Split RedHat spec files into bacula, bat, mtx, and docs
1276 \item Reorganized the manuals (fewer separate manuals)
1277 \item Added lock/unlock order protection in lock manager
1278 \item Allow 64 bit sizes for a number of variables
1279 \item Fixed several deadlocks or potential race conditions in the SD
1282 \chapter{Released Version 3.0.3 and 3.0.3a}
1284 There are no new features in version 3.0.3. This version simply fixes a
1285 number of bugs found in version 3.0.2 during the ongoing development
1288 \chapter{New Features in Released Version 3.0.2}
1290 This chapter presents the new features added to the
1291 Released Bacula Version 3.0.2.
1293 \section{Full Restore from a Given JobId}
1294 \index[general]{Restore menu}
1296 This feature allows selecting a single JobId and having Bacula
1297 automatically select all the other jobs that comprise a full backup up to
1298 and including the selected date (through JobId).
1300 Assume we start with the following jobs:
1302 +-------+--------------+---------------------+-------+----------+------------+
1303 | jobid | client | starttime | level | jobfiles | jobbytes |
1304 +-------+--------------+---------------------+-------+----------+------------
1305 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1306 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1307 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1308 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1309 +-------+--------------+---------------------+-------+----------+------------+
1312 Below is an example of this new feature (which is number 12 in the
1317 To select the JobIds, you have the following choices:
1318 1: List last 20 Jobs run
1319 2: List Jobs where a given File is saved
1321 12: Select full restore to a specified Job date
1324 Select item: (1-13): 12
1325 Enter JobId to get the state to restore: 5
1326 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1327 You have selected the following JobIds: 1,3,5
1329 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1330 1,444 files inserted into the tree.
1333 This project was funded by Bacula Systems.
1335 \section{Source Address}
1336 \index[general]{Source Address}
1338 A feature has been added which allows the administrator to specify the address
1339 from which the Director and File daemons will establish connections. This
1340 may be used to simplify system configuration overhead when working in complex
1341 networks utilizing multi-homing and policy-routing.
1343 To accomplish this, two new configuration directives have been implemented:
1346 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1350 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1354 Simply adding specific host routes on the OS
1355 would have an undesirable side-effect: any
1356 application trying to contact the destination host would be forced to use the
1357 more specific route possibly diverting management traffic onto a backup VLAN.
1358 Instead of adding host routes for each client connected to a multi-homed backup
1359 server (for example where there are management and backup VLANs), one can
1360 use the new directives to specify a specific source address at the application
1363 Additionally, this allows the simplification and abstraction of firewall rules
1364 when dealing with a Hot-Standby director or storage daemon configuration. The
1365 Hot-standby pair may share a CARP address, which connections must be sourced
1366 from, while system services listen and act from the unique interface addresses.
1368 This project was funded by Collaborative Fusion, Inc.
1370 \section{Show volume availability when doing restore}
1372 When doing a restore the selection dialog ends by displaying this
1376 The job will require the following
1377 Volume(s) Storage(s) SD Device(s)
1378 ===========================================================================
1379 *000741L3 LTO-4 LTO3
1380 *000866L3 LTO-4 LTO3
1381 *000765L3 LTO-4 LTO3
1382 *000764L3 LTO-4 LTO3
1383 *000756L3 LTO-4 LTO3
1384 *001759L3 LTO-4 LTO3
1385 *001763L3 LTO-4 LTO3
1389 Volumes marked with ``*'' are online (in the autochanger).
1392 This should help speed up large restores by minimizing the time spent
1393 waiting for the operator to discover that he must change tapes in the library.
1395 This project was funded by Bacula Systems.
1397 \section{Accurate estimate command}
1399 The \texttt{estimate} command can now use the accurate code to detect changes
1400 and give a better estimation.
1402 You can set the accurate behavior on the command line by using
1403 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1406 * estimate listing accurate=yes level=incremental job=BackupJob
1409 This project was funded by Bacula Systems.
1411 \chapter{New Features in 3.0.0}
1412 \label{NewFeaturesChapter}
1413 \index[general]{New Features}
1415 This chapter presents the new features added to the development 2.5.x
1416 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1418 \section{Accurate Backup}
1419 \index[general]{Accurate Backup}
1421 As with most other backup programs, by default Bacula decides what files to
1422 backup for Incremental and Differential backup by comparing the change
1423 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1424 backup completed. If one of those two times is later than the last backup
1425 time, then the file will be backed up. This does not, however, permit tracking
1426 what files have been deleted and will miss any file with an old time that may
1427 have been restored to or moved onto the client filesystem.
1429 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1430 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1431 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1432 backup, there is no difference, but for {\bf Differential} and {\bf
1433 Incremental} backups, the Director will send a list of all previous files
1434 backed up, and the File daemon will use that list to determine if any new files
1435 have been added or or moved and if any files have been deleted. This allows
1436 Bacula to make an accurate backup of your system to that point in time so that
1437 if you do a restore, it will restore your system exactly.
1440 about using Accurate backup is that it requires more resources (CPU and memory)
1441 on both the Director and the Client machines to create the list of previous
1442 files backed up, to send that list to the File daemon, for the File daemon to
1443 keep the list (possibly very big) in memory, and for the File daemon to do
1444 comparisons between every file in the FileSet and the list. In particular,
1445 if your client has lots of files (more than a few million), you will need
1446 lots of memory on the client machine.
1448 Accurate must not be enabled when backing up with a plugin that is not
1449 specially designed to work with Accurate. If you enable it, your restores
1450 will probably not work correctly.
1452 This project was funded by Bacula Systems.
1457 \index[general]{Copy Jobs}
1459 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1460 existing Migration feature with the exception that the Job that is copied is
1461 left unchanged. This essentially creates two identical copies of the same
1462 backup. However, the copy is treated as a copy rather than a backup job, and
1463 hence is not directly available for restore. The {\bf restore} command lists
1464 copy jobs and allows selection of copies by using \texttt{jobid=}
1465 option. If the keyword {\bf copies} is present on the command line, Bacula will
1466 display the list of all copies for selected jobs.
1471 These JobIds have copies as follows:
1472 +-------+------------------------------------+-----------+------------------+
1473 | JobId | Job | CopyJobId | MediaType |
1474 +-------+------------------------------------+-----------+------------------+
1475 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1476 +-------+------------------------------------+-----------+------------------+
1477 +-------+-------+----------+----------+---------------------+------------------+
1478 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1479 +-------+-------+----------+----------+---------------------+------------------+
1480 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1481 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1482 +-------+-------+----------+----------+---------------------+------------------+
1483 You have selected the following JobIds: 19,2
1485 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1486 5,611 files inserted into the tree.
1491 The Copy Job runs without using the File daemon by copying the data from the
1492 old backup Volume to a different Volume in a different Pool. See the Migration
1493 documentation for additional details. For copy Jobs there is a new selection
1494 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1495 not already copied to another Pool.
1497 As with Migration, the Client, Volume, Job, or SQL query, are
1498 other possible ways of selecting the Jobs to be copied. Selection
1499 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1500 work, but are probably more suited for Migration Jobs.
1502 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1503 it will promote the Copy to a \textsl{real} backup job and will make it available for
1504 automatic restore. If more than one Copy is available, it will promote the copy
1505 with the smallest JobId.
1507 A nice solution which can be built with the new Copy feature is often
1508 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1509 look something like the one below:
1513 Name = FullBackupsVirtualPool
1515 Purge Oldest Volume = Yes
1517 NextPool = FullBackupsTapePool
1521 Name = FullBackupsTapePool
1525 Volume Retention = 365 days
1526 Storage = superloader
1530 # Fake fileset for copy jobs
1542 # Fake client for copy jobs
1552 # Default template for a CopyDiskToTape Job
1555 Name = CopyDiskToTape
1557 Messages = StandardCopy
1560 Selection Type = PoolUncopiedJobs
1561 Maximum Concurrent Jobs = 10
1563 Allow Duplicate Jobs = Yes
1564 Cancel Queued Duplicates = No
1565 Cancel Running Duplicates = No
1570 Name = DaySchedule7:00
1571 Run = Level=Full daily at 7:00
1575 Name = CopyDiskToTapeFullBackups
1577 Schedule = DaySchedule7:00
1578 Pool = FullBackupsVirtualPool
1579 JobDefs = CopyDiskToTape
1583 The example above had 2 pool which are copied using the PoolUncopiedJobs
1584 selection criteria. Normal Full backups go to the Virtual pool and are copied
1585 to the Tape pool the next morning.
1587 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1592 +-------+------------------------------------+-----------+------------------+
1593 | JobId | Job | CopyJobId | MediaType |
1594 +-------+------------------------------------+-----------+------------------+
1595 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1596 +-------+------------------------------------+-----------+------------------+
1599 \section{ACL Updates}
1600 \index[general]{ACL Updates}
1601 The whole ACL code had been overhauled and in this version each platforms has
1602 different streams for each type of acl available on such an platform. As ACLs
1603 between platforms tend to be not that portable (most implement POSIX acls but
1604 some use an other draft or a completely different format) we currently only
1605 allow certain platform specific ACL streams to be decoded and restored on the
1606 same platform that they were created on. The old code allowed to restore ACL
1607 cross platform but the comments already mention that not being to wise. For
1608 backward compatibility the new code will accept the two old ACL streams and
1609 handle those with the platform specific handler. But for all new backups it
1610 will save the ACLs using the new streams.
1612 Currently the following platforms support ACLs:
1616 \item {\bf Darwin/OSX}
1625 Currently we support the following ACL types (these ACL streams use a reserved
1626 part of the stream numbers):
1629 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1631 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1632 string representation from acl\_to\_text (POSIX acl)
1633 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1634 string representation from acl\_to\_text (POSIX acl) for default acls.
1635 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1636 string representation from acl\_to\_text (POSIX acl) for access acls.
1637 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1638 string representation from acltostr (POSIX acl)
1639 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1640 representation from acl\_to\_text (POSIX acl) for default acls.
1641 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1642 representation from acl\_to\_text (POSIX acl) for access acls.
1643 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1644 string representation from acl\_to\_text (POSIX acl) for default acls.
1645 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1646 representation from acl\_to\_text (POSIX acl) for access acls.
1647 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1648 string representation from acl\_to\_text (POSIX acl) for default acls.
1649 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1650 string representation from acl\_to\_text (POSIX acl) for default acls.
1651 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1652 representation from acl\_to\_text (POSIX acl) for access acls.
1653 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1654 string representation from acltotext or acl\_totext (POSIX acl)
1655 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1656 representation from from acl\_totext (NFSv4 or ZFS acl)
1659 In future versions we might support conversion functions from one type of acl
1660 into an other for types that are either the same or easily convertible. For now
1661 the streams are separate and restoring them on a platform that doesn't
1662 recognize them will give you a warning.
1664 \section{Extended Attributes}
1665 \index[general]{Extended Attributes}
1666 Something that was on the project list for some time is now implemented for
1667 platforms that support a similar kind of interface. Its the support for backup
1668 and restore of so called extended attributes. As extended attributes are so
1669 platform specific these attributes are saved in separate streams for each
1670 platform. Restores of the extended attributes can only be performed on the
1671 same platform the backup was done. There is support for all types of extended
1672 attributes, but restoring from one type of filesystem onto an other type of
1673 filesystem on the same platform may lead to surprises. As extended attributes
1674 can contain any type of data they are stored as a series of so called
1675 value-pairs. This data must be seen as mostly binary and is stored as such.
1676 As security labels from selinux are also extended attributes this option also
1677 stores those labels and no specific code is enabled for handling selinux
1680 Currently the following platforms support extended attributes:
1682 \item {\bf Darwin/OSX}
1688 On Linux acls are also extended attributes, as such when you enable ACLs on a
1689 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1690 and not the same extended attribute.
1692 To enable the backup of extended attributes please add the following to your
1707 \section{Shared objects}
1708 \index[general]{Shared objects}
1709 A default build of Bacula will now create the libraries as shared objects
1710 (.so) rather than static libraries as was previously the case.
1711 The shared libraries are built using {\bf libtool} so it should be quite
1714 An important advantage of using shared objects is that on a machine with the
1715 Directory, File daemon, the Storage daemon, and a console, you will have only
1716 one copy of the code in memory rather than four copies. Also the total size of
1717 the binary release is smaller since the library code appears only once rather
1718 than once for every program that uses it; this results in significant reduction
1719 in the size of the binaries particularly for the utility tools.
1721 In order for the system loader to find the shared objects when loading the
1722 Bacula binaries, the Bacula shared objects must either be in a shared object
1723 directory known to the loader (typically /usr/lib) or they must be in the
1724 directory that may be specified on the {\bf ./configure} line using the {\bf
1725 {-}{-}libdir} option as:
1728 ./configure --libdir=/full-path/dir
1731 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1732 no need to modify your loader configuration provided that
1733 the shared objects are installed in that directory (Bacula
1734 does this with the make install command). The shared objects
1735 that Bacula references are:
1744 These files are symbolically linked to the real shared object file,
1745 which has a version number to permit running multiple versions of
1746 the libraries if desired (not normally the case).
1748 If you have problems with libtool or you wish to use the old
1749 way of building static libraries, or you want to build a static
1750 version of Bacula you may disable
1751 libtool on the configure command line with:
1754 ./configure --disable-libtool
1758 \section{Building Static versions of Bacula}
1759 \index[general]{Static linking}
1760 In order to build static versions of Bacula, in addition
1761 to configuration options that were needed you now must
1762 also add --disable-libtool. Example
1765 ./configure --enable-static-client-only --disable-libtool
1769 \section{Virtual Backup (Vbackup)}
1770 \index[general]{Virtual Backup}
1771 \index[general]{Vbackup}
1773 Bacula's virtual backup feature is often called Synthetic Backup or
1774 Consolidation in other backup products. It permits you to consolidate the
1775 previous Full backup plus the most recent Differential backup and any
1776 subsequent Incremental backups into a new Full backup. This new Full
1777 backup will then be considered as the most recent Full for any future
1778 Incremental or Differential backups. The VirtualFull backup is
1779 accomplished without contacting the client by reading the previous backup
1780 data and writing it to a volume in a different pool.
1782 In some respects the Vbackup feature works similar to a Migration job, in
1783 that Bacula normally reads the data from the pool specified in the
1784 Job resource, and writes it to the {\bf Next Pool} specified in the
1785 Job resource. Note, this means that usually the output from the Virtual
1786 Backup is written into a different pool from where your prior backups
1787 are saved. Doing it this way guarantees that you will not get a deadlock
1788 situation attempting to read and write to the same volume in the Storage
1789 daemon. If you then want to do subsequent backups, you may need to
1790 move the Virtual Full Volume back to your normal backup pool.
1791 Alternatively, you can set your {\bf Next Pool} to point to the current
1792 pool. This will cause Bacula to read and write to Volumes in the
1793 current pool. In general, this will work, because Bacula will
1794 not allow reading and writing on the same Volume. In any case, once
1795 a VirtualFull has been created, and a restore is done involving the
1796 most current Full, it will read the Volume or Volumes by the VirtualFull
1797 regardless of in which Pool the Volume is found.
1799 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1800 a level of {\bf VirtualFull}.
1802 A typical Job resource definition might look like the following:
1809 FileSet = "Full Set"
1816 # Default pool definition
1820 Recycle = yes # Automatically recycle Volumes
1821 AutoPrune = yes # Prune expired volumes
1822 Volume Retention = 365d # one year
1830 Recycle = yes # Automatically recycle Volumes
1831 AutoPrune = yes # Prune expired volumes
1832 Volume Retention = 365d # one year
1833 Storage = DiskChanger
1836 # Definition of file storage device
1841 Device = FileStorage
1843 Maximum Concurrent Jobs = 5
1846 # Definition of DDS Virtual tape disk storage device
1849 Address = localhost # N.B. Use a fully qualified name here
1851 Device = DiskChanger
1852 Media Type = DiskChangerMedia
1853 Maximum Concurrent Jobs = 4
1858 Then in bconsole or via a Run schedule, you would run the job as:
1861 run job=MyBackup level=Full
1862 run job=MyBackup level=Incremental
1863 run job=MyBackup level=Differential
1864 run job=MyBackup level=Incremental
1865 run job=MyBackup level=Incremental
1868 So providing there were changes between each of those jobs, you would end up
1869 with a Full backup, a Differential, which includes the first Incremental
1870 backup, then two Incremental backups. All the above jobs would be written to
1871 the {\bf Default} pool.
1873 To consolidate those backups into a new Full backup, you would run the
1877 run job=MyBackup level=VirtualFull
1880 And it would produce a new Full backup without using the client, and the output
1881 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1883 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1886 Note, the Start and End time of the Virtual Full backup is set to the
1887 values for the last job included in the Virtual Full (in the above example,
1888 it is an Increment). This is so that if another incremental is done, which
1889 will be based on the Virtual Full, it will backup all files from the
1890 last Job included in the Virtual Full rather than from the time the Virtual
1891 Full was actually run.
1895 \section{Catalog Format}
1896 \index[general]{Catalog Format}
1897 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1898 operation will convert the FileId field of the File table from 32 bits (max 4
1899 billion table entries) to 64 bits (very large number of items). The
1900 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1901 your catalog during the conversion. Also you won't be able to run jobs during
1902 this conversion period. For example, a 3 million file catalog will take 2
1903 minutes to upgrade on a normal machine. Please don't forget to make a valid
1904 backup of your database before executing the upgrade script. See the
1905 ReleaseNotes for additional details.
1907 \section{64 bit Windows Client}
1908 \index[general]{Win64 Client}
1909 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1910 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1911 As a consequence, we are also releasing a 64 bit version of the Bacula
1912 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1913 These binaries should only be installed on 64 bit Windows operating systems.
1914 What is important is not your hardware but whether or not you have
1915 a 64 bit version of the Windows OS.
1917 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1919 \item Before installing the Win64 Bacula Client, you must totally
1920 deinstall any prior 2.4.x Client installation using the
1921 Bacula deinstallation (see the menu item). You may want
1922 to save your .conf files first.
1923 \item Only the Client (File daemon) is ported to Win64, the Director
1924 and the Storage daemon are not in the 64 bit Windows installer.
1925 \item bwx-console is not yet ported.
1926 \item bconsole is ported but it has not been tested.
1927 \item The documentation is not included in the installer.
1928 \item Due to Vista security restrictions imposed on a default installation
1929 of Vista, before upgrading the Client, you must manually stop
1930 any prior version of Bacula from running, otherwise the install
1932 \item Due to Vista security restrictions imposed on a default installation
1933 of Vista, attempting to edit the conf files via the menu items
1934 will fail. You must directly edit the files with appropriate
1935 permissions. Generally double clicking on the appropriate .conf
1936 file will work providing you have sufficient permissions.
1937 \item All Bacula files are now installed in
1938 {\bf C:/Program Files/Bacula} except the main menu items,
1939 which are installed as before. This vastly simplifies the installation.
1940 \item If you are running on a foreign language version of Windows, most
1941 likely {\bf C:/Program Files} does not exist, so you should use the
1942 Custom installation and enter an appropriate location to install
1944 \item The 3.0.0 Win32 Client continues to install files in the locations used
1945 by prior versions. For the next version we will convert it to use
1946 the same installation conventions as the Win64 version.
1949 This project was funded by Bacula Systems.
1952 \section{Duplicate Job Control}
1953 \index[general]{Duplicate Jobs}
1954 The new version of Bacula provides four new directives that
1955 give additional control over what Bacula does if duplicate jobs
1956 are started. A duplicate job in the sense we use it here means
1957 a second or subsequent job with the same name starts. This
1958 happens most frequently when the first job runs longer than expected because no
1959 tapes are available.
1961 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1962 are specified in the Job resource.
1966 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1967 \index[general]{Allow Duplicate Jobs}
1968 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1969 the directive is set to {\bf no} (default) then only one job of a given name
1970 may run at one time, and the action that Bacula takes to ensure only
1971 one job runs is determined by the other directives (see below).
1973 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1974 are present and none of the three directives given below permit
1975 Canceling a job, then the current job (the second one started)
1978 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1979 \index[general]{Allow Higher Duplicates}
1980 This directive was in version 5.0.0, but does not work as
1981 expected. If used, it should always be set to no. In later versions
1982 of Bacula the directive is disabled (disregarded).
1984 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1985 \index[general]{Cancel Running Duplicates}
1986 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1987 if this directive is set to {\bf yes} any job that is already running
1988 will be canceled. The default is {\bf no}.
1990 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1991 \index[general]{Cancel Queued Duplicates}
1992 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1993 if this directive is set to {\bf yes} any job that is
1994 already queued to run but not yet running will be canceled.
1995 The default is {\bf no}.
1998 \section{TLS Authentication}
1999 \index[general]{TLS Authentication}
2000 In Bacula version 2.5.x and later, in addition to the normal Bacula
2001 CRAM-MD5 authentication that is used to authenticate each Bacula
2002 connection, you can specify that you want TLS Authentication as well,
2003 which will provide more secure authentication.
2005 This new feature uses Bacula's existing TLS code (normally used for
2006 communications encryption) to do authentication. To use it, you must
2007 specify all the TLS directives normally used to enable communications
2008 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
2011 \subsection{TLS Authenticate = yes}
2013 TLS Authenticate = yes
2016 in the main daemon configuration resource (Director for the Director,
2017 Client for the File daemon, and Storage for the Storage daemon).
2019 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
2020 authentication, Bacula will also do TLS authentication, then TLS
2021 encryption will be turned off, and the rest of the communication between
2022 the two Bacula daemons will be done without encryption.
2024 If you want to encrypt communications data, use the normal TLS directives
2025 but do not turn on {\bf TLS Authenticate}.
2027 \section{bextract non-portable Win32 data}
2028 \index[general]{bextract handles Win32 non-portable data}
2029 {\bf bextract} has been enhanced to be able to restore
2030 non-portable Win32 data to any OS. Previous versions were
2031 unable to restore non-portable Win32 data to machines that
2032 did not have the Win32 BackupRead and BackupWrite API calls.
2034 \section{State File updated at Job Termination}
2035 \index[general]{State File}
2036 In previous versions of Bacula, the state file, which provides a
2037 summary of previous jobs run in the {\bf status} command output was
2038 updated only when Bacula terminated, thus if the daemon crashed, the
2039 state file might not contain all the run data. This version of
2040 the Bacula daemons updates the state file on each job termination.
2042 \section{MaxFullInterval = \lt{}time-interval\gt{}}
2043 \index[general]{MaxFullInterval}
2044 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
2045 can be used to specify the maximum time interval between {\bf Full} backup
2046 jobs. When a job starts, if the time since the last Full backup is
2047 greater than the specified interval, and the job would normally be an
2048 {\bf Incremental} or {\bf Differential}, it will be automatically
2049 upgraded to a {\bf Full} backup.
2051 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
2052 \index[general]{MaxDiffInterval}
2053 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
2054 can be used to specify the maximum time interval between {\bf Differential} backup
2055 jobs. When a job starts, if the time since the last Differential backup is
2056 greater than the specified interval, and the job would normally be an
2057 {\bf Incremental}, it will be automatically
2058 upgraded to a {\bf Differential} backup.
2060 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
2061 \index[general]{MaxDiffInterval}
2062 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
2063 by the user, and when it is set it is an indication to backup programs
2064 to not backup that particular file. This version of Bacula contains a
2065 new Options directive within a FileSet resource, which instructs Bacula to
2066 obey this flag. The new directive is:
2069 Honor No Dump Flag = yes\vb{}no
2072 The default value is {\bf no}.
2075 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
2076 \index[general]{IgnoreDir}
2077 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
2078 can be added to the Include section of the FileSet resource. If the specified
2079 filename ({\bf filename-string}) is found on the Client in any directory to be
2080 backed up, the whole directory will be ignored (not backed up). For example:
2083 # List of files to be backed up
2091 Exclude Dir Containing = .excludeme
2096 But in /home, there may be hundreds of directories of users and some
2097 people want to indicate that they don't want to have certain
2098 directories backed up. For example, with the above FileSet, if
2099 the user or sysadmin creates a file named {\bf .excludeme} in
2100 specific directories, such as
2103 /home/user/www/cache/.excludeme
2104 /home/user/temp/.excludeme
2107 then Bacula will not backup the two directories named:
2110 /home/user/www/cache
2114 NOTE: subdirectories will not be backed up. That is, the directive
2115 applies to the two directories in question and any children (be they
2116 files, directories, etc).
2119 \section{Bacula Plugins}
2120 \index[general]{Plugin}
2121 Support for shared object plugins has been implemented in the Linux, Unix
2122 and Win32 File daemons. The API will be documented separately in
2123 the Developer's Guide or in a new document. For the moment, there is
2124 a single plugin named {\bf bpipe} that allows an external program to
2125 get control to backup and restore a file.
2127 Plugins are also planned (partially implemented) in the Director and the
2130 \subsection{Plugin Directory}
2131 \index[general]{Plugin Directory}
2132 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2133 be added to the daemon definition resource. The directory takes a quoted
2134 string argument, which is the name of the directory in which the daemon can
2135 find the Bacula plugins. If this directive is not specified, Bacula will not
2136 load any plugins. Since each plugin has a distinctive name, all the daemons
2137 can share the same plugin directory.
2139 \subsection{Plugin Options}
2140 \index[general]{Plugin Options}
2141 The {\bf Plugin Options} directive takes a quoted string
2142 argument (after the equal sign) and may be specified in the
2143 Job resource. The options specified will be passed to all plugins
2144 when they are run. This each plugin must know what it is looking
2145 for. The value defined in the Job resource can be modified
2146 by the user when he runs a Job via the {\bf bconsole} command line
2149 Note: this directive may be specified, and there is code to modify
2150 the string in the run command, but the plugin options are not yet passed to
2151 the plugin (i.e. not fully implemented).
2153 \subsection{Plugin Options ACL}
2154 \index[general]{Plugin Options ACL}
2155 The {\bf Plugin Options ACL} directive may be specified in the
2156 Director's Console resource. It functions as all the other ACL commands
2157 do by permitting users running restricted consoles to specify a
2158 {\bf Plugin Options} that overrides the one specified in the Job
2159 definition. Without this directive restricted consoles may not modify
2162 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2163 \index[general]{Plugin}
2164 The {\bf Plugin} directive is specified in the Include section of
2165 a FileSet resource where you put your {\bf File = xxx} directives.
2176 Plugin = "bpipe:..."
2181 In the above example, when the File daemon is processing the directives
2182 in the Include section, it will first backup all the files in {\bf /home}
2183 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2184 the Plugin Directory. The syntax and semantics of the Plugin directive
2185 require the first part of the string up to the colon (:) to be the name
2186 of the plugin. Everything after the first colon is ignored by the File daemon but
2187 is passed to the plugin. Thus the plugin writer may define the meaning of the
2188 rest of the string as he wishes.
2190 Please see the next section for information about the {\bf bpipe} Bacula
2193 \section{The bpipe Plugin}
2194 \index[general]{The bpipe Plugin}
2195 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2196 the Bacula source distribution. When the plugin is compiled and linking into
2197 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2198 Please note that this is a very simple plugin that was written for
2199 demonstration and test purposes. It is and can be used in production, but
2200 that was never really intended.
2202 The purpose of the plugin is to provide an interface to any system program for
2203 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2204 the Include section of your Job's FileSet resource. The full syntax of the
2205 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2206 to specify the sytax as it wishes) is:
2209 Plugin = "<field1>:<field2>:<field3>:<field4>"
2214 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2215 stripped off, so in this case, we would put {\bf bpipe} in this field.
2217 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2218 pseudo path and filename under which the backup will be saved. This pseudo
2219 path and filename will be seen by the user in the restore file tree.
2220 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2221 backed up by the plugin will be put under that "pseudo" path and filename.
2222 You must be careful to choose a naming convention that is unique to avoid
2223 a conflict with a path and filename that actually exists on your system.
2225 \item {\bf field3} for the {\bf bpipe} plugin
2226 specifies the "reader" program that is called by the plugin during
2227 backup to read the data. {\bf bpipe} will call this program by doing a
2230 \item {\bf field4} for the {\bf bpipe} plugin
2231 specifies the "writer" program that is called by the plugin during
2232 restore to write the data back to the filesystem.
2235 Please note that for two items above describing the "reader" and "writer"
2236 fields, these programs are "executed" by Bacula, which
2237 means there is no shell interpretation of any command line arguments
2238 you might use. If you want to use shell characters (redirection of input
2239 or output, ...), then we recommend that you put your command or commands
2240 in a shell script and execute the script. In addition if you backup a
2241 file with the reader program, when running the writer program during
2242 the restore, Bacula will not automatically create the path to the file.
2243 Either the path must exist, or you must explicitly do so with your command
2244 or in a shell script.
2246 Putting it all together, the full plugin directive line might look
2250 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2251 --opt --databases bacula:mysql"
2254 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2255 would be written on a single line.
2257 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2258 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2259 program {\bf mysqldump -f --opt --database bacula} to read the data during
2260 backup. The mysqldump command outputs all the data for the database named
2261 {\bf bacula}, which will be read by the plugin and stored in the backup.
2262 During restore, the data that was backed up will be sent to the program
2263 specified in the last field, which in this case is {\bf mysql}. When
2264 {\bf mysql} is called, it will read the data sent to it by the plugn
2265 then write it back to the same database from which it came ({\bf bacula}
2268 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2269 the data from a specified program to Bacula for backup, and then from Bacula to
2270 a specified program for restore.
2272 By using different command lines to {\bf bpipe},
2273 you can backup any kind of data (ASCII or binary) depending
2274 on the program called.
2276 \section{Microsoft Exchange Server 2003/2007 Plugin}
2277 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2278 \subsection{Background}
2279 The Exchange plugin was made possible by a funded development project
2280 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2281 The code for the plugin was written by James Harper, and the Bacula core
2282 code by Kern Sibbald. All the code for this funded development has become
2283 part of the Bacula project. Thanks to everyone who made it happen.
2285 \subsection{Concepts}
2286 Although it is possible to backup Exchange using Bacula VSS the Exchange
2287 plugin adds a good deal of functionality, because while Bacula VSS
2288 completes a full backup (snapshot) of Exchange, it does
2289 not support Incremental or Differential backups, restoring is more
2290 complicated, and a single database restore is not possible.
2292 Microsoft Exchange organises its storage into Storage Groups with
2293 Databases inside them. A default installation of Exchange will have a
2294 single Storage Group called 'First Storage Group', with two Databases
2295 inside it, "Mailbox Store (SERVER NAME)" and
2296 "Public Folder Store (SERVER NAME)",
2297 which hold user email and public folders respectively.
2299 In the default configuration, Exchange logs everything that happens to
2300 log files, such that if you have a backup, and all the log files since,
2301 you can restore to the present time. Each Storage Group has its own set
2302 of log files and operates independently of any other Storage Groups. At
2303 the Storage Group level, the logging can be turned off by enabling a
2304 function called "Enable circular logging". At this time the Exchange
2305 plugin will not function if this option is enabled.
2307 The plugin allows backing up of entire storage groups, and the restoring
2308 of entire storage groups or individual databases. Backing up and
2309 restoring at the individual mailbox or email item is not supported but
2310 can be simulated by use of the "Recovery" Storage Group (see below).
2312 \subsection{Installing}
2313 The Exchange plugin requires a DLL that is shipped with Microsoft
2314 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2315 correctly the Exchange plugin should find this automatically and run
2316 without any additional installation.
2318 If the DLL can not be found automatically it will need to be copied into
2319 the Bacula installation
2320 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2321 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2322 default Exchange installation.
2324 \subsection{Backing Up}
2325 To back up an Exchange server the Fileset definition must contain at
2326 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2327 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2328 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2329 up files are prefixed with something that isn't going to share a name
2330 with something outside the plugin, and the 'Microsoft Information Store'
2331 bit is required also. It is also possible to add the name of a storage
2332 group to the "Plugin =" line, eg \\
2333 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2334 if you want only a single storage group backed up.
2336 Additionally, you can suffix the 'Plugin =' directive with
2337 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2338 database at the end of a full backup.
2340 An Incremental or Differential backup will backup only the database logs
2341 for each Storage Group by inspecting the "modified date" on each
2342 physical log file. Because of the way the Exchange API works, the last
2343 logfile backed up on each backup will always be backed up by the next
2344 Incremental or Differential backup too. This adds 5MB to each
2345 Incremental or Differential backup size but otherwise does not cause any
2348 By default, a normal VSS fileset containing all the drive letters will
2349 also back up the Exchange databases using VSS. This will interfere with
2350 the plugin and Exchange's shared ideas of when the last full backup was
2351 done, and may also truncate log files incorrectly. It is important,
2352 therefore, that the Exchange database files be excluded from the backup,
2353 although the folders the files are in should be included, or they will
2354 have to be recreated manually if a bare metal restore is done.
2359 File = C:/Program Files/Exchsrvr/mdbdata
2360 Plugin = "exchange:..."
2363 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2364 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2365 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2366 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2367 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2368 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2369 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2374 The advantage of excluding the above files is that you can significantly
2375 reduce the size of your backup since all the important Exchange files
2376 will be properly saved by the Plugin.
2379 \subsection{Restoring}
2380 The restore operation is much the same as a normal Bacula restore, with
2381 the following provisos:
2384 \item The {\bf Where} restore option must not be specified
2385 \item Each Database directory must be marked as a whole. You cannot just
2386 select (say) the .edb file and not the others.
2387 \item If a Storage Group is restored, the directory of the Storage Group
2389 \item It is possible to restore only a subset of the available log files,
2390 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2391 if a log file is missing from the sequence of log files
2392 \item Each database to be restored must be dismounted and marked as "Can be
2393 overwritten by restore"
2394 \item If an entire Storage Group is to be restored (eg all databases and
2395 logs in the Storage Group), then it is best to manually delete the
2396 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2397 as Exchange can get confused by stray log files lying around.
2400 \subsection{Restoring to the Recovery Storage Group}
2401 The concept of the Recovery Storage Group is well documented by
2403 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2404 but to briefly summarize...
2406 Microsoft Exchange allows the creation of an additional Storage Group
2407 called the Recovery Storage Group, which is used to restore an older
2408 copy of a database (e.g. before a mailbox was deleted) into without
2409 messing with the current live data. This is required as the Standard and
2410 Small Business Server versions of Exchange can not ordinarily have more
2411 than one Storage Group.
2413 To create the Recovery Storage Group, drill down to the Server in Exchange
2414 System Manager, right click, and select
2415 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2416 locations and click OK. On the Recovery Storage Group, right click and
2417 select {\bf "Add Database to Recover..."} and select the database you will
2420 Restore only the single database nominated as the database in the
2421 Recovery Storage Group. Exchange will redirect the restore to the
2422 Recovery Storage Group automatically.
2423 Then run the restore.
2425 \subsection{Restoring on Microsoft Server 2007}
2426 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2427 2007, and hence you use a new procedure for recovering a single mail box.
2428 This procedure is documented by Microsoft at:
2429 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2430 and involves using the {\bf Restore-Mailbox} and {\bf
2431 Get-Mailbox Statistics} shell commands.
2433 \subsection{Caveats}
2434 This plugin is still being developed, so you should consider it
2435 currently in BETA test, and thus use in a production environment
2436 should be done only after very careful testing.
2438 When doing a full backup, the Exchange database logs are truncated by
2439 Exchange as soon as the plugin has completed the backup. If the data
2440 never makes it to the backup medium (eg because of spooling) then the
2441 logs will still be truncated, but they will also not have been backed
2442 up. A solution to this is being worked on. You will have to schedule a
2443 new Full backup to ensure that your next backups will be usable.
2445 The "Enable Circular Logging" option cannot be enabled or the plugin
2448 Exchange insists that a successful Full backup must have taken place if
2449 an Incremental or Differential backup is desired, and the plugin will
2450 fail if this is not the case. If a restore is done, Exchange will
2451 require that a Full backup be done before an Incremental or Differential
2454 The plugin will most likely not work well if another backup application
2455 (eg NTBACKUP) is backing up the Exchange database, especially if the
2456 other backup application is truncating the log files.
2458 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2459 we recommend either carefully testing or that you avoid this option for
2462 The Exchange plugin is not called during processing the bconsole {\bf
2463 estimate} command, and so anything that would be backed up by the plugin
2464 will not be added to the estimate total that is displayed.
2467 \section{libdbi Framework}
2468 \index[general]{libdbi Framework}
2469 As a general guideline, Bacula has support for a few catalog database drivers
2470 (MySQL, PostgreSQL, SQLite)
2471 coded natively by the Bacula team. With the libdbi implementation, which is a
2472 Bacula driver that uses libdbi to access the catalog, we have an open field to
2473 use many different kinds database engines following the needs of users.
2475 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2476 implements a database-independent abstraction layer in C, similar to the
2477 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2478 leverage the power of multiple databases and multiple simultaneous database
2479 connections by using this framework.
2481 Currently the libdbi driver in Bacula project only supports the same drivers
2482 natively coded in Bacula. However the libdbi project has support for many
2483 others database engines. You can view the list at
2484 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2485 supported by Bacula, however, they must be tested properly by the Bacula team.
2487 Some of benefits of using libdbi are:
2489 \item The possibility to use proprietary databases engines in which your
2490 proprietary licenses prevent the Bacula team from developing the driver.
2491 \item The possibility to use the drivers written for the libdbi project.
2492 \item The possibility to use other database engines without recompiling Bacula
2493 to use them. Just change one line in bacula-dir.conf
2494 \item Abstract Database access, this is, unique point to code and profiling
2495 catalog database access.
2498 The following drivers have been tested:
2500 \item PostgreSQL, with and without batch insert
2501 \item Mysql, with and without batch insert
2506 In the future, we will test and approve to use others databases engines
2507 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2509 To compile Bacula to support libdbi we need to configure the code with the
2510 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2511 [database] is the database engine to be used with Bacula (of course we can
2512 change the driver in file bacula-dir.conf, see below). We must configure the
2513 access port of the database engine with the option --with-db-port, because the
2514 libdbi framework doesn't know the default access port of each database.
2516 The next phase is checking (or configuring) the bacula-dir.conf, example:
2520 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2521 dbname = regress; user = regress; password = ""
2525 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2526 mysql database. Currently the drivers supported by Bacula are: postgresql,
2527 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2529 The following limitations apply when Bacula is set to use the libdbi framework:
2530 - Not tested on the Win32 platform
2531 - A little performance is lost if comparing with native database driver.
2532 The reason is bound with the database driver provided by libdbi and the
2533 simple fact that one more layer of code was added.
2535 It is important to remember, when compiling Bacula with libdbi, the
2536 following packages are needed:
2538 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2539 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2542 You can download them and compile them on your system or install the packages
2543 from your OS distribution.
2545 \section{Console Command Additions and Enhancements}
2546 \index[general]{Console Additions}
2548 \subsection{Display Autochanger Content}
2549 \index[general]{StatusSlots}
2551 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2552 autochanger content.
2556 Slot | Volume Name | Status | Media Type | Pool |
2557 ------+---------------+----------+-------------------+------------|
2558 1 | 00001 | Append | DiskChangerMedia | Default |
2559 2 | 00002 | Append | DiskChangerMedia | Default |
2560 3*| 00003 | Append | DiskChangerMedia | Scratch |
2565 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2566 {\bf update slots} command to synchronize autochanger content with your
2569 \subsection{list joblog job=xxx or jobid=nnn}
2570 \index[general]{list joblog}
2571 A new list command has been added that allows you to list the contents
2572 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2573 or for a particular JobId. The {\bf llist} command will include a line with
2574 the time and date of the entry.
2576 Note for the catalog to have Job Log entries, you must have a directive
2583 In your Director's {\bf Messages} resource.
2585 \subsection{Use separator for multiple commands}
2586 \index[general]{Command Separator}
2587 When using bconsole with readline, you can set the command separator with
2588 \textbf{@separator} command to one
2589 of those characters to write commands who require multiple input in one line.
2591 !$%&'()*+,-/:;<>?[]^`{|}~
2594 \subsection{Deleting Volumes}
2595 The delete volume bconsole command has been modified to
2596 require an asterisk (*) in front of a MediaId otherwise the
2597 value you enter is a taken to be a Volume name. This is so that
2598 users may delete numeric Volume names. The previous Bacula versions
2599 assumed that all input that started with a number was a MediaId.
2601 This new behavior is indicated in the prompt if you read it
2604 \section{Bare Metal Recovery}
2605 The old bare metal recovery project is essentially dead. One
2606 of the main features of it was that it would build a recovery
2607 CD based on the kernel on your system. The problem was that
2608 every distribution has a different boot procedure and different
2609 scripts, and worse yet, the boot procedures and scripts change
2610 from one distribution to another. This meant that maintaining
2611 (keeping up with the changes) the rescue CD was too much work.
2613 To replace it, a new bare metal recovery USB boot stick has been developed
2614 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2615 boot from a USB key.
2619 \item Recovery can be done from within graphical environment.
2620 \item Recovery can be done in a shell.
2621 \item Ubuntu boots on a large number of Linux systems.
2622 \item The process of updating the system and adding new
2623 packages is not too difficult.
2624 \item The USB key can easily be upgraded to newer Ubuntu versions.
2625 \item The USB key has writable partitions for modifications to
2626 the OS and for modification to your home directory.
2627 \item You can add new files/directories to the USB key very easily.
2628 \item You can save the environment from multiple machines on
2630 \item Bacula Systems is funding its ongoing development.
2633 The disadvantages are:
2635 \item The USB key is usable but currently under development.
2636 \item Not everyone may be familiar with Ubuntu (no worse
2638 \item Some older OSes cannot be booted from USB. This can
2639 be resolved by first booting a Ubuntu LiveCD then plugging
2641 \item Currently the documentation is sketchy and not yet added
2642 to the main manual. See below ...
2645 The documentation and the code can be found in the {\bf rescue} package
2646 in the directory {\bf linux/usb}.
2648 \section{Miscellaneous}
2649 \index[general]{Misc New Features}
2651 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2652 \index[general]{Allow Mixed Priority}
2653 This directive is only implemented in version 2.5 and later. When
2654 set to {\bf yes} (default {\bf no}), this job may run even if lower
2655 priority jobs are already running. This means a high priority job
2656 will not have to wait for other jobs to finish before starting.
2657 The scheduler will only mix priorities when all running jobs have
2660 Note that only higher priority jobs will start early. Suppose the
2661 director will allow two concurrent jobs, and that two jobs with
2662 priority 10 are running, with two more in the queue. If a job with
2663 priority 5 is added to the queue, it will be run as soon as one of
2664 the running jobs finishes. However, new priority 10 jobs will not
2665 be run until the priority 5 job has finished.
2667 \subsection{Bootstrap File Directive -- FileRegex}
2668 \index[general]{Bootstrap File Directive}
2669 {\bf FileRegex} is a new command that can be added to the bootstrap
2670 (.bsr) file. The value is a regular expression. When specified, only
2671 matching filenames will be restored.
2673 During a restore, if all File records are pruned from the catalog
2674 for a Job, normally Bacula can restore only all files saved. That
2675 is there is no way using the catalog to select individual files.
2676 With this new feature, Bacula will ask if you want to specify a Regex
2677 expression for extracting only a part of the full backup.
2680 Building directory tree for JobId(s) 1,3 ...
2681 There were no files inserted into the tree, so file selection
2682 is not possible.Most likely your retention policy pruned the files
2684 Do you want to restore all the files? (yes\vb{}no): no
2686 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2687 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2690 \subsection{Bootstrap File Optimization Changes}
2691 In order to permit proper seeking on disk files, we have extended the bootstrap
2692 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2693 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2694 address range and end address range respectively. These two directives replace
2695 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2696 VolEndBlock} directives. Bootstrap files containing the old directives will
2697 still work, but will not properly take advantage of proper disk seeking, and
2698 may read completely to the end of a disk volume during a restore. With the new
2699 format (automatically generated by the new Director), restores will seek
2700 properly and stop reading the volume when all the files have been restored.
2702 \subsection{Solaris ZFS/NFSv4 ACLs}
2703 This is an upgrade of the previous Solaris ACL backup code
2704 to the new library format, which will backup both the old
2705 POSIX(UFS) ACLs as well as the ZFS ACLs.
2707 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2708 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2709 be used to transfer from UFS to ZFS filesystems.
2712 \subsection{Virtual Tape Emulation}
2713 \index[general]{Virtual Tape Emulation}
2714 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2715 the tape code but actually reading and writing to a disk file. Used with the
2716 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2717 and 700 slots. This feature is most useful in testing. It is enabled
2718 by using {\bf Device Type = vtape} in the Storage daemon's Device
2719 directive. This feature is only implemented on Linux machines and should not be
2720 used for production.
2722 \subsection{Bat Enhancements}
2723 \index[general]{Bat Enhancements}
2724 Bat (the Bacula Administration Tool) GUI program has been significantly
2725 enhanced and stabilized. In particular, there are new table based status
2726 commands; it can now be easily localized using Qt4 Linguist.
2728 The Bat communications protocol has been significantly enhanced to improve
2729 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2730 the Director you are using otherwise the communications protocol will not
2733 \subsection{RunScript Enhancements}
2734 \index[general]{RunScript Enhancements}
2735 The {\bf RunScript} resource has been enhanced to permit multiple
2736 commands per RunScript. Simply specify multiple {\bf Command} directives
2743 Command = "/bin/echo test"
2744 Command = "/bin/echo an other test"
2745 Command = "/bin/echo 3 commands in the same runscript"
2752 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2753 implemented, which runs the command after the Volume Shadow Copy has been made.
2755 Console commands can be specified within a RunScript by using:
2756 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2757 carefully tested and debugged and is known to easily crash the Director.
2758 We would appreciate feedback. Due to the recursive nature of this command, we
2759 may remove it before the final release.
2761 \subsection{Status Enhancements}
2762 \index[general]{Status Enhancements}
2763 The bconsole {\bf status dir} output has been enhanced to indicate
2764 Storage daemon job spooling and despooling activity.
2766 \subsection{Connect Timeout}
2767 \index[general]{Connect Timeout}
2768 The default connect timeout to the File
2769 daemon has been set to 3 minutes. Previously it was 30 minutes.
2771 \subsection{ftruncate for NFS Volumes}
2772 \index[general]{ftruncate for NFS Volumes}
2773 If you write to a Volume mounted by NFS (say on a local file server),
2774 in previous Bacula versions, when the Volume was recycled, it was not
2775 properly truncated because NFS does not implement ftruncate (file
2776 truncate). This is now corrected in the new version because we have
2777 written code (actually a kind user) that deletes and recreates the Volume,
2778 thus accomplishing the same thing as a truncate.
2780 \subsection{Support for Ubuntu}
2781 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2782 version of Linux, and thus now provides correct autostart routines.
2783 Since Ubuntu officially supports Bacula, you can also obtain any
2784 recent release of Bacula from the Ubuntu repositories.
2786 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2787 \index[general]{Recycle Pool}
2788 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2789 be placed (moved) when it is recycled. Without this directive, a Volume will
2790 remain in the same pool when it is recycled. With this directive, it can be
2791 moved automatically to any existing pool during a recycle. This directive is
2792 probably most useful when defined in the Scratch pool, so that volumes will
2793 be recycled back into the Scratch pool.
2795 \subsection{FD Version}
2796 \index[general]{FD Version}
2797 The File daemon to Director protocol now includes a version
2798 number, which although there is no visible change for users,
2799 will help us in future versions automatically determine
2800 if a File daemon is not compatible.
2802 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2803 \index[general]{Max Run Sched Time}
2804 The time specifies the maximum allowed time that a job may run, counted from
2805 when the job was scheduled. This can be useful to prevent jobs from running
2806 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2809 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2810 \index[general]{Max Wait Time}
2811 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2812 of checking the maximum allowed time that a job may block for a resource,
2813 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2814 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2815 their job depending on the level. Now, they have to use
2816 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2817 directives are now deprecated.
2819 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2820 \index[general]{Incremental Max Wait Time}
2821 \index[general]{Differential Max Wait Time}
2823 These directives have been deprecated in favor of
2824 \texttt{Incremental|Differential Max Run Time}.
2826 \subsection{Max Run Time directives}
2827 \index[general]{Max Run Time directives}
2828 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2829 maximum allowed time that a job can run depending on the level.
2831 \addcontentsline{lof}{figure}{Job time control directives}
2832 \includegraphics{\idir different_time.eps}
2834 \subsection{Statistics Enhancements}
2835 \index[general]{Statistics Enhancements}
2836 If you (or probably your boss) want to have statistics on your backups to
2837 provide some \textit{Service Level Agreement} indicators, you could use a few
2838 SQL queries on the Job table to report how many:
2842 \item jobs have been successful
2843 \item files have been backed up
2847 However, these statistics are accurate only if your job retention is greater
2848 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2849 be able to use them.
2851 Now, you can use the \textbf{update stats [days=num]} console command to fill
2852 the JobHistory table with new Job records. If you want to be sure to take in
2853 account only \textbf{good jobs}, ie if one of your important job has failed but
2854 you have fixed the problem and restarted it on time, you probably want to
2855 delete the first \textit{bad} job record and keep only the successful one. For
2856 that simply let your staff do the job, and update JobHistory table after two or
2857 three days depending on your organization using the \textbf{[days=num]} option.
2859 These statistics records aren't used for restoring, but mainly for
2860 capacity planning, billings, etc.
2862 The Bweb interface provides a statistics module that can use this feature. You
2863 can also use tools like Talend or extract information by yourself.
2865 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2866 the length of time that Bacula will keep statistics job records in the Catalog
2867 database after the Job End time. (In \texttt{JobHistory} table) When this time
2868 period expires, and if user runs \texttt{prune stats} command, Bacula will
2869 prune (remove) Job records that are older than the specified period.
2871 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2872 job to maintain statistics.
2875 Name = BackupCatalog
2878 Console = "update stats days=3"
2879 Console = "prune stats yes"
2886 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2887 \index[general]{ScratchPool}
2888 This directive permits to specify a specific \textsl{Scratch} pool for the
2889 current pool. This is useful when using multiple storage sharing the same
2890 mediatype or when you want to dedicate volumes to a particular set of pool.
2892 \subsection{Enhanced Attribute Despooling}
2893 \index[general]{Attribute Despooling}
2894 If the storage daemon and the Director are on the same machine, the spool file
2895 that contains attributes is read directly by the Director instead of being
2896 transmitted across the network. That should reduce load and speedup insertion.
2898 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2899 \index[general]{SpoolSize}
2900 A new Job directive permits to specify the spool size per job. This is used
2901 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2903 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2904 \index[general]{MaximumConsoleConnections}
2905 A new director directive permits to specify the maximum number of Console
2906 Connections that could run concurrently. The default is set to 20, but you may
2907 set it to a larger number.
2909 \subsection{VerId = \lt{}string\gt{}}
2910 \index[general]{VerId}
2911 A new director directive permits to specify a personnal identifier that will be
2912 displayed in the \texttt{version} command.
2914 \subsection{dbcheck enhancements}
2915 \index[general]{dbcheck enhancements}
2916 If you are using Mysql, dbcheck will now ask you if you want to create
2917 temporary indexes to speed up orphaned Path and Filename elimination.
2919 A new \texttt{-B} option allows you to print catalog information in a simple
2920 text based format. This is useful to backup it in a secure way.
2935 You can now specify the database connection port in the command line.
2937 \subsection{{-}{-}docdir configure option}
2938 \index[general]{{-}{-}docdir configure option}
2939 You can use {-}{-}docdir= on the ./configure command to
2940 specify the directory where you want Bacula to install the
2941 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2942 {\bf /usr/share/doc/bacula}.
2944 \subsection{{-}{-}htmldir configure option}
2945 \index[general]{{-}{-}htmldir configure option}
2946 You can use {-}{-}htmldir= on the ./configure command to
2947 specify the directory where you want Bacula to install the bat html help
2948 files. The default is {\bf /usr/share/doc/bacula/html}
2950 \subsection{{-}{-}with-plugindir configure option}
2951 \index[general]{{-}{-}plugindir configure option}
2952 You can use {-}{-}plugindir= on the ./configure command to
2953 specify the directory where you want Bacula to install
2954 the plugins (currently only bpipe-fd). The default is