1 \chapter{New Features in 7.0.0}
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 7.0.0}
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"
27 \chapter{New Features in 5.2.13}
28 This chapter presents the new features that have been added to the current
29 Community version of Bacula that is now released.
31 \subsection{Additions to RunScript variables}
32 You can have access to Director name using \%D in your runscript
36 RunAfterJob = "/bin/echo Director=%D
39 \section{New Features in 5.2.1}
40 This chapter presents the new features were added in the
41 Community release version 5.2.1.
43 There are additional features (plugins) available in the Enterprise version
44 that are described in another chapter. A subscription to Bacula Systems
45 is required for the Enterprise version.
47 \subsection{LZO Compression}
49 LZO compression has been to the File daemon. From the user's point of view,
50 it works like the GZIP compression (just replace {\bf compression=GZIP} with
51 {\bf compression=LZO}).
56 Options {compression=LZO }
62 LZO provides a much faster compression and decompression speed but lower
63 compression ratio than GZIP. It is a good option when you backup to disk. For
64 tape, the hardware compression is almost always a better option.
66 LZO is a good alternative for GZIP1 when you don't want to slow down your
67 backup. With a modern CPU it should be able to run almost as fast as:
70 \item your client can read data from disk. Unless you have very fast disks like
71 SSD or large/fast RAID array.
72 \item the data transfers between the file daemon and the storage daemon even on
76 Note, Bacula uses compression level LZO1X-1.
79 The code for this feature was contributed by Laurent Papier.
81 \subsection{New Tray Monitor}
83 Since the old integrated Windows tray monitor doesn't work with
84 recent Windows versions, we have written a new Qt Tray Monitor that is available
85 for both Linux and Windows. In addition to all the previous features,
86 this new version allows you to run Backups from
87 the tray monitor menu.
91 \includegraphics[width=0.8\linewidth]{tray-monitor}
92 \label{fig:traymonitor}
93 \caption{New tray monitor}
98 \includegraphics[width=0.8\linewidth]{tray-monitor1}
99 \label{fig:traymonitor1}
100 \caption{Run a Job through the new tray monitor}
104 To be able to run a job from the tray monitor, you need to
105 allow specific commands in the Director monitor console:
110 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
111 ClientACL = *all* # you can restrict to a specific host
123 This project was funded by Bacula Systems and is available with Bacula
124 the Enterprise Edition and the Community Edition.
126 \subsection{Purge Migration Job}
128 The new {\bf Purge Migration Job} directive may be added to the Migration
129 Job definition in the Director's configuration file. When it is enabled
130 the Job that was migrated during a migration will be purged at
131 the end of the migration job.
139 Client = localhost-fd
142 Storage = DiskChanger
145 Selection Pattern = ".*Save"
147 Purge Migration Job = yes
153 This project was submitted by Dunlap Blake; testing and documentation was funded
156 \subsection{Changes in Bvfs (Bacula Virtual FileSystem)}
158 Bat has now a bRestore panel that uses Bvfs to display files and
163 \includegraphics[width=0.8\linewidth]{bat-brestore}
164 \label{fig:batbrestore}
165 \caption{Bat Brestore Panel}
168 the Bvfs module works correctly with BaseJobs, Copy and Migration jobs.
171 This project was funded by Bacula Systems.
173 \subsubsection*{General notes}
176 \item All fields are separated by a tab
177 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
178 records in very big directories
179 \item All operations (except cache creation) are designed to run instantly
180 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
181 can contribute new faster SQL queries we will be happy, else don't complain
183 \item The cache creation is dependent of the number of directories. As Bvfs
184 shares information across jobs, the first creation can be slow
185 \item All fields are separated by a tab
186 \item Due to potential encoding problem, it's advised to always use pathid in
190 \subsubsection*{Get dependent jobs from a given JobId}
192 Bvfs allows you to query the catalog against any combination of jobs. You
193 can combine all Jobs and all FileSet for a Client in a single session.
195 To get all JobId needed to restore a particular job, you can use the
196 \texttt{.bvfs\_get\_jobids} command.
199 .bvfs_get_jobids jobid=num [all]
203 .bvfs_get_jobids jobid=10
205 .bvfs_get_jobids jobid=10 all
209 In this example, a normal restore will need to use JobIds 1,2,5,10 to
210 compute a complete restore of the system.
212 With the \texttt{all} option, the Director will use all defined FileSet for
215 \subsubsection*{Generating Bvfs cache}
217 The \texttt{.bvfs\_update} command computes the directory cache for jobs
218 specified in argument, or for all jobs if unspecified.
221 .bvfs_update [jobid=numlist]
226 .bvfs_update jobid=1,2,3
229 You can run the cache update process in a RunScript after the catalog backup.
231 \subsubsection*{Get all versions of a specific file}
233 Bvfs allows you to find all versions of a specific file for a given Client with
234 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
235 function uses only PathId and FilenameId. The jobid argument is mandatory but
239 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
240 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
241 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
248 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
249 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
252 \subsubsection*{List directories}
254 Bvfs allows you to list directories in a specific path.
256 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
257 PathId FilenameId FileId JobId LStat Path
258 PathId FilenameId FileId JobId LStat Path
259 PathId FilenameId FileId JobId LStat Path
263 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
264 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
265 listed is a directory.
268 .bvfs_lsdirs pathid=4 jobid=1,11,12
269 4 0 0 0 A A A A A A A A A A A A A A .
270 5 0 0 0 A A A A A A A A A A A A A A ..
271 3 0 0 0 A A A A A A A A A A A A A A regress/
274 In this example, to list directories present in \texttt{regress/}, you can use
276 .bvfs_lsdirs pathid=3 jobid=1,11,12
277 3 0 0 0 A A A A A A A A A A A A A A .
278 4 0 0 0 A A A A A A A A A A A A A A ..
279 2 0 0 0 A A A A A A A A A A A A A A tmp/
282 \subsubsection*{List files}
284 Bvfs allows you to list files in a specific path.
286 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
287 PathId FilenameId FileId JobId LStat Path
288 PathId FilenameId FileId JobId LStat Path
289 PathId FilenameId FileId JobId LStat Path
293 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
294 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
298 .bvfs_lsfiles pathid=4 jobid=1,11,12
299 4 0 0 0 A A A A A A A A A A A A A A .
300 5 0 0 0 A A A A A A A A A A A A A A ..
301 1 0 0 0 A A A A A A A A A A A A A A regress/
304 In this example, to list files present in \texttt{regress/}, you can use
306 .bvfs_lsfiles pathid=1 jobid=1,11,12
307 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
308 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
309 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
310 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
311 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
314 \subsubsection*{Restore set of files}
316 Bvfs allows you to create a SQL table that contains files that you want to
317 restore. This table can be provided to a restore command with the file option.
320 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
322 restore file=?b2num ...
325 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
326 select all files. This query could be time consuming.
328 \texttt{hardlink} list is always composed of a series of two numbers (jobid,
329 fileindex). This information can be found in the LinkFI field of the LStat
332 The \texttt{path} argument represents the name of the table that Bvfs will
333 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
334 b2 and followed by digits).
339 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
343 \subsubsection*{Cleanup after Restore}
345 To drop the table used by the restore command, you can use the
346 \texttt{.bvfs\_cleanup} command.
349 .bvfs_cleanup path=b20001
352 \subsubsection*{Clearing the BVFS Cache}
354 To clear the BVFS cache, you can use the \texttt{.bvfs\_clear\_cache} command.
357 .bvfs_clear_cache yes
361 \subsection{Changes in the Pruning Algorithm}
363 We rewrote the job pruning algorithm in this version. Previously, in some users
364 reported that the pruning process at the end of jobs was very long. It should
365 not be longer the case. Now, Bacula won't prune automatically a Job if this
366 particular Job is needed to restore data. Example:
370 JobId: 2 Level: Incremental
371 JobId: 3 Level: Incremental
372 JobId: 4 Level: Differential
373 .. Other incrementals up to now
376 In this example, if the Job Retention defined in the Pool or in the Client
377 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
378 detect that JobId 1 and 4 are essential to restore data at the current state
379 and will prune only JobId 2 and 3.
381 \texttt{Important}, this change affect only the automatic pruning step after a
382 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
383 \texttt{VolumeRetention} period, important jobs can be pruned.
385 \subsection{Ability to Verify any specified Job}
386 You now have the ability to tell Bacula which Job should verify instead of
387 automatically verify just the last one.
389 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
391 To verify a given job, just specify the Job jobid in argument when starting the
394 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
396 JobName: VerifyVolume
397 Level: VolumeToCatalog
400 Pool: Default (From Job resource)
401 Storage: File (From Job resource)
402 Verify Job: VerifyVol.2010-09-08_14.17.17_03
403 Verify List: /tmp/regress/working/VerifyVol.bsr
404 When: 2010-09-08 14:17:31
406 OK to run? (yes/mod/no):
410 This project was funded by Bacula Systems and is available with Bacula
411 Enterprise Edition and Community Edition.
413 \subsection{Additions to RunScript variables}
414 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
415 command. The Client address is now available through \%h.
418 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
421 %\subsection{Changes in drivetype.exe}
423 %Now the \texttt{drivetype.exe} program allows you to list all local hard
424 %drives. It can help to build dynamic FileSet on Windows.
427 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
431 \subsection{Additions to the Plugin API}
432 The bfuncs structure has been extended to include a number of
435 \subsubsection{bfuncs}
436 The bFuncs structure defines the callback entry points within Bacula
437 that the plugin can use register events, get Bacula values, set
438 Bacula values, and send messages to the Job output or debug output.
440 The exact definition as of this writing is:
442 typedef struct s_baculaFuncs {
445 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
446 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
447 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
448 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
449 int type, utime_t mtime, const char *fmt, ...);
450 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
451 int level, const char *fmt, ...);
452 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
454 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
456 /* New functions follow */
457 bRC (*AddExclude)(bpContext *ctx, const char *file);
458 bRC (*AddInclude)(bpContext *ctx, const char *file);
459 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
460 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
461 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
462 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
468 \item [AddExclude] can be called to exclude a file. The file
469 string passed may include wildcards that will be interpreted by
470 the {\bf fnmatch} subroutine. This function can be called
471 multiple times, and each time the file specified will be added
472 to the list of files to be excluded. Note, this function only
473 permits adding excludes of specific file or directory names,
474 or files matched by the rather simple fnmatch mechanism.
475 See below for information on doing wild-card and regex excludes.
477 \item [NewPreInclude] can be called to create a new Include block. This
478 block will be added after the current defined Include block. This
479 function can be called multiple times, but each time, it will create
480 a new Include section (not normally needed). This function should
481 be called only if you want to add an entirely new Include block.
483 \item [NewInclude] can be called to create a new Include block. This
484 block will be added before any user defined Include blocks. This
485 function can be called multiple times, but each time, it will create
486 a new Include section (not normally needed). This function should
487 be called only if you want to add an entirely new Include block.
489 \item [AddInclude] can be called to add new files/directories to
490 be included. They are added to the current Include block. If
491 NewInclude has not been included, the current Include block is
492 the last one that the user created. This function
493 should be used only if you want to add totally new files/directories
494 to be included in the backup.
496 \item [NewOptions] adds a new Options block to the current Include
497 in front of any other Options blocks. This permits the plugin to
498 add exclude directives (wild-cards and regexes) in front of the
499 user Options, and thus prevent certain files from being backed up.
500 This can be useful if the plugin backs up files, and they should
501 not be also backed up by the main Bacula code. This function
502 may be called multiple times, and each time, it creates a new
503 prepended Options block. Note: normally you want to call this
504 entry point prior to calling AddOptions, AddRegex, or AddWild.
506 \item [AddOptions] allows the plugin it set options in
507 the current Options block, which is normally created with the
508 NewOptions call just prior to adding Include Options.
509 The permitted options are passed as a character string, where
510 each character has a specific meaning as defined below:
513 \item [a] always replace files (default).
514 \item [e] exclude rather than include.
515 \item [h] no recursion into subdirectories.
516 \item [H] do not handle hard links.
517 \item [i] ignore case in wildcard and regex matches.
518 \item [M] compute an MD5 sum.
519 \item [p] use a portable data format on Windows (not recommended).
520 \item [R] backup resource forks and Findr Info.
521 \item [r] read from a fifo
522 \item [S1] compute an SHA1 sum.
523 \item [S2] compute an SHA256 sum.
524 \item [S3] comput an SHA512 sum.
525 \item [s] handle sparse files.
526 \item [m] use st\_mtime only for file differences.
527 \item [k] restore the st\_atime after accessing a file.
528 \item [A] enable ACL backup.
529 \item [Vxxx:] specify verify options. Must terminate with :
530 \item [Cxxx:] specify accurate options. Must terminate with :
531 \item [Jxxx:] specify base job Options. Must terminate with :
532 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
534 \item [Zn] specify gzip compression level n.
535 \item [K] do not use st\_atime in backup decision.
536 \item [c] check if file changed during backup.
537 \item [N] honor no dump flag.
538 \item [X] enable backup of extended attributes.
541 \item [AddRegex] adds a regex expression to the current Options block.
542 The following options are permitted:
544 \item [ ] (a blank) regex applies to whole path and filename.
545 \item [F] regex applies only to the filename (directory or path stripped).
546 \item [D] regex applies only to the directory (path) part of the name.
549 \item [AddWild] adds a wildcard expression to the current Options block.
550 The following options are permitted:
552 \item [ ] (a blank) regex applies to whole path and filename.
553 \item [F] regex applies only to the filename (directory or path stripped).
554 \item [D] regex applies only to the directory (path) part of the name.
557 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
558 that can use Accurate code to compare the file information in argument with
559 the previous file information. The \texttt{delta\_seq} attribute of the
560 \texttt{save\_pkt} will be updated, and the call will return
561 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
566 \subsubsection{Bacula events}
567 The list of events has been extended to include:
573 bEventStartBackupJob = 3,
574 bEventEndBackupJob = 4,
575 bEventStartRestoreJob = 5,
576 bEventEndRestoreJob = 6,
577 bEventStartVerifyJob = 7,
578 bEventEndVerifyJob = 8,
579 bEventBackupCommand = 9,
580 bEventRestoreCommand = 10,
585 bEventCancelCommand = 13,
586 bEventVssBackupAddComponents = 14,
587 bEventVssRestoreLoadComponentMetadata = 15,
588 bEventVssRestoreSetComponentsSelected = 16,
589 bEventRestoreObject = 17,
590 bEventEndFileSet = 18,
591 bEventPluginCommand = 19,
592 bEventVssBeforeCloseRestore = 20,
593 bEventVssPrepareSnapshot = 21
599 \item [bEventCancelCommand] is called whenever the currently
600 running Job is canceled */
602 \item [bEventVssBackupAddComponents]
604 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
605 provides a char[27] table where the plugin can add Windows drives that will
606 be used during the Job. You need to add them without duplicates, and you can
607 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
611 \subsection{ACL enhancements}
613 The following enhancements are made to the Bacula Filed with regards to
614 Access Control Lists (ACLs)
617 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
618 POSIX and NFSv4 ACLs.
619 \item Added support for new acl types on FreeBSD 8.1 and later which supports
620 POSIX and NFSv4 ACLs.
621 \item Some generic cleanups for internal ACL handling.
622 \item Fix for acl storage on OSX
623 \item Cleanup of configure checks for ACL detection, now configure only
624 tests for a certain interface type based on the operating system
625 this should give less false positives on detection. Also when ACLs
626 are detected no other acl checks are performed anymore.
630 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
631 and is available with Bacula Enterprise Edition and Community Edition.
633 \subsection{XATTR enhancements}
635 The following enhancements are made to the Bacula Filed with regards to
636 Extended Attributes (XATTRs)
639 \item Added support for IRIX extended attributes using the attr\_get interface.
640 \item Added support for Tru64 (OSF1) extended attributes using the
641 getproplist interface.
642 \item Added support for AIX extended attributes available in AIX 6.x
643 and higher using the listea/getea/setea interface.
644 \item Added some debugging to generic xattr code so it easier to
646 \item Cleanup of configure checks for XATTR detection, now configure only
647 tests for a certain interface type based on the operating system
648 this should give less false positives on detection. Also when xattrs
649 are detected no other xattr checks are performed anymore.
653 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
654 and is available with Bacula Enterprise Edition and Community Edition.
656 \subsection{Class Based Database Backend Drivers}
658 The main Bacula Director code is independent of the SQL backend
659 in version 5.2.0 and greater. This means that the Bacula Director can be
660 packaged by itself, then each of the different SQL backends supported can
661 be packaged separately. It is possible to build all the DB backends at the
662 same time by including multiple database options at the same time.
664 ./configure can be run with multiple database configure options.
671 Order of testing for databases is:
678 Each configured backend generates a file named:
679 \verb+libbaccats-<sql_backend_name>-<version>.so+
680 A dummy catalog library is created named libbaccats-version.so
682 At configure time the first detected backend is used as the so called
683 default backend and at install time the dummy
684 \verb+libbaccats-<version>.so+ is replaced with the default backend type.
686 If you configure all three backends you get three backend libraries and the
687 postgresql gets installed as the default.
689 When you want to switch to another database, first save any old catalog you
690 may have then you can copy one of the three backend libraries over the
691 \verb+libbaccats-<version>.so+ e.g.
693 An actual command, depending on your Bacula version might be:
695 cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
698 where the \verb+5.2.2+ must be replaced by the Bacula release
701 Then you must update the default backend in the following files:
704 create_bacula_database
707 grant_bacula_privileges
713 And re-run all the above scripts. Please note, this means
714 you will have a new empty database and if you had a previous
717 All current database backend drivers for catalog information are rewritten
718 to use a set of multi inherited C++ classes which abstract the specific
719 database specific internals and make sure we have a more stable generic
720 interface with the rest of SQL code. From now on there is a strict
721 boundary between the SQL code and the low-level database functions. This
722 new interface should also make it easier to add a new backend for a
723 currently unsupported database. As part of the rewrite the SQLite 2 code
724 was removed (e.g. only SQLite 3 is now supported). An extra bonus of the
725 new code is that you can configure multiple backends in the configure and
726 build all backends in one compile session and select the correct database
727 backend at install time. This should make it a lot easier for packages
733 We also added cursor support for PostgreSQL backend, this improves memory
734 usage for large installation.
737 This project was implemented by Planets Communications B.V. and ELM
738 Consultancy B.V. and Bacula Systems and is available with both the Bacula
739 Enterprise Edition and the Community Edition.
741 \subsection{Hash List Enhancements}
743 The htable hash table class has been extended with extra hash functions for
744 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
745 Also the hash table initialization routines have been enhanced with
746 support for passing a hint as to the number of initial pages to use
747 for the size of the hash table. Until now the hash table always used
748 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
749 cache have been rewritten to use the new htable class with a small memory
753 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
754 and Bacula Systems and is available with Bacula Enterprise Edition and
759 %%% =====================================================================
764 \section{Release Version 5.0.3}
766 There are no new features in version 5.0.2. This version simply fixes a
767 number of bugs found in version 5.0.1 during the ongoing development
770 \section{Release Version 5.0.2}
772 There are no new features in version 5.0.2. This version simply fixes a
773 number of bugs found in version 5.0.1 during the ongoing development
779 \section{New Features in 5.0.1}
781 This chapter presents the new features that are in the released Bacula version
782 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
783 the ongoing development process.
785 \subsection{Truncate Volume after Purge}
786 \label{sec:actiononpurge}
788 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
789 the volume when it is purged with the new command \texttt{purge volume
790 action}. It is useful to prevent disk based volumes from consuming too much
796 Action On Purge = Truncate
801 As usual you can also set this property with the \texttt{update volume} command
803 *update volume=xxx ActionOnPurge=Truncate
804 *update volume=xxx actiononpurge=None
807 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
808 following command in interactive mode or in a RunScript as shown after:
810 *purge volume action=truncate storage=File allpools
811 # or by default, action=all
812 *purge volume action storage=File pool=Default
815 This is possible to specify the volume name, the media type, the pool, the
816 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
817 idle when you decide to run this command.
826 Console = "purge volume action=all allpools storage=File"
831 \textbf{Important note}: This feature doesn't work as
832 expected in version 5.0.0. Please do not use it before version 5.0.1.
834 \subsection{Allow Higher Duplicates}
835 This directive did not work correctly and has been depreciated
836 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
837 file as it will be removed in a future release.
839 \subsection{Cancel Lower Level Duplicates}
840 This directive was added in Bacula version 5.0.1. It compares the
841 level of a new backup job to old jobs of the same name, if any,
842 and will kill the job which has a lower level than the other one.
843 If the levels are the same (i.e. both are Full backups), then
844 nothing is done and the other Cancel XXX Duplicate directives
847 \section{New Features in 5.0.0}
849 \subsection{Maximum Concurrent Jobs for Devices}
850 \label{sec:maximumconcurrentjobdevice}
852 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
853 Daemon configuration permits setting the maximum number of Jobs that can
854 run concurrently on a specified Device. Using this directive, it is
855 possible to have different Jobs using multiple drives, because when the
856 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
857 Jobs on any other available compatible drive. This facilitates writing to
858 multiple drives with multiple Jobs that all use the same Pool.
860 This project was funded by Bacula Systems.
862 \subsection{Restore from Multiple Storage Daemons}
863 \index[general]{Restore}
865 Previously, you were able to restore from multiple devices in a single Storage
866 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
867 example, if your full backup runs on a Storage Daemon with an autochanger, and
868 your incremental jobs use another Storage Daemon with lots of disks, Bacula
869 will switch automatically from one Storage Daemon to an other within the same
872 You must upgrade your File Daemon to version 3.1.3 or greater to use this
875 This project was funded by Bacula Systems with the help of Equiinet.
877 \subsection{File Deduplication using Base Jobs}
878 A base job is sort of like a Full save except that you will want the FileSet to
879 contain only files that are unlikely to change in the future (i.e. a snapshot
880 of most of your system after installing it). After the base job has been run,
881 when you are doing a Full save, you specify one or more Base jobs to be used.
882 All files that have been backed up in the Base job/jobs but not modified will
883 then be excluded from the backup. During a restore, the Base jobs will be
884 automatically pulled in where necessary.
886 This is something none of the competition does, as far as we know (except
887 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
888 win for the user, it makes Bacula stand out as offering a unique optimization
889 that immediately saves time and money. Basically, imagine that you have 100
890 nearly identical Windows or Linux machine containing the OS and user files.
891 Now for the OS part, a Base job will be backed up once, and rather than making
892 100 copies of the OS, there will be only one. If one or more of the systems
893 have some files updated, no problem, they will be automatically restored.
895 See the \ilink{Base Job Chapter}{basejobs} for more information.
897 This project was funded by Bacula Systems.
899 \subsection{AllowCompression = \lt{}yes\vb{}no\gt{}}
900 \index[dir]{AllowCompression}
902 This new directive may be added to Storage resource within the Director's
903 configuration to allow users to selectively disable the client compression for
904 any job which writes to this storage resource.
910 Address = ultrium-tape
911 Password = storage_password # Password for Storage Daemon
914 AllowCompression = No # Tape drive has hardware compression
917 The above example would cause any jobs running with the UltriumTape storage
918 resource to run without compression from the client file daemons. This
919 effectively overrides any compression settings defined at the FileSet level.
921 This feature is probably most useful if you have a tape drive which supports
922 hardware compression. By setting the \texttt{AllowCompression = No} directive
923 for your tape drive storage resource, you can avoid additional load on the file
924 daemon and possibly speed up tape backups.
926 This project was funded by Collaborative Fusion, Inc.
928 \subsection{Accurate Fileset Options}
929 \label{sec:accuratefileset}
931 In previous versions, the accurate code used the file creation and modification
932 times to determine if a file was modified or not. Now you can specify which
933 attributes to use (time, size, checksum, permission, owner, group, \dots),
934 similar to the Verify options.
950 \item {\bf i} compare the inodes
951 \item {\bf p} compare the permission bits
952 \item {\bf n} compare the number of links
953 \item {\bf u} compare the user id
954 \item {\bf g} compare the group id
955 \item {\bf s} compare the size
956 \item {\bf a} compare the access time
957 \item {\bf m} compare the modification time (st\_mtime)
958 \item {\bf c} compare the change time (st\_ctime)
959 \item {\bf d} report file size decreases
960 \item {\bf 5} compare the MD5 signature
961 \item {\bf 1} compare the SHA1 signature
964 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
965 the File Daemon will have to read all files even if they normally would not
966 be saved. This increases the I/O load, but also the accuracy of the
967 deduplication. By default, Bacula will check modification/creation time
970 This project was funded by Bacula Systems.
972 \subsection{Tab-completion for Bconsole}
973 \label{sec:tabcompletion}
975 If you build \texttt{bconsole} with readline support, you will be able to use
976 the new auto-completion mode. This mode supports all commands, gives help
977 inside command, and lists resources when required. It works also in the restore
980 To use this feature, you should have readline development package loaded on
981 your system, and use the following option in configure.
983 ./configure --with-readline=/usr/include/readline --disable-conio ...
986 The new bconsole won't be able to tab-complete with older directors.
988 This project was funded by Bacula Systems.
990 \subsection{Pool File and Job Retention}
991 \label{sec:poolfilejobretention}
993 We added two new Pool directives, \texttt{FileRetention} and
994 \texttt{JobRetention}, that take precedence over Client directives of the same
995 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
996 example, you can decide to increase Retention times for Archive or OffSite Pool.
998 It seems obvious to us, but apparently not to some users, that given the
999 definition above that the Pool File and Job Retention periods is a global
1000 override for the normal Client based pruning, which means that when the
1001 Job is pruned, the pruning will apply globally to that particular Job.
1003 Currently, there is a bug in the implementation that causes any Pool
1004 retention periods specified to apply to {\bf all} Pools for that
1005 particular Client. Thus we suggest that you avoid using these two
1006 directives until this implementation problem is corrected.
1008 \subsection{Read-only File Daemon using capabilities}
1009 \label{sec:fdreadonly}
1010 This feature implements support of keeping \textbf{ReadAll} capabilities after
1011 UID/GID switch, this allows FD to keep root read but drop write permission.
1013 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
1014 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
1017 root@localhost:~# bacula-fd -k -u nobody -g nobody
1020 The code for this feature was contributed by our friends at AltLinux.
1022 \subsection{Bvfs API}
1025 To help developers of restore GUI interfaces, we have added new \textsl{dot
1026 commands} that permit browsing the catalog in a very simple way.
1029 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
1030 the Bvfs cache in the catalog. You need to run it before any access to the
1033 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
1034 will list all directories in the specified \texttt{path} or
1035 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
1036 encoding of path/filenames.
1038 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
1039 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
1040 \texttt{pathid} avoids problems with character encoding.
1043 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
1044 data that will be displayed.
1047 * .bvfs_update jobid=1,2
1049 * .bvfs_lsdir path=/ jobid=1,2
1052 This project was funded by Bacula Systems.
1054 \subsection{Testing your Tape Drive}
1055 \label{sec:btapespeed}
1057 To determine the best configuration of your tape drive, you can run the new
1058 \texttt{speed} command available in the \texttt{btape} program.
1060 This command can have the following arguments:
1062 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
1063 (between 1 and 5GB). This counter is in GB.
1064 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
1065 of data should be greater than your memory ($file\_size*nb\_file$).
1066 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
1068 \item[\texttt{skip\_random}] This flag permits to skip tests with random
1070 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
1071 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
1076 *speed file_size=3 skip_raw
1077 btape.c:1078 Test with zero data and bacula block structure.
1078 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1079 ++++++++++++++++++++++++++++++++++++++++++
1080 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1081 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
1083 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
1085 btape.c:1090 Test with random data, should give the minimum throughput.
1086 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1087 +++++++++++++++++++++++++++++++++++++++++++
1088 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1089 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
1090 +++++++++++++++++++++++++++++++++++++++++++
1092 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
1096 When using compression, the random test will give your the minimum throughput
1097 of your drive . The test using constant string will give you the maximum speed
1098 of your hardware chain. (CPU, memory, SCSI card, cable, drive, tape).
1100 You can change the block size in the Storage Daemon configuration file.
1102 \subsection{New {\bf Block Checksum} Device Directive}
1103 You may now turn off the Block Checksum (CRC32) code
1104 that Bacula uses when writing blocks to a Volume. This is
1111 doing so can reduce the Storage daemon CPU usage slightly. It
1112 will also permit Bacula to read a Volume that has corrupted data.
1114 The default is {\bf yes} -- i.e. the checksum is computed on write
1115 and checked on read.
1117 We do not recommend to turn this off particularly on older tape
1118 drives or for disk Volumes where doing so may allow corrupted data
1121 \subsection{New Bat Features}
1123 Those new features were funded by Bacula Systems.
1125 \subsubsection{Media List View}
1127 By clicking on ``Media'', you can see the list of all your volumes. You will be
1128 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1129 in the table. The old ``Media'' view is now known as ``Pool''.
1130 \begin{figure}[htbp]
1132 \includegraphics[width=0.8\linewidth]{bat-mediaview}
1133 \label{fig:mediaview}
1137 \subsubsection{Media Information View}
1139 By double-clicking on a volume (on the Media list, in the Autochanger content
1140 or in the Job information panel), you can access a detailed overview of your
1141 Volume. (cf figure \vref{fig:mediainfo}.)
1142 \begin{figure}[htbp]
1144 \includegraphics[width=0.8\linewidth]{bat11}
1145 \caption{Media information}
1146 \label{fig:mediainfo}
1149 \subsubsection{Job Information View}
1151 By double-clicking on a Job record (on the Job run list or in the Media
1152 information panel), you can access a detailed overview of your Job. (cf
1153 figure \vref{fig:jobinfo}.)
1154 \begin{figure}[htbp]
1156 \includegraphics[width=0.8\linewidth]{bat12}
1157 \caption{Job information}
1161 \subsubsection{Autochanger Content View}
1163 By double-clicking on a Storage record (on the Storage list panel), you can
1164 access a detailed overview of your Autochanger. (cf figure \vref{fig:jobinfo}.)
1165 \begin{figure}[htbp]
1167 \includegraphics[width=0.8\linewidth]{bat13}
1168 \caption{Autochanger content}
1169 \label{fig:achcontent}
1172 To use this feature, you need to use the latest mtx-changer script
1173 version. (With new \texttt{listall} and \texttt{transfer} commands)
1175 \subsection{Bat on Windows}
1176 We have ported {\bf bat} to Windows and it is now installed
1177 by default when the installer is run. It works quite well
1178 on Win32, but has not had a lot of testing there, so your
1179 feedback would be welcome. Unfortunately, even though it is
1180 installed by default, it does not yet work on 64 bit Windows
1183 \subsection{New Win32 Installer}
1184 The Win32 installer has been modified in several very important
1187 \item You must deinstall any current version of the
1188 Win32 File daemon before upgrading to the new one.
1189 If you forget to do so, the new installation will fail.
1190 To correct this failure, you must manually shutdown
1191 and deinstall the old File daemon.
1192 \item All files (other than menu links) are installed
1193 in {\bf c:/Program Files/Bacula}.
1194 \item The installer no longer sets this
1195 file to require administrator privileges by default. If you want
1196 to do so, please do it manually using the {\bf cacls} program.
1199 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1201 \item The server daemons (Director and Storage daemon) are
1202 no longer included in the Windows installer. If you want the
1203 Windows servers, you will either need to build them yourself (note
1204 they have not been ported to 64 bits), or you can contact
1205 Bacula Systems about this.
1208 \subsection{Win64 Installer}
1209 We have corrected a number of problems that required manual
1210 editing of the conf files. In most cases, it should now
1211 install and work. {\bf bat} is by default installed in
1212 {\bf c:/Program Files/Bacula/bin32} rather than
1213 {\bf c:/Program Files/Bacula} as is the case with the 32
1214 bit Windows installer.
1216 \subsection{Linux Bare Metal Recovery USB Key}
1217 We have made a number of significant improvements in the
1218 Bare Metal Recovery USB key. Please see the README files
1219 it the {\bf rescue} release for more details.
1221 We are working on an equivalent USB key for Windows bare
1222 metal recovery, but it will take some time to develop it (best
1223 estimate 3Q2010 or 4Q2010)
1226 \subsection{bconsole Timeout Option}
1227 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1228 for commands. This is useful with GUI programs that use {\bf bconsole}
1229 to interface to the Director.
1231 \subsection{Important Changes}
1232 \label{sec:importantchanges}
1235 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1236 to the same Pool. The Storage daemon ensures that you do not read and
1237 write to the same Volume.
1238 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1240 \item Virtually all the features of {\bf mtx-changer} have
1241 now been parametrized, which allows you to configure
1242 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1243 that contains variables that you can set to configure mtx-changer.
1244 This configuration file will not be overwritten during upgrades.
1245 We encourage you to submit any changes
1246 that are made to mtx-changer and to parametrize it all in
1247 mtx-changer.conf so that all configuration will be done by
1248 changing only mtx-changer.conf.
1249 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1250 and \texttt{transfer}. Please configure them as appropriate
1251 in mtx-changer.conf.
1252 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1253 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1254 password. If you want to use the new script, you will need to
1255 manually change the \texttt{BackupCatalog} Job definition.
1256 \item The \texttt{bconsole} \texttt{help} command now accepts
1257 an argument, which if provided produces information on that
1258 command (ex: \texttt{help run}).
1262 \subsubsection*{Truncate volume after purge}
1264 Note that the Truncate Volume after purge feature doesn't work as expected
1265 in 5.0.0 version. Please, don't use it before version 5.0.1.
1267 \subsubsection{Custom Catalog queries}
1269 If you wish to add specialized commands that list the contents of the catalog,
1270 you can do so by adding them to the \texttt{query.sql} file. This
1271 \texttt{query.sql} file is now empty by default. The file
1272 \texttt{examples/sample-query.sql} has an a number of sample commands
1273 you might find useful.
1275 \subsubsection{Deprecated parts}
1277 The following items have been \textbf{deprecated} for a long time, and are now
1278 removed from the code.
1281 \item Support for SQLite 2
1284 \subsection{Misc Changes}
1285 \label{sec:miscchanges}
1288 \item Updated Nagios check\_bacula
1289 \item Updated man files
1290 \item Added OSX package generation script in platforms/darwin
1291 \item Added Spanish and Ukrainian Bacula translations
1292 \item Enable/disable command shows only Jobs that can change
1293 \item Added \texttt{show disabled} command to show disabled Jobs
1294 \item Many ACL improvements
1295 \item Added Level to FD status Job output
1296 \item Begin Ingres DB driver (not yet working)
1297 \item Split RedHat spec files into bacula, bat, mtx, and docs
1298 \item Reorganized the manuals (fewer separate manuals)
1299 \item Added lock/unlock order protection in lock manager
1300 \item Allow 64 bit sizes for a number of variables
1301 \item Fixed several deadlocks or potential race conditions in the SD
1304 \chapter{Released Version 3.0.3 and 3.0.3a}
1306 There are no new features in version 3.0.3. This version simply fixes a
1307 number of bugs found in version 3.0.2 during the ongoing development
1310 \section{New Features in Released Version 3.0.2}
1312 This chapter presents the new features added to the
1313 Released Bacula Version 3.0.2.
1315 \subsection{Full Restore from a Given JobId}
1316 \index[general]{Restore menu}
1318 This feature allows selecting a single JobId and having Bacula
1319 automatically select all the other jobs that comprise a full backup up to
1320 and including the selected date (through JobId).
1322 Assume we start with the following jobs:
1324 +-------+--------------+---------------------+-------+----------+------------+
1325 | jobid | client | starttime | level | jobfiles | jobbytes |
1326 +-------+--------------+---------------------+-------+----------+------------
1327 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1328 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1329 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1330 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1331 +-------+--------------+---------------------+-------+----------+------------+
1334 Below is an example of this new feature (which is number 12 in the
1339 To select the JobIds, you have the following choices:
1340 1: List last 20 Jobs run
1341 2: List Jobs where a given File is saved
1343 12: Select full restore to a specified Job date
1346 Select item: (1-13): 12
1347 Enter JobId to get the state to restore: 5
1348 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1349 You have selected the following JobIds: 1,3,5
1351 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1352 1,444 files inserted into the tree.
1355 This project was funded by Bacula Systems.
1357 \subsection{Source Address}
1358 \index[general]{Source Address}
1360 A feature has been added which allows the administrator to specify the address
1361 from which the Director and File daemons will establish connections. This
1362 may be used to simplify system configuration overhead when working in complex
1363 networks utilizing multi-homing and policy-routing.
1365 To accomplish this, two new configuration directives have been implemented:
1368 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1372 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1376 Simply adding specific host routes on the OS
1377 would have an undesirable side-effect: any
1378 application trying to contact the destination host would be forced to use the
1379 more specific route possibly diverting management traffic onto a backup VLAN.
1380 Instead of adding host routes for each client connected to a multi-homed backup
1381 server (for example where there are management and backup VLANs), one can
1382 use the new directives to specify a specific source address at the application
1385 Additionally, this allows the simplification and abstraction of firewall rules
1386 when dealing with a Hot-Standby director or storage daemon configuration. The
1387 Hot-standby pair may share a CARP address, which connections must be sourced
1388 from, while system services listen and act from the unique interface addresses.
1390 This project was funded by Collaborative Fusion, Inc.
1392 \subsection{Show volume availability when doing restore}
1394 When doing a restore the selection dialog ends by displaying this
1398 The job will require the following
1399 Volume(s) Storage(s) SD Device(s)
1400 ===========================================================================
1401 *000741L3 LTO-4 LTO3
1402 *000866L3 LTO-4 LTO3
1403 *000765L3 LTO-4 LTO3
1404 *000764L3 LTO-4 LTO3
1405 *000756L3 LTO-4 LTO3
1406 *001759L3 LTO-4 LTO3
1407 *001763L3 LTO-4 LTO3
1411 Volumes marked with ``*'' are online (in the autochanger).
1414 This should help speed up large restores by minimizing the time spent
1415 waiting for the operator to discover that he must change tapes in the library.
1417 This project was funded by Bacula Systems.
1419 \subsection{Accurate estimate command}
1421 The \texttt{estimate} command can now use the accurate code to detect changes
1422 and give a better estimation.
1424 You can set the accurate behavior on the command line by using
1425 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1428 * estimate listing accurate=yes level=incremental job=BackupJob
1431 This project was funded by Bacula Systems.
1433 \section{New Features in 3.0.0}
1434 \label{NewFeaturesChapter}
1435 \index[general]{New Features}
1437 This chapter presents the new features added to the development 2.5.x
1438 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1440 \subsection{Accurate Backup}
1441 \index[general]{Accurate Backup}
1443 As with most other backup programs, by default Bacula decides what files to
1444 backup for Incremental and Differential backup by comparing the change
1445 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1446 backup completed. If one of those two times is later than the last backup
1447 time, then the file will be backed up. This does not, however, permit tracking
1448 what files have been deleted and will miss any file with an old time that may
1449 have been restored to or moved onto the client filesystem.
1451 \subsubsection{Accurate = \lt{}yes\vb{}no\gt{}}
1452 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1453 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1454 backup, there is no difference, but for {\bf Differential} and {\bf
1455 Incremental} backups, the Director will send a list of all previous files
1456 backed up, and the File daemon will use that list to determine if any new files
1457 have been added or or moved and if any files have been deleted. This allows
1458 Bacula to make an accurate backup of your system to that point in time so that
1459 if you do a restore, it will restore your system exactly.
1462 about using Accurate backup is that it requires more resources (CPU and memory)
1463 on both the Director and the Client machines to create the list of previous
1464 files backed up, to send that list to the File daemon, for the File daemon to
1465 keep the list (possibly very big) in memory, and for the File daemon to do
1466 comparisons between every file in the FileSet and the list. In particular,
1467 if your client has lots of files (more than a few million), you will need
1468 lots of memory on the client machine.
1470 Accurate must not be enabled when backing up with a plugin that is not
1471 specially designed to work with Accurate. If you enable it, your restores
1472 will probably not work correctly.
1474 This project was funded by Bacula Systems.
1478 \subsection{Copy Jobs}
1479 \index[general]{Copy Jobs}
1481 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1482 existing Migration feature with the exception that the Job that is copied is
1483 left unchanged. This essentially creates two identical copies of the same
1484 backup. However, the copy is treated as a copy rather than a backup job, and
1485 hence is not directly available for restore. The {\bf restore} command lists
1486 copy jobs and allows selection of copies by using \texttt{jobid=}
1487 option. If the keyword {\bf copies} is present on the command line, Bacula will
1488 display the list of all copies for selected jobs.
1493 These JobIds have copies as follows:
1494 +-------+------------------------------------+-----------+------------------+
1495 | JobId | Job | CopyJobId | MediaType |
1496 +-------+------------------------------------+-----------+------------------+
1497 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1498 +-------+------------------------------------+-----------+------------------+
1499 +-------+-------+----------+----------+---------------------+------------------+
1500 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1501 +-------+-------+----------+----------+---------------------+------------------+
1502 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1503 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1504 +-------+-------+----------+----------+---------------------+------------------+
1505 You have selected the following JobIds: 19,2
1507 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1508 5,611 files inserted into the tree.
1513 The Copy Job runs without using the File daemon by copying the data from the
1514 old backup Volume to a different Volume in a different Pool. See the Migration
1515 documentation for additional details. For copy Jobs there is a new selection
1516 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1517 not already copied to another Pool.
1519 As with Migration, the Client, Volume, Job, or SQL query, are
1520 other possible ways of selecting the Jobs to be copied. Selection
1521 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1522 work, but are probably more suited for Migration Jobs.
1524 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1525 it will promote the Copy to a \textsl{real} backup job and will make it available for
1526 automatic restore. If more than one Copy is available, it will promote the copy
1527 with the smallest JobId.
1529 A nice solution which can be built with the new Copy feature is often
1530 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1531 look something like the one below:
1535 Name = FullBackupsVirtualPool
1537 Purge Oldest Volume = Yes
1539 NextPool = FullBackupsTapePool
1543 Name = FullBackupsTapePool
1547 Volume Retention = 365 days
1548 Storage = superloader
1552 # Fake fileset for copy jobs
1564 # Fake client for copy jobs
1574 # Default template for a CopyDiskToTape Job
1577 Name = CopyDiskToTape
1579 Messages = StandardCopy
1582 Selection Type = PoolUncopiedJobs
1583 Maximum Concurrent Jobs = 10
1585 Allow Duplicate Jobs = Yes
1586 Cancel Queued Duplicates = No
1587 Cancel Running Duplicates = No
1592 Name = DaySchedule7:00
1593 Run = Level=Full daily at 7:00
1597 Name = CopyDiskToTapeFullBackups
1599 Schedule = DaySchedule7:00
1600 Pool = FullBackupsVirtualPool
1601 JobDefs = CopyDiskToTape
1605 The example above had 2 pool which are copied using the PoolUncopiedJobs
1606 selection criteria. Normal Full backups go to the Virtual pool and are copied
1607 to the Tape pool the next morning.
1609 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1614 +-------+------------------------------------+-----------+------------------+
1615 | JobId | Job | CopyJobId | MediaType |
1616 +-------+------------------------------------+-----------+------------------+
1617 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1618 +-------+------------------------------------+-----------+------------------+
1621 \subsection{ACL Updates}
1622 \index[general]{ACL Updates}
1623 The whole ACL code had been overhauled and in this version each platforms has
1624 different streams for each type of acl available on such an platform. As ACLs
1625 between platforms tend to be not that portable (most implement POSIX acls but
1626 some use an other draft or a completely different format) we currently only
1627 allow certain platform specific ACL streams to be decoded and restored on the
1628 same platform that they were created on. The old code allowed to restore ACL
1629 cross platform but the comments already mention that not being to wise. For
1630 backward compatibility the new code will accept the two old ACL streams and
1631 handle those with the platform specific handler. But for all new backups it
1632 will save the ACLs using the new streams.
1634 Currently the following platforms support ACLs:
1638 \item {\bf Darwin/OSX}
1647 Currently we support the following ACL types (these ACL streams use a reserved
1648 part of the stream numbers):
1651 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1653 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1654 string representation from acl\_to\_text (POSIX acl)
1655 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1656 string representation from acl\_to\_text (POSIX acl) for default acls.
1657 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1658 string representation from acl\_to\_text (POSIX acl) for access acls.
1659 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1660 string representation from acltostr (POSIX acl)
1661 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1662 representation from acl\_to\_text (POSIX acl) for default acls.
1663 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1664 representation from acl\_to\_text (POSIX acl) for access acls.
1665 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1666 string representation from acl\_to\_text (POSIX acl) for default acls.
1667 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1668 representation from acl\_to\_text (POSIX acl) for access acls.
1669 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1670 string representation from acl\_to\_text (POSIX acl) for default acls.
1671 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1672 string representation from acl\_to\_text (POSIX acl) for default acls.
1673 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1674 representation from acl\_to\_text (POSIX acl) for access acls.
1675 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1676 string representation from acltotext or acl\_totext (POSIX acl)
1677 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1678 representation from from acl\_totext (NFSv4 or ZFS acl)
1681 In future versions we might support conversion functions from one type of acl
1682 into an other for types that are either the same or easily convertible. For now
1683 the streams are separate and restoring them on a platform that doesn't
1684 recognize them will give you a warning.
1686 \subsection{Extended Attributes}
1687 \index[general]{Extended Attributes}
1688 Something that was on the project list for some time is now implemented for
1689 platforms that support a similar kind of interface. Its the support for backup
1690 and restore of so called extended attributes. As extended attributes are so
1691 platform specific these attributes are saved in separate streams for each
1692 platform. Restores of the extended attributes can only be performed on the
1693 same platform the backup was done. There is support for all types of extended
1694 attributes, but restoring from one type of filesystem onto an other type of
1695 filesystem on the same platform may lead to surprises. As extended attributes
1696 can contain any type of data they are stored as a series of so called
1697 value-pairs. This data must be seen as mostly binary and is stored as such.
1698 As security labels from selinux are also extended attributes this option also
1699 stores those labels and no specific code is enabled for handling selinux
1702 Currently the following platforms support extended attributes:
1704 \item {\bf Darwin/OSX}
1710 On Linux acls are also extended attributes, as such when you enable ACLs on a
1711 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1712 and not the same extended attribute.
1714 To enable the backup of extended attributes please add the following to your
1729 \subsection{Shared objects}
1730 \index[general]{Shared objects}
1731 A default build of Bacula will now create the libraries as shared objects
1732 (.so) rather than static libraries as was previously the case.
1733 The shared libraries are built using {\bf libtool} so it should be quite
1736 An important advantage of using shared objects is that on a machine with the
1737 Directory, File daemon, the Storage daemon, and a console, you will have only
1738 one copy of the code in memory rather than four copies. Also the total size of
1739 the binary release is smaller since the library code appears only once rather
1740 than once for every program that uses it; this results in significant reduction
1741 in the size of the binaries particularly for the utility tools.
1743 In order for the system loader to find the shared objects when loading the
1744 Bacula binaries, the Bacula shared objects must either be in a shared object
1745 directory known to the loader (typically /usr/lib) or they must be in the
1746 directory that may be specified on the {\bf ./configure} line using the {\bf
1747 {-}{-}libdir} option as:
1750 ./configure --libdir=/full-path/dir
1753 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1754 no need to modify your loader configuration provided that
1755 the shared objects are installed in that directory (Bacula
1756 does this with the make install command). The shared objects
1757 that Bacula references are:
1766 These files are symbolically linked to the real shared object file,
1767 which has a version number to permit running multiple versions of
1768 the libraries if desired (not normally the case).
1770 If you have problems with libtool or you wish to use the old
1771 way of building static libraries, or you want to build a static
1772 version of Bacula you may disable
1773 libtool on the configure command line with:
1776 ./configure --disable-libtool
1780 \subsection{Building Static versions of Bacula}
1781 \index[general]{Static linking}
1782 In order to build static versions of Bacula, in addition
1783 to configuration options that were needed you now must
1784 also add --disable-libtool. Example
1787 ./configure --enable-static-client-only --disable-libtool
1791 \subsection{Virtual Backup (Vbackup)}
1792 \index[general]{Virtual Backup}
1793 \index[general]{Vbackup}
1795 Bacula's virtual backup feature is often called Synthetic Backup or
1796 Consolidation in other backup products. It permits you to consolidate the
1797 previous Full backup plus the most recent Differential backup and any
1798 subsequent Incremental backups into a new Full backup. This new Full
1799 backup will then be considered as the most recent Full for any future
1800 Incremental or Differential backups. The VirtualFull backup is
1801 accomplished without contacting the client by reading the previous backup
1802 data and writing it to a volume in a different pool.
1804 In some respects the Vbackup feature works similar to a Migration job, in
1805 that Bacula normally reads the data from the pool specified in the
1806 Job resource, and writes it to the {\bf Next Pool} specified in the
1807 Job resource. Note, this means that usually the output from the Virtual
1808 Backup is written into a different pool from where your prior backups
1809 are saved. Doing it this way guarantees that you will not get a deadlock
1810 situation attempting to read and write to the same volume in the Storage
1811 daemon. If you then want to do subsequent backups, you may need to
1812 move the Virtual Full Volume back to your normal backup pool.
1813 Alternatively, you can set your {\bf Next Pool} to point to the current
1814 pool. This will cause Bacula to read and write to Volumes in the
1815 current pool. In general, this will work, because Bacula will
1816 not allow reading and writing on the same Volume. In any case, once
1817 a VirtualFull has been created, and a restore is done involving the
1818 most current Full, it will read the Volume or Volumes by the VirtualFull
1819 regardless of in which Pool the Volume is found.
1821 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1822 a level of {\bf VirtualFull}.
1824 A typical Job resource definition might look like the following:
1831 FileSet = "Full Set"
1838 # Default pool definition
1842 Recycle = yes # Automatically recycle Volumes
1843 AutoPrune = yes # Prune expired volumes
1844 Volume Retention = 365d # one year
1852 Recycle = yes # Automatically recycle Volumes
1853 AutoPrune = yes # Prune expired volumes
1854 Volume Retention = 365d # one year
1855 Storage = DiskChanger
1858 # Definition of file storage device
1863 Device = FileStorage
1865 Maximum Concurrent Jobs = 5
1868 # Definition of DDS Virtual tape disk storage device
1871 Address = localhost # N.B. Use a fully qualified name here
1873 Device = DiskChanger
1874 Media Type = DiskChangerMedia
1875 Maximum Concurrent Jobs = 4
1880 Then in bconsole or via a Run schedule, you would run the job as:
1883 run job=MyBackup level=Full
1884 run job=MyBackup level=Incremental
1885 run job=MyBackup level=Differential
1886 run job=MyBackup level=Incremental
1887 run job=MyBackup level=Incremental
1890 So providing there were changes between each of those jobs, you would end up
1891 with a Full backup, a Differential, which includes the first Incremental
1892 backup, then two Incremental backups. All the above jobs would be written to
1893 the {\bf Default} pool.
1895 To consolidate those backups into a new Full backup, you would run the
1899 run job=MyBackup level=VirtualFull
1902 And it would produce a new Full backup without using the client, and the output
1903 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1905 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1908 Note, the Start and End time of the Virtual Full backup is set to the
1909 values for the last job included in the Virtual Full (in the above example,
1910 it is an Increment). This is so that if another incremental is done, which
1911 will be based on the Virtual Full, it will backup all files from the
1912 last Job included in the Virtual Full rather than from the time the Virtual
1913 Full was actually run.
1917 \subsection{Catalog Format}
1918 \index[general]{Catalog Format}
1919 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1920 operation will convert the FileId field of the File table from 32 bits (max 4
1921 billion table entries) to 64 bits (very large number of items). The
1922 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1923 your catalog during the conversion. Also you won't be able to run jobs during
1924 this conversion period. For example, a 3 million file catalog will take 2
1925 minutes to upgrade on a normal machine. Please don't forget to make a valid
1926 backup of your database before executing the upgrade script. See the
1927 ReleaseNotes for additional details.
1929 \subsection{64 bit Windows Client}
1930 \index[general]{Win64 Client}
1931 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1932 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1933 As a consequence, we are also releasing a 64 bit version of the Bacula
1934 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1935 These binaries should only be installed on 64 bit Windows operating systems.
1936 What is important is not your hardware but whether or not you have
1937 a 64 bit version of the Windows OS.
1939 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1941 \item Before installing the Win64 Bacula Client, you must totally
1942 deinstall any prior 2.4.x Client installation using the
1943 Bacula deinstallation (see the menu item). You may want
1944 to save your .conf files first.
1945 \item Only the Client (File daemon) is ported to Win64, the Director
1946 and the Storage daemon are not in the 64 bit Windows installer.
1947 \item bwx-console is not yet ported.
1948 \item bconsole is ported but it has not been tested.
1949 \item The documentation is not included in the installer.
1950 \item Due to Vista security restrictions imposed on a default installation
1951 of Vista, before upgrading the Client, you must manually stop
1952 any prior version of Bacula from running, otherwise the install
1954 \item Due to Vista security restrictions imposed on a default installation
1955 of Vista, attempting to edit the conf files via the menu items
1956 will fail. You must directly edit the files with appropriate
1957 permissions. Generally double clicking on the appropriate .conf
1958 file will work providing you have sufficient permissions.
1959 \item All Bacula files are now installed in
1960 {\bf C:/Program Files/Bacula} except the main menu items,
1961 which are installed as before. This vastly simplifies the installation.
1962 \item If you are running on a foreign language version of Windows, most
1963 likely {\bf C:/Program Files} does not exist, so you should use the
1964 Custom installation and enter an appropriate location to install
1966 \item The 3.0.0 Win32 Client continues to install files in the locations used
1967 by prior versions. For the next version we will convert it to use
1968 the same installation conventions as the Win64 version.
1971 This project was funded by Bacula Systems.
1974 \subsection{Duplicate Job Control}
1975 \index[general]{Duplicate Jobs}
1976 The new version of Bacula provides four new directives that
1977 give additional control over what Bacula does if duplicate jobs
1978 are started. A duplicate job in the sense we use it here means
1979 a second or subsequent job with the same name starts. This
1980 happens most frequently when the first job runs longer than expected because no
1981 tapes are available.
1983 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1984 are specified in the Job resource.
1988 \subsubsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1989 \index[general]{Allow Duplicate Jobs}
1990 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1991 the directive is set to {\bf no} (default) then only one job of a given name
1992 may run at one time, and the action that Bacula takes to ensure only
1993 one job runs is determined by the other directives (see below).
1995 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1996 are present and none of the three directives given below permit
1997 Canceling a job, then the current job (the second one started)
2000 \subsubsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
2001 \index[general]{Allow Higher Duplicates}
2002 This directive was in version 5.0.0, but does not work as
2003 expected. If used, it should always be set to no. In later versions
2004 of Bacula the directive is disabled (disregarded).
2006 \subsubsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
2007 \index[general]{Cancel Running Duplicates}
2008 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
2009 if this directive is set to {\bf yes} any job that is already running
2010 will be canceled. The default is {\bf no}.
2012 \subsubsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
2013 \index[general]{Cancel Queued Duplicates}
2014 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
2015 if this directive is set to {\bf yes} any job that is
2016 already queued to run but not yet running will be canceled.
2017 The default is {\bf no}.
2020 \subsection{TLS Authentication}
2021 \index[general]{TLS Authentication}
2022 In Bacula version 2.5.x and later, in addition to the normal Bacula
2023 CRAM-MD5 authentication that is used to authenticate each Bacula
2024 connection, you can specify that you want TLS Authentication as well,
2025 which will provide more secure authentication.
2027 This new feature uses Bacula's existing TLS code (normally used for
2028 communications encryption) to do authentication. To use it, you must
2029 specify all the TLS directives normally used to enable communications
2030 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
2033 \subsubsection{TLS Authenticate = yes}
2035 TLS Authenticate = yes
2038 in the main daemon configuration resource (Director for the Director,
2039 Client for the File daemon, and Storage for the Storage daemon).
2041 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
2042 authentication, Bacula will also do TLS authentication, then TLS
2043 encryption will be turned off, and the rest of the communication between
2044 the two Bacula daemons will be done without encryption.
2046 If you want to encrypt communications data, use the normal TLS directives
2047 but do not turn on {\bf TLS Authenticate}.
2049 \subsection{bextract non-portable Win32 data}
2050 \index[general]{bextract handles Win32 non-portable data}
2051 {\bf bextract} has been enhanced to be able to restore
2052 non-portable Win32 data to any OS. Previous versions were
2053 unable to restore non-portable Win32 data to machines that
2054 did not have the Win32 BackupRead and BackupWrite API calls.
2056 \subsection{State File updated at Job Termination}
2057 \index[general]{State File}
2058 In previous versions of Bacula, the state file, which provides a
2059 summary of previous jobs run in the {\bf status} command output was
2060 updated only when Bacula terminated, thus if the daemon crashed, the
2061 state file might not contain all the run data. This version of
2062 the Bacula daemons updates the state file on each job termination.
2064 \subsection{MaxFullInterval = \lt{}time-interval\gt{}}
2065 \index[general]{MaxFullInterval}
2066 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
2067 can be used to specify the maximum time interval between {\bf Full} backup
2068 jobs. When a job starts, if the time since the last Full backup is
2069 greater than the specified interval, and the job would normally be an
2070 {\bf Incremental} or {\bf Differential}, it will be automatically
2071 upgraded to a {\bf Full} backup.
2073 \subsection{MaxDiffInterval = \lt{}time-interval\gt{}}
2074 \index[general]{MaxDiffInterval}
2075 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
2076 can be used to specify the maximum time interval between {\bf Differential} backup
2077 jobs. When a job starts, if the time since the last Differential backup is
2078 greater than the specified interval, and the job would normally be an
2079 {\bf Incremental}, it will be automatically
2080 upgraded to a {\bf Differential} backup.
2082 \subsection{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
2083 \index[general]{MaxDiffInterval}
2084 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
2085 by the user, and when it is set it is an indication to backup programs
2086 to not backup that particular file. This version of Bacula contains a
2087 new Options directive within a FileSet resource, which instructs Bacula to
2088 obey this flag. The new directive is:
2091 Honor No Dump Flag = yes\vb{}no
2094 The default value is {\bf no}.
2097 \subsection{Exclude Dir Containing = \lt{}filename-string\gt{}}
2098 \index[general]{IgnoreDir}
2099 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
2100 can be added to the Include section of the FileSet resource. If the specified
2101 filename ({\bf filename-string}) is found on the Client in any directory to be
2102 backed up, the whole directory will be ignored (not backed up). For example:
2105 # List of files to be backed up
2113 Exclude Dir Containing = .excludeme
2118 But in /home, there may be hundreds of directories of users and some
2119 people want to indicate that they don't want to have certain
2120 directories backed up. For example, with the above FileSet, if
2121 the user or sysadmin creates a file named {\bf .excludeme} in
2122 specific directories, such as
2125 /home/user/www/cache/.excludeme
2126 /home/user/temp/.excludeme
2129 then Bacula will not backup the two directories named:
2132 /home/user/www/cache
2136 NOTE: subdirectories will not be backed up. That is, the directive
2137 applies to the two directories in question and any children (be they
2138 files, directories, etc).
2141 \subsection{Bacula Plugins}
2142 \index[general]{Plugin}
2143 Support for shared object plugins has been implemented in the Linux, Unix
2144 and Win32 File daemons. The API will be documented separately in
2145 the Developer's Guide or in a new document. For the moment, there is
2146 a single plugin named {\bf bpipe} that allows an external program to
2147 get control to backup and restore a file.
2149 Plugins are also planned (partially implemented) in the Director and the
2152 \subsubsection{Plugin Directory}
2153 \index[general]{Plugin Directory}
2154 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2155 be added to the daemon definition resource. The directory takes a quoted
2156 string argument, which is the name of the directory in which the daemon can
2157 find the Bacula plugins. If this directive is not specified, Bacula will not
2158 load any plugins. Since each plugin has a distinctive name, all the daemons
2159 can share the same plugin directory.
2161 \subsubsection{Plugin Options}
2162 \index[general]{Plugin Options}
2163 The {\bf Plugin Options} directive takes a quoted string
2164 argument (after the equal sign) and may be specified in the
2165 Job resource. The options specified will be passed to all plugins
2166 when they are run. This each plugin must know what it is looking
2167 for. The value defined in the Job resource can be modified
2168 by the user when he runs a Job via the {\bf bconsole} command line
2171 Note: this directive may be specified, and there is code to modify
2172 the string in the run command, but the plugin options are not yet passed to
2173 the plugin (i.e. not fully implemented).
2175 \subsubsection{Plugin Options ACL}
2176 \index[general]{Plugin Options ACL}
2177 The {\bf Plugin Options ACL} directive may be specified in the
2178 Director's Console resource. It functions as all the other ACL commands
2179 do by permitting users running restricted consoles to specify a
2180 {\bf Plugin Options} that overrides the one specified in the Job
2181 definition. Without this directive restricted consoles may not modify
2184 \subsubsection{Plugin = \lt{}plugin-command-string\gt{}}
2185 \index[general]{Plugin}
2186 The {\bf Plugin} directive is specified in the Include section of
2187 a FileSet resource where you put your {\bf File = xxx} directives.
2198 Plugin = "bpipe:..."
2203 In the above example, when the File daemon is processing the directives
2204 in the Include section, it will first backup all the files in {\bf /home}
2205 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2206 the Plugin Directory. The syntax and semantics of the Plugin directive
2207 require the first part of the string up to the colon (:) to be the name
2208 of the plugin. Everything after the first colon is ignored by the File daemon but
2209 is passed to the plugin. Thus the plugin writer may define the meaning of the
2210 rest of the string as he wishes.
2212 Please see the next section for information about the {\bf bpipe} Bacula
2215 \subsection{The bpipe Plugin}
2216 \index[general]{The bpipe Plugin}
2217 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2218 the Bacula source distribution. When the plugin is compiled and linking into
2219 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2220 Please note that this is a very simple plugin that was written for
2221 demonstration and test purposes. It is and can be used in production, but
2222 that was never really intended.
2224 The purpose of the plugin is to provide an interface to any system program for
2225 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2226 the Include section of your Job's FileSet resource. The full syntax of the
2227 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2228 to specify the sytax as it wishes) is:
2231 Plugin = "<field1>:<field2>:<field3>:<field4>"
2236 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2237 stripped off, so in this case, we would put {\bf bpipe} in this field.
2239 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2240 pseudo path and filename under which the backup will be saved. This pseudo
2241 path and filename will be seen by the user in the restore file tree.
2242 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2243 backed up by the plugin will be put under that "pseudo" path and filename.
2244 You must be careful to choose a naming convention that is unique to avoid
2245 a conflict with a path and filename that actually exists on your system.
2247 \item {\bf field3} for the {\bf bpipe} plugin
2248 specifies the "reader" program that is called by the plugin during
2249 backup to read the data. {\bf bpipe} will call this program by doing a
2252 \item {\bf field4} for the {\bf bpipe} plugin
2253 specifies the "writer" program that is called by the plugin during
2254 restore to write the data back to the filesystem.
2257 Please note that for two items above describing the "reader" and "writer"
2258 fields, these programs are "executed" by Bacula, which
2259 means there is no shell interpretation of any command line arguments
2260 you might use. If you want to use shell characters (redirection of input
2261 or output, ...), then we recommend that you put your command or commands
2262 in a shell script and execute the script. In addition if you backup a
2263 file with the reader program, when running the writer program during
2264 the restore, Bacula will not automatically create the path to the file.
2265 Either the path must exist, or you must explicitly do so with your command
2266 or in a shell script.
2268 Putting it all together, the full plugin directive line might look
2272 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2273 --opt --databases bacula:mysql"
2276 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2277 would be written on a single line.
2279 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2280 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2281 program {\bf mysqldump -f --opt --database bacula} to read the data during
2282 backup. The mysqldump command outputs all the data for the database named
2283 {\bf bacula}, which will be read by the plugin and stored in the backup.
2284 During restore, the data that was backed up will be sent to the program
2285 specified in the last field, which in this case is {\bf mysql}. When
2286 {\bf mysql} is called, it will read the data sent to it by the plugn
2287 then write it back to the same database from which it came ({\bf bacula}
2290 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2291 the data from a specified program to Bacula for backup, and then from Bacula to
2292 a specified program for restore.
2294 By using different command lines to {\bf bpipe},
2295 you can backup any kind of data (ASCII or binary) depending
2296 on the program called.
2298 \subsection{Microsoft Exchange Server 2003/2007 Plugin}
2299 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2300 \subsubsection{Background}
2301 The Exchange plugin was made possible by a funded development project
2302 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2303 The code for the plugin was written by James Harper, and the Bacula core
2304 code by Kern Sibbald. All the code for this funded development has become
2305 part of the Bacula project. Thanks to everyone who made it happen.
2307 \subsubsection{Concepts}
2308 Although it is possible to backup Exchange using Bacula VSS the Exchange
2309 plugin adds a good deal of functionality, because while Bacula VSS
2310 completes a full backup (snapshot) of Exchange, it does
2311 not support Incremental or Differential backups, restoring is more
2312 complicated, and a single database restore is not possible.
2314 Microsoft Exchange organises its storage into Storage Groups with
2315 Databases inside them. A default installation of Exchange will have a
2316 single Storage Group called 'First Storage Group', with two Databases
2317 inside it, "Mailbox Store (SERVER NAME)" and
2318 "Public Folder Store (SERVER NAME)",
2319 which hold user email and public folders respectively.
2321 In the default configuration, Exchange logs everything that happens to
2322 log files, such that if you have a backup, and all the log files since,
2323 you can restore to the present time. Each Storage Group has its own set
2324 of log files and operates independently of any other Storage Groups. At
2325 the Storage Group level, the logging can be turned off by enabling a
2326 function called "Enable circular logging". At this time the Exchange
2327 plugin will not function if this option is enabled.
2329 The plugin allows backing up of entire storage groups, and the restoring
2330 of entire storage groups or individual databases. Backing up and
2331 restoring at the individual mailbox or email item is not supported but
2332 can be simulated by use of the "Recovery" Storage Group (see below).
2334 \subsubsection{Installing}
2335 The Exchange plugin requires a DLL that is shipped with Microsoft
2336 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2337 correctly the Exchange plugin should find this automatically and run
2338 without any additional installation.
2340 If the DLL can not be found automatically it will need to be copied into
2341 the Bacula installation
2342 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2343 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2344 default Exchange installation.
2346 \subsubsection{Backing Up}
2347 To back up an Exchange server the Fileset definition must contain at
2348 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2349 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2350 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2351 up files are prefixed with something that isn't going to share a name
2352 with something outside the plugin, and the 'Microsoft Information Store'
2353 bit is required also. It is also possible to add the name of a storage
2354 group to the "Plugin =" line, eg \\
2355 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2356 if you want only a single storage group backed up.
2358 Additionally, you can suffix the 'Plugin =' directive with
2359 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2360 database at the end of a full backup.
2362 An Incremental or Differential backup will backup only the database logs
2363 for each Storage Group by inspecting the "modified date" on each
2364 physical log file. Because of the way the Exchange API works, the last
2365 logfile backed up on each backup will always be backed up by the next
2366 Incremental or Differential backup too. This adds 5MB to each
2367 Incremental or Differential backup size but otherwise does not cause any
2370 By default, a normal VSS fileset containing all the drive letters will
2371 also back up the Exchange databases using VSS. This will interfere with
2372 the plugin and Exchange's shared ideas of when the last full backup was
2373 done, and may also truncate log files incorrectly. It is important,
2374 therefore, that the Exchange database files be excluded from the backup,
2375 although the folders the files are in should be included, or they will
2376 have to be recreated manually if a bare metal restore is done.
2381 File = C:/Program Files/Exchsrvr/mdbdata
2382 Plugin = "exchange:..."
2385 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2386 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2387 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2388 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2389 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2390 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2391 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2396 The advantage of excluding the above files is that you can significantly
2397 reduce the size of your backup since all the important Exchange files
2398 will be properly saved by the Plugin.
2401 \subsubsection{Restoring}
2402 The restore operation is much the same as a normal Bacula restore, with
2403 the following provisos:
2406 \item The {\bf Where} restore option must not be specified
2407 \item Each Database directory must be marked as a whole. You cannot just
2408 select (say) the .edb file and not the others.
2409 \item If a Storage Group is restored, the directory of the Storage Group
2411 \item It is possible to restore only a subset of the available log files,
2412 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2413 if a log file is missing from the sequence of log files
2414 \item Each database to be restored must be dismounted and marked as "Can be
2415 overwritten by restore"
2416 \item If an entire Storage Group is to be restored (eg all databases and
2417 logs in the Storage Group), then it is best to manually delete the
2418 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2419 as Exchange can get confused by stray log files lying around.
2422 \subsubsection{Restoring to the Recovery Storage Group}
2423 The concept of the Recovery Storage Group is well documented by
2425 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2426 but to briefly summarize...
2428 Microsoft Exchange allows the creation of an additional Storage Group
2429 called the Recovery Storage Group, which is used to restore an older
2430 copy of a database (e.g. before a mailbox was deleted) into without
2431 messing with the current live data. This is required as the Standard and
2432 Small Business Server versions of Exchange can not ordinarily have more
2433 than one Storage Group.
2435 To create the Recovery Storage Group, drill down to the Server in Exchange
2436 System Manager, right click, and select
2437 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2438 locations and click OK. On the Recovery Storage Group, right click and
2439 select {\bf "Add Database to Recover..."} and select the database you will
2442 Restore only the single database nominated as the database in the
2443 Recovery Storage Group. Exchange will redirect the restore to the
2444 Recovery Storage Group automatically.
2445 Then run the restore.
2447 \subsubsection{Restoring on Microsoft Server 2007}
2448 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2449 2007, and hence you use a new procedure for recovering a single mail box.
2450 This procedure is documented by Microsoft at:
2451 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2452 and involves using the {\bf Restore-Mailbox} and {\bf
2453 Get-Mailbox Statistics} shell commands.
2455 \subsubsection{Caveats}
2456 This plugin is still being developed, so you should consider it
2457 currently in BETA test, and thus use in a production environment
2458 should be done only after very careful testing.
2460 When doing a full backup, the Exchange database logs are truncated by
2461 Exchange as soon as the plugin has completed the backup. If the data
2462 never makes it to the backup medium (eg because of spooling) then the
2463 logs will still be truncated, but they will also not have been backed
2464 up. A solution to this is being worked on. You will have to schedule a
2465 new Full backup to ensure that your next backups will be usable.
2467 The "Enable Circular Logging" option cannot be enabled or the plugin
2470 Exchange insists that a successful Full backup must have taken place if
2471 an Incremental or Differential backup is desired, and the plugin will
2472 fail if this is not the case. If a restore is done, Exchange will
2473 require that a Full backup be done before an Incremental or Differential
2476 The plugin will most likely not work well if another backup application
2477 (eg NTBACKUP) is backing up the Exchange database, especially if the
2478 other backup application is truncating the log files.
2480 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2481 we recommend either carefully testing or that you avoid this option for
2484 The Exchange plugin is not called during processing the bconsole {\bf
2485 estimate} command, and so anything that would be backed up by the plugin
2486 will not be added to the estimate total that is displayed.
2489 \subsection{libdbi Framework}
2490 \index[general]{libdbi Framework}
2491 As a general guideline, Bacula has support for a few catalog database drivers
2492 (MySQL, PostgreSQL, SQLite)
2493 coded natively by the Bacula team. With the libdbi implementation, which is a
2494 Bacula driver that uses libdbi to access the catalog, we have an open field to
2495 use many different kinds database engines following the needs of users.
2497 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2498 implements a database-independent abstraction layer in C, similar to the
2499 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2500 leverage the power of multiple databases and multiple simultaneous database
2501 connections by using this framework.
2503 Currently the libdbi driver in Bacula project only supports the same drivers
2504 natively coded in Bacula. However the libdbi project has support for many
2505 others database engines. You can view the list at
2506 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2507 supported by Bacula, however, they must be tested properly by the Bacula team.
2509 Some of benefits of using libdbi are:
2511 \item The possibility to use proprietary databases engines in which your
2512 proprietary licenses prevent the Bacula team from developing the driver.
2513 \item The possibility to use the drivers written for the libdbi project.
2514 \item The possibility to use other database engines without recompiling Bacula
2515 to use them. Just change one line in bacula-dir.conf
2516 \item Abstract Database access, this is, unique point to code and profiling
2517 catalog database access.
2520 The following drivers have been tested:
2522 \item PostgreSQL, with and without batch insert
2523 \item Mysql, with and without batch insert
2528 In the future, we will test and approve to use others databases engines
2529 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2531 To compile Bacula to support libdbi we need to configure the code with the
2532 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2533 [database] is the database engine to be used with Bacula (of course we can
2534 change the driver in file bacula-dir.conf, see below). We must configure the
2535 access port of the database engine with the option --with-db-port, because the
2536 libdbi framework doesn't know the default access port of each database.
2538 The next phase is checking (or configuring) the bacula-dir.conf, example:
2542 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2543 dbname = regress; user = regress; password = ""
2547 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2548 mysql database. Currently the drivers supported by Bacula are: postgresql,
2549 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2551 The following limitations apply when Bacula is set to use the libdbi framework:
2552 - Not tested on the Win32 platform
2553 - A little performance is lost if comparing with native database driver.
2554 The reason is bound with the database driver provided by libdbi and the
2555 simple fact that one more layer of code was added.
2557 It is important to remember, when compiling Bacula with libdbi, the
2558 following packages are needed:
2560 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2561 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2564 You can download them and compile them on your system or install the packages
2565 from your OS distribution.
2567 \subsection{Console Command Additions and Enhancements}
2568 \index[general]{Console Additions}
2570 \subsubsection{Display Autochanger Content}
2571 \index[general]{StatusSlots}
2573 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2574 autochanger content.
2578 Slot | Volume Name | Status | Media Type | Pool |
2579 ------+---------------+----------+-------------------+------------|
2580 1 | 00001 | Append | DiskChangerMedia | Default |
2581 2 | 00002 | Append | DiskChangerMedia | Default |
2582 3*| 00003 | Append | DiskChangerMedia | Scratch |
2587 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2588 {\bf update slots} command to synchronize autochanger content with your
2591 \subsubsection{list joblog job=xxx or jobid=nnn}
2592 \index[general]{list joblog}
2593 A new list command has been added that allows you to list the contents
2594 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2595 or for a particular JobId. The {\bf llist} command will include a line with
2596 the time and date of the entry.
2598 Note for the catalog to have Job Log entries, you must have a directive
2605 In your Director's {\bf Messages} resource.
2607 \subsubsection{Use separator for multiple commands}
2608 \index[general]{Command Separator}
2609 When using bconsole with readline, you can set the command separator with
2610 \textbf{@separator} command to one
2611 of those characters to write commands who require multiple input in one line.
2613 !$%&'()*+,-/:;<>?[]^`{|}~
2616 \subsubsection{Deleting Volumes}
2617 The delete volume bconsole command has been modified to
2618 require an asterisk (*) in front of a MediaId otherwise the
2619 value you enter is a taken to be a Volume name. This is so that
2620 users may delete numeric Volume names. The previous Bacula versions
2621 assumed that all input that started with a number was a MediaId.
2623 This new behavior is indicated in the prompt if you read it
2626 \subsection{Bare Metal Recovery}
2627 The old bare metal recovery project is essentially dead. One
2628 of the main features of it was that it would build a recovery
2629 CD based on the kernel on your system. The problem was that
2630 every distribution has a different boot procedure and different
2631 scripts, and worse yet, the boot procedures and scripts change
2632 from one distribution to another. This meant that maintaining
2633 (keeping up with the changes) the rescue CD was too much work.
2635 To replace it, a new bare metal recovery USB boot stick has been developed
2636 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2637 boot from a USB key.
2641 \item Recovery can be done from within graphical environment.
2642 \item Recovery can be done in a shell.
2643 \item Ubuntu boots on a large number of Linux systems.
2644 \item The process of updating the system and adding new
2645 packages is not too difficult.
2646 \item The USB key can easily be upgraded to newer Ubuntu versions.
2647 \item The USB key has writable partitions for modifications to
2648 the OS and for modification to your home directory.
2649 \item You can add new files/directories to the USB key very easily.
2650 \item You can save the environment from multiple machines on
2652 \item Bacula Systems is funding its ongoing development.
2655 The disadvantages are:
2657 \item The USB key is usable but currently under development.
2658 \item Not everyone may be familiar with Ubuntu (no worse
2660 \item Some older OSes cannot be booted from USB. This can
2661 be resolved by first booting a Ubuntu LiveCD then plugging
2663 \item Currently the documentation is sketchy and not yet added
2664 to the main manual. See below ...
2667 The documentation and the code can be found in the {\bf rescue} package
2668 in the directory {\bf linux/usb}.
2670 \subsection{Miscellaneous}
2671 \index[general]{Misc New Features}
2673 \subsubsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2674 \index[general]{Allow Mixed Priority}
2675 This directive is only implemented in version 2.5 and later. When
2676 set to {\bf yes} (default {\bf no}), this job may run even if lower
2677 priority jobs are already running. This means a high priority job
2678 will not have to wait for other jobs to finish before starting.
2679 The scheduler will only mix priorities when all running jobs have
2682 Note that only higher priority jobs will start early. Suppose the
2683 director will allow two concurrent jobs, and that two jobs with
2684 priority 10 are running, with two more in the queue. If a job with
2685 priority 5 is added to the queue, it will be run as soon as one of
2686 the running jobs finishes. However, new priority 10 jobs will not
2687 be run until the priority 5 job has finished.
2689 \subsubsection{Bootstrap File Directive -- FileRegex}
2690 \index[general]{Bootstrap File Directive}
2691 {\bf FileRegex} is a new command that can be added to the bootstrap
2692 (.bsr) file. The value is a regular expression. When specified, only
2693 matching filenames will be restored.
2695 During a restore, if all File records are pruned from the catalog
2696 for a Job, normally Bacula can restore only all files saved. That
2697 is there is no way using the catalog to select individual files.
2698 With this new feature, Bacula will ask if you want to specify a Regex
2699 expression for extracting only a part of the full backup.
2702 Building directory tree for JobId(s) 1,3 ...
2703 There were no files inserted into the tree, so file selection
2704 is not possible.Most likely your retention policy pruned the files
2706 Do you want to restore all the files? (yes\vb{}no): no
2708 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2709 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2712 \subsubsection{Bootstrap File Optimization Changes}
2713 In order to permit proper seeking on disk files, we have extended the bootstrap
2714 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2715 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2716 address range and end address range respectively. These two directives replace
2717 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2718 VolEndBlock} directives. Bootstrap files containing the old directives will
2719 still work, but will not properly take advantage of proper disk seeking, and
2720 may read completely to the end of a disk volume during a restore. With the new
2721 format (automatically generated by the new Director), restores will seek
2722 properly and stop reading the volume when all the files have been restored.
2724 \subsubsection{Solaris ZFS/NFSv4 ACLs}
2725 This is an upgrade of the previous Solaris ACL backup code
2726 to the new library format, which will backup both the old
2727 POSIX(UFS) ACLs as well as the ZFS ACLs.
2729 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2730 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2731 be used to transfer from UFS to ZFS filesystems.
2734 \subsubsection{Virtual Tape Emulation}
2735 \index[general]{Virtual Tape Emulation}
2736 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2737 the tape code but actually reading and writing to a disk file. Used with the
2738 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2739 and 700 slots. This feature is most useful in testing. It is enabled
2740 by using {\bf Device Type = vtape} in the Storage daemon's Device
2741 directive. This feature is only implemented on Linux machines and should not be
2742 used for production.
2744 \subsubsection{Bat Enhancements}
2745 \index[general]{Bat Enhancements}
2746 Bat (the Bacula Administration Tool) GUI program has been significantly
2747 enhanced and stabilized. In particular, there are new table based status
2748 commands; it can now be easily localized using Qt4 Linguist.
2750 The Bat communications protocol has been significantly enhanced to improve
2751 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2752 the Director you are using otherwise the communications protocol will not
2755 \subsubsection{RunScript Enhancements}
2756 \index[general]{RunScript Enhancements}
2757 The {\bf RunScript} resource has been enhanced to permit multiple
2758 commands per RunScript. Simply specify multiple {\bf Command} directives
2765 Command = "/bin/echo test"
2766 Command = "/bin/echo an other test"
2767 Command = "/bin/echo 3 commands in the same runscript"
2774 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2775 implemented, which runs the command after the Volume Shadow Copy has been made.
2777 Console commands can be specified within a RunScript by using:
2778 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2779 carefully tested and debugged and is known to easily crash the Director.
2780 We would appreciate feedback. Due to the recursive nature of this command, we
2781 may remove it before the final release.
2783 \subsubsection{Status Enhancements}
2784 \index[general]{Status Enhancements}
2785 The bconsole {\bf status dir} output has been enhanced to indicate
2786 Storage daemon job spooling and despooling activity.
2788 \subsubsection{Connect Timeout}
2789 \index[general]{Connect Timeout}
2790 The default connect timeout to the File
2791 daemon has been set to 3 minutes. Previously it was 30 minutes.
2793 \subsubsection{ftruncate for NFS Volumes}
2794 \index[general]{ftruncate for NFS Volumes}
2795 If you write to a Volume mounted by NFS (say on a local file server),
2796 in previous Bacula versions, when the Volume was recycled, it was not
2797 properly truncated because NFS does not implement ftruncate (file
2798 truncate). This is now corrected in the new version because we have
2799 written code (actually a kind user) that deletes and recreates the Volume,
2800 thus accomplishing the same thing as a truncate.
2802 \subsubsection{Support for Ubuntu}
2803 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2804 version of Linux, and thus now provides correct autostart routines.
2805 Since Ubuntu officially supports Bacula, you can also obtain any
2806 recent release of Bacula from the Ubuntu repositories.
2808 \subsubsection{Recycle Pool = \lt{}pool-name\gt{}}
2809 \index[general]{Recycle Pool}
2810 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2811 be placed (moved) when it is recycled. Without this directive, a Volume will
2812 remain in the same pool when it is recycled. With this directive, it can be
2813 moved automatically to any existing pool during a recycle. This directive is
2814 probably most useful when defined in the Scratch pool, so that volumes will
2815 be recycled back into the Scratch pool.
2817 \subsubsection{FD Version}
2818 \index[general]{FD Version}
2819 The File daemon to Director protocol now includes a version
2820 number, which although there is no visible change for users,
2821 will help us in future versions automatically determine
2822 if a File daemon is not compatible.
2824 \subsubsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2825 \index[general]{Max Run Sched Time}
2826 The time specifies the maximum allowed time that a job may run, counted from
2827 when the job was scheduled. This can be useful to prevent jobs from running
2828 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2831 \subsubsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2832 \index[general]{Max Wait Time}
2833 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2834 of checking the maximum allowed time that a job may block for a resource,
2835 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2836 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2837 their job depending on the level. Now, they have to use
2838 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2839 directives are now deprecated.
2841 \subsubsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2842 \index[general]{Incremental Max Wait Time}
2843 \index[general]{Differential Max Wait Time}
2845 These directives have been deprecated in favor of
2846 \texttt{Incremental|Differential Max Run Time}.
2848 \subsubsection{Max Run Time directives}
2849 \index[general]{Max Run Time directives}
2850 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2851 maximum allowed time that a job can run depending on the level.
2853 \addcontentsline{lof}{figure}{Job time control directives}
2855 \includegraphics[width=\linewidth]{different_time}
2858 \subsubsection{Statistics Enhancements}
2859 \index[general]{Statistics Enhancements}
2860 If you (or probably your boss) want to have statistics on your backups to
2861 provide some \textit{Service Level Agreement} indicators, you could use a few
2862 SQL queries on the Job table to report how many:
2866 \item jobs have been successful
2867 \item files have been backed up
2871 However, these statistics are accurate only if your job retention is greater
2872 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2873 be able to use them.
2875 Now, you can use the \textbf{update stats [days=num]} console command to fill
2876 the JobHistory table with new Job records. If you want to be sure to take in
2877 account only \textbf{good jobs}, ie if one of your important job has failed but
2878 you have fixed the problem and restarted it on time, you probably want to
2879 delete the first \textit{bad} job record and keep only the successful one. For
2880 that simply let your staff do the job, and update JobHistory table after two or
2881 three days depending on your organization using the \textbf{[days=num]} option.
2883 These statistics records aren't used for restoring, but mainly for
2884 capacity planning, billings, etc.
2886 The Bweb interface provides a statistics module that can use this feature. You
2887 can also use tools like Talend or extract information by yourself.
2889 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2890 the length of time that Bacula will keep statistics job records in the Catalog
2891 database after the Job End time. (In \texttt{JobHistory} table) When this time
2892 period expires, and if user runs \texttt{prune stats} command, Bacula will
2893 prune (remove) Job records that are older than the specified period.
2895 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2896 job to maintain statistics.
2899 Name = BackupCatalog
2902 Console = "update stats days=3"
2903 Console = "prune stats yes"
2910 \subsubsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2911 \index[general]{ScratchPool}
2912 This directive permits to specify a specific \textsl{Scratch} pool for the
2913 current pool. This is useful when using multiple storage sharing the same
2914 mediatype or when you want to dedicate volumes to a particular set of pool.
2916 \subsubsection{Enhanced Attribute Despooling}
2917 \index[general]{Attribute Despooling}
2918 If the storage daemon and the Director are on the same machine, the spool file
2919 that contains attributes is read directly by the Director instead of being
2920 transmitted across the network. That should reduce load and speedup insertion.
2922 \subsubsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2923 \index[general]{SpoolSize}
2924 A new Job directive permits to specify the spool size per job. This is used
2925 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2927 \subsubsection{MaximumConsoleConnections = \lt{}number\gt{}}
2928 \index[general]{MaximumConsoleConnections}
2929 A new director directive permits to specify the maximum number of Console
2930 Connections that could run concurrently. The default is set to 20, but you may
2931 set it to a larger number.
2933 \subsubsection{VerId = \lt{}string\gt{}}
2934 \index[general]{VerId}
2935 A new director directive permits to specify a personnal identifier that will be
2936 displayed in the \texttt{version} command.
2938 \subsubsection{dbcheck enhancements}
2939 \index[general]{dbcheck enhancements}
2940 If you are using Mysql, dbcheck will now ask you if you want to create
2941 temporary indexes to speed up orphaned Path and Filename elimination.
2943 A new \texttt{-B} option allows you to print catalog information in a simple
2944 text based format. This is useful to backup it in a secure way.
2959 You can now specify the database connection port in the command line.
2961 \subsubsection{{-}{-}docdir configure option}
2962 \index[general]{{-}{-}docdir configure option}
2963 You can use {-}{-}docdir= on the ./configure command to
2964 specify the directory where you want Bacula to install the
2965 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2966 {\bf /usr/share/doc/bacula}.
2968 \subsubsection{{-}{-}htmldir configure option}
2969 \index[general]{{-}{-}htmldir configure option}
2970 You can use {-}{-}htmldir= on the ./configure command to
2971 specify the directory where you want Bacula to install the bat html help
2972 files. The default is {\bf /usr/share/doc/bacula/html}
2974 \subsubsection{{-}{-}with-plugindir configure option}
2975 \index[general]{{-}{-}plugindir configure option}
2976 You can use {-}{-}plugindir= on the ./configure command to
2977 specify the directory where you want Bacula to install
2978 the plugins (currently only bpipe-fd). The default is