1 \chapter{New Features in 5.1.x}
2 This chapter presents the new features that have been added to the
3 current version of Bacula that is under development. This version will be
4 released at some later date, probably near the end of April 2011.
6 \section{Restart Incomplete Job}
10 This project was funded by Bacula Systems and is available with Bacula
11 Enterprise Edition and Community Edition.
13 \section{New Tray Monitor}
15 Since the old integrated Windows tray monitor doesn't work anymore with
16 recent Windows versions, we have written a new Qt Tray Monitor that is available
17 for both Linux and Windows. This new version allows you to run Backup from
18 the tray monitor menu.
22 \includegraphics[width=10cm]{\idir tray-monitor}
23 \label{fig:traymonitor}
24 \caption{New tray monitor}
29 \includegraphics[width=10cm]{\idir tray-monitor1}
30 \label{fig:traymonitor1}
31 \caption{Run a Job through the new tray monitor}
35 This project was funded by Bacula Systems and is available with Bacula
36 the Enterprise Edition and the Community Edition.
38 \section{Purge Migration Job}
40 The new {\bf Purge Migration Job} directive may be added to the Migration
41 Job definition in the Director's configuration file. When it is enabled
42 the Job that was migrated during a migration will be purged at
43 the end of the migration job.
57 Selection Pattern = ".*Save"
59 Purge Migrated Job = yes
65 This project was submited by Dunlap Blake, testing and documentation was funded
68 \section{Job Bandwidth Limitation}
70 The new {\bf Job Bandwidth Limitation} directive may be added to the File
71 daemon's and/or Director's configuration to limit the bandwidth used by a Job on a
72 Client. It can be set in the File daemon's conf file for all Jobs run
73 in that File daemon, or it can be set for each Job in the
80 Working Directory = /some/path
81 Pid Directory = /some/path
83 Maximum Bandwidth Per Job = 5MB/s
87 The above example would cause any jobs running with the FileDaemon to not
88 exceed 5MB/s of throughput when sending data to the Storage Daemon.
90 You can specify the speed parameter in k/s, KB/s, m/s, MB/s.
96 FileSet = FS_localhost
99 Maximum Bandwidth = 5MB/s
104 The above example would cause Job \texttt{localhost-data} to not exceed 5MB/s
105 of throughput when sending data from the File daemon to the Storage daemon.
107 A new console command \texttt{setbandwidth} permits to set dynamically the
108 maximum throughput of a running Job or for future jobs of a Client.
111 * setbandwidth limit=1000000 jobid=10
114 The \texttt{limit} parameter is in KB/s.
117 This project was funded by Bacula Systems and is available in
118 the Enterprise Edition and the Community Edition.
120 \section{Support for MSSQL Block Level Backup}
122 This project was funded by Bacula Systems and is available with the Bacula
125 \section{Support for NDMP protocol}
127 The new \texttt{ndmp} Plugin is able to backup a NAS through NDMP protocol
128 using \textbf{Filer to server} approach, where the Filer is backing up across
129 the LAN to your Bacula server.
131 Accurate option should be turned on in the Job resource.
143 Plugin = "ndmp:host=nasbox user=root pass=root file=/vol/vol1"
148 This project was funded by Bacula Systems and is available with the Bacula
151 \section{Incremental/Differential Block Level Difference Backup}
153 The new \texttt{delta} Plugin is able to compute and apply signature-based file
154 differences. It can be used to backup only changes in a big binary file like
155 Outlook PST, VirtualBox/VmWare images or database files.
157 It supports both Incremental and Differential backups and stores signatures
158 database in the File Daemon working directory. This plugin is available on all
159 plateform including Windows 32 and 64bit.
161 Accurate option should be turned on in the Job resource.
173 Plugin = "delta:/home/eric/.VirtualBox/HardDisks/lenny-i386.vdi"
178 This project was funded by Bacula Systems and is available with the Bacula
181 \section{Include All Windows Drives in FileSet}
183 The \texttt{alldrives} Windows Plugin allows you to include all local drives
184 with a simple directive. This plugin is available for Windows 64 and 32 bit.
196 You exclude some specific drives with the \texttt{exclude} option.
203 Plugin = "alldrives: exclude=D,E"
209 This project was funded by Bacula Systems and is available with the Bacula
212 \section{SQL Catalog Enhancements}
214 % TODO: Marco can explain more things
215 Bacula uses a new catalog backend structure, it allows to build all SQL drivers
216 with the same \texttt{./configure ; make} session.
218 We also added cursor support for PostgreSQL backend, this improves memory usage
219 for large installation.
221 \section{Changes in Bvfs (Bacula Virtual FileSystem)}
223 Bat has now a bRestore panel that uses Bvfs to display files and
224 directories. It's still experimental.
228 \includegraphics[width=12cm]{\idir bat-brestore}
229 \label{fig:batbrestore}
230 \caption{Bat Brestore Panel}
233 \texttt{Important}, the Bvfs module is not currently compatible with BaseJobs,
234 Copy and Migration jobs.
237 This project was funded by Bacula Systems.
239 \subsection*{General notes}
242 \item All fields are separated by a tab
243 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
244 records in very big directories
245 \item All operations (except cache creation) are designed to run instantly
246 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
247 can contribute new faster SQL queries we will be happy, else don't complain
249 \item The cache creation is dependent of the number of directories. As Bvfs
250 shares information accross jobs, the first creation can be slow
251 \item All fields are separated by a tab
252 \item Due to potential encoding problem, it's advised to allways use pathid in
256 \subsection*{Get dependent jobs from a given JobId}
258 Bvfs allows you to query the catalog against any combination of jobs. You
259 can combine all Jobs and all FileSet for a Client in a single session.
261 To get all JobId needed to restore a particular job, you can use the
262 \texttt{.bvfs\_get\_jobids} command.
265 .bvfs_get_jobids jobid=num [all]
269 .bvfs_get_jobids jobid=10
271 .bvfs_get_jobids jobid=10 all
275 In this example, a normal restore will need to use JobIds 1,2,5,10 to
276 compute a complete restore of the system.
278 With the \texttt{all} option, the Director will use all defined FileSet for
281 \subsection*{Generating Bvfs cache}
283 The \texttt{.bvfs\_update} command computes the directory cache for jobs
284 specified in argument, or for all jobs if unspecified.
287 .bvfs_update [jobid=numlist]
292 .bvfs_update jobid=1,2,3
295 You can run the cache update process in a RunScript after the catalog backup.
297 \subsection*{Get all versions of a specific file}
299 Bvfs allows you to find all versions of a specific file for a given Client with
300 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
301 function uses only PathId and FilenameId. The jobid argument is mandatory but
305 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
306 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
307 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
314 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
315 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
318 \subsection*{List directories}
320 Bvfs allows you to list directories in a specific path.
322 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
323 PathId FilenameId FileId JobId LStat Path
324 PathId FilenameId FileId JobId LStat Path
325 PathId FilenameId FileId JobId LStat Path
329 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
330 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
331 listed is a directory.
334 .bvfs_lsdirs pathid=4 jobid=1,11,12
335 4 0 0 0 A A A A A A A A A A A A A A .
336 5 0 0 0 A A A A A A A A A A A A A A ..
337 3 0 0 0 A A A A A A A A A A A A A A regress/
340 In this example, to list directories present in \texttt{regress/}, you can use
342 .bvfs_lsdirs pathid=3 jobid=1,11,12
343 3 0 0 0 A A A A A A A A A A A A A A .
344 4 0 0 0 A A A A A A A A A A A A A A ..
345 2 0 0 0 A A A A A A A A A A A A A A tmp/
348 \subsection*{List files}
350 Bvfs allows you to list files in a specific path.
352 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
353 PathId FilenameId FileId JobId LStat Path
354 PathId FilenameId FileId JobId LStat Path
355 PathId FilenameId FileId JobId LStat Path
359 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
360 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
364 .bvfs_lsfiles pathid=4 jobid=1,11,12
365 4 0 0 0 A A A A A A A A A A A A A A .
366 5 0 0 0 A A A A A A A A A A A A A A ..
367 1 0 0 0 A A A A A A A A A A A A A A regress/
370 In this example, to list files present in \texttt{regress/}, you can use
372 .bvfs_lsfiles pathid=1 jobid=1,11,12
373 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
374 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
375 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
376 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
377 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
380 \subsection*{Restore set of files}
382 Bvfs allows you to create a SQL table that contains files that you want to
383 restore. This table can be provided to a restore command with the file option.
386 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
388 restore file=?b2num ...
391 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
392 select all files. This query could be time consuming.
394 \texttt{hardlink} list is always composed of a serie of two numbers (jobid,
395 fileindex). This information can be found in the LinkFI field of the LStat
398 The \texttt{path} argument represents the name of the table that Bvfs will
399 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
400 b2 and followed by digits).
405 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
409 \subsection*{Cleanup after restore}
411 To drop the table used by the restore command, you can use the
412 \texttt{.bvfs\_cleanup} command.
415 .bvfs_cleanup path=b20001
418 \section{Changes in the pruning algorithm}
420 We rewrote the job pruning algorithm in this version. Previously, in some users
421 reported that the pruning process at the end of jobs was very long. It should
422 not be longer the case. Now, Bacula won't prune automatically a Job if this
423 particular Job is needed to restore data. Example:
427 JobId: 2 Level: Incremental
428 JobId: 3 Level: Incremental
429 JobId: 4 Level: Differential
430 .. Other incrementals up to now
433 In this example, if the Job Retention defined in the Pool or in the Client
434 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
435 detect that JobId 1 and 4 are essential to restore data at the current state
436 and will prune only JobId 2 and 3.
438 \texttt{Important}, this change affect only the automatic pruning step after a
439 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
440 \texttt{VolumeRetention} period, important jobs can be pruned.
442 \section{Ability to Verify any specified Job}
443 You now have the ability to tell Bacula which Job should verify instead of
444 automatically verify just the last one.
446 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
448 To verify a given job, just specify the Job jobid in argument when starting the
451 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
453 JobName: VerifyVolume
454 Level: VolumeToCatalog
457 Pool: Default (From Job resource)
458 Storage: File (From Job resource)
459 Verify Job: VerifyVol.2010-09-08_14.17.17_03
460 Verify List: /tmp/regress/working/VerifyVol.bsr
461 When: 2010-09-08 14:17:31
463 OK to run? (yes/mod/no):
467 This project was funded by Bacula Systems and is available with Bacula
468 Enterprise Edition and Community Edition.
470 \section{Additions to RunScript variables}
471 You can have access to JobBytes and JobFiles using \%b and \%f in your runscript
472 command. The Client address is now available through \%h.
475 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%f ClientAddress=%h"
478 %\section{Changes in drivetype.exe}
480 %Now the \texttt{drivetype.exe} program allows you to list all local hard
481 %drives. It can help to build dynamic FileSet on Windows.
484 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
488 \section{ACL/Extended Attributes}
490 We added support for NFSv4 ACLs on FreeBSD 8.1 and IRIX extended attributes.
492 This project was funded by Marco van Wieringen.
494 \section{Additions to the Plugin API}
495 The bfuncs structure has been extended to include a number of
499 The bFuncs structure defines the callback entry points within Bacula
500 that the plugin can use register events, get Bacula values, set
501 Bacula values, and send messages to the Job output or debug output.
503 The exact definition as of this writing is:
505 typedef struct s_baculaFuncs {
508 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
509 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
510 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
511 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
512 int type, utime_t mtime, const char *fmt, ...);
513 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
514 int level, const char *fmt, ...);
515 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
517 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
519 /* New functions follow */
520 bRC (*AddExclude)(bpContext *ctx, const char *file);
521 bRC (*AddInclude)(bpContext *ctx, const char *file);
522 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
523 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
524 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
525 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
531 \item [AddExclude] can be called to exclude a file. The file
532 string passed may include wildcards that will be interpreted by
533 the {\bf fnmatch} subroutine. This function can be called
534 multiple times, and each time the file specified will be added
535 to the list of files to be excluded. Note, this function only
536 permits adding excludes of specific file or directory names,
537 or files matched by the rather simple fnmatch mechanism.
538 See below for information on doing wild-card and regex excludes.
540 \item [NewInclude] can be called to create a new Include block. This
541 block will be added before any user defined Include blocks. This
542 function can be called multiple times, but each time, it will create
543 a new Include section (not normally needed). This function should
544 be called only if you want to add an entirely new Include block.
546 \item [AddInclude] can be called to add new files/directories to
547 be included. They are added to the current Include block. If
548 NewInclude has not been included, the current Include block is
549 the last one that the user created. This function
550 should be used only if you want to add totally new files/directories
551 to be included in the backup.
553 \item [NewOptions] adds a new Options block to the current Include
554 in front of any other Options blocks. This permits the plugin to
555 add exclude directives (wild-cards and regexes) in front of the
556 user Options, and thus prevent certain files from being backed up.
557 This can be useful if the plugin backs up files, and they should
558 not be also backed up by the main Bacula code. This function
559 may be called multiple times, and each time, it creates a new
560 prepended Options block. Note: normally you want to call this
561 entry point prior to calling AddOptions, AddRegex, or AddWild.
563 \item [AddOptions] allows the plugin it set options in
564 the current Options block, which is normally created with the
565 NewOptions call just prior to adding Include Options.
566 The permitted options are passed as a character string, where
567 each character has a specific meaning as defined below:
570 \item [a] always replace files (default).
571 \item [e] exclude rather than include.
572 \item [h] no recursion into subdirectories.
573 \item [H] do not handle hard links.
574 \item [i] ignore case in wildcard and regex matches.
575 \item [M] compute an MD5 sum.
576 \item [p] use a portable data format on Windows (not recommended).
577 \item [R] backup resource forks and Findr Info.
578 \item [r] read from a fifo
579 \item [S1] compute an SHA1 sum.
580 \item [S2] compute an SHA256 sum.
581 \item [S3] comput an SHA512 sum.
582 \item [s] handle sparse files.
583 \item [m] use st\_mtime only for file differences.
584 \item [k] restore the st\_atime after accessing a file.
585 \item [A] enable ACL backup.
586 \item [Vxxx:] specify verify options. Must terminate with :
587 \item [Cxxx:] specify accurate options. Must terminate with :
588 \item [Jxxx:] specify base job Options. Must terminate with :
589 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
591 \item [Zn] specify gzip compression level n.
592 \item [K] do not use st\_atime in backup decision.
593 \item [c] check if file changed during backup.
594 \item [N] honor no dump flag.
595 \item [X] enable backup of extended attributes.
598 \item [AddRegex] adds a regex expression to the current Options block.
599 The fillowing options are permitted:
601 \item [ ] (a blank) regex applies to whole path and filename.
602 \item [F] regex applies only to the filename (directory or path stripped).
603 \item [D] regex applies only to the directory (path) part of the name.
606 \item [AddWild] adds a wildcard expression to the current Options block.
607 The fillowing options are permitted:
609 \item [ ] (a blank) regex applies to whole path and filename.
610 \item [F] regex applies only to the filename (directory or path stripped).
611 \item [D] regex applies only to the directory (path) part of the name.
614 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
615 that can use Accurate code to compare the file information in argument with
616 the previous file information. The \texttt{delta\_seq} attribute of the
617 \texttt{save\_pkt} will be updated, and the call will return
618 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
623 \subsection{Bacula events}
624 The list of events has been extended to include:
630 bEventStartBackupJob = 3,
631 bEventEndBackupJob = 4,
632 bEventStartRestoreJob = 5,
633 bEventEndRestoreJob = 6,
634 bEventStartVerifyJob = 7,
635 bEventEndVerifyJob = 8,
636 bEventBackupCommand = 9,
637 bEventRestoreCommand = 10,
642 bEventCancelCommand = 13,
643 bEventVssBackupAddComponents = 14,
644 bEventVssRestoreLoadComponentMetadata = 15,
645 bEventVssRestoreSetComponentsSelected = 16,
646 bEventRestoreObject = 17,
647 bEventEndFileSet = 18,
648 bEventPluginCommand = 19,
649 bEventVssBeforeCloseRestore = 20,
650 bEventVssPrepareSnapshot = 21
656 \item [bEventCancelCommand] is called whenever the currently
657 running Job is cancelled */
659 \item [bEventVssBackupAddComponents]
661 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
662 provides a char[27] table where the plugin can add Windows drives that will
663 be used during the Job. You need to add them without duplicates, and you can
664 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
668 \chapter{Release Version 5.0.3}
670 There are no new features in version 5.0.2. This version simply fixes a
671 number of bugs found in version 5.0.1 during the onging development
674 \chapter{Release Version 5.0.2}
676 There are no new features in version 5.0.2. This version simply fixes a
677 number of bugs found in version 5.0.1 during the onging development
683 \chapter{New Features in 5.0.1}
685 This chapter presents the new features that are in the released Bacula version
686 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
687 the onging development process.
689 \section{Truncate Volume after Purge}
690 \label{sec:actiononpurge}
692 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
693 the volume when it is purged with the new command \texttt{purge volume
694 action}. It is useful to prevent disk based volumes from consuming too much
700 Action On Purge = Truncate
705 As usual you can also set this property with the \texttt{update volume} command
707 *update volume=xxx ActionOnPurge=Truncate
708 *update volume=xxx actiononpurge=None
711 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
712 following command in interactive mode or in a RunScript as shown after:
714 *purge volume action=truncate storage=File allpools
715 # or by default, action=all
716 *purge volume action storage=File pool=Default
719 This is possible to specify the volume name, the media type, the pool, the
720 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
721 idle when you decide to run this command.
730 Console = "purge volume action=all allpools storage=File"
735 \textbf{Important note}: This feature doesn't work as
736 expected in version 5.0.0. Please do not use it before version 5.0.1.
738 \section{Allow Higher Duplicates}
739 This directive did not work correctly and has been depreciated
740 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
741 file as it will be removed in a future rlease.
743 \section{Cancel Lower Level Duplicates}
744 This directive was added in Bacula version 5.0.1. It compares the
745 level of a new backup job to old jobs of the same name, if any,
746 and will kill the job which has a lower level than the other one.
747 If the levels are the same (i.e. both are Full backups), then
748 nothing is done and the other Cancel XXX Duplicate directives
751 \chapter{New Features in 5.0.0}
753 \section{Maximum Concurent Jobs for Devices}
754 \label{sec:maximumconcurentjobdevice}
756 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
757 Daemon configuration permits setting the maximum number of Jobs that can
758 run concurrently on a specified Device. Using this directive, it is
759 possible to have different Jobs using multiple drives, because when the
760 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
761 Jobs on any other available compatible drive. This facilitates writing to
762 multiple drives with multiple Jobs that all use the same Pool.
764 This project was funded by Bacula Systems.
766 \section{Restore from Multiple Storage Daemons}
767 \index[general]{Restore}
769 Previously, you were able to restore from multiple devices in a single Storage
770 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
771 example, if your full backup runs on a Storage Daemon with an autochanger, and
772 your incremental jobs use another Storage Daemon with lots of disks, Bacula
773 will switch automatically from one Storage Daemon to an other within the same
776 You must upgrade your File Daemon to version 3.1.3 or greater to use this
779 This project was funded by Bacula Systems with the help of Equiinet.
781 \section{File Deduplication using Base Jobs}
782 A base job is sort of like a Full save except that you will want the FileSet to
783 contain only files that are unlikely to change in the future (i.e. a snapshot
784 of most of your system after installing it). After the base job has been run,
785 when you are doing a Full save, you specify one or more Base jobs to be used.
786 All files that have been backed up in the Base job/jobs but not modified will
787 then be excluded from the backup. During a restore, the Base jobs will be
788 automatically pulled in where necessary.
790 This is something none of the competition does, as far as we know (except
791 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
792 win for the user, it makes Bacula stand out as offering a unique optimization
793 that immediately saves time and money. Basically, imagine that you have 100
794 nearly identical Windows or Linux machine containing the OS and user files.
795 Now for the OS part, a Base job will be backed up once, and rather than making
796 100 copies of the OS, there will be only one. If one or more of the systems
797 have some files updated, no problem, they will be automatically restored.
799 See the \ilink{Base Job Chapter}{basejobs} for more information.
801 This project was funded by Bacula Systems.
803 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
804 \index[dir]{AllowCompression}
806 This new directive may be added to Storage resource within the Director's
807 configuration to allow users to selectively disable the client compression for
808 any job which writes to this storage resource.
814 Address = ultrium-tape
815 Password = storage_password # Password for Storage Daemon
818 AllowCompression = No # Tape drive has hardware compression
821 The above example would cause any jobs running with the UltriumTape storage
822 resource to run without compression from the client file daemons. This
823 effectively overrides any compression settings defined at the FileSet level.
825 This feature is probably most useful if you have a tape drive which supports
826 hardware compression. By setting the \texttt{AllowCompression = No} directive
827 for your tape drive storage resource, you can avoid additional load on the file
828 daemon and possibly speed up tape backups.
830 This project was funded by Collaborative Fusion, Inc.
832 \section{Accurate Fileset Options}
833 \label{sec:accuratefileset}
835 In previous versions, the accurate code used the file creation and modification
836 times to determine if a file was modified or not. Now you can specify which
837 attributes to use (time, size, checksum, permission, owner, group, \dots),
838 similar to the Verify options.
854 \item {\bf i} compare the inodes
855 \item {\bf p} compare the permission bits
856 \item {\bf n} compare the number of links
857 \item {\bf u} compare the user id
858 \item {\bf g} compare the group id
859 \item {\bf s} compare the size
860 \item {\bf a} compare the access time
861 \item {\bf m} compare the modification time (st\_mtime)
862 \item {\bf c} compare the change time (st\_ctime)
863 \item {\bf d} report file size decreases
864 \item {\bf 5} compare the MD5 signature
865 \item {\bf 1} compare the SHA1 signature
868 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
869 the File Daemon will have to read all files even if they normally would not
870 be saved. This increases the I/O load, but also the accuracy of the
871 deduplication. By default, Bacula will check modification/creation time
874 This project was funded by Bacula Systems.
876 \section{Tab-completion for Bconsole}
877 \label{sec:tabcompletion}
879 If you build \texttt{bconsole} with readline support, you will be able to use
880 the new auto-completion mode. This mode supports all commands, gives help
881 inside command, and lists resources when required. It works also in the restore
884 To use this feature, you should have readline development package loaded on
885 your system, and use the following option in configure.
887 ./configure --with-readline=/usr/include/readline --disable-conio ...
890 The new bconsole won't be able to tab-complete with older directors.
892 This project was funded by Bacula Systems.
894 \section{Pool File and Job Retention}
895 \label{sec:poolfilejobretention}
897 We added two new Pool directives, \texttt{FileRetention} and
898 \texttt{JobRetention}, that take precedence over Client directives of the same
899 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
900 example, you can decide to increase Retention times for Archive or OffSite Pool.
902 It seems obvious to us, but apparently not to some users, that given the
903 definition above that the Pool File and Job Retention periods is a global
904 override for the normal Client based prunning, which means that when the
905 Job is prunned, the prunning will apply globally to that particular Job.
907 Currently, there is a bug in the implementation that causes any Pool
908 retention periods specified to apply to {\bf all} Pools for that
909 particular Client. Thus we suggest that you avoid using these two
910 directives until this implementation problem is corrected.
912 \section{Read-only File Daemon using capabilities}
913 \label{sec:fdreadonly}
914 This feature implements support of keeping \textbf{ReadAll} capabilities after
915 UID/GID switch, this allows FD to keep root read but drop write permission.
917 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
918 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
921 root@localhost:~# bacula-fd -k -u nobody -g nobody
924 The code for this feature was contributed by our friends at AltLinux.
929 To help developers of restore GUI interfaces, we have added new \textsl{dot
930 commands} that permit browsing the catalog in a very simple way.
933 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
934 the Bvfs cache in the catalog. You need to run it before any access to the
937 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
938 will list all directories in the specified \texttt{path} or
939 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
940 encoding of path/filenames.
942 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
943 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
944 \texttt{pathid} avoids problems with character encoding.
947 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
948 data that will be displayed.
951 * .bvfs_update jobid=1,2
953 * .bvfs_lsdir path=/ jobid=1,2
956 This project was funded by Bacula Systems.
958 \section{Testing your Tape Drive}
959 \label{sec:btapespeed}
961 To determine the best configuration of your tape drive, you can run the new
962 \texttt{speed} command available in the \texttt{btape} program.
964 This command can have the following arguments:
966 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
967 (between 1 and 5GB). This counter is in GB.
968 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
969 of data should be greater than your memory ($file\_size*nb\_file$).
970 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
972 \item[\texttt{skip\_random}] This flag permits to skip tests with random
974 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
975 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
980 *speed file_size=3 skip_raw
981 btape.c:1078 Test with zero data and bacula block structure.
982 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
983 ++++++++++++++++++++++++++++++++++++++++++
984 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
985 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
987 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
989 btape.c:1090 Test with random data, should give the minimum throughput.
990 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
991 +++++++++++++++++++++++++++++++++++++++++++
992 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
993 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
994 +++++++++++++++++++++++++++++++++++++++++++
996 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
1000 When using compression, the random test will give your the minimum throughput
1001 of your drive . The test using constant string will give you the maximum speed
1002 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
1004 You can change the block size in the Storage Daemon configuration file.
1006 \section{New {\bf Block Checksum} Device Directive}
1007 You may now turn off the Block Checksum (CRC32) code
1008 that Bacula uses when writing blocks to a Volume. This is
1015 doing so can reduce the Storage daemon CPU usage slightly. It
1016 will also permit Bacula to read a Volume that has corrupted data.
1018 The default is {\bf yes} -- i.e. the checksum is computed on write
1019 and checked on read.
1021 We do not recommend to turn this off particularly on older tape
1022 drives or for disk Volumes where doing so may allow corrupted data
1025 \section{New Bat Features}
1027 Those new features were funded by Bacula Systems.
1029 \subsection{Media List View}
1031 By clicking on ``Media'', you can see the list of all your volumes. You will be
1032 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1033 in the table. The old ``Media'' view is now known as ``Pool''.
1034 \begin{figure}[htbp]
1036 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
1037 \label{fig:mediaview}
1041 \subsection{Media Information View}
1043 By double-clicking on a volume (on the Media list, in the Autochanger content
1044 or in the Job information panel), you can access a detailed overview of your
1045 Volume. (cf \ref{fig:mediainfo}.)
1046 \begin{figure}[htbp]
1048 \includegraphics[width=13cm]{\idir bat11.eps}
1049 \caption{Media information}
1050 \label{fig:mediainfo}
1053 \subsection{Job Information View}
1055 By double-clicking on a Job record (on the Job run list or in the Media
1056 information panel), you can access a detailed overview of your Job. (cf
1058 \begin{figure}[htbp]
1060 \includegraphics[width=13cm]{\idir bat12.eps}
1061 \caption{Job information}
1065 \subsection{Autochanger Content View}
1067 By double-clicking on a Storage record (on the Storage list panel), you can
1068 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
1069 \begin{figure}[htbp]
1071 \includegraphics[width=13cm]{\idir bat13.eps}
1072 \caption{Autochanger content}
1073 \label{fig:achcontent}
1076 To use this feature, you need to use the latest mtx-changer script
1077 version. (With new \texttt{listall} and \texttt{transfer} commands)
1079 \section{Bat on Windows}
1080 We have ported {\bf bat} to Windows and it is now installed
1081 by default when the installer is run. It works quite well
1082 on Win32, but has not had a lot of testing there, so your
1083 feedback would be welcome. Unfortunately, eventhough it is
1084 installed by default, it does not yet work on 64 bit Windows
1087 \section{New Win32 Installer}
1088 The Win32 installer has been modified in several very important
1091 \item You must deinstall any current version of the
1092 Win32 File daemon before upgrading to the new one.
1093 If you forget to do so, the new installation will fail.
1094 To correct this failure, you must manually shutdown
1095 and deinstall the old File daemon.
1096 \item All files (other than menu links) are installed
1097 in {\bf c:/Program Files/Bacula}.
1098 \item The installer no longer sets this
1099 file to require administrator privileges by default. If you want
1100 to do so, please do it manually using the {\bf cacls} program.
1103 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1105 \item The server daemons (Director and Storage daemon) are
1106 no longer included in the Windows installer. If you want the
1107 Windows servers, you will either need to build them yourself (note
1108 they have not been ported to 64 bits), or you can contact
1109 Bacula Systems about this.
1112 \section{Win64 Installer}
1113 We have corrected a number of problems that required manual
1114 editing of the conf files. In most cases, it should now
1115 install and work. {\bf bat} is by default installed in
1116 {\bf c:/Program Files/Bacula/bin32} rather than
1117 {\bf c:/Program Files/Bacula} as is the case with the 32
1118 bit Windows installer.
1120 \section{Linux Bare Metal Recovery USB Key}
1121 We have made a number of significant improvements in the
1122 Bare Metal Recovery USB key. Please see the README files
1123 it the {\bf rescue} release for more details.
1125 We are working on an equivalent USB key for Windows bare
1126 metal recovery, but it will take some time to develop it (best
1127 estimate 3Q2010 or 4Q2010)
1130 \section{bconsole Timeout Option}
1131 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1132 for commands. This is useful with GUI programs that use {\bf bconsole}
1133 to interface to the Director.
1135 \section{Important Changes}
1136 \label{sec:importantchanges}
1139 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1140 to the same Pool. The Storage daemon ensures that you do not read and
1141 write to the same Volume.
1142 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1144 \item Virtually all the features of {\bf mtx-changer} have
1145 now been parameterized, which allows you to configure
1146 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1147 that contains variables that you can set to configure mtx-changer.
1148 This configuration file will not be overwritten during upgrades.
1149 We encourage you to submit any changes
1150 that are made to mtx-changer and to parameterize it all in
1151 mtx-changer.conf so that all configuration will be done by
1152 changing only mtx-changer.conf.
1153 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1154 and \texttt{transfer}. Please configure them as appropriate
1155 in mtx-changer.conf.
1156 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1157 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1158 password. If you want to use the new script, you will need to
1159 manually change the \texttt{BackupCatalog} Job definition.
1160 \item The \texttt{bconsole} \texttt{help} command now accepts
1161 an argument, which if provided produces information on that
1162 command (ex: \texttt{help run}).
1166 \subsubsection*{Truncate volume after purge}
1168 Note that the Truncate Volume after purge feature doesn't work as expected
1169 in 5.0.0 version. Please, don't use it before version 5.0.1.
1171 \subsection{Custom Catalog queries}
1173 If you wish to add specialized commands that list the contents of the catalog,
1174 you can do so by adding them to the \texttt{query.sql} file. This
1175 \texttt{query.sql} file is now empty by default. The file
1176 \texttt{examples/sample-query.sql} has an a number of sample commands
1177 you might find useful.
1179 \subsection{Deprecated parts}
1181 The following items have been \textbf{deprecated} for a long time, and are now
1182 removed from the code.
1185 \item Support for SQLite 2
1188 \section{Misc Changes}
1189 \label{sec:miscchanges}
1192 \item Updated Nagios check\_bacula
1193 \item Updated man files
1194 \item Added OSX package generation script in platforms/darwin
1195 \item Added Spanish and Ukrainian Bacula translations
1196 \item Enable/disable command shows only Jobs that can change
1197 \item Added \texttt{show disabled} command to show disabled Jobs
1198 \item Many ACL improvements
1199 \item Added Level to FD status Job output
1200 \item Begin Ingres DB driver (not yet working)
1201 \item Split RedHat spec files into bacula, bat, mtx, and docs
1202 \item Reorganized the manuals (fewer separate manuals)
1203 \item Added lock/unlock order protection in lock manager
1204 \item Allow 64 bit sizes for a number of variables
1205 \item Fixed several deadlocks or potential race conditions in the SD
1208 \chapter{Released Version 3.0.3 and 3.0.3a}
1210 There are no new features in version 3.0.3. This version simply fixes a
1211 number of bugs found in version 3.0.2 during the onging development
1214 \chapter{New Features in Released Version 3.0.2}
1216 This chapter presents the new features added to the
1217 Released Bacula Version 3.0.2.
1219 \section{Full Restore from a Given JobId}
1220 \index[general]{Restore menu}
1222 This feature allows selecting a single JobId and having Bacula
1223 automatically select all the other jobs that comprise a full backup up to
1224 and including the selected date (through JobId).
1226 Assume we start with the following jobs:
1228 +-------+--------------+---------------------+-------+----------+------------+
1229 | jobid | client | starttime | level | jobfiles | jobbytes |
1230 +-------+--------------+---------------------+-------+----------+------------
1231 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1232 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1233 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1234 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1235 +-------+--------------+---------------------+-------+----------+------------+
1238 Below is an example of this new feature (which is number 12 in the
1243 To select the JobIds, you have the following choices:
1244 1: List last 20 Jobs run
1245 2: List Jobs where a given File is saved
1247 12: Select full restore to a specified Job date
1250 Select item: (1-13): 12
1251 Enter JobId to get the state to restore: 5
1252 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1253 You have selected the following JobIds: 1,3,5
1255 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1256 1,444 files inserted into the tree.
1259 This project was funded by Bacula Systems.
1261 \section{Source Address}
1262 \index[general]{Source Address}
1264 A feature has been added which allows the administrator to specify the address
1265 from which the Director and File daemons will establish connections. This
1266 may be used to simplify system configuration overhead when working in complex
1267 networks utilizing multi-homing and policy-routing.
1269 To accomplish this, two new configuration directives have been implemented:
1272 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1276 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1280 Simply adding specific host routes on the OS
1281 would have an undesirable side-effect: any
1282 application trying to contact the destination host would be forced to use the
1283 more specific route possibly diverting management traffic onto a backup VLAN.
1284 Instead of adding host routes for each client connected to a multi-homed backup
1285 server (for example where there are management and backup VLANs), one can
1286 use the new directives to specify a specific source address at the application
1289 Additionally, this allows the simplification and abstraction of firewall rules
1290 when dealing with a Hot-Standby director or storage daemon configuration. The
1291 Hot-standby pair may share a CARP address, which connections must be sourced
1292 from, while system services listen and act from the unique interface addresses.
1294 This project was funded by Collaborative Fusion, Inc.
1296 \section{Show volume availability when doing restore}
1298 When doing a restore the selection dialog ends by displaying this
1302 The job will require the following
1303 Volume(s) Storage(s) SD Device(s)
1304 ===========================================================================
1305 *000741L3 LTO-4 LTO3
1306 *000866L3 LTO-4 LTO3
1307 *000765L3 LTO-4 LTO3
1308 *000764L3 LTO-4 LTO3
1309 *000756L3 LTO-4 LTO3
1310 *001759L3 LTO-4 LTO3
1311 *001763L3 LTO-4 LTO3
1315 Volumes marked with ``*'' are online (in the autochanger).
1318 This should help speed up large restores by minimizing the time spent
1319 waiting for the operator to discover that he must change tapes in the library.
1321 This project was funded by Bacula Systems.
1323 \section{Accurate estimate command}
1325 The \texttt{estimate} command can now use the accurate code to detect changes
1326 and give a better estimation.
1328 You can set the accurate behavior on the command line by using
1329 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1332 * estimate listing accurate=yes level=incremental job=BackupJob
1335 This project was funded by Bacula Systems.
1337 \chapter{New Features in 3.0.0}
1338 \label{NewFeaturesChapter}
1339 \index[general]{New Features}
1341 This chapter presents the new features added to the development 2.5.x
1342 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1344 \section{Accurate Backup}
1345 \index[general]{Accurate Backup}
1347 As with most other backup programs, by default Bacula decides what files to
1348 backup for Incremental and Differental backup by comparing the change
1349 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1350 backup completed. If one of those two times is later than the last backup
1351 time, then the file will be backed up. This does not, however, permit tracking
1352 what files have been deleted and will miss any file with an old time that may
1353 have been restored to or moved onto the client filesystem.
1355 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1356 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1357 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1358 backup, there is no difference, but for {\bf Differential} and {\bf
1359 Incremental} backups, the Director will send a list of all previous files
1360 backed up, and the File daemon will use that list to determine if any new files
1361 have been added or or moved and if any files have been deleted. This allows
1362 Bacula to make an accurate backup of your system to that point in time so that
1363 if you do a restore, it will restore your system exactly.
1366 about using Accurate backup is that it requires more resources (CPU and memory)
1367 on both the Director and the Client machines to create the list of previous
1368 files backed up, to send that list to the File daemon, for the File daemon to
1369 keep the list (possibly very big) in memory, and for the File daemon to do
1370 comparisons between every file in the FileSet and the list. In particular,
1371 if your client has lots of files (more than a few million), you will need
1372 lots of memory on the client machine.
1374 Accurate must not be enabled when backing up with a plugin that is not
1375 specially designed to work with Accurate. If you enable it, your restores
1376 will probably not work correctly.
1378 This project was funded by Bacula Systems.
1383 \index[general]{Copy Jobs}
1385 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1386 existing Migration feature with the exception that the Job that is copied is
1387 left unchanged. This essentially creates two identical copies of the same
1388 backup. However, the copy is treated as a copy rather than a backup job, and
1389 hence is not directly available for restore. The {\bf restore} command lists
1390 copy jobs and allows selection of copies by using \texttt{jobid=}
1391 option. If the keyword {\bf copies} is present on the command line, Bacula will
1392 display the list of all copies for selected jobs.
1397 These JobIds have copies as follows:
1398 +-------+------------------------------------+-----------+------------------+
1399 | JobId | Job | CopyJobId | MediaType |
1400 +-------+------------------------------------+-----------+------------------+
1401 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1402 +-------+------------------------------------+-----------+------------------+
1403 +-------+-------+----------+----------+---------------------+------------------+
1404 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1405 +-------+-------+----------+----------+---------------------+------------------+
1406 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1407 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1408 +-------+-------+----------+----------+---------------------+------------------+
1409 You have selected the following JobIds: 19,2
1411 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1412 5,611 files inserted into the tree.
1417 The Copy Job runs without using the File daemon by copying the data from the
1418 old backup Volume to a different Volume in a different Pool. See the Migration
1419 documentation for additional details. For copy Jobs there is a new selection
1420 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1421 not already copied to another Pool.
1423 As with Migration, the Client, Volume, Job, or SQL query, are
1424 other possible ways of selecting the Jobs to be copied. Selection
1425 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1426 work, but are probably more suited for Migration Jobs.
1428 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1429 it will promote the Copy to a \textsl{real} backup job and will make it available for
1430 automatic restore. If more than one Copy is available, it will promote the copy
1431 with the smallest JobId.
1433 A nice solution which can be built with the new Copy feature is often
1434 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1435 look something like the one below:
1439 Name = FullBackupsVirtualPool
1441 Purge Oldest Volume = Yes
1443 NextPool = FullBackupsTapePool
1447 Name = FullBackupsTapePool
1451 Volume Retention = 365 days
1452 Storage = superloader
1456 # Fake fileset for copy jobs
1468 # Fake client for copy jobs
1478 # Default template for a CopyDiskToTape Job
1481 Name = CopyDiskToTape
1483 Messages = StandardCopy
1486 Selection Type = PoolUncopiedJobs
1487 Maximum Concurrent Jobs = 10
1489 Allow Duplicate Jobs = Yes
1490 Cancel Queued Duplicates = No
1491 Cancel Running Duplicates = No
1496 Name = DaySchedule7:00
1497 Run = Level=Full daily at 7:00
1501 Name = CopyDiskToTapeFullBackups
1503 Schedule = DaySchedule7:00
1504 Pool = FullBackupsVirtualPool
1505 JobDefs = CopyDiskToTape
1509 The example above had 2 pool which are copied using the PoolUncopiedJobs
1510 selection criteria. Normal Full backups go to the Virtual pool and are copied
1511 to the Tape pool the next morning.
1513 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1518 +-------+------------------------------------+-----------+------------------+
1519 | JobId | Job | CopyJobId | MediaType |
1520 +-------+------------------------------------+-----------+------------------+
1521 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1522 +-------+------------------------------------+-----------+------------------+
1525 \section{ACL Updates}
1526 \index[general]{ACL Updates}
1527 The whole ACL code had been overhauled and in this version each platforms has
1528 different streams for each type of acl available on such an platform. As ACLs
1529 between platforms tend to be not that portable (most implement POSIX acls but
1530 some use an other draft or a completely different format) we currently only
1531 allow certain platform specific ACL streams to be decoded and restored on the
1532 same platform that they were created on. The old code allowed to restore ACL
1533 cross platform but the comments already mention that not being to wise. For
1534 backward compatability the new code will accept the two old ACL streams and
1535 handle those with the platform specific handler. But for all new backups it
1536 will save the ACLs using the new streams.
1538 Currently the following platforms support ACLs:
1542 \item {\bf Darwin/OSX}
1551 Currently we support the following ACL types (these ACL streams use a reserved
1552 part of the stream numbers):
1555 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1557 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1558 string representation from acl\_to\_text (POSIX acl)
1559 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1560 string representation from acl\_to\_text (POSIX acl) for default acls.
1561 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1562 string representation from acl\_to\_text (POSIX acl) for access acls.
1563 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1564 string representation from acltostr (POSIX acl)
1565 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1566 representation from acl\_to\_text (POSIX acl) for default acls.
1567 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1568 representation from acl\_to\_text (POSIX acl) for access acls.
1569 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1570 string representation from acl\_to\_text (POSIX acl) for default acls.
1571 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1572 representation from acl\_to\_text (POSIX acl) for access acls.
1573 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1574 string representation from acl\_to\_text (POSIX acl) for default acls.
1575 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1576 string representation from acl\_to\_text (POSIX acl) for default acls.
1577 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1578 representation from acl\_to\_text (POSIX acl) for access acls.
1579 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1580 string representation from acltotext or acl\_totext (POSIX acl)
1581 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1582 representation from from acl\_totext (NFSv4 or ZFS acl)
1585 In future versions we might support conversion functions from one type of acl
1586 into an other for types that are either the same or easily convertable. For now
1587 the streams are seperate and restoring them on a platform that doesn't
1588 recognize them will give you a warning.
1590 \section{Extended Attributes}
1591 \index[general]{Extended Attributes}
1592 Something that was on the project list for some time is now implemented for
1593 platforms that support a similar kind of interface. Its the support for backup
1594 and restore of so called extended attributes. As extended attributes are so
1595 platform specific these attributes are saved in seperate streams for each
1596 platform. Restores of the extended attributes can only be performed on the
1597 same platform the backup was done. There is support for all types of extended
1598 attributes, but restoring from one type of filesystem onto an other type of
1599 filesystem on the same platform may lead to supprises. As extended attributes
1600 can contain any type of data they are stored as a series of so called
1601 value-pairs. This data must be seen as mostly binary and is stored as such.
1602 As security labels from selinux are also extended attributes this option also
1603 stores those labels and no specific code is enabled for handling selinux
1606 Currently the following platforms support extended attributes:
1608 \item {\bf Darwin/OSX}
1614 On linux acls are also extended attributes, as such when you enable ACLs on a
1615 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1616 and not the same exteneded attribute.
1618 To enable the backup of extended attributes please add the following to your
1633 \section{Shared objects}
1634 \index[general]{Shared objects}
1635 A default build of Bacula will now create the libraries as shared objects
1636 (.so) rather than static libraries as was previously the case.
1637 The shared libraries are built using {\bf libtool} so it should be quite
1640 An important advantage of using shared objects is that on a machine with the
1641 Directory, File daemon, the Storage daemon, and a console, you will have only
1642 one copy of the code in memory rather than four copies. Also the total size of
1643 the binary release is smaller since the library code appears only once rather
1644 than once for every program that uses it; this results in significant reduction
1645 in the size of the binaries particularly for the utility tools.
1647 In order for the system loader to find the shared objects when loading the
1648 Bacula binaries, the Bacula shared objects must either be in a shared object
1649 directory known to the loader (typically /usr/lib) or they must be in the
1650 directory that may be specified on the {\bf ./configure} line using the {\bf
1651 {-}{-}libdir} option as:
1654 ./configure --libdir=/full-path/dir
1657 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1658 no need to modify your loader configuration provided that
1659 the shared objects are installed in that directory (Bacula
1660 does this with the make install command). The shared objects
1661 that Bacula references are:
1670 These files are symbolically linked to the real shared object file,
1671 which has a version number to permit running multiple versions of
1672 the libraries if desired (not normally the case).
1674 If you have problems with libtool or you wish to use the old
1675 way of building static libraries, or you want to build a static
1676 version of Bacula you may disable
1677 libtool on the configure command line with:
1680 ./configure --disable-libtool
1684 \section{Building Static versions of Bacula}
1685 \index[general]{Static linking}
1686 In order to build static versions of Bacula, in addition
1687 to configuration options that were needed you now must
1688 also add --disable-libtool. Example
1691 ./configure --enable-static-client-only --disable-libtool
1695 \section{Virtual Backup (Vbackup)}
1696 \index[general]{Virtual Backup}
1697 \index[general]{Vbackup}
1699 Bacula's virtual backup feature is often called Synthetic Backup or
1700 Consolidation in other backup products. It permits you to consolidate the
1701 previous Full backup plus the most recent Differential backup and any
1702 subsequent Incremental backups into a new Full backup. This new Full
1703 backup will then be considered as the most recent Full for any future
1704 Incremental or Differential backups. The VirtualFull backup is
1705 accomplished without contacting the client by reading the previous backup
1706 data and writing it to a volume in a different pool.
1708 In some respects the Vbackup feature works similar to a Migration job, in
1709 that Bacula normally reads the data from the pool specified in the
1710 Job resource, and writes it to the {\bf Next Pool} specified in the
1711 Job resource. Note, this means that usually the output from the Virtual
1712 Backup is written into a different pool from where your prior backups
1713 are saved. Doing it this way guarantees that you will not get a deadlock
1714 situation attempting to read and write to the same volume in the Storage
1715 daemon. If you then want to do subsequent backups, you may need to
1716 move the Virtual Full Volume back to your normal backup pool.
1717 Alternatively, you can set your {\bf Next Pool} to point to the current
1718 pool. This will cause Bacula to read and write to Volumes in the
1719 current pool. In general, this will work, because Bacula will
1720 not allow reading and writing on the same Volume. In any case, once
1721 a VirtualFull has been created, and a restore is done involving the
1722 most current Full, it will read the Volume or Volumes by the VirtualFull
1723 regardless of in which Pool the Volume is found.
1725 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1726 a level of {\bf VirtualFull}.
1728 A typical Job resource definition might look like the following:
1735 FileSet = "Full Set"
1742 # Default pool definition
1746 Recycle = yes # Automatically recycle Volumes
1747 AutoPrune = yes # Prune expired volumes
1748 Volume Retention = 365d # one year
1756 Recycle = yes # Automatically recycle Volumes
1757 AutoPrune = yes # Prune expired volumes
1758 Volume Retention = 365d # one year
1759 Storage = DiskChanger
1762 # Definition of file storage device
1767 Device = FileStorage
1769 Maximum Concurrent Jobs = 5
1772 # Definition of DDS Virtual tape disk storage device
1775 Address = localhost # N.B. Use a fully qualified name here
1777 Device = DiskChanger
1778 Media Type = DiskChangerMedia
1779 Maximum Concurrent Jobs = 4
1784 Then in bconsole or via a Run schedule, you would run the job as:
1787 run job=MyBackup level=Full
1788 run job=MyBackup level=Incremental
1789 run job=MyBackup level=Differential
1790 run job=MyBackup level=Incremental
1791 run job=MyBackup level=Incremental
1794 So providing there were changes between each of those jobs, you would end up
1795 with a Full backup, a Differential, which includes the first Incremental
1796 backup, then two Incremental backups. All the above jobs would be written to
1797 the {\bf Default} pool.
1799 To consolidate those backups into a new Full backup, you would run the
1803 run job=MyBackup level=VirtualFull
1806 And it would produce a new Full backup without using the client, and the output
1807 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1809 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1812 Note, the Start and End time of the Virtual Full backup is set to the
1813 values for the last job included in the Virtual Full (in the above example,
1814 it is an Increment). This is so that if another incremental is done, which
1815 will be based on the Virtual Full, it will backup all files from the
1816 last Job included in the Virtual Full rather than from the time the Virtual
1817 Full was actually run.
1821 \section{Catalog Format}
1822 \index[general]{Catalog Format}
1823 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1824 operation will convert the FileId field of the File table from 32 bits (max 4
1825 billion table entries) to 64 bits (very large number of items). The
1826 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1827 your catalog during the conversion. Also you won't be able to run jobs during
1828 this conversion period. For example, a 3 million file catalog will take 2
1829 minutes to upgrade on a normal machine. Please don't forget to make a valid
1830 backup of your database before executing the upgrade script. See the
1831 ReleaseNotes for additional details.
1833 \section{64 bit Windows Client}
1834 \index[general]{Win64 Client}
1835 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1836 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1837 As a consequence, we are also releasing a 64 bit version of the Bacula
1838 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1839 These binaries should only be installed on 64 bit Windows operating systems.
1840 What is important is not your hardware but whether or not you have
1841 a 64 bit version of the Windows OS.
1843 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1845 \item Before installing the Win64 Bacula Client, you must totally
1846 deinstall any prior 2.4.x Client installation using the
1847 Bacula deinstallation (see the menu item). You may want
1848 to save your .conf files first.
1849 \item Only the Client (File daemon) is ported to Win64, the Director
1850 and the Storage daemon are not in the 64 bit Windows installer.
1851 \item bwx-console is not yet ported.
1852 \item bconsole is ported but it has not been tested.
1853 \item The documentation is not included in the installer.
1854 \item Due to Vista security restrictions imposed on a default installation
1855 of Vista, before upgrading the Client, you must manually stop
1856 any prior version of Bacula from running, otherwise the install
1858 \item Due to Vista security restrictions imposed on a default installation
1859 of Vista, attempting to edit the conf files via the menu items
1860 will fail. You must directly edit the files with appropriate
1861 permissions. Generally double clicking on the appropriate .conf
1862 file will work providing you have sufficient permissions.
1863 \item All Bacula files are now installed in
1864 {\bf C:/Program Files/Bacula} except the main menu items,
1865 which are installed as before. This vastly simplifies the installation.
1866 \item If you are running on a foreign language version of Windows, most
1867 likely {\bf C:/Program Files} does not exist, so you should use the
1868 Custom installation and enter an appropriate location to install
1870 \item The 3.0.0 Win32 Client continues to install files in the locations used
1871 by prior versions. For the next version we will convert it to use
1872 the same installation conventions as the Win64 version.
1875 This project was funded by Bacula Systems.
1878 \section{Duplicate Job Control}
1879 \index[general]{Duplicate Jobs}
1880 The new version of Bacula provides four new directives that
1881 give additional control over what Bacula does if duplicate jobs
1882 are started. A duplicate job in the sense we use it here means
1883 a second or subsequent job with the same name starts. This
1884 happens most frequently when the first job runs longer than expected because no
1885 tapes are available.
1887 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1888 are specified in the Job resource.
1892 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1893 \index[general]{Allow Duplicate Jobs}
1894 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1895 the directive is set to {\bf no} (default) then only one job of a given name
1896 may run at one time, and the action that Bacula takes to ensure only
1897 one job runs is determined by the other directives (see below).
1899 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1900 are present and none of the three directives given below permit
1901 cancelling a job, then the current job (the second one started)
1904 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1905 \index[general]{Allow Higher Duplicates}
1906 This directive was in version 5.0.0, but does not work as
1907 expected. If used, it should always be set to no. In later versions
1908 of Bacula the directive is disabled (disregarded).
1910 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1911 \index[general]{Cancel Running Duplicates}
1912 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1913 if this directive is set to {\bf yes} any job that is already running
1914 will be canceled. The default is {\bf no}.
1916 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1917 \index[general]{Cancel Queued Duplicates}
1918 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1919 if this directive is set to {\bf yes} any job that is
1920 already queued to run but not yet running will be canceled.
1921 The default is {\bf no}.
1924 \section{TLS Authentication}
1925 \index[general]{TLS Authentication}
1926 In Bacula version 2.5.x and later, in addition to the normal Bacula
1927 CRAM-MD5 authentication that is used to authenticate each Bacula
1928 connection, you can specify that you want TLS Authentication as well,
1929 which will provide more secure authentication.
1931 This new feature uses Bacula's existing TLS code (normally used for
1932 communications encryption) to do authentication. To use it, you must
1933 specify all the TLS directives normally used to enable communications
1934 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1937 \subsection{TLS Authenticate = yes}
1939 TLS Authenticate = yes
1942 in the main daemon configuration resource (Director for the Director,
1943 Client for the File daemon, and Storage for the Storage daemon).
1945 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1946 authentication, Bacula will also do TLS authentication, then TLS
1947 encryption will be turned off, and the rest of the communication between
1948 the two Bacula daemons will be done without encryption.
1950 If you want to encrypt communications data, use the normal TLS directives
1951 but do not turn on {\bf TLS Authenticate}.
1953 \section{bextract non-portable Win32 data}
1954 \index[general]{bextract handles Win32 non-portable data}
1955 {\bf bextract} has been enhanced to be able to restore
1956 non-portable Win32 data to any OS. Previous versions were
1957 unable to restore non-portable Win32 data to machines that
1958 did not have the Win32 BackupRead and BackupWrite API calls.
1960 \section{State File updated at Job Termination}
1961 \index[general]{State File}
1962 In previous versions of Bacula, the state file, which provides a
1963 summary of previous jobs run in the {\bf status} command output was
1964 updated only when Bacula terminated, thus if the daemon crashed, the
1965 state file might not contain all the run data. This version of
1966 the Bacula daemons updates the state file on each job termination.
1968 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1969 \index[general]{MaxFullInterval}
1970 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1971 can be used to specify the maximum time interval between {\bf Full} backup
1972 jobs. When a job starts, if the time since the last Full backup is
1973 greater than the specified interval, and the job would normally be an
1974 {\bf Incremental} or {\bf Differential}, it will be automatically
1975 upgraded to a {\bf Full} backup.
1977 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1978 \index[general]{MaxDiffInterval}
1979 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1980 can be used to specify the maximum time interval between {\bf Differential} backup
1981 jobs. When a job starts, if the time since the last Differential backup is
1982 greater than the specified interval, and the job would normally be an
1983 {\bf Incremental}, it will be automatically
1984 upgraded to a {\bf Differential} backup.
1986 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1987 \index[general]{MaxDiffInterval}
1988 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1989 by the user, and when it is set it is an indication to backup programs
1990 to not backup that particular file. This version of Bacula contains a
1991 new Options directive within a FileSet resource, which instructs Bacula to
1992 obey this flag. The new directive is:
1995 Honor No Dump Flag = yes\vb{}no
1998 The default value is {\bf no}.
2001 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
2002 \index[general]{IgnoreDir}
2003 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
2004 can be added to the Include section of the FileSet resource. If the specified
2005 filename ({\bf filename-string}) is found on the Client in any directory to be
2006 backed up, the whole directory will be ignored (not backed up). For example:
2009 # List of files to be backed up
2017 Exclude Dir Containing = .excludeme
2022 But in /home, there may be hundreds of directories of users and some
2023 people want to indicate that they don't want to have certain
2024 directories backed up. For example, with the above FileSet, if
2025 the user or sysadmin creates a file named {\bf .excludeme} in
2026 specific directories, such as
2029 /home/user/www/cache/.excludeme
2030 /home/user/temp/.excludeme
2033 then Bacula will not backup the two directories named:
2036 /home/user/www/cache
2040 NOTE: subdirectories will not be backed up. That is, the directive
2041 applies to the two directories in question and any children (be they
2042 files, directories, etc).
2045 \section{Bacula Plugins}
2046 \index[general]{Plugin}
2047 Support for shared object plugins has been implemented in the Linux, Unix
2048 and Win32 File daemons. The API will be documented separately in
2049 the Developer's Guide or in a new document. For the moment, there is
2050 a single plugin named {\bf bpipe} that allows an external program to
2051 get control to backup and restore a file.
2053 Plugins are also planned (partially implemented) in the Director and the
2056 \subsection{Plugin Directory}
2057 \index[general]{Plugin Directory}
2058 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2059 be added to the daemon definition resource. The directory takes a quoted
2060 string argument, which is the name of the directory in which the daemon can
2061 find the Bacula plugins. If this directive is not specified, Bacula will not
2062 load any plugins. Since each plugin has a distinctive name, all the daemons
2063 can share the same plugin directory.
2065 \subsection{Plugin Options}
2066 \index[general]{Plugin Options}
2067 The {\bf Plugin Options} directive takes a quoted string
2068 arguement (after the equal sign) and may be specified in the
2069 Job resource. The options specified will be passed to all plugins
2070 when they are run. This each plugin must know what it is looking
2071 for. The value defined in the Job resource can be modified
2072 by the user when he runs a Job via the {\bf bconsole} command line
2075 Note: this directive may be specified, and there is code to modify
2076 the string in the run command, but the plugin options are not yet passed to
2077 the plugin (i.e. not fully implemented).
2079 \subsection{Plugin Options ACL}
2080 \index[general]{Plugin Options ACL}
2081 The {\bf Plugin Options ACL} directive may be specified in the
2082 Director's Console resource. It functions as all the other ACL commands
2083 do by permitting users running restricted consoles to specify a
2084 {\bf Plugin Options} that overrides the one specified in the Job
2085 definition. Without this directive restricted consoles may not modify
2088 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2089 \index[general]{Plugin}
2090 The {\bf Plugin} directive is specified in the Include section of
2091 a FileSet resource where you put your {\bf File = xxx} directives.
2102 Plugin = "bpipe:..."
2107 In the above example, when the File daemon is processing the directives
2108 in the Include section, it will first backup all the files in {\bf /home}
2109 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2110 the Plugin Directory. The syntax and semantics of the Plugin directive
2111 require the first part of the string up to the colon (:) to be the name
2112 of the plugin. Everything after the first colon is ignored by the File daemon but
2113 is passed to the plugin. Thus the plugin writer may define the meaning of the
2114 rest of the string as he wishes.
2116 Please see the next section for information about the {\bf bpipe} Bacula
2119 \section{The bpipe Plugin}
2120 \index[general]{The bpipe Plugin}
2121 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2122 the Bacula source distribution. When the plugin is compiled and linking into
2123 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2124 Please note that this is a very simple plugin that was written for
2125 demonstration and test purposes. It is and can be used in production, but
2126 that was never really intended.
2128 The purpose of the plugin is to provide an interface to any system program for
2129 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2130 the Include section of your Job's FileSet resource. The full syntax of the
2131 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2132 to specify the sytax as it wishes) is:
2135 Plugin = "<field1>:<field2>:<field3>:<field4>"
2140 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2141 stripped off, so in this case, we would put {\bf bpipe} in this field.
2143 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2144 pseudo path and filename under which the backup will be saved. This pseudo
2145 path and filename will be seen by the user in the restore file tree.
2146 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2147 backed up by the plugin will be put under that "pseudo" path and filename.
2148 You must be careful to choose a naming convention that is unique to avoid
2149 a conflict with a path and filename that actually exists on your system.
2151 \item {\bf field3} for the {\bf bpipe} plugin
2152 specifies the "reader" program that is called by the plugin during
2153 backup to read the data. {\bf bpipe} will call this program by doing a
2156 \item {\bf field4} for the {\bf bpipe} plugin
2157 specifies the "writer" program that is called by the plugin during
2158 restore to write the data back to the filesystem.
2161 Please note that for two items above describing the "reader" and "writer"
2162 fields, these programs are "executed" by Bacula, which
2163 means there is no shell interpretation of any command line arguments
2164 you might use. If you want to use shell characters (redirection of input
2165 or output, ...), then we recommend that you put your command or commands
2166 in a shell script and execute the script. In addition if you backup a
2167 file with the reader program, when running the writer program during
2168 the restore, Bacula will not automatically create the path to the file.
2169 Either the path must exist, or you must explicitly do so with your command
2170 or in a shell script.
2172 Putting it all together, the full plugin directive line might look
2176 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2177 --opt --databases bacula:mysql"
2180 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2181 would be written on a single line.
2183 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2184 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2185 program {\bf mysqldump -f --opt --database bacula} to read the data during
2186 backup. The mysqldump command outputs all the data for the database named
2187 {\bf bacula}, which will be read by the plugin and stored in the backup.
2188 During restore, the data that was backed up will be sent to the program
2189 specified in the last field, which in this case is {\bf mysql}. When
2190 {\bf mysql} is called, it will read the data sent to it by the plugn
2191 then write it back to the same database from which it came ({\bf bacula}
2194 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2195 the data from a specified program to Bacula for backup, and then from Bacula to
2196 a specified program for restore.
2198 By using different command lines to {\bf bpipe},
2199 you can backup any kind of data (ASCII or binary) depending
2200 on the program called.
2202 \section{Microsoft Exchange Server 2003/2007 Plugin}
2203 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2204 \subsection{Background}
2205 The Exchange plugin was made possible by a funded development project
2206 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2207 The code for the plugin was written by James Harper, and the Bacula core
2208 code by Kern Sibbald. All the code for this funded development has become
2209 part of the Bacula project. Thanks to everyone who made it happen.
2211 \subsection{Concepts}
2212 Although it is possible to backup Exchange using Bacula VSS the Exchange
2213 plugin adds a good deal of functionality, because while Bacula VSS
2214 completes a full backup (snapshot) of Exchange, it does
2215 not support Incremental or Differential backups, restoring is more
2216 complicated, and a single database restore is not possible.
2218 Microsoft Exchange organises its storage into Storage Groups with
2219 Databases inside them. A default installation of Exchange will have a
2220 single Storage Group called 'First Storage Group', with two Databases
2221 inside it, "Mailbox Store (SERVER NAME)" and
2222 "Public Folder Store (SERVER NAME)",
2223 which hold user email and public folders respectively.
2225 In the default configuration, Exchange logs everything that happens to
2226 log files, such that if you have a backup, and all the log files since,
2227 you can restore to the present time. Each Storage Group has its own set
2228 of log files and operates independently of any other Storage Groups. At
2229 the Storage Group level, the logging can be turned off by enabling a
2230 function called "Enable circular logging". At this time the Exchange
2231 plugin will not function if this option is enabled.
2233 The plugin allows backing up of entire storage groups, and the restoring
2234 of entire storage groups or individual databases. Backing up and
2235 restoring at the individual mailbox or email item is not supported but
2236 can be simulated by use of the "Recovery" Storage Group (see below).
2238 \subsection{Installing}
2239 The Exchange plugin requires a DLL that is shipped with Microsoft
2240 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2241 correctly the Exchange plugin should find this automatically and run
2242 without any additional installation.
2244 If the DLL can not be found automatically it will need to be copied into
2245 the Bacula installation
2246 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2247 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2248 default Exchange installation.
2250 \subsection{Backing Up}
2251 To back up an Exchange server the Fileset definition must contain at
2252 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2253 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2254 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2255 up files are prefixed with something that isn't going to share a name
2256 with something outside the plugin, and the 'Microsoft Information Store'
2257 bit is required also. It is also possible to add the name of a storage
2258 group to the "Plugin =" line, eg \\
2259 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2260 if you want only a single storage group backed up.
2262 Additionally, you can suffix the 'Plugin =' directive with
2263 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2264 database at the end of a full backup.
2266 An Incremental or Differential backup will backup only the database logs
2267 for each Storage Group by inspecting the "modified date" on each
2268 physical log file. Because of the way the Exchange API works, the last
2269 logfile backed up on each backup will always be backed up by the next
2270 Incremental or Differential backup too. This adds 5MB to each
2271 Incremental or Differential backup size but otherwise does not cause any
2274 By default, a normal VSS fileset containing all the drive letters will
2275 also back up the Exchange databases using VSS. This will interfere with
2276 the plugin and Exchange's shared ideas of when the last full backup was
2277 done, and may also truncate log files incorrectly. It is important,
2278 therefore, that the Exchange database files be excluded from the backup,
2279 although the folders the files are in should be included, or they will
2280 have to be recreated manually if a baremetal restore is done.
2285 File = C:/Program Files/Exchsrvr/mdbdata
2286 Plugin = "exchange:..."
2289 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2290 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2291 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2292 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2293 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2294 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2295 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2300 The advantage of excluding the above files is that you can significantly
2301 reduce the size of your backup since all the important Exchange files
2302 will be properly saved by the Plugin.
2305 \subsection{Restoring}
2306 The restore operation is much the same as a normal Bacula restore, with
2307 the following provisos:
2310 \item The {\bf Where} restore option must not be specified
2311 \item Each Database directory must be marked as a whole. You cannot just
2312 select (say) the .edb file and not the others.
2313 \item If a Storage Group is restored, the directory of the Storage Group
2315 \item It is possible to restore only a subset of the available log files,
2316 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2317 if a log file is missing from the sequence of log files
2318 \item Each database to be restored must be dismounted and marked as "Can be
2319 overwritten by restore"
2320 \item If an entire Storage Group is to be restored (eg all databases and
2321 logs in the Storage Group), then it is best to manually delete the
2322 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2323 as Exchange can get confused by stray log files lying around.
2326 \subsection{Restoring to the Recovery Storage Group}
2327 The concept of the Recovery Storage Group is well documented by
2329 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2330 but to briefly summarize...
2332 Microsoft Exchange allows the creation of an additional Storage Group
2333 called the Recovery Storage Group, which is used to restore an older
2334 copy of a database (e.g. before a mailbox was deleted) into without
2335 messing with the current live data. This is required as the Standard and
2336 Small Business Server versions of Exchange can not ordinarily have more
2337 than one Storage Group.
2339 To create the Recovery Storage Group, drill down to the Server in Exchange
2340 System Manager, right click, and select
2341 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2342 locations and click OK. On the Recovery Storage Group, right click and
2343 select {\bf "Add Database to Recover..."} and select the database you will
2346 Restore only the single database nominated as the database in the
2347 Recovery Storage Group. Exchange will redirect the restore to the
2348 Recovery Storage Group automatically.
2349 Then run the restore.
2351 \subsection{Restoring on Microsoft Server 2007}
2352 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2353 2007, and henc you use a new proceedure for recovering a single mail box.
2354 This procedure is ducomented by Microsoft at:
2355 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2356 and involves using the {\bf Restore-Mailbox} and {\bf
2357 Get-MailboxStatistics} shell commands.
2359 \subsection{Caveats}
2360 This plugin is still being developed, so you should consider it
2361 currently in BETA test, and thus use in a production environment
2362 should be done only after very careful testing.
2364 When doing a full backup, the Exchange database logs are truncated by
2365 Exchange as soon as the plugin has completed the backup. If the data
2366 never makes it to the backup medium (eg because of spooling) then the
2367 logs will still be truncated, but they will also not have been backed
2368 up. A solution to this is being worked on. You will have to schedule a
2369 new Full backup to ensure that your next backups will be usable.
2371 The "Enable Circular Logging" option cannot be enabled or the plugin
2374 Exchange insists that a successful Full backup must have taken place if
2375 an Incremental or Differential backup is desired, and the plugin will
2376 fail if this is not the case. If a restore is done, Exchange will
2377 require that a Full backup be done before an Incremental or Differential
2380 The plugin will most likely not work well if another backup application
2381 (eg NTBACKUP) is backing up the Exchange database, especially if the
2382 other backup application is truncating the log files.
2384 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2385 we recommend either carefully testing or that you avoid this option for
2388 The Exchange plugin is not called during processing the bconsole {\bf
2389 estimate} command, and so anything that would be backed up by the plugin
2390 will not be added to the estimate total that is displayed.
2393 \section{libdbi Framework}
2394 \index[general]{libdbi Framework}
2395 As a general guideline, Bacula has support for a few catalog database drivers
2396 (MySQL, PostgreSQL, SQLite)
2397 coded natively by the Bacula team. With the libdbi implementation, which is a
2398 Bacula driver that uses libdbi to access the catalog, we have an open field to
2399 use many different kinds database engines following the needs of users.
2401 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2402 implements a database-independent abstraction layer in C, similar to the
2403 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2404 leverage the power of multiple databases and multiple simultaneous database
2405 connections by using this framework.
2407 Currently the libdbi driver in Bacula project only supports the same drivers
2408 natively coded in Bacula. However the libdbi project has support for many
2409 others database engines. You can view the list at
2410 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2411 supported by Bacula, however, they must be tested properly by the Bacula team.
2413 Some of benefits of using libdbi are:
2415 \item The possibility to use proprietary databases engines in which your
2416 proprietary licenses prevent the Bacula team from developing the driver.
2417 \item The possibility to use the drivers written for the libdbi project.
2418 \item The possibility to use other database engines without recompiling Bacula
2419 to use them. Just change one line in bacula-dir.conf
2420 \item Abstract Database access, this is, unique point to code and profiling
2421 catalog database access.
2424 The following drivers have been tested:
2426 \item PostgreSQL, with and without batch insert
2427 \item Mysql, with and without batch insert
2432 In the future, we will test and approve to use others databases engines
2433 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2435 To compile Bacula to support libdbi we need to configure the code with the
2436 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2437 [database] is the database engine to be used with Bacula (of course we can
2438 change the driver in file bacula-dir.conf, see below). We must configure the
2439 access port of the database engine with the option --with-db-port, because the
2440 libdbi framework doesn't know the default access port of each database.
2442 The next phase is checking (or configuring) the bacula-dir.conf, example:
2446 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2447 dbname = regress; user = regress; password = ""
2451 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2452 mysql database. Currently the drivers supported by Bacula are: postgresql,
2453 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2455 The following limitations apply when Bacula is set to use the libdbi framework:
2456 - Not tested on the Win32 platform
2457 - A little performance is lost if comparing with native database driver.
2458 The reason is bound with the database driver provided by libdbi and the
2459 simple fact that one more layer of code was added.
2461 It is important to remember, when compiling Bacula with libdbi, the
2462 following packages are needed:
2464 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2465 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2468 You can download them and compile them on your system or install the packages
2469 from your OS distribution.
2471 \section{Console Command Additions and Enhancements}
2472 \index[general]{Console Additions}
2474 \subsection{Display Autochanger Content}
2475 \index[general]{StatusSlots}
2477 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2478 autochanger content.
2482 Slot | Volume Name | Status | Media Type | Pool |
2483 ------+---------------+----------+-------------------+------------|
2484 1 | 00001 | Append | DiskChangerMedia | Default |
2485 2 | 00002 | Append | DiskChangerMedia | Default |
2486 3*| 00003 | Append | DiskChangerMedia | Scratch |
2491 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2492 {\bf update slots} command to synchronize autochanger content with your
2495 \subsection{list joblog job=xxx or jobid=nnn}
2496 \index[general]{list joblog}
2497 A new list command has been added that allows you to list the contents
2498 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2499 or for a particular JobId. The {\bf llist} command will include a line with
2500 the time and date of the entry.
2502 Note for the catalog to have Job Log entries, you must have a directive
2509 In your Director's {\bf Messages} resource.
2511 \subsection{Use separator for multiple commands}
2512 \index[general]{Command Separator}
2513 When using bconsole with readline, you can set the command separator with
2514 \textbf{@separator} command to one
2515 of those characters to write commands who require multiple input in one line.
2517 !$%&'()*+,-/:;<>?[]^`{|}~
2520 \subsection{Deleting Volumes}
2521 The delete volume bconsole command has been modified to
2522 require an asterisk (*) in front of a MediaId otherwise the
2523 value you enter is a taken to be a Volume name. This is so that
2524 users may delete numeric Volume names. The previous Bacula versions
2525 assumed that all input that started with a number was a MediaId.
2527 This new behavior is indicated in the prompt if you read it
2530 \section{Bare Metal Recovery}
2531 The old bare metal recovery project is essentially dead. One
2532 of the main features of it was that it would build a recovery
2533 CD based on the kernel on your system. The problem was that
2534 every distribution has a different boot procedure and different
2535 scripts, and worse yet, the boot procedures and scripts change
2536 from one distribution to another. This meant that maintaining
2537 (keeping up with the changes) the rescue CD was too much work.
2539 To replace it, a new bare metal recovery USB boot stick has been developed
2540 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2541 boot from a USB key.
2545 \item Recovery can be done from within graphical environment.
2546 \item Recovery can be done in a shell.
2547 \item Ubuntu boots on a large number of Linux systems.
2548 \item The process of updating the system and adding new
2549 packages is not too difficult.
2550 \item The USB key can easily be upgraded to newer Ubuntu versions.
2551 \item The USB key has writable partitions for modifications to
2552 the OS and for modification to your home directory.
2553 \item You can add new files/directories to the USB key very easily.
2554 \item You can save the environment from multiple machines on
2556 \item Bacula Systems is funding its ongoing development.
2559 The disadvantages are:
2561 \item The USB key is usable but currently under development.
2562 \item Not everyone may be familiar with Ubuntu (no worse
2564 \item Some older OSes cannot be booted from USB. This can
2565 be resolved by first booting a Ubuntu LiveCD then plugging
2567 \item Currently the documentation is sketchy and not yet added
2568 to the main manual. See below ...
2571 The documentation and the code can be found in the {\bf rescue} package
2572 in the directory {\bf linux/usb}.
2574 \section{Miscellaneous}
2575 \index[general]{Misc New Features}
2577 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2578 \index[general]{Allow Mixed Priority}
2579 This directive is only implemented in version 2.5 and later. When
2580 set to {\bf yes} (default {\bf no}), this job may run even if lower
2581 priority jobs are already running. This means a high priority job
2582 will not have to wait for other jobs to finish before starting.
2583 The scheduler will only mix priorities when all running jobs have
2586 Note that only higher priority jobs will start early. Suppose the
2587 director will allow two concurrent jobs, and that two jobs with
2588 priority 10 are running, with two more in the queue. If a job with
2589 priority 5 is added to the queue, it will be run as soon as one of
2590 the running jobs finishes. However, new priority 10 jobs will not
2591 be run until the priority 5 job has finished.
2593 \subsection{Bootstrap File Directive -- FileRegex}
2594 \index[general]{Bootstrap File Directive}
2595 {\bf FileRegex} is a new command that can be added to the bootstrap
2596 (.bsr) file. The value is a regular expression. When specified, only
2597 matching filenames will be restored.
2599 During a restore, if all File records are pruned from the catalog
2600 for a Job, normally Bacula can restore only all files saved. That
2601 is there is no way using the catalog to select individual files.
2602 With this new feature, Bacula will ask if you want to specify a Regex
2603 expression for extracting only a part of the full backup.
2606 Building directory tree for JobId(s) 1,3 ...
2607 There were no files inserted into the tree, so file selection
2608 is not possible.Most likely your retention policy pruned the files
2610 Do you want to restore all the files? (yes\vb{}no): no
2612 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2613 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2616 \subsection{Bootstrap File Optimization Changes}
2617 In order to permit proper seeking on disk files, we have extended the bootstrap
2618 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2619 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2620 address range and end address range respectively. These two directives replace
2621 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2622 VolEndBlock} directives. Bootstrap files containing the old directives will
2623 still work, but will not properly take advantage of proper disk seeking, and
2624 may read completely to the end of a disk volume during a restore. With the new
2625 format (automatically generated by the new Director), restores will seek
2626 properly and stop reading the volume when all the files have been restored.
2628 \subsection{Solaris ZFS/NFSv4 ACLs}
2629 This is an upgrade of the previous Solaris ACL backup code
2630 to the new library format, which will backup both the old
2631 POSIX(UFS) ACLs as well as the ZFS ACLs.
2633 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2634 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2635 be used to transfer from UFS to ZFS filesystems.
2638 \subsection{Virtual Tape Emulation}
2639 \index[general]{Virtual Tape Emulation}
2640 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2641 the tape code but actually reading and writing to a disk file. Used with the
2642 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2643 and 700 slots. This feature is most useful in testing. It is enabled
2644 by using {\bf Device Type = vtape} in the Storage daemon's Device
2645 directive. This feature is only implemented on Linux machines and should not be
2646 used for production.
2648 \subsection{Bat Enhancements}
2649 \index[general]{Bat Enhancements}
2650 Bat (the Bacula Administration Tool) GUI program has been significantly
2651 enhanced and stabilized. In particular, there are new table based status
2652 commands; it can now be easily localized using Qt4 Linguist.
2654 The Bat communications protocol has been significantly enhanced to improve
2655 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2656 the Director you are using otherwise the communications protocol will not
2659 \subsection{RunScript Enhancements}
2660 \index[general]{RunScript Enhancements}
2661 The {\bf RunScript} resource has been enhanced to permit multiple
2662 commands per RunScript. Simply specify multiple {\bf Command} directives
2669 Command = "/bin/echo test"
2670 Command = "/bin/echo an other test"
2671 Command = "/bin/echo 3 commands in the same runscript"
2678 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2679 implemented, which runs the command after the Volume Shadow Copy has been made.
2681 Console commands can be specified within a RunScript by using:
2682 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2683 carefully tested and debugged and is known to easily crash the Director.
2684 We would appreciate feedback. Due to the recursive nature of this command, we
2685 may remove it before the final release.
2687 \subsection{Status Enhancements}
2688 \index[general]{Status Enhancements}
2689 The bconsole {\bf status dir} output has been enhanced to indicate
2690 Storage daemon job spooling and despooling activity.
2692 \subsection{Connect Timeout}
2693 \index[general]{Connect Timeout}
2694 The default connect timeout to the File
2695 daemon has been set to 3 minutes. Previously it was 30 minutes.
2697 \subsection{ftruncate for NFS Volumes}
2698 \index[general]{ftruncate for NFS Volumes}
2699 If you write to a Volume mounted by NFS (say on a local file server),
2700 in previous Bacula versions, when the Volume was recycled, it was not
2701 properly truncated because NFS does not implement ftruncate (file
2702 truncate). This is now corrected in the new version because we have
2703 written code (actually a kind user) that deletes and recreates the Volume,
2704 thus accomplishing the same thing as a truncate.
2706 \subsection{Support for Ubuntu}
2707 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2708 version of Linux, and thus now provides correct autostart routines.
2709 Since Ubuntu officially supports Bacula, you can also obtain any
2710 recent release of Bacula from the Ubuntu repositories.
2712 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2713 \index[general]{Recycle Pool}
2714 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2715 be placed (moved) when it is recycled. Without this directive, a Volume will
2716 remain in the same pool when it is recycled. With this directive, it can be
2717 moved automatically to any existing pool during a recycle. This directive is
2718 probably most useful when defined in the Scratch pool, so that volumes will
2719 be recycled back into the Scratch pool.
2721 \subsection{FD Version}
2722 \index[general]{FD Version}
2723 The File daemon to Director protocol now includes a version
2724 number, which although there is no visible change for users,
2725 will help us in future versions automatically determine
2726 if a File daemon is not compatible.
2728 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2729 \index[general]{Max Run Sched Time}
2730 The time specifies the maximum allowed time that a job may run, counted from
2731 when the job was scheduled. This can be useful to prevent jobs from running
2732 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2735 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2736 \index[general]{Max Wait Time}
2737 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2738 of checking the maximum allowed time that a job may block for a resource,
2739 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2740 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2741 their job depending on the level. Now, they have to use
2742 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2743 directives are now deprecated.
2745 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2746 \index[general]{Incremental Max Wait Time}
2747 \index[general]{Differential Max Wait Time}
2749 These directives have been deprecated in favor of
2750 \texttt{Incremental|Differential Max Run Time}.
2752 \subsection{Max Run Time directives}
2753 \index[general]{Max Run Time directives}
2754 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2755 maximum allowed time that a job can run depending on the level.
2757 \addcontentsline{lof}{figure}{Job time control directives}
2758 \includegraphics{\idir different_time.eps}
2760 \subsection{Statistics Enhancements}
2761 \index[general]{Statistics Enhancements}
2762 If you (or probably your boss) want to have statistics on your backups to
2763 provide some \textit{Service Level Agreement} indicators, you could use a few
2764 SQL queries on the Job table to report how many:
2768 \item jobs have been successful
2769 \item files have been backed up
2773 However, these statistics are accurate only if your job retention is greater
2774 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2775 be able to use them.
2777 Now, you can use the \textbf{update stats [days=num]} console command to fill
2778 the JobHistory table with new Job records. If you want to be sure to take in
2779 account only \textbf{good jobs}, ie if one of your important job has failed but
2780 you have fixed the problem and restarted it on time, you probably want to
2781 delete the first \textit{bad} job record and keep only the successful one. For
2782 that simply let your staff do the job, and update JobHistory table after two or
2783 three days depending on your organization using the \textbf{[days=num]} option.
2785 These statistics records aren't used for restoring, but mainly for
2786 capacity planning, billings, etc.
2788 The Bweb interface provides a statistics module that can use this feature. You
2789 can also use tools like Talend or extract information by yourself.
2791 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2792 the length of time that Bacula will keep statistics job records in the Catalog
2793 database after the Job End time. (In \texttt{JobHistory} table) When this time
2794 period expires, and if user runs \texttt{prune stats} command, Bacula will
2795 prune (remove) Job records that are older than the specified period.
2797 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2798 job to maintain statistics.
2801 Name = BackupCatalog
2804 Console = "update stats days=3"
2805 Console = "prune stats yes"
2812 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2813 \index[general]{ScratchPool}
2814 This directive permits to specify a specific \textsl{Scratch} pool for the
2815 current pool. This is useful when using multiple storage sharing the same
2816 mediatype or when you want to dedicate volumes to a particular set of pool.
2818 \subsection{Enhanced Attribute Despooling}
2819 \index[general]{Attribute Despooling}
2820 If the storage daemon and the Director are on the same machine, the spool file
2821 that contains attributes is read directly by the Director instead of being
2822 transmitted across the network. That should reduce load and speedup insertion.
2824 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2825 \index[general]{SpoolSize}
2826 A new Job directive permits to specify the spool size per job. This is used
2827 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2829 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2830 \index[general]{MaximumConsoleConnections}
2831 A new director directive permits to specify the maximum number of Console
2832 Connections that could run concurrently. The default is set to 20, but you may
2833 set it to a larger number.
2835 \subsection{VerId = \lt{}string\gt{}}
2836 \index[general]{VerId}
2837 A new director directive permits to specify a personnal identifier that will be
2838 displayed in the \texttt{version} command.
2840 \subsection{dbcheck enhancements}
2841 \index[general]{dbcheck enhancements}
2842 If you are using Mysql, dbcheck will now ask you if you want to create
2843 temporary indexes to speed up orphaned Path and Filename elimination.
2845 A new \texttt{-B} option allows you to print catalog information in a simple
2846 text based format. This is useful to backup it in a secure way.
2861 You can now specify the database connection port in the command line.
2863 \subsection{{-}{-}docdir configure option}
2864 \index[general]{{-}{-}docdir configure option}
2865 You can use {-}{-}docdir= on the ./configure command to
2866 specify the directory where you want Bacula to install the
2867 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2868 {\bf /usr/share/doc/bacula}.
2870 \subsection{{-}{-}htmldir configure option}
2871 \index[general]{{-}{-}htmldir configure option}
2872 You can use {-}{-}htmldir= on the ./configure command to
2873 specify the directory where you want Bacula to install the bat html help
2874 files. The default is {\bf /usr/share/doc/bacula/html}
2876 \subsection{{-}{-}with-plugindir configure option}
2877 \index[general]{{-}{-}plugindir configure option}
2878 You can use {-}{-}plugindir= on the ./configure command to
2879 specify the directory where you want Bacula to install
2880 the plugins (currently only bpipe-fd). The default is