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 was added in the Unix File Daemon. From the user 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 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 built-in compression may be a better option.
44 LZO is a good altenative for GZIP1 when you don't want to slow down your
45 backup. On 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 that bacula only use one 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 submited 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 \texttt{Important}, the Bvfs module does not yet work correctly with BaseJobs,
147 Copy and Migration jobs.
150 This project was funded by Bacula Systems.
152 \subsection*{General notes}
155 \item All fields are separated by a tab
156 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
157 records in very big directories
158 \item All operations (except cache creation) are designed to run instantly
159 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
160 can contribute new faster SQL queries we will be happy, else don't complain
162 \item The cache creation is dependent of the number of directories. As Bvfs
163 shares information accross jobs, the first creation can be slow
164 \item All fields are separated by a tab
165 \item Due to potential encoding problem, it's advised to allways use pathid in
169 \subsection*{Get dependent jobs from a given JobId}
171 Bvfs allows you to query the catalog against any combination of jobs. You
172 can combine all Jobs and all FileSet for a Client in a single session.
174 To get all JobId needed to restore a particular job, you can use the
175 \texttt{.bvfs\_get\_jobids} command.
178 .bvfs_get_jobids jobid=num [all]
182 .bvfs_get_jobids jobid=10
184 .bvfs_get_jobids jobid=10 all
188 In this example, a normal restore will need to use JobIds 1,2,5,10 to
189 compute a complete restore of the system.
191 With the \texttt{all} option, the Director will use all defined FileSet for
194 \subsection*{Generating Bvfs cache}
196 The \texttt{.bvfs\_update} command computes the directory cache for jobs
197 specified in argument, or for all jobs if unspecified.
200 .bvfs_update [jobid=numlist]
205 .bvfs_update jobid=1,2,3
208 You can run the cache update process in a RunScript after the catalog backup.
210 \subsection*{Get all versions of a specific file}
212 Bvfs allows you to find all versions of a specific file for a given Client with
213 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
214 function uses only PathId and FilenameId. The jobid argument is mandatory but
218 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
219 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
220 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
227 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
228 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
231 \subsection*{List directories}
233 Bvfs allows you to list directories in a specific path.
235 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
236 PathId FilenameId FileId JobId LStat Path
237 PathId FilenameId FileId JobId LStat Path
238 PathId FilenameId FileId JobId LStat Path
242 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
243 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
244 listed is a directory.
247 .bvfs_lsdirs pathid=4 jobid=1,11,12
248 4 0 0 0 A A A A A A A A A A A A A A .
249 5 0 0 0 A A A A A A A A A A A A A A ..
250 3 0 0 0 A A A A A A A A A A A A A A regress/
253 In this example, to list directories present in \texttt{regress/}, you can use
255 .bvfs_lsdirs pathid=3 jobid=1,11,12
256 3 0 0 0 A A A A A A A A A A A A A A .
257 4 0 0 0 A A A A A A A A A A A A A A ..
258 2 0 0 0 A A A A A A A A A A A A A A tmp/
261 \subsection*{List files}
263 Bvfs allows you to list files in a specific path.
265 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
266 PathId FilenameId FileId JobId LStat Path
267 PathId FilenameId FileId JobId LStat Path
268 PathId FilenameId FileId JobId LStat Path
272 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
273 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
277 .bvfs_lsfiles pathid=4 jobid=1,11,12
278 4 0 0 0 A A A A A A A A A A A A A A .
279 5 0 0 0 A A A A A A A A A A A A A A ..
280 1 0 0 0 A A A A A A A A A A A A A A regress/
283 In this example, to list files present in \texttt{regress/}, you can use
285 .bvfs_lsfiles pathid=1 jobid=1,11,12
286 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
287 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
288 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
289 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
290 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
293 \subsection*{Restore set of files}
295 Bvfs allows you to create a SQL table that contains files that you want to
296 restore. This table can be provided to a restore command with the file option.
299 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
301 restore file=?b2num ...
304 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
305 select all files. This query could be time consuming.
307 \texttt{hardlink} list is always composed of a serie of two numbers (jobid,
308 fileindex). This information can be found in the LinkFI field of the LStat
311 The \texttt{path} argument represents the name of the table that Bvfs will
312 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
313 b2 and followed by digits).
318 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
322 \subsection*{Cleanup after Restore}
324 To drop the table used by the restore command, you can use the
325 \texttt{.bvfs\_cleanup} command.
328 .bvfs_cleanup path=b20001
331 \section{Changes in the Pruning Algorithm}
333 We rewrote the job pruning algorithm in this version. Previously, in some users
334 reported that the pruning process at the end of jobs was very long. It should
335 not be longer the case. Now, Bacula won't prune automatically a Job if this
336 particular Job is needed to restore data. Example:
340 JobId: 2 Level: Incremental
341 JobId: 3 Level: Incremental
342 JobId: 4 Level: Differential
343 .. Other incrementals up to now
346 In this example, if the Job Retention defined in the Pool or in the Client
347 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
348 detect that JobId 1 and 4 are essential to restore data at the current state
349 and will prune only JobId 2 and 3.
351 \texttt{Important}, this change affect only the automatic pruning step after a
352 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
353 \texttt{VolumeRetention} period, important jobs can be pruned.
355 \section{Ability to Verify any specified Job}
356 You now have the ability to tell Bacula which Job should verify instead of
357 automatically verify just the last one.
359 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
361 To verify a given job, just specify the Job jobid in argument when starting the
364 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
366 JobName: VerifyVolume
367 Level: VolumeToCatalog
370 Pool: Default (From Job resource)
371 Storage: File (From Job resource)
372 Verify Job: VerifyVol.2010-09-08_14.17.17_03
373 Verify List: /tmp/regress/working/VerifyVol.bsr
374 When: 2010-09-08 14:17:31
376 OK to run? (yes/mod/no):
380 This project was funded by Bacula Systems and is available with Bacula
381 Enterprise Edition and Community Edition.
383 \section{Additions to RunScript variables}
384 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
385 command. The Client address is now available through \%h.
388 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
391 %\section{Changes in drivetype.exe}
393 %Now the \texttt{drivetype.exe} program allows you to list all local hard
394 %drives. It can help to build dynamic FileSet on Windows.
397 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
401 \section{Additions to the Plugin API}
402 The bfuncs structure has been extended to include a number of
406 The bFuncs structure defines the callback entry points within Bacula
407 that the plugin can use register events, get Bacula values, set
408 Bacula values, and send messages to the Job output or debug output.
410 The exact definition as of this writing is:
412 typedef struct s_baculaFuncs {
415 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
416 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
417 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
418 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
419 int type, utime_t mtime, const char *fmt, ...);
420 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
421 int level, const char *fmt, ...);
422 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
424 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
426 /* New functions follow */
427 bRC (*AddExclude)(bpContext *ctx, const char *file);
428 bRC (*AddInclude)(bpContext *ctx, const char *file);
429 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
430 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
431 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
432 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
438 \item [AddExclude] can be called to exclude a file. The file
439 string passed may include wildcards that will be interpreted by
440 the {\bf fnmatch} subroutine. This function can be called
441 multiple times, and each time the file specified will be added
442 to the list of files to be excluded. Note, this function only
443 permits adding excludes of specific file or directory names,
444 or files matched by the rather simple fnmatch mechanism.
445 See below for information on doing wild-card and regex excludes.
447 \item [NewInclude] can be called to create a new Include block. This
448 block will be added before any user defined Include blocks. This
449 function can be called multiple times, but each time, it will create
450 a new Include section (not normally needed). This function should
451 be called only if you want to add an entirely new Include block.
453 \item [AddInclude] can be called to add new files/directories to
454 be included. They are added to the current Include block. If
455 NewInclude has not been included, the current Include block is
456 the last one that the user created. This function
457 should be used only if you want to add totally new files/directories
458 to be included in the backup.
460 \item [NewOptions] adds a new Options block to the current Include
461 in front of any other Options blocks. This permits the plugin to
462 add exclude directives (wild-cards and regexes) in front of the
463 user Options, and thus prevent certain files from being backed up.
464 This can be useful if the plugin backs up files, and they should
465 not be also backed up by the main Bacula code. This function
466 may be called multiple times, and each time, it creates a new
467 prepended Options block. Note: normally you want to call this
468 entry point prior to calling AddOptions, AddRegex, or AddWild.
470 \item [AddOptions] allows the plugin it set options in
471 the current Options block, which is normally created with the
472 NewOptions call just prior to adding Include Options.
473 The permitted options are passed as a character string, where
474 each character has a specific meaning as defined below:
477 \item [a] always replace files (default).
478 \item [e] exclude rather than include.
479 \item [h] no recursion into subdirectories.
480 \item [H] do not handle hard links.
481 \item [i] ignore case in wildcard and regex matches.
482 \item [M] compute an MD5 sum.
483 \item [p] use a portable data format on Windows (not recommended).
484 \item [R] backup resource forks and Findr Info.
485 \item [r] read from a fifo
486 \item [S1] compute an SHA1 sum.
487 \item [S2] compute an SHA256 sum.
488 \item [S3] comput an SHA512 sum.
489 \item [s] handle sparse files.
490 \item [m] use st\_mtime only for file differences.
491 \item [k] restore the st\_atime after accessing a file.
492 \item [A] enable ACL backup.
493 \item [Vxxx:] specify verify options. Must terminate with :
494 \item [Cxxx:] specify accurate options. Must terminate with :
495 \item [Jxxx:] specify base job Options. Must terminate with :
496 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
498 \item [Zn] specify gzip compression level n.
499 \item [K] do not use st\_atime in backup decision.
500 \item [c] check if file changed during backup.
501 \item [N] honor no dump flag.
502 \item [X] enable backup of extended attributes.
505 \item [AddRegex] adds a regex expression to the current Options block.
506 The fillowing options are permitted:
508 \item [ ] (a blank) regex applies to whole path and filename.
509 \item [F] regex applies only to the filename (directory or path stripped).
510 \item [D] regex applies only to the directory (path) part of the name.
513 \item [AddWild] adds a wildcard expression to the current Options block.
514 The fillowing options are permitted:
516 \item [ ] (a blank) regex applies to whole path and filename.
517 \item [F] regex applies only to the filename (directory or path stripped).
518 \item [D] regex applies only to the directory (path) part of the name.
521 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
522 that can use Accurate code to compare the file information in argument with
523 the previous file information. The \texttt{delta\_seq} attribute of the
524 \texttt{save\_pkt} will be updated, and the call will return
525 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
530 \subsection{Bacula events}
531 The list of events has been extended to include:
537 bEventStartBackupJob = 3,
538 bEventEndBackupJob = 4,
539 bEventStartRestoreJob = 5,
540 bEventEndRestoreJob = 6,
541 bEventStartVerifyJob = 7,
542 bEventEndVerifyJob = 8,
543 bEventBackupCommand = 9,
544 bEventRestoreCommand = 10,
549 bEventCancelCommand = 13,
550 bEventVssBackupAddComponents = 14,
551 bEventVssRestoreLoadComponentMetadata = 15,
552 bEventVssRestoreSetComponentsSelected = 16,
553 bEventRestoreObject = 17,
554 bEventEndFileSet = 18,
555 bEventPluginCommand = 19,
556 bEventVssBeforeCloseRestore = 20,
557 bEventVssPrepareSnapshot = 21
563 \item [bEventCancelCommand] is called whenever the currently
564 running Job is cancelled */
566 \item [bEventVssBackupAddComponents]
568 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
569 provides a char[27] table where the plugin can add Windows drives that will
570 be used during the Job. You need to add them without duplicates, and you can
571 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
575 \section{ACL enhancements}
577 The following enhancements are made to the Bacula Filed with regards to
578 Access Control Lists (ACLs)
581 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
582 POSIX and NFSv4 ACLs.
583 \item Added support for new acl types on FreeBSD 8.1 and later which supports
584 POSIX and NFSv4 ACLs.
585 \item Some generic cleanups for internal ACL handling.
586 \item Fix for acl storage on OSX
587 \item Cleanup of configure checks for ACL detection, now configure only
588 tests for a certain interface type based on the operating system
589 this should give less false possitives on detection. Also when acls
590 are detected no other acl checks are performed anymore.
594 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
595 and is available with Bacula Enterprise Edition and Community Edition.
597 \section{XATTR enhancements}
599 The following enhancements are made to the Bacula Filed with regards to
600 Extended Attributes (XATTRs)
603 \item Added support for IRIX extended attributes using the attr\_get interface.
604 \item Added support for Tru64 (OSF1) extended attributes using the
605 getproplist interface.
606 \item Added support for AIX extended attributes available in AIX 6.x
607 and higher using the listea/getea/setea interface.
608 \item Added some debugging to generic xattr code so it easier to
610 \item Cleanup of configure checks for XATTR detection, now configure only
611 tests for a certain interface type based on the operating system
612 this should give less false possitives on detection. Also when xattrs
613 are detected no other xattr checks are performed anymore.
617 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
618 and is available with Bacula Enterprise Edition and Community Edition.
620 \section{Class Based Database Backend Drivers}
622 The main Bacula Director code is independent of the SQL backend
623 in version 5.2.0 and greater. This means that the Bacula Director can be
624 packaged by itself, then each of the different SQL backends supported can
625 be packaged separately. It is possible to build all the DB backends at the
626 same time by including multiple database options at the same time.
628 ./configure can be run with multiple database configure options.
635 Order of testing for databases is:
642 Each configured backend generates a file named:
643 \verb+libbaccats-<sql_backend_name>-<version>.so+
644 A dummy catalog library is created named libbaccats-version.so
646 At configure time the first detected backend is used as the so called
647 default backend and at install time the dummy
648 \verb+libbaccats-<version>.so+ is replaced with the default backend type.
650 If you configure all three backends you get three backend libraries and the
651 postgresql gets installed as the default.
653 When you want to switch to another database, first save any old catalog you
654 may have then you can copy one of the three backend libraries over the
655 \verb+libbaccats-<version>.so+ e.g.
657 An actual command, depending on your Bacula version might be:
659 cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
662 where the \verb+5.2.2+ must be replaced by the Bacula release
665 Then you must update the default backend in the following files:
668 create_bacula_database
671 grant_bacula_privileges
677 And re-run all the above scripts. Please note, this means
678 you will have a new empty database and if you had a previous
681 All current database backend drivers for catalog information are rewritten
682 to use a set of multi inherited C++ classes which abstract the specific
683 database specific internals and make sure we have a more stable generic
684 interface with the rest of sql code. From now on there is a strict
685 boundery between the SQL code and the low-level database functions. This
686 new interface should also make it easier to add a new backend for a
687 currently unsupported database. As part of the rewrite the SQLite 2 code
688 was removed (e.g. only SQLite 3 is now supported). An extra bonus of the
689 new code is that you can configure multiple backends in the configure and
690 build all backends in one compile session and select the correct database
691 backend at install time. This should make it a lot easier for packages
697 We also added cursor support for PostgreSQL backend, this improves memory
698 usage for large installation.
701 This project was implemented by Planets Communications B.V. and ELM
702 Consultancy B.V. and Bacula Systems and is available with both the Bacula
703 Enterprise Edition and the Community Edition.
705 \section{Hash List Enhancements}
707 The htable hash table class has been extended with extra hash functions for
708 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
709 Also the hash table initialization routines have been enhanced with
710 support for passing a hint as to the number of initial pages to use
711 for the size of the hash table. Until now the hash table always used
712 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
713 cache have been rewritten to use the new htable class with a small memory
717 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
718 and Bacula Systems and is available with Bacula Enterprise Edition and
723 %%% =====================================================================
728 \chapter{Release Version 5.0.3}
730 There are no new features in version 5.0.2. This version simply fixes a
731 number of bugs found in version 5.0.1 during the onging development
734 \chapter{Release Version 5.0.2}
736 There are no new features in version 5.0.2. This version simply fixes a
737 number of bugs found in version 5.0.1 during the onging development
743 \chapter{New Features in 5.0.1}
745 This chapter presents the new features that are in the released Bacula version
746 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
747 the onging development process.
749 \section{Truncate Volume after Purge}
750 \label{sec:actiononpurge}
752 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
753 the volume when it is purged with the new command \texttt{purge volume
754 action}. It is useful to prevent disk based volumes from consuming too much
760 Action On Purge = Truncate
765 As usual you can also set this property with the \texttt{update volume} command
767 *update volume=xxx ActionOnPurge=Truncate
768 *update volume=xxx actiononpurge=None
771 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
772 following command in interactive mode or in a RunScript as shown after:
774 *purge volume action=truncate storage=File allpools
775 # or by default, action=all
776 *purge volume action storage=File pool=Default
779 This is possible to specify the volume name, the media type, the pool, the
780 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
781 idle when you decide to run this command.
790 Console = "purge volume action=all allpools storage=File"
795 \textbf{Important note}: This feature doesn't work as
796 expected in version 5.0.0. Please do not use it before version 5.0.1.
798 \section{Allow Higher Duplicates}
799 This directive did not work correctly and has been depreciated
800 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
801 file as it will be removed in a future rlease.
803 \section{Cancel Lower Level Duplicates}
804 This directive was added in Bacula version 5.0.1. It compares the
805 level of a new backup job to old jobs of the same name, if any,
806 and will kill the job which has a lower level than the other one.
807 If the levels are the same (i.e. both are Full backups), then
808 nothing is done and the other Cancel XXX Duplicate directives
811 \chapter{New Features in 5.0.0}
813 \section{Maximum Concurrent Jobs for Devices}
814 \label{sec:maximumconcurrentjobdevice}
816 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
817 Daemon configuration permits setting the maximum number of Jobs that can
818 run concurrently on a specified Device. Using this directive, it is
819 possible to have different Jobs using multiple drives, because when the
820 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
821 Jobs on any other available compatible drive. This facilitates writing to
822 multiple drives with multiple Jobs that all use the same Pool.
824 This project was funded by Bacula Systems.
826 \section{Restore from Multiple Storage Daemons}
827 \index[general]{Restore}
829 Previously, you were able to restore from multiple devices in a single Storage
830 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
831 example, if your full backup runs on a Storage Daemon with an autochanger, and
832 your incremental jobs use another Storage Daemon with lots of disks, Bacula
833 will switch automatically from one Storage Daemon to an other within the same
836 You must upgrade your File Daemon to version 3.1.3 or greater to use this
839 This project was funded by Bacula Systems with the help of Equiinet.
841 \section{File Deduplication using Base Jobs}
842 A base job is sort of like a Full save except that you will want the FileSet to
843 contain only files that are unlikely to change in the future (i.e. a snapshot
844 of most of your system after installing it). After the base job has been run,
845 when you are doing a Full save, you specify one or more Base jobs to be used.
846 All files that have been backed up in the Base job/jobs but not modified will
847 then be excluded from the backup. During a restore, the Base jobs will be
848 automatically pulled in where necessary.
850 This is something none of the competition does, as far as we know (except
851 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
852 win for the user, it makes Bacula stand out as offering a unique optimization
853 that immediately saves time and money. Basically, imagine that you have 100
854 nearly identical Windows or Linux machine containing the OS and user files.
855 Now for the OS part, a Base job will be backed up once, and rather than making
856 100 copies of the OS, there will be only one. If one or more of the systems
857 have some files updated, no problem, they will be automatically restored.
859 See the \ilink{Base Job Chapter}{basejobs} for more information.
861 This project was funded by Bacula Systems.
863 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
864 \index[dir]{AllowCompression}
866 This new directive may be added to Storage resource within the Director's
867 configuration to allow users to selectively disable the client compression for
868 any job which writes to this storage resource.
874 Address = ultrium-tape
875 Password = storage_password # Password for Storage Daemon
878 AllowCompression = No # Tape drive has hardware compression
881 The above example would cause any jobs running with the UltriumTape storage
882 resource to run without compression from the client file daemons. This
883 effectively overrides any compression settings defined at the FileSet level.
885 This feature is probably most useful if you have a tape drive which supports
886 hardware compression. By setting the \texttt{AllowCompression = No} directive
887 for your tape drive storage resource, you can avoid additional load on the file
888 daemon and possibly speed up tape backups.
890 This project was funded by Collaborative Fusion, Inc.
892 \section{Accurate Fileset Options}
893 \label{sec:accuratefileset}
895 In previous versions, the accurate code used the file creation and modification
896 times to determine if a file was modified or not. Now you can specify which
897 attributes to use (time, size, checksum, permission, owner, group, \dots),
898 similar to the Verify options.
914 \item {\bf i} compare the inodes
915 \item {\bf p} compare the permission bits
916 \item {\bf n} compare the number of links
917 \item {\bf u} compare the user id
918 \item {\bf g} compare the group id
919 \item {\bf s} compare the size
920 \item {\bf a} compare the access time
921 \item {\bf m} compare the modification time (st\_mtime)
922 \item {\bf c} compare the change time (st\_ctime)
923 \item {\bf d} report file size decreases
924 \item {\bf 5} compare the MD5 signature
925 \item {\bf 1} compare the SHA1 signature
928 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
929 the File Daemon will have to read all files even if they normally would not
930 be saved. This increases the I/O load, but also the accuracy of the
931 deduplication. By default, Bacula will check modification/creation time
934 This project was funded by Bacula Systems.
936 \section{Tab-completion for Bconsole}
937 \label{sec:tabcompletion}
939 If you build \texttt{bconsole} with readline support, you will be able to use
940 the new auto-completion mode. This mode supports all commands, gives help
941 inside command, and lists resources when required. It works also in the restore
944 To use this feature, you should have readline development package loaded on
945 your system, and use the following option in configure.
947 ./configure --with-readline=/usr/include/readline --disable-conio ...
950 The new bconsole won't be able to tab-complete with older directors.
952 This project was funded by Bacula Systems.
954 \section{Pool File and Job Retention}
955 \label{sec:poolfilejobretention}
957 We added two new Pool directives, \texttt{FileRetention} and
958 \texttt{JobRetention}, that take precedence over Client directives of the same
959 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
960 example, you can decide to increase Retention times for Archive or OffSite Pool.
962 It seems obvious to us, but apparently not to some users, that given the
963 definition above that the Pool File and Job Retention periods is a global
964 override for the normal Client based prunning, which means that when the
965 Job is prunned, the prunning will apply globally to that particular Job.
967 Currently, there is a bug in the implementation that causes any Pool
968 retention periods specified to apply to {\bf all} Pools for that
969 particular Client. Thus we suggest that you avoid using these two
970 directives until this implementation problem is corrected.
972 \section{Read-only File Daemon using capabilities}
973 \label{sec:fdreadonly}
974 This feature implements support of keeping \textbf{ReadAll} capabilities after
975 UID/GID switch, this allows FD to keep root read but drop write permission.
977 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
978 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
981 root@localhost:~# bacula-fd -k -u nobody -g nobody
984 The code for this feature was contributed by our friends at AltLinux.
989 To help developers of restore GUI interfaces, we have added new \textsl{dot
990 commands} that permit browsing the catalog in a very simple way.
993 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
994 the Bvfs cache in the catalog. You need to run it before any access to the
997 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
998 will list all directories in the specified \texttt{path} or
999 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
1000 encoding of path/filenames.
1002 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
1003 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
1004 \texttt{pathid} avoids problems with character encoding.
1007 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
1008 data that will be displayed.
1011 * .bvfs_update jobid=1,2
1013 * .bvfs_lsdir path=/ jobid=1,2
1016 This project was funded by Bacula Systems.
1018 \section{Testing your Tape Drive}
1019 \label{sec:btapespeed}
1021 To determine the best configuration of your tape drive, you can run the new
1022 \texttt{speed} command available in the \texttt{btape} program.
1024 This command can have the following arguments:
1026 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
1027 (between 1 and 5GB). This counter is in GB.
1028 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
1029 of data should be greater than your memory ($file\_size*nb\_file$).
1030 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
1032 \item[\texttt{skip\_random}] This flag permits to skip tests with random
1034 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
1035 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
1040 *speed file_size=3 skip_raw
1041 btape.c:1078 Test with zero data and bacula block structure.
1042 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1043 ++++++++++++++++++++++++++++++++++++++++++
1044 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1045 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
1047 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
1049 btape.c:1090 Test with random data, should give the minimum throughput.
1050 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1051 +++++++++++++++++++++++++++++++++++++++++++
1052 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1053 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
1054 +++++++++++++++++++++++++++++++++++++++++++
1056 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
1060 When using compression, the random test will give your the minimum throughput
1061 of your drive . The test using constant string will give you the maximum speed
1062 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
1064 You can change the block size in the Storage Daemon configuration file.
1066 \section{New {\bf Block Checksum} Device Directive}
1067 You may now turn off the Block Checksum (CRC32) code
1068 that Bacula uses when writing blocks to a Volume. This is
1075 doing so can reduce the Storage daemon CPU usage slightly. It
1076 will also permit Bacula to read a Volume that has corrupted data.
1078 The default is {\bf yes} -- i.e. the checksum is computed on write
1079 and checked on read.
1081 We do not recommend to turn this off particularly on older tape
1082 drives or for disk Volumes where doing so may allow corrupted data
1085 \section{New Bat Features}
1087 Those new features were funded by Bacula Systems.
1089 \subsection{Media List View}
1091 By clicking on ``Media'', you can see the list of all your volumes. You will be
1092 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1093 in the table. The old ``Media'' view is now known as ``Pool''.
1094 \begin{figure}[htbp]
1096 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
1097 \label{fig:mediaview}
1101 \subsection{Media Information View}
1103 By double-clicking on a volume (on the Media list, in the Autochanger content
1104 or in the Job information panel), you can access a detailed overview of your
1105 Volume. (cf \ref{fig:mediainfo}.)
1106 \begin{figure}[htbp]
1108 \includegraphics[width=13cm]{\idir bat11.eps}
1109 \caption{Media information}
1110 \label{fig:mediainfo}
1113 \subsection{Job Information View}
1115 By double-clicking on a Job record (on the Job run list or in the Media
1116 information panel), you can access a detailed overview of your Job. (cf
1118 \begin{figure}[htbp]
1120 \includegraphics[width=13cm]{\idir bat12.eps}
1121 \caption{Job information}
1125 \subsection{Autochanger Content View}
1127 By double-clicking on a Storage record (on the Storage list panel), you can
1128 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
1129 \begin{figure}[htbp]
1131 \includegraphics[width=13cm]{\idir bat13.eps}
1132 \caption{Autochanger content}
1133 \label{fig:achcontent}
1136 To use this feature, you need to use the latest mtx-changer script
1137 version. (With new \texttt{listall} and \texttt{transfer} commands)
1139 \section{Bat on Windows}
1140 We have ported {\bf bat} to Windows and it is now installed
1141 by default when the installer is run. It works quite well
1142 on Win32, but has not had a lot of testing there, so your
1143 feedback would be welcome. Unfortunately, eventhough it is
1144 installed by default, it does not yet work on 64 bit Windows
1147 \section{New Win32 Installer}
1148 The Win32 installer has been modified in several very important
1151 \item You must deinstall any current version of the
1152 Win32 File daemon before upgrading to the new one.
1153 If you forget to do so, the new installation will fail.
1154 To correct this failure, you must manually shutdown
1155 and deinstall the old File daemon.
1156 \item All files (other than menu links) are installed
1157 in {\bf c:/Program Files/Bacula}.
1158 \item The installer no longer sets this
1159 file to require administrator privileges by default. If you want
1160 to do so, please do it manually using the {\bf cacls} program.
1163 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1165 \item The server daemons (Director and Storage daemon) are
1166 no longer included in the Windows installer. If you want the
1167 Windows servers, you will either need to build them yourself (note
1168 they have not been ported to 64 bits), or you can contact
1169 Bacula Systems about this.
1172 \section{Win64 Installer}
1173 We have corrected a number of problems that required manual
1174 editing of the conf files. In most cases, it should now
1175 install and work. {\bf bat} is by default installed in
1176 {\bf c:/Program Files/Bacula/bin32} rather than
1177 {\bf c:/Program Files/Bacula} as is the case with the 32
1178 bit Windows installer.
1180 \section{Linux Bare Metal Recovery USB Key}
1181 We have made a number of significant improvements in the
1182 Bare Metal Recovery USB key. Please see the README files
1183 it the {\bf rescue} release for more details.
1185 We are working on an equivalent USB key for Windows bare
1186 metal recovery, but it will take some time to develop it (best
1187 estimate 3Q2010 or 4Q2010)
1190 \section{bconsole Timeout Option}
1191 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1192 for commands. This is useful with GUI programs that use {\bf bconsole}
1193 to interface to the Director.
1195 \section{Important Changes}
1196 \label{sec:importantchanges}
1199 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1200 to the same Pool. The Storage daemon ensures that you do not read and
1201 write to the same Volume.
1202 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1204 \item Virtually all the features of {\bf mtx-changer} have
1205 now been parameterized, which allows you to configure
1206 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1207 that contains variables that you can set to configure mtx-changer.
1208 This configuration file will not be overwritten during upgrades.
1209 We encourage you to submit any changes
1210 that are made to mtx-changer and to parameterize it all in
1211 mtx-changer.conf so that all configuration will be done by
1212 changing only mtx-changer.conf.
1213 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1214 and \texttt{transfer}. Please configure them as appropriate
1215 in mtx-changer.conf.
1216 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1217 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1218 password. If you want to use the new script, you will need to
1219 manually change the \texttt{BackupCatalog} Job definition.
1220 \item The \texttt{bconsole} \texttt{help} command now accepts
1221 an argument, which if provided produces information on that
1222 command (ex: \texttt{help run}).
1226 \subsubsection*{Truncate volume after purge}
1228 Note that the Truncate Volume after purge feature doesn't work as expected
1229 in 5.0.0 version. Please, don't use it before version 5.0.1.
1231 \subsection{Custom Catalog queries}
1233 If you wish to add specialized commands that list the contents of the catalog,
1234 you can do so by adding them to the \texttt{query.sql} file. This
1235 \texttt{query.sql} file is now empty by default. The file
1236 \texttt{examples/sample-query.sql} has an a number of sample commands
1237 you might find useful.
1239 \subsection{Deprecated parts}
1241 The following items have been \textbf{deprecated} for a long time, and are now
1242 removed from the code.
1245 \item Support for SQLite 2
1248 \section{Misc Changes}
1249 \label{sec:miscchanges}
1252 \item Updated Nagios check\_bacula
1253 \item Updated man files
1254 \item Added OSX package generation script in platforms/darwin
1255 \item Added Spanish and Ukrainian Bacula translations
1256 \item Enable/disable command shows only Jobs that can change
1257 \item Added \texttt{show disabled} command to show disabled Jobs
1258 \item Many ACL improvements
1259 \item Added Level to FD status Job output
1260 \item Begin Ingres DB driver (not yet working)
1261 \item Split RedHat spec files into bacula, bat, mtx, and docs
1262 \item Reorganized the manuals (fewer separate manuals)
1263 \item Added lock/unlock order protection in lock manager
1264 \item Allow 64 bit sizes for a number of variables
1265 \item Fixed several deadlocks or potential race conditions in the SD
1268 \chapter{Released Version 3.0.3 and 3.0.3a}
1270 There are no new features in version 3.0.3. This version simply fixes a
1271 number of bugs found in version 3.0.2 during the onging development
1274 \chapter{New Features in Released Version 3.0.2}
1276 This chapter presents the new features added to the
1277 Released Bacula Version 3.0.2.
1279 \section{Full Restore from a Given JobId}
1280 \index[general]{Restore menu}
1282 This feature allows selecting a single JobId and having Bacula
1283 automatically select all the other jobs that comprise a full backup up to
1284 and including the selected date (through JobId).
1286 Assume we start with the following jobs:
1288 +-------+--------------+---------------------+-------+----------+------------+
1289 | jobid | client | starttime | level | jobfiles | jobbytes |
1290 +-------+--------------+---------------------+-------+----------+------------
1291 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1292 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1293 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1294 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1295 +-------+--------------+---------------------+-------+----------+------------+
1298 Below is an example of this new feature (which is number 12 in the
1303 To select the JobIds, you have the following choices:
1304 1: List last 20 Jobs run
1305 2: List Jobs where a given File is saved
1307 12: Select full restore to a specified Job date
1310 Select item: (1-13): 12
1311 Enter JobId to get the state to restore: 5
1312 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1313 You have selected the following JobIds: 1,3,5
1315 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1316 1,444 files inserted into the tree.
1319 This project was funded by Bacula Systems.
1321 \section{Source Address}
1322 \index[general]{Source Address}
1324 A feature has been added which allows the administrator to specify the address
1325 from which the Director and File daemons will establish connections. This
1326 may be used to simplify system configuration overhead when working in complex
1327 networks utilizing multi-homing and policy-routing.
1329 To accomplish this, two new configuration directives have been implemented:
1332 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1336 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1340 Simply adding specific host routes on the OS
1341 would have an undesirable side-effect: any
1342 application trying to contact the destination host would be forced to use the
1343 more specific route possibly diverting management traffic onto a backup VLAN.
1344 Instead of adding host routes for each client connected to a multi-homed backup
1345 server (for example where there are management and backup VLANs), one can
1346 use the new directives to specify a specific source address at the application
1349 Additionally, this allows the simplification and abstraction of firewall rules
1350 when dealing with a Hot-Standby director or storage daemon configuration. The
1351 Hot-standby pair may share a CARP address, which connections must be sourced
1352 from, while system services listen and act from the unique interface addresses.
1354 This project was funded by Collaborative Fusion, Inc.
1356 \section{Show volume availability when doing restore}
1358 When doing a restore the selection dialog ends by displaying this
1362 The job will require the following
1363 Volume(s) Storage(s) SD Device(s)
1364 ===========================================================================
1365 *000741L3 LTO-4 LTO3
1366 *000866L3 LTO-4 LTO3
1367 *000765L3 LTO-4 LTO3
1368 *000764L3 LTO-4 LTO3
1369 *000756L3 LTO-4 LTO3
1370 *001759L3 LTO-4 LTO3
1371 *001763L3 LTO-4 LTO3
1375 Volumes marked with ``*'' are online (in the autochanger).
1378 This should help speed up large restores by minimizing the time spent
1379 waiting for the operator to discover that he must change tapes in the library.
1381 This project was funded by Bacula Systems.
1383 \section{Accurate estimate command}
1385 The \texttt{estimate} command can now use the accurate code to detect changes
1386 and give a better estimation.
1388 You can set the accurate behavior on the command line by using
1389 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1392 * estimate listing accurate=yes level=incremental job=BackupJob
1395 This project was funded by Bacula Systems.
1397 \chapter{New Features in 3.0.0}
1398 \label{NewFeaturesChapter}
1399 \index[general]{New Features}
1401 This chapter presents the new features added to the development 2.5.x
1402 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1404 \section{Accurate Backup}
1405 \index[general]{Accurate Backup}
1407 As with most other backup programs, by default Bacula decides what files to
1408 backup for Incremental and Differental backup by comparing the change
1409 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1410 backup completed. If one of those two times is later than the last backup
1411 time, then the file will be backed up. This does not, however, permit tracking
1412 what files have been deleted and will miss any file with an old time that may
1413 have been restored to or moved onto the client filesystem.
1415 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1416 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1417 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1418 backup, there is no difference, but for {\bf Differential} and {\bf
1419 Incremental} backups, the Director will send a list of all previous files
1420 backed up, and the File daemon will use that list to determine if any new files
1421 have been added or or moved and if any files have been deleted. This allows
1422 Bacula to make an accurate backup of your system to that point in time so that
1423 if you do a restore, it will restore your system exactly.
1426 about using Accurate backup is that it requires more resources (CPU and memory)
1427 on both the Director and the Client machines to create the list of previous
1428 files backed up, to send that list to the File daemon, for the File daemon to
1429 keep the list (possibly very big) in memory, and for the File daemon to do
1430 comparisons between every file in the FileSet and the list. In particular,
1431 if your client has lots of files (more than a few million), you will need
1432 lots of memory on the client machine.
1434 Accurate must not be enabled when backing up with a plugin that is not
1435 specially designed to work with Accurate. If you enable it, your restores
1436 will probably not work correctly.
1438 This project was funded by Bacula Systems.
1443 \index[general]{Copy Jobs}
1445 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1446 existing Migration feature with the exception that the Job that is copied is
1447 left unchanged. This essentially creates two identical copies of the same
1448 backup. However, the copy is treated as a copy rather than a backup job, and
1449 hence is not directly available for restore. The {\bf restore} command lists
1450 copy jobs and allows selection of copies by using \texttt{jobid=}
1451 option. If the keyword {\bf copies} is present on the command line, Bacula will
1452 display the list of all copies for selected jobs.
1457 These JobIds have copies as follows:
1458 +-------+------------------------------------+-----------+------------------+
1459 | JobId | Job | CopyJobId | MediaType |
1460 +-------+------------------------------------+-----------+------------------+
1461 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1462 +-------+------------------------------------+-----------+------------------+
1463 +-------+-------+----------+----------+---------------------+------------------+
1464 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1465 +-------+-------+----------+----------+---------------------+------------------+
1466 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1467 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1468 +-------+-------+----------+----------+---------------------+------------------+
1469 You have selected the following JobIds: 19,2
1471 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1472 5,611 files inserted into the tree.
1477 The Copy Job runs without using the File daemon by copying the data from the
1478 old backup Volume to a different Volume in a different Pool. See the Migration
1479 documentation for additional details. For copy Jobs there is a new selection
1480 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1481 not already copied to another Pool.
1483 As with Migration, the Client, Volume, Job, or SQL query, are
1484 other possible ways of selecting the Jobs to be copied. Selection
1485 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1486 work, but are probably more suited for Migration Jobs.
1488 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1489 it will promote the Copy to a \textsl{real} backup job and will make it available for
1490 automatic restore. If more than one Copy is available, it will promote the copy
1491 with the smallest JobId.
1493 A nice solution which can be built with the new Copy feature is often
1494 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1495 look something like the one below:
1499 Name = FullBackupsVirtualPool
1501 Purge Oldest Volume = Yes
1503 NextPool = FullBackupsTapePool
1507 Name = FullBackupsTapePool
1511 Volume Retention = 365 days
1512 Storage = superloader
1516 # Fake fileset for copy jobs
1528 # Fake client for copy jobs
1538 # Default template for a CopyDiskToTape Job
1541 Name = CopyDiskToTape
1543 Messages = StandardCopy
1546 Selection Type = PoolUncopiedJobs
1547 Maximum Concurrent Jobs = 10
1549 Allow Duplicate Jobs = Yes
1550 Cancel Queued Duplicates = No
1551 Cancel Running Duplicates = No
1556 Name = DaySchedule7:00
1557 Run = Level=Full daily at 7:00
1561 Name = CopyDiskToTapeFullBackups
1563 Schedule = DaySchedule7:00
1564 Pool = FullBackupsVirtualPool
1565 JobDefs = CopyDiskToTape
1569 The example above had 2 pool which are copied using the PoolUncopiedJobs
1570 selection criteria. Normal Full backups go to the Virtual pool and are copied
1571 to the Tape pool the next morning.
1573 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1578 +-------+------------------------------------+-----------+------------------+
1579 | JobId | Job | CopyJobId | MediaType |
1580 +-------+------------------------------------+-----------+------------------+
1581 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1582 +-------+------------------------------------+-----------+------------------+
1585 \section{ACL Updates}
1586 \index[general]{ACL Updates}
1587 The whole ACL code had been overhauled and in this version each platforms has
1588 different streams for each type of acl available on such an platform. As ACLs
1589 between platforms tend to be not that portable (most implement POSIX acls but
1590 some use an other draft or a completely different format) we currently only
1591 allow certain platform specific ACL streams to be decoded and restored on the
1592 same platform that they were created on. The old code allowed to restore ACL
1593 cross platform but the comments already mention that not being to wise. For
1594 backward compatability the new code will accept the two old ACL streams and
1595 handle those with the platform specific handler. But for all new backups it
1596 will save the ACLs using the new streams.
1598 Currently the following platforms support ACLs:
1602 \item {\bf Darwin/OSX}
1611 Currently we support the following ACL types (these ACL streams use a reserved
1612 part of the stream numbers):
1615 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1617 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1618 string representation from acl\_to\_text (POSIX acl)
1619 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1620 string representation from acl\_to\_text (POSIX acl) for default acls.
1621 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1622 string representation from acl\_to\_text (POSIX acl) for access acls.
1623 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1624 string representation from acltostr (POSIX acl)
1625 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1626 representation from acl\_to\_text (POSIX acl) for default acls.
1627 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1628 representation from acl\_to\_text (POSIX acl) for access acls.
1629 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1630 string representation from acl\_to\_text (POSIX acl) for default acls.
1631 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1632 representation from acl\_to\_text (POSIX acl) for access acls.
1633 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1634 string representation from acl\_to\_text (POSIX acl) for default acls.
1635 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1636 string representation from acl\_to\_text (POSIX acl) for default acls.
1637 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1638 representation from acl\_to\_text (POSIX acl) for access acls.
1639 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1640 string representation from acltotext or acl\_totext (POSIX acl)
1641 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1642 representation from from acl\_totext (NFSv4 or ZFS acl)
1645 In future versions we might support conversion functions from one type of acl
1646 into an other for types that are either the same or easily convertable. For now
1647 the streams are seperate and restoring them on a platform that doesn't
1648 recognize them will give you a warning.
1650 \section{Extended Attributes}
1651 \index[general]{Extended Attributes}
1652 Something that was on the project list for some time is now implemented for
1653 platforms that support a similar kind of interface. Its the support for backup
1654 and restore of so called extended attributes. As extended attributes are so
1655 platform specific these attributes are saved in seperate streams for each
1656 platform. Restores of the extended attributes can only be performed on the
1657 same platform the backup was done. There is support for all types of extended
1658 attributes, but restoring from one type of filesystem onto an other type of
1659 filesystem on the same platform may lead to supprises. As extended attributes
1660 can contain any type of data they are stored as a series of so called
1661 value-pairs. This data must be seen as mostly binary and is stored as such.
1662 As security labels from selinux are also extended attributes this option also
1663 stores those labels and no specific code is enabled for handling selinux
1666 Currently the following platforms support extended attributes:
1668 \item {\bf Darwin/OSX}
1674 On linux acls are also extended attributes, as such when you enable ACLs on a
1675 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1676 and not the same exteneded attribute.
1678 To enable the backup of extended attributes please add the following to your
1693 \section{Shared objects}
1694 \index[general]{Shared objects}
1695 A default build of Bacula will now create the libraries as shared objects
1696 (.so) rather than static libraries as was previously the case.
1697 The shared libraries are built using {\bf libtool} so it should be quite
1700 An important advantage of using shared objects is that on a machine with the
1701 Directory, File daemon, the Storage daemon, and a console, you will have only
1702 one copy of the code in memory rather than four copies. Also the total size of
1703 the binary release is smaller since the library code appears only once rather
1704 than once for every program that uses it; this results in significant reduction
1705 in the size of the binaries particularly for the utility tools.
1707 In order for the system loader to find the shared objects when loading the
1708 Bacula binaries, the Bacula shared objects must either be in a shared object
1709 directory known to the loader (typically /usr/lib) or they must be in the
1710 directory that may be specified on the {\bf ./configure} line using the {\bf
1711 {-}{-}libdir} option as:
1714 ./configure --libdir=/full-path/dir
1717 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1718 no need to modify your loader configuration provided that
1719 the shared objects are installed in that directory (Bacula
1720 does this with the make install command). The shared objects
1721 that Bacula references are:
1730 These files are symbolically linked to the real shared object file,
1731 which has a version number to permit running multiple versions of
1732 the libraries if desired (not normally the case).
1734 If you have problems with libtool or you wish to use the old
1735 way of building static libraries, or you want to build a static
1736 version of Bacula you may disable
1737 libtool on the configure command line with:
1740 ./configure --disable-libtool
1744 \section{Building Static versions of Bacula}
1745 \index[general]{Static linking}
1746 In order to build static versions of Bacula, in addition
1747 to configuration options that were needed you now must
1748 also add --disable-libtool. Example
1751 ./configure --enable-static-client-only --disable-libtool
1755 \section{Virtual Backup (Vbackup)}
1756 \index[general]{Virtual Backup}
1757 \index[general]{Vbackup}
1759 Bacula's virtual backup feature is often called Synthetic Backup or
1760 Consolidation in other backup products. It permits you to consolidate the
1761 previous Full backup plus the most recent Differential backup and any
1762 subsequent Incremental backups into a new Full backup. This new Full
1763 backup will then be considered as the most recent Full for any future
1764 Incremental or Differential backups. The VirtualFull backup is
1765 accomplished without contacting the client by reading the previous backup
1766 data and writing it to a volume in a different pool.
1768 In some respects the Vbackup feature works similar to a Migration job, in
1769 that Bacula normally reads the data from the pool specified in the
1770 Job resource, and writes it to the {\bf Next Pool} specified in the
1771 Job resource. Note, this means that usually the output from the Virtual
1772 Backup is written into a different pool from where your prior backups
1773 are saved. Doing it this way guarantees that you will not get a deadlock
1774 situation attempting to read and write to the same volume in the Storage
1775 daemon. If you then want to do subsequent backups, you may need to
1776 move the Virtual Full Volume back to your normal backup pool.
1777 Alternatively, you can set your {\bf Next Pool} to point to the current
1778 pool. This will cause Bacula to read and write to Volumes in the
1779 current pool. In general, this will work, because Bacula will
1780 not allow reading and writing on the same Volume. In any case, once
1781 a VirtualFull has been created, and a restore is done involving the
1782 most current Full, it will read the Volume or Volumes by the VirtualFull
1783 regardless of in which Pool the Volume is found.
1785 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1786 a level of {\bf VirtualFull}.
1788 A typical Job resource definition might look like the following:
1795 FileSet = "Full Set"
1802 # Default pool definition
1806 Recycle = yes # Automatically recycle Volumes
1807 AutoPrune = yes # Prune expired volumes
1808 Volume Retention = 365d # one year
1816 Recycle = yes # Automatically recycle Volumes
1817 AutoPrune = yes # Prune expired volumes
1818 Volume Retention = 365d # one year
1819 Storage = DiskChanger
1822 # Definition of file storage device
1827 Device = FileStorage
1829 Maximum Concurrent Jobs = 5
1832 # Definition of DDS Virtual tape disk storage device
1835 Address = localhost # N.B. Use a fully qualified name here
1837 Device = DiskChanger
1838 Media Type = DiskChangerMedia
1839 Maximum Concurrent Jobs = 4
1844 Then in bconsole or via a Run schedule, you would run the job as:
1847 run job=MyBackup level=Full
1848 run job=MyBackup level=Incremental
1849 run job=MyBackup level=Differential
1850 run job=MyBackup level=Incremental
1851 run job=MyBackup level=Incremental
1854 So providing there were changes between each of those jobs, you would end up
1855 with a Full backup, a Differential, which includes the first Incremental
1856 backup, then two Incremental backups. All the above jobs would be written to
1857 the {\bf Default} pool.
1859 To consolidate those backups into a new Full backup, you would run the
1863 run job=MyBackup level=VirtualFull
1866 And it would produce a new Full backup without using the client, and the output
1867 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1869 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1872 Note, the Start and End time of the Virtual Full backup is set to the
1873 values for the last job included in the Virtual Full (in the above example,
1874 it is an Increment). This is so that if another incremental is done, which
1875 will be based on the Virtual Full, it will backup all files from the
1876 last Job included in the Virtual Full rather than from the time the Virtual
1877 Full was actually run.
1881 \section{Catalog Format}
1882 \index[general]{Catalog Format}
1883 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1884 operation will convert the FileId field of the File table from 32 bits (max 4
1885 billion table entries) to 64 bits (very large number of items). The
1886 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1887 your catalog during the conversion. Also you won't be able to run jobs during
1888 this conversion period. For example, a 3 million file catalog will take 2
1889 minutes to upgrade on a normal machine. Please don't forget to make a valid
1890 backup of your database before executing the upgrade script. See the
1891 ReleaseNotes for additional details.
1893 \section{64 bit Windows Client}
1894 \index[general]{Win64 Client}
1895 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1896 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1897 As a consequence, we are also releasing a 64 bit version of the Bacula
1898 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1899 These binaries should only be installed on 64 bit Windows operating systems.
1900 What is important is not your hardware but whether or not you have
1901 a 64 bit version of the Windows OS.
1903 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1905 \item Before installing the Win64 Bacula Client, you must totally
1906 deinstall any prior 2.4.x Client installation using the
1907 Bacula deinstallation (see the menu item). You may want
1908 to save your .conf files first.
1909 \item Only the Client (File daemon) is ported to Win64, the Director
1910 and the Storage daemon are not in the 64 bit Windows installer.
1911 \item bwx-console is not yet ported.
1912 \item bconsole is ported but it has not been tested.
1913 \item The documentation is not included in the installer.
1914 \item Due to Vista security restrictions imposed on a default installation
1915 of Vista, before upgrading the Client, you must manually stop
1916 any prior version of Bacula from running, otherwise the install
1918 \item Due to Vista security restrictions imposed on a default installation
1919 of Vista, attempting to edit the conf files via the menu items
1920 will fail. You must directly edit the files with appropriate
1921 permissions. Generally double clicking on the appropriate .conf
1922 file will work providing you have sufficient permissions.
1923 \item All Bacula files are now installed in
1924 {\bf C:/Program Files/Bacula} except the main menu items,
1925 which are installed as before. This vastly simplifies the installation.
1926 \item If you are running on a foreign language version of Windows, most
1927 likely {\bf C:/Program Files} does not exist, so you should use the
1928 Custom installation and enter an appropriate location to install
1930 \item The 3.0.0 Win32 Client continues to install files in the locations used
1931 by prior versions. For the next version we will convert it to use
1932 the same installation conventions as the Win64 version.
1935 This project was funded by Bacula Systems.
1938 \section{Duplicate Job Control}
1939 \index[general]{Duplicate Jobs}
1940 The new version of Bacula provides four new directives that
1941 give additional control over what Bacula does if duplicate jobs
1942 are started. A duplicate job in the sense we use it here means
1943 a second or subsequent job with the same name starts. This
1944 happens most frequently when the first job runs longer than expected because no
1945 tapes are available.
1947 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1948 are specified in the Job resource.
1952 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1953 \index[general]{Allow Duplicate Jobs}
1954 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1955 the directive is set to {\bf no} (default) then only one job of a given name
1956 may run at one time, and the action that Bacula takes to ensure only
1957 one job runs is determined by the other directives (see below).
1959 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1960 are present and none of the three directives given below permit
1961 cancelling a job, then the current job (the second one started)
1964 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1965 \index[general]{Allow Higher Duplicates}
1966 This directive was in version 5.0.0, but does not work as
1967 expected. If used, it should always be set to no. In later versions
1968 of Bacula the directive is disabled (disregarded).
1970 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1971 \index[general]{Cancel Running Duplicates}
1972 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1973 if this directive is set to {\bf yes} any job that is already running
1974 will be canceled. The default is {\bf no}.
1976 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1977 \index[general]{Cancel Queued Duplicates}
1978 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1979 if this directive is set to {\bf yes} any job that is
1980 already queued to run but not yet running will be canceled.
1981 The default is {\bf no}.
1984 \section{TLS Authentication}
1985 \index[general]{TLS Authentication}
1986 In Bacula version 2.5.x and later, in addition to the normal Bacula
1987 CRAM-MD5 authentication that is used to authenticate each Bacula
1988 connection, you can specify that you want TLS Authentication as well,
1989 which will provide more secure authentication.
1991 This new feature uses Bacula's existing TLS code (normally used for
1992 communications encryption) to do authentication. To use it, you must
1993 specify all the TLS directives normally used to enable communications
1994 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1997 \subsection{TLS Authenticate = yes}
1999 TLS Authenticate = yes
2002 in the main daemon configuration resource (Director for the Director,
2003 Client for the File daemon, and Storage for the Storage daemon).
2005 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
2006 authentication, Bacula will also do TLS authentication, then TLS
2007 encryption will be turned off, and the rest of the communication between
2008 the two Bacula daemons will be done without encryption.
2010 If you want to encrypt communications data, use the normal TLS directives
2011 but do not turn on {\bf TLS Authenticate}.
2013 \section{bextract non-portable Win32 data}
2014 \index[general]{bextract handles Win32 non-portable data}
2015 {\bf bextract} has been enhanced to be able to restore
2016 non-portable Win32 data to any OS. Previous versions were
2017 unable to restore non-portable Win32 data to machines that
2018 did not have the Win32 BackupRead and BackupWrite API calls.
2020 \section{State File updated at Job Termination}
2021 \index[general]{State File}
2022 In previous versions of Bacula, the state file, which provides a
2023 summary of previous jobs run in the {\bf status} command output was
2024 updated only when Bacula terminated, thus if the daemon crashed, the
2025 state file might not contain all the run data. This version of
2026 the Bacula daemons updates the state file on each job termination.
2028 \section{MaxFullInterval = \lt{}time-interval\gt{}}
2029 \index[general]{MaxFullInterval}
2030 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
2031 can be used to specify the maximum time interval between {\bf Full} backup
2032 jobs. When a job starts, if the time since the last Full backup is
2033 greater than the specified interval, and the job would normally be an
2034 {\bf Incremental} or {\bf Differential}, it will be automatically
2035 upgraded to a {\bf Full} backup.
2037 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
2038 \index[general]{MaxDiffInterval}
2039 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
2040 can be used to specify the maximum time interval between {\bf Differential} backup
2041 jobs. When a job starts, if the time since the last Differential backup is
2042 greater than the specified interval, and the job would normally be an
2043 {\bf Incremental}, it will be automatically
2044 upgraded to a {\bf Differential} backup.
2046 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
2047 \index[general]{MaxDiffInterval}
2048 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
2049 by the user, and when it is set it is an indication to backup programs
2050 to not backup that particular file. This version of Bacula contains a
2051 new Options directive within a FileSet resource, which instructs Bacula to
2052 obey this flag. The new directive is:
2055 Honor No Dump Flag = yes\vb{}no
2058 The default value is {\bf no}.
2061 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
2062 \index[general]{IgnoreDir}
2063 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
2064 can be added to the Include section of the FileSet resource. If the specified
2065 filename ({\bf filename-string}) is found on the Client in any directory to be
2066 backed up, the whole directory will be ignored (not backed up). For example:
2069 # List of files to be backed up
2077 Exclude Dir Containing = .excludeme
2082 But in /home, there may be hundreds of directories of users and some
2083 people want to indicate that they don't want to have certain
2084 directories backed up. For example, with the above FileSet, if
2085 the user or sysadmin creates a file named {\bf .excludeme} in
2086 specific directories, such as
2089 /home/user/www/cache/.excludeme
2090 /home/user/temp/.excludeme
2093 then Bacula will not backup the two directories named:
2096 /home/user/www/cache
2100 NOTE: subdirectories will not be backed up. That is, the directive
2101 applies to the two directories in question and any children (be they
2102 files, directories, etc).
2105 \section{Bacula Plugins}
2106 \index[general]{Plugin}
2107 Support for shared object plugins has been implemented in the Linux, Unix
2108 and Win32 File daemons. The API will be documented separately in
2109 the Developer's Guide or in a new document. For the moment, there is
2110 a single plugin named {\bf bpipe} that allows an external program to
2111 get control to backup and restore a file.
2113 Plugins are also planned (partially implemented) in the Director and the
2116 \subsection{Plugin Directory}
2117 \index[general]{Plugin Directory}
2118 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2119 be added to the daemon definition resource. The directory takes a quoted
2120 string argument, which is the name of the directory in which the daemon can
2121 find the Bacula plugins. If this directive is not specified, Bacula will not
2122 load any plugins. Since each plugin has a distinctive name, all the daemons
2123 can share the same plugin directory.
2125 \subsection{Plugin Options}
2126 \index[general]{Plugin Options}
2127 The {\bf Plugin Options} directive takes a quoted string
2128 arguement (after the equal sign) and may be specified in the
2129 Job resource. The options specified will be passed to all plugins
2130 when they are run. This each plugin must know what it is looking
2131 for. The value defined in the Job resource can be modified
2132 by the user when he runs a Job via the {\bf bconsole} command line
2135 Note: this directive may be specified, and there is code to modify
2136 the string in the run command, but the plugin options are not yet passed to
2137 the plugin (i.e. not fully implemented).
2139 \subsection{Plugin Options ACL}
2140 \index[general]{Plugin Options ACL}
2141 The {\bf Plugin Options ACL} directive may be specified in the
2142 Director's Console resource. It functions as all the other ACL commands
2143 do by permitting users running restricted consoles to specify a
2144 {\bf Plugin Options} that overrides the one specified in the Job
2145 definition. Without this directive restricted consoles may not modify
2148 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2149 \index[general]{Plugin}
2150 The {\bf Plugin} directive is specified in the Include section of
2151 a FileSet resource where you put your {\bf File = xxx} directives.
2162 Plugin = "bpipe:..."
2167 In the above example, when the File daemon is processing the directives
2168 in the Include section, it will first backup all the files in {\bf /home}
2169 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2170 the Plugin Directory. The syntax and semantics of the Plugin directive
2171 require the first part of the string up to the colon (:) to be the name
2172 of the plugin. Everything after the first colon is ignored by the File daemon but
2173 is passed to the plugin. Thus the plugin writer may define the meaning of the
2174 rest of the string as he wishes.
2176 Please see the next section for information about the {\bf bpipe} Bacula
2179 \section{The bpipe Plugin}
2180 \index[general]{The bpipe Plugin}
2181 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2182 the Bacula source distribution. When the plugin is compiled and linking into
2183 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2184 Please note that this is a very simple plugin that was written for
2185 demonstration and test purposes. It is and can be used in production, but
2186 that was never really intended.
2188 The purpose of the plugin is to provide an interface to any system program for
2189 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2190 the Include section of your Job's FileSet resource. The full syntax of the
2191 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2192 to specify the sytax as it wishes) is:
2195 Plugin = "<field1>:<field2>:<field3>:<field4>"
2200 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2201 stripped off, so in this case, we would put {\bf bpipe} in this field.
2203 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2204 pseudo path and filename under which the backup will be saved. This pseudo
2205 path and filename will be seen by the user in the restore file tree.
2206 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2207 backed up by the plugin will be put under that "pseudo" path and filename.
2208 You must be careful to choose a naming convention that is unique to avoid
2209 a conflict with a path and filename that actually exists on your system.
2211 \item {\bf field3} for the {\bf bpipe} plugin
2212 specifies the "reader" program that is called by the plugin during
2213 backup to read the data. {\bf bpipe} will call this program by doing a
2216 \item {\bf field4} for the {\bf bpipe} plugin
2217 specifies the "writer" program that is called by the plugin during
2218 restore to write the data back to the filesystem.
2221 Please note that for two items above describing the "reader" and "writer"
2222 fields, these programs are "executed" by Bacula, which
2223 means there is no shell interpretation of any command line arguments
2224 you might use. If you want to use shell characters (redirection of input
2225 or output, ...), then we recommend that you put your command or commands
2226 in a shell script and execute the script. In addition if you backup a
2227 file with the reader program, when running the writer program during
2228 the restore, Bacula will not automatically create the path to the file.
2229 Either the path must exist, or you must explicitly do so with your command
2230 or in a shell script.
2232 Putting it all together, the full plugin directive line might look
2236 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2237 --opt --databases bacula:mysql"
2240 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2241 would be written on a single line.
2243 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2244 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2245 program {\bf mysqldump -f --opt --database bacula} to read the data during
2246 backup. The mysqldump command outputs all the data for the database named
2247 {\bf bacula}, which will be read by the plugin and stored in the backup.
2248 During restore, the data that was backed up will be sent to the program
2249 specified in the last field, which in this case is {\bf mysql}. When
2250 {\bf mysql} is called, it will read the data sent to it by the plugn
2251 then write it back to the same database from which it came ({\bf bacula}
2254 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2255 the data from a specified program to Bacula for backup, and then from Bacula to
2256 a specified program for restore.
2258 By using different command lines to {\bf bpipe},
2259 you can backup any kind of data (ASCII or binary) depending
2260 on the program called.
2262 \section{Microsoft Exchange Server 2003/2007 Plugin}
2263 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2264 \subsection{Background}
2265 The Exchange plugin was made possible by a funded development project
2266 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2267 The code for the plugin was written by James Harper, and the Bacula core
2268 code by Kern Sibbald. All the code for this funded development has become
2269 part of the Bacula project. Thanks to everyone who made it happen.
2271 \subsection{Concepts}
2272 Although it is possible to backup Exchange using Bacula VSS the Exchange
2273 plugin adds a good deal of functionality, because while Bacula VSS
2274 completes a full backup (snapshot) of Exchange, it does
2275 not support Incremental or Differential backups, restoring is more
2276 complicated, and a single database restore is not possible.
2278 Microsoft Exchange organises its storage into Storage Groups with
2279 Databases inside them. A default installation of Exchange will have a
2280 single Storage Group called 'First Storage Group', with two Databases
2281 inside it, "Mailbox Store (SERVER NAME)" and
2282 "Public Folder Store (SERVER NAME)",
2283 which hold user email and public folders respectively.
2285 In the default configuration, Exchange logs everything that happens to
2286 log files, such that if you have a backup, and all the log files since,
2287 you can restore to the present time. Each Storage Group has its own set
2288 of log files and operates independently of any other Storage Groups. At
2289 the Storage Group level, the logging can be turned off by enabling a
2290 function called "Enable circular logging". At this time the Exchange
2291 plugin will not function if this option is enabled.
2293 The plugin allows backing up of entire storage groups, and the restoring
2294 of entire storage groups or individual databases. Backing up and
2295 restoring at the individual mailbox or email item is not supported but
2296 can be simulated by use of the "Recovery" Storage Group (see below).
2298 \subsection{Installing}
2299 The Exchange plugin requires a DLL that is shipped with Microsoft
2300 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2301 correctly the Exchange plugin should find this automatically and run
2302 without any additional installation.
2304 If the DLL can not be found automatically it will need to be copied into
2305 the Bacula installation
2306 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2307 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2308 default Exchange installation.
2310 \subsection{Backing Up}
2311 To back up an Exchange server the Fileset definition must contain at
2312 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2313 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2314 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2315 up files are prefixed with something that isn't going to share a name
2316 with something outside the plugin, and the 'Microsoft Information Store'
2317 bit is required also. It is also possible to add the name of a storage
2318 group to the "Plugin =" line, eg \\
2319 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2320 if you want only a single storage group backed up.
2322 Additionally, you can suffix the 'Plugin =' directive with
2323 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2324 database at the end of a full backup.
2326 An Incremental or Differential backup will backup only the database logs
2327 for each Storage Group by inspecting the "modified date" on each
2328 physical log file. Because of the way the Exchange API works, the last
2329 logfile backed up on each backup will always be backed up by the next
2330 Incremental or Differential backup too. This adds 5MB to each
2331 Incremental or Differential backup size but otherwise does not cause any
2334 By default, a normal VSS fileset containing all the drive letters will
2335 also back up the Exchange databases using VSS. This will interfere with
2336 the plugin and Exchange's shared ideas of when the last full backup was
2337 done, and may also truncate log files incorrectly. It is important,
2338 therefore, that the Exchange database files be excluded from the backup,
2339 although the folders the files are in should be included, or they will
2340 have to be recreated manually if a baremetal restore is done.
2345 File = C:/Program Files/Exchsrvr/mdbdata
2346 Plugin = "exchange:..."
2349 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2350 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2351 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2352 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2353 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2354 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2355 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2360 The advantage of excluding the above files is that you can significantly
2361 reduce the size of your backup since all the important Exchange files
2362 will be properly saved by the Plugin.
2365 \subsection{Restoring}
2366 The restore operation is much the same as a normal Bacula restore, with
2367 the following provisos:
2370 \item The {\bf Where} restore option must not be specified
2371 \item Each Database directory must be marked as a whole. You cannot just
2372 select (say) the .edb file and not the others.
2373 \item If a Storage Group is restored, the directory of the Storage Group
2375 \item It is possible to restore only a subset of the available log files,
2376 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2377 if a log file is missing from the sequence of log files
2378 \item Each database to be restored must be dismounted and marked as "Can be
2379 overwritten by restore"
2380 \item If an entire Storage Group is to be restored (eg all databases and
2381 logs in the Storage Group), then it is best to manually delete the
2382 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2383 as Exchange can get confused by stray log files lying around.
2386 \subsection{Restoring to the Recovery Storage Group}
2387 The concept of the Recovery Storage Group is well documented by
2389 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2390 but to briefly summarize...
2392 Microsoft Exchange allows the creation of an additional Storage Group
2393 called the Recovery Storage Group, which is used to restore an older
2394 copy of a database (e.g. before a mailbox was deleted) into without
2395 messing with the current live data. This is required as the Standard and
2396 Small Business Server versions of Exchange can not ordinarily have more
2397 than one Storage Group.
2399 To create the Recovery Storage Group, drill down to the Server in Exchange
2400 System Manager, right click, and select
2401 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2402 locations and click OK. On the Recovery Storage Group, right click and
2403 select {\bf "Add Database to Recover..."} and select the database you will
2406 Restore only the single database nominated as the database in the
2407 Recovery Storage Group. Exchange will redirect the restore to the
2408 Recovery Storage Group automatically.
2409 Then run the restore.
2411 \subsection{Restoring on Microsoft Server 2007}
2412 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2413 2007, and henc you use a new proceedure for recovering a single mail box.
2414 This procedure is ducomented by Microsoft at:
2415 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2416 and involves using the {\bf Restore-Mailbox} and {\bf
2417 Get-MailboxStatistics} shell commands.
2419 \subsection{Caveats}
2420 This plugin is still being developed, so you should consider it
2421 currently in BETA test, and thus use in a production environment
2422 should be done only after very careful testing.
2424 When doing a full backup, the Exchange database logs are truncated by
2425 Exchange as soon as the plugin has completed the backup. If the data
2426 never makes it to the backup medium (eg because of spooling) then the
2427 logs will still be truncated, but they will also not have been backed
2428 up. A solution to this is being worked on. You will have to schedule a
2429 new Full backup to ensure that your next backups will be usable.
2431 The "Enable Circular Logging" option cannot be enabled or the plugin
2434 Exchange insists that a successful Full backup must have taken place if
2435 an Incremental or Differential backup is desired, and the plugin will
2436 fail if this is not the case. If a restore is done, Exchange will
2437 require that a Full backup be done before an Incremental or Differential
2440 The plugin will most likely not work well if another backup application
2441 (eg NTBACKUP) is backing up the Exchange database, especially if the
2442 other backup application is truncating the log files.
2444 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2445 we recommend either carefully testing or that you avoid this option for
2448 The Exchange plugin is not called during processing the bconsole {\bf
2449 estimate} command, and so anything that would be backed up by the plugin
2450 will not be added to the estimate total that is displayed.
2453 \section{libdbi Framework}
2454 \index[general]{libdbi Framework}
2455 As a general guideline, Bacula has support for a few catalog database drivers
2456 (MySQL, PostgreSQL, SQLite)
2457 coded natively by the Bacula team. With the libdbi implementation, which is a
2458 Bacula driver that uses libdbi to access the catalog, we have an open field to
2459 use many different kinds database engines following the needs of users.
2461 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2462 implements a database-independent abstraction layer in C, similar to the
2463 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2464 leverage the power of multiple databases and multiple simultaneous database
2465 connections by using this framework.
2467 Currently the libdbi driver in Bacula project only supports the same drivers
2468 natively coded in Bacula. However the libdbi project has support for many
2469 others database engines. You can view the list at
2470 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2471 supported by Bacula, however, they must be tested properly by the Bacula team.
2473 Some of benefits of using libdbi are:
2475 \item The possibility to use proprietary databases engines in which your
2476 proprietary licenses prevent the Bacula team from developing the driver.
2477 \item The possibility to use the drivers written for the libdbi project.
2478 \item The possibility to use other database engines without recompiling Bacula
2479 to use them. Just change one line in bacula-dir.conf
2480 \item Abstract Database access, this is, unique point to code and profiling
2481 catalog database access.
2484 The following drivers have been tested:
2486 \item PostgreSQL, with and without batch insert
2487 \item Mysql, with and without batch insert
2492 In the future, we will test and approve to use others databases engines
2493 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2495 To compile Bacula to support libdbi we need to configure the code with the
2496 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2497 [database] is the database engine to be used with Bacula (of course we can
2498 change the driver in file bacula-dir.conf, see below). We must configure the
2499 access port of the database engine with the option --with-db-port, because the
2500 libdbi framework doesn't know the default access port of each database.
2502 The next phase is checking (or configuring) the bacula-dir.conf, example:
2506 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2507 dbname = regress; user = regress; password = ""
2511 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2512 mysql database. Currently the drivers supported by Bacula are: postgresql,
2513 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2515 The following limitations apply when Bacula is set to use the libdbi framework:
2516 - Not tested on the Win32 platform
2517 - A little performance is lost if comparing with native database driver.
2518 The reason is bound with the database driver provided by libdbi and the
2519 simple fact that one more layer of code was added.
2521 It is important to remember, when compiling Bacula with libdbi, the
2522 following packages are needed:
2524 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2525 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2528 You can download them and compile them on your system or install the packages
2529 from your OS distribution.
2531 \section{Console Command Additions and Enhancements}
2532 \index[general]{Console Additions}
2534 \subsection{Display Autochanger Content}
2535 \index[general]{StatusSlots}
2537 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2538 autochanger content.
2542 Slot | Volume Name | Status | Media Type | Pool |
2543 ------+---------------+----------+-------------------+------------|
2544 1 | 00001 | Append | DiskChangerMedia | Default |
2545 2 | 00002 | Append | DiskChangerMedia | Default |
2546 3*| 00003 | Append | DiskChangerMedia | Scratch |
2551 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2552 {\bf update slots} command to synchronize autochanger content with your
2555 \subsection{list joblog job=xxx or jobid=nnn}
2556 \index[general]{list joblog}
2557 A new list command has been added that allows you to list the contents
2558 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2559 or for a particular JobId. The {\bf llist} command will include a line with
2560 the time and date of the entry.
2562 Note for the catalog to have Job Log entries, you must have a directive
2569 In your Director's {\bf Messages} resource.
2571 \subsection{Use separator for multiple commands}
2572 \index[general]{Command Separator}
2573 When using bconsole with readline, you can set the command separator with
2574 \textbf{@separator} command to one
2575 of those characters to write commands who require multiple input in one line.
2577 !$%&'()*+,-/:;<>?[]^`{|}~
2580 \subsection{Deleting Volumes}
2581 The delete volume bconsole command has been modified to
2582 require an asterisk (*) in front of a MediaId otherwise the
2583 value you enter is a taken to be a Volume name. This is so that
2584 users may delete numeric Volume names. The previous Bacula versions
2585 assumed that all input that started with a number was a MediaId.
2587 This new behavior is indicated in the prompt if you read it
2590 \section{Bare Metal Recovery}
2591 The old bare metal recovery project is essentially dead. One
2592 of the main features of it was that it would build a recovery
2593 CD based on the kernel on your system. The problem was that
2594 every distribution has a different boot procedure and different
2595 scripts, and worse yet, the boot procedures and scripts change
2596 from one distribution to another. This meant that maintaining
2597 (keeping up with the changes) the rescue CD was too much work.
2599 To replace it, a new bare metal recovery USB boot stick has been developed
2600 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2601 boot from a USB key.
2605 \item Recovery can be done from within graphical environment.
2606 \item Recovery can be done in a shell.
2607 \item Ubuntu boots on a large number of Linux systems.
2608 \item The process of updating the system and adding new
2609 packages is not too difficult.
2610 \item The USB key can easily be upgraded to newer Ubuntu versions.
2611 \item The USB key has writable partitions for modifications to
2612 the OS and for modification to your home directory.
2613 \item You can add new files/directories to the USB key very easily.
2614 \item You can save the environment from multiple machines on
2616 \item Bacula Systems is funding its ongoing development.
2619 The disadvantages are:
2621 \item The USB key is usable but currently under development.
2622 \item Not everyone may be familiar with Ubuntu (no worse
2624 \item Some older OSes cannot be booted from USB. This can
2625 be resolved by first booting a Ubuntu LiveCD then plugging
2627 \item Currently the documentation is sketchy and not yet added
2628 to the main manual. See below ...
2631 The documentation and the code can be found in the {\bf rescue} package
2632 in the directory {\bf linux/usb}.
2634 \section{Miscellaneous}
2635 \index[general]{Misc New Features}
2637 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2638 \index[general]{Allow Mixed Priority}
2639 This directive is only implemented in version 2.5 and later. When
2640 set to {\bf yes} (default {\bf no}), this job may run even if lower
2641 priority jobs are already running. This means a high priority job
2642 will not have to wait for other jobs to finish before starting.
2643 The scheduler will only mix priorities when all running jobs have
2646 Note that only higher priority jobs will start early. Suppose the
2647 director will allow two concurrent jobs, and that two jobs with
2648 priority 10 are running, with two more in the queue. If a job with
2649 priority 5 is added to the queue, it will be run as soon as one of
2650 the running jobs finishes. However, new priority 10 jobs will not
2651 be run until the priority 5 job has finished.
2653 \subsection{Bootstrap File Directive -- FileRegex}
2654 \index[general]{Bootstrap File Directive}
2655 {\bf FileRegex} is a new command that can be added to the bootstrap
2656 (.bsr) file. The value is a regular expression. When specified, only
2657 matching filenames will be restored.
2659 During a restore, if all File records are pruned from the catalog
2660 for a Job, normally Bacula can restore only all files saved. That
2661 is there is no way using the catalog to select individual files.
2662 With this new feature, Bacula will ask if you want to specify a Regex
2663 expression for extracting only a part of the full backup.
2666 Building directory tree for JobId(s) 1,3 ...
2667 There were no files inserted into the tree, so file selection
2668 is not possible.Most likely your retention policy pruned the files
2670 Do you want to restore all the files? (yes\vb{}no): no
2672 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2673 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2676 \subsection{Bootstrap File Optimization Changes}
2677 In order to permit proper seeking on disk files, we have extended the bootstrap
2678 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2679 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2680 address range and end address range respectively. These two directives replace
2681 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2682 VolEndBlock} directives. Bootstrap files containing the old directives will
2683 still work, but will not properly take advantage of proper disk seeking, and
2684 may read completely to the end of a disk volume during a restore. With the new
2685 format (automatically generated by the new Director), restores will seek
2686 properly and stop reading the volume when all the files have been restored.
2688 \subsection{Solaris ZFS/NFSv4 ACLs}
2689 This is an upgrade of the previous Solaris ACL backup code
2690 to the new library format, which will backup both the old
2691 POSIX(UFS) ACLs as well as the ZFS ACLs.
2693 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2694 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2695 be used to transfer from UFS to ZFS filesystems.
2698 \subsection{Virtual Tape Emulation}
2699 \index[general]{Virtual Tape Emulation}
2700 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2701 the tape code but actually reading and writing to a disk file. Used with the
2702 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2703 and 700 slots. This feature is most useful in testing. It is enabled
2704 by using {\bf Device Type = vtape} in the Storage daemon's Device
2705 directive. This feature is only implemented on Linux machines and should not be
2706 used for production.
2708 \subsection{Bat Enhancements}
2709 \index[general]{Bat Enhancements}
2710 Bat (the Bacula Administration Tool) GUI program has been significantly
2711 enhanced and stabilized. In particular, there are new table based status
2712 commands; it can now be easily localized using Qt4 Linguist.
2714 The Bat communications protocol has been significantly enhanced to improve
2715 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2716 the Director you are using otherwise the communications protocol will not
2719 \subsection{RunScript Enhancements}
2720 \index[general]{RunScript Enhancements}
2721 The {\bf RunScript} resource has been enhanced to permit multiple
2722 commands per RunScript. Simply specify multiple {\bf Command} directives
2729 Command = "/bin/echo test"
2730 Command = "/bin/echo an other test"
2731 Command = "/bin/echo 3 commands in the same runscript"
2738 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2739 implemented, which runs the command after the Volume Shadow Copy has been made.
2741 Console commands can be specified within a RunScript by using:
2742 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2743 carefully tested and debugged and is known to easily crash the Director.
2744 We would appreciate feedback. Due to the recursive nature of this command, we
2745 may remove it before the final release.
2747 \subsection{Status Enhancements}
2748 \index[general]{Status Enhancements}
2749 The bconsole {\bf status dir} output has been enhanced to indicate
2750 Storage daemon job spooling and despooling activity.
2752 \subsection{Connect Timeout}
2753 \index[general]{Connect Timeout}
2754 The default connect timeout to the File
2755 daemon has been set to 3 minutes. Previously it was 30 minutes.
2757 \subsection{ftruncate for NFS Volumes}
2758 \index[general]{ftruncate for NFS Volumes}
2759 If you write to a Volume mounted by NFS (say on a local file server),
2760 in previous Bacula versions, when the Volume was recycled, it was not
2761 properly truncated because NFS does not implement ftruncate (file
2762 truncate). This is now corrected in the new version because we have
2763 written code (actually a kind user) that deletes and recreates the Volume,
2764 thus accomplishing the same thing as a truncate.
2766 \subsection{Support for Ubuntu}
2767 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2768 version of Linux, and thus now provides correct autostart routines.
2769 Since Ubuntu officially supports Bacula, you can also obtain any
2770 recent release of Bacula from the Ubuntu repositories.
2772 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2773 \index[general]{Recycle Pool}
2774 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2775 be placed (moved) when it is recycled. Without this directive, a Volume will
2776 remain in the same pool when it is recycled. With this directive, it can be
2777 moved automatically to any existing pool during a recycle. This directive is
2778 probably most useful when defined in the Scratch pool, so that volumes will
2779 be recycled back into the Scratch pool.
2781 \subsection{FD Version}
2782 \index[general]{FD Version}
2783 The File daemon to Director protocol now includes a version
2784 number, which although there is no visible change for users,
2785 will help us in future versions automatically determine
2786 if a File daemon is not compatible.
2788 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2789 \index[general]{Max Run Sched Time}
2790 The time specifies the maximum allowed time that a job may run, counted from
2791 when the job was scheduled. This can be useful to prevent jobs from running
2792 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2795 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2796 \index[general]{Max Wait Time}
2797 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2798 of checking the maximum allowed time that a job may block for a resource,
2799 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2800 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2801 their job depending on the level. Now, they have to use
2802 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2803 directives are now deprecated.
2805 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2806 \index[general]{Incremental Max Wait Time}
2807 \index[general]{Differential Max Wait Time}
2809 These directives have been deprecated in favor of
2810 \texttt{Incremental|Differential Max Run Time}.
2812 \subsection{Max Run Time directives}
2813 \index[general]{Max Run Time directives}
2814 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2815 maximum allowed time that a job can run depending on the level.
2817 \addcontentsline{lof}{figure}{Job time control directives}
2818 \includegraphics{\idir different_time.eps}
2820 \subsection{Statistics Enhancements}
2821 \index[general]{Statistics Enhancements}
2822 If you (or probably your boss) want to have statistics on your backups to
2823 provide some \textit{Service Level Agreement} indicators, you could use a few
2824 SQL queries on the Job table to report how many:
2828 \item jobs have been successful
2829 \item files have been backed up
2833 However, these statistics are accurate only if your job retention is greater
2834 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2835 be able to use them.
2837 Now, you can use the \textbf{update stats [days=num]} console command to fill
2838 the JobHistory table with new Job records. If you want to be sure to take in
2839 account only \textbf{good jobs}, ie if one of your important job has failed but
2840 you have fixed the problem and restarted it on time, you probably want to
2841 delete the first \textit{bad} job record and keep only the successful one. For
2842 that simply let your staff do the job, and update JobHistory table after two or
2843 three days depending on your organization using the \textbf{[days=num]} option.
2845 These statistics records aren't used for restoring, but mainly for
2846 capacity planning, billings, etc.
2848 The Bweb interface provides a statistics module that can use this feature. You
2849 can also use tools like Talend or extract information by yourself.
2851 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2852 the length of time that Bacula will keep statistics job records in the Catalog
2853 database after the Job End time. (In \texttt{JobHistory} table) When this time
2854 period expires, and if user runs \texttt{prune stats} command, Bacula will
2855 prune (remove) Job records that are older than the specified period.
2857 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2858 job to maintain statistics.
2861 Name = BackupCatalog
2864 Console = "update stats days=3"
2865 Console = "prune stats yes"
2872 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2873 \index[general]{ScratchPool}
2874 This directive permits to specify a specific \textsl{Scratch} pool for the
2875 current pool. This is useful when using multiple storage sharing the same
2876 mediatype or when you want to dedicate volumes to a particular set of pool.
2878 \subsection{Enhanced Attribute Despooling}
2879 \index[general]{Attribute Despooling}
2880 If the storage daemon and the Director are on the same machine, the spool file
2881 that contains attributes is read directly by the Director instead of being
2882 transmitted across the network. That should reduce load and speedup insertion.
2884 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2885 \index[general]{SpoolSize}
2886 A new Job directive permits to specify the spool size per job. This is used
2887 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2889 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2890 \index[general]{MaximumConsoleConnections}
2891 A new director directive permits to specify the maximum number of Console
2892 Connections that could run concurrently. The default is set to 20, but you may
2893 set it to a larger number.
2895 \subsection{VerId = \lt{}string\gt{}}
2896 \index[general]{VerId}
2897 A new director directive permits to specify a personnal identifier that will be
2898 displayed in the \texttt{version} command.
2900 \subsection{dbcheck enhancements}
2901 \index[general]{dbcheck enhancements}
2902 If you are using Mysql, dbcheck will now ask you if you want to create
2903 temporary indexes to speed up orphaned Path and Filename elimination.
2905 A new \texttt{-B} option allows you to print catalog information in a simple
2906 text based format. This is useful to backup it in a secure way.
2921 You can now specify the database connection port in the command line.
2923 \subsection{{-}{-}docdir configure option}
2924 \index[general]{{-}{-}docdir configure option}
2925 You can use {-}{-}docdir= on the ./configure command to
2926 specify the directory where you want Bacula to install the
2927 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2928 {\bf /usr/share/doc/bacula}.
2930 \subsection{{-}{-}htmldir configure option}
2931 \index[general]{{-}{-}htmldir configure option}
2932 You can use {-}{-}htmldir= on the ./configure command to
2933 specify the directory where you want Bacula to install the bat html help
2934 files. The default is {\bf /usr/share/doc/bacula/html}
2936 \subsection{{-}{-}with-plugindir configure option}
2937 \index[general]{{-}{-}plugindir configure option}
2938 You can use {-}{-}plugindir= on the ./configure command to
2939 specify the directory where you want Bacula to install
2940 the plugins (currently only bpipe-fd). The default is