1 \chapter{New Features in 5.2.x}
2 This chapter presents the new features that have been added to the next
3 Community version of Bacula that is not yet released.
5 \chapter{New Features in 5.2.2}
6 This chapter presents the new features that have been added to the current
7 Community version of Bacula that is now released.
9 \section{Additions to RunScript variables}
10 You can have access to Director name using \%D in your runscript
14 RunAfterJob = "/bin/echo Director=%D
17 \chapter{New Features in 5.2.1}
18 This chapter presents the new features were added in the
19 Community release version 5.2.1.
21 There are additional features (plugins) available in the Enterprise version
22 that are described in another chapter. A subscription to Bacula Systems
23 is required for the Enterprise version.
25 \section{LZO Compression}
27 LZO compression was added in the Unix File Daemon. From the user point of view,
28 it works like the GZIP compression (just replace {\bf compression=GZIP} with
29 {\bf compression=LZO}).
34 Options { compression=LZO }
40 LZO provides much faster compression and decompression speed but lower
41 compression ratio than GZIP. It is a good option when you backup to disk. For
42 tape, the built-in compression may be a better option.
44 LZO is a good altenative for GZIP1 when you don't want to slow down your
45 backup. On a modern CPU it should be able to run almost as fast as:
48 \item your client can read data from disk. Unless you have very fast disks like
49 SSD or large/fast RAID array.
50 \item the data transfers between the file daemon and the storage daemon even on
54 Note that bacula only use one compression level LZO1X-1.
57 The code for this feature was contributed by Laurent Papier.
59 \section{New Tray Monitor}
61 Since the old integrated Windows tray monitor doesn't work with
62 recent Windows versions, we have written a new Qt Tray Monitor that is available
63 for both Linux and Windows. In addition to all the previous features,
64 this new version allows you to run Backups from
65 the tray monitor menu.
69 \includegraphics[width=10cm]{\idir tray-monitor}
70 \label{fig:traymonitor}
71 \caption{New tray monitor}
76 \includegraphics[width=10cm]{\idir tray-monitor1}
77 \label{fig:traymonitor1}
78 \caption{Run a Job through the new tray monitor}
82 To be able to run a job from the tray monitor, you need to
83 allow specific commands in the Director monitor console:
88 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
89 ClientACL = *all* # you can restrict to a specific host
101 This project was funded by Bacula Systems and is available with Bacula
102 the Enterprise Edition and the Community Edition.
104 \section{Purge Migration Job}
106 The new {\bf Purge Migration Job} directive may be added to the Migration
107 Job definition in the Director's configuration file. When it is enabled
108 the Job that was migrated during a migration will be purged at
109 the end of the migration job.
117 Client = localhost-fd
120 Storage = DiskChanger
123 Selection Pattern = ".*Save"
125 Purge Migration Job = yes
131 This project was submited by Dunlap Blake; testing and documentation was funded
134 \section{Changes in Bvfs (Bacula Virtual FileSystem)}
136 Bat has now a bRestore panel that uses Bvfs to display files and
141 \includegraphics[width=12cm]{\idir bat-brestore}
142 \label{fig:batbrestore}
143 \caption{Bat Brestore Panel}
146 \texttt{Important}, the Bvfs module does not yet work correctly with BaseJobs,
147 Copy and Migration jobs.
150 This project was funded by Bacula Systems.
152 \subsection*{General notes}
155 \item All fields are separated by a tab
156 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
157 records in very big directories
158 \item All operations (except cache creation) are designed to run instantly
159 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
160 can contribute new faster SQL queries we will be happy, else don't complain
162 \item The cache creation is dependent of the number of directories. As Bvfs
163 shares information accross jobs, the first creation can be slow
164 \item All fields are separated by a tab
165 \item Due to potential encoding problem, it's advised to allways use pathid in
169 \subsection*{Get dependent jobs from a given JobId}
171 Bvfs allows you to query the catalog against any combination of jobs. You
172 can combine all Jobs and all FileSet for a Client in a single session.
174 To get all JobId needed to restore a particular job, you can use the
175 \texttt{.bvfs\_get\_jobids} command.
178 .bvfs_get_jobids jobid=num [all]
182 .bvfs_get_jobids jobid=10
184 .bvfs_get_jobids jobid=10 all
188 In this example, a normal restore will need to use JobIds 1,2,5,10 to
189 compute a complete restore of the system.
191 With the \texttt{all} option, the Director will use all defined FileSet for
194 \subsection*{Generating Bvfs cache}
196 The \texttt{.bvfs\_update} command computes the directory cache for jobs
197 specified in argument, or for all jobs if unspecified.
200 .bvfs_update [jobid=numlist]
205 .bvfs_update jobid=1,2,3
208 You can run the cache update process in a RunScript after the catalog backup.
210 \subsection*{Get all versions of a specific file}
212 Bvfs allows you to find all versions of a specific file for a given Client with
213 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
214 function uses only PathId and FilenameId. The jobid argument is mandatory but
218 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
219 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
220 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
227 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
228 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
231 \subsection*{List directories}
233 Bvfs allows you to list directories in a specific path.
235 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
236 PathId FilenameId FileId JobId LStat Path
237 PathId FilenameId FileId JobId LStat Path
238 PathId FilenameId FileId JobId LStat Path
242 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
243 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
244 listed is a directory.
247 .bvfs_lsdirs pathid=4 jobid=1,11,12
248 4 0 0 0 A A A A A A A A A A A A A A .
249 5 0 0 0 A A A A A A A A A A A A A A ..
250 3 0 0 0 A A A A A A A A A A A A A A regress/
253 In this example, to list directories present in \texttt{regress/}, you can use
255 .bvfs_lsdirs pathid=3 jobid=1,11,12
256 3 0 0 0 A A A A A A A A A A A A A A .
257 4 0 0 0 A A A A A A A A A A A A A A ..
258 2 0 0 0 A A A A A A A A A A A A A A tmp/
261 \subsection*{List files}
263 Bvfs allows you to list files in a specific path.
265 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
266 PathId FilenameId FileId JobId LStat Path
267 PathId FilenameId FileId JobId LStat Path
268 PathId FilenameId FileId JobId LStat Path
272 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
273 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
277 .bvfs_lsfiles pathid=4 jobid=1,11,12
278 4 0 0 0 A A A A A A A A A A A A A A .
279 5 0 0 0 A A A A A A A A A A A A A A ..
280 1 0 0 0 A A A A A A A A A A A A A A regress/
283 In this example, to list files present in \texttt{regress/}, you can use
285 .bvfs_lsfiles pathid=1 jobid=1,11,12
286 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
287 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
288 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
289 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
290 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
293 \subsection*{Restore set of files}
295 Bvfs allows you to create a SQL table that contains files that you want to
296 restore. This table can be provided to a restore command with the file option.
299 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
301 restore file=?b2num ...
304 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
305 select all files. This query could be time consuming.
307 \texttt{hardlink} list is always composed of a serie of two numbers (jobid,
308 fileindex). This information can be found in the LinkFI field of the LStat
311 The \texttt{path} argument represents the name of the table that Bvfs will
312 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
313 b2 and followed by digits).
318 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
322 \subsection*{Cleanup after Restore}
324 To drop the table used by the restore command, you can use the
325 \texttt{.bvfs\_cleanup} command.
328 .bvfs_cleanup path=b20001
331 \subsection*{Clearing the BVFS Cache}
333 To clear the BVFS cache, you can use the \texttt{.bvfs\_clear_cache} command.
336 .bvfs_clear_cache yes
340 \section{Changes in the Pruning Algorithm}
342 We rewrote the job pruning algorithm in this version. Previously, in some users
343 reported that the pruning process at the end of jobs was very long. It should
344 not be longer the case. Now, Bacula won't prune automatically a Job if this
345 particular Job is needed to restore data. Example:
349 JobId: 2 Level: Incremental
350 JobId: 3 Level: Incremental
351 JobId: 4 Level: Differential
352 .. Other incrementals up to now
355 In this example, if the Job Retention defined in the Pool or in the Client
356 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
357 detect that JobId 1 and 4 are essential to restore data at the current state
358 and will prune only JobId 2 and 3.
360 \texttt{Important}, this change affect only the automatic pruning step after a
361 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
362 \texttt{VolumeRetention} period, important jobs can be pruned.
364 \section{Ability to Verify any specified Job}
365 You now have the ability to tell Bacula which Job should verify instead of
366 automatically verify just the last one.
368 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
370 To verify a given job, just specify the Job jobid in argument when starting the
373 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
375 JobName: VerifyVolume
376 Level: VolumeToCatalog
379 Pool: Default (From Job resource)
380 Storage: File (From Job resource)
381 Verify Job: VerifyVol.2010-09-08_14.17.17_03
382 Verify List: /tmp/regress/working/VerifyVol.bsr
383 When: 2010-09-08 14:17:31
385 OK to run? (yes/mod/no):
389 This project was funded by Bacula Systems and is available with Bacula
390 Enterprise Edition and Community Edition.
392 \section{Additions to RunScript variables}
393 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
394 command. The Client address is now available through \%h.
397 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
400 %\section{Changes in drivetype.exe}
402 %Now the \texttt{drivetype.exe} program allows you to list all local hard
403 %drives. It can help to build dynamic FileSet on Windows.
406 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
410 \section{Additions to the Plugin API}
411 The bfuncs structure has been extended to include a number of
415 The bFuncs structure defines the callback entry points within Bacula
416 that the plugin can use register events, get Bacula values, set
417 Bacula values, and send messages to the Job output or debug output.
419 The exact definition as of this writing is:
421 typedef struct s_baculaFuncs {
424 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
425 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
426 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
427 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
428 int type, utime_t mtime, const char *fmt, ...);
429 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
430 int level, const char *fmt, ...);
431 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
433 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
435 /* New functions follow */
436 bRC (*AddExclude)(bpContext *ctx, const char *file);
437 bRC (*AddInclude)(bpContext *ctx, const char *file);
438 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
439 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
440 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
441 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
447 \item [AddExclude] can be called to exclude a file. The file
448 string passed may include wildcards that will be interpreted by
449 the {\bf fnmatch} subroutine. This function can be called
450 multiple times, and each time the file specified will be added
451 to the list of files to be excluded. Note, this function only
452 permits adding excludes of specific file or directory names,
453 or files matched by the rather simple fnmatch mechanism.
454 See below for information on doing wild-card and regex excludes.
456 \item [NewInclude] can be called to create a new Include block. This
457 block will be added before any user defined Include blocks. This
458 function can be called multiple times, but each time, it will create
459 a new Include section (not normally needed). This function should
460 be called only if you want to add an entirely new Include block.
462 \item [AddInclude] can be called to add new files/directories to
463 be included. They are added to the current Include block. If
464 NewInclude has not been included, the current Include block is
465 the last one that the user created. This function
466 should be used only if you want to add totally new files/directories
467 to be included in the backup.
469 \item [NewOptions] adds a new Options block to the current Include
470 in front of any other Options blocks. This permits the plugin to
471 add exclude directives (wild-cards and regexes) in front of the
472 user Options, and thus prevent certain files from being backed up.
473 This can be useful if the plugin backs up files, and they should
474 not be also backed up by the main Bacula code. This function
475 may be called multiple times, and each time, it creates a new
476 prepended Options block. Note: normally you want to call this
477 entry point prior to calling AddOptions, AddRegex, or AddWild.
479 \item [AddOptions] allows the plugin it set options in
480 the current Options block, which is normally created with the
481 NewOptions call just prior to adding Include Options.
482 The permitted options are passed as a character string, where
483 each character has a specific meaning as defined below:
486 \item [a] always replace files (default).
487 \item [e] exclude rather than include.
488 \item [h] no recursion into subdirectories.
489 \item [H] do not handle hard links.
490 \item [i] ignore case in wildcard and regex matches.
491 \item [M] compute an MD5 sum.
492 \item [p] use a portable data format on Windows (not recommended).
493 \item [R] backup resource forks and Findr Info.
494 \item [r] read from a fifo
495 \item [S1] compute an SHA1 sum.
496 \item [S2] compute an SHA256 sum.
497 \item [S3] comput an SHA512 sum.
498 \item [s] handle sparse files.
499 \item [m] use st\_mtime only for file differences.
500 \item [k] restore the st\_atime after accessing a file.
501 \item [A] enable ACL backup.
502 \item [Vxxx:] specify verify options. Must terminate with :
503 \item [Cxxx:] specify accurate options. Must terminate with :
504 \item [Jxxx:] specify base job Options. Must terminate with :
505 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
507 \item [Zn] specify gzip compression level n.
508 \item [K] do not use st\_atime in backup decision.
509 \item [c] check if file changed during backup.
510 \item [N] honor no dump flag.
511 \item [X] enable backup of extended attributes.
514 \item [AddRegex] adds a regex expression to the current Options block.
515 The fillowing options are permitted:
517 \item [ ] (a blank) regex applies to whole path and filename.
518 \item [F] regex applies only to the filename (directory or path stripped).
519 \item [D] regex applies only to the directory (path) part of the name.
522 \item [AddWild] adds a wildcard expression to the current Options block.
523 The fillowing options are permitted:
525 \item [ ] (a blank) regex applies to whole path and filename.
526 \item [F] regex applies only to the filename (directory or path stripped).
527 \item [D] regex applies only to the directory (path) part of the name.
530 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
531 that can use Accurate code to compare the file information in argument with
532 the previous file information. The \texttt{delta\_seq} attribute of the
533 \texttt{save\_pkt} will be updated, and the call will return
534 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
539 \subsection{Bacula events}
540 The list of events has been extended to include:
546 bEventStartBackupJob = 3,
547 bEventEndBackupJob = 4,
548 bEventStartRestoreJob = 5,
549 bEventEndRestoreJob = 6,
550 bEventStartVerifyJob = 7,
551 bEventEndVerifyJob = 8,
552 bEventBackupCommand = 9,
553 bEventRestoreCommand = 10,
558 bEventCancelCommand = 13,
559 bEventVssBackupAddComponents = 14,
560 bEventVssRestoreLoadComponentMetadata = 15,
561 bEventVssRestoreSetComponentsSelected = 16,
562 bEventRestoreObject = 17,
563 bEventEndFileSet = 18,
564 bEventPluginCommand = 19,
565 bEventVssBeforeCloseRestore = 20,
566 bEventVssPrepareSnapshot = 21
572 \item [bEventCancelCommand] is called whenever the currently
573 running Job is cancelled */
575 \item [bEventVssBackupAddComponents]
577 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
578 provides a char[27] table where the plugin can add Windows drives that will
579 be used during the Job. You need to add them without duplicates, and you can
580 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
584 \section{ACL enhancements}
586 The following enhancements are made to the Bacula Filed with regards to
587 Access Control Lists (ACLs)
590 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
591 POSIX and NFSv4 ACLs.
592 \item Added support for new acl types on FreeBSD 8.1 and later which supports
593 POSIX and NFSv4 ACLs.
594 \item Some generic cleanups for internal ACL handling.
595 \item Fix for acl storage on OSX
596 \item Cleanup of configure checks for ACL detection, now configure only
597 tests for a certain interface type based on the operating system
598 this should give less false possitives on detection. Also when acls
599 are detected no other acl checks are performed anymore.
603 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
604 and is available with Bacula Enterprise Edition and Community Edition.
606 \section{XATTR enhancements}
608 The following enhancements are made to the Bacula Filed with regards to
609 Extended Attributes (XATTRs)
612 \item Added support for IRIX extended attributes using the attr\_get interface.
613 \item Added support for Tru64 (OSF1) extended attributes using the
614 getproplist interface.
615 \item Added support for AIX extended attributes available in AIX 6.x
616 and higher using the listea/getea/setea interface.
617 \item Added some debugging to generic xattr code so it easier to
619 \item Cleanup of configure checks for XATTR detection, now configure only
620 tests for a certain interface type based on the operating system
621 this should give less false possitives on detection. Also when xattrs
622 are detected no other xattr checks are performed anymore.
626 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
627 and is available with Bacula Enterprise Edition and Community Edition.
629 \section{Class Based Database Backend Drivers}
631 The main Bacula Director code is independent of the SQL backend
632 in version 5.2.0 and greater. This means that the Bacula Director can be
633 packaged by itself, then each of the different SQL backends supported can
634 be packaged separately. It is possible to build all the DB backends at the
635 same time by including multiple database options at the same time.
637 ./configure can be run with multiple database configure options.
644 Order of testing for databases is:
651 Each configured backend generates a file named:
652 \verb+libbaccats-<sql_backend_name>-<version>.so+
653 A dummy catalog library is created named libbaccats-version.so
655 At configure time the first detected backend is used as the so called
656 default backend and at install time the dummy
657 \verb+libbaccats-<version>.so+ is replaced with the default backend type.
659 If you configure all three backends you get three backend libraries and the
660 postgresql gets installed as the default.
662 When you want to switch to another database, first save any old catalog you
663 may have then you can copy one of the three backend libraries over the
664 \verb+libbaccats-<version>.so+ e.g.
666 An actual command, depending on your Bacula version might be:
668 cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
671 where the \verb+5.2.2+ must be replaced by the Bacula release
674 Then you must update the default backend in the following files:
677 create_bacula_database
680 grant_bacula_privileges
686 And re-run all the above scripts. Please note, this means
687 you will have a new empty database and if you had a previous
690 All current database backend drivers for catalog information are rewritten
691 to use a set of multi inherited C++ classes which abstract the specific
692 database specific internals and make sure we have a more stable generic
693 interface with the rest of sql code. From now on there is a strict
694 boundery between the SQL code and the low-level database functions. This
695 new interface should also make it easier to add a new backend for a
696 currently unsupported database. As part of the rewrite the SQLite 2 code
697 was removed (e.g. only SQLite 3 is now supported). An extra bonus of the
698 new code is that you can configure multiple backends in the configure and
699 build all backends in one compile session and select the correct database
700 backend at install time. This should make it a lot easier for packages
706 We also added cursor support for PostgreSQL backend, this improves memory
707 usage for large installation.
710 This project was implemented by Planets Communications B.V. and ELM
711 Consultancy B.V. and Bacula Systems and is available with both the Bacula
712 Enterprise Edition and the Community Edition.
714 \section{Hash List Enhancements}
716 The htable hash table class has been extended with extra hash functions for
717 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
718 Also the hash table initialization routines have been enhanced with
719 support for passing a hint as to the number of initial pages to use
720 for the size of the hash table. Until now the hash table always used
721 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
722 cache have been rewritten to use the new htable class with a small memory
726 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
727 and Bacula Systems and is available with Bacula Enterprise Edition and
732 %%% =====================================================================
737 \chapter{Release Version 5.0.3}
739 There are no new features in version 5.0.2. This version simply fixes a
740 number of bugs found in version 5.0.1 during the onging development
743 \chapter{Release Version 5.0.2}
745 There are no new features in version 5.0.2. This version simply fixes a
746 number of bugs found in version 5.0.1 during the onging development
752 \chapter{New Features in 5.0.1}
754 This chapter presents the new features that are in the released Bacula version
755 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
756 the onging development process.
758 \section{Truncate Volume after Purge}
759 \label{sec:actiononpurge}
761 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
762 the volume when it is purged with the new command \texttt{purge volume
763 action}. It is useful to prevent disk based volumes from consuming too much
769 Action On Purge = Truncate
774 As usual you can also set this property with the \texttt{update volume} command
776 *update volume=xxx ActionOnPurge=Truncate
777 *update volume=xxx actiononpurge=None
780 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
781 following command in interactive mode or in a RunScript as shown after:
783 *purge volume action=truncate storage=File allpools
784 # or by default, action=all
785 *purge volume action storage=File pool=Default
788 This is possible to specify the volume name, the media type, the pool, the
789 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
790 idle when you decide to run this command.
799 Console = "purge volume action=all allpools storage=File"
804 \textbf{Important note}: This feature doesn't work as
805 expected in version 5.0.0. Please do not use it before version 5.0.1.
807 \section{Allow Higher Duplicates}
808 This directive did not work correctly and has been depreciated
809 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
810 file as it will be removed in a future rlease.
812 \section{Cancel Lower Level Duplicates}
813 This directive was added in Bacula version 5.0.1. It compares the
814 level of a new backup job to old jobs of the same name, if any,
815 and will kill the job which has a lower level than the other one.
816 If the levels are the same (i.e. both are Full backups), then
817 nothing is done and the other Cancel XXX Duplicate directives
820 \chapter{New Features in 5.0.0}
822 \section{Maximum Concurrent Jobs for Devices}
823 \label{sec:maximumconcurrentjobdevice}
825 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
826 Daemon configuration permits setting the maximum number of Jobs that can
827 run concurrently on a specified Device. Using this directive, it is
828 possible to have different Jobs using multiple drives, because when the
829 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
830 Jobs on any other available compatible drive. This facilitates writing to
831 multiple drives with multiple Jobs that all use the same Pool.
833 This project was funded by Bacula Systems.
835 \section{Restore from Multiple Storage Daemons}
836 \index[general]{Restore}
838 Previously, you were able to restore from multiple devices in a single Storage
839 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
840 example, if your full backup runs on a Storage Daemon with an autochanger, and
841 your incremental jobs use another Storage Daemon with lots of disks, Bacula
842 will switch automatically from one Storage Daemon to an other within the same
845 You must upgrade your File Daemon to version 3.1.3 or greater to use this
848 This project was funded by Bacula Systems with the help of Equiinet.
850 \section{File Deduplication using Base Jobs}
851 A base job is sort of like a Full save except that you will want the FileSet to
852 contain only files that are unlikely to change in the future (i.e. a snapshot
853 of most of your system after installing it). After the base job has been run,
854 when you are doing a Full save, you specify one or more Base jobs to be used.
855 All files that have been backed up in the Base job/jobs but not modified will
856 then be excluded from the backup. During a restore, the Base jobs will be
857 automatically pulled in where necessary.
859 This is something none of the competition does, as far as we know (except
860 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
861 win for the user, it makes Bacula stand out as offering a unique optimization
862 that immediately saves time and money. Basically, imagine that you have 100
863 nearly identical Windows or Linux machine containing the OS and user files.
864 Now for the OS part, a Base job will be backed up once, and rather than making
865 100 copies of the OS, there will be only one. If one or more of the systems
866 have some files updated, no problem, they will be automatically restored.
868 See the \ilink{Base Job Chapter}{basejobs} for more information.
870 This project was funded by Bacula Systems.
872 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
873 \index[dir]{AllowCompression}
875 This new directive may be added to Storage resource within the Director's
876 configuration to allow users to selectively disable the client compression for
877 any job which writes to this storage resource.
883 Address = ultrium-tape
884 Password = storage_password # Password for Storage Daemon
887 AllowCompression = No # Tape drive has hardware compression
890 The above example would cause any jobs running with the UltriumTape storage
891 resource to run without compression from the client file daemons. This
892 effectively overrides any compression settings defined at the FileSet level.
894 This feature is probably most useful if you have a tape drive which supports
895 hardware compression. By setting the \texttt{AllowCompression = No} directive
896 for your tape drive storage resource, you can avoid additional load on the file
897 daemon and possibly speed up tape backups.
899 This project was funded by Collaborative Fusion, Inc.
901 \section{Accurate Fileset Options}
902 \label{sec:accuratefileset}
904 In previous versions, the accurate code used the file creation and modification
905 times to determine if a file was modified or not. Now you can specify which
906 attributes to use (time, size, checksum, permission, owner, group, \dots),
907 similar to the Verify options.
923 \item {\bf i} compare the inodes
924 \item {\bf p} compare the permission bits
925 \item {\bf n} compare the number of links
926 \item {\bf u} compare the user id
927 \item {\bf g} compare the group id
928 \item {\bf s} compare the size
929 \item {\bf a} compare the access time
930 \item {\bf m} compare the modification time (st\_mtime)
931 \item {\bf c} compare the change time (st\_ctime)
932 \item {\bf d} report file size decreases
933 \item {\bf 5} compare the MD5 signature
934 \item {\bf 1} compare the SHA1 signature
937 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
938 the File Daemon will have to read all files even if they normally would not
939 be saved. This increases the I/O load, but also the accuracy of the
940 deduplication. By default, Bacula will check modification/creation time
943 This project was funded by Bacula Systems.
945 \section{Tab-completion for Bconsole}
946 \label{sec:tabcompletion}
948 If you build \texttt{bconsole} with readline support, you will be able to use
949 the new auto-completion mode. This mode supports all commands, gives help
950 inside command, and lists resources when required. It works also in the restore
953 To use this feature, you should have readline development package loaded on
954 your system, and use the following option in configure.
956 ./configure --with-readline=/usr/include/readline --disable-conio ...
959 The new bconsole won't be able to tab-complete with older directors.
961 This project was funded by Bacula Systems.
963 \section{Pool File and Job Retention}
964 \label{sec:poolfilejobretention}
966 We added two new Pool directives, \texttt{FileRetention} and
967 \texttt{JobRetention}, that take precedence over Client directives of the same
968 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
969 example, you can decide to increase Retention times for Archive or OffSite Pool.
971 It seems obvious to us, but apparently not to some users, that given the
972 definition above that the Pool File and Job Retention periods is a global
973 override for the normal Client based prunning, which means that when the
974 Job is prunned, the prunning will apply globally to that particular Job.
976 Currently, there is a bug in the implementation that causes any Pool
977 retention periods specified to apply to {\bf all} Pools for that
978 particular Client. Thus we suggest that you avoid using these two
979 directives until this implementation problem is corrected.
981 \section{Read-only File Daemon using capabilities}
982 \label{sec:fdreadonly}
983 This feature implements support of keeping \textbf{ReadAll} capabilities after
984 UID/GID switch, this allows FD to keep root read but drop write permission.
986 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
987 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
990 root@localhost:~# bacula-fd -k -u nobody -g nobody
993 The code for this feature was contributed by our friends at AltLinux.
998 To help developers of restore GUI interfaces, we have added new \textsl{dot
999 commands} that permit browsing the catalog in a very simple way.
1002 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
1003 the Bvfs cache in the catalog. You need to run it before any access to the
1006 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
1007 will list all directories in the specified \texttt{path} or
1008 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
1009 encoding of path/filenames.
1011 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
1012 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
1013 \texttt{pathid} avoids problems with character encoding.
1016 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
1017 data that will be displayed.
1020 * .bvfs_update jobid=1,2
1022 * .bvfs_lsdir path=/ jobid=1,2
1025 This project was funded by Bacula Systems.
1027 \section{Testing your Tape Drive}
1028 \label{sec:btapespeed}
1030 To determine the best configuration of your tape drive, you can run the new
1031 \texttt{speed} command available in the \texttt{btape} program.
1033 This command can have the following arguments:
1035 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
1036 (between 1 and 5GB). This counter is in GB.
1037 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
1038 of data should be greater than your memory ($file\_size*nb\_file$).
1039 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
1041 \item[\texttt{skip\_random}] This flag permits to skip tests with random
1043 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
1044 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
1049 *speed file_size=3 skip_raw
1050 btape.c:1078 Test with zero data and bacula block structure.
1051 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1052 ++++++++++++++++++++++++++++++++++++++++++
1053 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1054 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
1056 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
1058 btape.c:1090 Test with random data, should give the minimum throughput.
1059 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1060 +++++++++++++++++++++++++++++++++++++++++++
1061 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1062 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
1063 +++++++++++++++++++++++++++++++++++++++++++
1065 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
1069 When using compression, the random test will give your the minimum throughput
1070 of your drive . The test using constant string will give you the maximum speed
1071 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
1073 You can change the block size in the Storage Daemon configuration file.
1075 \section{New {\bf Block Checksum} Device Directive}
1076 You may now turn off the Block Checksum (CRC32) code
1077 that Bacula uses when writing blocks to a Volume. This is
1084 doing so can reduce the Storage daemon CPU usage slightly. It
1085 will also permit Bacula to read a Volume that has corrupted data.
1087 The default is {\bf yes} -- i.e. the checksum is computed on write
1088 and checked on read.
1090 We do not recommend to turn this off particularly on older tape
1091 drives or for disk Volumes where doing so may allow corrupted data
1094 \section{New Bat Features}
1096 Those new features were funded by Bacula Systems.
1098 \subsection{Media List View}
1100 By clicking on ``Media'', you can see the list of all your volumes. You will be
1101 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1102 in the table. The old ``Media'' view is now known as ``Pool''.
1103 \begin{figure}[htbp]
1105 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
1106 \label{fig:mediaview}
1110 \subsection{Media Information View}
1112 By double-clicking on a volume (on the Media list, in the Autochanger content
1113 or in the Job information panel), you can access a detailed overview of your
1114 Volume. (cf \ref{fig:mediainfo}.)
1115 \begin{figure}[htbp]
1117 \includegraphics[width=13cm]{\idir bat11.eps}
1118 \caption{Media information}
1119 \label{fig:mediainfo}
1122 \subsection{Job Information View}
1124 By double-clicking on a Job record (on the Job run list or in the Media
1125 information panel), you can access a detailed overview of your Job. (cf
1127 \begin{figure}[htbp]
1129 \includegraphics[width=13cm]{\idir bat12.eps}
1130 \caption{Job information}
1134 \subsection{Autochanger Content View}
1136 By double-clicking on a Storage record (on the Storage list panel), you can
1137 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
1138 \begin{figure}[htbp]
1140 \includegraphics[width=13cm]{\idir bat13.eps}
1141 \caption{Autochanger content}
1142 \label{fig:achcontent}
1145 To use this feature, you need to use the latest mtx-changer script
1146 version. (With new \texttt{listall} and \texttt{transfer} commands)
1148 \section{Bat on Windows}
1149 We have ported {\bf bat} to Windows and it is now installed
1150 by default when the installer is run. It works quite well
1151 on Win32, but has not had a lot of testing there, so your
1152 feedback would be welcome. Unfortunately, eventhough it is
1153 installed by default, it does not yet work on 64 bit Windows
1156 \section{New Win32 Installer}
1157 The Win32 installer has been modified in several very important
1160 \item You must deinstall any current version of the
1161 Win32 File daemon before upgrading to the new one.
1162 If you forget to do so, the new installation will fail.
1163 To correct this failure, you must manually shutdown
1164 and deinstall the old File daemon.
1165 \item All files (other than menu links) are installed
1166 in {\bf c:/Program Files/Bacula}.
1167 \item The installer no longer sets this
1168 file to require administrator privileges by default. If you want
1169 to do so, please do it manually using the {\bf cacls} program.
1172 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1174 \item The server daemons (Director and Storage daemon) are
1175 no longer included in the Windows installer. If you want the
1176 Windows servers, you will either need to build them yourself (note
1177 they have not been ported to 64 bits), or you can contact
1178 Bacula Systems about this.
1181 \section{Win64 Installer}
1182 We have corrected a number of problems that required manual
1183 editing of the conf files. In most cases, it should now
1184 install and work. {\bf bat} is by default installed in
1185 {\bf c:/Program Files/Bacula/bin32} rather than
1186 {\bf c:/Program Files/Bacula} as is the case with the 32
1187 bit Windows installer.
1189 \section{Linux Bare Metal Recovery USB Key}
1190 We have made a number of significant improvements in the
1191 Bare Metal Recovery USB key. Please see the README files
1192 it the {\bf rescue} release for more details.
1194 We are working on an equivalent USB key for Windows bare
1195 metal recovery, but it will take some time to develop it (best
1196 estimate 3Q2010 or 4Q2010)
1199 \section{bconsole Timeout Option}
1200 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1201 for commands. This is useful with GUI programs that use {\bf bconsole}
1202 to interface to the Director.
1204 \section{Important Changes}
1205 \label{sec:importantchanges}
1208 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1209 to the same Pool. The Storage daemon ensures that you do not read and
1210 write to the same Volume.
1211 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1213 \item Virtually all the features of {\bf mtx-changer} have
1214 now been parameterized, which allows you to configure
1215 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1216 that contains variables that you can set to configure mtx-changer.
1217 This configuration file will not be overwritten during upgrades.
1218 We encourage you to submit any changes
1219 that are made to mtx-changer and to parameterize it all in
1220 mtx-changer.conf so that all configuration will be done by
1221 changing only mtx-changer.conf.
1222 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1223 and \texttt{transfer}. Please configure them as appropriate
1224 in mtx-changer.conf.
1225 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1226 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1227 password. If you want to use the new script, you will need to
1228 manually change the \texttt{BackupCatalog} Job definition.
1229 \item The \texttt{bconsole} \texttt{help} command now accepts
1230 an argument, which if provided produces information on that
1231 command (ex: \texttt{help run}).
1235 \subsubsection*{Truncate volume after purge}
1237 Note that the Truncate Volume after purge feature doesn't work as expected
1238 in 5.0.0 version. Please, don't use it before version 5.0.1.
1240 \subsection{Custom Catalog queries}
1242 If you wish to add specialized commands that list the contents of the catalog,
1243 you can do so by adding them to the \texttt{query.sql} file. This
1244 \texttt{query.sql} file is now empty by default. The file
1245 \texttt{examples/sample-query.sql} has an a number of sample commands
1246 you might find useful.
1248 \subsection{Deprecated parts}
1250 The following items have been \textbf{deprecated} for a long time, and are now
1251 removed from the code.
1254 \item Support for SQLite 2
1257 \section{Misc Changes}
1258 \label{sec:miscchanges}
1261 \item Updated Nagios check\_bacula
1262 \item Updated man files
1263 \item Added OSX package generation script in platforms/darwin
1264 \item Added Spanish and Ukrainian Bacula translations
1265 \item Enable/disable command shows only Jobs that can change
1266 \item Added \texttt{show disabled} command to show disabled Jobs
1267 \item Many ACL improvements
1268 \item Added Level to FD status Job output
1269 \item Begin Ingres DB driver (not yet working)
1270 \item Split RedHat spec files into bacula, bat, mtx, and docs
1271 \item Reorganized the manuals (fewer separate manuals)
1272 \item Added lock/unlock order protection in lock manager
1273 \item Allow 64 bit sizes for a number of variables
1274 \item Fixed several deadlocks or potential race conditions in the SD
1277 \chapter{Released Version 3.0.3 and 3.0.3a}
1279 There are no new features in version 3.0.3. This version simply fixes a
1280 number of bugs found in version 3.0.2 during the onging development
1283 \chapter{New Features in Released Version 3.0.2}
1285 This chapter presents the new features added to the
1286 Released Bacula Version 3.0.2.
1288 \section{Full Restore from a Given JobId}
1289 \index[general]{Restore menu}
1291 This feature allows selecting a single JobId and having Bacula
1292 automatically select all the other jobs that comprise a full backup up to
1293 and including the selected date (through JobId).
1295 Assume we start with the following jobs:
1297 +-------+--------------+---------------------+-------+----------+------------+
1298 | jobid | client | starttime | level | jobfiles | jobbytes |
1299 +-------+--------------+---------------------+-------+----------+------------
1300 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1301 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1302 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1303 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1304 +-------+--------------+---------------------+-------+----------+------------+
1307 Below is an example of this new feature (which is number 12 in the
1312 To select the JobIds, you have the following choices:
1313 1: List last 20 Jobs run
1314 2: List Jobs where a given File is saved
1316 12: Select full restore to a specified Job date
1319 Select item: (1-13): 12
1320 Enter JobId to get the state to restore: 5
1321 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1322 You have selected the following JobIds: 1,3,5
1324 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1325 1,444 files inserted into the tree.
1328 This project was funded by Bacula Systems.
1330 \section{Source Address}
1331 \index[general]{Source Address}
1333 A feature has been added which allows the administrator to specify the address
1334 from which the Director and File daemons will establish connections. This
1335 may be used to simplify system configuration overhead when working in complex
1336 networks utilizing multi-homing and policy-routing.
1338 To accomplish this, two new configuration directives have been implemented:
1341 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1345 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1349 Simply adding specific host routes on the OS
1350 would have an undesirable side-effect: any
1351 application trying to contact the destination host would be forced to use the
1352 more specific route possibly diverting management traffic onto a backup VLAN.
1353 Instead of adding host routes for each client connected to a multi-homed backup
1354 server (for example where there are management and backup VLANs), one can
1355 use the new directives to specify a specific source address at the application
1358 Additionally, this allows the simplification and abstraction of firewall rules
1359 when dealing with a Hot-Standby director or storage daemon configuration. The
1360 Hot-standby pair may share a CARP address, which connections must be sourced
1361 from, while system services listen and act from the unique interface addresses.
1363 This project was funded by Collaborative Fusion, Inc.
1365 \section{Show volume availability when doing restore}
1367 When doing a restore the selection dialog ends by displaying this
1371 The job will require the following
1372 Volume(s) Storage(s) SD Device(s)
1373 ===========================================================================
1374 *000741L3 LTO-4 LTO3
1375 *000866L3 LTO-4 LTO3
1376 *000765L3 LTO-4 LTO3
1377 *000764L3 LTO-4 LTO3
1378 *000756L3 LTO-4 LTO3
1379 *001759L3 LTO-4 LTO3
1380 *001763L3 LTO-4 LTO3
1384 Volumes marked with ``*'' are online (in the autochanger).
1387 This should help speed up large restores by minimizing the time spent
1388 waiting for the operator to discover that he must change tapes in the library.
1390 This project was funded by Bacula Systems.
1392 \section{Accurate estimate command}
1394 The \texttt{estimate} command can now use the accurate code to detect changes
1395 and give a better estimation.
1397 You can set the accurate behavior on the command line by using
1398 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1401 * estimate listing accurate=yes level=incremental job=BackupJob
1404 This project was funded by Bacula Systems.
1406 \chapter{New Features in 3.0.0}
1407 \label{NewFeaturesChapter}
1408 \index[general]{New Features}
1410 This chapter presents the new features added to the development 2.5.x
1411 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1413 \section{Accurate Backup}
1414 \index[general]{Accurate Backup}
1416 As with most other backup programs, by default Bacula decides what files to
1417 backup for Incremental and Differental backup by comparing the change
1418 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1419 backup completed. If one of those two times is later than the last backup
1420 time, then the file will be backed up. This does not, however, permit tracking
1421 what files have been deleted and will miss any file with an old time that may
1422 have been restored to or moved onto the client filesystem.
1424 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1425 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1426 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1427 backup, there is no difference, but for {\bf Differential} and {\bf
1428 Incremental} backups, the Director will send a list of all previous files
1429 backed up, and the File daemon will use that list to determine if any new files
1430 have been added or or moved and if any files have been deleted. This allows
1431 Bacula to make an accurate backup of your system to that point in time so that
1432 if you do a restore, it will restore your system exactly.
1435 about using Accurate backup is that it requires more resources (CPU and memory)
1436 on both the Director and the Client machines to create the list of previous
1437 files backed up, to send that list to the File daemon, for the File daemon to
1438 keep the list (possibly very big) in memory, and for the File daemon to do
1439 comparisons between every file in the FileSet and the list. In particular,
1440 if your client has lots of files (more than a few million), you will need
1441 lots of memory on the client machine.
1443 Accurate must not be enabled when backing up with a plugin that is not
1444 specially designed to work with Accurate. If you enable it, your restores
1445 will probably not work correctly.
1447 This project was funded by Bacula Systems.
1452 \index[general]{Copy Jobs}
1454 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1455 existing Migration feature with the exception that the Job that is copied is
1456 left unchanged. This essentially creates two identical copies of the same
1457 backup. However, the copy is treated as a copy rather than a backup job, and
1458 hence is not directly available for restore. The {\bf restore} command lists
1459 copy jobs and allows selection of copies by using \texttt{jobid=}
1460 option. If the keyword {\bf copies} is present on the command line, Bacula will
1461 display the list of all copies for selected jobs.
1466 These JobIds have copies as follows:
1467 +-------+------------------------------------+-----------+------------------+
1468 | JobId | Job | CopyJobId | MediaType |
1469 +-------+------------------------------------+-----------+------------------+
1470 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1471 +-------+------------------------------------+-----------+------------------+
1472 +-------+-------+----------+----------+---------------------+------------------+
1473 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1474 +-------+-------+----------+----------+---------------------+------------------+
1475 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1476 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1477 +-------+-------+----------+----------+---------------------+------------------+
1478 You have selected the following JobIds: 19,2
1480 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1481 5,611 files inserted into the tree.
1486 The Copy Job runs without using the File daemon by copying the data from the
1487 old backup Volume to a different Volume in a different Pool. See the Migration
1488 documentation for additional details. For copy Jobs there is a new selection
1489 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1490 not already copied to another Pool.
1492 As with Migration, the Client, Volume, Job, or SQL query, are
1493 other possible ways of selecting the Jobs to be copied. Selection
1494 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1495 work, but are probably more suited for Migration Jobs.
1497 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1498 it will promote the Copy to a \textsl{real} backup job and will make it available for
1499 automatic restore. If more than one Copy is available, it will promote the copy
1500 with the smallest JobId.
1502 A nice solution which can be built with the new Copy feature is often
1503 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1504 look something like the one below:
1508 Name = FullBackupsVirtualPool
1510 Purge Oldest Volume = Yes
1512 NextPool = FullBackupsTapePool
1516 Name = FullBackupsTapePool
1520 Volume Retention = 365 days
1521 Storage = superloader
1525 # Fake fileset for copy jobs
1537 # Fake client for copy jobs
1547 # Default template for a CopyDiskToTape Job
1550 Name = CopyDiskToTape
1552 Messages = StandardCopy
1555 Selection Type = PoolUncopiedJobs
1556 Maximum Concurrent Jobs = 10
1558 Allow Duplicate Jobs = Yes
1559 Cancel Queued Duplicates = No
1560 Cancel Running Duplicates = No
1565 Name = DaySchedule7:00
1566 Run = Level=Full daily at 7:00
1570 Name = CopyDiskToTapeFullBackups
1572 Schedule = DaySchedule7:00
1573 Pool = FullBackupsVirtualPool
1574 JobDefs = CopyDiskToTape
1578 The example above had 2 pool which are copied using the PoolUncopiedJobs
1579 selection criteria. Normal Full backups go to the Virtual pool and are copied
1580 to the Tape pool the next morning.
1582 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1587 +-------+------------------------------------+-----------+------------------+
1588 | JobId | Job | CopyJobId | MediaType |
1589 +-------+------------------------------------+-----------+------------------+
1590 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1591 +-------+------------------------------------+-----------+------------------+
1594 \section{ACL Updates}
1595 \index[general]{ACL Updates}
1596 The whole ACL code had been overhauled and in this version each platforms has
1597 different streams for each type of acl available on such an platform. As ACLs
1598 between platforms tend to be not that portable (most implement POSIX acls but
1599 some use an other draft or a completely different format) we currently only
1600 allow certain platform specific ACL streams to be decoded and restored on the
1601 same platform that they were created on. The old code allowed to restore ACL
1602 cross platform but the comments already mention that not being to wise. For
1603 backward compatability the new code will accept the two old ACL streams and
1604 handle those with the platform specific handler. But for all new backups it
1605 will save the ACLs using the new streams.
1607 Currently the following platforms support ACLs:
1611 \item {\bf Darwin/OSX}
1620 Currently we support the following ACL types (these ACL streams use a reserved
1621 part of the stream numbers):
1624 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1626 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1627 string representation from acl\_to\_text (POSIX acl)
1628 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1629 string representation from acl\_to\_text (POSIX acl) for default acls.
1630 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1631 string representation from acl\_to\_text (POSIX acl) for access acls.
1632 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1633 string representation from acltostr (POSIX acl)
1634 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1635 representation from acl\_to\_text (POSIX acl) for default acls.
1636 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1637 representation from acl\_to\_text (POSIX acl) for access acls.
1638 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1639 string representation from acl\_to\_text (POSIX acl) for default acls.
1640 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1641 representation from acl\_to\_text (POSIX acl) for access acls.
1642 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1643 string representation from acl\_to\_text (POSIX acl) for default acls.
1644 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1645 string representation from acl\_to\_text (POSIX acl) for default acls.
1646 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1647 representation from acl\_to\_text (POSIX acl) for access acls.
1648 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1649 string representation from acltotext or acl\_totext (POSIX acl)
1650 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1651 representation from from acl\_totext (NFSv4 or ZFS acl)
1654 In future versions we might support conversion functions from one type of acl
1655 into an other for types that are either the same or easily convertable. For now
1656 the streams are seperate and restoring them on a platform that doesn't
1657 recognize them will give you a warning.
1659 \section{Extended Attributes}
1660 \index[general]{Extended Attributes}
1661 Something that was on the project list for some time is now implemented for
1662 platforms that support a similar kind of interface. Its the support for backup
1663 and restore of so called extended attributes. As extended attributes are so
1664 platform specific these attributes are saved in seperate streams for each
1665 platform. Restores of the extended attributes can only be performed on the
1666 same platform the backup was done. There is support for all types of extended
1667 attributes, but restoring from one type of filesystem onto an other type of
1668 filesystem on the same platform may lead to supprises. As extended attributes
1669 can contain any type of data they are stored as a series of so called
1670 value-pairs. This data must be seen as mostly binary and is stored as such.
1671 As security labels from selinux are also extended attributes this option also
1672 stores those labels and no specific code is enabled for handling selinux
1675 Currently the following platforms support extended attributes:
1677 \item {\bf Darwin/OSX}
1683 On linux acls are also extended attributes, as such when you enable ACLs on a
1684 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1685 and not the same exteneded attribute.
1687 To enable the backup of extended attributes please add the following to your
1702 \section{Shared objects}
1703 \index[general]{Shared objects}
1704 A default build of Bacula will now create the libraries as shared objects
1705 (.so) rather than static libraries as was previously the case.
1706 The shared libraries are built using {\bf libtool} so it should be quite
1709 An important advantage of using shared objects is that on a machine with the
1710 Directory, File daemon, the Storage daemon, and a console, you will have only
1711 one copy of the code in memory rather than four copies. Also the total size of
1712 the binary release is smaller since the library code appears only once rather
1713 than once for every program that uses it; this results in significant reduction
1714 in the size of the binaries particularly for the utility tools.
1716 In order for the system loader to find the shared objects when loading the
1717 Bacula binaries, the Bacula shared objects must either be in a shared object
1718 directory known to the loader (typically /usr/lib) or they must be in the
1719 directory that may be specified on the {\bf ./configure} line using the {\bf
1720 {-}{-}libdir} option as:
1723 ./configure --libdir=/full-path/dir
1726 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1727 no need to modify your loader configuration provided that
1728 the shared objects are installed in that directory (Bacula
1729 does this with the make install command). The shared objects
1730 that Bacula references are:
1739 These files are symbolically linked to the real shared object file,
1740 which has a version number to permit running multiple versions of
1741 the libraries if desired (not normally the case).
1743 If you have problems with libtool or you wish to use the old
1744 way of building static libraries, or you want to build a static
1745 version of Bacula you may disable
1746 libtool on the configure command line with:
1749 ./configure --disable-libtool
1753 \section{Building Static versions of Bacula}
1754 \index[general]{Static linking}
1755 In order to build static versions of Bacula, in addition
1756 to configuration options that were needed you now must
1757 also add --disable-libtool. Example
1760 ./configure --enable-static-client-only --disable-libtool
1764 \section{Virtual Backup (Vbackup)}
1765 \index[general]{Virtual Backup}
1766 \index[general]{Vbackup}
1768 Bacula's virtual backup feature is often called Synthetic Backup or
1769 Consolidation in other backup products. It permits you to consolidate the
1770 previous Full backup plus the most recent Differential backup and any
1771 subsequent Incremental backups into a new Full backup. This new Full
1772 backup will then be considered as the most recent Full for any future
1773 Incremental or Differential backups. The VirtualFull backup is
1774 accomplished without contacting the client by reading the previous backup
1775 data and writing it to a volume in a different pool.
1777 In some respects the Vbackup feature works similar to a Migration job, in
1778 that Bacula normally reads the data from the pool specified in the
1779 Job resource, and writes it to the {\bf Next Pool} specified in the
1780 Job resource. Note, this means that usually the output from the Virtual
1781 Backup is written into a different pool from where your prior backups
1782 are saved. Doing it this way guarantees that you will not get a deadlock
1783 situation attempting to read and write to the same volume in the Storage
1784 daemon. If you then want to do subsequent backups, you may need to
1785 move the Virtual Full Volume back to your normal backup pool.
1786 Alternatively, you can set your {\bf Next Pool} to point to the current
1787 pool. This will cause Bacula to read and write to Volumes in the
1788 current pool. In general, this will work, because Bacula will
1789 not allow reading and writing on the same Volume. In any case, once
1790 a VirtualFull has been created, and a restore is done involving the
1791 most current Full, it will read the Volume or Volumes by the VirtualFull
1792 regardless of in which Pool the Volume is found.
1794 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1795 a level of {\bf VirtualFull}.
1797 A typical Job resource definition might look like the following:
1804 FileSet = "Full Set"
1811 # Default pool definition
1815 Recycle = yes # Automatically recycle Volumes
1816 AutoPrune = yes # Prune expired volumes
1817 Volume Retention = 365d # one year
1825 Recycle = yes # Automatically recycle Volumes
1826 AutoPrune = yes # Prune expired volumes
1827 Volume Retention = 365d # one year
1828 Storage = DiskChanger
1831 # Definition of file storage device
1836 Device = FileStorage
1838 Maximum Concurrent Jobs = 5
1841 # Definition of DDS Virtual tape disk storage device
1844 Address = localhost # N.B. Use a fully qualified name here
1846 Device = DiskChanger
1847 Media Type = DiskChangerMedia
1848 Maximum Concurrent Jobs = 4
1853 Then in bconsole or via a Run schedule, you would run the job as:
1856 run job=MyBackup level=Full
1857 run job=MyBackup level=Incremental
1858 run job=MyBackup level=Differential
1859 run job=MyBackup level=Incremental
1860 run job=MyBackup level=Incremental
1863 So providing there were changes between each of those jobs, you would end up
1864 with a Full backup, a Differential, which includes the first Incremental
1865 backup, then two Incremental backups. All the above jobs would be written to
1866 the {\bf Default} pool.
1868 To consolidate those backups into a new Full backup, you would run the
1872 run job=MyBackup level=VirtualFull
1875 And it would produce a new Full backup without using the client, and the output
1876 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1878 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1881 Note, the Start and End time of the Virtual Full backup is set to the
1882 values for the last job included in the Virtual Full (in the above example,
1883 it is an Increment). This is so that if another incremental is done, which
1884 will be based on the Virtual Full, it will backup all files from the
1885 last Job included in the Virtual Full rather than from the time the Virtual
1886 Full was actually run.
1890 \section{Catalog Format}
1891 \index[general]{Catalog Format}
1892 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1893 operation will convert the FileId field of the File table from 32 bits (max 4
1894 billion table entries) to 64 bits (very large number of items). The
1895 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1896 your catalog during the conversion. Also you won't be able to run jobs during
1897 this conversion period. For example, a 3 million file catalog will take 2
1898 minutes to upgrade on a normal machine. Please don't forget to make a valid
1899 backup of your database before executing the upgrade script. See the
1900 ReleaseNotes for additional details.
1902 \section{64 bit Windows Client}
1903 \index[general]{Win64 Client}
1904 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1905 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1906 As a consequence, we are also releasing a 64 bit version of the Bacula
1907 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1908 These binaries should only be installed on 64 bit Windows operating systems.
1909 What is important is not your hardware but whether or not you have
1910 a 64 bit version of the Windows OS.
1912 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1914 \item Before installing the Win64 Bacula Client, you must totally
1915 deinstall any prior 2.4.x Client installation using the
1916 Bacula deinstallation (see the menu item). You may want
1917 to save your .conf files first.
1918 \item Only the Client (File daemon) is ported to Win64, the Director
1919 and the Storage daemon are not in the 64 bit Windows installer.
1920 \item bwx-console is not yet ported.
1921 \item bconsole is ported but it has not been tested.
1922 \item The documentation is not included in the installer.
1923 \item Due to Vista security restrictions imposed on a default installation
1924 of Vista, before upgrading the Client, you must manually stop
1925 any prior version of Bacula from running, otherwise the install
1927 \item Due to Vista security restrictions imposed on a default installation
1928 of Vista, attempting to edit the conf files via the menu items
1929 will fail. You must directly edit the files with appropriate
1930 permissions. Generally double clicking on the appropriate .conf
1931 file will work providing you have sufficient permissions.
1932 \item All Bacula files are now installed in
1933 {\bf C:/Program Files/Bacula} except the main menu items,
1934 which are installed as before. This vastly simplifies the installation.
1935 \item If you are running on a foreign language version of Windows, most
1936 likely {\bf C:/Program Files} does not exist, so you should use the
1937 Custom installation and enter an appropriate location to install
1939 \item The 3.0.0 Win32 Client continues to install files in the locations used
1940 by prior versions. For the next version we will convert it to use
1941 the same installation conventions as the Win64 version.
1944 This project was funded by Bacula Systems.
1947 \section{Duplicate Job Control}
1948 \index[general]{Duplicate Jobs}
1949 The new version of Bacula provides four new directives that
1950 give additional control over what Bacula does if duplicate jobs
1951 are started. A duplicate job in the sense we use it here means
1952 a second or subsequent job with the same name starts. This
1953 happens most frequently when the first job runs longer than expected because no
1954 tapes are available.
1956 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1957 are specified in the Job resource.
1961 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1962 \index[general]{Allow Duplicate Jobs}
1963 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1964 the directive is set to {\bf no} (default) then only one job of a given name
1965 may run at one time, and the action that Bacula takes to ensure only
1966 one job runs is determined by the other directives (see below).
1968 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1969 are present and none of the three directives given below permit
1970 cancelling a job, then the current job (the second one started)
1973 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1974 \index[general]{Allow Higher Duplicates}
1975 This directive was in version 5.0.0, but does not work as
1976 expected. If used, it should always be set to no. In later versions
1977 of Bacula the directive is disabled (disregarded).
1979 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1980 \index[general]{Cancel Running Duplicates}
1981 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1982 if this directive is set to {\bf yes} any job that is already running
1983 will be canceled. The default is {\bf no}.
1985 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1986 \index[general]{Cancel Queued Duplicates}
1987 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1988 if this directive is set to {\bf yes} any job that is
1989 already queued to run but not yet running will be canceled.
1990 The default is {\bf no}.
1993 \section{TLS Authentication}
1994 \index[general]{TLS Authentication}
1995 In Bacula version 2.5.x and later, in addition to the normal Bacula
1996 CRAM-MD5 authentication that is used to authenticate each Bacula
1997 connection, you can specify that you want TLS Authentication as well,
1998 which will provide more secure authentication.
2000 This new feature uses Bacula's existing TLS code (normally used for
2001 communications encryption) to do authentication. To use it, you must
2002 specify all the TLS directives normally used to enable communications
2003 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
2006 \subsection{TLS Authenticate = yes}
2008 TLS Authenticate = yes
2011 in the main daemon configuration resource (Director for the Director,
2012 Client for the File daemon, and Storage for the Storage daemon).
2014 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
2015 authentication, Bacula will also do TLS authentication, then TLS
2016 encryption will be turned off, and the rest of the communication between
2017 the two Bacula daemons will be done without encryption.
2019 If you want to encrypt communications data, use the normal TLS directives
2020 but do not turn on {\bf TLS Authenticate}.
2022 \section{bextract non-portable Win32 data}
2023 \index[general]{bextract handles Win32 non-portable data}
2024 {\bf bextract} has been enhanced to be able to restore
2025 non-portable Win32 data to any OS. Previous versions were
2026 unable to restore non-portable Win32 data to machines that
2027 did not have the Win32 BackupRead and BackupWrite API calls.
2029 \section{State File updated at Job Termination}
2030 \index[general]{State File}
2031 In previous versions of Bacula, the state file, which provides a
2032 summary of previous jobs run in the {\bf status} command output was
2033 updated only when Bacula terminated, thus if the daemon crashed, the
2034 state file might not contain all the run data. This version of
2035 the Bacula daemons updates the state file on each job termination.
2037 \section{MaxFullInterval = \lt{}time-interval\gt{}}
2038 \index[general]{MaxFullInterval}
2039 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
2040 can be used to specify the maximum time interval between {\bf Full} backup
2041 jobs. When a job starts, if the time since the last Full backup is
2042 greater than the specified interval, and the job would normally be an
2043 {\bf Incremental} or {\bf Differential}, it will be automatically
2044 upgraded to a {\bf Full} backup.
2046 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
2047 \index[general]{MaxDiffInterval}
2048 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
2049 can be used to specify the maximum time interval between {\bf Differential} backup
2050 jobs. When a job starts, if the time since the last Differential backup is
2051 greater than the specified interval, and the job would normally be an
2052 {\bf Incremental}, it will be automatically
2053 upgraded to a {\bf Differential} backup.
2055 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
2056 \index[general]{MaxDiffInterval}
2057 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
2058 by the user, and when it is set it is an indication to backup programs
2059 to not backup that particular file. This version of Bacula contains a
2060 new Options directive within a FileSet resource, which instructs Bacula to
2061 obey this flag. The new directive is:
2064 Honor No Dump Flag = yes\vb{}no
2067 The default value is {\bf no}.
2070 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
2071 \index[general]{IgnoreDir}
2072 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
2073 can be added to the Include section of the FileSet resource. If the specified
2074 filename ({\bf filename-string}) is found on the Client in any directory to be
2075 backed up, the whole directory will be ignored (not backed up). For example:
2078 # List of files to be backed up
2086 Exclude Dir Containing = .excludeme
2091 But in /home, there may be hundreds of directories of users and some
2092 people want to indicate that they don't want to have certain
2093 directories backed up. For example, with the above FileSet, if
2094 the user or sysadmin creates a file named {\bf .excludeme} in
2095 specific directories, such as
2098 /home/user/www/cache/.excludeme
2099 /home/user/temp/.excludeme
2102 then Bacula will not backup the two directories named:
2105 /home/user/www/cache
2109 NOTE: subdirectories will not be backed up. That is, the directive
2110 applies to the two directories in question and any children (be they
2111 files, directories, etc).
2114 \section{Bacula Plugins}
2115 \index[general]{Plugin}
2116 Support for shared object plugins has been implemented in the Linux, Unix
2117 and Win32 File daemons. The API will be documented separately in
2118 the Developer's Guide or in a new document. For the moment, there is
2119 a single plugin named {\bf bpipe} that allows an external program to
2120 get control to backup and restore a file.
2122 Plugins are also planned (partially implemented) in the Director and the
2125 \subsection{Plugin Directory}
2126 \index[general]{Plugin Directory}
2127 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2128 be added to the daemon definition resource. The directory takes a quoted
2129 string argument, which is the name of the directory in which the daemon can
2130 find the Bacula plugins. If this directive is not specified, Bacula will not
2131 load any plugins. Since each plugin has a distinctive name, all the daemons
2132 can share the same plugin directory.
2134 \subsection{Plugin Options}
2135 \index[general]{Plugin Options}
2136 The {\bf Plugin Options} directive takes a quoted string
2137 arguement (after the equal sign) and may be specified in the
2138 Job resource. The options specified will be passed to all plugins
2139 when they are run. This each plugin must know what it is looking
2140 for. The value defined in the Job resource can be modified
2141 by the user when he runs a Job via the {\bf bconsole} command line
2144 Note: this directive may be specified, and there is code to modify
2145 the string in the run command, but the plugin options are not yet passed to
2146 the plugin (i.e. not fully implemented).
2148 \subsection{Plugin Options ACL}
2149 \index[general]{Plugin Options ACL}
2150 The {\bf Plugin Options ACL} directive may be specified in the
2151 Director's Console resource. It functions as all the other ACL commands
2152 do by permitting users running restricted consoles to specify a
2153 {\bf Plugin Options} that overrides the one specified in the Job
2154 definition. Without this directive restricted consoles may not modify
2157 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2158 \index[general]{Plugin}
2159 The {\bf Plugin} directive is specified in the Include section of
2160 a FileSet resource where you put your {\bf File = xxx} directives.
2171 Plugin = "bpipe:..."
2176 In the above example, when the File daemon is processing the directives
2177 in the Include section, it will first backup all the files in {\bf /home}
2178 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2179 the Plugin Directory. The syntax and semantics of the Plugin directive
2180 require the first part of the string up to the colon (:) to be the name
2181 of the plugin. Everything after the first colon is ignored by the File daemon but
2182 is passed to the plugin. Thus the plugin writer may define the meaning of the
2183 rest of the string as he wishes.
2185 Please see the next section for information about the {\bf bpipe} Bacula
2188 \section{The bpipe Plugin}
2189 \index[general]{The bpipe Plugin}
2190 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2191 the Bacula source distribution. When the plugin is compiled and linking into
2192 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2193 Please note that this is a very simple plugin that was written for
2194 demonstration and test purposes. It is and can be used in production, but
2195 that was never really intended.
2197 The purpose of the plugin is to provide an interface to any system program for
2198 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2199 the Include section of your Job's FileSet resource. The full syntax of the
2200 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2201 to specify the sytax as it wishes) is:
2204 Plugin = "<field1>:<field2>:<field3>:<field4>"
2209 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2210 stripped off, so in this case, we would put {\bf bpipe} in this field.
2212 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2213 pseudo path and filename under which the backup will be saved. This pseudo
2214 path and filename will be seen by the user in the restore file tree.
2215 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2216 backed up by the plugin will be put under that "pseudo" path and filename.
2217 You must be careful to choose a naming convention that is unique to avoid
2218 a conflict with a path and filename that actually exists on your system.
2220 \item {\bf field3} for the {\bf bpipe} plugin
2221 specifies the "reader" program that is called by the plugin during
2222 backup to read the data. {\bf bpipe} will call this program by doing a
2225 \item {\bf field4} for the {\bf bpipe} plugin
2226 specifies the "writer" program that is called by the plugin during
2227 restore to write the data back to the filesystem.
2230 Please note that for two items above describing the "reader" and "writer"
2231 fields, these programs are "executed" by Bacula, which
2232 means there is no shell interpretation of any command line arguments
2233 you might use. If you want to use shell characters (redirection of input
2234 or output, ...), then we recommend that you put your command or commands
2235 in a shell script and execute the script. In addition if you backup a
2236 file with the reader program, when running the writer program during
2237 the restore, Bacula will not automatically create the path to the file.
2238 Either the path must exist, or you must explicitly do so with your command
2239 or in a shell script.
2241 Putting it all together, the full plugin directive line might look
2245 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2246 --opt --databases bacula:mysql"
2249 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2250 would be written on a single line.
2252 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2253 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2254 program {\bf mysqldump -f --opt --database bacula} to read the data during
2255 backup. The mysqldump command outputs all the data for the database named
2256 {\bf bacula}, which will be read by the plugin and stored in the backup.
2257 During restore, the data that was backed up will be sent to the program
2258 specified in the last field, which in this case is {\bf mysql}. When
2259 {\bf mysql} is called, it will read the data sent to it by the plugn
2260 then write it back to the same database from which it came ({\bf bacula}
2263 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2264 the data from a specified program to Bacula for backup, and then from Bacula to
2265 a specified program for restore.
2267 By using different command lines to {\bf bpipe},
2268 you can backup any kind of data (ASCII or binary) depending
2269 on the program called.
2271 \section{Microsoft Exchange Server 2003/2007 Plugin}
2272 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2273 \subsection{Background}
2274 The Exchange plugin was made possible by a funded development project
2275 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2276 The code for the plugin was written by James Harper, and the Bacula core
2277 code by Kern Sibbald. All the code for this funded development has become
2278 part of the Bacula project. Thanks to everyone who made it happen.
2280 \subsection{Concepts}
2281 Although it is possible to backup Exchange using Bacula VSS the Exchange
2282 plugin adds a good deal of functionality, because while Bacula VSS
2283 completes a full backup (snapshot) of Exchange, it does
2284 not support Incremental or Differential backups, restoring is more
2285 complicated, and a single database restore is not possible.
2287 Microsoft Exchange organises its storage into Storage Groups with
2288 Databases inside them. A default installation of Exchange will have a
2289 single Storage Group called 'First Storage Group', with two Databases
2290 inside it, "Mailbox Store (SERVER NAME)" and
2291 "Public Folder Store (SERVER NAME)",
2292 which hold user email and public folders respectively.
2294 In the default configuration, Exchange logs everything that happens to
2295 log files, such that if you have a backup, and all the log files since,
2296 you can restore to the present time. Each Storage Group has its own set
2297 of log files and operates independently of any other Storage Groups. At
2298 the Storage Group level, the logging can be turned off by enabling a
2299 function called "Enable circular logging". At this time the Exchange
2300 plugin will not function if this option is enabled.
2302 The plugin allows backing up of entire storage groups, and the restoring
2303 of entire storage groups or individual databases. Backing up and
2304 restoring at the individual mailbox or email item is not supported but
2305 can be simulated by use of the "Recovery" Storage Group (see below).
2307 \subsection{Installing}
2308 The Exchange plugin requires a DLL that is shipped with Microsoft
2309 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2310 correctly the Exchange plugin should find this automatically and run
2311 without any additional installation.
2313 If the DLL can not be found automatically it will need to be copied into
2314 the Bacula installation
2315 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2316 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2317 default Exchange installation.
2319 \subsection{Backing Up}
2320 To back up an Exchange server the Fileset definition must contain at
2321 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2322 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2323 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2324 up files are prefixed with something that isn't going to share a name
2325 with something outside the plugin, and the 'Microsoft Information Store'
2326 bit is required also. It is also possible to add the name of a storage
2327 group to the "Plugin =" line, eg \\
2328 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2329 if you want only a single storage group backed up.
2331 Additionally, you can suffix the 'Plugin =' directive with
2332 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2333 database at the end of a full backup.
2335 An Incremental or Differential backup will backup only the database logs
2336 for each Storage Group by inspecting the "modified date" on each
2337 physical log file. Because of the way the Exchange API works, the last
2338 logfile backed up on each backup will always be backed up by the next
2339 Incremental or Differential backup too. This adds 5MB to each
2340 Incremental or Differential backup size but otherwise does not cause any
2343 By default, a normal VSS fileset containing all the drive letters will
2344 also back up the Exchange databases using VSS. This will interfere with
2345 the plugin and Exchange's shared ideas of when the last full backup was
2346 done, and may also truncate log files incorrectly. It is important,
2347 therefore, that the Exchange database files be excluded from the backup,
2348 although the folders the files are in should be included, or they will
2349 have to be recreated manually if a baremetal restore is done.
2354 File = C:/Program Files/Exchsrvr/mdbdata
2355 Plugin = "exchange:..."
2358 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2359 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2360 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2361 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2362 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2363 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2364 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2369 The advantage of excluding the above files is that you can significantly
2370 reduce the size of your backup since all the important Exchange files
2371 will be properly saved by the Plugin.
2374 \subsection{Restoring}
2375 The restore operation is much the same as a normal Bacula restore, with
2376 the following provisos:
2379 \item The {\bf Where} restore option must not be specified
2380 \item Each Database directory must be marked as a whole. You cannot just
2381 select (say) the .edb file and not the others.
2382 \item If a Storage Group is restored, the directory of the Storage Group
2384 \item It is possible to restore only a subset of the available log files,
2385 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2386 if a log file is missing from the sequence of log files
2387 \item Each database to be restored must be dismounted and marked as "Can be
2388 overwritten by restore"
2389 \item If an entire Storage Group is to be restored (eg all databases and
2390 logs in the Storage Group), then it is best to manually delete the
2391 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2392 as Exchange can get confused by stray log files lying around.
2395 \subsection{Restoring to the Recovery Storage Group}
2396 The concept of the Recovery Storage Group is well documented by
2398 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2399 but to briefly summarize...
2401 Microsoft Exchange allows the creation of an additional Storage Group
2402 called the Recovery Storage Group, which is used to restore an older
2403 copy of a database (e.g. before a mailbox was deleted) into without
2404 messing with the current live data. This is required as the Standard and
2405 Small Business Server versions of Exchange can not ordinarily have more
2406 than one Storage Group.
2408 To create the Recovery Storage Group, drill down to the Server in Exchange
2409 System Manager, right click, and select
2410 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2411 locations and click OK. On the Recovery Storage Group, right click and
2412 select {\bf "Add Database to Recover..."} and select the database you will
2415 Restore only the single database nominated as the database in the
2416 Recovery Storage Group. Exchange will redirect the restore to the
2417 Recovery Storage Group automatically.
2418 Then run the restore.
2420 \subsection{Restoring on Microsoft Server 2007}
2421 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2422 2007, and henc you use a new proceedure for recovering a single mail box.
2423 This procedure is ducomented by Microsoft at:
2424 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2425 and involves using the {\bf Restore-Mailbox} and {\bf
2426 Get-MailboxStatistics} shell commands.
2428 \subsection{Caveats}
2429 This plugin is still being developed, so you should consider it
2430 currently in BETA test, and thus use in a production environment
2431 should be done only after very careful testing.
2433 When doing a full backup, the Exchange database logs are truncated by
2434 Exchange as soon as the plugin has completed the backup. If the data
2435 never makes it to the backup medium (eg because of spooling) then the
2436 logs will still be truncated, but they will also not have been backed
2437 up. A solution to this is being worked on. You will have to schedule a
2438 new Full backup to ensure that your next backups will be usable.
2440 The "Enable Circular Logging" option cannot be enabled or the plugin
2443 Exchange insists that a successful Full backup must have taken place if
2444 an Incremental or Differential backup is desired, and the plugin will
2445 fail if this is not the case. If a restore is done, Exchange will
2446 require that a Full backup be done before an Incremental or Differential
2449 The plugin will most likely not work well if another backup application
2450 (eg NTBACKUP) is backing up the Exchange database, especially if the
2451 other backup application is truncating the log files.
2453 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2454 we recommend either carefully testing or that you avoid this option for
2457 The Exchange plugin is not called during processing the bconsole {\bf
2458 estimate} command, and so anything that would be backed up by the plugin
2459 will not be added to the estimate total that is displayed.
2462 \section{libdbi Framework}
2463 \index[general]{libdbi Framework}
2464 As a general guideline, Bacula has support for a few catalog database drivers
2465 (MySQL, PostgreSQL, SQLite)
2466 coded natively by the Bacula team. With the libdbi implementation, which is a
2467 Bacula driver that uses libdbi to access the catalog, we have an open field to
2468 use many different kinds database engines following the needs of users.
2470 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2471 implements a database-independent abstraction layer in C, similar to the
2472 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2473 leverage the power of multiple databases and multiple simultaneous database
2474 connections by using this framework.
2476 Currently the libdbi driver in Bacula project only supports the same drivers
2477 natively coded in Bacula. However the libdbi project has support for many
2478 others database engines. You can view the list at
2479 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2480 supported by Bacula, however, they must be tested properly by the Bacula team.
2482 Some of benefits of using libdbi are:
2484 \item The possibility to use proprietary databases engines in which your
2485 proprietary licenses prevent the Bacula team from developing the driver.
2486 \item The possibility to use the drivers written for the libdbi project.
2487 \item The possibility to use other database engines without recompiling Bacula
2488 to use them. Just change one line in bacula-dir.conf
2489 \item Abstract Database access, this is, unique point to code and profiling
2490 catalog database access.
2493 The following drivers have been tested:
2495 \item PostgreSQL, with and without batch insert
2496 \item Mysql, with and without batch insert
2501 In the future, we will test and approve to use others databases engines
2502 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2504 To compile Bacula to support libdbi we need to configure the code with the
2505 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2506 [database] is the database engine to be used with Bacula (of course we can
2507 change the driver in file bacula-dir.conf, see below). We must configure the
2508 access port of the database engine with the option --with-db-port, because the
2509 libdbi framework doesn't know the default access port of each database.
2511 The next phase is checking (or configuring) the bacula-dir.conf, example:
2515 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2516 dbname = regress; user = regress; password = ""
2520 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2521 mysql database. Currently the drivers supported by Bacula are: postgresql,
2522 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2524 The following limitations apply when Bacula is set to use the libdbi framework:
2525 - Not tested on the Win32 platform
2526 - A little performance is lost if comparing with native database driver.
2527 The reason is bound with the database driver provided by libdbi and the
2528 simple fact that one more layer of code was added.
2530 It is important to remember, when compiling Bacula with libdbi, the
2531 following packages are needed:
2533 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2534 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2537 You can download them and compile them on your system or install the packages
2538 from your OS distribution.
2540 \section{Console Command Additions and Enhancements}
2541 \index[general]{Console Additions}
2543 \subsection{Display Autochanger Content}
2544 \index[general]{StatusSlots}
2546 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2547 autochanger content.
2551 Slot | Volume Name | Status | Media Type | Pool |
2552 ------+---------------+----------+-------------------+------------|
2553 1 | 00001 | Append | DiskChangerMedia | Default |
2554 2 | 00002 | Append | DiskChangerMedia | Default |
2555 3*| 00003 | Append | DiskChangerMedia | Scratch |
2560 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2561 {\bf update slots} command to synchronize autochanger content with your
2564 \subsection{list joblog job=xxx or jobid=nnn}
2565 \index[general]{list joblog}
2566 A new list command has been added that allows you to list the contents
2567 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2568 or for a particular JobId. The {\bf llist} command will include a line with
2569 the time and date of the entry.
2571 Note for the catalog to have Job Log entries, you must have a directive
2578 In your Director's {\bf Messages} resource.
2580 \subsection{Use separator for multiple commands}
2581 \index[general]{Command Separator}
2582 When using bconsole with readline, you can set the command separator with
2583 \textbf{@separator} command to one
2584 of those characters to write commands who require multiple input in one line.
2586 !$%&'()*+,-/:;<>?[]^`{|}~
2589 \subsection{Deleting Volumes}
2590 The delete volume bconsole command has been modified to
2591 require an asterisk (*) in front of a MediaId otherwise the
2592 value you enter is a taken to be a Volume name. This is so that
2593 users may delete numeric Volume names. The previous Bacula versions
2594 assumed that all input that started with a number was a MediaId.
2596 This new behavior is indicated in the prompt if you read it
2599 \section{Bare Metal Recovery}
2600 The old bare metal recovery project is essentially dead. One
2601 of the main features of it was that it would build a recovery
2602 CD based on the kernel on your system. The problem was that
2603 every distribution has a different boot procedure and different
2604 scripts, and worse yet, the boot procedures and scripts change
2605 from one distribution to another. This meant that maintaining
2606 (keeping up with the changes) the rescue CD was too much work.
2608 To replace it, a new bare metal recovery USB boot stick has been developed
2609 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2610 boot from a USB key.
2614 \item Recovery can be done from within graphical environment.
2615 \item Recovery can be done in a shell.
2616 \item Ubuntu boots on a large number of Linux systems.
2617 \item The process of updating the system and adding new
2618 packages is not too difficult.
2619 \item The USB key can easily be upgraded to newer Ubuntu versions.
2620 \item The USB key has writable partitions for modifications to
2621 the OS and for modification to your home directory.
2622 \item You can add new files/directories to the USB key very easily.
2623 \item You can save the environment from multiple machines on
2625 \item Bacula Systems is funding its ongoing development.
2628 The disadvantages are:
2630 \item The USB key is usable but currently under development.
2631 \item Not everyone may be familiar with Ubuntu (no worse
2633 \item Some older OSes cannot be booted from USB. This can
2634 be resolved by first booting a Ubuntu LiveCD then plugging
2636 \item Currently the documentation is sketchy and not yet added
2637 to the main manual. See below ...
2640 The documentation and the code can be found in the {\bf rescue} package
2641 in the directory {\bf linux/usb}.
2643 \section{Miscellaneous}
2644 \index[general]{Misc New Features}
2646 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2647 \index[general]{Allow Mixed Priority}
2648 This directive is only implemented in version 2.5 and later. When
2649 set to {\bf yes} (default {\bf no}), this job may run even if lower
2650 priority jobs are already running. This means a high priority job
2651 will not have to wait for other jobs to finish before starting.
2652 The scheduler will only mix priorities when all running jobs have
2655 Note that only higher priority jobs will start early. Suppose the
2656 director will allow two concurrent jobs, and that two jobs with
2657 priority 10 are running, with two more in the queue. If a job with
2658 priority 5 is added to the queue, it will be run as soon as one of
2659 the running jobs finishes. However, new priority 10 jobs will not
2660 be run until the priority 5 job has finished.
2662 \subsection{Bootstrap File Directive -- FileRegex}
2663 \index[general]{Bootstrap File Directive}
2664 {\bf FileRegex} is a new command that can be added to the bootstrap
2665 (.bsr) file. The value is a regular expression. When specified, only
2666 matching filenames will be restored.
2668 During a restore, if all File records are pruned from the catalog
2669 for a Job, normally Bacula can restore only all files saved. That
2670 is there is no way using the catalog to select individual files.
2671 With this new feature, Bacula will ask if you want to specify a Regex
2672 expression for extracting only a part of the full backup.
2675 Building directory tree for JobId(s) 1,3 ...
2676 There were no files inserted into the tree, so file selection
2677 is not possible.Most likely your retention policy pruned the files
2679 Do you want to restore all the files? (yes\vb{}no): no
2681 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2682 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2685 \subsection{Bootstrap File Optimization Changes}
2686 In order to permit proper seeking on disk files, we have extended the bootstrap
2687 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2688 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2689 address range and end address range respectively. These two directives replace
2690 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2691 VolEndBlock} directives. Bootstrap files containing the old directives will
2692 still work, but will not properly take advantage of proper disk seeking, and
2693 may read completely to the end of a disk volume during a restore. With the new
2694 format (automatically generated by the new Director), restores will seek
2695 properly and stop reading the volume when all the files have been restored.
2697 \subsection{Solaris ZFS/NFSv4 ACLs}
2698 This is an upgrade of the previous Solaris ACL backup code
2699 to the new library format, which will backup both the old
2700 POSIX(UFS) ACLs as well as the ZFS ACLs.
2702 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2703 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2704 be used to transfer from UFS to ZFS filesystems.
2707 \subsection{Virtual Tape Emulation}
2708 \index[general]{Virtual Tape Emulation}
2709 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2710 the tape code but actually reading and writing to a disk file. Used with the
2711 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2712 and 700 slots. This feature is most useful in testing. It is enabled
2713 by using {\bf Device Type = vtape} in the Storage daemon's Device
2714 directive. This feature is only implemented on Linux machines and should not be
2715 used for production.
2717 \subsection{Bat Enhancements}
2718 \index[general]{Bat Enhancements}
2719 Bat (the Bacula Administration Tool) GUI program has been significantly
2720 enhanced and stabilized. In particular, there are new table based status
2721 commands; it can now be easily localized using Qt4 Linguist.
2723 The Bat communications protocol has been significantly enhanced to improve
2724 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2725 the Director you are using otherwise the communications protocol will not
2728 \subsection{RunScript Enhancements}
2729 \index[general]{RunScript Enhancements}
2730 The {\bf RunScript} resource has been enhanced to permit multiple
2731 commands per RunScript. Simply specify multiple {\bf Command} directives
2738 Command = "/bin/echo test"
2739 Command = "/bin/echo an other test"
2740 Command = "/bin/echo 3 commands in the same runscript"
2747 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2748 implemented, which runs the command after the Volume Shadow Copy has been made.
2750 Console commands can be specified within a RunScript by using:
2751 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2752 carefully tested and debugged and is known to easily crash the Director.
2753 We would appreciate feedback. Due to the recursive nature of this command, we
2754 may remove it before the final release.
2756 \subsection{Status Enhancements}
2757 \index[general]{Status Enhancements}
2758 The bconsole {\bf status dir} output has been enhanced to indicate
2759 Storage daemon job spooling and despooling activity.
2761 \subsection{Connect Timeout}
2762 \index[general]{Connect Timeout}
2763 The default connect timeout to the File
2764 daemon has been set to 3 minutes. Previously it was 30 minutes.
2766 \subsection{ftruncate for NFS Volumes}
2767 \index[general]{ftruncate for NFS Volumes}
2768 If you write to a Volume mounted by NFS (say on a local file server),
2769 in previous Bacula versions, when the Volume was recycled, it was not
2770 properly truncated because NFS does not implement ftruncate (file
2771 truncate). This is now corrected in the new version because we have
2772 written code (actually a kind user) that deletes and recreates the Volume,
2773 thus accomplishing the same thing as a truncate.
2775 \subsection{Support for Ubuntu}
2776 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2777 version of Linux, and thus now provides correct autostart routines.
2778 Since Ubuntu officially supports Bacula, you can also obtain any
2779 recent release of Bacula from the Ubuntu repositories.
2781 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2782 \index[general]{Recycle Pool}
2783 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2784 be placed (moved) when it is recycled. Without this directive, a Volume will
2785 remain in the same pool when it is recycled. With this directive, it can be
2786 moved automatically to any existing pool during a recycle. This directive is
2787 probably most useful when defined in the Scratch pool, so that volumes will
2788 be recycled back into the Scratch pool.
2790 \subsection{FD Version}
2791 \index[general]{FD Version}
2792 The File daemon to Director protocol now includes a version
2793 number, which although there is no visible change for users,
2794 will help us in future versions automatically determine
2795 if a File daemon is not compatible.
2797 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2798 \index[general]{Max Run Sched Time}
2799 The time specifies the maximum allowed time that a job may run, counted from
2800 when the job was scheduled. This can be useful to prevent jobs from running
2801 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2804 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2805 \index[general]{Max Wait Time}
2806 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2807 of checking the maximum allowed time that a job may block for a resource,
2808 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2809 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2810 their job depending on the level. Now, they have to use
2811 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2812 directives are now deprecated.
2814 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2815 \index[general]{Incremental Max Wait Time}
2816 \index[general]{Differential Max Wait Time}
2818 These directives have been deprecated in favor of
2819 \texttt{Incremental|Differential Max Run Time}.
2821 \subsection{Max Run Time directives}
2822 \index[general]{Max Run Time directives}
2823 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2824 maximum allowed time that a job can run depending on the level.
2826 \addcontentsline{lof}{figure}{Job time control directives}
2827 \includegraphics{\idir different_time.eps}
2829 \subsection{Statistics Enhancements}
2830 \index[general]{Statistics Enhancements}
2831 If you (or probably your boss) want to have statistics on your backups to
2832 provide some \textit{Service Level Agreement} indicators, you could use a few
2833 SQL queries on the Job table to report how many:
2837 \item jobs have been successful
2838 \item files have been backed up
2842 However, these statistics are accurate only if your job retention is greater
2843 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2844 be able to use them.
2846 Now, you can use the \textbf{update stats [days=num]} console command to fill
2847 the JobHistory table with new Job records. If you want to be sure to take in
2848 account only \textbf{good jobs}, ie if one of your important job has failed but
2849 you have fixed the problem and restarted it on time, you probably want to
2850 delete the first \textit{bad} job record and keep only the successful one. For
2851 that simply let your staff do the job, and update JobHistory table after two or
2852 three days depending on your organization using the \textbf{[days=num]} option.
2854 These statistics records aren't used for restoring, but mainly for
2855 capacity planning, billings, etc.
2857 The Bweb interface provides a statistics module that can use this feature. You
2858 can also use tools like Talend or extract information by yourself.
2860 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2861 the length of time that Bacula will keep statistics job records in the Catalog
2862 database after the Job End time. (In \texttt{JobHistory} table) When this time
2863 period expires, and if user runs \texttt{prune stats} command, Bacula will
2864 prune (remove) Job records that are older than the specified period.
2866 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2867 job to maintain statistics.
2870 Name = BackupCatalog
2873 Console = "update stats days=3"
2874 Console = "prune stats yes"
2881 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2882 \index[general]{ScratchPool}
2883 This directive permits to specify a specific \textsl{Scratch} pool for the
2884 current pool. This is useful when using multiple storage sharing the same
2885 mediatype or when you want to dedicate volumes to a particular set of pool.
2887 \subsection{Enhanced Attribute Despooling}
2888 \index[general]{Attribute Despooling}
2889 If the storage daemon and the Director are on the same machine, the spool file
2890 that contains attributes is read directly by the Director instead of being
2891 transmitted across the network. That should reduce load and speedup insertion.
2893 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2894 \index[general]{SpoolSize}
2895 A new Job directive permits to specify the spool size per job. This is used
2896 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2898 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2899 \index[general]{MaximumConsoleConnections}
2900 A new director directive permits to specify the maximum number of Console
2901 Connections that could run concurrently. The default is set to 20, but you may
2902 set it to a larger number.
2904 \subsection{VerId = \lt{}string\gt{}}
2905 \index[general]{VerId}
2906 A new director directive permits to specify a personnal identifier that will be
2907 displayed in the \texttt{version} command.
2909 \subsection{dbcheck enhancements}
2910 \index[general]{dbcheck enhancements}
2911 If you are using Mysql, dbcheck will now ask you if you want to create
2912 temporary indexes to speed up orphaned Path and Filename elimination.
2914 A new \texttt{-B} option allows you to print catalog information in a simple
2915 text based format. This is useful to backup it in a secure way.
2930 You can now specify the database connection port in the command line.
2932 \subsection{{-}{-}docdir configure option}
2933 \index[general]{{-}{-}docdir configure option}
2934 You can use {-}{-}docdir= on the ./configure command to
2935 specify the directory where you want Bacula to install the
2936 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2937 {\bf /usr/share/doc/bacula}.
2939 \subsection{{-}{-}htmldir configure option}
2940 \index[general]{{-}{-}htmldir configure option}
2941 You can use {-}{-}htmldir= on the ./configure command to
2942 specify the directory where you want Bacula to install the bat html help
2943 files. The default is {\bf /usr/share/doc/bacula/html}
2945 \subsection{{-}{-}with-plugindir configure option}
2946 \index[general]{{-}{-}plugindir configure option}
2947 You can use {-}{-}plugindir= on the ./configure command to
2948 specify the directory where you want Bacula to install
2949 the plugins (currently only bpipe-fd). The default is