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 2010.
6 \section{Purge Migration Job when Completed}
8 A new directive may be added to the Migration Job definition in the Director
9 configuration file to purge the job migrated at the end of a migration.
23 Selection Pattern = ".*Save"
25 Purge Migrated Job = yes
31 This project was submited by Dunlap Blake, testing and documentation was funded
34 \section{Job Bandwidth Limitation}
36 A new directive may be added to FileDaemon or Director to allow users to limit
37 the bandwidth used by a Job on a Client. It can be set for all Jobs globally,
38 per Directors in the File Daemon configuration, or per Job in the Director
45 Working Directory = /some/path
46 Pid Directory = /some/path
48 Maximum Bandwidth = 5MB/s
52 The above example would cause any jobs running with the FileDaemon to not
53 exceed 5MB/s of throughput when sending data to the Storage Daemon.
55 You can specify the speed parameter in k/s, kb/s, m/s, mb/s.
61 FileSet = FS_localhost
64 Maximum Bandwidth = 5MB/s
69 The above example would cause job \texttt{localhost-data} to not exceed 5MB/s
70 of throughput when sending data to the Storage Daemon.
72 A new console commande \texttt{setbandwidth} permits to set dynamically the
73 maximum throughput of a running Job or for future jobs of a Client.
76 * setbandwidth limit=1000000 jobid=10
79 The \texttt{limit} parameter is in kb/s.
82 This project was funded by Bacula Systems and is available with Bacula
83 Enterprise Edition and Community Edition.
85 \section{Support for MSSQL Block Level Backup}
87 This project was funded by Bacula Systems and is available with Bacula
90 \section{Support for NDMP protocol}
92 The new \texttt{ndmp} Plugin is able to backup a NAS through NDMP protocol
93 using \textbf{Filer to server} approach, where the Filer is backing up across
94 the LAN to your Bacula server.
96 Accurate option should be turned on in the Job resource.
108 Plugin = "ndmp:host=nasbox user=root pass=root file=/vol/vol1"
113 This project was funded by Bacula Systems and is available with Bacula Enterprise
116 \section{Incremental/Differential Block Level Difference Backup}
118 The new \texttt{delta} Plugin is able to compute and apply signature-based file
119 differences. It can be used to backup only changes in a big binary file like Outlook
120 PST, VirtualBox/VmWare images or database files.
122 It supports both Incremental and Differential backups and stores signatures
123 database in the File Daemon working directory. This plugin is available on all
124 plateform including Windows 32 and 64bit.
126 Accurate option should be turned on in the Job resource.
138 Plugin = "delta:/home/eric/.VirtualBox/HardDisks/lenny-i386.vdi"
143 This project was funded by Bacula Systems and is available with Bacula Enterprise
146 \section{Include All Windows Drives in FileSet}
148 The \texttt{alldrives} Windows Plugin allows you to include all local drives with
149 a simple directive. This plugin is available for Windows 64 and 32 bit.
161 This project was funded by Bacula Systems and is available with Bacula
164 \section{Changes in Bvfs (Bacula Virtual FileSystem)}
166 Bat has now a bRestore panel that uses Bvfs to display files and
167 directories. It's still experimental.
169 \texttt{Important}, the Bvfs module is not currently compatible with BaseJobs,
170 Copy and Migration jobs.
173 This project was funded by Bacula Systems.
175 \subsection*{General notes}
178 \item All fields are separated by a tab
179 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
180 records in very big directories
181 \item All operations (except cache creation) are designed to run instantly
182 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
183 can contribute new faster SQL queries we will be happy, else don't complain
185 \item The cache creation is dependent of the number of directories. As Bvfs
186 shares information accross jobs, the first creation can be slow
187 \item All fields are separated by a tab
188 \item Due to potential encoding problem, it's advised to allways use pathid in
192 \subsection*{Get dependent jobs from a given JobId}
194 Bvfs allows you to query the catalog against any combination of jobs. You
195 can combine all Jobs and all FileSet for a Client in a single session.
197 To get all JobId needed to restore a particular job, you can use the
198 \texttt{.bvfs\_get\_jobids} command.
201 .bvfs_get_jobids jobid=num [all]
205 .bvfs_get_jobids jobid=10
207 .bvfs_get_jobids jobid=10 all
211 In this example, a normal restore will need to use JobIds 1,2,5,10 to
212 compute a complete restore of the system.
214 With the \texttt{all} option, the Director will use all defined FileSet for
217 \subsection*{Generating Bvfs cache}
219 The \texttt{.bvfs\_update} command computes the directory cache for jobs
220 specified in argument, or for all jobs if unspecified.
223 .bvfs_update [jobid=numlist]
228 .bvfs_update jobid=1,2,3
231 You can run the cache update process in a RunScript after the catalog backup.
233 \subsection*{Get all versions of a specific file}
235 Bvfs allows you to find all versions of a specific file for a given Client with
236 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this function
237 uses only PathId and FilenameId. The jobid argument is mandatory but unused.
240 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
241 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
242 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
249 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
250 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
253 \subsection*{List directories}
255 Bvfs allows you to list directories in a specific path.
257 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
258 PathId FilenameId FileId JobId LStat Path
259 PathId FilenameId FileId JobId LStat Path
260 PathId FilenameId FileId JobId LStat Path
264 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
265 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
266 listed is a directory.
269 .bvfs_lsdirs pathid=4 jobid=1,11,12
270 4 0 0 0 A A A A A A A A A A A A A A .
271 5 0 0 0 A A A A A A A A A A A A A A ..
272 3 0 0 0 A A A A A A A A A A A A A A regress/
275 In this example, to list directories present in \texttt{regress/}, you can use
277 .bvfs_lsdirs pathid=3 jobid=1,11,12
278 3 0 0 0 A A A A A A A A A A A A A A .
279 4 0 0 0 A A A A A A A A A A A A A A ..
280 2 0 0 0 A A A A A A A A A A A A A A tmp/
283 \subsection*{List files}
285 Bvfs allows you to list files in a specific path.
287 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
288 PathId FilenameId FileId JobId LStat Path
289 PathId FilenameId FileId JobId LStat Path
290 PathId FilenameId FileId JobId LStat Path
294 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
295 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
299 .bvfs_lsfiles pathid=4 jobid=1,11,12
300 4 0 0 0 A A A A A A A A A A A A A A .
301 5 0 0 0 A A A A A A A A A A A A A A ..
302 1 0 0 0 A A A A A A A A A A A A A A regress/
305 In this example, to list files present in \texttt{regress/}, you can use
307 .bvfs_lsfiles pathid=1 jobid=1,11,12
308 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
309 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
310 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
311 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
312 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
315 \subsection*{Restore set of files}
317 Bvfs allows you to create a SQL table that contains files that you want to
318 restore. This table can be provided to a restore command with the file option.
321 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
323 restore file=?b2num ...
326 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
327 select all files. This query could be time consuming.
329 \texttt{hardlink} list is always composed of a serie of two numbers (jobid,
330 fileindex). This information can be found in the LinkFI field of the LStat
333 The \texttt{path} argument represents the name of the table that Bvfs will
334 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
335 b2 and followed by digits).
340 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
344 \subsection*{Cleanup after restore}
346 To drop the table used by the restore command, you can use the
347 \texttt{.bvfs\_cleanup} command.
350 .bvfs_cleanup path=b20001
353 \section{Changes in the pruning algorithm}
355 We rewrote the job pruning algorithm in this version. Previously, in some users
356 reported that the pruning process at the end of jobs was very long. It should
357 not be longer the case. Now, Bacula won't prune automatically a Job if this
358 particular Job is needed to restore data. Example:
362 JobId: 2 Level: Incremental
363 JobId: 3 Level: Incremental
364 JobId: 4 Level: Differential
365 .. Other incrementals up to now
368 In this example, if the Job Retention defined in the Pool or in the Client
369 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
370 detect that JobId 1 and 4 are essential to restore data at the current state
371 and will prune only JobId 2 and 3.
373 \texttt{Important}, this change affect only the automatic pruning step after a
374 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
375 \texttt{VolumeRetention} period, important jobs can be pruned.
377 \section{Ability to Verify any specified Job}
378 You now have the ability to tell Bacula which Job should verify instead of
379 automatically verify just the last one.
381 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
383 To verify a given job, just specify the Job jobid in argument when starting the
386 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
388 JobName: VerifyVolume
389 Level: VolumeToCatalog
392 Pool: Default (From Job resource)
393 Storage: File (From Job resource)
394 Verify Job: VerifyVol.2010-09-08_14.17.17_03
395 Verify List: /tmp/regress/working/VerifyVol.bsr
396 When: 2010-09-08 14:17:31
398 OK to run? (yes/mod/no):
402 This project was funded by Bacula Systems and is available with Bacula
403 Enterprise Edition and Community Edition.
405 \section{Additions to RunScript variables}
406 You can have access to JobBytes and JobFiles using %b and %f in your runscript
410 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%f"
413 %\section{Changes in drivetype.exe}
415 %Now the \texttt{drivetype.exe} program allows you to list all local hard
416 %drives. It can help to build dynamic FileSet on Windows.
419 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
423 \section{Additions to the Plugin API}
424 The bfuncs structure has been extended to include a number of
428 The bFuncs structure defines the callback entry points within Bacula
429 that the plugin can use register events, get Bacula values, set
430 Bacula values, and send messages to the Job output or debug output.
432 The exact definition as of this writing is:
434 typedef struct s_baculaFuncs {
437 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
438 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
439 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
440 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
441 int type, utime_t mtime, const char *fmt, ...);
442 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
443 int level, const char *fmt, ...);
444 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
446 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
448 /* New functions follow */
449 bRC (*AddExclude)(bpContext *ctx, const char *file);
450 bRC (*AddInclude)(bpContext *ctx, const char *file);
451 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
452 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
453 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
454 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
460 \item [AddExclude] can be called to exclude a file. The file
461 string passed may include wildcards that will be interpreted by
462 the {\bf fnmatch} subroutine. This function can be called
463 multiple times, and each time the file specified will be added
464 to the list of files to be excluded. Note, this function only
465 permits adding excludes of specific file or directory names,
466 or files matched by the rather simple fnmatch mechanism.
467 See below for information on doing wild-card and regex excludes.
469 \item [NewInclude] can be called to create a new Include block. This
470 block will be added before any user defined Include blocks. This
471 function can be called multiple times, but each time, it will create
472 a new Include section (not normally needed). This function should
473 be called only if you want to add an entirely new Include block.
475 \item [AddInclude] can be called to add new files/directories to
476 be included. They are added to the current Include block. If
477 NewInclude has not been included, the current Include block is
478 the last one that the user created. This function
479 should be used only if you want to add totally new files/directories
480 to be included in the backup.
482 \item [NewOptions] adds a new Options block to the current Include
483 in front of any other Options blocks. This permits the plugin to
484 add exclude directives (wild-cards and regexes) in front of the
485 user Options, and thus prevent certain files from being backed up.
486 This can be useful if the plugin backs up files, and they should
487 not be also backed up by the main Bacula code. This function
488 may be called multiple times, and each time, it creates a new
489 prepended Options block. Note: normally you want to call this
490 entry point prior to calling AddOptions, AddRegex, or AddWild.
492 \item [AddOptions] allows the plugin it set options in
493 the current Options block, which is normally created with the
494 NewOptions call just prior to adding Include Options.
495 The permitted options are passed as a character string, where
496 each character has a specific meaning as defined below:
499 \item [a] always replace files (default).
500 \item [e] exclude rather than include.
501 \item [h] no recursion into subdirectories.
502 \item [H] do not handle hard links.
503 \item [i] ignore case in wildcard and regex matches.
504 \item [M] compute an MD5 sum.
505 \item [p] use a portable data format on Windows (not recommended).
506 \item [R] backup resource forks and Findr Info.
507 \item [r] read from a fifo
508 \item [S1] compute an SHA1 sum.
509 \item [S2] compute an SHA256 sum.
510 \item [S3] comput an SHA512 sum.
511 \item [s] handle sparse files.
512 \item [m] use st\_mtime only for file differences.
513 \item [k] restore the st\_atime after accessing a file.
514 \item [A] enable ACL backup.
515 \item [Vxxx:] specify verify options. Must terminate with :
516 \item [Cxxx:] specify accurate options. Must terminate with :
517 \item [Jxxx:] specify base job Options. Must terminate with :
518 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
520 \item [Zn] specify gzip compression level n.
521 \item [K] do not use st\_atime in backup decision.
522 \item [c] check if file changed during backup.
523 \item [N] honor no dump flag.
524 \item [X] enable backup of extended attributes.
527 \item [AddRegex] adds a regex expression to the current Options block.
528 The fillowing options are permitted:
530 \item [ ] (a blank) regex applies to whole path and filename.
531 \item [F] regex applies only to the filename (directory or path stripped).
532 \item [D] regex applies only to the directory (path) part of the name.
535 \item [AddWild] adds a wildcard expression to the current Options block.
536 The fillowing options are permitted:
538 \item [ ] (a blank) regex applies to whole path and filename.
539 \item [F] regex applies only to the filename (directory or path stripped).
540 \item [D] regex applies only to the directory (path) part of the name.
543 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
544 that can use Accurate code to compare the file information in argument with
545 the previous file information. The \texttt{delta\_seq} attribute of the
546 \texttt{save\_pkt} will be updated, and the call will return
547 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
552 \subsection{Bacula events}
553 The list of events has been extended to include:
559 bEventStartBackupJob = 3,
560 bEventEndBackupJob = 4,
561 bEventStartRestoreJob = 5,
562 bEventEndRestoreJob = 6,
563 bEventStartVerifyJob = 7,
564 bEventEndVerifyJob = 8,
565 bEventBackupCommand = 9,
566 bEventRestoreCommand = 10,
571 bEventCancelCommand = 13,
572 bEventVssBackupAddComponents = 14,
573 bEventVssRestoreLoadComponentMetadata = 15,
574 bEventVssRestoreSetComponentsSelected = 16,
575 bEventRestoreObject = 17,
576 bEventEndFileSet = 18,
577 bEventPluginCommand = 19,
578 bEventVssBeforeCloseRestore = 20,
579 bEventVssPrepareSnapshot = 21
585 \item [bEventCancelCommand] is called whenever the currently
586 running Job is cancelled */
588 \item [bEventVssBackupAddComponents]
590 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
591 provides a char[27] table where the plugin can add Windows drives that will
592 be used during the Job. You need to add them without duplicates, and you can
593 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
597 \chapter{Release Version 5.0.3}
599 There are no new features in version 5.0.2. This version simply fixes a
600 number of bugs found in version 5.0.1 during the onging development
603 \chapter{Release Version 5.0.2}
605 There are no new features in version 5.0.2. This version simply fixes a
606 number of bugs found in version 5.0.1 during the onging development
612 \chapter{New Features in 5.0.1}
614 This chapter presents the new features that are in the released Bacula version
615 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
616 the onging development process.
618 \section{Truncate Volume after Purge}
619 \label{sec:actiononpurge}
621 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
622 the volume when it is purged with the new command \texttt{purge volume
623 action}. It is useful to prevent disk based volumes from consuming too much
629 Action On Purge = Truncate
634 As usual you can also set this property with the \texttt{update volume} command
636 *update volume=xxx ActionOnPurge=Truncate
637 *update volume=xxx actiononpurge=None
640 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
641 following command in interactive mode or in a RunScript as shown after:
643 *purge volume action=truncate storage=File allpools
644 # or by default, action=all
645 *purge volume action storage=File pool=Default
648 This is possible to specify the volume name, the media type, the pool, the
649 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
650 idle when you decide to run this command.
659 Console = "purge volume action=all allpools storage=File"
664 \textbf{Important note}: This feature doesn't work as
665 expected in version 5.0.0. Please do not use it before version 5.0.1.
667 \section{Allow Higher Duplicates}
668 This directive did not work correctly and has been depreciated
669 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
670 file as it will be removed in a future rlease.
672 \section{Cancel Lower Level Duplicates}
673 This directive was added in Bacula version 5.0.1. It compares the
674 level of a new backup job to old jobs of the same name, if any,
675 and will kill the job which has a lower level than the other one.
676 If the levels are the same (i.e. both are Full backups), then
677 nothing is done and the other Cancel XXX Duplicate directives
680 \chapter{New Features in 5.0.0}
682 \section{Maximum Concurent Jobs for Devices}
683 \label{sec:maximumconcurentjobdevice}
685 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
686 Daemon configuration permits setting the maximum number of Jobs that can
687 run concurrently on a specified Device. Using this directive, it is
688 possible to have different Jobs using multiple drives, because when the
689 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
690 Jobs on any other available compatible drive. This facilitates writing to
691 multiple drives with multiple Jobs that all use the same Pool.
693 This project was funded by Bacula Systems.
695 \section{Restore from Multiple Storage Daemons}
696 \index[general]{Restore}
698 Previously, you were able to restore from multiple devices in a single Storage
699 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
700 example, if your full backup runs on a Storage Daemon with an autochanger, and
701 your incremental jobs use another Storage Daemon with lots of disks, Bacula
702 will switch automatically from one Storage Daemon to an other within the same
705 You must upgrade your File Daemon to version 3.1.3 or greater to use this
708 This project was funded by Bacula Systems with the help of Equiinet.
710 \section{File Deduplication using Base Jobs}
711 A base job is sort of like a Full save except that you will want the FileSet to
712 contain only files that are unlikely to change in the future (i.e. a snapshot
713 of most of your system after installing it). After the base job has been run,
714 when you are doing a Full save, you specify one or more Base jobs to be used.
715 All files that have been backed up in the Base job/jobs but not modified will
716 then be excluded from the backup. During a restore, the Base jobs will be
717 automatically pulled in where necessary.
719 This is something none of the competition does, as far as we know (except
720 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
721 win for the user, it makes Bacula stand out as offering a unique optimization
722 that immediately saves time and money. Basically, imagine that you have 100
723 nearly identical Windows or Linux machine containing the OS and user files.
724 Now for the OS part, a Base job will be backed up once, and rather than making
725 100 copies of the OS, there will be only one. If one or more of the systems
726 have some files updated, no problem, they will be automatically restored.
728 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
729 files that will be used during Full backup as base.
740 Base = BackupZog4, BackupLinux
746 In this example, the job \texttt{BackupZog4} will use the most recent version
747 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
748 jobs. Base jobs should have run with \texttt{level=Base} to be used.
750 By default, Bacula will compare permissions bits, user and group fields,
751 modification time, size and the checksum of the file to choose between the
752 current backup and the BaseJob file list. You can change this behavior with the
753 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
754 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
770 \textbf{Important note}: The current implementation doesn't permit to scan
771 volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
773 This project was funded by Bacula Systems.
775 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
776 \index[dir]{AllowCompression}
778 This new directive may be added to Storage resource within the Director's
779 configuration to allow users to selectively disable the client compression for
780 any job which writes to this storage resource.
786 Address = ultrium-tape
787 Password = storage_password # Password for Storage Daemon
790 AllowCompression = No # Tape drive has hardware compression
793 The above example would cause any jobs running with the UltriumTape storage
794 resource to run without compression from the client file daemons. This
795 effectively overrides any compression settings defined at the FileSet level.
797 This feature is probably most useful if you have a tape drive which supports
798 hardware compression. By setting the \texttt{AllowCompression = No} directive
799 for your tape drive storage resource, you can avoid additional load on the file
800 daemon and possibly speed up tape backups.
802 This project was funded by Collaborative Fusion, Inc.
804 \section{Accurate Fileset Options}
805 \label{sec:accuratefileset}
807 In previous versions, the accurate code used the file creation and modification
808 times to determine if a file was modified or not. Now you can specify which
809 attributes to use (time, size, checksum, permission, owner, group, \dots),
810 similar to the Verify options.
826 \item {\bf i} compare the inodes
827 \item {\bf p} compare the permission bits
828 \item {\bf n} compare the number of links
829 \item {\bf u} compare the user id
830 \item {\bf g} compare the group id
831 \item {\bf s} compare the size
832 \item {\bf a} compare the access time
833 \item {\bf m} compare the modification time (st\_mtime)
834 \item {\bf c} compare the change time (st\_ctime)
835 \item {\bf d} report file size decreases
836 \item {\bf 5} compare the MD5 signature
837 \item {\bf 1} compare the SHA1 signature
840 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
841 the File Daemon will have to read all files even if they normally would not
842 be saved. This increases the I/O load, but also the accuracy of the
843 deduplication. By default, Bacula will check modification/creation time
846 This project was funded by Bacula Systems.
848 \section{Tab-completion for Bconsole}
849 \label{sec:tabcompletion}
851 If you build \texttt{bconsole} with readline support, you will be able to use
852 the new auto-completion mode. This mode supports all commands, gives help
853 inside command, and lists resources when required. It works also in the restore
856 To use this feature, you should have readline development package loaded on
857 your system, and use the following option in configure.
859 ./configure --with-readline=/usr/include/readline --disable-conio ...
862 The new bconsole won't be able to tab-complete with older directors.
864 This project was funded by Bacula Systems.
866 \section{Pool File and Job Retention}
867 \label{sec:poolfilejobretention}
869 We added two new Pool directives, \texttt{FileRetention} and
870 \texttt{JobRetention}, that take precedence over Client directives of the same
871 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
872 example, you can decide to increase Retention times for Archive or OffSite Pool.
874 It seems obvious to us, but apparently not to some users, that given the
875 definition above that the Pool File and Job Retention periods is a global
876 override for the normal Client based prunning, which means that when the
877 Job is prunned, the prunning will apply globally to that particular Job.
879 Currently, there is a bug in the implementation that causes any Pool
880 retention periods specified to apply to {\bf all} Pools for that
881 particular Client. Thus we suggest that you avoid using these two
882 directives until this implementation problem is corrected.
884 \section{Read-only File Daemon using capabilities}
885 \label{sec:fdreadonly}
886 This feature implements support of keeping \textbf{ReadAll} capabilities after
887 UID/GID switch, this allows FD to keep root read but drop write permission.
889 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
890 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
893 root@localhost:~# bacula-fd -k -u nobody -g nobody
896 The code for this feature was contributed by our friends at AltLinux.
901 To help developers of restore GUI interfaces, we have added new \textsl{dot
902 commands} that permit browsing the catalog in a very simple way.
905 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
906 the Bvfs cache in the catalog. You need to run it before any access to the
909 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
910 will list all directories in the specified \texttt{path} or
911 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
912 encoding of path/filenames.
914 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
915 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
916 \texttt{pathid} avoids problems with character encoding.
919 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
920 data that will be displayed.
923 * .bvfs_update jobid=1,2
925 * .bvfs_lsdir path=/ jobid=1,2
928 This project was funded by Bacula Systems.
930 \section{Testing your Tape Drive}
931 \label{sec:btapespeed}
933 To determine the best configuration of your tape drive, you can run the new
934 \texttt{speed} command available in the \texttt{btape} program.
936 This command can have the following arguments:
938 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
939 (between 1 and 5GB). This counter is in GB.
940 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
941 of data should be greater than your memory ($file\_size*nb\_file$).
942 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
944 \item[\texttt{skip\_random}] This flag permits to skip tests with random
946 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
947 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
952 *speed file_size=3 skip_raw
953 btape.c:1078 Test with zero data and bacula block structure.
954 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
955 ++++++++++++++++++++++++++++++++++++++++++
956 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
957 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
959 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
961 btape.c:1090 Test with random data, should give the minimum throughput.
962 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
963 +++++++++++++++++++++++++++++++++++++++++++
964 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
965 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
966 +++++++++++++++++++++++++++++++++++++++++++
968 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
972 When using compression, the random test will give your the minimum throughput
973 of your drive . The test using constant string will give you the maximum speed
974 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
976 You can change the block size in the Storage Daemon configuration file.
978 \section{New {\bf Block Checksum} Device Directive}
979 You may now turn off the Block Checksum (CRC32) code
980 that Bacula uses when writing blocks to a Volume. This is
987 doing so can reduce the Storage daemon CPU usage slightly. It
988 will also permit Bacula to read a Volume that has corrupted data.
990 The default is {\bf yes} -- i.e. the checksum is computed on write
993 We do not recommend to turn this off particularly on older tape
994 drives or for disk Volumes where doing so may allow corrupted data
997 \section{New Bat Features}
999 Those new features were funded by Bacula Systems.
1001 \subsection{Media List View}
1003 By clicking on ``Media'', you can see the list of all your volumes. You will be
1004 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1005 in the table. The old ``Media'' view is now known as ``Pool''.
1006 \begin{figure}[htbp]
1008 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
1009 \label{fig:mediaview}
1013 \subsection{Media Information View}
1015 By double-clicking on a volume (on the Media list, in the Autochanger content
1016 or in the Job information panel), you can access a detailed overview of your
1017 Volume. (cf \ref{fig:mediainfo}.)
1018 \begin{figure}[htbp]
1020 \includegraphics[width=13cm]{\idir bat11.eps}
1021 \caption{Media information}
1022 \label{fig:mediainfo}
1025 \subsection{Job Information View}
1027 By double-clicking on a Job record (on the Job run list or in the Media
1028 information panel), you can access a detailed overview of your Job. (cf
1030 \begin{figure}[htbp]
1032 \includegraphics[width=13cm]{\idir bat12.eps}
1033 \caption{Job information}
1037 \subsection{Autochanger Content View}
1039 By double-clicking on a Storage record (on the Storage list panel), you can
1040 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
1041 \begin{figure}[htbp]
1043 \includegraphics[width=13cm]{\idir bat13.eps}
1044 \caption{Autochanger content}
1045 \label{fig:achcontent}
1048 To use this feature, you need to use the latest mtx-changer script
1049 version. (With new \texttt{listall} and \texttt{transfer} commands)
1051 \section{Bat on Windows}
1052 We have ported {\bf bat} to Windows and it is now installed
1053 by default when the installer is run. It works quite well
1054 on Win32, but has not had a lot of testing there, so your
1055 feedback would be welcome. Unfortunately, eventhough it is
1056 installed by default, it does not yet work on 64 bit Windows
1059 \section{New Win32 Installer}
1060 The Win32 installer has been modified in several very important
1063 \item You must deinstall any current version of the
1064 Win32 File daemon before upgrading to the new one.
1065 If you forget to do so, the new installation will fail.
1066 To correct this failure, you must manually shutdown
1067 and deinstall the old File daemon.
1068 \item All files (other than menu links) are installed
1069 in {\bf c:/Program Files/Bacula}.
1070 \item The installer no longer sets this
1071 file to require administrator privileges by default. If you want
1072 to do so, please do it manually using the {\bf cacls} program.
1075 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1077 \item The server daemons (Director and Storage daemon) are
1078 no longer included in the Windows installer. If you want the
1079 Windows servers, you will either need to build them yourself (note
1080 they have not been ported to 64 bits), or you can contact
1081 Bacula Systems about this.
1084 \section{Win64 Installer}
1085 We have corrected a number of problems that required manual
1086 editing of the conf files. In most cases, it should now
1087 install and work. {\bf bat} is by default installed in
1088 {\bf c:/Program Files/Bacula/bin32} rather than
1089 {\bf c:/Program Files/Bacula} as is the case with the 32
1090 bit Windows installer.
1092 \section{Linux Bare Metal Recovery USB Key}
1093 We have made a number of significant improvements in the
1094 Bare Metal Recovery USB key. Please see the README files
1095 it the {\bf rescue} release for more details.
1097 We are working on an equivalent USB key for Windows bare
1098 metal recovery, but it will take some time to develop it (best
1099 estimate 3Q2010 or 4Q2010)
1102 \section{bconsole Timeout Option}
1103 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1104 for commands. This is useful with GUI programs that use {\bf bconsole}
1105 to interface to the Director.
1107 \section{Important Changes}
1108 \label{sec:importantchanges}
1111 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1112 to the same Pool. The Storage daemon ensures that you do not read and
1113 write to the same Volume.
1114 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1116 \item Virtually all the features of {\bf mtx-changer} have
1117 now been parameterized, which allows you to configure
1118 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1119 that contains variables that you can set to configure mtx-changer.
1120 This configuration file will not be overwritten during upgrades.
1121 We encourage you to submit any changes
1122 that are made to mtx-changer and to parameterize it all in
1123 mtx-changer.conf so that all configuration will be done by
1124 changing only mtx-changer.conf.
1125 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1126 and \texttt{transfer}. Please configure them as appropriate
1127 in mtx-changer.conf.
1128 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1129 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1130 password. If you want to use the new script, you will need to
1131 manually change the \texttt{BackupCatalog} Job definition.
1132 \item The \texttt{bconsole} \texttt{help} command now accepts
1133 an argument, which if provided produces information on that
1134 command (ex: \texttt{help run}).
1138 \subsubsection*{Truncate volume after purge}
1140 Note that the Truncate Volume after purge feature doesn't work as expected
1141 in 5.0.0 version. Please, don't use it before version 5.0.1.
1143 \subsection{Custom Catalog queries}
1145 If you wish to add specialized commands that list the contents of the catalog,
1146 you can do so by adding them to the \texttt{query.sql} file. This
1147 \texttt{query.sql} file is now empty by default. The file
1148 \texttt{examples/sample-query.sql} has an a number of sample commands
1149 you might find useful.
1151 \subsection{Deprecated parts}
1153 The following items have been \textbf{deprecated} for a long time, and are now
1154 removed from the code.
1157 \item Support for SQLite 2
1160 \section{Misc Changes}
1161 \label{sec:miscchanges}
1164 \item Updated Nagios check\_bacula
1165 \item Updated man files
1166 \item Added OSX package generation script in platforms/darwin
1167 \item Added Spanish and Ukrainian Bacula translations
1168 \item Enable/disable command shows only Jobs that can change
1169 \item Added \texttt{show disabled} command to show disabled Jobs
1170 \item Many ACL improvements
1171 \item Added Level to FD status Job output
1172 \item Begin Ingres DB driver (not yet working)
1173 \item Split RedHat spec files into bacula, bat, mtx, and docs
1174 \item Reorganized the manuals (fewer separate manuals)
1175 \item Added lock/unlock order protection in lock manager
1176 \item Allow 64 bit sizes for a number of variables
1177 \item Fixed several deadlocks or potential race conditions in the SD
1180 \chapter{Released Version 3.0.3 and 3.0.3a}
1182 There are no new features in version 3.0.3. This version simply fixes a
1183 number of bugs found in version 3.0.2 during the onging development
1186 \chapter{New Features in Released Version 3.0.2}
1188 This chapter presents the new features added to the
1189 Released Bacula Version 3.0.2.
1191 \section{Full Restore from a Given JobId}
1192 \index[general]{Restore menu}
1194 This feature allows selecting a single JobId and having Bacula
1195 automatically select all the other jobs that comprise a full backup up to
1196 and including the selected date (through JobId).
1198 Assume we start with the following jobs:
1200 +-------+--------------+---------------------+-------+----------+------------+
1201 | jobid | client | starttime | level | jobfiles | jobbytes |
1202 +-------+--------------+---------------------+-------+----------+------------
1203 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1204 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1205 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1206 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1207 +-------+--------------+---------------------+-------+----------+------------+
1210 Below is an example of this new feature (which is number 12 in the
1215 To select the JobIds, you have the following choices:
1216 1: List last 20 Jobs run
1217 2: List Jobs where a given File is saved
1219 12: Select full restore to a specified Job date
1222 Select item: (1-13): 12
1223 Enter JobId to get the state to restore: 5
1224 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1225 You have selected the following JobIds: 1,3,5
1227 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1228 1,444 files inserted into the tree.
1231 This project was funded by Bacula Systems.
1233 \section{Source Address}
1234 \index[general]{Source Address}
1236 A feature has been added which allows the administrator to specify the address
1237 from which the Director and File daemons will establish connections. This
1238 may be used to simplify system configuration overhead when working in complex
1239 networks utilizing multi-homing and policy-routing.
1241 To accomplish this, two new configuration directives have been implemented:
1244 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1248 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1252 Simply adding specific host routes on the OS
1253 would have an undesirable side-effect: any
1254 application trying to contact the destination host would be forced to use the
1255 more specific route possibly diverting management traffic onto a backup VLAN.
1256 Instead of adding host routes for each client connected to a multi-homed backup
1257 server (for example where there are management and backup VLANs), one can
1258 use the new directives to specify a specific source address at the application
1261 Additionally, this allows the simplification and abstraction of firewall rules
1262 when dealing with a Hot-Standby director or storage daemon configuration. The
1263 Hot-standby pair may share a CARP address, which connections must be sourced
1264 from, while system services listen and act from the unique interface addresses.
1266 This project was funded by Collaborative Fusion, Inc.
1268 \section{Show volume availability when doing restore}
1270 When doing a restore the selection dialog ends by displaying this
1274 The job will require the following
1275 Volume(s) Storage(s) SD Device(s)
1276 ===========================================================================
1277 *000741L3 LTO-4 LTO3
1278 *000866L3 LTO-4 LTO3
1279 *000765L3 LTO-4 LTO3
1280 *000764L3 LTO-4 LTO3
1281 *000756L3 LTO-4 LTO3
1282 *001759L3 LTO-4 LTO3
1283 *001763L3 LTO-4 LTO3
1287 Volumes marked with ``*'' are online (in the autochanger).
1290 This should help speed up large restores by minimizing the time spent
1291 waiting for the operator to discover that he must change tapes in the library.
1293 This project was funded by Bacula Systems.
1295 \section{Accurate estimate command}
1297 The \texttt{estimate} command can now use the accurate code to detect changes
1298 and give a better estimation.
1300 You can set the accurate behavior on the command line by using
1301 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1304 * estimate listing accurate=yes level=incremental job=BackupJob
1307 This project was funded by Bacula Systems.
1309 \chapter{New Features in 3.0.0}
1310 \label{NewFeaturesChapter}
1311 \index[general]{New Features}
1313 This chapter presents the new features added to the development 2.5.x
1314 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1316 \section{Accurate Backup}
1317 \index[general]{Accurate Backup}
1319 As with most other backup programs, by default Bacula decides what files to
1320 backup for Incremental and Differental backup by comparing the change
1321 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1322 backup completed. If one of those two times is later than the last backup
1323 time, then the file will be backed up. This does not, however, permit tracking
1324 what files have been deleted and will miss any file with an old time that may
1325 have been restored to or moved onto the client filesystem.
1327 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1328 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1329 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1330 backup, there is no difference, but for {\bf Differential} and {\bf
1331 Incremental} backups, the Director will send a list of all previous files
1332 backed up, and the File daemon will use that list to determine if any new files
1333 have been added or or moved and if any files have been deleted. This allows
1334 Bacula to make an accurate backup of your system to that point in time so that
1335 if you do a restore, it will restore your system exactly.
1338 about using Accurate backup is that it requires more resources (CPU and memory)
1339 on both the Director and the Client machines to create the list of previous
1340 files backed up, to send that list to the File daemon, for the File daemon to
1341 keep the list (possibly very big) in memory, and for the File daemon to do
1342 comparisons between every file in the FileSet and the list. In particular,
1343 if your client has lots of files (more than a few million), you will need
1344 lots of memory on the client machine.
1346 Accurate must not be enabled when backing up with a plugin that is not
1347 specially designed to work with Accurate. If you enable it, your restores
1348 will probably not work correctly.
1350 This project was funded by Bacula Systems.
1355 \index[general]{Copy Jobs}
1357 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1358 existing Migration feature with the exception that the Job that is copied is
1359 left unchanged. This essentially creates two identical copies of the same
1360 backup. However, the copy is treated as a copy rather than a backup job, and
1361 hence is not directly available for restore. The {\bf restore} command lists
1362 copy jobs and allows selection of copies by using \texttt{jobid=}
1363 option. If the keyword {\bf copies} is present on the command line, Bacula will
1364 display the list of all copies for selected jobs.
1369 These JobIds have copies as follows:
1370 +-------+------------------------------------+-----------+------------------+
1371 | JobId | Job | CopyJobId | MediaType |
1372 +-------+------------------------------------+-----------+------------------+
1373 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1374 +-------+------------------------------------+-----------+------------------+
1375 +-------+-------+----------+----------+---------------------+------------------+
1376 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1377 +-------+-------+----------+----------+---------------------+------------------+
1378 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1379 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1380 +-------+-------+----------+----------+---------------------+------------------+
1381 You have selected the following JobIds: 19,2
1383 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1384 5,611 files inserted into the tree.
1389 The Copy Job runs without using the File daemon by copying the data from the
1390 old backup Volume to a different Volume in a different Pool. See the Migration
1391 documentation for additional details. For copy Jobs there is a new selection
1392 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1393 not already copied to another Pool.
1395 As with Migration, the Client, Volume, Job, or SQL query, are
1396 other possible ways of selecting the Jobs to be copied. Selection
1397 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1398 work, but are probably more suited for Migration Jobs.
1400 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1401 it will promote the Copy to a \textsl{real} backup job and will make it available for
1402 automatic restore. If more than one Copy is available, it will promote the copy
1403 with the smallest JobId.
1405 A nice solution which can be built with the new Copy feature is often
1406 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1407 look something like the one below:
1411 Name = FullBackupsVirtualPool
1413 Purge Oldest Volume = Yes
1415 NextPool = FullBackupsTapePool
1419 Name = FullBackupsTapePool
1423 Volume Retention = 365 days
1424 Storage = superloader
1428 # Fake fileset for copy jobs
1440 # Fake client for copy jobs
1450 # Default template for a CopyDiskToTape Job
1453 Name = CopyDiskToTape
1455 Messages = StandardCopy
1458 Selection Type = PoolUncopiedJobs
1459 Maximum Concurrent Jobs = 10
1461 Allow Duplicate Jobs = Yes
1462 Cancel Queued Duplicates = No
1463 Cancel Running Duplicates = No
1468 Name = DaySchedule7:00
1469 Run = Level=Full daily at 7:00
1473 Name = CopyDiskToTapeFullBackups
1475 Schedule = DaySchedule7:00
1476 Pool = FullBackupsVirtualPool
1477 JobDefs = CopyDiskToTape
1481 The example above had 2 pool which are copied using the PoolUncopiedJobs
1482 selection criteria. Normal Full backups go to the Virtual pool and are copied
1483 to the Tape pool the next morning.
1485 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1490 +-------+------------------------------------+-----------+------------------+
1491 | JobId | Job | CopyJobId | MediaType |
1492 +-------+------------------------------------+-----------+------------------+
1493 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1494 +-------+------------------------------------+-----------+------------------+
1497 \section{ACL Updates}
1498 \index[general]{ACL Updates}
1499 The whole ACL code had been overhauled and in this version each platforms has
1500 different streams for each type of acl available on such an platform. As ACLs
1501 between platforms tend to be not that portable (most implement POSIX acls but
1502 some use an other draft or a completely different format) we currently only
1503 allow certain platform specific ACL streams to be decoded and restored on the
1504 same platform that they were created on. The old code allowed to restore ACL
1505 cross platform but the comments already mention that not being to wise. For
1506 backward compatability the new code will accept the two old ACL streams and
1507 handle those with the platform specific handler. But for all new backups it
1508 will save the ACLs using the new streams.
1510 Currently the following platforms support ACLs:
1514 \item {\bf Darwin/OSX}
1523 Currently we support the following ACL types (these ACL streams use a reserved
1524 part of the stream numbers):
1527 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1529 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1530 string representation from acl\_to\_text (POSIX acl)
1531 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1532 string representation from acl\_to\_text (POSIX acl) for default acls.
1533 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1534 string representation from acl\_to\_text (POSIX acl) for access acls.
1535 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1536 string representation from acltostr (POSIX acl)
1537 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1538 representation from acl\_to\_text (POSIX acl) for default acls.
1539 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1540 representation from acl\_to\_text (POSIX acl) for access acls.
1541 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1542 string representation from acl\_to\_text (POSIX acl) for default acls.
1543 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1544 representation from acl\_to\_text (POSIX acl) for access acls.
1545 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1546 string representation from acl\_to\_text (POSIX acl) for default acls.
1547 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1548 string representation from acl\_to\_text (POSIX acl) for default acls.
1549 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1550 representation from acl\_to\_text (POSIX acl) for access acls.
1551 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1552 string representation from acltotext or acl\_totext (POSIX acl)
1553 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1554 representation from from acl\_totext (NFSv4 or ZFS acl)
1557 In future versions we might support conversion functions from one type of acl
1558 into an other for types that are either the same or easily convertable. For now
1559 the streams are seperate and restoring them on a platform that doesn't
1560 recognize them will give you a warning.
1562 \section{Extended Attributes}
1563 \index[general]{Extended Attributes}
1564 Something that was on the project list for some time is now implemented for
1565 platforms that support a similar kind of interface. Its the support for backup
1566 and restore of so called extended attributes. As extended attributes are so
1567 platform specific these attributes are saved in seperate streams for each
1568 platform. Restores of the extended attributes can only be performed on the
1569 same platform the backup was done. There is support for all types of extended
1570 attributes, but restoring from one type of filesystem onto an other type of
1571 filesystem on the same platform may lead to supprises. As extended attributes
1572 can contain any type of data they are stored as a series of so called
1573 value-pairs. This data must be seen as mostly binary and is stored as such.
1574 As security labels from selinux are also extended attributes this option also
1575 stores those labels and no specific code is enabled for handling selinux
1578 Currently the following platforms support extended attributes:
1580 \item {\bf Darwin/OSX}
1586 On linux acls are also extended attributes, as such when you enable ACLs on a
1587 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1588 and not the same exteneded attribute.
1590 To enable the backup of extended attributes please add the following to your
1605 \section{Shared objects}
1606 \index[general]{Shared objects}
1607 A default build of Bacula will now create the libraries as shared objects
1608 (.so) rather than static libraries as was previously the case.
1609 The shared libraries are built using {\bf libtool} so it should be quite
1612 An important advantage of using shared objects is that on a machine with the
1613 Directory, File daemon, the Storage daemon, and a console, you will have only
1614 one copy of the code in memory rather than four copies. Also the total size of
1615 the binary release is smaller since the library code appears only once rather
1616 than once for every program that uses it; this results in significant reduction
1617 in the size of the binaries particularly for the utility tools.
1619 In order for the system loader to find the shared objects when loading the
1620 Bacula binaries, the Bacula shared objects must either be in a shared object
1621 directory known to the loader (typically /usr/lib) or they must be in the
1622 directory that may be specified on the {\bf ./configure} line using the {\bf
1623 {-}{-}libdir} option as:
1626 ./configure --libdir=/full-path/dir
1629 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1630 no need to modify your loader configuration provided that
1631 the shared objects are installed in that directory (Bacula
1632 does this with the make install command). The shared objects
1633 that Bacula references are:
1642 These files are symbolically linked to the real shared object file,
1643 which has a version number to permit running multiple versions of
1644 the libraries if desired (not normally the case).
1646 If you have problems with libtool or you wish to use the old
1647 way of building static libraries, or you want to build a static
1648 version of Bacula you may disable
1649 libtool on the configure command line with:
1652 ./configure --disable-libtool
1656 \section{Building Static versions of Bacula}
1657 \index[general]{Static linking}
1658 In order to build static versions of Bacula, in addition
1659 to configuration options that were needed you now must
1660 also add --disable-libtool. Example
1663 ./configure --enable-static-client-only --disable-libtool
1667 \section{Virtual Backup (Vbackup)}
1668 \index[general]{Virtual Backup}
1669 \index[general]{Vbackup}
1671 Bacula's virtual backup feature is often called Synthetic Backup or
1672 Consolidation in other backup products. It permits you to consolidate the
1673 previous Full backup plus the most recent Differential backup and any
1674 subsequent Incremental backups into a new Full backup. This new Full
1675 backup will then be considered as the most recent Full for any future
1676 Incremental or Differential backups. The VirtualFull backup is
1677 accomplished without contacting the client by reading the previous backup
1678 data and writing it to a volume in a different pool.
1680 In some respects the Vbackup feature works similar to a Migration job, in
1681 that Bacula normally reads the data from the pool specified in the
1682 Job resource, and writes it to the {\bf Next Pool} specified in the
1683 Job resource. Note, this means that usually the output from the Virtual
1684 Backup is written into a different pool from where your prior backups
1685 are saved. Doing it this way guarantees that you will not get a deadlock
1686 situation attempting to read and write to the same volume in the Storage
1687 daemon. If you then want to do subsequent backups, you may need to
1688 move the Virtual Full Volume back to your normal backup pool.
1689 Alternatively, you can set your {\bf Next Pool} to point to the current
1690 pool. This will cause Bacula to read and write to Volumes in the
1691 current pool. In general, this will work, because Bacula will
1692 not allow reading and writing on the same Volume. In any case, once
1693 a VirtualFull has been created, and a restore is done involving the
1694 most current Full, it will read the Volume or Volumes by the VirtualFull
1695 regardless of in which Pool the Volume is found.
1697 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1698 a level of {\bf VirtualFull}.
1700 A typical Job resource definition might look like the following:
1707 FileSet = "Full Set"
1714 # Default pool definition
1718 Recycle = yes # Automatically recycle Volumes
1719 AutoPrune = yes # Prune expired volumes
1720 Volume Retention = 365d # one year
1728 Recycle = yes # Automatically recycle Volumes
1729 AutoPrune = yes # Prune expired volumes
1730 Volume Retention = 365d # one year
1731 Storage = DiskChanger
1734 # Definition of file storage device
1739 Device = FileStorage
1741 Maximum Concurrent Jobs = 5
1744 # Definition of DDS Virtual tape disk storage device
1747 Address = localhost # N.B. Use a fully qualified name here
1749 Device = DiskChanger
1750 Media Type = DiskChangerMedia
1751 Maximum Concurrent Jobs = 4
1756 Then in bconsole or via a Run schedule, you would run the job as:
1759 run job=MyBackup level=Full
1760 run job=MyBackup level=Incremental
1761 run job=MyBackup level=Differential
1762 run job=MyBackup level=Incremental
1763 run job=MyBackup level=Incremental
1766 So providing there were changes between each of those jobs, you would end up
1767 with a Full backup, a Differential, which includes the first Incremental
1768 backup, then two Incremental backups. All the above jobs would be written to
1769 the {\bf Default} pool.
1771 To consolidate those backups into a new Full backup, you would run the
1775 run job=MyBackup level=VirtualFull
1778 And it would produce a new Full backup without using the client, and the output
1779 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1781 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1784 Note, the Start and End time of the Virtual Full backup is set to the
1785 values for the last job included in the Virtual Full (in the above example,
1786 it is an Increment). This is so that if another incremental is done, which
1787 will be based on the Virtual Full, it will backup all files from the
1788 last Job included in the Virtual Full rather than from the time the Virtual
1789 Full was actually run.
1793 \section{Catalog Format}
1794 \index[general]{Catalog Format}
1795 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1796 operation will convert the FileId field of the File table from 32 bits (max 4
1797 billion table entries) to 64 bits (very large number of items). The
1798 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1799 your catalog during the conversion. Also you won't be able to run jobs during
1800 this conversion period. For example, a 3 million file catalog will take 2
1801 minutes to upgrade on a normal machine. Please don't forget to make a valid
1802 backup of your database before executing the upgrade script. See the
1803 ReleaseNotes for additional details.
1805 \section{64 bit Windows Client}
1806 \index[general]{Win64 Client}
1807 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1808 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1809 As a consequence, we are also releasing a 64 bit version of the Bacula
1810 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1811 These binaries should only be installed on 64 bit Windows operating systems.
1812 What is important is not your hardware but whether or not you have
1813 a 64 bit version of the Windows OS.
1815 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1817 \item Before installing the Win64 Bacula Client, you must totally
1818 deinstall any prior 2.4.x Client installation using the
1819 Bacula deinstallation (see the menu item). You may want
1820 to save your .conf files first.
1821 \item Only the Client (File daemon) is ported to Win64, the Director
1822 and the Storage daemon are not in the 64 bit Windows installer.
1823 \item bwx-console is not yet ported.
1824 \item bconsole is ported but it has not been tested.
1825 \item The documentation is not included in the installer.
1826 \item Due to Vista security restrictions imposed on a default installation
1827 of Vista, before upgrading the Client, you must manually stop
1828 any prior version of Bacula from running, otherwise the install
1830 \item Due to Vista security restrictions imposed on a default installation
1831 of Vista, attempting to edit the conf files via the menu items
1832 will fail. You must directly edit the files with appropriate
1833 permissions. Generally double clicking on the appropriate .conf
1834 file will work providing you have sufficient permissions.
1835 \item All Bacula files are now installed in
1836 {\bf C:/Program Files/Bacula} except the main menu items,
1837 which are installed as before. This vastly simplifies the installation.
1838 \item If you are running on a foreign language version of Windows, most
1839 likely {\bf C:/Program Files} does not exist, so you should use the
1840 Custom installation and enter an appropriate location to install
1842 \item The 3.0.0 Win32 Client continues to install files in the locations used
1843 by prior versions. For the next version we will convert it to use
1844 the same installation conventions as the Win64 version.
1847 This project was funded by Bacula Systems.
1850 \section{Duplicate Job Control}
1851 \index[general]{Duplicate Jobs}
1852 The new version of Bacula provides four new directives that
1853 give additional control over what Bacula does if duplicate jobs
1854 are started. A duplicate job in the sense we use it here means
1855 a second or subsequent job with the same name starts. This
1856 happens most frequently when the first job runs longer than expected because no
1857 tapes are available.
1859 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1860 are specified in the Job resource.
1864 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1865 \index[general]{Allow Duplicate Jobs}
1866 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1867 the directive is set to {\bf no} (default) then only one job of a given name
1868 may run at one time, and the action that Bacula takes to ensure only
1869 one job runs is determined by the other directives (see below).
1871 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1872 are present and none of the three directives given below permit
1873 cancelling a job, then the current job (the second one started)
1876 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1877 \index[general]{Allow Higher Duplicates}
1878 This directive was in version 5.0.0, but does not work as
1879 expected. If used, it should always be set to no. In later versions
1880 of Bacula the directive is disabled (disregarded).
1882 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1883 \index[general]{Cancel Running Duplicates}
1884 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1885 if this directive is set to {\bf yes} any job that is already running
1886 will be canceled. The default is {\bf no}.
1888 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1889 \index[general]{Cancel Queued Duplicates}
1890 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1891 if this directive is set to {\bf yes} any job that is
1892 already queued to run but not yet running will be canceled.
1893 The default is {\bf no}.
1896 \section{TLS Authentication}
1897 \index[general]{TLS Authentication}
1898 In Bacula version 2.5.x and later, in addition to the normal Bacula
1899 CRAM-MD5 authentication that is used to authenticate each Bacula
1900 connection, you can specify that you want TLS Authentication as well,
1901 which will provide more secure authentication.
1903 This new feature uses Bacula's existing TLS code (normally used for
1904 communications encryption) to do authentication. To use it, you must
1905 specify all the TLS directives normally used to enable communications
1906 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1909 \subsection{TLS Authenticate = yes}
1911 TLS Authenticate = yes
1914 in the main daemon configuration resource (Director for the Director,
1915 Client for the File daemon, and Storage for the Storage daemon).
1917 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1918 authentication, Bacula will also do TLS authentication, then TLS
1919 encryption will be turned off, and the rest of the communication between
1920 the two Bacula daemons will be done without encryption.
1922 If you want to encrypt communications data, use the normal TLS directives
1923 but do not turn on {\bf TLS Authenticate}.
1925 \section{bextract non-portable Win32 data}
1926 \index[general]{bextract handles Win32 non-portable data}
1927 {\bf bextract} has been enhanced to be able to restore
1928 non-portable Win32 data to any OS. Previous versions were
1929 unable to restore non-portable Win32 data to machines that
1930 did not have the Win32 BackupRead and BackupWrite API calls.
1932 \section{State File updated at Job Termination}
1933 \index[general]{State File}
1934 In previous versions of Bacula, the state file, which provides a
1935 summary of previous jobs run in the {\bf status} command output was
1936 updated only when Bacula terminated, thus if the daemon crashed, the
1937 state file might not contain all the run data. This version of
1938 the Bacula daemons updates the state file on each job termination.
1940 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1941 \index[general]{MaxFullInterval}
1942 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1943 can be used to specify the maximum time interval between {\bf Full} backup
1944 jobs. When a job starts, if the time since the last Full backup is
1945 greater than the specified interval, and the job would normally be an
1946 {\bf Incremental} or {\bf Differential}, it will be automatically
1947 upgraded to a {\bf Full} backup.
1949 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1950 \index[general]{MaxDiffInterval}
1951 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1952 can be used to specify the maximum time interval between {\bf Differential} backup
1953 jobs. When a job starts, if the time since the last Differential backup is
1954 greater than the specified interval, and the job would normally be an
1955 {\bf Incremental}, it will be automatically
1956 upgraded to a {\bf Differential} backup.
1958 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1959 \index[general]{MaxDiffInterval}
1960 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1961 by the user, and when it is set it is an indication to backup programs
1962 to not backup that particular file. This version of Bacula contains a
1963 new Options directive within a FileSet resource, which instructs Bacula to
1964 obey this flag. The new directive is:
1967 Honor No Dump Flag = yes\vb{}no
1970 The default value is {\bf no}.
1973 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1974 \index[general]{IgnoreDir}
1975 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1976 can be added to the Include section of the FileSet resource. If the specified
1977 filename ({\bf filename-string}) is found on the Client in any directory to be
1978 backed up, the whole directory will be ignored (not backed up). For example:
1981 # List of files to be backed up
1989 Exclude Dir Containing = .excludeme
1994 But in /home, there may be hundreds of directories of users and some
1995 people want to indicate that they don't want to have certain
1996 directories backed up. For example, with the above FileSet, if
1997 the user or sysadmin creates a file named {\bf .excludeme} in
1998 specific directories, such as
2001 /home/user/www/cache/.excludeme
2002 /home/user/temp/.excludeme
2005 then Bacula will not backup the two directories named:
2008 /home/user/www/cache
2012 NOTE: subdirectories will not be backed up. That is, the directive
2013 applies to the two directories in question and any children (be they
2014 files, directories, etc).
2017 \section{Bacula Plugins}
2018 \index[general]{Plugin}
2019 Support for shared object plugins has been implemented in the Linux, Unix
2020 and Win32 File daemons. The API will be documented separately in
2021 the Developer's Guide or in a new document. For the moment, there is
2022 a single plugin named {\bf bpipe} that allows an external program to
2023 get control to backup and restore a file.
2025 Plugins are also planned (partially implemented) in the Director and the
2028 \subsection{Plugin Directory}
2029 \index[general]{Plugin Directory}
2030 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2031 be added to the daemon definition resource. The directory takes a quoted
2032 string argument, which is the name of the directory in which the daemon can
2033 find the Bacula plugins. If this directive is not specified, Bacula will not
2034 load any plugins. Since each plugin has a distinctive name, all the daemons
2035 can share the same plugin directory.
2037 \subsection{Plugin Options}
2038 \index[general]{Plugin Options}
2039 The {\bf Plugin Options} directive takes a quoted string
2040 arguement (after the equal sign) and may be specified in the
2041 Job resource. The options specified will be passed to all plugins
2042 when they are run. This each plugin must know what it is looking
2043 for. The value defined in the Job resource can be modified
2044 by the user when he runs a Job via the {\bf bconsole} command line
2047 Note: this directive may be specified, and there is code to modify
2048 the string in the run command, but the plugin options are not yet passed to
2049 the plugin (i.e. not fully implemented).
2051 \subsection{Plugin Options ACL}
2052 \index[general]{Plugin Options ACL}
2053 The {\bf Plugin Options ACL} directive may be specified in the
2054 Director's Console resource. It functions as all the other ACL commands
2055 do by permitting users running restricted consoles to specify a
2056 {\bf Plugin Options} that overrides the one specified in the Job
2057 definition. Without this directive restricted consoles may not modify
2060 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2061 \index[general]{Plugin}
2062 The {\bf Plugin} directive is specified in the Include section of
2063 a FileSet resource where you put your {\bf File = xxx} directives.
2074 Plugin = "bpipe:..."
2079 In the above example, when the File daemon is processing the directives
2080 in the Include section, it will first backup all the files in {\bf /home}
2081 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2082 the Plugin Directory. The syntax and semantics of the Plugin directive
2083 require the first part of the string up to the colon (:) to be the name
2084 of the plugin. Everything after the first colon is ignored by the File daemon but
2085 is passed to the plugin. Thus the plugin writer may define the meaning of the
2086 rest of the string as he wishes.
2088 Please see the next section for information about the {\bf bpipe} Bacula
2091 \section{The bpipe Plugin}
2092 \index[general]{The bpipe Plugin}
2093 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2094 the Bacula source distribution. When the plugin is compiled and linking into
2095 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2096 Please note that this is a very simple plugin that was written for
2097 demonstration and test purposes. It is and can be used in production, but
2098 that was never really intended.
2100 The purpose of the plugin is to provide an interface to any system program for
2101 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2102 the Include section of your Job's FileSet resource. The full syntax of the
2103 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2104 to specify the sytax as it wishes) is:
2107 Plugin = "<field1>:<field2>:<field3>:<field4>"
2112 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2113 stripped off, so in this case, we would put {\bf bpipe} in this field.
2115 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2116 pseudo path and filename under which the backup will be saved. This pseudo
2117 path and filename will be seen by the user in the restore file tree.
2118 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2119 backed up by the plugin will be put under that "pseudo" path and filename.
2120 You must be careful to choose a naming convention that is unique to avoid
2121 a conflict with a path and filename that actually exists on your system.
2123 \item {\bf field3} for the {\bf bpipe} plugin
2124 specifies the "reader" program that is called by the plugin during
2125 backup to read the data. {\bf bpipe} will call this program by doing a
2128 \item {\bf field4} for the {\bf bpipe} plugin
2129 specifies the "writer" program that is called by the plugin during
2130 restore to write the data back to the filesystem.
2133 Please note that for two items above describing the "reader" and "writer"
2134 fields, these programs are "executed" by Bacula, which
2135 means there is no shell interpretation of any command line arguments
2136 you might use. If you want to use shell characters (redirection of input
2137 or output, ...), then we recommend that you put your command or commands
2138 in a shell script and execute the script. In addition if you backup a
2139 file with the reader program, when running the writer program during
2140 the restore, Bacula will not automatically create the path to the file.
2141 Either the path must exist, or you must explicitly do so with your command
2142 or in a shell script.
2144 Putting it all together, the full plugin directive line might look
2148 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2149 --opt --databases bacula:mysql"
2152 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2153 would be written on a single line.
2155 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2156 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2157 program {\bf mysqldump -f --opt --database bacula} to read the data during
2158 backup. The mysqldump command outputs all the data for the database named
2159 {\bf bacula}, which will be read by the plugin and stored in the backup.
2160 During restore, the data that was backed up will be sent to the program
2161 specified in the last field, which in this case is {\bf mysql}. When
2162 {\bf mysql} is called, it will read the data sent to it by the plugn
2163 then write it back to the same database from which it came ({\bf bacula}
2166 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2167 the data from a specified program to Bacula for backup, and then from Bacula to
2168 a specified program for restore.
2170 By using different command lines to {\bf bpipe},
2171 you can backup any kind of data (ASCII or binary) depending
2172 on the program called.
2174 \section{Microsoft Exchange Server 2003/2007 Plugin}
2175 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2176 \subsection{Background}
2177 The Exchange plugin was made possible by a funded development project
2178 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2179 The code for the plugin was written by James Harper, and the Bacula core
2180 code by Kern Sibbald. All the code for this funded development has become
2181 part of the Bacula project. Thanks to everyone who made it happen.
2183 \subsection{Concepts}
2184 Although it is possible to backup Exchange using Bacula VSS the Exchange
2185 plugin adds a good deal of functionality, because while Bacula VSS
2186 completes a full backup (snapshot) of Exchange, it does
2187 not support Incremental or Differential backups, restoring is more
2188 complicated, and a single database restore is not possible.
2190 Microsoft Exchange organises its storage into Storage Groups with
2191 Databases inside them. A default installation of Exchange will have a
2192 single Storage Group called 'First Storage Group', with two Databases
2193 inside it, "Mailbox Store (SERVER NAME)" and
2194 "Public Folder Store (SERVER NAME)",
2195 which hold user email and public folders respectively.
2197 In the default configuration, Exchange logs everything that happens to
2198 log files, such that if you have a backup, and all the log files since,
2199 you can restore to the present time. Each Storage Group has its own set
2200 of log files and operates independently of any other Storage Groups. At
2201 the Storage Group level, the logging can be turned off by enabling a
2202 function called "Enable circular logging". At this time the Exchange
2203 plugin will not function if this option is enabled.
2205 The plugin allows backing up of entire storage groups, and the restoring
2206 of entire storage groups or individual databases. Backing up and
2207 restoring at the individual mailbox or email item is not supported but
2208 can be simulated by use of the "Recovery" Storage Group (see below).
2210 \subsection{Installing}
2211 The Exchange plugin requires a DLL that is shipped with Microsoft
2212 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2213 correctly the Exchange plugin should find this automatically and run
2214 without any additional installation.
2216 If the DLL can not be found automatically it will need to be copied into
2217 the Bacula installation
2218 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2219 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2220 default Exchange installation.
2222 \subsection{Backing Up}
2223 To back up an Exchange server the Fileset definition must contain at
2224 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2225 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2226 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2227 up files are prefixed with something that isn't going to share a name
2228 with something outside the plugin, and the 'Microsoft Information Store'
2229 bit is required also. It is also possible to add the name of a storage
2230 group to the "Plugin =" line, eg \\
2231 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2232 if you want only a single storage group backed up.
2234 Additionally, you can suffix the 'Plugin =' directive with
2235 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2236 database at the end of a full backup.
2238 An Incremental or Differential backup will backup only the database logs
2239 for each Storage Group by inspecting the "modified date" on each
2240 physical log file. Because of the way the Exchange API works, the last
2241 logfile backed up on each backup will always be backed up by the next
2242 Incremental or Differential backup too. This adds 5MB to each
2243 Incremental or Differential backup size but otherwise does not cause any
2246 By default, a normal VSS fileset containing all the drive letters will
2247 also back up the Exchange databases using VSS. This will interfere with
2248 the plugin and Exchange's shared ideas of when the last full backup was
2249 done, and may also truncate log files incorrectly. It is important,
2250 therefore, that the Exchange database files be excluded from the backup,
2251 although the folders the files are in should be included, or they will
2252 have to be recreated manually if a baremetal restore is done.
2257 File = C:/Program Files/Exchsrvr/mdbdata
2258 Plugin = "exchange:..."
2261 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2262 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2263 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2264 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2265 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2266 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2267 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2272 The advantage of excluding the above files is that you can significantly
2273 reduce the size of your backup since all the important Exchange files
2274 will be properly saved by the Plugin.
2277 \subsection{Restoring}
2278 The restore operation is much the same as a normal Bacula restore, with
2279 the following provisos:
2282 \item The {\bf Where} restore option must not be specified
2283 \item Each Database directory must be marked as a whole. You cannot just
2284 select (say) the .edb file and not the others.
2285 \item If a Storage Group is restored, the directory of the Storage Group
2287 \item It is possible to restore only a subset of the available log files,
2288 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2289 if a log file is missing from the sequence of log files
2290 \item Each database to be restored must be dismounted and marked as "Can be
2291 overwritten by restore"
2292 \item If an entire Storage Group is to be restored (eg all databases and
2293 logs in the Storage Group), then it is best to manually delete the
2294 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2295 as Exchange can get confused by stray log files lying around.
2298 \subsection{Restoring to the Recovery Storage Group}
2299 The concept of the Recovery Storage Group is well documented by
2301 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2302 but to briefly summarize...
2304 Microsoft Exchange allows the creation of an additional Storage Group
2305 called the Recovery Storage Group, which is used to restore an older
2306 copy of a database (e.g. before a mailbox was deleted) into without
2307 messing with the current live data. This is required as the Standard and
2308 Small Business Server versions of Exchange can not ordinarily have more
2309 than one Storage Group.
2311 To create the Recovery Storage Group, drill down to the Server in Exchange
2312 System Manager, right click, and select
2313 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2314 locations and click OK. On the Recovery Storage Group, right click and
2315 select {\bf "Add Database to Recover..."} and select the database you will
2318 Restore only the single database nominated as the database in the
2319 Recovery Storage Group. Exchange will redirect the restore to the
2320 Recovery Storage Group automatically.
2321 Then run the restore.
2323 \subsection{Restoring on Microsoft Server 2007}
2324 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2325 2007, and henc you use a new proceedure for recovering a single mail box.
2326 This procedure is ducomented by Microsoft at:
2327 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2328 and involves using the {\bf Restore-Mailbox} and {\bf
2329 Get-MailboxStatistics} shell commands.
2331 \subsection{Caveats}
2332 This plugin is still being developed, so you should consider it
2333 currently in BETA test, and thus use in a production environment
2334 should be done only after very careful testing.
2336 When doing a full backup, the Exchange database logs are truncated by
2337 Exchange as soon as the plugin has completed the backup. If the data
2338 never makes it to the backup medium (eg because of spooling) then the
2339 logs will still be truncated, but they will also not have been backed
2340 up. A solution to this is being worked on. You will have to schedule a
2341 new Full backup to ensure that your next backups will be usable.
2343 The "Enable Circular Logging" option cannot be enabled or the plugin
2346 Exchange insists that a successful Full backup must have taken place if
2347 an Incremental or Differential backup is desired, and the plugin will
2348 fail if this is not the case. If a restore is done, Exchange will
2349 require that a Full backup be done before an Incremental or Differential
2352 The plugin will most likely not work well if another backup application
2353 (eg NTBACKUP) is backing up the Exchange database, especially if the
2354 other backup application is truncating the log files.
2356 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2357 we recommend either carefully testing or that you avoid this option for
2360 The Exchange plugin is not called during processing the bconsole {\bf
2361 estimate} command, and so anything that would be backed up by the plugin
2362 will not be added to the estimate total that is displayed.
2365 \section{libdbi Framework}
2366 \index[general]{libdbi Framework}
2367 As a general guideline, Bacula has support for a few catalog database drivers
2368 (MySQL, PostgreSQL, SQLite)
2369 coded natively by the Bacula team. With the libdbi implementation, which is a
2370 Bacula driver that uses libdbi to access the catalog, we have an open field to
2371 use many different kinds database engines following the needs of users.
2373 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2374 implements a database-independent abstraction layer in C, similar to the
2375 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2376 leverage the power of multiple databases and multiple simultaneous database
2377 connections by using this framework.
2379 Currently the libdbi driver in Bacula project only supports the same drivers
2380 natively coded in Bacula. However the libdbi project has support for many
2381 others database engines. You can view the list at
2382 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2383 supported by Bacula, however, they must be tested properly by the Bacula team.
2385 Some of benefits of using libdbi are:
2387 \item The possibility to use proprietary databases engines in which your
2388 proprietary licenses prevent the Bacula team from developing the driver.
2389 \item The possibility to use the drivers written for the libdbi project.
2390 \item The possibility to use other database engines without recompiling Bacula
2391 to use them. Just change one line in bacula-dir.conf
2392 \item Abstract Database access, this is, unique point to code and profiling
2393 catalog database access.
2396 The following drivers have been tested:
2398 \item PostgreSQL, with and without batch insert
2399 \item Mysql, with and without batch insert
2404 In the future, we will test and approve to use others databases engines
2405 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2407 To compile Bacula to support libdbi we need to configure the code with the
2408 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2409 [database] is the database engine to be used with Bacula (of course we can
2410 change the driver in file bacula-dir.conf, see below). We must configure the
2411 access port of the database engine with the option --with-db-port, because the
2412 libdbi framework doesn't know the default access port of each database.
2414 The next phase is checking (or configuring) the bacula-dir.conf, example:
2418 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2419 dbname = regress; user = regress; password = ""
2423 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2424 mysql database. Currently the drivers supported by Bacula are: postgresql,
2425 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2427 The following limitations apply when Bacula is set to use the libdbi framework:
2428 - Not tested on the Win32 platform
2429 - A little performance is lost if comparing with native database driver.
2430 The reason is bound with the database driver provided by libdbi and the
2431 simple fact that one more layer of code was added.
2433 It is important to remember, when compiling Bacula with libdbi, the
2434 following packages are needed:
2436 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2437 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2440 You can download them and compile them on your system or install the packages
2441 from your OS distribution.
2443 \section{Console Command Additions and Enhancements}
2444 \index[general]{Console Additions}
2446 \subsection{Display Autochanger Content}
2447 \index[general]{StatusSlots}
2449 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2450 autochanger content.
2454 Slot | Volume Name | Status | Media Type | Pool |
2455 ------+---------------+----------+-------------------+------------|
2456 1 | 00001 | Append | DiskChangerMedia | Default |
2457 2 | 00002 | Append | DiskChangerMedia | Default |
2458 3*| 00003 | Append | DiskChangerMedia | Scratch |
2463 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2464 {\bf update slots} command to synchronize autochanger content with your
2467 \subsection{list joblog job=xxx or jobid=nnn}
2468 \index[general]{list joblog}
2469 A new list command has been added that allows you to list the contents
2470 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2471 or for a particular JobId. The {\bf llist} command will include a line with
2472 the time and date of the entry.
2474 Note for the catalog to have Job Log entries, you must have a directive
2481 In your Director's {\bf Messages} resource.
2483 \subsection{Use separator for multiple commands}
2484 \index[general]{Command Separator}
2485 When using bconsole with readline, you can set the command separator with
2486 \textbf{@separator} command to one
2487 of those characters to write commands who require multiple input in one line.
2489 !$%&'()*+,-/:;<>?[]^`{|}~
2492 \subsection{Deleting Volumes}
2493 The delete volume bconsole command has been modified to
2494 require an asterisk (*) in front of a MediaId otherwise the
2495 value you enter is a taken to be a Volume name. This is so that
2496 users may delete numeric Volume names. The previous Bacula versions
2497 assumed that all input that started with a number was a MediaId.
2499 This new behavior is indicated in the prompt if you read it
2502 \section{Bare Metal Recovery}
2503 The old bare metal recovery project is essentially dead. One
2504 of the main features of it was that it would build a recovery
2505 CD based on the kernel on your system. The problem was that
2506 every distribution has a different boot procedure and different
2507 scripts, and worse yet, the boot procedures and scripts change
2508 from one distribution to another. This meant that maintaining
2509 (keeping up with the changes) the rescue CD was too much work.
2511 To replace it, a new bare metal recovery USB boot stick has been developed
2512 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2513 boot from a USB key.
2517 \item Recovery can be done from within graphical environment.
2518 \item Recovery can be done in a shell.
2519 \item Ubuntu boots on a large number of Linux systems.
2520 \item The process of updating the system and adding new
2521 packages is not too difficult.
2522 \item The USB key can easily be upgraded to newer Ubuntu versions.
2523 \item The USB key has writable partitions for modifications to
2524 the OS and for modification to your home directory.
2525 \item You can add new files/directories to the USB key very easily.
2526 \item You can save the environment from multiple machines on
2528 \item Bacula Systems is funding its ongoing development.
2531 The disadvantages are:
2533 \item The USB key is usable but currently under development.
2534 \item Not everyone may be familiar with Ubuntu (no worse
2536 \item Some older OSes cannot be booted from USB. This can
2537 be resolved by first booting a Ubuntu LiveCD then plugging
2539 \item Currently the documentation is sketchy and not yet added
2540 to the main manual. See below ...
2543 The documentation and the code can be found in the {\bf rescue} package
2544 in the directory {\bf linux/usb}.
2546 \section{Miscellaneous}
2547 \index[general]{Misc New Features}
2549 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2550 \index[general]{Allow Mixed Priority}
2551 This directive is only implemented in version 2.5 and later. When
2552 set to {\bf yes} (default {\bf no}), this job may run even if lower
2553 priority jobs are already running. This means a high priority job
2554 will not have to wait for other jobs to finish before starting.
2555 The scheduler will only mix priorities when all running jobs have
2558 Note that only higher priority jobs will start early. Suppose the
2559 director will allow two concurrent jobs, and that two jobs with
2560 priority 10 are running, with two more in the queue. If a job with
2561 priority 5 is added to the queue, it will be run as soon as one of
2562 the running jobs finishes. However, new priority 10 jobs will not
2563 be run until the priority 5 job has finished.
2565 \subsection{Bootstrap File Directive -- FileRegex}
2566 \index[general]{Bootstrap File Directive}
2567 {\bf FileRegex} is a new command that can be added to the bootstrap
2568 (.bsr) file. The value is a regular expression. When specified, only
2569 matching filenames will be restored.
2571 During a restore, if all File records are pruned from the catalog
2572 for a Job, normally Bacula can restore only all files saved. That
2573 is there is no way using the catalog to select individual files.
2574 With this new feature, Bacula will ask if you want to specify a Regex
2575 expression for extracting only a part of the full backup.
2578 Building directory tree for JobId(s) 1,3 ...
2579 There were no files inserted into the tree, so file selection
2580 is not possible.Most likely your retention policy pruned the files
2582 Do you want to restore all the files? (yes\vb{}no): no
2584 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2585 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2588 \subsection{Bootstrap File Optimization Changes}
2589 In order to permit proper seeking on disk files, we have extended the bootstrap
2590 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2591 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2592 address range and end address range respectively. These two directives replace
2593 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2594 VolEndBlock} directives. Bootstrap files containing the old directives will
2595 still work, but will not properly take advantage of proper disk seeking, and
2596 may read completely to the end of a disk volume during a restore. With the new
2597 format (automatically generated by the new Director), restores will seek
2598 properly and stop reading the volume when all the files have been restored.
2600 \subsection{Solaris ZFS/NFSv4 ACLs}
2601 This is an upgrade of the previous Solaris ACL backup code
2602 to the new library format, which will backup both the old
2603 POSIX(UFS) ACLs as well as the ZFS ACLs.
2605 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2606 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2607 be used to transfer from UFS to ZFS filesystems.
2610 \subsection{Virtual Tape Emulation}
2611 \index[general]{Virtual Tape Emulation}
2612 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2613 the tape code but actually reading and writing to a disk file. Used with the
2614 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2615 and 700 slots. This feature is most useful in testing. It is enabled
2616 by using {\bf Device Type = vtape} in the Storage daemon's Device
2617 directive. This feature is only implemented on Linux machines and should not be
2618 used for production.
2620 \subsection{Bat Enhancements}
2621 \index[general]{Bat Enhancements}
2622 Bat (the Bacula Administration Tool) GUI program has been significantly
2623 enhanced and stabilized. In particular, there are new table based status
2624 commands; it can now be easily localized using Qt4 Linguist.
2626 The Bat communications protocol has been significantly enhanced to improve
2627 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2628 the Director you are using otherwise the communications protocol will not
2631 \subsection{RunScript Enhancements}
2632 \index[general]{RunScript Enhancements}
2633 The {\bf RunScript} resource has been enhanced to permit multiple
2634 commands per RunScript. Simply specify multiple {\bf Command} directives
2641 Command = "/bin/echo test"
2642 Command = "/bin/echo an other test"
2643 Command = "/bin/echo 3 commands in the same runscript"
2650 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2651 implemented, which runs the command after the Volume Shadow Copy has been made.
2653 Console commands can be specified within a RunScript by using:
2654 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2655 carefully tested and debugged and is known to easily crash the Director.
2656 We would appreciate feedback. Due to the recursive nature of this command, we
2657 may remove it before the final release.
2659 \subsection{Status Enhancements}
2660 \index[general]{Status Enhancements}
2661 The bconsole {\bf status dir} output has been enhanced to indicate
2662 Storage daemon job spooling and despooling activity.
2664 \subsection{Connect Timeout}
2665 \index[general]{Connect Timeout}
2666 The default connect timeout to the File
2667 daemon has been set to 3 minutes. Previously it was 30 minutes.
2669 \subsection{ftruncate for NFS Volumes}
2670 \index[general]{ftruncate for NFS Volumes}
2671 If you write to a Volume mounted by NFS (say on a local file server),
2672 in previous Bacula versions, when the Volume was recycled, it was not
2673 properly truncated because NFS does not implement ftruncate (file
2674 truncate). This is now corrected in the new version because we have
2675 written code (actually a kind user) that deletes and recreates the Volume,
2676 thus accomplishing the same thing as a truncate.
2678 \subsection{Support for Ubuntu}
2679 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2680 version of Linux, and thus now provides correct autostart routines.
2681 Since Ubuntu officially supports Bacula, you can also obtain any
2682 recent release of Bacula from the Ubuntu repositories.
2684 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2685 \index[general]{Recycle Pool}
2686 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2687 be placed (moved) when it is recycled. Without this directive, a Volume will
2688 remain in the same pool when it is recycled. With this directive, it can be
2689 moved automatically to any existing pool during a recycle. This directive is
2690 probably most useful when defined in the Scratch pool, so that volumes will
2691 be recycled back into the Scratch pool.
2693 \subsection{FD Version}
2694 \index[general]{FD Version}
2695 The File daemon to Director protocol now includes a version
2696 number, which although there is no visible change for users,
2697 will help us in future versions automatically determine
2698 if a File daemon is not compatible.
2700 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2701 \index[general]{Max Run Sched Time}
2702 The time specifies the maximum allowed time that a job may run, counted from
2703 when the job was scheduled. This can be useful to prevent jobs from running
2704 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2707 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2708 \index[general]{Max Wait Time}
2709 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2710 of checking the maximum allowed time that a job may block for a resource,
2711 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2712 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2713 their job depending on the level. Now, they have to use
2714 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2715 directives are now deprecated.
2717 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2718 \index[general]{Incremental Max Wait Time}
2719 \index[general]{Differential Max Wait Time}
2721 These directives have been deprecated in favor of
2722 \texttt{Incremental|Differential Max Run Time}.
2724 \subsection{Max Run Time directives}
2725 \index[general]{Max Run Time directives}
2726 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2727 maximum allowed time that a job can run depending on the level.
2729 \addcontentsline{lof}{figure}{Job time control directives}
2730 \includegraphics{\idir different_time.eps}
2732 \subsection{Statistics Enhancements}
2733 \index[general]{Statistics Enhancements}
2734 If you (or probably your boss) want to have statistics on your backups to
2735 provide some \textit{Service Level Agreement} indicators, you could use a few
2736 SQL queries on the Job table to report how many:
2740 \item jobs have been successful
2741 \item files have been backed up
2745 However, these statistics are accurate only if your job retention is greater
2746 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2747 be able to use them.
2749 Now, you can use the \textbf{update stats [days=num]} console command to fill
2750 the JobHistory table with new Job records. If you want to be sure to take in
2751 account only \textbf{good jobs}, ie if one of your important job has failed but
2752 you have fixed the problem and restarted it on time, you probably want to
2753 delete the first \textit{bad} job record and keep only the successful one. For
2754 that simply let your staff do the job, and update JobHistory table after two or
2755 three days depending on your organization using the \textbf{[days=num]} option.
2757 These statistics records aren't used for restoring, but mainly for
2758 capacity planning, billings, etc.
2760 The Bweb interface provides a statistics module that can use this feature. You
2761 can also use tools like Talend or extract information by yourself.
2763 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2764 the length of time that Bacula will keep statistics job records in the Catalog
2765 database after the Job End time. (In \texttt{JobHistory} table) When this time
2766 period expires, and if user runs \texttt{prune stats} command, Bacula will
2767 prune (remove) Job records that are older than the specified period.
2769 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2770 job to maintain statistics.
2773 Name = BackupCatalog
2776 Console = "update stats days=3"
2777 Console = "prune stats yes"
2784 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2785 \index[general]{ScratchPool}
2786 This directive permits to specify a specific \textsl{Scratch} pool for the
2787 current pool. This is useful when using multiple storage sharing the same
2788 mediatype or when you want to dedicate volumes to a particular set of pool.
2790 \subsection{Enhanced Attribute Despooling}
2791 \index[general]{Attribute Despooling}
2792 If the storage daemon and the Director are on the same machine, the spool file
2793 that contains attributes is read directly by the Director instead of being
2794 transmitted across the network. That should reduce load and speedup insertion.
2796 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2797 \index[general]{SpoolSize}
2798 A new Job directive permits to specify the spool size per job. This is used
2799 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2801 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2802 \index[general]{MaximumConsoleConnections}
2803 A new director directive permits to specify the maximum number of Console
2804 Connections that could run concurrently. The default is set to 20, but you may
2805 set it to a larger number.
2807 \subsection{VerId = \lt{}string\gt{}}
2808 \index[general]{VerId}
2809 A new director directive permits to specify a personnal identifier that will be
2810 displayed in the \texttt{version} command.
2812 \subsection{dbcheck enhancements}
2813 \index[general]{dbcheck enhancements}
2814 If you are using Mysql, dbcheck will now ask you if you want to create
2815 temporary indexes to speed up orphaned Path and Filename elimination.
2817 A new \texttt{-B} option allows you to print catalog information in a simple
2818 text based format. This is useful to backup it in a secure way.
2833 You can now specify the database connection port in the command line.
2835 \subsection{{-}{-}docdir configure option}
2836 \index[general]{{-}{-}docdir configure option}
2837 You can use {-}{-}docdir= on the ./configure command to
2838 specify the directory where you want Bacula to install the
2839 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2840 {\bf /usr/share/doc/bacula}.
2842 \subsection{{-}{-}htmldir configure option}
2843 \index[general]{{-}{-}htmldir configure option}
2844 You can use {-}{-}htmldir= on the ./configure command to
2845 specify the directory where you want Bacula to install the bat html help
2846 files. The default is {\bf /usr/share/doc/bacula/html}
2848 \subsection{{-}{-}with-plugindir configure option}
2849 \index[general]{{-}{-}plugindir configure option}
2850 You can use {-}{-}plugindir= on the ./configure command to
2851 specify the directory where you want Bacula to install
2852 the plugins (currently only bpipe-fd). The default is