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{Ability to Verify any specified Job}
7 You now have the ability to tell Bacula which Job should verify instead of
8 automatically verify just the last one.
10 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
12 To verify a given job, just specify the Job jobid in argument when starting the
15 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
18 Level: VolumeToCatalog
21 Pool: Default (From Job resource)
22 Storage: File (From Job resource)
23 Verify Job: VerifyVol.2010-09-08_14.17.17_03
24 Verify List: /tmp/regress/working/VerifyVol.bsr
25 When: 2010-09-08 14:17:31
27 OK to run? (yes/mod/no):
30 \section{Additions to the Plugin API}
31 The bfuncs structure has been extended to include a number of
35 The bFuncs structure defines the callback entry points within Bacula
36 that the plugin can use register events, get Bacula values, set
37 Bacula values, and send messages to the Job output or debug output.
39 The exact definition as of this writing is:
41 typedef struct s_baculaFuncs {
44 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
45 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
46 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
47 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
48 int type, utime_t mtime, const char *fmt, ...);
49 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
50 int level, const char *fmt, ...);
51 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
53 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
55 /* New functions follow */
56 bRC (*AddExclude)(bpContext *ctx, const char *file);
57 bRC (*AddInclude)(bpContext *ctx, const char *file);
58 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
59 bRC (*AddRegexToInclude)(bpContext *ctx, const char *item, int type);
60 bRC (*AddWildToInclude)(bpContext *ctx, const char *item, int type);
66 \item [AddExclude] can be called to exclude a file. The file
67 string passed may include wildcards that will be interpreted by
68 the {\bf fnmatch} subroutine. This function can be called
69 multiple times, and each time the file specified will be added
70 to the list of files to be excluded. Note, this function only
71 permits adding excludes of specific file or directory names,
72 or files matched by the rather simple fnmatch mechanism.
73 See below for information on doing wild-card and regex excludes.
75 \item [NewInclude] can be called to create a new Include block. This
76 block will be added before any user defined Include blocks. This
77 function can be called multiple times, but each time, it will create
78 a new Include section (not normally needed). This function should
79 be called only if you want to add an entirely new Include block.
81 \item [AddInclude] can be called to add new files/directories to
82 be included. They are added to the current Include block. If
83 NewInclude has not been included, the current Include block is
84 the last one that the user created. This function
85 should be used only if you want to add totally new files/directories
86 to be included in the backup.
88 \item [NewOptions] adds a new Options block to the current Include
89 in front of any other Options blocks. This permits the plugin to
90 add exclude directives (wild-cards and regexes) in front of the
91 user Options, and thus prevent certain files from being backed up.
92 This can be useful if the plugin backs up files, and they should
93 not be also backed up by the main Bacula code. This function
94 may be called multiple times, and each time, it creates a new
95 prepended Options block. Note: normally you want to call this
96 entry point prior to calling AddOptions, AddRegex, or AddWild.
98 \item [AddOptions] allows the plugin it set options in
99 the current Options block, which is normally created with the
100 NewOptions call just prior to adding Include Options.
101 The permitted options are passed as a character string, where
102 each character has a specific meaning as defined below:
105 \item [a] always replace files (default).
106 \item [e] exclude rather than include.
107 \item [h] no recursion into subdirectories.
108 \item [H] do not handle hard links.
109 \item [i] ignore case in wildcard and regex matches.
110 \item [M] compute an MD5 sum.
111 \item [p] use a portable data format on Windows (not recommended).
112 \item [R] backup resource forks and Findr Info.
113 \item [r] read from a fifo
114 \item [S1] compute an SHA1 sum.
115 \item [S2] compute an SHA256 sum.
116 \item [S3] comput an SHA512 sum.
117 \item [s] handle sparse files.
118 \item [m] use st\_mtime only for file differences.
119 \item [k] restore the st\_atime after accessing a file.
120 \item [A] enable ACL backup.
121 \item [Vxxx:] specify verify options. Must terminate with :
122 \item [Cxxx:] specify accurate options. Must terminate with :
123 \item [Jxxx:] specify base job Options. Must terminate with :
124 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
126 \item [Zn] specify gzip compression level n.
127 \item [K] do not use st\_atime in backup decision.
128 \item [c] check if file changed during backup.
129 \item [N] honor no dump flag.
130 \item [X] enable backup of extended attributes.
133 \item [AddRegex] adds a regex expression to the current Options block.
134 The fillowing options are permitted:
136 \item [ ] (a blank) regex applies to whole path and filename.
137 \item [F] regex applies only to the filename (directory or path stripped).
138 \item [D] regex applies only to the directory (path) part of the name.
141 \item [AddWild] adds a wildcard expression to the current Options block.
142 The fillowing options are permitted:
144 \item [ ] (a blank) regex applies to whole path and filename.
145 \item [F] regex applies only to the filename (directory or path stripped).
146 \item [D] regex applies only to the directory (path) part of the name.
152 \subsection{Bacula events}
153 The list of events has been extended to include:
159 bEventStartBackupJob = 3,
160 bEventEndBackupJob = 4,
161 bEventStartRestoreJob = 5,
162 bEventEndRestoreJob = 6,
163 bEventStartVerifyJob = 7,
164 bEventEndVerifyJob = 8,
165 bEventBackupCommand = 9,
166 bEventRestoreCommand = 10,
171 bEventCancelCommand = 13,
172 bEventVssBackupAddComponents = 14,
173 bEventVssRestoreLoadComponentMetadata = 15,
174 bEventVssRestoreSetComponentsSelected = 16,
175 bEventRestoreObject = 17,
176 bEventEndFileSet = 18
182 \item [bEventCancelCommand] is called whenever the currently
183 running Job is cancelled */
185 \item [bEventVssBackupAddComponents]
194 \chapter{New Features in 5.0.1}
196 This chapter presents the new features that are in the released Bacula version
197 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
198 the onging development process.
200 \section{Truncate Volume after Purge}
201 \label{sec:actiononpurge}
203 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
204 the volume when it is purged with the new command \texttt{purge volume
205 action}. It is useful to prevent disk based volumes from consuming too much
211 Action On Purge = Truncate
216 As usual you can also set this property with the \texttt{update volume} command
218 *update volume=xxx ActionOnPurge=Truncate
219 *update volume=xxx actiononpurge=None
222 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
223 following command in interactive mode or in a RunScript as shown after:
225 *purge volume action=truncate storage=File allpools
226 # or by default, action=all
227 *purge volume action storage=File pool=Default
230 This is possible to specify the volume name, the media type, the pool, the
231 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
232 idle when you decide to run this command.
241 Console = "purge volume action=all allpools storage=File"
246 \textbf{Important note}: This feature doesn't work as
247 expected in version 5.0.0. Please do not use it before version 5.0.1.
249 \section{Allow Higher Duplicates}
250 This directive did not work correctly and has been depreciated
251 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
252 file as it will be removed in a future rlease.
254 \section{Cancel Lower Level Duplicates}
255 This directive was added in Bacula version 5.0.1. It compares the
256 level of a new backup job to old jobs of the same name, if any,
257 and will kill the job which has a lower level than the other one.
258 If the levels are the same (i.e. both are Full backups), then
259 nothing is done and the other Cancel XXX Duplicate directives
262 \chapter{New Features in 5.0.0}
264 \section{Maximum Concurent Jobs for Devices}
265 \label{sec:maximumconcurentjobdevice}
267 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
268 Daemon configuration permits setting the maximum number of Jobs that can
269 run concurrently on a specified Device. Using this directive, it is
270 possible to have different Jobs using multiple drives, because when the
271 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
272 Jobs on any other available compatible drive. This facilitates writing to
273 multiple drives with multiple Jobs that all use the same Pool.
275 This project was funded by Bacula Systems.
277 \section{Restore from Multiple Storage Daemons}
278 \index[general]{Restore}
280 Previously, you were able to restore from multiple devices in a single Storage
281 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
282 example, if your full backup runs on a Storage Daemon with an autochanger, and
283 your incremental jobs use another Storage Daemon with lots of disks, Bacula
284 will switch automatically from one Storage Daemon to an other within the same
287 You must upgrade your File Daemon to version 3.1.3 or greater to use this
290 This project was funded by Bacula Systems with the help of Equiinet.
292 \section{File Deduplication using Base Jobs}
293 A base job is sort of like a Full save except that you will want the FileSet to
294 contain only files that are unlikely to change in the future (i.e. a snapshot
295 of most of your system after installing it). After the base job has been run,
296 when you are doing a Full save, you specify one or more Base jobs to be used.
297 All files that have been backed up in the Base job/jobs but not modified will
298 then be excluded from the backup. During a restore, the Base jobs will be
299 automatically pulled in where necessary.
301 This is something none of the competition does, as far as we know (except
302 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
303 win for the user, it makes Bacula stand out as offering a unique optimization
304 that immediately saves time and money. Basically, imagine that you have 100
305 nearly identical Windows or Linux machine containing the OS and user files.
306 Now for the OS part, a Base job will be backed up once, and rather than making
307 100 copies of the OS, there will be only one. If one or more of the systems
308 have some files updated, no problem, they will be automatically restored.
310 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
311 files that will be used during Full backup as base.
322 Base = BackupZog4, BackupLinux
328 In this example, the job \texttt{BackupZog4} will use the most recent version
329 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
330 jobs. Base jobs should have run with \texttt{level=Base} to be used.
332 By default, Bacula will compare permissions bits, user and group fields,
333 modification time, size and the checksum of the file to choose between the
334 current backup and the BaseJob file list. You can change this behavior with the
335 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
336 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
352 \textbf{Important note}: The current implementation doesn't permit to scan
353 volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
355 This project was funded by Bacula Systems.
357 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
358 \index[dir]{AllowCompression}
360 This new directive may be added to Storage resource within the Director's
361 configuration to allow users to selectively disable the client compression for
362 any job which writes to this storage resource.
368 Address = ultrium-tape
369 Password = storage_password # Password for Storage Daemon
372 AllowCompression = No # Tape drive has hardware compression
375 The above example would cause any jobs running with the UltriumTape storage
376 resource to run without compression from the client file daemons. This
377 effectively overrides any compression settings defined at the FileSet level.
379 This feature is probably most useful if you have a tape drive which supports
380 hardware compression. By setting the \texttt{AllowCompression = No} directive
381 for your tape drive storage resource, you can avoid additional load on the file
382 daemon and possibly speed up tape backups.
384 This project was funded by Collaborative Fusion, Inc.
386 \section{Accurate Fileset Options}
387 \label{sec:accuratefileset}
389 In previous versions, the accurate code used the file creation and modification
390 times to determine if a file was modified or not. Now you can specify which
391 attributes to use (time, size, checksum, permission, owner, group, \dots),
392 similar to the Verify options.
408 \item {\bf i} compare the inodes
409 \item {\bf p} compare the permission bits
410 \item {\bf n} compare the number of links
411 \item {\bf u} compare the user id
412 \item {\bf g} compare the group id
413 \item {\bf s} compare the size
414 \item {\bf a} compare the access time
415 \item {\bf m} compare the modification time (st\_mtime)
416 \item {\bf c} compare the change time (st\_ctime)
417 \item {\bf d} report file size decreases
418 \item {\bf 5} compare the MD5 signature
419 \item {\bf 1} compare the SHA1 signature
422 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
423 the File Daemon will have to read all files even if they normally would not
424 be saved. This increases the I/O load, but also the accuracy of the
425 deduplication. By default, Bacula will check modification/creation time
428 This project was funded by Bacula Systems.
430 \section{Tab-completion for Bconsole}
431 \label{sec:tabcompletion}
433 If you build \texttt{bconsole} with readline support, you will be able to use
434 the new auto-completion mode. This mode supports all commands, gives help
435 inside command, and lists resources when required. It works also in the restore
438 To use this feature, you should have readline development package loaded on
439 your system, and use the following option in configure.
441 ./configure --with-readline=/usr/include/readline --disable-conio ...
444 The new bconsole won't be able to tab-complete with older directors.
446 This project was funded by Bacula Systems.
448 \section{Pool File and Job Retention}
449 \label{sec:poolfilejobretention}
451 We added two new Pool directives, \texttt{FileRetention} and
452 \texttt{JobRetention}, that take precedence over Client directives of the same
453 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
454 example, you can decide to increase Retention times for Archive or OffSite Pool.
456 It seems obvious to us, but apparently not to some users, that given the
457 definition above that the Pool File and Job Retention periods is a global
458 override for the normal Client based prunning, which means that when the
459 Job is prunned, the prunning will apply globally to that particular Job.
461 Currently, there is a bug in the implementation that causes any Pool
462 retention periods specified to apply to {\bf all} Pools for that
463 particular Client. Thus we suggest that you avoid using these two
464 directives until this implementation problem is corrected.
466 \section{Read-only File Daemon using capabilities}
467 \label{sec:fdreadonly}
468 This feature implements support of keeping \textbf{ReadAll} capabilities after
469 UID/GID switch, this allows FD to keep root read but drop write permission.
471 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
472 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
475 root@localhost:~# bacula-fd -k -u nobody -g nobody
478 The code for this feature was contributed by our friends at AltLinux.
483 To help developers of restore GUI interfaces, we have added new \textsl{dot
484 commands} that permit browsing the catalog in a very simple way.
487 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
488 the Bvfs cache in the catalog. You need to run it before any access to the
491 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
492 will list all directories in the specified \texttt{path} or
493 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
494 encoding of path/filenames.
496 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
497 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
498 \texttt{pathid} avoids problems with character encoding.
501 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
502 data that will be displayed.
505 * .bvfs_update jobid=1,2
507 * .bvfs_lsdir path=/ jobid=1,2
510 This project was funded by Bacula Systems.
512 \section{Testing your Tape Drive}
513 \label{sec:btapespeed}
515 To determine the best configuration of your tape drive, you can run the new
516 \texttt{speed} command available in the \texttt{btape} program.
518 This command can have the following arguments:
520 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
521 (between 1 and 5GB). This counter is in GB.
522 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
523 of data should be greater than your memory ($file\_size*nb\_file$).
524 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
526 \item[\texttt{skip\_random}] This flag permits to skip tests with random
528 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
529 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
534 *speed file_size=3 skip_raw
535 btape.c:1078 Test with zero data and bacula block structure.
536 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
537 ++++++++++++++++++++++++++++++++++++++++++
538 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
539 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
541 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
543 btape.c:1090 Test with random data, should give the minimum throughput.
544 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
545 +++++++++++++++++++++++++++++++++++++++++++
546 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
547 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
548 +++++++++++++++++++++++++++++++++++++++++++
550 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
554 When using compression, the random test will give your the minimum throughput
555 of your drive . The test using constant string will give you the maximum speed
556 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
558 You can change the block size in the Storage Daemon configuration file.
560 \section{New {\bf Block Checksum} Device Directive}
561 You may now turn off the Block Checksum (CRC32) code
562 that Bacula uses when writing blocks to a Volume. This is
569 doing so can reduce the Storage daemon CPU usage slightly. It
570 will also permit Bacula to read a Volume that has corrupted data.
572 The default is {\bf yes} -- i.e. the checksum is computed on write
575 We do not recommend to turn this off particularly on older tape
576 drives or for disk Volumes where doing so may allow corrupted data
579 \section{New Bat Features}
581 Those new features were funded by Bacula Systems.
583 \subsection{Media List View}
585 By clicking on ``Media'', you can see the list of all your volumes. You will be
586 able to filter by Pool, Media Type, Location,\dots And sort the result directly
587 in the table. The old ``Media'' view is now known as ``Pool''.
590 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
591 \label{fig:mediaview}
595 \subsection{Media Information View}
597 By double-clicking on a volume (on the Media list, in the Autochanger content
598 or in the Job information panel), you can access a detailed overview of your
599 Volume. (cf \ref{fig:mediainfo}.)
602 \includegraphics[width=13cm]{\idir bat11.eps}
603 \caption{Media information}
604 \label{fig:mediainfo}
607 \subsection{Job Information View}
609 By double-clicking on a Job record (on the Job run list or in the Media
610 information panel), you can access a detailed overview of your Job. (cf
614 \includegraphics[width=13cm]{\idir bat12.eps}
615 \caption{Job information}
619 \subsection{Autochanger Content View}
621 By double-clicking on a Storage record (on the Storage list panel), you can
622 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
625 \includegraphics[width=13cm]{\idir bat13.eps}
626 \caption{Autochanger content}
627 \label{fig:achcontent}
630 To use this feature, you need to use the latest mtx-changer script
631 version. (With new \texttt{listall} and \texttt{transfer} commands)
633 \section{Bat on Windows}
634 We have ported {\bf bat} to Windows and it is now installed
635 by default when the installer is run. It works quite well
636 on Win32, but has not had a lot of testing there, so your
637 feedback would be welcome. Unfortunately, eventhough it is
638 installed by default, it does not yet work on 64 bit Windows
641 \section{New Win32 Installer}
642 The Win32 installer has been modified in several very important
645 \item You must deinstall any current version of the
646 Win32 File daemon before upgrading to the new one.
647 If you forget to do so, the new installation will fail.
648 To correct this failure, you must manually shutdown
649 and deinstall the old File daemon.
650 \item All files (other than menu links) are installed
651 in {\bf c:/Program Files/Bacula}.
652 \item The installer no longer sets this
653 file to require administrator privileges by default. If you want
654 to do so, please do it manually using the {\bf cacls} program.
657 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
659 \item The server daemons (Director and Storage daemon) are
660 no longer included in the Windows installer. If you want the
661 Windows servers, you will either need to build them yourself (note
662 they have not been ported to 64 bits), or you can contact
663 Bacula Systems about this.
666 \section{Win64 Installer}
667 We have corrected a number of problems that required manual
668 editing of the conf files. In most cases, it should now
669 install and work. {\bf bat} is by default installed in
670 {\bf c:/Program Files/Bacula/bin32} rather than
671 {\bf c:/Program Files/Bacula} as is the case with the 32
672 bit Windows installer.
674 \section{Linux Bare Metal Recovery USB Key}
675 We have made a number of significant improvements in the
676 Bare Metal Recovery USB key. Please see the README files
677 it the {\bf rescue} release for more details.
679 We are working on an equivalent USB key for Windows bare
680 metal recovery, but it will take some time to develop it (best
681 estimate 3Q2010 or 4Q2010)
684 \section{bconsole Timeout Option}
685 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
686 for commands. This is useful with GUI programs that use {\bf bconsole}
687 to interface to the Director.
689 \section{Important Changes}
690 \label{sec:importantchanges}
693 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
694 to the same Pool. The Storage daemon ensures that you do not read and
695 write to the same Volume.
696 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
698 \item Virtually all the features of {\bf mtx-changer} have
699 now been parameterized, which allows you to configure
700 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
701 that contains variables that you can set to configure mtx-changer.
702 This configuration file will not be overwritten during upgrades.
703 We encourage you to submit any changes
704 that are made to mtx-changer and to parameterize it all in
705 mtx-changer.conf so that all configuration will be done by
706 changing only mtx-changer.conf.
707 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
708 and \texttt{transfer}. Please configure them as appropriate
710 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
711 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
712 password. If you want to use the new script, you will need to
713 manually change the \texttt{BackupCatalog} Job definition.
714 \item The \texttt{bconsole} \texttt{help} command now accepts
715 an argument, which if provided produces information on that
716 command (ex: \texttt{help run}).
720 \subsubsection*{Truncate volume after purge}
722 Note that the Truncate Volume after purge feature doesn't work as expected
723 in 5.0.0 version. Please, don't use it before version 5.0.1.
725 \subsection{Custom Catalog queries}
727 If you wish to add specialized commands that list the contents of the catalog,
728 you can do so by adding them to the \texttt{query.sql} file. This
729 \texttt{query.sql} file is now empty by default. The file
730 \texttt{examples/sample-query.sql} has an a number of sample commands
731 you might find useful.
733 \subsection{Deprecated parts}
735 The following items have been \textbf{deprecated} for a long time, and are now
736 removed from the code.
739 \item Support for SQLite 2
742 \section{Misc Changes}
743 \label{sec:miscchanges}
746 \item Updated Nagios check\_bacula
747 \item Updated man files
748 \item Added OSX package generation script in platforms/darwin
749 \item Added Spanish and Ukrainian Bacula translations
750 \item Enable/disable command shows only Jobs that can change
751 \item Added \texttt{show disabled} command to show disabled Jobs
752 \item Many ACL improvements
753 \item Added Level to FD status Job output
754 \item Begin Ingres DB driver (not yet working)
755 \item Split RedHat spec files into bacula, bat, mtx, and docs
756 \item Reorganized the manuals (fewer separate manuals)
757 \item Added lock/unlock order protection in lock manager
758 \item Allow 64 bit sizes for a number of variables
759 \item Fixed several deadlocks or potential race conditions in the SD
762 \chapter{Released Version 3.0.3 and 3.0.3a}
764 There are no new features in version 3.0.3. This version simply fixes a
765 number of bugs found in version 3.0.2 during the onging development
768 \chapter{New Features in Released Version 3.0.2}
770 This chapter presents the new features added to the
771 Released Bacula Version 3.0.2.
773 \section{Full Restore from a Given JobId}
774 \index[general]{Restore menu}
776 This feature allows selecting a single JobId and having Bacula
777 automatically select all the other jobs that comprise a full backup up to
778 and including the selected date (through JobId).
780 Assume we start with the following jobs:
782 +-------+--------------+---------------------+-------+----------+------------+
783 | jobid | client | starttime | level | jobfiles | jobbytes |
784 +-------+--------------+---------------------+-------+----------+------------
785 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
786 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
787 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
788 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
789 +-------+--------------+---------------------+-------+----------+------------+
792 Below is an example of this new feature (which is number 12 in the
797 To select the JobIds, you have the following choices:
798 1: List last 20 Jobs run
799 2: List Jobs where a given File is saved
801 12: Select full restore to a specified Job date
804 Select item: (1-13): 12
805 Enter JobId to get the state to restore: 5
806 Selecting jobs to build the Full state at 2009-07-15 11:45:45
807 You have selected the following JobIds: 1,3,5
809 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
810 1,444 files inserted into the tree.
813 This project was funded by Bacula Systems.
815 \section{Source Address}
816 \index[general]{Source Address}
818 A feature has been added which allows the administrator to specify the address
819 from which the Director and File daemons will establish connections. This
820 may be used to simplify system configuration overhead when working in complex
821 networks utilizing multi-homing and policy-routing.
823 To accomplish this, two new configuration directives have been implemented:
826 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
830 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
834 Simply adding specific host routes on the OS
835 would have an undesirable side-effect: any
836 application trying to contact the destination host would be forced to use the
837 more specific route possibly diverting management traffic onto a backup VLAN.
838 Instead of adding host routes for each client connected to a multi-homed backup
839 server (for example where there are management and backup VLANs), one can
840 use the new directives to specify a specific source address at the application
843 Additionally, this allows the simplification and abstraction of firewall rules
844 when dealing with a Hot-Standby director or storage daemon configuration. The
845 Hot-standby pair may share a CARP address, which connections must be sourced
846 from, while system services listen and act from the unique interface addresses.
848 This project was funded by Collaborative Fusion, Inc.
850 \section{Show volume availability when doing restore}
852 When doing a restore the selection dialog ends by displaying this
856 The job will require the following
857 Volume(s) Storage(s) SD Device(s)
858 ===========================================================================
869 Volumes marked with ``*'' are online (in the autochanger).
872 This should help speed up large restores by minimizing the time spent
873 waiting for the operator to discover that he must change tapes in the library.
875 This project was funded by Bacula Systems.
877 \section{Accurate estimate command}
879 The \texttt{estimate} command can now use the accurate code to detect changes
880 and give a better estimation.
882 You can set the accurate behavior on the command line by using
883 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
886 * estimate listing accurate=yes level=incremental job=BackupJob
889 This project was funded by Bacula Systems.
891 \chapter{New Features in 3.0.0}
892 \label{NewFeaturesChapter}
893 \index[general]{New Features}
895 This chapter presents the new features added to the development 2.5.x
896 versions to be released as Bacula version 3.0.0 sometime in April 2009.
898 \section{Accurate Backup}
899 \index[general]{Accurate Backup}
901 As with most other backup programs, by default Bacula decides what files to
902 backup for Incremental and Differental backup by comparing the change
903 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
904 backup completed. If one of those two times is later than the last backup
905 time, then the file will be backed up. This does not, however, permit tracking
906 what files have been deleted and will miss any file with an old time that may
907 have been restored to or moved onto the client filesystem.
909 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
910 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
911 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
912 backup, there is no difference, but for {\bf Differential} and {\bf
913 Incremental} backups, the Director will send a list of all previous files
914 backed up, and the File daemon will use that list to determine if any new files
915 have been added or or moved and if any files have been deleted. This allows
916 Bacula to make an accurate backup of your system to that point in time so that
917 if you do a restore, it will restore your system exactly.
920 about using Accurate backup is that it requires more resources (CPU and memory)
921 on both the Director and the Client machines to create the list of previous
922 files backed up, to send that list to the File daemon, for the File daemon to
923 keep the list (possibly very big) in memory, and for the File daemon to do
924 comparisons between every file in the FileSet and the list. In particular,
925 if your client has lots of files (more than a few million), you will need
926 lots of memory on the client machine.
928 Accurate must not be enabled when backing up with a plugin that is not
929 specially designed to work with Accurate. If you enable it, your restores
930 will probably not work correctly.
932 This project was funded by Bacula Systems.
937 \index[general]{Copy Jobs}
939 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
940 existing Migration feature with the exception that the Job that is copied is
941 left unchanged. This essentially creates two identical copies of the same
942 backup. However, the copy is treated as a copy rather than a backup job, and
943 hence is not directly available for restore. The {\bf restore} command lists
944 copy jobs and allows selection of copies by using \texttt{jobid=}
945 option. If the keyword {\bf copies} is present on the command line, Bacula will
946 display the list of all copies for selected jobs.
951 These JobIds have copies as follows:
952 +-------+------------------------------------+-----------+------------------+
953 | JobId | Job | CopyJobId | MediaType |
954 +-------+------------------------------------+-----------+------------------+
955 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
956 +-------+------------------------------------+-----------+------------------+
957 +-------+-------+----------+----------+---------------------+------------------+
958 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
959 +-------+-------+----------+----------+---------------------+------------------+
960 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
961 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
962 +-------+-------+----------+----------+---------------------+------------------+
963 You have selected the following JobIds: 19,2
965 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
966 5,611 files inserted into the tree.
971 The Copy Job runs without using the File daemon by copying the data from the
972 old backup Volume to a different Volume in a different Pool. See the Migration
973 documentation for additional details. For copy Jobs there is a new selection
974 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
975 not already copied to another Pool.
977 As with Migration, the Client, Volume, Job, or SQL query, are
978 other possible ways of selecting the Jobs to be copied. Selection
979 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
980 work, but are probably more suited for Migration Jobs.
982 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
983 it will promote the Copy to a \textsl{real} backup job and will make it available for
984 automatic restore. If more than one Copy is available, it will promote the copy
985 with the smallest JobId.
987 A nice solution which can be built with the new Copy feature is often
988 called disk-to-disk-to-tape backup (DTDTT). A sample config could
989 look something like the one below:
993 Name = FullBackupsVirtualPool
995 Purge Oldest Volume = Yes
997 NextPool = FullBackupsTapePool
1001 Name = FullBackupsTapePool
1005 Volume Retention = 365 days
1006 Storage = superloader
1010 # Fake fileset for copy jobs
1022 # Fake client for copy jobs
1032 # Default template for a CopyDiskToTape Job
1035 Name = CopyDiskToTape
1037 Messages = StandardCopy
1040 Selection Type = PoolUncopiedJobs
1041 Maximum Concurrent Jobs = 10
1043 Allow Duplicate Jobs = Yes
1044 Cancel Queued Duplicates = No
1045 Cancel Running Duplicates = No
1050 Name = DaySchedule7:00
1051 Run = Level=Full daily at 7:00
1055 Name = CopyDiskToTapeFullBackups
1057 Schedule = DaySchedule7:00
1058 Pool = FullBackupsVirtualPool
1059 JobDefs = CopyDiskToTape
1063 The example above had 2 pool which are copied using the PoolUncopiedJobs
1064 selection criteria. Normal Full backups go to the Virtual pool and are copied
1065 to the Tape pool the next morning.
1067 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1072 +-------+------------------------------------+-----------+------------------+
1073 | JobId | Job | CopyJobId | MediaType |
1074 +-------+------------------------------------+-----------+------------------+
1075 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1076 +-------+------------------------------------+-----------+------------------+
1079 \section{ACL Updates}
1080 \index[general]{ACL Updates}
1081 The whole ACL code had been overhauled and in this version each platforms has
1082 different streams for each type of acl available on such an platform. As ACLs
1083 between platforms tend to be not that portable (most implement POSIX acls but
1084 some use an other draft or a completely different format) we currently only
1085 allow certain platform specific ACL streams to be decoded and restored on the
1086 same platform that they were created on. The old code allowed to restore ACL
1087 cross platform but the comments already mention that not being to wise. For
1088 backward compatability the new code will accept the two old ACL streams and
1089 handle those with the platform specific handler. But for all new backups it
1090 will save the ACLs using the new streams.
1092 Currently the following platforms support ACLs:
1096 \item {\bf Darwin/OSX}
1105 Currently we support the following ACL types (these ACL streams use a reserved
1106 part of the stream numbers):
1109 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1111 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1112 string representation from acl\_to\_text (POSIX acl)
1113 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1114 string representation from acl\_to\_text (POSIX acl) for default acls.
1115 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1116 string representation from acl\_to\_text (POSIX acl) for access acls.
1117 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1118 string representation from acltostr (POSIX acl)
1119 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1120 representation from acl\_to\_text (POSIX acl) for default acls.
1121 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1122 representation from acl\_to\_text (POSIX acl) for access acls.
1123 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1124 string representation from acl\_to\_text (POSIX acl) for default acls.
1125 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1126 representation from acl\_to\_text (POSIX acl) for access acls.
1127 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1128 string representation from acl\_to\_text (POSIX acl) for default acls.
1129 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1130 string representation from acl\_to\_text (POSIX acl) for default acls.
1131 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1132 representation from acl\_to\_text (POSIX acl) for access acls.
1133 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1134 string representation from acltotext or acl\_totext (POSIX acl)
1135 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1136 representation from from acl\_totext (NFSv4 or ZFS acl)
1139 In future versions we might support conversion functions from one type of acl
1140 into an other for types that are either the same or easily convertable. For now
1141 the streams are seperate and restoring them on a platform that doesn't
1142 recognize them will give you a warning.
1144 \section{Extended Attributes}
1145 \index[general]{Extended Attributes}
1146 Something that was on the project list for some time is now implemented for
1147 platforms that support a similar kind of interface. Its the support for backup
1148 and restore of so called extended attributes. As extended attributes are so
1149 platform specific these attributes are saved in seperate streams for each
1150 platform. Restores of the extended attributes can only be performed on the
1151 same platform the backup was done. There is support for all types of extended
1152 attributes, but restoring from one type of filesystem onto an other type of
1153 filesystem on the same platform may lead to supprises. As extended attributes
1154 can contain any type of data they are stored as a series of so called
1155 value-pairs. This data must be seen as mostly binary and is stored as such.
1156 As security labels from selinux are also extended attributes this option also
1157 stores those labels and no specific code is enabled for handling selinux
1160 Currently the following platforms support extended attributes:
1162 \item {\bf Darwin/OSX}
1168 On linux acls are also extended attributes, as such when you enable ACLs on a
1169 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1170 and not the same exteneded attribute.
1172 To enable the backup of extended attributes please add the following to your
1187 \section{Shared objects}
1188 \index[general]{Shared objects}
1189 A default build of Bacula will now create the libraries as shared objects
1190 (.so) rather than static libraries as was previously the case.
1191 The shared libraries are built using {\bf libtool} so it should be quite
1194 An important advantage of using shared objects is that on a machine with the
1195 Directory, File daemon, the Storage daemon, and a console, you will have only
1196 one copy of the code in memory rather than four copies. Also the total size of
1197 the binary release is smaller since the library code appears only once rather
1198 than once for every program that uses it; this results in significant reduction
1199 in the size of the binaries particularly for the utility tools.
1201 In order for the system loader to find the shared objects when loading the
1202 Bacula binaries, the Bacula shared objects must either be in a shared object
1203 directory known to the loader (typically /usr/lib) or they must be in the
1204 directory that may be specified on the {\bf ./configure} line using the {\bf
1205 {-}{-}libdir} option as:
1208 ./configure --libdir=/full-path/dir
1211 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1212 no need to modify your loader configuration provided that
1213 the shared objects are installed in that directory (Bacula
1214 does this with the make install command). The shared objects
1215 that Bacula references are:
1224 These files are symbolically linked to the real shared object file,
1225 which has a version number to permit running multiple versions of
1226 the libraries if desired (not normally the case).
1228 If you have problems with libtool or you wish to use the old
1229 way of building static libraries, or you want to build a static
1230 version of Bacula you may disable
1231 libtool on the configure command line with:
1234 ./configure --disable-libtool
1238 \section{Building Static versions of Bacula}
1239 \index[general]{Static linking}
1240 In order to build static versions of Bacula, in addition
1241 to configuration options that were needed you now must
1242 also add --disable-libtool. Example
1245 ./configure --enable-static-client-only --disable-libtool
1249 \section{Virtual Backup (Vbackup)}
1250 \index[general]{Virtual Backup}
1251 \index[general]{Vbackup}
1253 Bacula's virtual backup feature is often called Synthetic Backup or
1254 Consolidation in other backup products. It permits you to consolidate the
1255 previous Full backup plus the most recent Differential backup and any
1256 subsequent Incremental backups into a new Full backup. This new Full
1257 backup will then be considered as the most recent Full for any future
1258 Incremental or Differential backups. The VirtualFull backup is
1259 accomplished without contacting the client by reading the previous backup
1260 data and writing it to a volume in a different pool.
1262 In some respects the Vbackup feature works similar to a Migration job, in
1263 that Bacula normally reads the data from the pool specified in the
1264 Job resource, and writes it to the {\bf Next Pool} specified in the
1265 Job resource. Note, this means that usually the output from the Virtual
1266 Backup is written into a different pool from where your prior backups
1267 are saved. Doing it this way guarantees that you will not get a deadlock
1268 situation attempting to read and write to the same volume in the Storage
1269 daemon. If you then want to do subsequent backups, you may need to
1270 move the Virtual Full Volume back to your normal backup pool.
1271 Alternatively, you can set your {\bf Next Pool} to point to the current
1272 pool. This will cause Bacula to read and write to Volumes in the
1273 current pool. In general, this will work, because Bacula will
1274 not allow reading and writing on the same Volume. In any case, once
1275 a VirtualFull has been created, and a restore is done involving the
1276 most current Full, it will read the Volume or Volumes by the VirtualFull
1277 regardless of in which Pool the Volume is found.
1279 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1280 a level of {\bf VirtualFull}.
1282 A typical Job resource definition might look like the following:
1289 FileSet = "Full Set"
1296 # Default pool definition
1300 Recycle = yes # Automatically recycle Volumes
1301 AutoPrune = yes # Prune expired volumes
1302 Volume Retention = 365d # one year
1310 Recycle = yes # Automatically recycle Volumes
1311 AutoPrune = yes # Prune expired volumes
1312 Volume Retention = 365d # one year
1313 Storage = DiskChanger
1316 # Definition of file storage device
1321 Device = FileStorage
1323 Maximum Concurrent Jobs = 5
1326 # Definition of DDS Virtual tape disk storage device
1329 Address = localhost # N.B. Use a fully qualified name here
1331 Device = DiskChanger
1332 Media Type = DiskChangerMedia
1333 Maximum Concurrent Jobs = 4
1338 Then in bconsole or via a Run schedule, you would run the job as:
1341 run job=MyBackup level=Full
1342 run job=MyBackup level=Incremental
1343 run job=MyBackup level=Differential
1344 run job=MyBackup level=Incremental
1345 run job=MyBackup level=Incremental
1348 So providing there were changes between each of those jobs, you would end up
1349 with a Full backup, a Differential, which includes the first Incremental
1350 backup, then two Incremental backups. All the above jobs would be written to
1351 the {\bf Default} pool.
1353 To consolidate those backups into a new Full backup, you would run the
1357 run job=MyBackup level=VirtualFull
1360 And it would produce a new Full backup without using the client, and the output
1361 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1363 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1366 Note, the Start and End time of the Virtual Full backup is set to the
1367 values for the last job included in the Virtual Full (in the above example,
1368 it is an Increment). This is so that if another incremental is done, which
1369 will be based on the Virtual Full, it will backup all files from the
1370 last Job included in the Virtual Full rather than from the time the Virtual
1371 Full was actually run.
1375 \section{Catalog Format}
1376 \index[general]{Catalog Format}
1377 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1378 operation will convert the FileId field of the File table from 32 bits (max 4
1379 billion table entries) to 64 bits (very large number of items). The
1380 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1381 your catalog during the conversion. Also you won't be able to run jobs during
1382 this conversion period. For example, a 3 million file catalog will take 2
1383 minutes to upgrade on a normal machine. Please don't forget to make a valid
1384 backup of your database before executing the upgrade script. See the
1385 ReleaseNotes for additional details.
1387 \section{64 bit Windows Client}
1388 \index[general]{Win64 Client}
1389 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1390 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1391 As a consequence, we are also releasing a 64 bit version of the Bacula
1392 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1393 These binaries should only be installed on 64 bit Windows operating systems.
1394 What is important is not your hardware but whether or not you have
1395 a 64 bit version of the Windows OS.
1397 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1399 \item Before installing the Win64 Bacula Client, you must totally
1400 deinstall any prior 2.4.x Client installation using the
1401 Bacula deinstallation (see the menu item). You may want
1402 to save your .conf files first.
1403 \item Only the Client (File daemon) is ported to Win64, the Director
1404 and the Storage daemon are not in the 64 bit Windows installer.
1405 \item bwx-console is not yet ported.
1406 \item bconsole is ported but it has not been tested.
1407 \item The documentation is not included in the installer.
1408 \item Due to Vista security restrictions imposed on a default installation
1409 of Vista, before upgrading the Client, you must manually stop
1410 any prior version of Bacula from running, otherwise the install
1412 \item Due to Vista security restrictions imposed on a default installation
1413 of Vista, attempting to edit the conf files via the menu items
1414 will fail. You must directly edit the files with appropriate
1415 permissions. Generally double clicking on the appropriate .conf
1416 file will work providing you have sufficient permissions.
1417 \item All Bacula files are now installed in
1418 {\bf C:/Program Files/Bacula} except the main menu items,
1419 which are installed as before. This vastly simplifies the installation.
1420 \item If you are running on a foreign language version of Windows, most
1421 likely {\bf C:/Program Files} does not exist, so you should use the
1422 Custom installation and enter an appropriate location to install
1424 \item The 3.0.0 Win32 Client continues to install files in the locations used
1425 by prior versions. For the next version we will convert it to use
1426 the same installation conventions as the Win64 version.
1429 This project was funded by Bacula Systems.
1432 \section{Duplicate Job Control}
1433 \index[general]{Duplicate Jobs}
1434 The new version of Bacula provides four new directives that
1435 give additional control over what Bacula does if duplicate jobs
1436 are started. A duplicate job in the sense we use it here means
1437 a second or subsequent job with the same name starts. This
1438 happens most frequently when the first job runs longer than expected because no
1439 tapes are available.
1441 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1442 are specified in the Job resource.
1446 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1447 \index[general]{Allow Duplicate Jobs}
1448 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1449 the directive is set to {\bf no} (default) then only one job of a given name
1450 may run at one time, and the action that Bacula takes to ensure only
1451 one job runs is determined by the other directives (see below).
1453 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1454 are present and none of the three directives given below permit
1455 cancelling a job, then the current job (the second one started)
1458 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1459 \index[general]{Allow Higher Duplicates}
1460 This directive was in version 5.0.0, but does not work as
1461 expected. If used, it should always be set to no. In later versions
1462 of Bacula the directive is disabled (disregarded).
1464 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1465 \index[general]{Cancel Running Duplicates}
1466 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1467 if this directive is set to {\bf yes} any job that is already running
1468 will be canceled. The default is {\bf no}.
1470 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1471 \index[general]{Cancel Queued Duplicates}
1472 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1473 if this directive is set to {\bf yes} any job that is
1474 already queued to run but not yet running will be canceled.
1475 The default is {\bf no}.
1478 \section{TLS Authentication}
1479 \index[general]{TLS Authentication}
1480 In Bacula version 2.5.x and later, in addition to the normal Bacula
1481 CRAM-MD5 authentication that is used to authenticate each Bacula
1482 connection, you can specify that you want TLS Authentication as well,
1483 which will provide more secure authentication.
1485 This new feature uses Bacula's existing TLS code (normally used for
1486 communications encryption) to do authentication. To use it, you must
1487 specify all the TLS directives normally used to enable communications
1488 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1491 \subsection{TLS Authenticate = yes}
1493 TLS Authenticate = yes
1496 in the main daemon configuration resource (Director for the Director,
1497 Client for the File daemon, and Storage for the Storage daemon).
1499 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1500 authentication, Bacula will also do TLS authentication, then TLS
1501 encryption will be turned off, and the rest of the communication between
1502 the two Bacula daemons will be done without encryption.
1504 If you want to encrypt communications data, use the normal TLS directives
1505 but do not turn on {\bf TLS Authenticate}.
1507 \section{bextract non-portable Win32 data}
1508 \index[general]{bextract handles Win32 non-portable data}
1509 {\bf bextract} has been enhanced to be able to restore
1510 non-portable Win32 data to any OS. Previous versions were
1511 unable to restore non-portable Win32 data to machines that
1512 did not have the Win32 BackupRead and BackupWrite API calls.
1514 \section{State File updated at Job Termination}
1515 \index[general]{State File}
1516 In previous versions of Bacula, the state file, which provides a
1517 summary of previous jobs run in the {\bf status} command output was
1518 updated only when Bacula terminated, thus if the daemon crashed, the
1519 state file might not contain all the run data. This version of
1520 the Bacula daemons updates the state file on each job termination.
1522 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1523 \index[general]{MaxFullInterval}
1524 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1525 can be used to specify the maximum time interval between {\bf Full} backup
1526 jobs. When a job starts, if the time since the last Full backup is
1527 greater than the specified interval, and the job would normally be an
1528 {\bf Incremental} or {\bf Differential}, it will be automatically
1529 upgraded to a {\bf Full} backup.
1531 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1532 \index[general]{MaxDiffInterval}
1533 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1534 can be used to specify the maximum time interval between {\bf Differential} backup
1535 jobs. When a job starts, if the time since the last Differential backup is
1536 greater than the specified interval, and the job would normally be an
1537 {\bf Incremental}, it will be automatically
1538 upgraded to a {\bf Differential} backup.
1540 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1541 \index[general]{MaxDiffInterval}
1542 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1543 by the user, and when it is set it is an indication to backup programs
1544 to not backup that particular file. This version of Bacula contains a
1545 new Options directive within a FileSet resource, which instructs Bacula to
1546 obey this flag. The new directive is:
1549 Honor No Dump Flag = yes\vb{}no
1552 The default value is {\bf no}.
1555 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1556 \index[general]{IgnoreDir}
1557 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1558 can be added to the Include section of the FileSet resource. If the specified
1559 filename ({\bf filename-string}) is found on the Client in any directory to be
1560 backed up, the whole directory will be ignored (not backed up). For example:
1563 # List of files to be backed up
1571 Exclude Dir Containing = .excludeme
1576 But in /home, there may be hundreds of directories of users and some
1577 people want to indicate that they don't want to have certain
1578 directories backed up. For example, with the above FileSet, if
1579 the user or sysadmin creates a file named {\bf .excludeme} in
1580 specific directories, such as
1583 /home/user/www/cache/.excludeme
1584 /home/user/temp/.excludeme
1587 then Bacula will not backup the two directories named:
1590 /home/user/www/cache
1594 NOTE: subdirectories will not be backed up. That is, the directive
1595 applies to the two directories in question and any children (be they
1596 files, directories, etc).
1599 \section{Bacula Plugins}
1600 \index[general]{Plugin}
1601 Support for shared object plugins has been implemented in the Linux, Unix
1602 and Win32 File daemons. The API will be documented separately in
1603 the Developer's Guide or in a new document. For the moment, there is
1604 a single plugin named {\bf bpipe} that allows an external program to
1605 get control to backup and restore a file.
1607 Plugins are also planned (partially implemented) in the Director and the
1610 \subsection{Plugin Directory}
1611 \index[general]{Plugin Directory}
1612 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1613 be added to the daemon definition resource. The directory takes a quoted
1614 string argument, which is the name of the directory in which the daemon can
1615 find the Bacula plugins. If this directive is not specified, Bacula will not
1616 load any plugins. Since each plugin has a distinctive name, all the daemons
1617 can share the same plugin directory.
1619 \subsection{Plugin Options}
1620 \index[general]{Plugin Options}
1621 The {\bf Plugin Options} directive takes a quoted string
1622 arguement (after the equal sign) and may be specified in the
1623 Job resource. The options specified will be passed to all plugins
1624 when they are run. This each plugin must know what it is looking
1625 for. The value defined in the Job resource can be modified
1626 by the user when he runs a Job via the {\bf bconsole} command line
1629 Note: this directive may be specified, and there is code to modify
1630 the string in the run command, but the plugin options are not yet passed to
1631 the plugin (i.e. not fully implemented).
1633 \subsection{Plugin Options ACL}
1634 \index[general]{Plugin Options ACL}
1635 The {\bf Plugin Options ACL} directive may be specified in the
1636 Director's Console resource. It functions as all the other ACL commands
1637 do by permitting users running restricted consoles to specify a
1638 {\bf Plugin Options} that overrides the one specified in the Job
1639 definition. Without this directive restricted consoles may not modify
1642 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1643 \index[general]{Plugin}
1644 The {\bf Plugin} directive is specified in the Include section of
1645 a FileSet resource where you put your {\bf File = xxx} directives.
1656 Plugin = "bpipe:..."
1661 In the above example, when the File daemon is processing the directives
1662 in the Include section, it will first backup all the files in {\bf /home}
1663 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1664 the Plugin Directory. The syntax and semantics of the Plugin directive
1665 require the first part of the string up to the colon (:) to be the name
1666 of the plugin. Everything after the first colon is ignored by the File daemon but
1667 is passed to the plugin. Thus the plugin writer may define the meaning of the
1668 rest of the string as he wishes.
1670 Please see the next section for information about the {\bf bpipe} Bacula
1673 \section{The bpipe Plugin}
1674 \index[general]{The bpipe Plugin}
1675 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1676 the Bacula source distribution. When the plugin is compiled and linking into
1677 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1678 Please note that this is a very simple plugin that was written for
1679 demonstration and test purposes. It is and can be used in production, but
1680 that was never really intended.
1682 The purpose of the plugin is to provide an interface to any system program for
1683 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1684 the Include section of your Job's FileSet resource. The full syntax of the
1685 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1686 to specify the sytax as it wishes) is:
1689 Plugin = "<field1>:<field2>:<field3>:<field4>"
1694 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1695 stripped off, so in this case, we would put {\bf bpipe} in this field.
1697 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1698 pseudo path and filename under which the backup will be saved. This pseudo
1699 path and filename will be seen by the user in the restore file tree.
1700 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1701 backed up by the plugin will be put under that "pseudo" path and filename.
1702 You must be careful to choose a naming convention that is unique to avoid
1703 a conflict with a path and filename that actually exists on your system.
1705 \item {\bf field3} for the {\bf bpipe} plugin
1706 specifies the "reader" program that is called by the plugin during
1707 backup to read the data. {\bf bpipe} will call this program by doing a
1710 \item {\bf field4} for the {\bf bpipe} plugin
1711 specifies the "writer" program that is called by the plugin during
1712 restore to write the data back to the filesystem.
1715 Please note that for two items above describing the "reader" and "writer"
1716 fields, these programs are "executed" by Bacula, which
1717 means there is no shell interpretation of any command line arguments
1718 you might use. If you want to use shell characters (redirection of input
1719 or output, ...), then we recommend that you put your command or commands
1720 in a shell script and execute the script. In addition if you backup a
1721 file with the reader program, when running the writer program during
1722 the restore, Bacula will not automatically create the path to the file.
1723 Either the path must exist, or you must explicitly do so with your command
1724 or in a shell script.
1726 Putting it all together, the full plugin directive line might look
1730 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1731 --opt --databases bacula:mysql"
1734 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1735 would be written on a single line.
1737 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1738 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1739 program {\bf mysqldump -f --opt --database bacula} to read the data during
1740 backup. The mysqldump command outputs all the data for the database named
1741 {\bf bacula}, which will be read by the plugin and stored in the backup.
1742 During restore, the data that was backed up will be sent to the program
1743 specified in the last field, which in this case is {\bf mysql}. When
1744 {\bf mysql} is called, it will read the data sent to it by the plugn
1745 then write it back to the same database from which it came ({\bf bacula}
1748 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1749 the data from a specified program to Bacula for backup, and then from Bacula to
1750 a specified program for restore.
1752 By using different command lines to {\bf bpipe},
1753 you can backup any kind of data (ASCII or binary) depending
1754 on the program called.
1756 \section{Microsoft Exchange Server 2003/2007 Plugin}
1757 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1758 \subsection{Background}
1759 The Exchange plugin was made possible by a funded development project
1760 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1761 The code for the plugin was written by James Harper, and the Bacula core
1762 code by Kern Sibbald. All the code for this funded development has become
1763 part of the Bacula project. Thanks to everyone who made it happen.
1765 \subsection{Concepts}
1766 Although it is possible to backup Exchange using Bacula VSS the Exchange
1767 plugin adds a good deal of functionality, because while Bacula VSS
1768 completes a full backup (snapshot) of Exchange, it does
1769 not support Incremental or Differential backups, restoring is more
1770 complicated, and a single database restore is not possible.
1772 Microsoft Exchange organises its storage into Storage Groups with
1773 Databases inside them. A default installation of Exchange will have a
1774 single Storage Group called 'First Storage Group', with two Databases
1775 inside it, "Mailbox Store (SERVER NAME)" and
1776 "Public Folder Store (SERVER NAME)",
1777 which hold user email and public folders respectively.
1779 In the default configuration, Exchange logs everything that happens to
1780 log files, such that if you have a backup, and all the log files since,
1781 you can restore to the present time. Each Storage Group has its own set
1782 of log files and operates independently of any other Storage Groups. At
1783 the Storage Group level, the logging can be turned off by enabling a
1784 function called "Enable circular logging". At this time the Exchange
1785 plugin will not function if this option is enabled.
1787 The plugin allows backing up of entire storage groups, and the restoring
1788 of entire storage groups or individual databases. Backing up and
1789 restoring at the individual mailbox or email item is not supported but
1790 can be simulated by use of the "Recovery" Storage Group (see below).
1792 \subsection{Installing}
1793 The Exchange plugin requires a DLL that is shipped with Microsoft
1794 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1795 correctly the Exchange plugin should find this automatically and run
1796 without any additional installation.
1798 If the DLL can not be found automatically it will need to be copied into
1799 the Bacula installation
1800 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1801 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1802 default Exchange installation.
1804 \subsection{Backing Up}
1805 To back up an Exchange server the Fileset definition must contain at
1806 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1807 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1808 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1809 up files are prefixed with something that isn't going to share a name
1810 with something outside the plugin, and the 'Microsoft Information Store'
1811 bit is required also. It is also possible to add the name of a storage
1812 group to the "Plugin =" line, eg \\
1813 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1814 if you want only a single storage group backed up.
1816 Additionally, you can suffix the 'Plugin =' directive with
1817 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1818 database at the end of a full backup.
1820 An Incremental or Differential backup will backup only the database logs
1821 for each Storage Group by inspecting the "modified date" on each
1822 physical log file. Because of the way the Exchange API works, the last
1823 logfile backed up on each backup will always be backed up by the next
1824 Incremental or Differential backup too. This adds 5MB to each
1825 Incremental or Differential backup size but otherwise does not cause any
1828 By default, a normal VSS fileset containing all the drive letters will
1829 also back up the Exchange databases using VSS. This will interfere with
1830 the plugin and Exchange's shared ideas of when the last full backup was
1831 done, and may also truncate log files incorrectly. It is important,
1832 therefore, that the Exchange database files be excluded from the backup,
1833 although the folders the files are in should be included, or they will
1834 have to be recreated manually if a baremetal restore is done.
1839 File = C:/Program Files/Exchsrvr/mdbdata
1840 Plugin = "exchange:..."
1843 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1844 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1845 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1846 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1847 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1848 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1849 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1854 The advantage of excluding the above files is that you can significantly
1855 reduce the size of your backup since all the important Exchange files
1856 will be properly saved by the Plugin.
1859 \subsection{Restoring}
1860 The restore operation is much the same as a normal Bacula restore, with
1861 the following provisos:
1864 \item The {\bf Where} restore option must not be specified
1865 \item Each Database directory must be marked as a whole. You cannot just
1866 select (say) the .edb file and not the others.
1867 \item If a Storage Group is restored, the directory of the Storage Group
1869 \item It is possible to restore only a subset of the available log files,
1870 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1871 if a log file is missing from the sequence of log files
1872 \item Each database to be restored must be dismounted and marked as "Can be
1873 overwritten by restore"
1874 \item If an entire Storage Group is to be restored (eg all databases and
1875 logs in the Storage Group), then it is best to manually delete the
1876 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1877 as Exchange can get confused by stray log files lying around.
1880 \subsection{Restoring to the Recovery Storage Group}
1881 The concept of the Recovery Storage Group is well documented by
1883 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1884 but to briefly summarize...
1886 Microsoft Exchange allows the creation of an additional Storage Group
1887 called the Recovery Storage Group, which is used to restore an older
1888 copy of a database (e.g. before a mailbox was deleted) into without
1889 messing with the current live data. This is required as the Standard and
1890 Small Business Server versions of Exchange can not ordinarily have more
1891 than one Storage Group.
1893 To create the Recovery Storage Group, drill down to the Server in Exchange
1894 System Manager, right click, and select
1895 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1896 locations and click OK. On the Recovery Storage Group, right click and
1897 select {\bf "Add Database to Recover..."} and select the database you will
1900 Restore only the single database nominated as the database in the
1901 Recovery Storage Group. Exchange will redirect the restore to the
1902 Recovery Storage Group automatically.
1903 Then run the restore.
1905 \subsection{Restoring on Microsoft Server 2007}
1906 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1907 2007, and henc you use a new proceedure for recovering a single mail box.
1908 This procedure is ducomented by Microsoft at:
1909 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1910 and involves using the {\bf Restore-Mailbox} and {\bf
1911 Get-MailboxStatistics} shell commands.
1913 \subsection{Caveats}
1914 This plugin is still being developed, so you should consider it
1915 currently in BETA test, and thus use in a production environment
1916 should be done only after very careful testing.
1918 When doing a full backup, the Exchange database logs are truncated by
1919 Exchange as soon as the plugin has completed the backup. If the data
1920 never makes it to the backup medium (eg because of spooling) then the
1921 logs will still be truncated, but they will also not have been backed
1922 up. A solution to this is being worked on. You will have to schedule a
1923 new Full backup to ensure that your next backups will be usable.
1925 The "Enable Circular Logging" option cannot be enabled or the plugin
1928 Exchange insists that a successful Full backup must have taken place if
1929 an Incremental or Differential backup is desired, and the plugin will
1930 fail if this is not the case. If a restore is done, Exchange will
1931 require that a Full backup be done before an Incremental or Differential
1934 The plugin will most likely not work well if another backup application
1935 (eg NTBACKUP) is backing up the Exchange database, especially if the
1936 other backup application is truncating the log files.
1938 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1939 we recommend either carefully testing or that you avoid this option for
1942 The Exchange plugin is not called during processing the bconsole {\bf
1943 estimate} command, and so anything that would be backed up by the plugin
1944 will not be added to the estimate total that is displayed.
1947 \section{libdbi Framework}
1948 \index[general]{libdbi Framework}
1949 As a general guideline, Bacula has support for a few catalog database drivers
1950 (MySQL, PostgreSQL, SQLite)
1951 coded natively by the Bacula team. With the libdbi implementation, which is a
1952 Bacula driver that uses libdbi to access the catalog, we have an open field to
1953 use many different kinds database engines following the needs of users.
1955 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1956 implements a database-independent abstraction layer in C, similar to the
1957 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1958 leverage the power of multiple databases and multiple simultaneous database
1959 connections by using this framework.
1961 Currently the libdbi driver in Bacula project only supports the same drivers
1962 natively coded in Bacula. However the libdbi project has support for many
1963 others database engines. You can view the list at
1964 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1965 supported by Bacula, however, they must be tested properly by the Bacula team.
1967 Some of benefits of using libdbi are:
1969 \item The possibility to use proprietary databases engines in which your
1970 proprietary licenses prevent the Bacula team from developing the driver.
1971 \item The possibility to use the drivers written for the libdbi project.
1972 \item The possibility to use other database engines without recompiling Bacula
1973 to use them. Just change one line in bacula-dir.conf
1974 \item Abstract Database access, this is, unique point to code and profiling
1975 catalog database access.
1978 The following drivers have been tested:
1980 \item PostgreSQL, with and without batch insert
1981 \item Mysql, with and without batch insert
1986 In the future, we will test and approve to use others databases engines
1987 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1989 To compile Bacula to support libdbi we need to configure the code with the
1990 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1991 [database] is the database engine to be used with Bacula (of course we can
1992 change the driver in file bacula-dir.conf, see below). We must configure the
1993 access port of the database engine with the option --with-db-port, because the
1994 libdbi framework doesn't know the default access port of each database.
1996 The next phase is checking (or configuring) the bacula-dir.conf, example:
2000 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2001 dbname = regress; user = regress; password = ""
2005 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2006 mysql database. Currently the drivers supported by Bacula are: postgresql,
2007 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2009 The following limitations apply when Bacula is set to use the libdbi framework:
2010 - Not tested on the Win32 platform
2011 - A little performance is lost if comparing with native database driver.
2012 The reason is bound with the database driver provided by libdbi and the
2013 simple fact that one more layer of code was added.
2015 It is important to remember, when compiling Bacula with libdbi, the
2016 following packages are needed:
2018 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2019 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2022 You can download them and compile them on your system or install the packages
2023 from your OS distribution.
2025 \section{Console Command Additions and Enhancements}
2026 \index[general]{Console Additions}
2028 \subsection{Display Autochanger Content}
2029 \index[general]{StatusSlots}
2031 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2032 autochanger content.
2036 Slot | Volume Name | Status | Media Type | Pool |
2037 ------+---------------+----------+-------------------+------------|
2038 1 | 00001 | Append | DiskChangerMedia | Default |
2039 2 | 00002 | Append | DiskChangerMedia | Default |
2040 3*| 00003 | Append | DiskChangerMedia | Scratch |
2045 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2046 {\bf update slots} command to synchronize autochanger content with your
2049 \subsection{list joblog job=xxx or jobid=nnn}
2050 \index[general]{list joblog}
2051 A new list command has been added that allows you to list the contents
2052 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2053 or for a particular JobId. The {\bf llist} command will include a line with
2054 the time and date of the entry.
2056 Note for the catalog to have Job Log entries, you must have a directive
2063 In your Director's {\bf Messages} resource.
2065 \subsection{Use separator for multiple commands}
2066 \index[general]{Command Separator}
2067 When using bconsole with readline, you can set the command separator with
2068 \textbf{@separator} command to one
2069 of those characters to write commands who require multiple input in one line.
2071 !$%&'()*+,-/:;<>?[]^`{|}~
2074 \subsection{Deleting Volumes}
2075 The delete volume bconsole command has been modified to
2076 require an asterisk (*) in front of a MediaId otherwise the
2077 value you enter is a taken to be a Volume name. This is so that
2078 users may delete numeric Volume names. The previous Bacula versions
2079 assumed that all input that started with a number was a MediaId.
2081 This new behavior is indicated in the prompt if you read it
2084 \section{Bare Metal Recovery}
2085 The old bare metal recovery project is essentially dead. One
2086 of the main features of it was that it would build a recovery
2087 CD based on the kernel on your system. The problem was that
2088 every distribution has a different boot procedure and different
2089 scripts, and worse yet, the boot procedures and scripts change
2090 from one distribution to another. This meant that maintaining
2091 (keeping up with the changes) the rescue CD was too much work.
2093 To replace it, a new bare metal recovery USB boot stick has been developed
2094 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2095 boot from a USB key.
2099 \item Recovery can be done from within graphical environment.
2100 \item Recovery can be done in a shell.
2101 \item Ubuntu boots on a large number of Linux systems.
2102 \item The process of updating the system and adding new
2103 packages is not too difficult.
2104 \item The USB key can easily be upgraded to newer Ubuntu versions.
2105 \item The USB key has writable partitions for modifications to
2106 the OS and for modification to your home directory.
2107 \item You can add new files/directories to the USB key very easily.
2108 \item You can save the environment from multiple machines on
2110 \item Bacula Systems is funding its ongoing development.
2113 The disadvantages are:
2115 \item The USB key is usable but currently under development.
2116 \item Not everyone may be familiar with Ubuntu (no worse
2118 \item Some older OSes cannot be booted from USB. This can
2119 be resolved by first booting a Ubuntu LiveCD then plugging
2121 \item Currently the documentation is sketchy and not yet added
2122 to the main manual. See below ...
2125 The documentation and the code can be found in the {\bf rescue} package
2126 in the directory {\bf linux/usb}.
2128 \section{Miscellaneous}
2129 \index[general]{Misc New Features}
2131 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2132 \index[general]{Allow Mixed Priority}
2133 This directive is only implemented in version 2.5 and later. When
2134 set to {\bf yes} (default {\bf no}), this job may run even if lower
2135 priority jobs are already running. This means a high priority job
2136 will not have to wait for other jobs to finish before starting.
2137 The scheduler will only mix priorities when all running jobs have
2140 Note that only higher priority jobs will start early. Suppose the
2141 director will allow two concurrent jobs, and that two jobs with
2142 priority 10 are running, with two more in the queue. If a job with
2143 priority 5 is added to the queue, it will be run as soon as one of
2144 the running jobs finishes. However, new priority 10 jobs will not
2145 be run until the priority 5 job has finished.
2147 \subsection{Bootstrap File Directive -- FileRegex}
2148 \index[general]{Bootstrap File Directive}
2149 {\bf FileRegex} is a new command that can be added to the bootstrap
2150 (.bsr) file. The value is a regular expression. When specified, only
2151 matching filenames will be restored.
2153 During a restore, if all File records are pruned from the catalog
2154 for a Job, normally Bacula can restore only all files saved. That
2155 is there is no way using the catalog to select individual files.
2156 With this new feature, Bacula will ask if you want to specify a Regex
2157 expression for extracting only a part of the full backup.
2160 Building directory tree for JobId(s) 1,3 ...
2161 There were no files inserted into the tree, so file selection
2162 is not possible.Most likely your retention policy pruned the files
2164 Do you want to restore all the files? (yes\vb{}no): no
2166 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2167 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2170 \subsection{Bootstrap File Optimization Changes}
2171 In order to permit proper seeking on disk files, we have extended the bootstrap
2172 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2173 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2174 address range and end address range respectively. These two directives replace
2175 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2176 VolEndBlock} directives. Bootstrap files containing the old directives will
2177 still work, but will not properly take advantage of proper disk seeking, and
2178 may read completely to the end of a disk volume during a restore. With the new
2179 format (automatically generated by the new Director), restores will seek
2180 properly and stop reading the volume when all the files have been restored.
2182 \subsection{Solaris ZFS/NFSv4 ACLs}
2183 This is an upgrade of the previous Solaris ACL backup code
2184 to the new library format, which will backup both the old
2185 POSIX(UFS) ACLs as well as the ZFS ACLs.
2187 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2188 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2189 be used to transfer from UFS to ZFS filesystems.
2192 \subsection{Virtual Tape Emulation}
2193 \index[general]{Virtual Tape Emulation}
2194 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2195 the tape code but actually reading and writing to a disk file. Used with the
2196 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2197 and 700 slots. This feature is most useful in testing. It is enabled
2198 by using {\bf Device Type = vtape} in the Storage daemon's Device
2199 directive. This feature is only implemented on Linux machines and should not be
2200 used for production.
2202 \subsection{Bat Enhancements}
2203 \index[general]{Bat Enhancements}
2204 Bat (the Bacula Administration Tool) GUI program has been significantly
2205 enhanced and stabilized. In particular, there are new table based status
2206 commands; it can now be easily localized using Qt4 Linguist.
2208 The Bat communications protocol has been significantly enhanced to improve
2209 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2210 the Director you are using otherwise the communications protocol will not
2213 \subsection{RunScript Enhancements}
2214 \index[general]{RunScript Enhancements}
2215 The {\bf RunScript} resource has been enhanced to permit multiple
2216 commands per RunScript. Simply specify multiple {\bf Command} directives
2223 Command = "/bin/echo test"
2224 Command = "/bin/echo an other test"
2225 Command = "/bin/echo 3 commands in the same runscript"
2232 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2233 implemented, which runs the command after the Volume Shadow Copy has been made.
2235 Console commands can be specified within a RunScript by using:
2236 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2237 carefully tested and debugged and is known to easily crash the Director.
2238 We would appreciate feedback. Due to the recursive nature of this command, we
2239 may remove it before the final release.
2241 \subsection{Status Enhancements}
2242 \index[general]{Status Enhancements}
2243 The bconsole {\bf status dir} output has been enhanced to indicate
2244 Storage daemon job spooling and despooling activity.
2246 \subsection{Connect Timeout}
2247 \index[general]{Connect Timeout}
2248 The default connect timeout to the File
2249 daemon has been set to 3 minutes. Previously it was 30 minutes.
2251 \subsection{ftruncate for NFS Volumes}
2252 \index[general]{ftruncate for NFS Volumes}
2253 If you write to a Volume mounted by NFS (say on a local file server),
2254 in previous Bacula versions, when the Volume was recycled, it was not
2255 properly truncated because NFS does not implement ftruncate (file
2256 truncate). This is now corrected in the new version because we have
2257 written code (actually a kind user) that deletes and recreates the Volume,
2258 thus accomplishing the same thing as a truncate.
2260 \subsection{Support for Ubuntu}
2261 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2262 version of Linux, and thus now provides correct autostart routines.
2263 Since Ubuntu officially supports Bacula, you can also obtain any
2264 recent release of Bacula from the Ubuntu repositories.
2266 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2267 \index[general]{Recycle Pool}
2268 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2269 be placed (moved) when it is recycled. Without this directive, a Volume will
2270 remain in the same pool when it is recycled. With this directive, it can be
2271 moved automatically to any existing pool during a recycle. This directive is
2272 probably most useful when defined in the Scratch pool, so that volumes will
2273 be recycled back into the Scratch pool.
2275 \subsection{FD Version}
2276 \index[general]{FD Version}
2277 The File daemon to Director protocol now includes a version
2278 number, which although there is no visible change for users,
2279 will help us in future versions automatically determine
2280 if a File daemon is not compatible.
2282 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2283 \index[general]{Max Run Sched Time}
2284 The time specifies the maximum allowed time that a job may run, counted from
2285 when the job was scheduled. This can be useful to prevent jobs from running
2286 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2289 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2290 \index[general]{Max Wait Time}
2291 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2292 of checking the maximum allowed time that a job may block for a resource,
2293 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2294 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2295 their job depending on the level. Now, they have to use
2296 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2297 directives are now deprecated.
2299 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2300 \index[general]{Incremental Max Wait Time}
2301 \index[general]{Differential Max Wait Time}
2303 These directives have been deprecated in favor of
2304 \texttt{Incremental|Differential Max Run Time}.
2306 \subsection{Max Run Time directives}
2307 \index[general]{Max Run Time directives}
2308 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2309 maximum allowed time that a job can run depending on the level.
2311 \addcontentsline{lof}{figure}{Job time control directives}
2312 \includegraphics{\idir different_time.eps}
2314 \subsection{Statistics Enhancements}
2315 \index[general]{Statistics Enhancements}
2316 If you (or probably your boss) want to have statistics on your backups to
2317 provide some \textit{Service Level Agreement} indicators, you could use a few
2318 SQL queries on the Job table to report how many:
2322 \item jobs have been successful
2323 \item files have been backed up
2327 However, these statistics are accurate only if your job retention is greater
2328 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2329 be able to use them.
2331 Now, you can use the \textbf{update stats [days=num]} console command to fill
2332 the JobHistory table with new Job records. If you want to be sure to take in
2333 account only \textbf{good jobs}, ie if one of your important job has failed but
2334 you have fixed the problem and restarted it on time, you probably want to
2335 delete the first \textit{bad} job record and keep only the successful one. For
2336 that simply let your staff do the job, and update JobHistory table after two or
2337 three days depending on your organization using the \textbf{[days=num]} option.
2339 These statistics records aren't used for restoring, but mainly for
2340 capacity planning, billings, etc.
2342 The Bweb interface provides a statistics module that can use this feature. You
2343 can also use tools like Talend or extract information by yourself.
2345 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2346 the length of time that Bacula will keep statistics job records in the Catalog
2347 database after the Job End time. (In \texttt{JobHistory} table) When this time
2348 period expires, and if user runs \texttt{prune stats} command, Bacula will
2349 prune (remove) Job records that are older than the specified period.
2351 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2352 job to maintain statistics.
2355 Name = BackupCatalog
2358 Console = "update stats days=3"
2359 Console = "prune stats yes"
2366 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2367 \index[general]{ScratchPool}
2368 This directive permits to specify a specific \textsl{Scratch} pool for the
2369 current pool. This is useful when using multiple storage sharing the same
2370 mediatype or when you want to dedicate volumes to a particular set of pool.
2372 \subsection{Enhanced Attribute Despooling}
2373 \index[general]{Attribute Despooling}
2374 If the storage daemon and the Director are on the same machine, the spool file
2375 that contains attributes is read directly by the Director instead of being
2376 transmitted across the network. That should reduce load and speedup insertion.
2378 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2379 \index[general]{SpoolSize}
2380 A new Job directive permits to specify the spool size per job. This is used
2381 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2383 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2384 \index[general]{MaximumConsoleConnections}
2385 A new director directive permits to specify the maximum number of Console
2386 Connections that could run concurrently. The default is set to 20, but you may
2387 set it to a larger number.
2389 \subsection{VerId = \lt{}string\gt{}}
2390 \index[general]{VerId}
2391 A new director directive permits to specify a personnal identifier that will be
2392 displayed in the \texttt{version} command.
2394 \subsection{dbcheck enhancements}
2395 \index[general]{dbcheck enhancements}
2396 If you are using Mysql, dbcheck will now ask you if you want to create
2397 temporary indexes to speed up orphaned Path and Filename elimination.
2399 A new \texttt{-B} option allows you to print catalog information in a simple
2400 text based format. This is useful to backup it in a secure way.
2415 You can now specify the database connection port in the command line.
2417 \subsection{{-}{-}docdir configure option}
2418 \index[general]{{-}{-}docdir configure option}
2419 You can use {-}{-}docdir= on the ./configure command to
2420 specify the directory where you want Bacula to install the
2421 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2422 {\bf /usr/share/doc/bacula}.
2424 \subsection{{-}{-}htmldir configure option}
2425 \index[general]{{-}{-}htmldir configure option}
2426 You can use {-}{-}htmldir= on the ./configure command to
2427 specify the directory where you want Bacula to install the bat html help
2428 files. The default is {\bf /usr/share/doc/bacula/html}
2430 \subsection{{-}{-}with-plugindir configure option}
2431 \index[general]{{-}{-}plugindir configure option}
2432 You can use {-}{-}plugindir= on the ./configure command to
2433 specify the directory where you want Bacula to install
2434 the plugins (currently only bpipe-fd). The default is