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 \mbacula{} that is not yet released.
5 \section{New Features in 5.2.2}
6 This chapter presents the new features that have been added to the current
7 Community version of \mbacula{} that is now released.
9 \subsection{Additions to RunScript variables}
10 You can have access to Director name using \%D in your runscript
14 RunAfterJob = "/bin/echo Director=%D
17 \section{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 \subsection{LZO Compression}
27 LZO compression has been to the File daemon. From the user's point of view,
28 it works like the GZIP compression (just replace {\bf compression=GZIP} with
29 {\bf compression=LZO}).
34 Options { compression=LZO }
40 LZO provides a much faster compression and decompression speed but lower
41 compression ratio than GZIP. It is a good option when you backup to disk. For
42 tape, the hardware compression is almost always a better option.
44 LZO is a good alternative for GZIP1 when you don't want to slow down your
45 backup. With a modern CPU it should be able to run almost as fast as:
48 \item your client can read data from disk. Unless you have very fast disks like
49 SSD or large/fast RAID array.
50 \item the data transfers between the file daemon and the storage daemon even on
54 Note, \mbacula{} uses compression level LZO1X-1.
57 The code for this feature was contributed by Laurent Papier.
59 \subsection{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 \bsysimageH{tray-monitor}{New tray monitor}{figcom:traymonitor}
71 % \label{figcom:traymonitor}
72 % \caption{New tray monitor}
75 %% \begin{figure}[htbp]
77 %% \includegraphics[width=10cm]{\idir tray-monitor1}
78 %% \label{figcom:traymonitor1}
79 %% \caption{Run a Job through the new tray monitor}
81 \bsysimageH{tray-monitor1}{Run a Job through the new tray monitor}{figcom:traymonitor1}
83 To be able to run a job from the tray monitor, you need to
84 allow specific commands in the Director monitor console:
89 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
90 ClientACL = *all* # you can restrict to a specific host
102 This project was funded by Bacula Systems and is available with Bacula
103 the Enterprise Edition and the Community Edition.
105 \subsection{Purge Migration Job}
107 The new {\bf Purge Migration Job} directive may be added to the Migration
108 Job definition in the Director's configuration file. When it is enabled
109 the Job that was migrated during a migration will be purged at
110 the end of the migration job.
118 Client = localhost-fd
121 Storage = DiskChanger
124 Selection Pattern = ".*Save"
126 Purge Migration Job = yes
132 This project was submitted by Dunlap Blake; testing and documentation was funded
135 \subsection{Changes in Bvfs (Bacula Virtual FileSystem)}
137 Bat has now a bRestore panel that uses Bvfs to display files and
140 %% \begin{figure}[htbp]
142 %% \includegraphics[width=12cm]{\idir
143 %% \label{figcom:batbrestore}
144 %% \caption{Bat Brestore Panel}
146 \bsysimageH{bat-brestore}{Bat Brestore Panel}{figcom:batbrestore}
148 the Bvfs module works correctly with BaseJobs, Copy and Migration jobs.
151 This project was funded by Bacula Systems.
153 \subsubsection*{General notes}
156 \item All fields are separated by a tab
157 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
158 records in very big directories
159 \item All operations (except cache creation) are designed to run instantly
160 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
161 can contribute new faster SQL queries we will be happy, else don't complain
163 \item The cache creation is dependent of the number of directories. As Bvfs
164 shares information across jobs, the first creation can be slow
165 \item All fields are separated by a tab
166 \item Due to potential encoding problem, it's advised to always use pathid in
170 \subsubsection*{Get dependent jobs from a given JobId}
172 Bvfs allows you to query the catalog against any combination of jobs. You
173 can combine all Jobs and all FileSet for a Client in a single session.
175 To get all JobId needed to restore a particular job, you can use the
176 \texttt{.bvfs\_get\_jobids} command.
179 .bvfs_get_jobids jobid=num [all]
183 .bvfs_get_jobids jobid=10
185 .bvfs_get_jobids jobid=10 all
189 In this example, a normal restore will need to use JobIds 1,2,5,10 to
190 compute a complete restore of the system.
192 With the \texttt{all} option, the Director will use all defined FileSet for
195 \subsubsection*{Generating Bvfs cache}
197 The \texttt{.bvfs\_update} command computes the directory cache for jobs
198 specified in argument, or for all jobs if unspecified.
201 .bvfs_update [jobid=numlist]
206 .bvfs_update jobid=1,2,3
209 You can run the cache update process in a RunScript after the catalog backup.
211 \subsubsection*{Get all versions of a specific file}
213 Bvfs allows you to find all versions of a specific file for a given Client with
214 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
215 function uses only PathId and FilenameId. The jobid argument is mandatory but
219 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
220 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
221 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
228 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
229 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
232 \subsubsection*{List directories}
234 Bvfs allows you to list directories in a specific path.
236 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
237 PathId FilenameId FileId JobId LStat Path
238 PathId FilenameId FileId JobId LStat Path
239 PathId FilenameId FileId JobId LStat Path
243 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
244 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
245 listed is a directory.
248 .bvfs_lsdirs pathid=4 jobid=1,11,12
249 4 0 0 0 A A A A A A A A A A A A A A .
250 5 0 0 0 A A A A A A A A A A A A A A ..
251 3 0 0 0 A A A A A A A A A A A A A A regress/
254 In this example, to list directories present in \texttt{regress/}, you can use
256 .bvfs_lsdirs pathid=3 jobid=1,11,12
257 3 0 0 0 A A A A A A A A A A A A A A .
258 4 0 0 0 A A A A A A A A A A A A A A ..
259 2 0 0 0 A A A A A A A A A A A A A A tmp/
262 \subsubsection*{List files}
264 Bvfs allows you to list files in a specific path.
266 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
267 PathId FilenameId FileId JobId LStat Path
268 PathId FilenameId FileId JobId LStat Path
269 PathId FilenameId FileId JobId LStat Path
273 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
274 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
278 .bvfs_lsfiles pathid=4 jobid=1,11,12
279 4 0 0 0 A A A A A A A A A A A A A A .
280 5 0 0 0 A A A A A A A A A A A A A A ..
281 1 0 0 0 A A A A A A A A A A A A A A regress/
284 In this example, to list files present in \texttt{regress/}, you can use
286 .bvfs_lsfiles pathid=1 jobid=1,11,12
287 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
288 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
289 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
290 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
291 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
294 \subsubsection*{Restore set of files}
296 Bvfs allows you to create a SQL table that contains files that you want to
297 restore. This table can be provided to a restore command with the file option.
300 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
302 restore file=?b2num ...
305 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
306 select all files. This query could be time consuming.
308 \texttt{hardlink} list is always composed of a series of two numbers (jobid,
309 fileindex). This information can be found in the LinkFI field of the LStat
312 The \texttt{path} argument represents the name of the table that Bvfs will
313 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
314 b2 and followed by digits).
319 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
323 \subsubsection*{Cleanup after Restore}
325 To drop the table used by the restore command, you can use the
326 \texttt{.bvfs\_cleanup} command.
329 .bvfs_cleanup path=b20001
332 \subsubsection*{Clearing the BVFS Cache}
334 To clear the BVFS cache, you can use the \texttt{.bvfs\_clear\_cache} command.
337 .bvfs_clear_cache yes
341 \subsection{Changes in the Pruning Algorithm}
343 We rewrote the job pruning algorithm in this version. Previously, in some users
344 reported that the pruning process at the end of jobs was very long. It should
345 not be longer the case. Now, \mbacula{} won't prune automatically a Job if this
346 particular Job is needed to restore data. Example:
350 JobId: 2 Level: Incremental
351 JobId: 3 Level: Incremental
352 JobId: 4 Level: Differential
353 .. Other incrementals up to now
356 In this example, if the Job Retention defined in the Pool or in the Client
357 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, \mbacula{} will
358 detect that JobId 1 and 4 are essential to restore data at the current state
359 and will prune only JobId 2 and 3.
361 \texttt{Important}, this change affect only the automatic pruning step after a
362 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
363 \texttt{VolumeRetention} period, important jobs can be pruned.
365 \subsection{Ability to Verify any specified Job}
366 You now have the ability to tell \mbacula{} which Job should verify instead of
367 automatically verify just the last one.
369 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
371 To verify a given job, just specify the Job jobid in argument when starting the
374 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
376 JobName: VerifyVolume
377 Level: VolumeToCatalog
380 Pool: Default (From Job resource)
381 Storage: File (From Job resource)
382 Verify Job: VerifyVol.2010-09-08_14.17.17_03
383 Verify List: /tmp/regress/working/VerifyVol.bsr
384 When: 2010-09-08 14:17:31
386 OK to run? (yes/mod/no):
390 This project was funded by Bacula Systems and is available with Bacula
391 Enterprise Edition and Community Edition.
393 \subsection{Additions to RunScript variables}
394 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
395 command. The Client address is now available through \%h.
398 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
401 %\subsection{Changes in drivetype.exe}
403 %Now the \texttt{drivetype.exe} program allows you to list all local hard
404 %drives. It can help to build dynamic FileSet on Windows.
407 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
411 \subsection{Additions to the Plugin API}
412 The bfuncs structure has been extended to include a number of
415 \subsubsection{bfuncs}
416 The bFuncs structure defines the callback entry points within \mbacula{}
417 that the plugin can use register events, get \mbacula{} values, set
418 \mbacula{} values, and send messages to the Job output or debug output.
420 The exact definition as of this writing is:
422 typedef struct s_baculaFuncs {
425 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
426 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
427 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
428 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
429 int type, utime_t mtime, const char *fmt, ...);
430 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
431 int level, const char *fmt, ...);
432 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
434 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
436 /* New functions follow */
437 bRC (*AddExclude)(bpContext *ctx, const char *file);
438 bRC (*AddInclude)(bpContext *ctx, const char *file);
439 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
440 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
441 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
442 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
448 \item [AddExclude] can be called to exclude a file. The file
449 string passed may include wildcards that will be interpreted by
450 the {\bf fnmatch} subroutine. This function can be called
451 multiple times, and each time the file specified will be added
452 to the list of files to be excluded. Note, this function only
453 permits adding excludes of specific file or directory names,
454 or files matched by the rather simple fnmatch mechanism.
455 See below for information on doing wild-card and regex excludes.
457 \item [NewPreInclude] can be called to create a new Include block. This
458 block will be added after the current defined Include block. This
459 function can be called multiple times, but each time, it will create
460 a new Include section (not normally needed). This function should
461 be called only if you want to add an entirely new Include block.
463 \item [NewInclude] can be called to create a new Include block. This
464 block will be added before any user defined Include blocks. This
465 function can be called multiple times, but each time, it will create
466 a new Include section (not normally needed). This function should
467 be called only if you want to add an entirely new Include block.
469 \item [AddInclude] can be called to add new files/directories to
470 be included. They are added to the current Include block. If
471 NewInclude has not been included, the current Include block is
472 the last one that the user created. This function
473 should be used only if you want to add totally new files/directories
474 to be included in the backup.
476 \item [NewOptions] adds a new Options block to the current Include
477 in front of any other Options blocks. This permits the plugin to
478 add exclude directives (wild-cards and regexes) in front of the
479 user Options, and thus prevent certain files from being backed up.
480 This can be useful if the plugin backs up files, and they should
481 not be also backed up by the main \mbacula{} code. This function
482 may be called multiple times, and each time, it creates a new
483 prepended Options block. Note: normally you want to call this
484 entry point prior to calling AddOptions, AddRegex, or AddWild.
486 \item [AddOptions] allows the plugin it set options in
487 the current Options block, which is normally created with the
488 NewOptions call just prior to adding Include Options.
489 The permitted options are passed as a character string, where
490 each character has a specific meaning as defined below:
493 \item [a] always replace files (default).
494 \item [e] exclude rather than include.
495 \item [h] no recursion into subdirectories.
496 \item [H] do not handle hard links.
497 \item [i] ignore case in wildcard and regex matches.
498 \item [M] compute an MD5 sum.
499 \item [p] use a portable data format on Windows (not recommended).
500 \item [R] backup resource forks and Findr Info.
501 \item [r] read from a fifo
502 \item [S1] compute an SHA1 sum.
503 \item [S2] compute an SHA256 sum.
504 \item [S3] comput an SHA512 sum.
505 \item [s] handle sparse files.
506 \item [m] use st\_mtime only for file differences.
507 \item [k] restore the st\_atime after accessing a file.
508 \item [A] enable ACL backup.
509 \item [Vxxx:] specify verify options. Must terminate with :
510 \item [Cxxx:] specify accurate options. Must terminate with :
511 \item [Jxxx:] specify base job Options. Must terminate with :
512 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
514 \item [Zn] specify gzip compression level n.
515 \item [K] do not use st\_atime in backup decision.
516 \item [c] check if file changed during backup.
517 \item [N] honor no dump flag.
518 \item [X] enable backup of extended attributes.
521 \item [AddRegex] adds a regex expression to the current Options block.
522 The following options are permitted:
524 \item [ ] (a blank) regex applies to whole path and filename.
525 \item [F] regex applies only to the filename (directory or path stripped).
526 \item [D] regex applies only to the directory (path) part of the name.
529 \item [AddWild] adds a wildcard expression to the current Options block.
530 The following options are permitted:
532 \item [ ] (a blank) regex applies to whole path and filename.
533 \item [F] regex applies only to the filename (directory or path stripped).
534 \item [D] regex applies only to the directory (path) part of the name.
537 \item [checkChanges] call the \texttt{check\_changes()} function in \mbacula{} code
538 that can use Accurate code to compare the file information in argument with
539 the previous file information. The \texttt{delta\_seq} attribute of the
540 \texttt{save\_pkt} will be updated, and the call will return
541 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
546 \subsubsection{Bacula events}
547 The list of events has been extended to include:
553 bEventStartBackupJob = 3,
554 bEventEndBackupJob = 4,
555 bEventStartRestoreJob = 5,
556 bEventEndRestoreJob = 6,
557 bEventStartVerifyJob = 7,
558 bEventEndVerifyJob = 8,
559 bEventBackupCommand = 9,
560 bEventRestoreCommand = 10,
565 bEventCancelCommand = 13,
566 bEventVssBackupAddComponents = 14,
567 bEventVssRestoreLoadComponentMetadata = 15,
568 bEventVssRestoreSetComponentsSelected = 16,
569 bEventRestoreObject = 17,
570 bEventEndFileSet = 18,
571 bEventPluginCommand = 19,
572 bEventVssBeforeCloseRestore = 20,
573 bEventVssPrepareSnapshot = 21
579 \item [bEventCancelCommand] is called whenever the currently
580 running Job is canceled */
582 \item [bEventVssBackupAddComponents]
584 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
585 provides a char[27] table where the plugin can add Windows drives that will
586 be used during the Job. You need to add them without duplicates, and you can
587 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
591 \subsection{ACL enhancements}
593 The following enhancements are made to the \mbacula{} Filed with regards to
594 Access Control Lists (ACLs)
597 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
598 POSIX and NFSv4 ACLs.
599 \item Added support for new acl types on FreeBSD 8.1 and later which supports
600 POSIX and NFSv4 ACLs.
601 \item Some generic cleanups for internal ACL handling.
602 \item Fix for acl storage on OSX
603 \item Cleanup of configure checks for ACL detection, now configure only
604 tests for a certain interface type based on the operating system
605 this should give less false positives on detection. Also when ACLs
606 are detected no other acl checks are performed anymore.
610 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
611 and is available with Bacula Enterprise Edition and Community Edition.
613 \subsection{XATTR enhancements}
615 The following enhancements are made to the \mbacula{} Filed with regards to
616 Extended Attributes (XATTRs)
619 \item Added support for IRIX extended attributes using the attr\_get interface.
620 \item Added support for Tru64 (OSF1) extended attributes using the
621 getproplist interface.
622 \item Added support for AIX extended attributes available in AIX 6.x
623 and higher using the listea/getea/setea interface.
624 \item Added some debugging to generic xattr code so it easier to
626 \item Cleanup of configure checks for XATTR detection, now configure only
627 tests for a certain interface type based on the operating system
628 this should give less false positives on detection. Also when xattrs
629 are detected no other xattr checks are performed anymore.
633 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
634 and is available with Bacula Enterprise Edition and Community Edition.
636 \subsection{Class Based Database Backend Drivers}
638 The main \mbacula{} Director code is independent of the SQL backend
639 in version 5.2.0 and greater. This means that the \mbacula{} Director can be
640 packaged by itself, then each of the different SQL backends supported can
641 be packaged separately. It is possible to build all the DB backends at the
642 same time by including multiple database options at the same time.
644 ./configure can be run with multiple database configure options.
651 Order of testing for databases is:
658 Each configured backend generates a file named:
659 \lstinline+libbaccats-<sql_backend_name>-<version>.so+
660 A dummy catalog library is created named libbaccats-version.so
662 At configure time the first detected backend is used as the so called
663 default backend and at install time the dummy
664 \lstinline+libbaccats-<version>.so+ is replaced with the default backend type.
666 If you configure all three backends you get three backend libraries and the
667 postgresql gets installed as the default.
669 When you want to switch to another database, first save any old catalog you
670 may have then you can copy one of the three backend libraries over the
671 \lstinline+libbaccats-<version>.so+ e.g.
673 An actual command, depending on your \mbacula{} version might be:
675 cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
678 where the \lstinline+5.2.2+ must be replaced by the \mbacula{} release
681 Then you must update the default backend in the following files:
684 create_bacula_database
687 grant_bacula_privileges
693 And re-run all the above scripts. Please note, this means
694 you will have a new empty database and if you had a previous
697 All current database backend drivers for catalog information are rewritten
698 to use a set of multi inherited C++ classes which abstract the specific
699 database specific internals and make sure we have a more stable generic
700 interface with the rest of SQL code. From now on there is a strict
701 boundary between the SQL code and the low-level database functions. This
702 new interface should also make it easier to add a new backend for a
703 currently unsupported database. As part of the rewrite the SQLite 2 code
704 was removed (e.g. only SQLite 3 is now supported). An extra bonus of the
705 new code is that you can configure multiple backends in the configure and
706 build all backends in one compile session and select the correct database
707 backend at install time. This should make it a lot easier for packages
713 We also added cursor support for PostgreSQL backend, this improves memory
714 usage for large installation.
717 This project was implemented by Planets Communications B.V. and ELM
718 Consultancy B.V. and Bacula Systems and is available with both the Bacula
719 Enterprise Edition and the Community Edition.
721 \subsection{Hash List Enhancements}
723 The htable hash table class has been extended with extra hash functions for
724 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
725 Also the hash table initialization routines have been enhanced with
726 support for passing a hint as to the number of initial pages to use
727 for the size of the hash table. Until now the hash table always used
728 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
729 cache have been rewritten to use the new htable class with a small memory
733 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
734 and Bacula Systems and is available with Bacula Enterprise Edition and
739 %%% =====================================================================
744 \section{Release Version 5.0.3}
746 There are no new features in version 5.0.2. This version simply fixes a
747 number of bugs found in version 5.0.1 during the ongoing development
750 \section{Release Version 5.0.2}
752 There are no new features in version 5.0.2. This version simply fixes a
753 number of bugs found in version 5.0.1 during the ongoing development
759 \section{New Features in 5.0.1}
761 This chapter presents the new features that are in the released Bacula version
762 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
763 the ongoing development process.
765 \subsection{Truncate Volume after Purge}
766 \label{seccom:actiononpurge}
768 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
769 the volume when it is purged with the new command \texttt{purge volume
770 action}. It is useful to prevent disk based volumes from consuming too much
776 Action On Purge = Truncate
781 As usual you can also set this property with the \texttt{update volume} command
783 *update volume=xxx ActionOnPurge=Truncate
784 *update volume=xxx actiononpurge=None
787 To ask \mbacula{} to truncate your \texttt{Purged} volumes, you need to use the
788 following command in interactive mode or in a RunScript as shown after:
790 *purge volume action=truncate storage=File allpools
791 # or by default, action=all
792 *purge volume action storage=File pool=Default
795 This is possible to specify the volume name, the media type, the pool, the
796 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
797 idle when you decide to run this command.
806 Console = "purge volume action=all allpools storage=File"
811 \textbf{Important note}: This feature doesn't work as
812 expected in version 5.0.0. Please do not use it before version 5.0.1.
814 \subsection{Allow Higher Duplicates}
815 This directive did not work correctly and has been depreciated
816 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
817 file as it will be removed in a future release.
819 \subsection{Cancel Lower Level Duplicates}
820 This directive was added in Bacula version 5.0.1. It compares the
821 level of a new backup job to old jobs of the same name, if any,
822 and will kill the job which has a lower level than the other one.
823 If the levels are the same (i.e. both are Full backups), then
824 nothing is done and the other Cancel XXX Duplicate directives
827 \section{New Features in 5.0.0}
829 \subsection{Maximum Concurrent Jobs for Devices}
830 \label{seccom:maximumconcurrentjobdevice}
832 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
833 Daemon configuration permits setting the maximum number of Jobs that can
834 run concurrently on a specified Device. Using this directive, it is
835 possible to have different Jobs using multiple drives, because when the
836 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
837 Jobs on any other available compatible drive. This facilitates writing to
838 multiple drives with multiple Jobs that all use the same Pool.
840 This project was funded by Bacula Systems.
842 \subsection{Restore from Multiple Storage Daemons}
843 \index[general]{Restore}
845 Previously, you were able to restore from multiple devices in a single Storage
846 Daemon. Now, \mbacula{} is able to restore from multiple Storage Daemons. For
847 example, if your full backup runs on a Storage Daemon with an autochanger, and
848 your incremental jobs use another Storage Daemon with lots of disks, \mbacula{}
849 will switch automatically from one Storage Daemon to an other within the same
852 You must upgrade your File Daemon to version 3.1.3 or greater to use this
855 This project was funded by Bacula Systems with the help of Equiinet.
857 \subsection{File Deduplication using Base Jobs}
858 A base job is sort of like a Full save except that you will want the FileSet to
859 contain only files that are unlikely to change in the future (i.e. a snapshot
860 of most of your system after installing it). After the base job has been run,
861 when you are doing a Full save, you specify one or more Base jobs to be used.
862 All files that have been backed up in the Base job/jobs but not modified will
863 then be excluded from the backup. During a restore, the Base jobs will be
864 automatically pulled in where necessary.
866 This is something none of the competition does, as far as we know (except
867 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
868 win for the user, it makes \mbacula{} stand out as offering a unique optimization
869 that immediately saves time and money. Basically, imagine that you have 100
870 nearly identical Windows or Linux machine containing the OS and user files.
871 Now for the OS part, a Base job will be backed up once, and rather than making
872 100 copies of the OS, there will be only one. If one or more of the systems
873 have some files updated, no problem, they will be automatically restored.
875 See the \ilink{Base Job Chapter}{basejobs} for more information.
877 This project was funded by Bacula Systems.
879 \subsection{AllowCompression = \lt{}yes\vb{}no\gt{}}
880 \index[dir]{AllowCompression}
882 This new directive may be added to Storage resource within the Director's
883 configuration to allow users to selectively disable the client compression for
884 any job which writes to this storage resource.
890 Address = ultrium-tape
891 Password = storage_password # Password for Storage Daemon
894 AllowCompression = No # Tape drive has hardware compression
897 The above example would cause any jobs running with the UltriumTape storage
898 resource to run without compression from the client file daemons. This
899 effectively overrides any compression settings defined at the FileSet level.
901 This feature is probably most useful if you have a tape drive which supports
902 hardware compression. By setting the \texttt{AllowCompression = No} directive
903 for your tape drive storage resource, you can avoid additional load on the file
904 daemon and possibly speed up tape backups.
906 This project was funded by Collaborative Fusion, Inc.
908 \subsection{Accurate Fileset Options}
909 \label{seccom:accuratefileset}
911 In previous versions, the accurate code used the file creation and modification
912 times to determine if a file was modified or not. Now you can specify which
913 attributes to use (time, size, checksum, permission, owner, group, \dots),
914 similar to the Verify options.
930 \item {\bf i} compare the inodes
931 \item {\bf p} compare the permission bits
932 \item {\bf n} compare the number of links
933 \item {\bf u} compare the user id
934 \item {\bf g} compare the group id
935 \item {\bf s} compare the size
936 \item {\bf a} compare the access time
937 \item {\bf m} compare the modification time (st\_mtime)
938 \item {\bf c} compare the change time (st\_ctime)
939 \item {\bf d} report file size decreases
940 \item {\bf 5} compare the MD5 signature
941 \item {\bf 1} compare the SHA1 signature
944 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
945 the File Daemon will have to read all files even if they normally would not
946 be saved. This increases the I/O load, but also the accuracy of the
947 deduplication. By default, \mbacula{} will check modification/creation time
950 This project was funded by Bacula Systems.
952 \subsection{Tab-completion for Bconsole}
953 \label{seccom:tabcompletion}
955 If you build \texttt{bconsole} with readline support, you will be able to use
956 the new auto-completion mode. This mode supports all commands, gives help
957 inside command, and lists resources when required. It works also in the restore
960 To use this feature, you should have readline development package loaded on
961 your system, and use the following option in configure.
963 ./configure --with-readline=/usr/include/readline --disable-conio ...
966 The new bconsole won't be able to tab-complete with older directors.
968 This project was funded by Bacula Systems.
970 \subsection{Pool File and Job Retention}
971 \label{seccom:poolfilejobretention}
973 We added two new Pool directives, \texttt{FileRetention} and
974 \texttt{JobRetention}, that take precedence over Client directives of the same
975 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
976 example, you can decide to increase Retention times for Archive or OffSite Pool.
978 It seems obvious to us, but apparently not to some users, that given the
979 definition above that the Pool File and Job Retention periods is a global
980 override for the normal Client based pruning, which means that when the
981 Job is pruned, the pruning will apply globally to that particular Job.
983 Currently, there is a bug in the implementation that causes any Pool
984 retention periods specified to apply to {\bf all} Pools for that
985 particular Client. Thus we suggest that you avoid using these two
986 directives until this implementation problem is corrected.
988 \subsection{Read-only File Daemon using capabilities}
989 \label{seccom:fdreadonly}
990 This feature implements support of keeping \textbf{ReadAll} capabilities after
991 UID/GID switch, this allows FD to keep root read but drop write permission.
993 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
994 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
997 root@localhost:~# bacula-fd -k -u nobody -g nobody
1000 The code for this feature was contributed by our friends at AltLinux.
1002 \subsection{Bvfs API}
1005 To help developers of restore GUI interfaces, we have added new \textsl{dot
1006 commands} that permit browsing the catalog in a very simple way.
1009 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
1010 the Bvfs cache in the catalog. You need to run it before any access to the
1013 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
1014 will list all directories in the specified \texttt{path} or
1015 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
1016 encoding of path/filenames.
1018 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
1019 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
1020 \texttt{pathid} avoids problems with character encoding.
1023 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
1024 data that will be displayed.
1027 * .bvfs_update jobid=1,2
1029 * .bvfs_lsdir path=/ jobid=1,2
1032 This project was funded by Bacula Systems.
1034 \subsection{Testing your Tape Drive}
1035 \label{seccom:btapespeed}
1037 To determine the best configuration of your tape drive, you can run the new
1038 \texttt{speed} command available in the \texttt{btape} program.
1040 This command can have the following arguments:
1042 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
1043 (between 1 and 5GB). This counter is in GB.
1044 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
1045 of data should be greater than your memory ($file\_size*nb\_file$).
1046 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
1048 \item[\texttt{skip\_random}] This flag permits to skip tests with random
1050 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
1051 \item[\texttt{skip\_block}] This flag permits to skip tests with \mbacula{} block
1056 *speed file_size=3 skip_raw
1057 btape.c:1078 Test with zero data and bacula block structure.
1058 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1059 ++++++++++++++++++++++++++++++++++++++++++
1060 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1061 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
1063 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
1065 btape.c:1090 Test with random data, should give the minimum throughput.
1066 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1067 +++++++++++++++++++++++++++++++++++++++++++
1068 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1069 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
1070 +++++++++++++++++++++++++++++++++++++++++++
1072 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
1076 When using compression, the random test will give your the minimum throughput
1077 of your drive . The test using constant string will give you the maximum speed
1078 of your hardware chain. (CPU, memory, SCSI card, cable, drive, tape).
1080 You can change the block size in the Storage Daemon configuration file.
1082 \subsection{New {\bf Block Checksum} Device Directive}
1083 You may now turn off the Block Checksum (CRC32) code
1084 that \mbacula{} uses when writing blocks to a Volume. This is
1091 doing so can reduce the Storage daemon CPU usage slightly. It
1092 will also permit \mbacula{} to read a Volume that has corrupted data.
1094 The default is {\bf yes} -- i.e. the checksum is computed on write
1095 and checked on read.
1097 We do not recommend to turn this off particularly on older tape
1098 drives or for disk Volumes where doing so may allow corrupted data
1101 \subsection{New Bat Features}
1103 Those new features were funded by Bacula Systems.
1105 \subsubsection{Media List View}
1107 By clicking on ``Media'', you can see the list of all your volumes. You will be
1108 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1109 in the table. The old ``Media'' view is now known as ``Pool''.
1110 %% \begin{figure}[htbp]
1112 %% \includegraphics[width=13cm]{\idir bat-mediaview}
1113 %% \label{figcom:mediaview}
1115 \bsysimageH{bat-mediaview}{List of all Volumes}{figcom:mediaview}
1117 \subsubsection{Media Information View}
1119 By double-clicking on a volume (on the Media list, in the Autochanger content
1120 or in the Job information panel), you can access a detailed overview of your
1121 Volume. (cf. figure \bsysref{figcom:mediainfo}.)
1122 %% \begin{figure}[htbp]
1124 %% \includegraphics[width=13cm]{\idir bat11}
1125 %% \caption{Media information}
1126 %% \label{figcom:mediainfo}
1128 \bsysimageH{bat11}{Media information}{figcom:mediainfo}
1129 \subsubsection{Job Information View}
1131 By double-clicking on a Job record (on the Job run list or in the Media
1132 information panel), you can access a detailed overview of your Job. (cf
1133 \bsysref{figcom:jobinfo}.)
1134 %% \begin{figure}[htbp]
1136 %% \includegraphics[width=13cm]{\idir bat12}
1137 %% \caption{Job information}
1138 %% \label{figcom:jobinfo}
1140 \bsysimageH{bat12}{Job information}{figcom:jobinfo}
1142 \subsubsection{Autochanger Content View}
1144 By double-clicking on a Storage record (on the Storage list panel), you can
1145 access a detailed overview of your Autochanger. (cf. figure \bsysref{figcom:jobinfo}.)
1146 %% \begin{figure}[htbp]
1148 %% \includegraphics[width=13cm]{\idir bat13}
1149 %% \caption{Autochanger content}
1150 %% \label{figcom:achcontent}
1152 \bsysimageH{bat13}{Autochanger content}{figcom:achcontent}
1154 To use this feature, you need to use the latest mtx-changer script
1155 version. (With new \texttt{listall} and \texttt{transfer} commands)
1157 \subsection{Bat on Windows}
1158 We have ported {\bf bat} to Windows and it is now installed
1159 by default when the installer is run. It works quite well
1160 on Win32, but has not had a lot of testing there, so your
1161 feedback would be welcome. Unfortunately, even though it is
1162 installed by default, it does not yet work on 64 bit Windows
1165 \subsection{New Win32 Installer}
1166 The Win32 installer has been modified in several very important
1169 \item You must deinstall any current version of the
1170 Win32 File daemon before upgrading to the new one.
1171 If you forget to do so, the new installation will fail.
1172 To correct this failure, you must manually shutdown
1173 and deinstall the old File daemon.
1174 \item All files (other than menu links) are installed
1175 in {\bf c:/Program Files/Bacula}.
1176 \item The installer no longer sets this
1177 file to require administrator privileges by default. If you want
1178 to do so, please do it manually using the {\bf cacls} program.
1181 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1183 \item The server daemons (Director and Storage daemon) are
1184 no longer included in the Windows installer. If you want the
1185 Windows servers, you will either need to build them yourself (note
1186 they have not been ported to 64 bits), or you can contact
1187 Bacula Systems about this.
1190 \subsection{Win64 Installer}
1191 We have corrected a number of problems that required manual
1192 editing of the conf files. In most cases, it should now
1193 install and work. {\bf bat} is by default installed in
1194 {\bf c:/Program Files/Bacula/bin32} rather than
1195 {\bf c:/Program Files/Bacula} as is the case with the 32
1196 bit Windows installer.
1198 \subsection{Linux Bare Metal Recovery USB Key}
1199 We have made a number of significant improvements in the
1200 Bare Metal Recovery USB key. Please see the README files
1201 it the {\bf rescue} release for more details.
1203 We are working on an equivalent USB key for Windows bare
1204 metal recovery, but it will take some time to develop it (best
1205 estimate 3Q2010 or 4Q2010)
1208 \subsection{bconsole Timeout Option}
1209 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1210 for commands. This is useful with GUI programs that use {\bf bconsole}
1211 to interface to the Director.
1213 \subsection{Important Changes}
1214 \label{seccom:importantchanges}
1217 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1218 to the same Pool. The Storage daemon ensures that you do not read and
1219 write to the same Volume.
1220 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1222 \item Virtually all the features of {\bf mtx-changer} have
1223 now been parametrized, which allows you to configure
1224 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1225 that contains variables that you can set to configure mtx-changer.
1226 This configuration file will not be overwritten during upgrades.
1227 We encourage you to submit any changes
1228 that are made to mtx-changer and to parametrize it all in
1229 mtx-changer.conf so that all configuration will be done by
1230 changing only mtx-changer.conf.
1231 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1232 and \texttt{transfer}. Please configure them as appropriate
1233 in mtx-changer.conf.
1234 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1235 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1236 password. If you want to use the new script, you will need to
1237 manually change the \texttt{BackupCatalog} Job definition.
1238 \item The \texttt{bconsole} \texttt{help} command now accepts
1239 an argument, which if provided produces information on that
1240 command (ex: \texttt{help run}).
1244 \subsubsection*{Truncate volume after purge}
1246 Note that the Truncate Volume after purge feature doesn't work as expected
1247 in 5.0.0 version. Please, don't use it before version 5.0.1.
1249 \subsubsection{Custom Catalog queries}
1251 If you wish to add specialized commands that list the contents of the catalog,
1252 you can do so by adding them to the \texttt{query.sql} file. This
1253 \texttt{query.sql} file is now empty by default. The file
1254 \texttt{examples/sample-query.sql} has an a number of sample commands
1255 you might find useful.
1257 \subsubsection{Deprecated parts}
1259 The following items have been \textbf{deprecated} for a long time, and are now
1260 removed from the code.
1263 \item Support for SQLite 2
1266 \subsection{Misc Changes}
1267 \label{seccom:miscchanges}
1270 \item Updated Nagios check\_bacula
1271 \item Updated man files
1272 \item Added OSX package generation script in platforms/darwin
1273 \item Added Spanish and Ukrainian Bacula translations
1274 \item Enable/disable command shows only Jobs that can change
1275 \item Added \texttt{show disabled} command to show disabled Jobs
1276 \item Many ACL improvements
1277 \item Added Level to FD status Job output
1278 \item Begin Ingres DB driver (not yet working)
1279 \item Split RedHat spec files into bacula, bat, mtx, and docs
1280 \item Reorganized the manuals (fewer separate manuals)
1281 \item Added lock/unlock order protection in lock manager
1282 \item Allow 64 bit sizes for a number of variables
1283 \item Fixed several deadlocks or potential race conditions in the SD
1286 \chapter{Released Version 3.0.3 and 3.0.3a}
1288 There are no new features in version 3.0.3. This version simply fixes a
1289 number of bugs found in version 3.0.2 during the ongoing development
1292 \section{New Features in Released Version 3.0.2}
1294 This chapter presents the new features added to the
1295 Released Bacula Version 3.0.2.
1297 \subsection{Full Restore from a Given JobId}
1298 \index[general]{Restore menu}
1300 This feature allows selecting a single JobId and having \mbacula{}
1301 automatically select all the other jobs that comprise a full backup up to
1302 and including the selected date (through JobId).
1304 Assume we start with the following jobs:
1306 +-------+--------------+---------------------+-------+----------+------------+
1307 | jobid | client | starttime | level | jobfiles | jobbytes |
1308 +-------+--------------+---------------------+-------+----------+------------
1309 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1310 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1311 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1312 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1313 +-------+--------------+---------------------+-------+----------+------------+
1316 Below is an example of this new feature (which is number 12 in the
1321 To select the JobIds, you have the following choices:
1322 1: List last 20 Jobs run
1323 2: List Jobs where a given File is saved
1325 12: Select full restore to a specified Job date
1328 Select item: (1-13): 12
1329 Enter JobId to get the state to restore: 5
1330 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1331 You have selected the following JobIds: 1,3,5
1333 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1334 1,444 files inserted into the tree.
1337 This project was funded by Bacula Systems.
1339 \subsection{Source Address}
1340 \index[general]{Source address}
1342 A feature has been added which allows the administrator to specify the address
1343 from which the Director and File daemons will establish connections. This
1344 may be used to simplify system configuration overhead when working in complex
1345 networks utilizing multi-homing and policy-routing.
1347 To accomplish this, two new configuration directives have been implemented:
1350 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1354 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1358 Simply adding specific host routes on the OS
1359 would have an undesirable side-effect: any
1360 application trying to contact the destination host would be forced to use the
1361 more specific route possibly diverting management traffic onto a backup VLAN.
1362 Instead of adding host routes for each client connected to a multi-homed backup
1363 server (for example where there are management and backup VLANs), one can
1364 use the new directives to specify a specific source address at the application
1367 Additionally, this allows the simplification and abstraction of firewall rules
1368 when dealing with a Hot-Standby director or storage daemon configuration. The
1369 Hot-standby pair may share a CARP address, which connections must be sourced
1370 from, while system services listen and act from the unique interface addresses.
1372 This project was funded by Collaborative Fusion, Inc.
1374 \subsection{Show volume availability when doing restore}
1376 When doing a restore the selection dialog ends by displaying this
1380 The job will require the following
1381 Volume(s) Storage(s) SD Device(s)
1382 ===========================================================================
1383 *000741L3 LTO-4 LTO3
1384 *000866L3 LTO-4 LTO3
1385 *000765L3 LTO-4 LTO3
1386 *000764L3 LTO-4 LTO3
1387 *000756L3 LTO-4 LTO3
1388 *001759L3 LTO-4 LTO3
1389 *001763L3 LTO-4 LTO3
1393 Volumes marked with ``*'' are online (in the autochanger).
1396 This should help speed up large restores by minimizing the time spent
1397 waiting for the operator to discover that he must change tapes in the library.
1399 This project was funded by Bacula Systems.
1401 \subsection{Accurate estimate command}
1403 The \texttt{estimate} command can now use the accurate code to detect changes
1404 and give a better estimation.
1406 You can set the accurate behavior on the command line by using
1407 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1410 * estimate listing accurate=yes level=incremental job=BackupJob
1413 This project was funded by Bacula Systems.
1415 \section{New Features in 3.0.0}
1416 \label{3:NewFeaturesChapter}
1417 \index[general]{New features}
1419 This chapter presents the new features added to the development 2.5.x
1420 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1422 \subsection{Accurate Backup}\label{accuratemode}
1423 \index[general]{Accurate backup}
1425 As with most other backup programs, by default \mbacula{} decides what files to
1426 backup for Incremental and Differential backup by comparing the change
1427 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1428 backup completed. If one of those two times is later than the last backup
1429 time, then the file will be backed up. This does not, however, permit tracking
1430 what files have been deleted and will miss any file with an old time that may
1431 have been restored to or moved onto the client filesystem.
1433 \subsubsection{Accurate = \lt{}yes\vb{}no\gt{}}
1434 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1435 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1436 backup, there is no difference, but for {\bf Differential} and {\bf
1437 Incremental} backups, the Director will send a list of all previous files
1438 backed up, and the File daemon will use that list to determine if any new files
1439 have been added or or moved and if any files have been deleted. This allows
1440 \mbacula{} to make an accurate backup of your system to that point in time so that
1441 if you do a restore, it will restore your system exactly.
1444 about using Accurate backup is that it requires more resources (CPU and memory)
1445 on both the Director and the Client machines to create the list of previous
1446 files backed up, to send that list to the File daemon, for the File daemon to
1447 keep the list (possibly very big) in memory, and for the File daemon to do
1448 comparisons between every file in the FileSet and the list. In particular,
1449 if your client has lots of files (more than a few million), you will need
1450 lots of memory on the client machine.
1452 Accurate must not be enabled when backing up with a plugin that is not
1453 specially designed to work with Accurate. If you enable it, your restores
1454 will probably not work correctly.
1456 This project was funded by Bacula Systems.
1460 \subsection{Copy Jobs}
1461 \index[general]{Copy jobs}
1463 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1464 existing Migration feature with the exception that the Job that is copied is
1465 left unchanged. This essentially creates two identical copies of the same
1466 backup. However, the copy is treated as a copy rather than a backup job, and
1467 hence is not directly available for restore. The {\bf restore} command lists
1468 copy jobs and allows selection of copies by using \texttt{jobid=}
1469 option. If the keyword {\bf copies} is present on the command line, \mbacula{} will
1470 display the list of all copies for selected jobs.
1475 These JobIds have copies as follows:
1476 +-------+------------------------------------+-----------+------------------+
1477 | JobId | Job | CopyJobId | MediaType |
1478 +-------+------------------------------------+-----------+------------------+
1479 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1480 +-------+------------------------------------+-----------+------------------+
1481 +-------+-------+----------+----------+---------------------+------------------+
1482 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1483 +-------+-------+----------+----------+---------------------+------------------+
1484 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1485 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1486 +-------+-------+----------+----------+---------------------+------------------+
1487 You have selected the following JobIds: 19,2
1489 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1490 5,611 files inserted into the tree.
1495 The Copy Job runs without using the File daemon by copying the data from the
1496 old backup Volume to a different Volume in a different Pool. See the Migration
1497 documentation for additional details. For copy Jobs there is a new selection
1498 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1499 not already copied to another Pool.
1501 As with Migration, the Client, Volume, Job, or SQL query, are
1502 other possible ways of selecting the Jobs to be copied. Selection
1503 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1504 work, but are probably more suited for Migration Jobs.
1506 If \mbacula{} finds a Copy of a job record that is purged (deleted) from the catalog,
1507 it will promote the Copy to a \textsl{real} backup job and will make it available for
1508 automatic restore. If more than one Copy is available, it will promote the copy
1509 with the smallest JobId.
1511 A nice solution which can be built with the new Copy feature is often
1512 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1513 look something like the one below:
1517 Name = FullBackupsVirtualPool
1519 Purge Oldest Volume = Yes
1521 NextPool = FullBackupsTapePool
1525 Name = FullBackupsTapePool
1529 Volume Retention = 365 days
1530 Storage = superloader
1534 # Fake fileset for copy jobs
1546 # Fake client for copy jobs
1556 # Default template for a CopyDiskToTape Job
1559 Name = CopyDiskToTape
1561 Messages = StandardCopy
1564 Selection Type = PoolUncopiedJobs
1565 Maximum Concurrent Jobs = 10
1567 Allow Duplicate Jobs = Yes
1568 Cancel Queued Duplicates = No
1569 Cancel Running Duplicates = No
1574 Name = DaySchedule7:00
1575 Run = Level=Full daily at 7:00
1579 Name = CopyDiskToTapeFullBackups
1581 Schedule = DaySchedule7:00
1582 Pool = FullBackupsVirtualPool
1583 JobDefs = CopyDiskToTape
1587 The example above had 2 pool which are copied using the PoolUncopiedJobs
1588 selection criteria. Normal Full backups go to the Virtual pool and are copied
1589 to the Tape pool the next morning.
1591 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1596 +-------+------------------------------------+-----------+------------------+
1597 | JobId | Job | CopyJobId | MediaType |
1598 +-------+------------------------------------+-----------+------------------+
1599 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1600 +-------+------------------------------------+-----------+------------------+
1603 \subsection{ACL Updates}
1604 \index[general]{ACL updates}
1605 The whole ACL code had been overhauled and in this version each platforms has
1606 different streams for each type of acl available on such an platform. As ACLs
1607 between platforms tend to be not that portable (most implement POSIX acls but
1608 some use an other draft or a completely different format) we currently only
1609 allow certain platform specific ACL streams to be decoded and restored on the
1610 same platform that they were created on. The old code allowed to restore ACL
1611 cross platform but the comments already mention that not being to wise. For
1612 backward compatibility the new code will accept the two old ACL streams and
1613 handle those with the platform specific handler. But for all new backups it
1614 will save the ACLs using the new streams.
1616 Currently the following platforms support ACLs:
1620 \item {\bf Darwin/OSX}
1629 Currently we support the following ACL types (these ACL streams use a reserved
1630 part of the stream numbers):
1633 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1635 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1636 string representation from acl\_to\_text (POSIX acl)
1637 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1638 string representation from acl\_to\_text (POSIX acl) for default acls.
1639 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1640 string representation from acl\_to\_text (POSIX acl) for access acls.
1641 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1642 string representation from acltostr (POSIX acl)
1643 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1644 representation from acl\_to\_text (POSIX acl) for default acls.
1645 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1646 representation from acl\_to\_text (POSIX acl) for access acls.
1647 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1648 string representation from acl\_to\_text (POSIX acl) for default acls.
1649 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1650 representation from acl\_to\_text (POSIX acl) for access acls.
1651 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1652 string representation from acl\_to\_text (POSIX acl) for default acls.
1653 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1654 string representation from acl\_to\_text (POSIX acl) for default acls.
1655 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1656 representation from acl\_to\_text (POSIX acl) for access acls.
1657 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1658 string representation from acltotext or acl\_totext (POSIX acl)
1659 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1660 representation from from acl\_totext (NFSv4 or ZFS acl)
1663 In future versions we might support conversion functions from one type of acl
1664 into an other for types that are either the same or easily convertible. For now
1665 the streams are separate and restoring them on a platform that doesn't
1666 recognize them will give you a warning.
1668 \subsection{Extended Attributes}
1669 \index[general]{Extended attributes}
1670 Something that was on the project list for some time is now implemented for
1671 platforms that support a similar kind of interface. Its the support for backup
1672 and restore of so called extended attributes. As extended attributes are so
1673 platform specific these attributes are saved in separate streams for each
1674 platform. Restores of the extended attributes can only be performed on the
1675 same platform the backup was done. There is support for all types of extended
1676 attributes, but restoring from one type of filesystem onto an other type of
1677 filesystem on the same platform may lead to surprises. As extended attributes
1678 can contain any type of data they are stored as a series of so called
1679 value-pairs. This data must be seen as mostly binary and is stored as such.
1680 As security labels from selinux are also extended attributes this option also
1681 stores those labels and no specific code is enabled for handling selinux
1684 Currently the following platforms support extended attributes:
1686 \item {\bf Darwin/OSX}
1692 On Linux acls are also extended attributes, as such when you enable ACLs on a
1693 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1694 and not the same extended attribute.
1696 To enable the backup of extended attributes please add the following to your
1711 \subsection{Shared objects}
1712 \index[general]{Shared objects}
1713 A default build of \mbacula{} will now create the libraries as shared objects
1714 (.so) rather than static libraries as was previously the case.
1715 The shared libraries are built using {\bf libtool} so it should be quite
1718 An important advantage of using shared objects is that on a machine with the
1719 Directory, File daemon, the Storage daemon, and a console, you will have only
1720 one copy of the code in memory rather than four copies. Also the total size of
1721 the binary release is smaller since the library code appears only once rather
1722 than once for every program that uses it; this results in significant reduction
1723 in the size of the binaries particularly for the utility tools.
1725 In order for the system loader to find the shared objects when loading the
1726 \mbacula{} binaries, the \mbacula{} shared objects must either be in a shared object
1727 directory known to the loader (typically /usr/lib) or they must be in the
1728 directory that may be specified on the {\bf ./configure} line using the {\bf
1729 {-}{-}libdir} option as:
1732 ./configure --libdir=/full-path/dir
1735 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1736 no need to modify your loader configuration provided that
1737 the shared objects are installed in that directory (\mbacula{}
1738 does this with the make install command). The shared objects
1739 that \mbacula{} references are:
1748 These files are symbolically linked to the real shared object file,
1749 which has a version number to permit running multiple versions of
1750 the libraries if desired (not normally the case).
1752 If you have problems with libtool or you wish to use the old
1753 way of building static libraries, or you want to build a static
1754 version of \mbacula{} you may disable
1755 libtool on the configure command line with:
1758 ./configure --disable-libtool
1762 \subsection{Building Static versions of Bacula}
1763 \index[general]{Static linking}
1764 In order to build static versions of \mbacula{}, in addition
1765 to configuration options that were needed you now must
1766 also add --disable-libtool. Example
1769 ./configure --enable-static-client-only --disable-libtool
1773 \subsection{Virtual Backup (Vbackup)}
1774 \index[general]{Virtual Backup}
1775 \index[general]{Vbackup}
1777 \mbacula{}'s virtual backup feature is often called Synthetic Backup or
1778 Consolidation in other backup products. It permits you to consolidate the
1779 previous Full backup plus the most recent Differential backup and any
1780 subsequent Incremental backups into a new Full backup. This new Full
1781 backup will then be considered as the most recent Full for any future
1782 Incremental or Differential backups. The VirtualFull backup is
1783 accomplished without contacting the client by reading the previous backup
1784 data and writing it to a volume in a different pool.
1786 In some respects the Vbackup feature works similar to a Migration job, in
1787 that \mbacula{} normally reads the data from the pool specified in the
1788 Job resource, and writes it to the {\bf Next Pool} specified in the
1789 Job resource. Note, this means that usually the output from the Virtual
1790 Backup is written into a different pool from where your prior backups
1791 are saved. Doing it this way guarantees that you will not get a deadlock
1792 situation attempting to read and write to the same volume in the Storage
1793 daemon. If you then want to do subsequent backups, you may need to
1794 move the Virtual Full Volume back to your normal backup pool.
1795 Alternatively, you can set your {\bf Next Pool} to point to the current
1796 pool. This will cause \mbacula{} to read and write to Volumes in the
1797 current pool. In general, this will work, because \mbacula{} will
1798 not allow reading and writing on the same Volume. In any case, once
1799 a VirtualFull has been created, and a restore is done involving the
1800 most current Full, it will read the Volume or Volumes by the VirtualFull
1801 regardless of in which Pool the Volume is found.
1803 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1804 a level of {\bf VirtualFull}.
1806 A typical Job resource definition might look like the following:
1813 FileSet = "Full Set"
1820 # Default pool definition
1824 Recycle = yes # Automatically recycle Volumes
1825 AutoPrune = yes # Prune expired volumes
1826 Volume Retention = 365d # one year
1834 Recycle = yes # Automatically recycle Volumes
1835 AutoPrune = yes # Prune expired volumes
1836 Volume Retention = 365d # one year
1837 Storage = DiskChanger
1840 # Definition of file storage device
1845 Device = FileStorage
1847 Maximum Concurrent Jobs = 5
1850 # Definition of DDS Virtual tape disk storage device
1853 Address = localhost # N.B. Use a fully qualified name here
1855 Device = DiskChanger
1856 Media Type = DiskChangerMedia
1857 Maximum Concurrent Jobs = 4
1862 Then in bconsole or via a Run schedule, you would run the job as:
1865 run job=MyBackup level=Full
1866 run job=MyBackup level=Incremental
1867 run job=MyBackup level=Differential
1868 run job=MyBackup level=Incremental
1869 run job=MyBackup level=Incremental
1872 So providing there were changes between each of those jobs, you would end up
1873 with a Full backup, a Differential, which includes the first Incremental
1874 backup, then two Incremental backups. All the above jobs would be written to
1875 the {\bf Default} pool.
1877 To consolidate those backups into a new Full backup, you would run the
1881 run job=MyBackup level=VirtualFull
1884 And it would produce a new Full backup without using the client, and the output
1885 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1887 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1890 Note, the Start and End time of the Virtual Full backup is set to the
1891 values for the last job included in the Virtual Full (in the above example,
1892 it is an Increment). This is so that if another incremental is done, which
1893 will be based on the Virtual Full, it will backup all files from the
1894 last Job included in the Virtual Full rather than from the time the Virtual
1895 Full was actually run.
1899 \subsection{Catalog Format}
1900 \index[general]{Catalog format}
1901 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1902 operation will convert the FileId field of the File table from 32 bits (max 4
1903 billion table entries) to 64 bits (very large number of items). The
1904 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1905 your catalog during the conversion. Also you won't be able to run jobs during
1906 this conversion period. For example, a 3 million file catalog will take 2
1907 minutes to upgrade on a normal machine. Please don't forget to make a valid
1908 backup of your database before executing the upgrade script. See the
1909 ReleaseNotes for additional details.
1911 \subsection{64 bit Windows Client}
1912 \index[general]{Win64 client}
1913 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1914 their 64 bit OS versions is not compatible with a 32 bit \mbacula{} Client.
1915 As a consequence, we are also releasing a 64 bit version of the \mbacula{}
1916 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1917 These binaries should only be installed on 64 bit Windows operating systems.
1918 What is important is not your hardware but whether or not you have
1919 a 64 bit version of the Windows OS.
1921 Compared to the Win32 \mbacula{} Client, the 64 bit release contains a few differences:
1923 \item Before installing the Win64 \mbacula{} Client, you must totally
1924 deinstall any prior 2.4.x Client installation using the
1925 \mbacula{} deinstallation (see the menu item). You may want
1926 to save your .conf files first.
1927 \item Only the Client (File daemon) is ported to Win64, the Director
1928 and the Storage daemon are not in the 64 bit Windows installer.
1929 \item bwx-console is not yet ported.
1930 \item bconsole is ported but it has not been tested.
1931 \item The documentation is not included in the installer.
1932 \item Due to Vista security restrictions imposed on a default installation
1933 of Vista, before upgrading the Client, you must manually stop
1934 any prior version of \mbacula{} from running, otherwise the install
1936 \item Due to Vista security restrictions imposed on a default installation
1937 of Vista, attempting to edit the conf files via the menu items
1938 will fail. You must directly edit the files with appropriate
1939 permissions. Generally double clicking on the appropriate .conf
1940 file will work providing you have sufficient permissions.
1941 \item All \mbacula{} files are now installed in
1942 {\bf C:/Program Files/Bacula} except the main menu items,
1943 which are installed as before. This vastly simplifies the installation.
1944 \item If you are running on a foreign language version of Windows, most
1945 likely {\bf C:/Program Files} does not exist, so you should use the
1946 Custom installation and enter an appropriate location to install
1948 \item The 3.0.0 Win32 Client continues to install files in the locations used
1949 by prior versions. For the next version we will convert it to use
1950 the same installation conventions as the Win64 version.
1953 This project was funded by Bacula Systems.
1956 \subsection{Duplicate Job Control}
1957 \index[general]{Duplicate jobs}
1958 The new version of \mbacula{} provides four new directives that
1959 give additional control over what \mbacula{} does if duplicate jobs
1960 are started. A duplicate job in the sense we use it here means
1961 a second or subsequent job with the same name starts. This
1962 happens most frequently when the first job runs longer than expected because no
1963 tapes are available.
1965 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1966 are specified in the Job resource.
1970 \subsubsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1971 \index[general]{Allow Duplicate Jobs}
1972 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1973 the directive is set to {\bf no} (default) then only one job of a given name
1974 may run at one time, and the action that \mbacula{} takes to ensure only
1975 one job runs is determined by the other directives (see below).
1977 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1978 are present and none of the three directives given below permit
1979 Canceling a job, then the current job (the second one started)
1982 \subsubsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1983 \index[general]{Allow Higher Duplicates}
1984 This directive was in version 5.0.0, but does not work as
1985 expected. If used, it should always be set to no. In later versions
1986 of \mbacula{} the directive is disabled (disregarded).
1988 \subsubsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1989 \index[general]{Cancel Running Duplicates}
1990 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1991 if this directive is set to {\bf yes} any job that is already running
1992 will be canceled. The default is {\bf no}.
1994 \subsubsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1995 \index[general]{Cancel Queued Duplicates}
1996 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1997 if this directive is set to {\bf yes} any job that is
1998 already queued to run but not yet running will be canceled.
1999 The default is {\bf no}.
2002 \subsection{TLS Authentication}
2003 \index[general]{TLS authentication}
2004 In Bacula version 2.5.x and later, in addition to the normal \mbacula{}
2005 CRAM-MD5 authentication that is used to authenticate each \mbacula{}
2006 connection, you can specify that you want TLS Authentication as well,
2007 which will provide more secure authentication.
2009 This new feature uses \mbacula{}'s existing TLS code (normally used for
2010 communications encryption) to do authentication. To use it, you must
2011 specify all the TLS directives normally used to enable communications
2012 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, \ldots{}) and
2015 \subsubsection{TLS Authenticate = yes}
2017 TLS Authenticate = yes
2020 in the main daemon configuration resource (Director for the Director,
2021 Client for the File daemon, and Storage for the Storage daemon).
2023 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
2024 authentication, \mbacula{} will also do TLS authentication, then TLS
2025 encryption will be turned off, and the rest of the communication between
2026 the two \mbacula{} daemons will be done without encryption.
2028 If you want to encrypt communications data, use the normal TLS directives
2029 but do not turn on {\bf TLS Authenticate}.
2031 \subsection{bextract non-portable Win32 data}
2032 \index[general]{bextract handles Win32 non-portable data}
2033 \index[general]{Win32!bextract handles non-portable data}
2034 {\bf bextract} has been enhanced to be able to restore
2035 non-portable Win32 data to any OS. Previous versions were
2036 unable to restore non-portable Win32 data to machines that
2037 did not have the Win32 BackupRead and BackupWrite API calls.
2039 \subsection{State File updated at Job Termination}
2040 \index[general]{State file}
2041 In previous versions of \mbacula{}, the state file, which provides a
2042 summary of previous jobs run in the {\bf status} command output was
2043 updated only when \mbacula{} terminated, thus if the daemon crashed, the
2044 state file might not contain all the run data. This version of
2045 the \mbacula{} daemons updates the state file on each job termination.
2047 \subsection{MaxFullInterval = \lt{}time-interval\gt{}}
2048 \index[general]{MaxFullInterval}
2049 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
2050 can be used to specify the maximum time interval between {\bf Full} backup
2051 jobs. When a job starts, if the time since the last Full backup is
2052 greater than the specified interval, and the job would normally be an
2053 {\bf Incremental} or {\bf Differential}, it will be automatically
2054 upgraded to a {\bf Full} backup.
2056 \subsection{MaxDiffInterval = \lt{}time-interval\gt{}}
2057 \index[general]{MaxDiffInterval}
2058 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
2059 can be used to specify the maximum time interval between {\bf Differential} backup
2060 jobs. When a job starts, if the time since the last Differential backup is
2061 greater than the specified interval, and the job would normally be an
2062 {\bf Incremental}, it will be automatically
2063 upgraded to a {\bf Differential} backup.
2065 \subsection{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
2066 \index[general]{MaxDiffInterval}
2067 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
2068 by the user, and when it is set it is an indication to backup programs
2069 to not backup that particular file. This version of \mbacula{} contains a
2070 new Options directive within a FileSet resource, which instructs \mbacula{} to
2071 obey this flag. The new directive is:
2074 Honor No Dump Flag = yes\vb{}no
2077 The default value is {\bf no}.
2080 \subsection{Exclude Dir Containing = \lt{}filename-string\gt{}}
2081 \index[general]{IgnoreDir}
2082 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
2083 can be added to the Include section of the FileSet resource. If the specified
2084 filename ({\bf filename-string}) is found on the Client in any directory to be
2085 backed up, the whole directory will be ignored (not backed up). For example:
2088 # List of files to be backed up
2096 Exclude Dir Containing = .excludeme
2101 But in /home, there may be hundreds of directories of users and some
2102 people want to indicate that they don't want to have certain
2103 directories backed up. For example, with the above FileSet, if
2104 the user or sysadmin creates a file named {\bf .excludeme} in
2105 specific directories, such as
2108 /home/user/www/cache/.excludeme
2109 /home/user/temp/.excludeme
2112 then \mbacula{} will not backup the two directories named:
2115 /home/user/www/cache
2119 NOTE: subdirectories will not be backed up. That is, the directive
2120 applies to the two directories in question and any children (be they
2121 files, directories, etc).
2124 \subsection{Bacula Plugins}
2125 \index[general]{Plugin}
2126 Support for shared object plugins has been implemented in the Linux, Unix
2127 and Win32 File daemons. The API will be documented separately in
2128 the Developer's Guide or in a new document. For the moment, there is
2129 a single plugin named {\bf bpipe} that allows an external program to
2130 get control to backup and restore a file.
2132 Plugins are also planned (partially implemented) in the Director and the
2135 \subsubsection{Plugin Directory}
2136 \index[general]{Plugin Directory}
2137 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2138 be added to the daemon definition resource. The directory takes a quoted
2139 string argument, which is the name of the directory in which the daemon can
2140 find the \mbacula{} plugins. If this directive is not specified, \mbacula{} will not
2141 load any plugins. Since each plugin has a distinctive name, all the daemons
2142 can share the same plugin directory.
2144 \subsubsection{Plugin Options}
2145 \index[general]{Plugin Options}
2146 The {\bf Plugin Options} directive takes a quoted string
2147 argument (after the equal sign) and may be specified in the
2148 Job resource. The options specified will be passed to all plugins
2149 when they are run. This each plugin must know what it is looking
2150 for. The value defined in the Job resource can be modified
2151 by the user when he runs a Job via the {\bf bconsole} command line
2154 Note: this directive may be specified, and there is code to modify
2155 the string in the run command, but the plugin options are not yet passed to
2156 the plugin (i.e. not fully implemented).
2158 \subsubsection{Plugin Options ACL}
2159 \index[general]{Plugin Options ACL}
2160 The {\bf Plugin Options ACL} directive may be specified in the
2161 Director's Console resource. It functions as all the other ACL commands
2162 do by permitting users running restricted consoles to specify a
2163 {\bf Plugin Options} that overrides the one specified in the Job
2164 definition. Without this directive restricted consoles may not modify
2167 \subsubsection{Plugin = \lt{}plugin-command-string\gt{}}
2168 \index[general]{Plugin}
2169 The {\bf Plugin} directive is specified in the Include section of
2170 a FileSet resource where you put your {\bf File = xxx} directives.
2181 Plugin = "bpipe:..."
2186 In the above example, when the File daemon is processing the directives
2187 in the Include section, it will first backup all the files in {\bf /home}
2188 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2189 the Plugin Directory. The syntax and semantics of the Plugin directive
2190 require the first part of the string up to the colon (:) to be the name
2191 of the plugin. Everything after the first colon is ignored by the File daemon but
2192 is passed to the plugin. Thus the plugin writer may define the meaning of the
2193 rest of the string as he wishes.
2195 Please see the next section for information about the {\bf bpipe} \mbacula{}
2198 \subsection{The bpipe Plugin}
2199 \index[general]{The bpipe plugin}
2200 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2201 the \mbacula{} source distribution. When the plugin is compiled and linking into
2202 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2203 Please note that this is a very simple plugin that was written for
2204 demonstration and test purposes. It is and can be used in production, but
2205 that was never really intended.
2207 The purpose of the plugin is to provide an interface to any system program for
2208 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2209 the Include section of your Job's FileSet resource. The full syntax of the
2210 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2211 to specify the sytax as it wishes) is:
2214 Plugin = "<field1>:<field2>:<field3>:<field4>"
2219 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2220 stripped off, so in this case, we would put {\bf bpipe} in this field.
2222 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2223 pseudo path and filename under which the backup will be saved. This pseudo
2224 path and filename will be seen by the user in the restore file tree.
2225 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2226 backed up by the plugin will be put under that "pseudo" path and filename.
2227 You must be careful to choose a naming convention that is unique to avoid
2228 a conflict with a path and filename that actually exists on your system.
2230 \item {\bf field3} for the {\bf bpipe} plugin
2231 specifies the "reader" program that is called by the plugin during
2232 backup to read the data. {\bf bpipe} will call this program by doing a
2235 \item {\bf field4} for the {\bf bpipe} plugin
2236 specifies the "writer" program that is called by the plugin during
2237 restore to write the data back to the filesystem.
2240 Please note that for two items above describing the "reader" and "writer"
2241 fields, these programs are "executed" by \mbacula{}, which
2242 means there is no shell interpretation of any command line arguments
2243 you might use. If you want to use shell characters (redirection of input
2244 or output, \ldots{}), then we recommend that you put your command or commands
2245 in a shell script and execute the script. In addition if you backup a
2246 file with the reader program, when running the writer program during
2247 the restore, \mbacula{} will not automatically create the path to the file.
2248 Either the path must exist, or you must explicitly do so with your command
2249 or in a shell script.
2251 Putting it all together, the full plugin directive line might look
2255 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2256 --opt --databases bacula:mysql"
2259 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2260 would be written on a single line.
2262 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2263 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2264 program {\bf mysqldump -f --opt --database bacula} to read the data during
2265 backup. The mysqldump command outputs all the data for the database named
2266 {\bf bacula}, which will be read by the plugin and stored in the backup.
2267 During restore, the data that was backed up will be sent to the program
2268 specified in the last field, which in this case is {\bf mysql}. When
2269 {\bf mysql} is called, it will read the data sent to it by the plugn
2270 then write it back to the same database from which it came ({\bf bacula}
2273 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2274 the data from a specified program to \mbacula{} for backup, and then from \mbacula{} to
2275 a specified program for restore.
2277 By using different command lines to {\bf bpipe},
2278 you can backup any kind of data (ASCII or binary) depending
2279 on the program called.
2281 \subsection{Microsoft Exchange Server 2003/2007 Plugin}
2282 \index[general]{Microsoft Exchange Server 2003/2007 plugin}
2283 \subsubsection{Background}
2284 The Exchange plugin was made possible by a funded development project
2285 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2286 The code for the plugin was written by James Harper, and the \mbacula{} core
2287 code by Kern Sibbald. All the code for this funded development has become
2288 part of the \mbacula{} project. Thanks to everyone who made it happen.
2290 \subsubsection{Concepts}
2291 Although it is possible to backup Exchange using \mbacula{} VSS the Exchange
2292 plugin adds a good deal of functionality, because while \mbacula{} VSS
2293 completes a full backup (snapshot) of Exchange, it does
2294 not support Incremental or Differential backups, restoring is more
2295 complicated, and a single database restore is not possible.
2297 Microsoft Exchange organises its storage into Storage Groups with
2298 Databases inside them. A default installation of Exchange will have a
2299 single Storage Group called 'First Storage Group', with two Databases
2300 inside it, "Mailbox Store (SERVER NAME)" and
2301 "Public Folder Store (SERVER NAME)",
2302 which hold user email and public folders respectively.
2304 In the default configuration, Exchange logs everything that happens to
2305 log files, such that if you have a backup, and all the log files since,
2306 you can restore to the present time. Each Storage Group has its own set
2307 of log files and operates independently of any other Storage Groups. At
2308 the Storage Group level, the logging can be turned off by enabling a
2309 function called "Enable circular logging". At this time the Exchange
2310 plugin will not function if this option is enabled.
2312 The plugin allows backing up of entire storage groups, and the restoring
2313 of entire storage groups or individual databases. Backing up and
2314 restoring at the individual mailbox or email item is not supported but
2315 can be simulated by use of the "Recovery" Storage Group (see below).
2317 \subsubsection{Installing}
2318 The Exchange plugin requires a DLL that is shipped with Microsoft
2319 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2320 correctly the Exchange plugin should find this automatically and run
2321 without any additional installation.
2323 If the DLL can not be found automatically it will need to be copied into
2324 the \mbacula{} installation
2325 directory (eg C:\lstinline+\+Program Files\lstinline+\+Bacula\lstinline+\+bin). The Exchange API DLL is
2326 named esebcli2.dll and is found in C:\lstinline+\+Program Files\lstinline+\+Exchsrvr\lstinline+\+bin on a
2327 default Exchange installation.
2329 \subsubsection{Backing Up}
2330 To back up an Exchange server the Fileset definition must contain at
2331 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2332 the backup to work correctly. The 'exchange:' bit tells \mbacula{} to look
2333 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2334 up files are prefixed with something that isn't going to share a name
2335 with something outside the plugin, and the 'Microsoft Information Store'
2336 bit is required also. It is also possible to add the name of a storage
2337 group to the "Plugin =" line, eg \\
2338 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2339 if you want only a single storage group backed up.
2341 Additionally, you can suffix the 'Plugin =' directive with
2342 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2343 database at the end of a full backup.
2345 An Incremental or Differential backup will backup only the database logs
2346 for each Storage Group by inspecting the "modified date" on each
2347 physical log file. Because of the way the Exchange API works, the last
2348 logfile backed up on each backup will always be backed up by the next
2349 Incremental or Differential backup too. This adds 5MB to each
2350 Incremental or Differential backup size but otherwise does not cause any
2353 By default, a normal VSS fileset containing all the drive letters will
2354 also back up the Exchange databases using VSS. This will interfere with
2355 the plugin and Exchange's shared ideas of when the last full backup was
2356 done, and may also truncate log files incorrectly. It is important,
2357 therefore, that the Exchange database files be excluded from the backup,
2358 although the folders the files are in should be included, or they will
2359 have to be recreated manually if a bare metal restore is done.
2364 File = C:/Program Files/Exchsrvr/mdbdata
2365 Plugin = "exchange:..."
2368 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2369 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2370 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2371 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2372 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2373 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2374 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2379 The advantage of excluding the above files is that you can significantly
2380 reduce the size of your backup since all the important Exchange files
2381 will be properly saved by the Plugin.
2384 \subsubsection{Restoring}
2385 The restore operation is much the same as a normal \mbacula{} restore, with
2386 the following provisos:
2389 \item The {\bf Where} restore option must not be specified
2390 \item Each Database directory must be marked as a whole. You cannot just
2391 select (say) the .edb file and not the others.
2392 \item If a Storage Group is restored, the directory of the Storage Group
2394 \item It is possible to restore only a subset of the available log files,
2395 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2396 if a log file is missing from the sequence of log files
2397 \item Each database to be restored must be dismounted and marked as "Can be
2398 overwritten by restore"
2399 \item If an entire Storage Group is to be restored (eg all databases and
2400 logs in the Storage Group), then it is best to manually delete the
2401 database files from the server (eg C:\lstinline+\+Program Files\lstinline+\+Exchsrvr\lstinline+\+mdbdata\lstinline+\+*)
2402 as Exchange can get confused by stray log files lying around.
2405 \subsubsection{Restoring to the Recovery Storage Group}
2406 The concept of the Recovery Storage Group is well documented by
2408 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2409 but to briefly summarize\ldots{}
2411 Microsoft Exchange allows the creation of an additional Storage Group
2412 called the Recovery Storage Group, which is used to restore an older
2413 copy of a database (e.g. before a mailbox was deleted) into without
2414 messing with the current live data. This is required as the Standard and
2415 Small Business Server versions of Exchange can not ordinarily have more
2416 than one Storage Group.
2418 To create the Recovery Storage Group, drill down to the Server in Exchange
2419 System Manager, right click, and select
2420 {\bf "New -> Recovery Storage Group\ldots{}"}. Accept or change the file
2421 locations and click OK. On the Recovery Storage Group, right click and
2422 select {\bf "Add Database to Recover\ldots{}"} and select the database you will
2425 Restore only the single database nominated as the database in the
2426 Recovery Storage Group. Exchange will redirect the restore to the
2427 Recovery Storage Group automatically.
2428 Then run the restore.
2430 \subsubsection{Restoring on Microsoft Server 2007}
2431 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2432 2007, and hence you use a new procedure for recovering a single mail box.
2433 This procedure is documented by Microsoft at:
2434 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2435 and involves using the {\bf Restore-Mailbox} and {\bf
2436 Get-Mailbox Statistics} shell commands.
2438 \subsubsection{Caveats}
2439 This plugin is still being developed, so you should consider it
2440 currently in BETA test, and thus use in a production environment
2441 should be done only after very careful testing.
2443 When doing a full backup, the Exchange database logs are truncated by
2444 Exchange as soon as the plugin has completed the backup. If the data
2445 never makes it to the backup medium (eg because of spooling) then the
2446 logs will still be truncated, but they will also not have been backed
2447 up. A solution to this is being worked on. You will have to schedule a
2448 new Full backup to ensure that your next backups will be usable.
2450 The "Enable Circular Logging" option cannot be enabled or the plugin
2453 Exchange insists that a successful Full backup must have taken place if
2454 an Incremental or Differential backup is desired, and the plugin will
2455 fail if this is not the case. If a restore is done, Exchange will
2456 require that a Full backup be done before an Incremental or Differential
2459 The plugin will most likely not work well if another backup application
2460 (eg NTBACKUP) is backing up the Exchange database, especially if the
2461 other backup application is truncating the log files.
2463 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2464 we recommend either carefully testing or that you avoid this option for
2467 The Exchange plugin is not called during processing the bconsole {\bf
2468 estimate} command, and so anything that would be backed up by the plugin
2469 will not be added to the estimate total that is displayed.
2472 \subsection{libdbi Framework}
2473 \index[general]{libdbi framework}
2474 As a general guideline, \mbacula{} has support for a few catalog database drivers
2475 (MySQL, PostgreSQL, SQLite)
2476 coded natively by the Bacula team. With the libdbi implementation, which is a
2477 \mbacula{} driver that uses libdbi to access the catalog, we have an open field to
2478 use many different kinds database engines following the needs of users.
2480 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2481 implements a database-independent abstraction layer in C, similar to the
2482 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2483 leverage the power of multiple databases and multiple simultaneous database
2484 connections by using this framework.
2486 Currently the libdbi driver in Bacula project only supports the same drivers
2487 natively coded in \mbacula{}. However the libdbi project has support for many
2488 others database engines. You can view the list at
2489 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2490 supported by Bacula, however, they must be tested properly by the Bacula team.
2492 Some of benefits of using libdbi are:
2494 \item The possibility to use proprietary databases engines in which your
2495 proprietary licenses prevent the Bacula team from developing the driver.
2496 \item The possibility to use the drivers written for the libdbi project.
2497 \item The possibility to use other database engines without recompiling \mbacula{}
2498 to use them. Just change one line in bacula-dir.conf
2499 \item Abstract Database access, this is, unique point to code and profiling
2500 catalog database access.
2503 The following drivers have been tested:
2505 \item PostgreSQL, with and without batch insert
2506 \item Mysql, with and without batch insert
2511 In the future, we will test and approve to use others databases engines
2512 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2514 To compile Bacula to support libdbi we need to configure the code with the
2515 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2516 [database] is the database engine to be used with Bacula (of course we can
2517 change the driver in file bacula-dir.conf, see below). We must configure the
2518 access port of the database engine with the option --with-db-port, because the
2519 libdbi framework doesn't know the default access port of each database.
2521 The next phase is checking (or configuring) the bacula-dir.conf, example:
2525 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2526 dbname = regress; user = regress; password = ""
2530 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2531 mysql database. Currently the drivers supported by \mbacula{} are: postgresql,
2532 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2534 The following limitations apply when \mbacula{} is set to use the libdbi framework:
2535 - Not tested on the Win32 platform
2536 - A little performance is lost if comparing with native database driver.
2537 The reason is bound with the database driver provided by libdbi and the
2538 simple fact that one more layer of code was added.
2540 It is important to remember, when compiling \mbacula{} with libdbi, the
2541 following packages are needed:
2543 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2544 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2547 You can download them and compile them on your system or install the packages
2548 from your OS distribution.
2550 \subsection{Console Command Additions and Enhancements}
2551 \index[general]{Console additions}
2553 \subsubsection{Display Autochanger Content}
2554 \index[general]{StatusSlots}
2556 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2557 autochanger content.
2561 Slot | Volume Name | Status | Media Type | Pool |
2562 ------+---------------+----------+-------------------+------------|
2563 1 | 00001 | Append | DiskChangerMedia | Default |
2564 2 | 00002 | Append | DiskChangerMedia | Default |
2565 3*| 00003 | Append | DiskChangerMedia | Scratch |
2570 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2571 {\bf update slots} command to synchronize autochanger content with your
2574 \subsubsection{list joblog job=xxx or jobid=nnn}
2575 \index[general]{list joblog}
2576 A new list command has been added that allows you to list the contents
2577 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2578 or for a particular JobId. The {\bf llist} command will include a line with
2579 the time and date of the entry.
2581 Note for the catalog to have Job Log entries, you must have a directive
2588 In your Director's {\bf Messages} resource.
2590 \subsubsection{Use separator for multiple commands}
2591 \index[general]{Command separator}
2592 When using bconsole with readline, you can set the command separator with
2593 \textbf{@separator} command to one
2594 of those characters to write commands who require multiple input in one line.
2596 !$%&'()*+,-/:;<>?[]^`{|}~
2599 \subsubsection{Deleting Volumes}
2600 The delete volume bconsole command has been modified to
2601 require an asterisk (*) in front of a MediaId otherwise the
2602 value you enter is a taken to be a Volume name. This is so that
2603 users may delete numeric Volume names. The previous Bacula versions
2604 assumed that all input that started with a number was a MediaId.
2606 This new behavior is indicated in the prompt if you read it
2609 \subsection{Bare Metal Recovery}
2610 The old bare metal recovery project is essentially dead. One
2611 of the main features of it was that it would build a recovery
2612 CD based on the kernel on your system. The problem was that
2613 every distribution has a different boot procedure and different
2614 scripts, and worse yet, the boot procedures and scripts change
2615 from one distribution to another. This meant that maintaining
2616 (keeping up with the changes) the rescue CD was too much work.
2618 To replace it, a new bare metal recovery USB boot stick has been developed
2619 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2620 boot from a USB key.
2624 \item Recovery can be done from within graphical environment.
2625 \item Recovery can be done in a shell.
2626 \item Ubuntu boots on a large number of Linux systems.
2627 \item The process of updating the system and adding new
2628 packages is not too difficult.
2629 \item The USB key can easily be upgraded to newer Ubuntu versions.
2630 \item The USB key has writable partitions for modifications to
2631 the OS and for modification to your home directory.
2632 \item You can add new files/directories to the USB key very easily.
2633 \item You can save the environment from multiple machines on
2635 \item Bacula Systems is funding its ongoing development.
2638 The disadvantages are:
2640 \item The USB key is usable but currently under development.
2641 \item Not everyone may be familiar with Ubuntu (no worse
2643 \item Some older OSes cannot be booted from USB. This can
2644 be resolved by first booting a Ubuntu LiveCD then plugging
2646 \item Currently the documentation is sketchy and not yet added
2647 to the main manual. See below \ldots{}
2650 The documentation and the code can be found in the {\bf rescue} package
2651 in the directory {\bf linux/usb}.
2653 \subsection{Miscellaneous}
2654 \index[general]{Misc new features}
2656 \subsubsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2657 \index[general]{Allow Mixed Priority}
2658 This directive is only implemented in version 2.5 and later. When
2659 set to {\bf yes} (default {\bf no}), this job may run even if lower
2660 priority jobs are already running. This means a high priority job
2661 will not have to wait for other jobs to finish before starting.
2662 The scheduler will only mix priorities when all running jobs have
2665 Note that only higher priority jobs will start early. Suppose the
2666 director will allow two concurrent jobs, and that two jobs with
2667 priority 10 are running, with two more in the queue. If a job with
2668 priority 5 is added to the queue, it will be run as soon as one of
2669 the running jobs finishes. However, new priority 10 jobs will not
2670 be run until the priority 5 job has finished.
2672 \subsubsection{Bootstrap File Directive -- FileRegex}
2673 \index[general]{Bootstrap File directive}
2674 {\bf FileRegex} is a new command that can be added to the bootstrap
2675 (.bsr) file. The value is a regular expression. When specified, only
2676 matching filenames will be restored.
2678 During a restore, if all File records are pruned from the catalog
2679 for a Job, normally \mbacula{} can restore only all files saved. That
2680 is there is no way using the catalog to select individual files.
2681 With this new feature, \mbacula{} will ask if you want to specify a Regex
2682 expression for extracting only a part of the full backup.
2685 Building directory tree for JobId(s) 1,3 ...
2686 There were no files inserted into the tree, so file selection
2687 is not possible.Most likely your retention policy pruned the files
2689 Do you want to restore all the files? (yes\vb{}no): no
2691 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2692 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2695 \subsubsection{Bootstrap File Optimization Changes}
2696 In order to permit proper seeking on disk files, we have extended the bootstrap
2697 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2698 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2699 address range and end address range respectively. These two directives replace
2700 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2701 VolEndBlock} directives. Bootstrap files containing the old directives will
2702 still work, but will not properly take advantage of proper disk seeking, and
2703 may read completely to the end of a disk volume during a restore. With the new
2704 format (automatically generated by the new Director), restores will seek
2705 properly and stop reading the volume when all the files have been restored.
2707 \subsubsection{Solaris ZFS/NFSv4 ACLs}
2708 This is an upgrade of the previous Solaris ACL backup code
2709 to the new library format, which will backup both the old
2710 POSIX(UFS) ACLs as well as the ZFS ACLs.
2712 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2713 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2714 be used to transfer from UFS to ZFS filesystems.
2717 \subsubsection{Virtual Tape Emulation}
2718 \index[general]{Virtual tape emulation}
2719 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2720 the tape code but actually reading and writing to a disk file. Used with the
2721 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2722 and 700 slots. This feature is most useful in testing. It is enabled
2723 by using {\bf Device Type = vtape} in the Storage daemon's Device
2724 directive. This feature is only implemented on Linux machines and should not be
2725 used for production.
2727 \subsubsection{Bat Enhancements}
2728 \index[general]{Bat enhancements}
2729 Bat (the Bacula Administration Tool) GUI program has been significantly
2730 enhanced and stabilized. In particular, there are new table based status
2731 commands; it can now be easily localized using Qt4 Linguist.
2733 The Bat communications protocol has been significantly enhanced to improve
2734 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2735 the Director you are using otherwise the communications protocol will not
2738 \subsubsection{RunScript Enhancements}
2739 \index[general]{RunScript enhancements}
2740 The {\bf RunScript} resource has been enhanced to permit multiple
2741 commands per RunScript. Simply specify multiple {\bf Command} directives
2748 Command = "/bin/echo test"
2749 Command = "/bin/echo an other test"
2750 Command = "/bin/echo 3 commands in the same runscript"
2757 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2758 implemented, which runs the command after the Volume Shadow Copy has been made.
2760 Console commands can be specified within a RunScript by using:
2761 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2762 carefully tested and debugged and is known to easily crash the Director.
2763 We would appreciate feedback. Due to the recursive nature of this command, we
2764 may remove it before the final release.
2766 \subsubsection{Status Enhancements}
2767 \index[general]{Status enhancements}
2768 The bconsole {\bf status dir} output has been enhanced to indicate
2769 Storage daemon job spooling and despooling activity.
2771 \subsubsection{Connect Timeout}
2772 \index[general]{Connect Timeout}
2773 The default connect timeout to the File
2774 daemon has been set to 3 minutes. Previously it was 30 minutes.
2776 \subsubsection{ftruncate for NFS Volumes}
2777 \index[general]{ftruncate for NFS volumes}
2778 If you write to a Volume mounted by NFS (say on a local file server),
2779 in previous Bacula versions, when the Volume was recycled, it was not
2780 properly truncated because NFS does not implement ftruncate (file
2781 truncate). This is now corrected in the new version because we have
2782 written code (actually a kind user) that deletes and recreates the Volume,
2783 thus accomplishing the same thing as a truncate.
2785 \subsubsection{Support for Ubuntu}
2786 The new version of \mbacula{} now recognizes the Ubuntu (and Kubuntu)
2787 version of Linux, and thus now provides correct autostart routines.
2788 Since Ubuntu officially supports \mbacula{}, you can also obtain any
2789 recent release of Bacula from the Ubuntu repositories.
2791 \subsubsection{Recycle Pool = \lt{}pool-name\gt{}}
2792 \index[general]{Recycle Pool}
2793 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2794 be placed (moved) when it is recycled. Without this directive, a Volume will
2795 remain in the same pool when it is recycled. With this directive, it can be
2796 moved automatically to any existing pool during a recycle. This directive is
2797 probably most useful when defined in the Scratch pool, so that volumes will
2798 be recycled back into the Scratch pool.
2800 \subsubsection{FD Version}
2801 \index[general]{FD version}
2802 The File daemon to Director protocol now includes a version
2803 number, which although there is no visible change for users,
2804 will help us in future versions automatically determine
2805 if a File daemon is not compatible.
2807 \subsubsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2808 \index[general]{Max Run Sched Time}
2809 The time specifies the maximum allowed time that a job may run, counted from
2810 when the job was scheduled. This can be useful to prevent jobs from running
2811 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2814 \subsubsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2815 \index[general]{Max Wait Time}
2816 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2817 of checking the maximum allowed time that a job may block for a resource,
2818 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2819 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2820 their job depending on the level. Now, they have to use
2821 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2822 directives are now deprecated.
2824 \subsubsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2825 \index[general]{Incremental Max Wait Time}
2826 \index[general]{Differential Max Wait Time}
2828 These directives have been deprecated in favor of
2829 \texttt{Incremental|Differential Max Run Time}.
2831 \subsubsection{Max Run Time directives}
2832 \index[general]{Max Run Time directives}
2833 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2834 maximum allowed time that a job can run depending on the level.
2836 %\addcontentsline{lof}{figure}{Job time control directives}
2837 %\includegraphics{\idir different_time}
2838 \bsysimageH{different_time}{Job time control directives}{figcom:different_time}
2840 \subsubsection{Statistics Enhancements}
2841 \index[general]{Statistics enhancements}
2842 If you (or probably your boss) want to have statistics on your backups to
2843 provide some \textit{Service Level Agreement} indicators, you could use a few
2844 SQL queries on the Job table to report how many:
2848 \item jobs have been successful
2849 \item files have been backed up
2853 However, these statistics are accurate only if your job retention is greater
2854 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2855 be able to use them.
2857 Now, you can use the \textbf{update stats [days=num]} console command to fill
2858 the JobHistory table with new Job records. If you want to be sure to take in
2859 account only \textbf{good jobs}, ie if one of your important job has failed but
2860 you have fixed the problem and restarted it on time, you probably want to
2861 delete the first \textit{bad} job record and keep only the successful one. For
2862 that simply let your staff do the job, and update JobHistory table after two or
2863 three days depending on your organization using the \textbf{[days=num]} option.
2865 These statistics records aren't used for restoring, but mainly for
2866 capacity planning, billings, etc.
2868 The Bweb interface provides a statistics module that can use this feature. You
2869 can also use tools like Talend or extract information by yourself.
2871 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2872 the length of time that \mbacula{} will keep statistics job records in the Catalog
2873 database after the Job End time. (In \texttt{JobHistory} table) When this time
2874 period expires, and if user runs \texttt{prune stats} command, \mbacula{} will
2875 prune (remove) Job records that are older than the specified period.
2877 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2878 job to maintain statistics.
2881 Name = BackupCatalog
2884 Console = "update stats days=3"
2885 Console = "prune stats yes"
2892 \subsubsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2893 \index[general]{ScratchPool}
2894 This directive permits to specify a specific \textsl{Scratch} pool for the
2895 current pool. This is useful when using multiple storage sharing the same
2896 mediatype or when you want to dedicate volumes to a particular set of pool.
2898 \subsubsection{Enhanced Attribute Despooling}
2899 \index[general]{Attribute Despooling}
2900 If the storage daemon and the Director are on the same machine, the spool file
2901 that contains attributes is read directly by the Director instead of being
2902 transmitted across the network. That should reduce load and speedup insertion.
2904 \subsubsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2905 \index[general]{SpoolSize}
2906 A new Job directive permits to specify the spool size per job. This is used
2907 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2909 \subsubsection{MaximumConsoleConnections = \lt{}number\gt{}}
2910 \index[general]{MaximumConsoleConnections}
2911 A new director directive permits to specify the maximum number of Console
2912 Connections that could run concurrently. The default is set to 20, but you may
2913 set it to a larger number.
2915 \subsubsection{VerId = \lt{}string\gt{}}
2916 \index[general]{VerId}
2917 A new director directive permits to specify a personnal identifier that will be
2918 displayed in the \texttt{version} command.
2920 \subsubsection{dbcheck enhancements}
2921 \index[general]{dbcheck enhancements}
2922 If you are using Mysql, dbcheck will now ask you if you want to create
2923 temporary indexes to speed up orphaned Path and Filename elimination.
2925 A new \texttt{-B} option allows you to print catalog information in a simple
2926 text based format. This is useful to backup it in a secure way.
2941 You can now specify the database connection port in the command line.
2943 \subsubsection{{-}{-}docdir configure option}
2944 \index[general]{{-}{-}docdir configure option}
2945 You can use {-}{-}docdir= on the ./configure command to
2946 specify the directory where you want \mbacula{} to install the
2947 LICENSE, ReleaseNotes, ChangeLog, \ldots{} files. The default is
2948 {\bf /usr/share/doc/bacula}.
2950 \subsubsection{{-}{-}htmldir configure option}
2951 \index[general]{{-}{-}htmldir configure option}
2952 You can use {-}{-}htmldir= on the ./configure command to
2953 specify the directory where you want \mbacula{} to install the bat html help
2954 files. The default is {\bf /usr/share/doc/bacula/html}
2956 \subsubsection{{-}{-}with-plugindir configure option}
2957 \index[general]{{-}{-}plugindir configure option}
2958 You can use {-}{-}plugindir= on the ./configure command to
2959 specify the directory where you want \mbacula{} to install
2960 the plugins (currently only bpipe-fd). The default is