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 \section{New Features in 5.2.14}
7 \subsection{Director job Codes in Message Resource Commands}
8 Before submitting the specified mail command to the operating system, Bacula
9 performs character substitution like in Runscript commands. Bacula will now
10 perform also specific Director character substitution.
13 The code for this feature was contributed by Bastian Friedrich.
15 \subsection{Additions to RunScript variables}
16 The following variables are now available in runscripts:
18 \item current PID using \%P
19 \item if the job is a clone job using \%C
23 RunAfterJob = "/bin/echo Pid=%P isCloned=%C"
26 \section{New Features in 5.2.2}
27 This chapter presents the new features that have been added to the current
28 Community version of Bacula that is now released.
30 \subsection{Additions to RunScript variables}
31 You can have access to Director name using \%D in your runscript
35 RunAfterJob = "/bin/echo Director=%D
38 \section{New Features in 5.2.1}
39 This chapter presents the new features were added in the
40 Community release version 5.2.1.
42 There are additional features (plugins) available in the Enterprise version
43 that are described in another chapter. A subscription to Bacula Systems
44 is required for the Enterprise version.
46 \subsection{LZO Compression}
48 LZO compression has been to the File daemon. From the user's point of view,
49 it works like the GZIP compression (just replace {\bf compression=GZIP} with
50 {\bf compression=LZO}).
55 Options {compression=LZO }
61 LZO provides a much faster compression and decompression speed but lower
62 compression ratio than GZIP. It is a good option when you backup to disk. For
63 tape, the hardware compression is almost always a better option.
65 LZO is a good alternative for GZIP1 when you don't want to slow down your
66 backup. With a modern CPU it should be able to run almost as fast as:
69 \item your client can read data from disk. Unless you have very fast disks like
70 SSD or large/fast RAID array.
71 \item the data transfers between the file daemon and the storage daemon even on
75 Note, Bacula uses compression level LZO1X-1.
78 The code for this feature was contributed by Laurent Papier.
80 \subsection{New Tray Monitor}
82 Since the old integrated Windows tray monitor doesn't work with
83 recent Windows versions, we have written a new Qt Tray Monitor that is available
84 for both Linux and Windows. In addition to all the previous features,
85 this new version allows you to run Backups from
86 the tray monitor menu.
90 \includegraphics[width=0.8\linewidth]{tray-monitor}
91 \label{fig:traymonitor}
92 \caption{New tray monitor}
97 \includegraphics[width=0.8\linewidth]{tray-monitor1}
98 \label{fig:traymonitor1}
99 \caption{Run a Job through the new tray monitor}
103 To be able to run a job from the tray monitor, you need to
104 allow specific commands in the Director monitor console:
109 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
110 ClientACL = *all* # you can restrict to a specific host
122 This project was funded by Bacula Systems and is available with Bacula
123 the Enterprise Edition and the Community Edition.
125 \subsection{Purge Migration Job}
127 The new {\bf Purge Migration Job} directive may be added to the Migration
128 Job definition in the Director's configuration file. When it is enabled
129 the Job that was migrated during a migration will be purged at
130 the end of the migration job.
138 Client = localhost-fd
141 Storage = DiskChanger
144 Selection Pattern = ".*Save"
146 Purge Migration Job = yes
152 This project was submitted by Dunlap Blake; testing and documentation was funded
155 \subsection{Changes in Bvfs (Bacula Virtual FileSystem)}
157 Bat has now a bRestore panel that uses Bvfs to display files and
162 \includegraphics[width=0.8\linewidth]{bat-brestore}
163 \label{fig:batbrestore}
164 \caption{Bat Brestore Panel}
167 the Bvfs module works correctly with BaseJobs, Copy and Migration jobs.
170 This project was funded by Bacula Systems.
172 \subsubsection*{General notes}
175 \item All fields are separated by a tab
176 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
177 records in very big directories
178 \item All operations (except cache creation) are designed to run instantly
179 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
180 can contribute new faster SQL queries we will be happy, else don't complain
182 \item The cache creation is dependent of the number of directories. As Bvfs
183 shares information across jobs, the first creation can be slow
184 \item All fields are separated by a tab
185 \item Due to potential encoding problem, it's advised to always use pathid in
189 \subsubsection*{Get dependent jobs from a given JobId}
191 Bvfs allows you to query the catalog against any combination of jobs. You
192 can combine all Jobs and all FileSet for a Client in a single session.
194 To get all JobId needed to restore a particular job, you can use the
195 \texttt{.bvfs\_get\_jobids} command.
198 .bvfs_get_jobids jobid=num [all]
202 .bvfs_get_jobids jobid=10
204 .bvfs_get_jobids jobid=10 all
208 In this example, a normal restore will need to use JobIds 1,2,5,10 to
209 compute a complete restore of the system.
211 With the \texttt{all} option, the Director will use all defined FileSet for
214 \subsubsection*{Generating Bvfs cache}
216 The \texttt{.bvfs\_update} command computes the directory cache for jobs
217 specified in argument, or for all jobs if unspecified.
220 .bvfs_update [jobid=numlist]
225 .bvfs_update jobid=1,2,3
228 You can run the cache update process in a RunScript after the catalog backup.
230 \subsubsection*{Get all versions of a specific file}
232 Bvfs allows you to find all versions of a specific file for a given Client with
233 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
234 function uses only PathId and FilenameId. The jobid argument is mandatory but
238 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
239 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
240 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
247 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
248 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
251 \subsubsection*{List directories}
253 Bvfs allows you to list directories in a specific path.
255 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
256 PathId FilenameId FileId JobId LStat Path
257 PathId FilenameId FileId JobId LStat Path
258 PathId FilenameId FileId JobId LStat Path
262 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
263 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
264 listed is a directory.
267 .bvfs_lsdirs pathid=4 jobid=1,11,12
268 4 0 0 0 A A A A A A A A A A A A A A .
269 5 0 0 0 A A A A A A A A A A A A A A ..
270 3 0 0 0 A A A A A A A A A A A A A A regress/
273 In this example, to list directories present in \texttt{regress/}, you can use
275 .bvfs_lsdirs pathid=3 jobid=1,11,12
276 3 0 0 0 A A A A A A A A A A A A A A .
277 4 0 0 0 A A A A A A A A A A A A A A ..
278 2 0 0 0 A A A A A A A A A A A A A A tmp/
281 \subsubsection*{List files}
283 Bvfs allows you to list files in a specific path.
285 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
286 PathId FilenameId FileId JobId LStat Path
287 PathId FilenameId FileId JobId LStat Path
288 PathId FilenameId FileId JobId LStat Path
292 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
293 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
297 .bvfs_lsfiles pathid=4 jobid=1,11,12
298 4 0 0 0 A A A A A A A A A A A A A A .
299 5 0 0 0 A A A A A A A A A A A A A A ..
300 1 0 0 0 A A A A A A A A A A A A A A regress/
303 In this example, to list files present in \texttt{regress/}, you can use
305 .bvfs_lsfiles pathid=1 jobid=1,11,12
306 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
307 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
308 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
309 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
310 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
313 \subsubsection*{Restore set of files}
315 Bvfs allows you to create a SQL table that contains files that you want to
316 restore. This table can be provided to a restore command with the file option.
319 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
321 restore file=?b2num ...
324 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
325 select all files. This query could be time consuming.
327 \texttt{hardlink} list is always composed of a series of two numbers (jobid,
328 fileindex). This information can be found in the LinkFI field of the LStat
331 The \texttt{path} argument represents the name of the table that Bvfs will
332 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
333 b2 and followed by digits).
338 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
342 \subsubsection*{Cleanup after Restore}
344 To drop the table used by the restore command, you can use the
345 \texttt{.bvfs\_cleanup} command.
348 .bvfs_cleanup path=b20001
351 \subsubsection*{Clearing the BVFS Cache}
353 To clear the BVFS cache, you can use the \texttt{.bvfs\_clear\_cache} command.
356 .bvfs_clear_cache yes
360 \subsection{Changes in the Pruning Algorithm}
362 We rewrote the job pruning algorithm in this version. Previously, in some users
363 reported that the pruning process at the end of jobs was very long. It should
364 not be longer the case. Now, Bacula won't prune automatically a Job if this
365 particular Job is needed to restore data. Example:
369 JobId: 2 Level: Incremental
370 JobId: 3 Level: Incremental
371 JobId: 4 Level: Differential
372 .. Other incrementals up to now
375 In this example, if the Job Retention defined in the Pool or in the Client
376 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
377 detect that JobId 1 and 4 are essential to restore data at the current state
378 and will prune only JobId 2 and 3.
380 \texttt{Important}, this change affect only the automatic pruning step after a
381 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
382 \texttt{VolumeRetention} period, important jobs can be pruned.
384 \subsection{Ability to Verify any specified Job}
385 You now have the ability to tell Bacula which Job should verify instead of
386 automatically verify just the last one.
388 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
390 To verify a given job, just specify the Job jobid in argument when starting the
393 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
395 JobName: VerifyVolume
396 Level: VolumeToCatalog
399 Pool: Default (From Job resource)
400 Storage: File (From Job resource)
401 Verify Job: VerifyVol.2010-09-08_14.17.17_03
402 Verify List: /tmp/regress/working/VerifyVol.bsr
403 When: 2010-09-08 14:17:31
405 OK to run? (yes/mod/no):
409 This project was funded by Bacula Systems and is available with Bacula
410 Enterprise Edition and Community Edition.
412 \subsection{Additions to RunScript variables}
413 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
414 command. The Client address is now available through \%h.
417 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
420 %\subsection{Changes in drivetype.exe}
422 %Now the \texttt{drivetype.exe} program allows you to list all local hard
423 %drives. It can help to build dynamic FileSet on Windows.
426 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
430 \subsection{Additions to the Plugin API}
431 The bfuncs structure has been extended to include a number of
434 \subsubsection{bfuncs}
435 The bFuncs structure defines the callback entry points within Bacula
436 that the plugin can use register events, get Bacula values, set
437 Bacula values, and send messages to the Job output or debug output.
439 The exact definition as of this writing is:
441 typedef struct s_baculaFuncs {
444 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
445 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
446 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
447 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
448 int type, utime_t mtime, const char *fmt, ...);
449 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
450 int level, const char *fmt, ...);
451 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
453 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
455 /* New functions follow */
456 bRC (*AddExclude)(bpContext *ctx, const char *file);
457 bRC (*AddInclude)(bpContext *ctx, const char *file);
458 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
459 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
460 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
461 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
467 \item [AddExclude] can be called to exclude a file. The file
468 string passed may include wildcards that will be interpreted by
469 the {\bf fnmatch} subroutine. This function can be called
470 multiple times, and each time the file specified will be added
471 to the list of files to be excluded. Note, this function only
472 permits adding excludes of specific file or directory names,
473 or files matched by the rather simple fnmatch mechanism.
474 See below for information on doing wild-card and regex excludes.
476 \item [NewPreInclude] can be called to create a new Include block. This
477 block will be added after the current defined Include block. This
478 function can be called multiple times, but each time, it will create
479 a new Include section (not normally needed). This function should
480 be called only if you want to add an entirely new Include block.
482 \item [NewInclude] can be called to create a new Include block. This
483 block will be added before any user defined Include blocks. This
484 function can be called multiple times, but each time, it will create
485 a new Include section (not normally needed). This function should
486 be called only if you want to add an entirely new Include block.
488 \item [AddInclude] can be called to add new files/directories to
489 be included. They are added to the current Include block. If
490 NewInclude has not been included, the current Include block is
491 the last one that the user created. This function
492 should be used only if you want to add totally new files/directories
493 to be included in the backup.
495 \item [NewOptions] adds a new Options block to the current Include
496 in front of any other Options blocks. This permits the plugin to
497 add exclude directives (wild-cards and regexes) in front of the
498 user Options, and thus prevent certain files from being backed up.
499 This can be useful if the plugin backs up files, and they should
500 not be also backed up by the main Bacula code. This function
501 may be called multiple times, and each time, it creates a new
502 prepended Options block. Note: normally you want to call this
503 entry point prior to calling AddOptions, AddRegex, or AddWild.
505 \item [AddOptions] allows the plugin it set options in
506 the current Options block, which is normally created with the
507 NewOptions call just prior to adding Include Options.
508 The permitted options are passed as a character string, where
509 each character has a specific meaning as defined below:
512 \item [a] always replace files (default).
513 \item [e] exclude rather than include.
514 \item [h] no recursion into subdirectories.
515 \item [H] do not handle hard links.
516 \item [i] ignore case in wildcard and regex matches.
517 \item [M] compute an MD5 sum.
518 \item [p] use a portable data format on Windows (not recommended).
519 \item [R] backup resource forks and Findr Info.
520 \item [r] read from a fifo
521 \item [S1] compute an SHA1 sum.
522 \item [S2] compute an SHA256 sum.
523 \item [S3] comput an SHA512 sum.
524 \item [s] handle sparse files.
525 \item [m] use st\_mtime only for file differences.
526 \item [k] restore the st\_atime after accessing a file.
527 \item [A] enable ACL backup.
528 \item [Vxxx:] specify verify options. Must terminate with :
529 \item [Cxxx:] specify accurate options. Must terminate with :
530 \item [Jxxx:] specify base job Options. Must terminate with :
531 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
533 \item [Zn] specify gzip compression level n.
534 \item [K] do not use st\_atime in backup decision.
535 \item [c] check if file changed during backup.
536 \item [N] honor no dump flag.
537 \item [X] enable backup of extended attributes.
540 \item [AddRegex] adds a regex expression to the current Options block.
541 The following options are permitted:
543 \item [ ] (a blank) regex applies to whole path and filename.
544 \item [F] regex applies only to the filename (directory or path stripped).
545 \item [D] regex applies only to the directory (path) part of the name.
548 \item [AddWild] adds a wildcard expression to the current Options block.
549 The following options are permitted:
551 \item [ ] (a blank) regex applies to whole path and filename.
552 \item [F] regex applies only to the filename (directory or path stripped).
553 \item [D] regex applies only to the directory (path) part of the name.
556 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
557 that can use Accurate code to compare the file information in argument with
558 the previous file information. The \texttt{delta\_seq} attribute of the
559 \texttt{save\_pkt} will be updated, and the call will return
560 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
565 \subsubsection{Bacula events}
566 The list of events has been extended to include:
572 bEventStartBackupJob = 3,
573 bEventEndBackupJob = 4,
574 bEventStartRestoreJob = 5,
575 bEventEndRestoreJob = 6,
576 bEventStartVerifyJob = 7,
577 bEventEndVerifyJob = 8,
578 bEventBackupCommand = 9,
579 bEventRestoreCommand = 10,
584 bEventCancelCommand = 13,
585 bEventVssBackupAddComponents = 14,
586 bEventVssRestoreLoadComponentMetadata = 15,
587 bEventVssRestoreSetComponentsSelected = 16,
588 bEventRestoreObject = 17,
589 bEventEndFileSet = 18,
590 bEventPluginCommand = 19,
591 bEventVssBeforeCloseRestore = 20,
592 bEventVssPrepareSnapshot = 21
598 \item [bEventCancelCommand] is called whenever the currently
599 running Job is canceled */
601 \item [bEventVssBackupAddComponents]
603 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
604 provides a char[27] table where the plugin can add Windows drives that will
605 be used during the Job. You need to add them without duplicates, and you can
606 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
610 \subsection{ACL enhancements}
612 The following enhancements are made to the Bacula Filed with regards to
613 Access Control Lists (ACLs)
616 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
617 POSIX and NFSv4 ACLs.
618 \item Added support for new acl types on FreeBSD 8.1 and later which supports
619 POSIX and NFSv4 ACLs.
620 \item Some generic cleanups for internal ACL handling.
621 \item Fix for acl storage on OSX
622 \item Cleanup of configure checks for ACL detection, now configure only
623 tests for a certain interface type based on the operating system
624 this should give less false positives on detection. Also when ACLs
625 are detected no other acl checks are performed anymore.
629 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
630 and is available with Bacula Enterprise Edition and Community Edition.
632 \subsection{XATTR enhancements}
634 The following enhancements are made to the Bacula Filed with regards to
635 Extended Attributes (XATTRs)
638 \item Added support for IRIX extended attributes using the attr\_get interface.
639 \item Added support for Tru64 (OSF1) extended attributes using the
640 getproplist interface.
641 \item Added support for AIX extended attributes available in AIX 6.x
642 and higher using the listea/getea/setea interface.
643 \item Added some debugging to generic xattr code so it easier to
645 \item Cleanup of configure checks for XATTR detection, now configure only
646 tests for a certain interface type based on the operating system
647 this should give less false positives on detection. Also when xattrs
648 are detected no other xattr checks are performed anymore.
652 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
653 and is available with Bacula Enterprise Edition and Community Edition.
655 \subsection{Class Based Database Backend Drivers}
657 The main Bacula Director code is independent of the SQL backend
658 in version 5.2.0 and greater. This means that the Bacula Director can be
659 packaged by itself, then each of the different SQL backends supported can
660 be packaged separately. It is possible to build all the DB backends at the
661 same time by including multiple database options at the same time.
663 ./configure can be run with multiple database configure options.
670 Order of testing for databases is:
677 Each configured backend generates a file named:
678 \verb+libbaccats-<sql_backend_name>-<version>.so+
679 A dummy catalog library is created named libbaccats-version.so
681 At configure time the first detected backend is used as the so called
682 default backend and at install time the dummy
683 \verb+libbaccats-<version>.so+ is replaced with the default backend type.
685 If you configure all three backends you get three backend libraries and the
686 postgresql gets installed as the default.
688 When you want to switch to another database, first save any old catalog you
689 may have then you can copy one of the three backend libraries over the
690 \verb+libbaccats-<version>.so+ e.g.
692 An actual command, depending on your Bacula version might be:
694 cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
697 where the \verb+5.2.2+ must be replaced by the Bacula release
700 Then you must update the default backend in the following files:
703 create_bacula_database
706 grant_bacula_privileges
712 And re-run all the above scripts. Please note, this means
713 you will have a new empty database and if you had a previous
716 All current database backend drivers for catalog information are rewritten
717 to use a set of multi inherited C++ classes which abstract the specific
718 database specific internals and make sure we have a more stable generic
719 interface with the rest of SQL code. From now on there is a strict
720 boundary between the SQL code and the low-level database functions. This
721 new interface should also make it easier to add a new backend for a
722 currently unsupported database. As part of the rewrite the SQLite 2 code
723 was removed (e.g. only SQLite 3 is now supported). An extra bonus of the
724 new code is that you can configure multiple backends in the configure and
725 build all backends in one compile session and select the correct database
726 backend at install time. This should make it a lot easier for packages
732 We also added cursor support for PostgreSQL backend, this improves memory
733 usage for large installation.
736 This project was implemented by Planets Communications B.V. and ELM
737 Consultancy B.V. and Bacula Systems and is available with both the Bacula
738 Enterprise Edition and the Community Edition.
740 \subsection{Hash List Enhancements}
742 The htable hash table class has been extended with extra hash functions for
743 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
744 Also the hash table initialization routines have been enhanced with
745 support for passing a hint as to the number of initial pages to use
746 for the size of the hash table. Until now the hash table always used
747 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
748 cache have been rewritten to use the new htable class with a small memory
752 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
753 and Bacula Systems and is available with Bacula Enterprise Edition and
758 %%% =====================================================================
763 \section{Release Version 5.0.3}
765 There are no new features in version 5.0.2. This version simply fixes a
766 number of bugs found in version 5.0.1 during the ongoing development
769 \section{Release Version 5.0.2}
771 There are no new features in version 5.0.2. This version simply fixes a
772 number of bugs found in version 5.0.1 during the ongoing development
778 \section{New Features in 5.0.1}
780 This chapter presents the new features that are in the released Bacula version
781 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
782 the ongoing development process.
784 \subsection{Truncate Volume after Purge}
785 \label{sec:actiononpurge}
787 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
788 the volume when it is purged with the new command \texttt{purge volume
789 action}. It is useful to prevent disk based volumes from consuming too much
795 Action On Purge = Truncate
800 As usual you can also set this property with the \texttt{update volume} command
802 *update volume=xxx ActionOnPurge=Truncate
803 *update volume=xxx actiononpurge=None
806 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
807 following command in interactive mode or in a RunScript as shown after:
809 *purge volume action=truncate storage=File allpools
810 # or by default, action=all
811 *purge volume action storage=File pool=Default
814 This is possible to specify the volume name, the media type, the pool, the
815 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
816 idle when you decide to run this command.
825 Console = "purge volume action=all allpools storage=File"
830 \textbf{Important note}: This feature doesn't work as
831 expected in version 5.0.0. Please do not use it before version 5.0.1.
833 \subsection{Allow Higher Duplicates}
834 This directive did not work correctly and has been depreciated
835 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
836 file as it will be removed in a future release.
838 \subsection{Cancel Lower Level Duplicates}
839 This directive was added in Bacula version 5.0.1. It compares the
840 level of a new backup job to old jobs of the same name, if any,
841 and will kill the job which has a lower level than the other one.
842 If the levels are the same (i.e. both are Full backups), then
843 nothing is done and the other Cancel XXX Duplicate directives
846 \section{New Features in 5.0.0}
848 \subsection{Maximum Concurrent Jobs for Devices}
849 \label{sec:maximumconcurrentjobdevice}
851 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
852 Daemon configuration permits setting the maximum number of Jobs that can
853 run concurrently on a specified Device. Using this directive, it is
854 possible to have different Jobs using multiple drives, because when the
855 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
856 Jobs on any other available compatible drive. This facilitates writing to
857 multiple drives with multiple Jobs that all use the same Pool.
859 This project was funded by Bacula Systems.
861 \subsection{Restore from Multiple Storage Daemons}
862 \index[general]{Restore}
864 Previously, you were able to restore from multiple devices in a single Storage
865 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
866 example, if your full backup runs on a Storage Daemon with an autochanger, and
867 your incremental jobs use another Storage Daemon with lots of disks, Bacula
868 will switch automatically from one Storage Daemon to an other within the same
871 You must upgrade your File Daemon to version 3.1.3 or greater to use this
874 This project was funded by Bacula Systems with the help of Equiinet.
876 \subsection{File Deduplication using Base Jobs}
877 A base job is sort of like a Full save except that you will want the FileSet to
878 contain only files that are unlikely to change in the future (i.e. a snapshot
879 of most of your system after installing it). After the base job has been run,
880 when you are doing a Full save, you specify one or more Base jobs to be used.
881 All files that have been backed up in the Base job/jobs but not modified will
882 then be excluded from the backup. During a restore, the Base jobs will be
883 automatically pulled in where necessary.
885 This is something none of the competition does, as far as we know (except
886 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
887 win for the user, it makes Bacula stand out as offering a unique optimization
888 that immediately saves time and money. Basically, imagine that you have 100
889 nearly identical Windows or Linux machine containing the OS and user files.
890 Now for the OS part, a Base job will be backed up once, and rather than making
891 100 copies of the OS, there will be only one. If one or more of the systems
892 have some files updated, no problem, they will be automatically restored.
894 See the \ilink{Base Job Chapter}{basejobs} for more information.
896 This project was funded by Bacula Systems.
898 \subsection{AllowCompression = \lt{}yes\vb{}no\gt{}}
899 \index[dir]{AllowCompression}
901 This new directive may be added to Storage resource within the Director's
902 configuration to allow users to selectively disable the client compression for
903 any job which writes to this storage resource.
909 Address = ultrium-tape
910 Password = storage_password # Password for Storage Daemon
913 AllowCompression = No # Tape drive has hardware compression
916 The above example would cause any jobs running with the UltriumTape storage
917 resource to run without compression from the client file daemons. This
918 effectively overrides any compression settings defined at the FileSet level.
920 This feature is probably most useful if you have a tape drive which supports
921 hardware compression. By setting the \texttt{AllowCompression = No} directive
922 for your tape drive storage resource, you can avoid additional load on the file
923 daemon and possibly speed up tape backups.
925 This project was funded by Collaborative Fusion, Inc.
927 \subsection{Accurate Fileset Options}
928 \label{sec:accuratefileset}
930 In previous versions, the accurate code used the file creation and modification
931 times to determine if a file was modified or not. Now you can specify which
932 attributes to use (time, size, checksum, permission, owner, group, \dots),
933 similar to the Verify options.
949 \item {\bf i} compare the inodes
950 \item {\bf p} compare the permission bits
951 \item {\bf n} compare the number of links
952 \item {\bf u} compare the user id
953 \item {\bf g} compare the group id
954 \item {\bf s} compare the size
955 \item {\bf a} compare the access time
956 \item {\bf m} compare the modification time (st\_mtime)
957 \item {\bf c} compare the change time (st\_ctime)
958 \item {\bf d} report file size decreases
959 \item {\bf 5} compare the MD5 signature
960 \item {\bf 1} compare the SHA1 signature
963 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
964 the File Daemon will have to read all files even if they normally would not
965 be saved. This increases the I/O load, but also the accuracy of the
966 deduplication. By default, Bacula will check modification/creation time
969 This project was funded by Bacula Systems.
971 \subsection{Tab-completion for Bconsole}
972 \label{sec:tabcompletion}
974 If you build \texttt{bconsole} with readline support, you will be able to use
975 the new auto-completion mode. This mode supports all commands, gives help
976 inside command, and lists resources when required. It works also in the restore
979 To use this feature, you should have readline development package loaded on
980 your system, and use the following option in configure.
982 ./configure --with-readline=/usr/include/readline --disable-conio ...
985 The new bconsole won't be able to tab-complete with older directors.
987 This project was funded by Bacula Systems.
989 \subsection{Pool File and Job Retention}
990 \label{sec:poolfilejobretention}
992 We added two new Pool directives, \texttt{FileRetention} and
993 \texttt{JobRetention}, that take precedence over Client directives of the same
994 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
995 example, you can decide to increase Retention times for Archive or OffSite Pool.
997 It seems obvious to us, but apparently not to some users, that given the
998 definition above that the Pool File and Job Retention periods is a global
999 override for the normal Client based pruning, which means that when the
1000 Job is pruned, the pruning will apply globally to that particular Job.
1002 Currently, there is a bug in the implementation that causes any Pool
1003 retention periods specified to apply to {\bf all} Pools for that
1004 particular Client. Thus we suggest that you avoid using these two
1005 directives until this implementation problem is corrected.
1007 \subsection{Read-only File Daemon using capabilities}
1008 \label{sec:fdreadonly}
1009 This feature implements support of keeping \textbf{ReadAll} capabilities after
1010 UID/GID switch, this allows FD to keep root read but drop write permission.
1012 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
1013 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
1016 root@localhost:~# bacula-fd -k -u nobody -g nobody
1019 The code for this feature was contributed by our friends at AltLinux.
1021 \subsection{Bvfs API}
1024 To help developers of restore GUI interfaces, we have added new \textsl{dot
1025 commands} that permit browsing the catalog in a very simple way.
1028 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
1029 the Bvfs cache in the catalog. You need to run it before any access to the
1032 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
1033 will list all directories in the specified \texttt{path} or
1034 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
1035 encoding of path/filenames.
1037 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
1038 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
1039 \texttt{pathid} avoids problems with character encoding.
1042 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
1043 data that will be displayed.
1046 * .bvfs_update jobid=1,2
1048 * .bvfs_lsdir path=/ jobid=1,2
1051 This project was funded by Bacula Systems.
1053 \subsection{Testing your Tape Drive}
1054 \label{sec:btapespeed}
1056 To determine the best configuration of your tape drive, you can run the new
1057 \texttt{speed} command available in the \texttt{btape} program.
1059 This command can have the following arguments:
1061 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
1062 (between 1 and 5GB). This counter is in GB.
1063 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
1064 of data should be greater than your memory ($file\_size*nb\_file$).
1065 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
1067 \item[\texttt{skip\_random}] This flag permits to skip tests with random
1069 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
1070 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
1075 *speed file_size=3 skip_raw
1076 btape.c:1078 Test with zero data and bacula block structure.
1077 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1078 ++++++++++++++++++++++++++++++++++++++++++
1079 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1080 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
1082 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
1084 btape.c:1090 Test with random data, should give the minimum throughput.
1085 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1086 +++++++++++++++++++++++++++++++++++++++++++
1087 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1088 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
1089 +++++++++++++++++++++++++++++++++++++++++++
1091 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
1095 When using compression, the random test will give your the minimum throughput
1096 of your drive . The test using constant string will give you the maximum speed
1097 of your hardware chain. (CPU, memory, SCSI card, cable, drive, tape).
1099 You can change the block size in the Storage Daemon configuration file.
1101 \subsection{New {\bf Block Checksum} Device Directive}
1102 You may now turn off the Block Checksum (CRC32) code
1103 that Bacula uses when writing blocks to a Volume. This is
1110 doing so can reduce the Storage daemon CPU usage slightly. It
1111 will also permit Bacula to read a Volume that has corrupted data.
1113 The default is {\bf yes} -- i.e. the checksum is computed on write
1114 and checked on read.
1116 We do not recommend to turn this off particularly on older tape
1117 drives or for disk Volumes where doing so may allow corrupted data
1120 \subsection{New Bat Features}
1122 Those new features were funded by Bacula Systems.
1124 \subsubsection{Media List View}
1126 By clicking on ``Media'', you can see the list of all your volumes. You will be
1127 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1128 in the table. The old ``Media'' view is now known as ``Pool''.
1129 \begin{figure}[htbp]
1131 \includegraphics[width=0.8\linewidth]{bat-mediaview}
1132 \label{fig:mediaview}
1136 \subsubsection{Media Information View}
1138 By double-clicking on a volume (on the Media list, in the Autochanger content
1139 or in the Job information panel), you can access a detailed overview of your
1140 Volume. (cf figure \vref{fig:mediainfo}.)
1141 \begin{figure}[htbp]
1143 \includegraphics[width=0.8\linewidth]{bat11}
1144 \caption{Media information}
1145 \label{fig:mediainfo}
1148 \subsubsection{Job Information View}
1150 By double-clicking on a Job record (on the Job run list or in the Media
1151 information panel), you can access a detailed overview of your Job. (cf
1152 figure \vref{fig:jobinfo}.)
1153 \begin{figure}[htbp]
1155 \includegraphics[width=0.8\linewidth]{bat12}
1156 \caption{Job information}
1160 \subsubsection{Autochanger Content View}
1162 By double-clicking on a Storage record (on the Storage list panel), you can
1163 access a detailed overview of your Autochanger. (cf figure \vref{fig:jobinfo}.)
1164 \begin{figure}[htbp]
1166 \includegraphics[width=0.8\linewidth]{bat13}
1167 \caption{Autochanger content}
1168 \label{fig:achcontent}
1171 To use this feature, you need to use the latest mtx-changer script
1172 version. (With new \texttt{listall} and \texttt{transfer} commands)
1174 \subsection{Bat on Windows}
1175 We have ported {\bf bat} to Windows and it is now installed
1176 by default when the installer is run. It works quite well
1177 on Win32, but has not had a lot of testing there, so your
1178 feedback would be welcome. Unfortunately, even though it is
1179 installed by default, it does not yet work on 64 bit Windows
1182 \subsection{New Win32 Installer}
1183 The Win32 installer has been modified in several very important
1186 \item You must deinstall any current version of the
1187 Win32 File daemon before upgrading to the new one.
1188 If you forget to do so, the new installation will fail.
1189 To correct this failure, you must manually shutdown
1190 and deinstall the old File daemon.
1191 \item All files (other than menu links) are installed
1192 in {\bf c:/Program Files/Bacula}.
1193 \item The installer no longer sets this
1194 file to require administrator privileges by default. If you want
1195 to do so, please do it manually using the {\bf cacls} program.
1198 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1200 \item The server daemons (Director and Storage daemon) are
1201 no longer included in the Windows installer. If you want the
1202 Windows servers, you will either need to build them yourself (note
1203 they have not been ported to 64 bits), or you can contact
1204 Bacula Systems about this.
1207 \subsection{Win64 Installer}
1208 We have corrected a number of problems that required manual
1209 editing of the conf files. In most cases, it should now
1210 install and work. {\bf bat} is by default installed in
1211 {\bf c:/Program Files/Bacula/bin32} rather than
1212 {\bf c:/Program Files/Bacula} as is the case with the 32
1213 bit Windows installer.
1215 \subsection{Linux Bare Metal Recovery USB Key}
1216 We have made a number of significant improvements in the
1217 Bare Metal Recovery USB key. Please see the README files
1218 it the {\bf rescue} release for more details.
1220 We are working on an equivalent USB key for Windows bare
1221 metal recovery, but it will take some time to develop it (best
1222 estimate 3Q2010 or 4Q2010)
1225 \subsection{bconsole Timeout Option}
1226 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1227 for commands. This is useful with GUI programs that use {\bf bconsole}
1228 to interface to the Director.
1230 \subsection{Important Changes}
1231 \label{sec:importantchanges}
1234 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1235 to the same Pool. The Storage daemon ensures that you do not read and
1236 write to the same Volume.
1237 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1239 \item Virtually all the features of {\bf mtx-changer} have
1240 now been parametrized, which allows you to configure
1241 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1242 that contains variables that you can set to configure mtx-changer.
1243 This configuration file will not be overwritten during upgrades.
1244 We encourage you to submit any changes
1245 that are made to mtx-changer and to parametrize it all in
1246 mtx-changer.conf so that all configuration will be done by
1247 changing only mtx-changer.conf.
1248 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1249 and \texttt{transfer}. Please configure them as appropriate
1250 in mtx-changer.conf.
1251 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1252 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1253 password. If you want to use the new script, you will need to
1254 manually change the \texttt{BackupCatalog} Job definition.
1255 \item The \texttt{bconsole} \texttt{help} command now accepts
1256 an argument, which if provided produces information on that
1257 command (ex: \texttt{help run}).
1261 \subsubsection*{Truncate volume after purge}
1263 Note that the Truncate Volume after purge feature doesn't work as expected
1264 in 5.0.0 version. Please, don't use it before version 5.0.1.
1266 \subsubsection{Custom Catalog queries}
1268 If you wish to add specialized commands that list the contents of the catalog,
1269 you can do so by adding them to the \texttt{query.sql} file. This
1270 \texttt{query.sql} file is now empty by default. The file
1271 \texttt{examples/sample-query.sql} has an a number of sample commands
1272 you might find useful.
1274 \subsubsection{Deprecated parts}
1276 The following items have been \textbf{deprecated} for a long time, and are now
1277 removed from the code.
1280 \item Support for SQLite 2
1283 \subsection{Misc Changes}
1284 \label{sec:miscchanges}
1287 \item Updated Nagios check\_bacula
1288 \item Updated man files
1289 \item Added OSX package generation script in platforms/darwin
1290 \item Added Spanish and Ukrainian Bacula translations
1291 \item Enable/disable command shows only Jobs that can change
1292 \item Added \texttt{show disabled} command to show disabled Jobs
1293 \item Many ACL improvements
1294 \item Added Level to FD status Job output
1295 \item Begin Ingres DB driver (not yet working)
1296 \item Split RedHat spec files into bacula, bat, mtx, and docs
1297 \item Reorganized the manuals (fewer separate manuals)
1298 \item Added lock/unlock order protection in lock manager
1299 \item Allow 64 bit sizes for a number of variables
1300 \item Fixed several deadlocks or potential race conditions in the SD
1303 \chapter{Released Version 3.0.3 and 3.0.3a}
1305 There are no new features in version 3.0.3. This version simply fixes a
1306 number of bugs found in version 3.0.2 during the ongoing development
1309 \section{New Features in Released Version 3.0.2}
1311 This chapter presents the new features added to the
1312 Released Bacula Version 3.0.2.
1314 \subsection{Full Restore from a Given JobId}
1315 \index[general]{Restore menu}
1317 This feature allows selecting a single JobId and having Bacula
1318 automatically select all the other jobs that comprise a full backup up to
1319 and including the selected date (through JobId).
1321 Assume we start with the following jobs:
1323 +-------+--------------+---------------------+-------+----------+------------+
1324 | jobid | client | starttime | level | jobfiles | jobbytes |
1325 +-------+--------------+---------------------+-------+----------+------------
1326 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1327 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1328 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1329 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1330 +-------+--------------+---------------------+-------+----------+------------+
1333 Below is an example of this new feature (which is number 12 in the
1338 To select the JobIds, you have the following choices:
1339 1: List last 20 Jobs run
1340 2: List Jobs where a given File is saved
1342 12: Select full restore to a specified Job date
1345 Select item: (1-13): 12
1346 Enter JobId to get the state to restore: 5
1347 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1348 You have selected the following JobIds: 1,3,5
1350 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1351 1,444 files inserted into the tree.
1354 This project was funded by Bacula Systems.
1356 \subsection{Source Address}
1357 \index[general]{Source Address}
1359 A feature has been added which allows the administrator to specify the address
1360 from which the Director and File daemons will establish connections. This
1361 may be used to simplify system configuration overhead when working in complex
1362 networks utilizing multi-homing and policy-routing.
1364 To accomplish this, two new configuration directives have been implemented:
1367 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1371 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1375 Simply adding specific host routes on the OS
1376 would have an undesirable side-effect: any
1377 application trying to contact the destination host would be forced to use the
1378 more specific route possibly diverting management traffic onto a backup VLAN.
1379 Instead of adding host routes for each client connected to a multi-homed backup
1380 server (for example where there are management and backup VLANs), one can
1381 use the new directives to specify a specific source address at the application
1384 Additionally, this allows the simplification and abstraction of firewall rules
1385 when dealing with a Hot-Standby director or storage daemon configuration. The
1386 Hot-standby pair may share a CARP address, which connections must be sourced
1387 from, while system services listen and act from the unique interface addresses.
1389 This project was funded by Collaborative Fusion, Inc.
1391 \subsection{Show volume availability when doing restore}
1393 When doing a restore the selection dialog ends by displaying this
1397 The job will require the following
1398 Volume(s) Storage(s) SD Device(s)
1399 ===========================================================================
1400 *000741L3 LTO-4 LTO3
1401 *000866L3 LTO-4 LTO3
1402 *000765L3 LTO-4 LTO3
1403 *000764L3 LTO-4 LTO3
1404 *000756L3 LTO-4 LTO3
1405 *001759L3 LTO-4 LTO3
1406 *001763L3 LTO-4 LTO3
1410 Volumes marked with ``*'' are online (in the autochanger).
1413 This should help speed up large restores by minimizing the time spent
1414 waiting for the operator to discover that he must change tapes in the library.
1416 This project was funded by Bacula Systems.
1418 \subsection{Accurate estimate command}
1420 The \texttt{estimate} command can now use the accurate code to detect changes
1421 and give a better estimation.
1423 You can set the accurate behavior on the command line by using
1424 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1427 * estimate listing accurate=yes level=incremental job=BackupJob
1430 This project was funded by Bacula Systems.
1432 \section{New Features in 3.0.0}
1433 \label{NewFeaturesChapter}
1434 \index[general]{New Features}
1436 This chapter presents the new features added to the development 2.5.x
1437 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1439 \subsection{Accurate Backup}
1440 \index[general]{Accurate Backup}
1442 As with most other backup programs, by default Bacula decides what files to
1443 backup for Incremental and Differential backup by comparing the change
1444 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1445 backup completed. If one of those two times is later than the last backup
1446 time, then the file will be backed up. This does not, however, permit tracking
1447 what files have been deleted and will miss any file with an old time that may
1448 have been restored to or moved onto the client filesystem.
1450 \subsubsection{Accurate = \lt{}yes\vb{}no\gt{}}
1451 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1452 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1453 backup, there is no difference, but for {\bf Differential} and {\bf
1454 Incremental} backups, the Director will send a list of all previous files
1455 backed up, and the File daemon will use that list to determine if any new files
1456 have been added or or moved and if any files have been deleted. This allows
1457 Bacula to make an accurate backup of your system to that point in time so that
1458 if you do a restore, it will restore your system exactly.
1461 about using Accurate backup is that it requires more resources (CPU and memory)
1462 on both the Director and the Client machines to create the list of previous
1463 files backed up, to send that list to the File daemon, for the File daemon to
1464 keep the list (possibly very big) in memory, and for the File daemon to do
1465 comparisons between every file in the FileSet and the list. In particular,
1466 if your client has lots of files (more than a few million), you will need
1467 lots of memory on the client machine.
1469 Accurate must not be enabled when backing up with a plugin that is not
1470 specially designed to work with Accurate. If you enable it, your restores
1471 will probably not work correctly.
1473 This project was funded by Bacula Systems.
1477 \subsection{Copy Jobs}
1478 \index[general]{Copy Jobs}
1480 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1481 existing Migration feature with the exception that the Job that is copied is
1482 left unchanged. This essentially creates two identical copies of the same
1483 backup. However, the copy is treated as a copy rather than a backup job, and
1484 hence is not directly available for restore. The {\bf restore} command lists
1485 copy jobs and allows selection of copies by using \texttt{jobid=}
1486 option. If the keyword {\bf copies} is present on the command line, Bacula will
1487 display the list of all copies for selected jobs.
1492 These JobIds have copies as follows:
1493 +-------+------------------------------------+-----------+------------------+
1494 | JobId | Job | CopyJobId | MediaType |
1495 +-------+------------------------------------+-----------+------------------+
1496 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1497 +-------+------------------------------------+-----------+------------------+
1498 +-------+-------+----------+----------+---------------------+------------------+
1499 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1500 +-------+-------+----------+----------+---------------------+------------------+
1501 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1502 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1503 +-------+-------+----------+----------+---------------------+------------------+
1504 You have selected the following JobIds: 19,2
1506 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1507 5,611 files inserted into the tree.
1512 The Copy Job runs without using the File daemon by copying the data from the
1513 old backup Volume to a different Volume in a different Pool. See the Migration
1514 documentation for additional details. For copy Jobs there is a new selection
1515 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1516 not already copied to another Pool.
1518 As with Migration, the Client, Volume, Job, or SQL query, are
1519 other possible ways of selecting the Jobs to be copied. Selection
1520 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1521 work, but are probably more suited for Migration Jobs.
1523 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1524 it will promote the Copy to a \textsl{real} backup job and will make it available for
1525 automatic restore. If more than one Copy is available, it will promote the copy
1526 with the smallest JobId.
1528 A nice solution which can be built with the new Copy feature is often
1529 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1530 look something like the one below:
1534 Name = FullBackupsVirtualPool
1536 Purge Oldest Volume = Yes
1538 NextPool = FullBackupsTapePool
1542 Name = FullBackupsTapePool
1546 Volume Retention = 365 days
1547 Storage = superloader
1551 # Fake fileset for copy jobs
1563 # Fake client for copy jobs
1573 # Default template for a CopyDiskToTape Job
1576 Name = CopyDiskToTape
1578 Messages = StandardCopy
1581 Selection Type = PoolUncopiedJobs
1582 Maximum Concurrent Jobs = 10
1584 Allow Duplicate Jobs = Yes
1585 Cancel Queued Duplicates = No
1586 Cancel Running Duplicates = No
1591 Name = DaySchedule7:00
1592 Run = Level=Full daily at 7:00
1596 Name = CopyDiskToTapeFullBackups
1598 Schedule = DaySchedule7:00
1599 Pool = FullBackupsVirtualPool
1600 JobDefs = CopyDiskToTape
1604 The example above had 2 pool which are copied using the PoolUncopiedJobs
1605 selection criteria. Normal Full backups go to the Virtual pool and are copied
1606 to the Tape pool the next morning.
1608 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1613 +-------+------------------------------------+-----------+------------------+
1614 | JobId | Job | CopyJobId | MediaType |
1615 +-------+------------------------------------+-----------+------------------+
1616 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1617 +-------+------------------------------------+-----------+------------------+
1620 \subsection{ACL Updates}
1621 \index[general]{ACL Updates}
1622 The whole ACL code had been overhauled and in this version each platforms has
1623 different streams for each type of acl available on such an platform. As ACLs
1624 between platforms tend to be not that portable (most implement POSIX acls but
1625 some use an other draft or a completely different format) we currently only
1626 allow certain platform specific ACL streams to be decoded and restored on the
1627 same platform that they were created on. The old code allowed to restore ACL
1628 cross platform but the comments already mention that not being to wise. For
1629 backward compatibility the new code will accept the two old ACL streams and
1630 handle those with the platform specific handler. But for all new backups it
1631 will save the ACLs using the new streams.
1633 Currently the following platforms support ACLs:
1637 \item {\bf Darwin/OSX}
1646 Currently we support the following ACL types (these ACL streams use a reserved
1647 part of the stream numbers):
1650 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1652 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1653 string representation from acl\_to\_text (POSIX acl)
1654 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1655 string representation from acl\_to\_text (POSIX acl) for default acls.
1656 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1657 string representation from acl\_to\_text (POSIX acl) for access acls.
1658 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1659 string representation from acltostr (POSIX acl)
1660 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1661 representation from acl\_to\_text (POSIX acl) for default acls.
1662 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1663 representation from acl\_to\_text (POSIX acl) for access acls.
1664 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1665 string representation from acl\_to\_text (POSIX acl) for default acls.
1666 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1667 representation from acl\_to\_text (POSIX acl) for access acls.
1668 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1669 string representation from acl\_to\_text (POSIX acl) for default acls.
1670 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1671 string representation from acl\_to\_text (POSIX acl) for default acls.
1672 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1673 representation from acl\_to\_text (POSIX acl) for access acls.
1674 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1675 string representation from acltotext or acl\_totext (POSIX acl)
1676 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1677 representation from from acl\_totext (NFSv4 or ZFS acl)
1680 In future versions we might support conversion functions from one type of acl
1681 into an other for types that are either the same or easily convertible. For now
1682 the streams are separate and restoring them on a platform that doesn't
1683 recognize them will give you a warning.
1685 \subsection{Extended Attributes}
1686 \index[general]{Extended Attributes}
1687 Something that was on the project list for some time is now implemented for
1688 platforms that support a similar kind of interface. Its the support for backup
1689 and restore of so called extended attributes. As extended attributes are so
1690 platform specific these attributes are saved in separate streams for each
1691 platform. Restores of the extended attributes can only be performed on the
1692 same platform the backup was done. There is support for all types of extended
1693 attributes, but restoring from one type of filesystem onto an other type of
1694 filesystem on the same platform may lead to surprises. As extended attributes
1695 can contain any type of data they are stored as a series of so called
1696 value-pairs. This data must be seen as mostly binary and is stored as such.
1697 As security labels from selinux are also extended attributes this option also
1698 stores those labels and no specific code is enabled for handling selinux
1701 Currently the following platforms support extended attributes:
1703 \item {\bf Darwin/OSX}
1709 On Linux acls are also extended attributes, as such when you enable ACLs on a
1710 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1711 and not the same extended attribute.
1713 To enable the backup of extended attributes please add the following to your
1728 \subsection{Shared objects}
1729 \index[general]{Shared objects}
1730 A default build of Bacula will now create the libraries as shared objects
1731 (.so) rather than static libraries as was previously the case.
1732 The shared libraries are built using {\bf libtool} so it should be quite
1735 An important advantage of using shared objects is that on a machine with the
1736 Directory, File daemon, the Storage daemon, and a console, you will have only
1737 one copy of the code in memory rather than four copies. Also the total size of
1738 the binary release is smaller since the library code appears only once rather
1739 than once for every program that uses it; this results in significant reduction
1740 in the size of the binaries particularly for the utility tools.
1742 In order for the system loader to find the shared objects when loading the
1743 Bacula binaries, the Bacula shared objects must either be in a shared object
1744 directory known to the loader (typically /usr/lib) or they must be in the
1745 directory that may be specified on the {\bf ./configure} line using the {\bf
1746 {-}{-}libdir} option as:
1749 ./configure --libdir=/full-path/dir
1752 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1753 no need to modify your loader configuration provided that
1754 the shared objects are installed in that directory (Bacula
1755 does this with the make install command). The shared objects
1756 that Bacula references are:
1765 These files are symbolically linked to the real shared object file,
1766 which has a version number to permit running multiple versions of
1767 the libraries if desired (not normally the case).
1769 If you have problems with libtool or you wish to use the old
1770 way of building static libraries, or you want to build a static
1771 version of Bacula you may disable
1772 libtool on the configure command line with:
1775 ./configure --disable-libtool
1779 \subsection{Building Static versions of Bacula}
1780 \index[general]{Static linking}
1781 In order to build static versions of Bacula, in addition
1782 to configuration options that were needed you now must
1783 also add --disable-libtool. Example
1786 ./configure --enable-static-client-only --disable-libtool
1790 \subsection{Virtual Backup (Vbackup)}
1791 \index[general]{Virtual Backup}
1792 \index[general]{Vbackup}
1794 Bacula's virtual backup feature is often called Synthetic Backup or
1795 Consolidation in other backup products. It permits you to consolidate the
1796 previous Full backup plus the most recent Differential backup and any
1797 subsequent Incremental backups into a new Full backup. This new Full
1798 backup will then be considered as the most recent Full for any future
1799 Incremental or Differential backups. The VirtualFull backup is
1800 accomplished without contacting the client by reading the previous backup
1801 data and writing it to a volume in a different pool.
1803 In some respects the Vbackup feature works similar to a Migration job, in
1804 that Bacula normally reads the data from the pool specified in the
1805 Job resource, and writes it to the {\bf Next Pool} specified in the
1806 Job resource. Note, this means that usually the output from the Virtual
1807 Backup is written into a different pool from where your prior backups
1808 are saved. Doing it this way guarantees that you will not get a deadlock
1809 situation attempting to read and write to the same volume in the Storage
1810 daemon. If you then want to do subsequent backups, you may need to
1811 move the Virtual Full Volume back to your normal backup pool.
1812 Alternatively, you can set your {\bf Next Pool} to point to the current
1813 pool. This will cause Bacula to read and write to Volumes in the
1814 current pool. In general, this will work, because Bacula will
1815 not allow reading and writing on the same Volume. In any case, once
1816 a VirtualFull has been created, and a restore is done involving the
1817 most current Full, it will read the Volume or Volumes by the VirtualFull
1818 regardless of in which Pool the Volume is found.
1820 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1821 a level of {\bf VirtualFull}.
1823 A typical Job resource definition might look like the following:
1830 FileSet = "Full Set"
1837 # Default pool definition
1841 Recycle = yes # Automatically recycle Volumes
1842 AutoPrune = yes # Prune expired volumes
1843 Volume Retention = 365d # one year
1851 Recycle = yes # Automatically recycle Volumes
1852 AutoPrune = yes # Prune expired volumes
1853 Volume Retention = 365d # one year
1854 Storage = DiskChanger
1857 # Definition of file storage device
1862 Device = FileStorage
1864 Maximum Concurrent Jobs = 5
1867 # Definition of DDS Virtual tape disk storage device
1870 Address = localhost # N.B. Use a fully qualified name here
1872 Device = DiskChanger
1873 Media Type = DiskChangerMedia
1874 Maximum Concurrent Jobs = 4
1879 Then in bconsole or via a Run schedule, you would run the job as:
1882 run job=MyBackup level=Full
1883 run job=MyBackup level=Incremental
1884 run job=MyBackup level=Differential
1885 run job=MyBackup level=Incremental
1886 run job=MyBackup level=Incremental
1889 So providing there were changes between each of those jobs, you would end up
1890 with a Full backup, a Differential, which includes the first Incremental
1891 backup, then two Incremental backups. All the above jobs would be written to
1892 the {\bf Default} pool.
1894 To consolidate those backups into a new Full backup, you would run the
1898 run job=MyBackup level=VirtualFull
1901 And it would produce a new Full backup without using the client, and the output
1902 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1904 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1907 Note, the Start and End time of the Virtual Full backup is set to the
1908 values for the last job included in the Virtual Full (in the above example,
1909 it is an Increment). This is so that if another incremental is done, which
1910 will be based on the Virtual Full, it will backup all files from the
1911 last Job included in the Virtual Full rather than from the time the Virtual
1912 Full was actually run.
1916 \subsection{Catalog Format}
1917 \index[general]{Catalog Format}
1918 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1919 operation will convert the FileId field of the File table from 32 bits (max 4
1920 billion table entries) to 64 bits (very large number of items). The
1921 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1922 your catalog during the conversion. Also you won't be able to run jobs during
1923 this conversion period. For example, a 3 million file catalog will take 2
1924 minutes to upgrade on a normal machine. Please don't forget to make a valid
1925 backup of your database before executing the upgrade script. See the
1926 ReleaseNotes for additional details.
1928 \subsection{64 bit Windows Client}
1929 \index[general]{Win64 Client}
1930 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1931 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1932 As a consequence, we are also releasing a 64 bit version of the Bacula
1933 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1934 These binaries should only be installed on 64 bit Windows operating systems.
1935 What is important is not your hardware but whether or not you have
1936 a 64 bit version of the Windows OS.
1938 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1940 \item Before installing the Win64 Bacula Client, you must totally
1941 deinstall any prior 2.4.x Client installation using the
1942 Bacula deinstallation (see the menu item). You may want
1943 to save your .conf files first.
1944 \item Only the Client (File daemon) is ported to Win64, the Director
1945 and the Storage daemon are not in the 64 bit Windows installer.
1946 \item bwx-console is not yet ported.
1947 \item bconsole is ported but it has not been tested.
1948 \item The documentation is not included in the installer.
1949 \item Due to Vista security restrictions imposed on a default installation
1950 of Vista, before upgrading the Client, you must manually stop
1951 any prior version of Bacula from running, otherwise the install
1953 \item Due to Vista security restrictions imposed on a default installation
1954 of Vista, attempting to edit the conf files via the menu items
1955 will fail. You must directly edit the files with appropriate
1956 permissions. Generally double clicking on the appropriate .conf
1957 file will work providing you have sufficient permissions.
1958 \item All Bacula files are now installed in
1959 {\bf C:/Program Files/Bacula} except the main menu items,
1960 which are installed as before. This vastly simplifies the installation.
1961 \item If you are running on a foreign language version of Windows, most
1962 likely {\bf C:/Program Files} does not exist, so you should use the
1963 Custom installation and enter an appropriate location to install
1965 \item The 3.0.0 Win32 Client continues to install files in the locations used
1966 by prior versions. For the next version we will convert it to use
1967 the same installation conventions as the Win64 version.
1970 This project was funded by Bacula Systems.
1973 \subsection{Duplicate Job Control}
1974 \index[general]{Duplicate Jobs}
1975 The new version of Bacula provides four new directives that
1976 give additional control over what Bacula does if duplicate jobs
1977 are started. A duplicate job in the sense we use it here means
1978 a second or subsequent job with the same name starts. This
1979 happens most frequently when the first job runs longer than expected because no
1980 tapes are available.
1982 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1983 are specified in the Job resource.
1987 \subsubsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1988 \index[general]{Allow Duplicate Jobs}
1989 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1990 the directive is set to {\bf no} (default) then only one job of a given name
1991 may run at one time, and the action that Bacula takes to ensure only
1992 one job runs is determined by the other directives (see below).
1994 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1995 are present and none of the three directives given below permit
1996 Canceling a job, then the current job (the second one started)
1999 \subsubsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
2000 \index[general]{Allow Higher Duplicates}
2001 This directive was in version 5.0.0, but does not work as
2002 expected. If used, it should always be set to no. In later versions
2003 of Bacula the directive is disabled (disregarded).
2005 \subsubsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
2006 \index[general]{Cancel Running Duplicates}
2007 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
2008 if this directive is set to {\bf yes} any job that is already running
2009 will be canceled. The default is {\bf no}.
2011 \subsubsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
2012 \index[general]{Cancel Queued Duplicates}
2013 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
2014 if this directive is set to {\bf yes} any job that is
2015 already queued to run but not yet running will be canceled.
2016 The default is {\bf no}.
2019 \subsection{TLS Authentication}
2020 \index[general]{TLS Authentication}
2021 In Bacula version 2.5.x and later, in addition to the normal Bacula
2022 CRAM-MD5 authentication that is used to authenticate each Bacula
2023 connection, you can specify that you want TLS Authentication as well,
2024 which will provide more secure authentication.
2026 This new feature uses Bacula's existing TLS code (normally used for
2027 communications encryption) to do authentication. To use it, you must
2028 specify all the TLS directives normally used to enable communications
2029 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
2032 \subsubsection{TLS Authenticate = yes}
2034 TLS Authenticate = yes
2037 in the main daemon configuration resource (Director for the Director,
2038 Client for the File daemon, and Storage for the Storage daemon).
2040 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
2041 authentication, Bacula will also do TLS authentication, then TLS
2042 encryption will be turned off, and the rest of the communication between
2043 the two Bacula daemons will be done without encryption.
2045 If you want to encrypt communications data, use the normal TLS directives
2046 but do not turn on {\bf TLS Authenticate}.
2048 \subsection{bextract non-portable Win32 data}
2049 \index[general]{bextract handles Win32 non-portable data}
2050 {\bf bextract} has been enhanced to be able to restore
2051 non-portable Win32 data to any OS. Previous versions were
2052 unable to restore non-portable Win32 data to machines that
2053 did not have the Win32 BackupRead and BackupWrite API calls.
2055 \subsection{State File updated at Job Termination}
2056 \index[general]{State File}
2057 In previous versions of Bacula, the state file, which provides a
2058 summary of previous jobs run in the {\bf status} command output was
2059 updated only when Bacula terminated, thus if the daemon crashed, the
2060 state file might not contain all the run data. This version of
2061 the Bacula daemons updates the state file on each job termination.
2063 \subsection{MaxFullInterval = \lt{}time-interval\gt{}}
2064 \index[general]{MaxFullInterval}
2065 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
2066 can be used to specify the maximum time interval between {\bf Full} backup
2067 jobs. When a job starts, if the time since the last Full backup is
2068 greater than the specified interval, and the job would normally be an
2069 {\bf Incremental} or {\bf Differential}, it will be automatically
2070 upgraded to a {\bf Full} backup.
2072 \subsection{MaxDiffInterval = \lt{}time-interval\gt{}}
2073 \index[general]{MaxDiffInterval}
2074 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
2075 can be used to specify the maximum time interval between {\bf Differential} backup
2076 jobs. When a job starts, if the time since the last Differential backup is
2077 greater than the specified interval, and the job would normally be an
2078 {\bf Incremental}, it will be automatically
2079 upgraded to a {\bf Differential} backup.
2081 \subsection{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
2082 \index[general]{MaxDiffInterval}
2083 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
2084 by the user, and when it is set it is an indication to backup programs
2085 to not backup that particular file. This version of Bacula contains a
2086 new Options directive within a FileSet resource, which instructs Bacula to
2087 obey this flag. The new directive is:
2090 Honor No Dump Flag = yes\vb{}no
2093 The default value is {\bf no}.
2096 \subsection{Exclude Dir Containing = \lt{}filename-string\gt{}}
2097 \index[general]{IgnoreDir}
2098 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
2099 can be added to the Include section of the FileSet resource. If the specified
2100 filename ({\bf filename-string}) is found on the Client in any directory to be
2101 backed up, the whole directory will be ignored (not backed up). For example:
2104 # List of files to be backed up
2112 Exclude Dir Containing = .excludeme
2117 But in /home, there may be hundreds of directories of users and some
2118 people want to indicate that they don't want to have certain
2119 directories backed up. For example, with the above FileSet, if
2120 the user or sysadmin creates a file named {\bf .excludeme} in
2121 specific directories, such as
2124 /home/user/www/cache/.excludeme
2125 /home/user/temp/.excludeme
2128 then Bacula will not backup the two directories named:
2131 /home/user/www/cache
2135 NOTE: subdirectories will not be backed up. That is, the directive
2136 applies to the two directories in question and any children (be they
2137 files, directories, etc).
2140 \subsection{Bacula Plugins}
2141 \index[general]{Plugin}
2142 Support for shared object plugins has been implemented in the Linux, Unix
2143 and Win32 File daemons. The API will be documented separately in
2144 the Developer's Guide or in a new document. For the moment, there is
2145 a single plugin named {\bf bpipe} that allows an external program to
2146 get control to backup and restore a file.
2148 Plugins are also planned (partially implemented) in the Director and the
2151 \subsubsection{Plugin Directory}
2152 \index[general]{Plugin Directory}
2153 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2154 be added to the daemon definition resource. The directory takes a quoted
2155 string argument, which is the name of the directory in which the daemon can
2156 find the Bacula plugins. If this directive is not specified, Bacula will not
2157 load any plugins. Since each plugin has a distinctive name, all the daemons
2158 can share the same plugin directory.
2160 \subsubsection{Plugin Options}
2161 \index[general]{Plugin Options}
2162 The {\bf Plugin Options} directive takes a quoted string
2163 argument (after the equal sign) and may be specified in the
2164 Job resource. The options specified will be passed to all plugins
2165 when they are run. This each plugin must know what it is looking
2166 for. The value defined in the Job resource can be modified
2167 by the user when he runs a Job via the {\bf bconsole} command line
2170 Note: this directive may be specified, and there is code to modify
2171 the string in the run command, but the plugin options are not yet passed to
2172 the plugin (i.e. not fully implemented).
2174 \subsubsection{Plugin Options ACL}
2175 \index[general]{Plugin Options ACL}
2176 The {\bf Plugin Options ACL} directive may be specified in the
2177 Director's Console resource. It functions as all the other ACL commands
2178 do by permitting users running restricted consoles to specify a
2179 {\bf Plugin Options} that overrides the one specified in the Job
2180 definition. Without this directive restricted consoles may not modify
2183 \subsubsection{Plugin = \lt{}plugin-command-string\gt{}}
2184 \index[general]{Plugin}
2185 The {\bf Plugin} directive is specified in the Include section of
2186 a FileSet resource where you put your {\bf File = xxx} directives.
2197 Plugin = "bpipe:..."
2202 In the above example, when the File daemon is processing the directives
2203 in the Include section, it will first backup all the files in {\bf /home}
2204 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2205 the Plugin Directory. The syntax and semantics of the Plugin directive
2206 require the first part of the string up to the colon (:) to be the name
2207 of the plugin. Everything after the first colon is ignored by the File daemon but
2208 is passed to the plugin. Thus the plugin writer may define the meaning of the
2209 rest of the string as he wishes.
2211 Please see the next section for information about the {\bf bpipe} Bacula
2214 \subsection{The bpipe Plugin}
2215 \index[general]{The bpipe Plugin}
2216 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2217 the Bacula source distribution. When the plugin is compiled and linking into
2218 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2219 Please note that this is a very simple plugin that was written for
2220 demonstration and test purposes. It is and can be used in production, but
2221 that was never really intended.
2223 The purpose of the plugin is to provide an interface to any system program for
2224 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2225 the Include section of your Job's FileSet resource. The full syntax of the
2226 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2227 to specify the sytax as it wishes) is:
2230 Plugin = "<field1>:<field2>:<field3>:<field4>"
2235 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2236 stripped off, so in this case, we would put {\bf bpipe} in this field.
2238 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2239 pseudo path and filename under which the backup will be saved. This pseudo
2240 path and filename will be seen by the user in the restore file tree.
2241 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2242 backed up by the plugin will be put under that "pseudo" path and filename.
2243 You must be careful to choose a naming convention that is unique to avoid
2244 a conflict with a path and filename that actually exists on your system.
2246 \item {\bf field3} for the {\bf bpipe} plugin
2247 specifies the "reader" program that is called by the plugin during
2248 backup to read the data. {\bf bpipe} will call this program by doing a
2251 \item {\bf field4} for the {\bf bpipe} plugin
2252 specifies the "writer" program that is called by the plugin during
2253 restore to write the data back to the filesystem.
2256 Please note that for two items above describing the "reader" and "writer"
2257 fields, these programs are "executed" by Bacula, which
2258 means there is no shell interpretation of any command line arguments
2259 you might use. If you want to use shell characters (redirection of input
2260 or output, ...), then we recommend that you put your command or commands
2261 in a shell script and execute the script. In addition if you backup a
2262 file with the reader program, when running the writer program during
2263 the restore, Bacula will not automatically create the path to the file.
2264 Either the path must exist, or you must explicitly do so with your command
2265 or in a shell script.
2267 Putting it all together, the full plugin directive line might look
2271 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2272 --opt --databases bacula:mysql"
2275 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2276 would be written on a single line.
2278 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2279 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2280 program {\bf mysqldump -f --opt --database bacula} to read the data during
2281 backup. The mysqldump command outputs all the data for the database named
2282 {\bf bacula}, which will be read by the plugin and stored in the backup.
2283 During restore, the data that was backed up will be sent to the program
2284 specified in the last field, which in this case is {\bf mysql}. When
2285 {\bf mysql} is called, it will read the data sent to it by the plugn
2286 then write it back to the same database from which it came ({\bf bacula}
2289 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2290 the data from a specified program to Bacula for backup, and then from Bacula to
2291 a specified program for restore.
2293 By using different command lines to {\bf bpipe},
2294 you can backup any kind of data (ASCII or binary) depending
2295 on the program called.
2297 \subsection{Microsoft Exchange Server 2003/2007 Plugin}
2298 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2299 \subsubsection{Background}
2300 The Exchange plugin was made possible by a funded development project
2301 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2302 The code for the plugin was written by James Harper, and the Bacula core
2303 code by Kern Sibbald. All the code for this funded development has become
2304 part of the Bacula project. Thanks to everyone who made it happen.
2306 \subsubsection{Concepts}
2307 Although it is possible to backup Exchange using Bacula VSS the Exchange
2308 plugin adds a good deal of functionality, because while Bacula VSS
2309 completes a full backup (snapshot) of Exchange, it does
2310 not support Incremental or Differential backups, restoring is more
2311 complicated, and a single database restore is not possible.
2313 Microsoft Exchange organises its storage into Storage Groups with
2314 Databases inside them. A default installation of Exchange will have a
2315 single Storage Group called 'First Storage Group', with two Databases
2316 inside it, "Mailbox Store (SERVER NAME)" and
2317 "Public Folder Store (SERVER NAME)",
2318 which hold user email and public folders respectively.
2320 In the default configuration, Exchange logs everything that happens to
2321 log files, such that if you have a backup, and all the log files since,
2322 you can restore to the present time. Each Storage Group has its own set
2323 of log files and operates independently of any other Storage Groups. At
2324 the Storage Group level, the logging can be turned off by enabling a
2325 function called "Enable circular logging". At this time the Exchange
2326 plugin will not function if this option is enabled.
2328 The plugin allows backing up of entire storage groups, and the restoring
2329 of entire storage groups or individual databases. Backing up and
2330 restoring at the individual mailbox or email item is not supported but
2331 can be simulated by use of the "Recovery" Storage Group (see below).
2333 \subsubsection{Installing}
2334 The Exchange plugin requires a DLL that is shipped with Microsoft
2335 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2336 correctly the Exchange plugin should find this automatically and run
2337 without any additional installation.
2339 If the DLL can not be found automatically it will need to be copied into
2340 the Bacula installation
2341 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2342 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2343 default Exchange installation.
2345 \subsubsection{Backing Up}
2346 To back up an Exchange server the Fileset definition must contain at
2347 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2348 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2349 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2350 up files are prefixed with something that isn't going to share a name
2351 with something outside the plugin, and the 'Microsoft Information Store'
2352 bit is required also. It is also possible to add the name of a storage
2353 group to the "Plugin =" line, eg \\
2354 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2355 if you want only a single storage group backed up.
2357 Additionally, you can suffix the 'Plugin =' directive with
2358 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2359 database at the end of a full backup.
2361 An Incremental or Differential backup will backup only the database logs
2362 for each Storage Group by inspecting the "modified date" on each
2363 physical log file. Because of the way the Exchange API works, the last
2364 logfile backed up on each backup will always be backed up by the next
2365 Incremental or Differential backup too. This adds 5MB to each
2366 Incremental or Differential backup size but otherwise does not cause any
2369 By default, a normal VSS fileset containing all the drive letters will
2370 also back up the Exchange databases using VSS. This will interfere with
2371 the plugin and Exchange's shared ideas of when the last full backup was
2372 done, and may also truncate log files incorrectly. It is important,
2373 therefore, that the Exchange database files be excluded from the backup,
2374 although the folders the files are in should be included, or they will
2375 have to be recreated manually if a bare metal restore is done.
2380 File = C:/Program Files/Exchsrvr/mdbdata
2381 Plugin = "exchange:..."
2384 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2385 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2386 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2387 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2388 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2389 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2390 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2395 The advantage of excluding the above files is that you can significantly
2396 reduce the size of your backup since all the important Exchange files
2397 will be properly saved by the Plugin.
2400 \subsubsection{Restoring}
2401 The restore operation is much the same as a normal Bacula restore, with
2402 the following provisos:
2405 \item The {\bf Where} restore option must not be specified
2406 \item Each Database directory must be marked as a whole. You cannot just
2407 select (say) the .edb file and not the others.
2408 \item If a Storage Group is restored, the directory of the Storage Group
2410 \item It is possible to restore only a subset of the available log files,
2411 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2412 if a log file is missing from the sequence of log files
2413 \item Each database to be restored must be dismounted and marked as "Can be
2414 overwritten by restore"
2415 \item If an entire Storage Group is to be restored (eg all databases and
2416 logs in the Storage Group), then it is best to manually delete the
2417 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2418 as Exchange can get confused by stray log files lying around.
2421 \subsubsection{Restoring to the Recovery Storage Group}
2422 The concept of the Recovery Storage Group is well documented by
2424 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2425 but to briefly summarize...
2427 Microsoft Exchange allows the creation of an additional Storage Group
2428 called the Recovery Storage Group, which is used to restore an older
2429 copy of a database (e.g. before a mailbox was deleted) into without
2430 messing with the current live data. This is required as the Standard and
2431 Small Business Server versions of Exchange can not ordinarily have more
2432 than one Storage Group.
2434 To create the Recovery Storage Group, drill down to the Server in Exchange
2435 System Manager, right click, and select
2436 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2437 locations and click OK. On the Recovery Storage Group, right click and
2438 select {\bf "Add Database to Recover..."} and select the database you will
2441 Restore only the single database nominated as the database in the
2442 Recovery Storage Group. Exchange will redirect the restore to the
2443 Recovery Storage Group automatically.
2444 Then run the restore.
2446 \subsubsection{Restoring on Microsoft Server 2007}
2447 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2448 2007, and hence you use a new procedure for recovering a single mail box.
2449 This procedure is documented by Microsoft at:
2450 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2451 and involves using the {\bf Restore-Mailbox} and {\bf
2452 Get-Mailbox Statistics} shell commands.
2454 \subsubsection{Caveats}
2455 This plugin is still being developed, so you should consider it
2456 currently in BETA test, and thus use in a production environment
2457 should be done only after very careful testing.
2459 When doing a full backup, the Exchange database logs are truncated by
2460 Exchange as soon as the plugin has completed the backup. If the data
2461 never makes it to the backup medium (eg because of spooling) then the
2462 logs will still be truncated, but they will also not have been backed
2463 up. A solution to this is being worked on. You will have to schedule a
2464 new Full backup to ensure that your next backups will be usable.
2466 The "Enable Circular Logging" option cannot be enabled or the plugin
2469 Exchange insists that a successful Full backup must have taken place if
2470 an Incremental or Differential backup is desired, and the plugin will
2471 fail if this is not the case. If a restore is done, Exchange will
2472 require that a Full backup be done before an Incremental or Differential
2475 The plugin will most likely not work well if another backup application
2476 (eg NTBACKUP) is backing up the Exchange database, especially if the
2477 other backup application is truncating the log files.
2479 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2480 we recommend either carefully testing or that you avoid this option for
2483 The Exchange plugin is not called during processing the bconsole {\bf
2484 estimate} command, and so anything that would be backed up by the plugin
2485 will not be added to the estimate total that is displayed.
2488 \subsection{libdbi Framework}
2489 \index[general]{libdbi Framework}
2490 As a general guideline, Bacula has support for a few catalog database drivers
2491 (MySQL, PostgreSQL, SQLite)
2492 coded natively by the Bacula team. With the libdbi implementation, which is a
2493 Bacula driver that uses libdbi to access the catalog, we have an open field to
2494 use many different kinds database engines following the needs of users.
2496 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2497 implements a database-independent abstraction layer in C, similar to the
2498 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2499 leverage the power of multiple databases and multiple simultaneous database
2500 connections by using this framework.
2502 Currently the libdbi driver in Bacula project only supports the same drivers
2503 natively coded in Bacula. However the libdbi project has support for many
2504 others database engines. You can view the list at
2505 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2506 supported by Bacula, however, they must be tested properly by the Bacula team.
2508 Some of benefits of using libdbi are:
2510 \item The possibility to use proprietary databases engines in which your
2511 proprietary licenses prevent the Bacula team from developing the driver.
2512 \item The possibility to use the drivers written for the libdbi project.
2513 \item The possibility to use other database engines without recompiling Bacula
2514 to use them. Just change one line in bacula-dir.conf
2515 \item Abstract Database access, this is, unique point to code and profiling
2516 catalog database access.
2519 The following drivers have been tested:
2521 \item PostgreSQL, with and without batch insert
2522 \item Mysql, with and without batch insert
2527 In the future, we will test and approve to use others databases engines
2528 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2530 To compile Bacula to support libdbi we need to configure the code with the
2531 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2532 [database] is the database engine to be used with Bacula (of course we can
2533 change the driver in file bacula-dir.conf, see below). We must configure the
2534 access port of the database engine with the option --with-db-port, because the
2535 libdbi framework doesn't know the default access port of each database.
2537 The next phase is checking (or configuring) the bacula-dir.conf, example:
2541 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2542 dbname = regress; user = regress; password = ""
2546 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2547 mysql database. Currently the drivers supported by Bacula are: postgresql,
2548 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2550 The following limitations apply when Bacula is set to use the libdbi framework:
2551 - Not tested on the Win32 platform
2552 - A little performance is lost if comparing with native database driver.
2553 The reason is bound with the database driver provided by libdbi and the
2554 simple fact that one more layer of code was added.
2556 It is important to remember, when compiling Bacula with libdbi, the
2557 following packages are needed:
2559 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2560 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2563 You can download them and compile them on your system or install the packages
2564 from your OS distribution.
2566 \subsection{Console Command Additions and Enhancements}
2567 \index[general]{Console Additions}
2569 \subsubsection{Display Autochanger Content}
2570 \index[general]{StatusSlots}
2572 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2573 autochanger content.
2577 Slot | Volume Name | Status | Media Type | Pool |
2578 ------+---------------+----------+-------------------+------------|
2579 1 | 00001 | Append | DiskChangerMedia | Default |
2580 2 | 00002 | Append | DiskChangerMedia | Default |
2581 3*| 00003 | Append | DiskChangerMedia | Scratch |
2586 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2587 {\bf update slots} command to synchronize autochanger content with your
2590 \subsubsection{list joblog job=xxx or jobid=nnn}
2591 \index[general]{list joblog}
2592 A new list command has been added that allows you to list the contents
2593 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2594 or for a particular JobId. The {\bf llist} command will include a line with
2595 the time and date of the entry.
2597 Note for the catalog to have Job Log entries, you must have a directive
2604 In your Director's {\bf Messages} resource.
2606 \subsubsection{Use separator for multiple commands}
2607 \index[general]{Command Separator}
2608 When using bconsole with readline, you can set the command separator with
2609 \textbf{@separator} command to one
2610 of those characters to write commands who require multiple input in one line.
2612 !$%&'()*+,-/:;<>?[]^`{|}~
2615 \subsubsection{Deleting Volumes}
2616 The delete volume bconsole command has been modified to
2617 require an asterisk (*) in front of a MediaId otherwise the
2618 value you enter is a taken to be a Volume name. This is so that
2619 users may delete numeric Volume names. The previous Bacula versions
2620 assumed that all input that started with a number was a MediaId.
2622 This new behavior is indicated in the prompt if you read it
2625 \subsection{Bare Metal Recovery}
2626 The old bare metal recovery project is essentially dead. One
2627 of the main features of it was that it would build a recovery
2628 CD based on the kernel on your system. The problem was that
2629 every distribution has a different boot procedure and different
2630 scripts, and worse yet, the boot procedures and scripts change
2631 from one distribution to another. This meant that maintaining
2632 (keeping up with the changes) the rescue CD was too much work.
2634 To replace it, a new bare metal recovery USB boot stick has been developed
2635 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2636 boot from a USB key.
2640 \item Recovery can be done from within graphical environment.
2641 \item Recovery can be done in a shell.
2642 \item Ubuntu boots on a large number of Linux systems.
2643 \item The process of updating the system and adding new
2644 packages is not too difficult.
2645 \item The USB key can easily be upgraded to newer Ubuntu versions.
2646 \item The USB key has writable partitions for modifications to
2647 the OS and for modification to your home directory.
2648 \item You can add new files/directories to the USB key very easily.
2649 \item You can save the environment from multiple machines on
2651 \item Bacula Systems is funding its ongoing development.
2654 The disadvantages are:
2656 \item The USB key is usable but currently under development.
2657 \item Not everyone may be familiar with Ubuntu (no worse
2659 \item Some older OSes cannot be booted from USB. This can
2660 be resolved by first booting a Ubuntu LiveCD then plugging
2662 \item Currently the documentation is sketchy and not yet added
2663 to the main manual. See below ...
2666 The documentation and the code can be found in the {\bf rescue} package
2667 in the directory {\bf linux/usb}.
2669 \subsection{Miscellaneous}
2670 \index[general]{Misc New Features}
2672 \subsubsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2673 \index[general]{Allow Mixed Priority}
2674 This directive is only implemented in version 2.5 and later. When
2675 set to {\bf yes} (default {\bf no}), this job may run even if lower
2676 priority jobs are already running. This means a high priority job
2677 will not have to wait for other jobs to finish before starting.
2678 The scheduler will only mix priorities when all running jobs have
2681 Note that only higher priority jobs will start early. Suppose the
2682 director will allow two concurrent jobs, and that two jobs with
2683 priority 10 are running, with two more in the queue. If a job with
2684 priority 5 is added to the queue, it will be run as soon as one of
2685 the running jobs finishes. However, new priority 10 jobs will not
2686 be run until the priority 5 job has finished.
2688 \subsubsection{Bootstrap File Directive -- FileRegex}
2689 \index[general]{Bootstrap File Directive}
2690 {\bf FileRegex} is a new command that can be added to the bootstrap
2691 (.bsr) file. The value is a regular expression. When specified, only
2692 matching filenames will be restored.
2694 During a restore, if all File records are pruned from the catalog
2695 for a Job, normally Bacula can restore only all files saved. That
2696 is there is no way using the catalog to select individual files.
2697 With this new feature, Bacula will ask if you want to specify a Regex
2698 expression for extracting only a part of the full backup.
2701 Building directory tree for JobId(s) 1,3 ...
2702 There were no files inserted into the tree, so file selection
2703 is not possible.Most likely your retention policy pruned the files
2705 Do you want to restore all the files? (yes\vb{}no): no
2707 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2708 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2711 \subsubsection{Bootstrap File Optimization Changes}
2712 In order to permit proper seeking on disk files, we have extended the bootstrap
2713 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2714 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2715 address range and end address range respectively. These two directives replace
2716 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2717 VolEndBlock} directives. Bootstrap files containing the old directives will
2718 still work, but will not properly take advantage of proper disk seeking, and
2719 may read completely to the end of a disk volume during a restore. With the new
2720 format (automatically generated by the new Director), restores will seek
2721 properly and stop reading the volume when all the files have been restored.
2723 \subsubsection{Solaris ZFS/NFSv4 ACLs}
2724 This is an upgrade of the previous Solaris ACL backup code
2725 to the new library format, which will backup both the old
2726 POSIX(UFS) ACLs as well as the ZFS ACLs.
2728 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2729 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2730 be used to transfer from UFS to ZFS filesystems.
2733 \subsubsection{Virtual Tape Emulation}
2734 \index[general]{Virtual Tape Emulation}
2735 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2736 the tape code but actually reading and writing to a disk file. Used with the
2737 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2738 and 700 slots. This feature is most useful in testing. It is enabled
2739 by using {\bf Device Type = vtape} in the Storage daemon's Device
2740 directive. This feature is only implemented on Linux machines and should not be
2741 used for production.
2743 \subsubsection{Bat Enhancements}
2744 \index[general]{Bat Enhancements}
2745 Bat (the Bacula Administration Tool) GUI program has been significantly
2746 enhanced and stabilized. In particular, there are new table based status
2747 commands; it can now be easily localized using Qt4 Linguist.
2749 The Bat communications protocol has been significantly enhanced to improve
2750 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2751 the Director you are using otherwise the communications protocol will not
2754 \subsubsection{RunScript Enhancements}
2755 \index[general]{RunScript Enhancements}
2756 The {\bf RunScript} resource has been enhanced to permit multiple
2757 commands per RunScript. Simply specify multiple {\bf Command} directives
2764 Command = "/bin/echo test"
2765 Command = "/bin/echo an other test"
2766 Command = "/bin/echo 3 commands in the same runscript"
2773 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2774 implemented, which runs the command after the Volume Shadow Copy has been made.
2776 Console commands can be specified within a RunScript by using:
2777 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2778 carefully tested and debugged and is known to easily crash the Director.
2779 We would appreciate feedback. Due to the recursive nature of this command, we
2780 may remove it before the final release.
2782 \subsubsection{Status Enhancements}
2783 \index[general]{Status Enhancements}
2784 The bconsole {\bf status dir} output has been enhanced to indicate
2785 Storage daemon job spooling and despooling activity.
2787 \subsubsection{Connect Timeout}
2788 \index[general]{Connect Timeout}
2789 The default connect timeout to the File
2790 daemon has been set to 3 minutes. Previously it was 30 minutes.
2792 \subsubsection{ftruncate for NFS Volumes}
2793 \index[general]{ftruncate for NFS Volumes}
2794 If you write to a Volume mounted by NFS (say on a local file server),
2795 in previous Bacula versions, when the Volume was recycled, it was not
2796 properly truncated because NFS does not implement ftruncate (file
2797 truncate). This is now corrected in the new version because we have
2798 written code (actually a kind user) that deletes and recreates the Volume,
2799 thus accomplishing the same thing as a truncate.
2801 \subsubsection{Support for Ubuntu}
2802 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2803 version of Linux, and thus now provides correct autostart routines.
2804 Since Ubuntu officially supports Bacula, you can also obtain any
2805 recent release of Bacula from the Ubuntu repositories.
2807 \subsubsection{Recycle Pool = \lt{}pool-name\gt{}}
2808 \index[general]{Recycle Pool}
2809 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2810 be placed (moved) when it is recycled. Without this directive, a Volume will
2811 remain in the same pool when it is recycled. With this directive, it can be
2812 moved automatically to any existing pool during a recycle. This directive is
2813 probably most useful when defined in the Scratch pool, so that volumes will
2814 be recycled back into the Scratch pool.
2816 \subsubsection{FD Version}
2817 \index[general]{FD Version}
2818 The File daemon to Director protocol now includes a version
2819 number, which although there is no visible change for users,
2820 will help us in future versions automatically determine
2821 if a File daemon is not compatible.
2823 \subsubsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2824 \index[general]{Max Run Sched Time}
2825 The time specifies the maximum allowed time that a job may run, counted from
2826 when the job was scheduled. This can be useful to prevent jobs from running
2827 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2830 \subsubsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2831 \index[general]{Max Wait Time}
2832 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2833 of checking the maximum allowed time that a job may block for a resource,
2834 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2835 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2836 their job depending on the level. Now, they have to use
2837 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2838 directives are now deprecated.
2840 \subsubsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2841 \index[general]{Incremental Max Wait Time}
2842 \index[general]{Differential Max Wait Time}
2844 These directives have been deprecated in favor of
2845 \texttt{Incremental|Differential Max Run Time}.
2847 \subsubsection{Max Run Time directives}
2848 \index[general]{Max Run Time directives}
2849 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2850 maximum allowed time that a job can run depending on the level.
2852 \addcontentsline{lof}{figure}{Job time control directives}
2854 \includegraphics[width=\linewidth]{different_time}
2857 \subsubsection{Statistics Enhancements}
2858 \index[general]{Statistics Enhancements}
2859 If you (or probably your boss) want to have statistics on your backups to
2860 provide some \textit{Service Level Agreement} indicators, you could use a few
2861 SQL queries on the Job table to report how many:
2865 \item jobs have been successful
2866 \item files have been backed up
2870 However, these statistics are accurate only if your job retention is greater
2871 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2872 be able to use them.
2874 Now, you can use the \textbf{update stats [days=num]} console command to fill
2875 the JobHistory table with new Job records. If you want to be sure to take in
2876 account only \textbf{good jobs}, ie if one of your important job has failed but
2877 you have fixed the problem and restarted it on time, you probably want to
2878 delete the first \textit{bad} job record and keep only the successful one. For
2879 that simply let your staff do the job, and update JobHistory table after two or
2880 three days depending on your organization using the \textbf{[days=num]} option.
2882 These statistics records aren't used for restoring, but mainly for
2883 capacity planning, billings, etc.
2885 The Bweb interface provides a statistics module that can use this feature. You
2886 can also use tools like Talend or extract information by yourself.
2888 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2889 the length of time that Bacula will keep statistics job records in the Catalog
2890 database after the Job End time. (In \texttt{JobHistory} table) When this time
2891 period expires, and if user runs \texttt{prune stats} command, Bacula will
2892 prune (remove) Job records that are older than the specified period.
2894 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2895 job to maintain statistics.
2898 Name = BackupCatalog
2901 Console = "update stats days=3"
2902 Console = "prune stats yes"
2909 \subsubsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2910 \index[general]{ScratchPool}
2911 This directive permits to specify a specific \textsl{Scratch} pool for the
2912 current pool. This is useful when using multiple storage sharing the same
2913 mediatype or when you want to dedicate volumes to a particular set of pool.
2915 \subsubsection{Enhanced Attribute Despooling}
2916 \index[general]{Attribute Despooling}
2917 If the storage daemon and the Director are on the same machine, the spool file
2918 that contains attributes is read directly by the Director instead of being
2919 transmitted across the network. That should reduce load and speedup insertion.
2921 \subsubsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2922 \index[general]{SpoolSize}
2923 A new Job directive permits to specify the spool size per job. This is used
2924 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2926 \subsubsection{MaximumConsoleConnections = \lt{}number\gt{}}
2927 \index[general]{MaximumConsoleConnections}
2928 A new director directive permits to specify the maximum number of Console
2929 Connections that could run concurrently. The default is set to 20, but you may
2930 set it to a larger number.
2932 \subsubsection{VerId = \lt{}string\gt{}}
2933 \index[general]{VerId}
2934 A new director directive permits to specify a personnal identifier that will be
2935 displayed in the \texttt{version} command.
2937 \subsubsection{dbcheck enhancements}
2938 \index[general]{dbcheck enhancements}
2939 If you are using Mysql, dbcheck will now ask you if you want to create
2940 temporary indexes to speed up orphaned Path and Filename elimination.
2942 A new \texttt{-B} option allows you to print catalog information in a simple
2943 text based format. This is useful to backup it in a secure way.
2958 You can now specify the database connection port in the command line.
2960 \subsubsection{{-}{-}docdir configure option}
2961 \index[general]{{-}{-}docdir configure option}
2962 You can use {-}{-}docdir= on the ./configure command to
2963 specify the directory where you want Bacula to install the
2964 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2965 {\bf /usr/share/doc/bacula}.
2967 \subsubsection{{-}{-}htmldir configure option}
2968 \index[general]{{-}{-}htmldir configure option}
2969 You can use {-}{-}htmldir= on the ./configure command to
2970 specify the directory where you want Bacula to install the bat html help
2971 files. The default is {\bf /usr/share/doc/bacula/html}
2973 \subsubsection{{-}{-}with-plugindir configure option}
2974 \index[general]{{-}{-}plugindir configure option}
2975 You can use {-}{-}plugindir= on the ./configure command to
2976 specify the directory where you want Bacula to install
2977 the plugins (currently only bpipe-fd). The default is