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{Additions to the Plugin API}
7 The bfuncs structure has been extended to include a number of
11 The bFuncs structure defines the callback entry points within Bacula
12 that the plugin can use register events, get Bacula values, set
13 Bacula values, and send messages to the Job output or debug output.
15 The exact definition as of this writing is:
17 typedef struct s_baculaFuncs {
20 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
21 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
22 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
23 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
24 int type, utime_t mtime, const char *fmt, ...);
25 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
26 int level, const char *fmt, ...);
27 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
29 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
31 /* New functions follow */
32 bRC (*AddExclude)(bpContext *ctx, const char *file);
33 bRC (*AddInclude)(bpContext *ctx, const char *file);
34 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
35 bRC (*AddRegexToInclude)(bpContext *ctx, const char *item, int type);
36 bRC (*AddWildToInclude)(bpContext *ctx, const char *item, int type);
42 \item [AddExclude] can be called to exclude a file. The file
43 string passed may include wildcards that will be interpreted by
44 the {\bf fnmatch} subroutine. This function can be called
45 multiple times, and each time the file specified will be added
46 to the list of files to be excluded. Note, this function only
47 permits adding excludes of specific file or directory names,
48 or files matched by the rather simple fnmatch mechanism.
49 See below for information on doing wild-card and regex excludes.
51 \item [NewInclude] can be called to create a new Include block. This
52 block will be added before any user defined Include blocks. This
53 function can be called multiple times, but each time, it will create
54 a new Include section (not normally needed). This function should
55 be called only if you want to add an entirely new Include block.
57 \item [AddInclude] can be called to add new files/directories to
58 be included. They are added to the current Include block. If
59 NewInclude has not been included, the current Include block is
60 the last one that the user created. This function
61 should be used only if you want to add totally new files/directories
62 to be included in the backup.
64 \item [NewOptions] adds a new Options block to the current Include
65 in front of any other Options blocks. This permits the plugin to
66 add exclude directives (wild-cards and regexes) in front of the
67 user Options, and thus prevent certain files from being backed up.
68 This can be useful if the plugin backs up files, and they should
69 not be also backed up by the main Bacula code. This function
70 may be called multiple times, and each time, it creates a new
71 prepended Options block. Note: normally you want to call this
72 entry point prior to calling AddOptions, AddRegex, or AddWild.
74 \item [AddOptions] allows the plugin it set options in
75 the current Options block, which is normally created with the
76 NewOptions call just prior to adding Include Options.
77 The permitted options are passed as a character string, where
78 each character has a specific meaning as defined below:
81 \item [a] always replace files (default).
82 \item [e] exclude rather than include.
83 \item [h] no recursion into subdirectories.
84 \item [H] do not handle hard links.
85 \item [i] ignore case in wildcard and regex matches.
86 \item [M] compute an MD5 sum.
87 \item [p] use a portable data format on Windows (not recommended).
88 \item [R] backup resource forks and Findr Info.
89 \item [r] read from a fifo
90 \item [S1] compute an SHA1 sum.
91 \item [S2] compute an SHA256 sum.
92 \item [S3] comput an SHA512 sum.
93 \item [s] handle sparse files.
94 \item [m] use st\_mtime only for file differences.
95 \item [k] restore the st\_atime after accessing a file.
96 \item [A] enable ACL backup.
97 \item [Vxxx:] specify verify options. Must terminate with :
98 \item [Cxxx:] specify accurate options. Must terminate with :
99 \item [Jxxx:] specify base job Options. Must terminate with :
100 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
102 \item [Zn] specify gzip compression level n.
103 \item [K] do not use st\_atime in backup decision.
104 \item [c] check if file changed during backup.
105 \item [N] honor no dump flag.
106 \item [X] enable backup of extended attributes.
109 \item [AddRegex] adds a regex expression to the current Options block.
110 The fillowing options are permitted:
112 \item [ ] (a blank) regex applies to whole path and filename.
113 \item [F] regex applies only to the filename (directory or path stripped).
114 \item [D] regex applies only to the directory (path) part of the name.
117 \item [AddWild] adds a wildcard expression to the current Options block.
118 The fillowing options are permitted:
120 \item [ ] (a blank) regex applies to whole path and filename.
121 \item [F] regex applies only to the filename (directory or path stripped).
122 \item [D] regex applies only to the directory (path) part of the name.
128 \subsection{Bacula events}
129 The list of events has been extended to include:
135 bEventStartBackupJob = 3,
136 bEventEndBackupJob = 4,
137 bEventStartRestoreJob = 5,
138 bEventEndRestoreJob = 6,
139 bEventStartVerifyJob = 7,
140 bEventEndVerifyJob = 8,
141 bEventBackupCommand = 9,
142 bEventRestoreCommand = 10,
147 bEventCancelCommand = 13,
148 bEventVssBackupAddComponents = 14,
149 bEventVssRestoreLoadComponentMetadata = 15,
150 bEventVssRestoreSetComponentsSelected = 16,
151 bEventRestoreObject = 17,
152 bEventEndFileSet = 18
158 \item [bEventCancelCommand] is called whenever the currently
159 running Job is cancelled */
161 \item [bEventVssBackupAddComponents]
170 \chapter{New Features in 5.0.1}
172 This chapter presents the new features that are in the released Bacula version
173 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
174 the onging development process.
176 \section{Truncate Volume after Purge}
177 \label{sec:actiononpurge}
179 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
180 the volume when it is purged with the new command \texttt{purge volume
181 action}. It is useful to prevent disk based volumes from consuming too much
187 Action On Purge = Truncate
192 As usual you can also set this property with the \texttt{update volume} command
194 *update volume=xxx ActionOnPurge=Truncate
195 *update volume=xxx actiononpurge=None
198 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
199 following command in interactive mode or in a RunScript as shown after:
201 *purge volume action=truncate storage=File allpools
202 # or by default, action=all
203 *purge volume action storage=File pool=Default
206 This is possible to specify the volume name, the media type, the pool, the
207 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
208 idle when you decide to run this command.
217 Console = "purge volume action=all allpools storage=File"
222 \textbf{Important note}: This feature doesn't work as
223 expected in version 5.0.0. Please do not use it before version 5.0.1.
225 \section{Allow Higher Duplicates}
226 This directive did not work correctly and has been depreciated
227 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
228 file as it will be removed in a future rlease.
230 \section{Cancel Lower Level Duplicates}
231 This directive was added in Bacula version 5.0.1. It compares the
232 level of a new backup job to old jobs of the same name, if any,
233 and will kill the job which has a lower level than the other one.
234 If the levels are the same (i.e. both are Full backups), then
235 nothing is done and the other Cancel XXX Duplicate directives
238 \chapter{New Features in 5.0.0}
240 \section{Maximum Concurent Jobs for Devices}
241 \label{sec:maximumconcurentjobdevice}
243 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
244 Daemon configuration permits setting the maximum number of Jobs that can
245 run concurrently on a specified Device. Using this directive, it is
246 possible to have different Jobs using multiple drives, because when the
247 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
248 Jobs on any other available compatible drive. This facilitates writing to
249 multiple drives with multiple Jobs that all use the same Pool.
251 This project was funded by Bacula Systems.
253 \section{Restore from Multiple Storage Daemons}
254 \index[general]{Restore}
256 Previously, you were able to restore from multiple devices in a single Storage
257 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
258 example, if your full backup runs on a Storage Daemon with an autochanger, and
259 your incremental jobs use another Storage Daemon with lots of disks, Bacula
260 will switch automatically from one Storage Daemon to an other within the same
263 You must upgrade your File Daemon to version 3.1.3 or greater to use this
266 This project was funded by Bacula Systems with the help of Equiinet.
268 \section{File Deduplication using Base Jobs}
269 A base job is sort of like a Full save except that you will want the FileSet to
270 contain only files that are unlikely to change in the future (i.e. a snapshot
271 of most of your system after installing it). After the base job has been run,
272 when you are doing a Full save, you specify one or more Base jobs to be used.
273 All files that have been backed up in the Base job/jobs but not modified will
274 then be excluded from the backup. During a restore, the Base jobs will be
275 automatically pulled in where necessary.
277 This is something none of the competition does, as far as we know (except
278 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
279 win for the user, it makes Bacula stand out as offering a unique optimization
280 that immediately saves time and money. Basically, imagine that you have 100
281 nearly identical Windows or Linux machine containing the OS and user files.
282 Now for the OS part, a Base job will be backed up once, and rather than making
283 100 copies of the OS, there will be only one. If one or more of the systems
284 have some files updated, no problem, they will be automatically restored.
286 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
287 files that will be used during Full backup as base.
298 Base = BackupZog4, BackupLinux
304 In this example, the job \texttt{BackupZog4} will use the most recent version
305 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
306 jobs. Base jobs should have run with \texttt{level=Base} to be used.
308 By default, Bacula will compare permissions bits, user and group fields,
309 modification time, size and the checksum of the file to choose between the
310 current backup and the BaseJob file list. You can change this behavior with the
311 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
312 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
328 \textbf{Important note}: The current implementation doesn't permit to scan
329 volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
331 This project was funded by Bacula Systems.
333 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
334 \index[dir]{AllowCompression}
336 This new directive may be added to Storage resource within the Director's
337 configuration to allow users to selectively disable the client compression for
338 any job which writes to this storage resource.
344 Address = ultrium-tape
345 Password = storage_password # Password for Storage Daemon
348 AllowCompression = No # Tape drive has hardware compression
351 The above example would cause any jobs running with the UltriumTape storage
352 resource to run without compression from the client file daemons. This
353 effectively overrides any compression settings defined at the FileSet level.
355 This feature is probably most useful if you have a tape drive which supports
356 hardware compression. By setting the \texttt{AllowCompression = No} directive
357 for your tape drive storage resource, you can avoid additional load on the file
358 daemon and possibly speed up tape backups.
360 This project was funded by Collaborative Fusion, Inc.
362 \section{Accurate Fileset Options}
363 \label{sec:accuratefileset}
365 In previous versions, the accurate code used the file creation and modification
366 times to determine if a file was modified or not. Now you can specify which
367 attributes to use (time, size, checksum, permission, owner, group, \dots),
368 similar to the Verify options.
384 \item {\bf i} compare the inodes
385 \item {\bf p} compare the permission bits
386 \item {\bf n} compare the number of links
387 \item {\bf u} compare the user id
388 \item {\bf g} compare the group id
389 \item {\bf s} compare the size
390 \item {\bf a} compare the access time
391 \item {\bf m} compare the modification time (st\_mtime)
392 \item {\bf c} compare the change time (st\_ctime)
393 \item {\bf d} report file size decreases
394 \item {\bf 5} compare the MD5 signature
395 \item {\bf 1} compare the SHA1 signature
398 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
399 the File Daemon will have to read all files even if they normally would not
400 be saved. This increases the I/O load, but also the accuracy of the
401 deduplication. By default, Bacula will check modification/creation time
404 This project was funded by Bacula Systems.
406 \section{Tab-completion for Bconsole}
407 \label{sec:tabcompletion}
409 If you build \texttt{bconsole} with readline support, you will be able to use
410 the new auto-completion mode. This mode supports all commands, gives help
411 inside command, and lists resources when required. It works also in the restore
414 To use this feature, you should have readline development package loaded on
415 your system, and use the following option in configure.
417 ./configure --with-readline=/usr/include/readline --disable-conio ...
420 The new bconsole won't be able to tab-complete with older directors.
422 This project was funded by Bacula Systems.
424 \section{Pool File and Job Retention}
425 \label{sec:poolfilejobretention}
427 We added two new Pool directives, \texttt{FileRetention} and
428 \texttt{JobRetention}, that take precedence over Client directives of the same
429 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
430 example, you can decide to increase Retention times for Archive or OffSite Pool.
432 It seems obvious to us, but apparently not to some users, that given the
433 definition above that the Pool File and Job Retention periods apply to the
434 data and records of all Jobs and all Clients that use Volumes in the Pool.
436 \section{Read-only File Daemon using capabilities}
437 \label{sec:fdreadonly}
438 This feature implements support of keeping \textbf{ReadAll} capabilities after
439 UID/GID switch, this allows FD to keep root read but drop write permission.
441 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
442 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
445 root@localhost:~# bacula-fd -k -u nobody -g nobody
448 The code for this feature was contributed by our friends at AltLinux.
453 To help developers of restore GUI interfaces, we have added new \textsl{dot
454 commands} that permit browsing the catalog in a very simple way.
457 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
458 the Bvfs cache in the catalog. You need to run it before any access to the
461 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
462 will list all directories in the specified \texttt{path} or
463 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
464 encoding of path/filenames.
466 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
467 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
468 \texttt{pathid} avoids problems with character encoding.
471 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
472 data that will be displayed.
475 * .bvfs_update jobid=1,2
477 * .bvfs_lsdir path=/ jobid=1,2
480 This project was funded by Bacula Systems.
482 \section{Testing your Tape Drive}
483 \label{sec:btapespeed}
485 To determine the best configuration of your tape drive, you can run the new
486 \texttt{speed} command available in the \texttt{btape} program.
488 This command can have the following arguments:
490 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
491 (between 1 and 5GB). This counter is in GB.
492 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
493 of data should be greater than your memory ($file\_size*nb\_file$).
494 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
496 \item[\texttt{skip\_random}] This flag permits to skip tests with random
498 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
499 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
504 *speed file_size=3 skip_raw
505 btape.c:1078 Test with zero data and bacula block structure.
506 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
507 ++++++++++++++++++++++++++++++++++++++++++
508 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
509 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
511 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
513 btape.c:1090 Test with random data, should give the minimum throughput.
514 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
515 +++++++++++++++++++++++++++++++++++++++++++
516 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
517 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
518 +++++++++++++++++++++++++++++++++++++++++++
520 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
524 When using compression, the random test will give your the minimum throughput
525 of your drive . The test using constant string will give you the maximum speed
526 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
528 You can change the block size in the Storage Daemon configuration file.
530 \section{New {\bf Block Checksum} Device Directive}
531 You may now turn off the Block Checksum (CRC32) code
532 that Bacula uses when writing blocks to a Volume. This is
539 doing so can reduce the Storage daemon CPU usage slightly. It
540 will also permit Bacula to read a Volume that has corrupted data.
542 The default is {\bf yes} -- i.e. the checksum is computed on write
545 We do not recommend to turn this off particularly on older tape
546 drives or for disk Volumes where doing so may allow corrupted data
549 \section{New Bat Features}
551 Those new features were funded by Bacula Systems.
553 \subsection{Media List View}
555 By clicking on ``Media'', you can see the list of all your volumes. You will be
556 able to filter by Pool, Media Type, Location,\dots And sort the result directly
557 in the table. The old ``Media'' view is now known as ``Pool''.
560 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
561 \label{fig:mediaview}
565 \subsection{Media Information View}
567 By double-clicking on a volume (on the Media list, in the Autochanger content
568 or in the Job information panel), you can access a detailed overview of your
569 Volume. (cf \ref{fig:mediainfo}.)
572 \includegraphics[width=13cm]{\idir bat11.eps}
573 \caption{Media information}
574 \label{fig:mediainfo}
577 \subsection{Job Information View}
579 By double-clicking on a Job record (on the Job run list or in the Media
580 information panel), you can access a detailed overview of your Job. (cf
584 \includegraphics[width=13cm]{\idir bat12.eps}
585 \caption{Job information}
589 \subsection{Autochanger Content View}
591 By double-clicking on a Storage record (on the Storage list panel), you can
592 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
595 \includegraphics[width=13cm]{\idir bat13.eps}
596 \caption{Autochanger content}
597 \label{fig:achcontent}
600 To use this feature, you need to use the latest mtx-changer script
601 version. (With new \texttt{listall} and \texttt{transfer} commands)
603 \section{Bat on Windows}
604 We have ported {\bf bat} to Windows and it is now installed
605 by default when the installer is run. It works quite well
606 on Win32, but has not had a lot of testing there, so your
607 feedback would be welcome. Unfortunately, eventhough it is
608 installed by default, it does not yet work on 64 bit Windows
611 \section{New Win32 Installer}
612 The Win32 installer has been modified in several very important
615 \item You must deinstall any current version of the
616 Win32 File daemon before upgrading to the new one.
617 If you forget to do so, the new installation will fail.
618 To correct this failure, you must manually shutdown
619 and deinstall the old File daemon.
620 \item All files (other than menu links) are installed
621 in {\bf c:/Program Files/Bacula}.
622 \item The installer no longer sets this
623 file to require administrator privileges by default. If you want
624 to do so, please do it manually using the {\bf cacls} program.
627 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
629 \item The server daemons (Director and Storage daemon) are
630 no longer included in the Windows installer. If you want the
631 Windows servers, you will either need to build them yourself (note
632 they have not been ported to 64 bits), or you can contact
633 Bacula Systems about this.
636 \section{Win64 Installer}
637 We have corrected a number of problems that required manual
638 editing of the conf files. In most cases, it should now
639 install and work. {\bf bat} is by default installed in
640 {\bf c:/Program Files/Bacula/bin32} rather than
641 {\bf c:/Program Files/Bacula} as is the case with the 32
642 bit Windows installer.
644 \section{Linux Bare Metal Recovery USB Key}
645 We have made a number of significant improvements in the
646 Bare Metal Recovery USB key. Please see the README files
647 it the {\bf rescue} release for more details.
649 We are working on an equivalent USB key for Windows bare
650 metal recovery, but it will take some time to develop it (best
651 estimate 3Q2010 or 4Q2010)
654 \section{bconsole Timeout Option}
655 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
656 for commands. This is useful with GUI programs that use {\bf bconsole}
657 to interface to the Director.
659 \section{Important Changes}
660 \label{sec:importantchanges}
663 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
664 to the same Pool. The Storage daemon ensures that you do not read and
665 write to the same Volume.
666 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
668 \item Virtually all the features of {\bf mtx-changer} have
669 now been parameterized, which allows you to configure
670 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
671 that contains variables that you can set to configure mtx-changer.
672 This configuration file will not be overwritten during upgrades.
673 We encourage you to submit any changes
674 that are made to mtx-changer and to parameterize it all in
675 mtx-changer.conf so that all configuration will be done by
676 changing only mtx-changer.conf.
677 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
678 and \texttt{transfer}. Please configure them as appropriate
680 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
681 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
682 password. If you want to use the new script, you will need to
683 manually change the \texttt{BackupCatalog} Job definition.
684 \item The \texttt{bconsole} \texttt{help} command now accepts
685 an argument, which if provided produces information on that
686 command (ex: \texttt{help run}).
690 \subsubsection*{Truncate volume after purge}
692 Note that the Truncate Volume after purge feature doesn't work as expected
693 in 5.0.0 version. Please, don't use it before version 5.0.1.
695 \subsection{Custom Catalog queries}
697 If you wish to add specialized commands that list the contents of the catalog,
698 you can do so by adding them to the \texttt{query.sql} file. This
699 \texttt{query.sql} file is now empty by default. The file
700 \texttt{examples/sample-query.sql} has an a number of sample commands
701 you might find useful.
703 \subsection{Deprecated parts}
705 The following items have been \textbf{deprecated} for a long time, and are now
706 removed from the code.
709 \item Support for SQLite 2
712 \section{Misc Changes}
713 \label{sec:miscchanges}
716 \item Updated Nagios check\_bacula
717 \item Updated man files
718 \item Added OSX package generation script in platforms/darwin
719 \item Added Spanish and Ukrainian Bacula translations
720 \item Enable/disable command shows only Jobs that can change
721 \item Added \texttt{show disabled} command to show disabled Jobs
722 \item Many ACL improvements
723 \item Added Level to FD status Job output
724 \item Begin Ingres DB driver (not yet working)
725 \item Split RedHat spec files into bacula, bat, mtx, and docs
726 \item Reorganized the manuals (fewer separate manuals)
727 \item Added lock/unlock order protection in lock manager
728 \item Allow 64 bit sizes for a number of variables
729 \item Fixed several deadlocks or potential race conditions in the SD
732 \chapter{Released Version 3.0.3 and 3.0.3a}
734 There are no new features in version 3.0.3. This version simply fixes a
735 number of bugs found in version 3.0.2 during the onging development
738 \chapter{New Features in Released Version 3.0.2}
740 This chapter presents the new features added to the
741 Released Bacula Version 3.0.2.
743 \section{Full Restore from a Given JobId}
744 \index[general]{Restore menu}
746 This feature allows selecting a single JobId and having Bacula
747 automatically select all the other jobs that comprise a full backup up to
748 and including the selected date (through JobId).
750 Assume we start with the following jobs:
752 +-------+--------------+---------------------+-------+----------+------------+
753 | jobid | client | starttime | level | jobfiles | jobbytes |
754 +-------+--------------+---------------------+-------+----------+------------
755 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
756 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
757 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
758 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
759 +-------+--------------+---------------------+-------+----------+------------+
762 Below is an example of this new feature (which is number 12 in the
767 To select the JobIds, you have the following choices:
768 1: List last 20 Jobs run
769 2: List Jobs where a given File is saved
771 12: Select full restore to a specified Job date
774 Select item: (1-13): 12
775 Enter JobId to get the state to restore: 5
776 Selecting jobs to build the Full state at 2009-07-15 11:45:45
777 You have selected the following JobIds: 1,3,5
779 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
780 1,444 files inserted into the tree.
783 This project was funded by Bacula Systems.
785 \section{Source Address}
786 \index[general]{Source Address}
788 A feature has been added which allows the administrator to specify the address
789 from which the Director and File daemons will establish connections. This
790 may be used to simplify system configuration overhead when working in complex
791 networks utilizing multi-homing and policy-routing.
793 To accomplish this, two new configuration directives have been implemented:
796 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
800 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
804 Simply adding specific host routes on the OS
805 would have an undesirable side-effect: any
806 application trying to contact the destination host would be forced to use the
807 more specific route possibly diverting management traffic onto a backup VLAN.
808 Instead of adding host routes for each client connected to a multi-homed backup
809 server (for example where there are management and backup VLANs), one can
810 use the new directives to specify a specific source address at the application
813 Additionally, this allows the simplification and abstraction of firewall rules
814 when dealing with a Hot-Standby director or storage daemon configuration. The
815 Hot-standby pair may share a CARP address, which connections must be sourced
816 from, while system services listen and act from the unique interface addresses.
818 This project was funded by Collaborative Fusion, Inc.
820 \section{Show volume availability when doing restore}
822 When doing a restore the selection dialog ends by displaying this
826 The job will require the following
827 Volume(s) Storage(s) SD Device(s)
828 ===========================================================================
839 Volumes marked with ``*'' are online (in the autochanger).
842 This should help speed up large restores by minimizing the time spent
843 waiting for the operator to discover that he must change tapes in the library.
845 This project was funded by Bacula Systems.
847 \section{Accurate estimate command}
849 The \texttt{estimate} command can now use the accurate code to detect changes
850 and give a better estimation.
852 You can set the accurate behavior on the command line by using
853 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
856 * estimate listing accurate=yes level=incremental job=BackupJob
859 This project was funded by Bacula Systems.
861 \chapter{New Features in 3.0.0}
862 \label{NewFeaturesChapter}
863 \index[general]{New Features}
865 This chapter presents the new features added to the development 2.5.x
866 versions to be released as Bacula version 3.0.0 sometime in April 2009.
868 \section{Accurate Backup}
869 \index[general]{Accurate Backup}
871 As with most other backup programs, by default Bacula decides what files to
872 backup for Incremental and Differental backup by comparing the change
873 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
874 backup completed. If one of those two times is later than the last backup
875 time, then the file will be backed up. This does not, however, permit tracking
876 what files have been deleted and will miss any file with an old time that may
877 have been restored to or moved onto the client filesystem.
879 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
880 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
881 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
882 backup, there is no difference, but for {\bf Differential} and {\bf
883 Incremental} backups, the Director will send a list of all previous files
884 backed up, and the File daemon will use that list to determine if any new files
885 have been added or or moved and if any files have been deleted. This allows
886 Bacula to make an accurate backup of your system to that point in time so that
887 if you do a restore, it will restore your system exactly.
890 about using Accurate backup is that it requires more resources (CPU and memory)
891 on both the Director and the Client machines to create the list of previous
892 files backed up, to send that list to the File daemon, for the File daemon to
893 keep the list (possibly very big) in memory, and for the File daemon to do
894 comparisons between every file in the FileSet and the list. In particular,
895 if your client has lots of files (more than a few million), you will need
896 lots of memory on the client machine.
898 Accurate must not be enabled when backing up with a plugin that is not
899 specially designed to work with Accurate. If you enable it, your restores
900 will probably not work correctly.
902 This project was funded by Bacula Systems.
907 \index[general]{Copy Jobs}
909 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
910 existing Migration feature with the exception that the Job that is copied is
911 left unchanged. This essentially creates two identical copies of the same
912 backup. However, the copy is treated as a copy rather than a backup job, and
913 hence is not directly available for restore. The {\bf restore} command lists
914 copy jobs and allows selection of copies by using \texttt{jobid=}
915 option. If the keyword {\bf copies} is present on the command line, Bacula will
916 display the list of all copies for selected jobs.
921 These JobIds have copies as follows:
922 +-------+------------------------------------+-----------+------------------+
923 | JobId | Job | CopyJobId | MediaType |
924 +-------+------------------------------------+-----------+------------------+
925 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
926 +-------+------------------------------------+-----------+------------------+
927 +-------+-------+----------+----------+---------------------+------------------+
928 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
929 +-------+-------+----------+----------+---------------------+------------------+
930 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
931 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
932 +-------+-------+----------+----------+---------------------+------------------+
933 You have selected the following JobIds: 19,2
935 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
936 5,611 files inserted into the tree.
941 The Copy Job runs without using the File daemon by copying the data from the
942 old backup Volume to a different Volume in a different Pool. See the Migration
943 documentation for additional details. For copy Jobs there is a new selection
944 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
945 not already copied to another Pool.
947 As with Migration, the Client, Volume, Job, or SQL query, are
948 other possible ways of selecting the Jobs to be copied. Selection
949 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
950 work, but are probably more suited for Migration Jobs.
952 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
953 it will promote the Copy to a \textsl{real} backup job and will make it available for
954 automatic restore. If more than one Copy is available, it will promote the copy
955 with the smallest JobId.
957 A nice solution which can be built with the new Copy feature is often
958 called disk-to-disk-to-tape backup (DTDTT). A sample config could
959 look something like the one below:
963 Name = FullBackupsVirtualPool
965 Purge Oldest Volume = Yes
967 NextPool = FullBackupsTapePool
971 Name = FullBackupsTapePool
975 Volume Retention = 365 days
976 Storage = superloader
980 # Fake fileset for copy jobs
992 # Fake client for copy jobs
1002 # Default template for a CopyDiskToTape Job
1005 Name = CopyDiskToTape
1007 Messages = StandardCopy
1010 Selection Type = PoolUncopiedJobs
1011 Maximum Concurrent Jobs = 10
1013 Allow Duplicate Jobs = Yes
1014 Cancel Queued Duplicates = No
1015 Cancel Running Duplicates = No
1020 Name = DaySchedule7:00
1021 Run = Level=Full daily at 7:00
1025 Name = CopyDiskToTapeFullBackups
1027 Schedule = DaySchedule7:00
1028 Pool = FullBackupsVirtualPool
1029 JobDefs = CopyDiskToTape
1033 The example above had 2 pool which are copied using the PoolUncopiedJobs
1034 selection criteria. Normal Full backups go to the Virtual pool and are copied
1035 to the Tape pool the next morning.
1037 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1042 +-------+------------------------------------+-----------+------------------+
1043 | JobId | Job | CopyJobId | MediaType |
1044 +-------+------------------------------------+-----------+------------------+
1045 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1046 +-------+------------------------------------+-----------+------------------+
1049 \section{ACL Updates}
1050 \index[general]{ACL Updates}
1051 The whole ACL code had been overhauled and in this version each platforms has
1052 different streams for each type of acl available on such an platform. As ACLs
1053 between platforms tend to be not that portable (most implement POSIX acls but
1054 some use an other draft or a completely different format) we currently only
1055 allow certain platform specific ACL streams to be decoded and restored on the
1056 same platform that they were created on. The old code allowed to restore ACL
1057 cross platform but the comments already mention that not being to wise. For
1058 backward compatability the new code will accept the two old ACL streams and
1059 handle those with the platform specific handler. But for all new backups it
1060 will save the ACLs using the new streams.
1062 Currently the following platforms support ACLs:
1066 \item {\bf Darwin/OSX}
1075 Currently we support the following ACL types (these ACL streams use a reserved
1076 part of the stream numbers):
1079 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1081 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1082 string representation from acl\_to\_text (POSIX acl)
1083 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1084 string representation from acl\_to\_text (POSIX acl) for default acls.
1085 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1086 string representation from acl\_to\_text (POSIX acl) for access acls.
1087 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1088 string representation from acltostr (POSIX acl)
1089 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1090 representation from acl\_to\_text (POSIX acl) for default acls.
1091 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1092 representation from acl\_to\_text (POSIX acl) for access acls.
1093 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1094 string representation from acl\_to\_text (POSIX acl) for default acls.
1095 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1096 representation from acl\_to\_text (POSIX acl) for access acls.
1097 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1098 string representation from acl\_to\_text (POSIX acl) for default acls.
1099 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1100 string representation from acl\_to\_text (POSIX acl) for default acls.
1101 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1102 representation from acl\_to\_text (POSIX acl) for access acls.
1103 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1104 string representation from acltotext or acl\_totext (POSIX acl)
1105 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1106 representation from from acl\_totext (NFSv4 or ZFS acl)
1109 In future versions we might support conversion functions from one type of acl
1110 into an other for types that are either the same or easily convertable. For now
1111 the streams are seperate and restoring them on a platform that doesn't
1112 recognize them will give you a warning.
1114 \section{Extended Attributes}
1115 \index[general]{Extended Attributes}
1116 Something that was on the project list for some time is now implemented for
1117 platforms that support a similar kind of interface. Its the support for backup
1118 and restore of so called extended attributes. As extended attributes are so
1119 platform specific these attributes are saved in seperate streams for each
1120 platform. Restores of the extended attributes can only be performed on the
1121 same platform the backup was done. There is support for all types of extended
1122 attributes, but restoring from one type of filesystem onto an other type of
1123 filesystem on the same platform may lead to supprises. As extended attributes
1124 can contain any type of data they are stored as a series of so called
1125 value-pairs. This data must be seen as mostly binary and is stored as such.
1126 As security labels from selinux are also extended attributes this option also
1127 stores those labels and no specific code is enabled for handling selinux
1130 Currently the following platforms support extended attributes:
1132 \item {\bf Darwin/OSX}
1138 On linux acls are also extended attributes, as such when you enable ACLs on a
1139 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1140 and not the same exteneded attribute.
1142 To enable the backup of extended attributes please add the following to your
1157 \section{Shared objects}
1158 \index[general]{Shared objects}
1159 A default build of Bacula will now create the libraries as shared objects
1160 (.so) rather than static libraries as was previously the case.
1161 The shared libraries are built using {\bf libtool} so it should be quite
1164 An important advantage of using shared objects is that on a machine with the
1165 Directory, File daemon, the Storage daemon, and a console, you will have only
1166 one copy of the code in memory rather than four copies. Also the total size of
1167 the binary release is smaller since the library code appears only once rather
1168 than once for every program that uses it; this results in significant reduction
1169 in the size of the binaries particularly for the utility tools.
1171 In order for the system loader to find the shared objects when loading the
1172 Bacula binaries, the Bacula shared objects must either be in a shared object
1173 directory known to the loader (typically /usr/lib) or they must be in the
1174 directory that may be specified on the {\bf ./configure} line using the {\bf
1175 {-}{-}libdir} option as:
1178 ./configure --libdir=/full-path/dir
1181 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1182 no need to modify your loader configuration provided that
1183 the shared objects are installed in that directory (Bacula
1184 does this with the make install command). The shared objects
1185 that Bacula references are:
1194 These files are symbolically linked to the real shared object file,
1195 which has a version number to permit running multiple versions of
1196 the libraries if desired (not normally the case).
1198 If you have problems with libtool or you wish to use the old
1199 way of building static libraries, or you want to build a static
1200 version of Bacula you may disable
1201 libtool on the configure command line with:
1204 ./configure --disable-libtool
1208 \section{Building Static versions of Bacula}
1209 \index[general]{Static linking}
1210 In order to build static versions of Bacula, in addition
1211 to configuration options that were needed you now must
1212 also add --disable-libtool. Example
1215 ./configure --enable-static-client-only --disable-libtool
1219 \section{Virtual Backup (Vbackup)}
1220 \index[general]{Virtual Backup}
1221 \index[general]{Vbackup}
1223 Bacula's virtual backup feature is often called Synthetic Backup or
1224 Consolidation in other backup products. It permits you to consolidate the
1225 previous Full backup plus the most recent Differential backup and any
1226 subsequent Incremental backups into a new Full backup. This new Full
1227 backup will then be considered as the most recent Full for any future
1228 Incremental or Differential backups. The VirtualFull backup is
1229 accomplished without contacting the client by reading the previous backup
1230 data and writing it to a volume in a different pool.
1232 In some respects the Vbackup feature works similar to a Migration job, in
1233 that Bacula normally reads the data from the pool specified in the
1234 Job resource, and writes it to the {\bf Next Pool} specified in the
1235 Job resource. Note, this means that usually the output from the Virtual
1236 Backup is written into a different pool from where your prior backups
1237 are saved. Doing it this way guarantees that you will not get a deadlock
1238 situation attempting to read and write to the same volume in the Storage
1239 daemon. If you then want to do subsequent backups, you may need to
1240 move the Virtual Full Volume back to your normal backup pool.
1241 Alternatively, you can set your {\bf Next Pool} to point to the current
1242 pool. This will cause Bacula to read and write to Volumes in the
1243 current pool. In general, this will work, because Bacula will
1244 not allow reading and writing on the same Volume. In any case, once
1245 a VirtualFull has been created, and a restore is done involving the
1246 most current Full, it will read the Volume or Volumes by the VirtualFull
1247 regardless of in which Pool the Volume is found.
1249 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1250 a level of {\bf VirtualFull}.
1252 A typical Job resource definition might look like the following:
1259 FileSet = "Full Set"
1266 # Default pool definition
1270 Recycle = yes # Automatically recycle Volumes
1271 AutoPrune = yes # Prune expired volumes
1272 Volume Retention = 365d # one year
1280 Recycle = yes # Automatically recycle Volumes
1281 AutoPrune = yes # Prune expired volumes
1282 Volume Retention = 365d # one year
1283 Storage = DiskChanger
1286 # Definition of file storage device
1291 Device = FileStorage
1293 Maximum Concurrent Jobs = 5
1296 # Definition of DDS Virtual tape disk storage device
1299 Address = localhost # N.B. Use a fully qualified name here
1301 Device = DiskChanger
1302 Media Type = DiskChangerMedia
1303 Maximum Concurrent Jobs = 4
1308 Then in bconsole or via a Run schedule, you would run the job as:
1311 run job=MyBackup level=Full
1312 run job=MyBackup level=Incremental
1313 run job=MyBackup level=Differential
1314 run job=MyBackup level=Incremental
1315 run job=MyBackup level=Incremental
1318 So providing there were changes between each of those jobs, you would end up
1319 with a Full backup, a Differential, which includes the first Incremental
1320 backup, then two Incremental backups. All the above jobs would be written to
1321 the {\bf Default} pool.
1323 To consolidate those backups into a new Full backup, you would run the
1327 run job=MyBackup level=VirtualFull
1330 And it would produce a new Full backup without using the client, and the output
1331 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1333 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1336 Note, the Start and End time of the Virtual Full backup is set to the
1337 values for the last job included in the Virtual Full (in the above example,
1338 it is an Increment). This is so that if another incremental is done, which
1339 will be based on the Virtual Full, it will backup all files from the
1340 last Job included in the Virtual Full rather than from the time the Virtual
1341 Full was actually run.
1345 \section{Catalog Format}
1346 \index[general]{Catalog Format}
1347 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1348 operation will convert the FileId field of the File table from 32 bits (max 4
1349 billion table entries) to 64 bits (very large number of items). The
1350 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1351 your catalog during the conversion. Also you won't be able to run jobs during
1352 this conversion period. For example, a 3 million file catalog will take 2
1353 minutes to upgrade on a normal machine. Please don't forget to make a valid
1354 backup of your database before executing the upgrade script. See the
1355 ReleaseNotes for additional details.
1357 \section{64 bit Windows Client}
1358 \index[general]{Win64 Client}
1359 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1360 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1361 As a consequence, we are also releasing a 64 bit version of the Bacula
1362 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1363 These binaries should only be installed on 64 bit Windows operating systems.
1364 What is important is not your hardware but whether or not you have
1365 a 64 bit version of the Windows OS.
1367 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1369 \item Before installing the Win64 Bacula Client, you must totally
1370 deinstall any prior 2.4.x Client installation using the
1371 Bacula deinstallation (see the menu item). You may want
1372 to save your .conf files first.
1373 \item Only the Client (File daemon) is ported to Win64, the Director
1374 and the Storage daemon are not in the 64 bit Windows installer.
1375 \item bwx-console is not yet ported.
1376 \item bconsole is ported but it has not been tested.
1377 \item The documentation is not included in the installer.
1378 \item Due to Vista security restrictions imposed on a default installation
1379 of Vista, before upgrading the Client, you must manually stop
1380 any prior version of Bacula from running, otherwise the install
1382 \item Due to Vista security restrictions imposed on a default installation
1383 of Vista, attempting to edit the conf files via the menu items
1384 will fail. You must directly edit the files with appropriate
1385 permissions. Generally double clicking on the appropriate .conf
1386 file will work providing you have sufficient permissions.
1387 \item All Bacula files are now installed in
1388 {\bf C:/Program Files/Bacula} except the main menu items,
1389 which are installed as before. This vastly simplifies the installation.
1390 \item If you are running on a foreign language version of Windows, most
1391 likely {\bf C:/Program Files} does not exist, so you should use the
1392 Custom installation and enter an appropriate location to install
1394 \item The 3.0.0 Win32 Client continues to install files in the locations used
1395 by prior versions. For the next version we will convert it to use
1396 the same installation conventions as the Win64 version.
1399 This project was funded by Bacula Systems.
1402 \section{Duplicate Job Control}
1403 \index[general]{Duplicate Jobs}
1404 The new version of Bacula provides four new directives that
1405 give additional control over what Bacula does if duplicate jobs
1406 are started. A duplicate job in the sense we use it here means
1407 a second or subsequent job with the same name starts. This
1408 happens most frequently when the first job runs longer than expected because no
1409 tapes are available.
1411 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1412 are specified in the Job resource.
1416 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1417 \index[general]{Allow Duplicate Jobs}
1418 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1419 the directive is set to {\bf no} (default) then only one job of a given name
1420 may run at one time, and the action that Bacula takes to ensure only
1421 one job runs is determined by the other directives (see below).
1423 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1424 are present and none of the three directives given below permit
1425 cancelling a job, then the current job (the second one started)
1428 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1429 \index[general]{Allow Higher Duplicates}
1430 This directive was in version 5.0.0, but does not work as
1431 expected. If used, it should always be set to no. In later versions
1432 of Bacula the directive is disabled (disregarded).
1434 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1435 \index[general]{Cancel Running Duplicates}
1436 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1437 if this directive is set to {\bf yes} any job that is already running
1438 will be canceled. The default is {\bf no}.
1440 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1441 \index[general]{Cancel Queued Duplicates}
1442 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1443 if this directive is set to {\bf yes} any job that is
1444 already queued to run but not yet running will be canceled.
1445 The default is {\bf no}.
1448 \section{TLS Authentication}
1449 \index[general]{TLS Authentication}
1450 In Bacula version 2.5.x and later, in addition to the normal Bacula
1451 CRAM-MD5 authentication that is used to authenticate each Bacula
1452 connection, you can specify that you want TLS Authentication as well,
1453 which will provide more secure authentication.
1455 This new feature uses Bacula's existing TLS code (normally used for
1456 communications encryption) to do authentication. To use it, you must
1457 specify all the TLS directives normally used to enable communications
1458 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1461 \subsection{TLS Authenticate = yes}
1463 TLS Authenticate = yes
1466 in the main daemon configuration resource (Director for the Director,
1467 Client for the File daemon, and Storage for the Storage daemon).
1469 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1470 authentication, Bacula will also do TLS authentication, then TLS
1471 encryption will be turned off, and the rest of the communication between
1472 the two Bacula daemons will be done without encryption.
1474 If you want to encrypt communications data, use the normal TLS directives
1475 but do not turn on {\bf TLS Authenticate}.
1477 \section{bextract non-portable Win32 data}
1478 \index[general]{bextract handles Win32 non-portable data}
1479 {\bf bextract} has been enhanced to be able to restore
1480 non-portable Win32 data to any OS. Previous versions were
1481 unable to restore non-portable Win32 data to machines that
1482 did not have the Win32 BackupRead and BackupWrite API calls.
1484 \section{State File updated at Job Termination}
1485 \index[general]{State File}
1486 In previous versions of Bacula, the state file, which provides a
1487 summary of previous jobs run in the {\bf status} command output was
1488 updated only when Bacula terminated, thus if the daemon crashed, the
1489 state file might not contain all the run data. This version of
1490 the Bacula daemons updates the state file on each job termination.
1492 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1493 \index[general]{MaxFullInterval}
1494 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1495 can be used to specify the maximum time interval between {\bf Full} backup
1496 jobs. When a job starts, if the time since the last Full backup is
1497 greater than the specified interval, and the job would normally be an
1498 {\bf Incremental} or {\bf Differential}, it will be automatically
1499 upgraded to a {\bf Full} backup.
1501 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1502 \index[general]{MaxDiffInterval}
1503 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1504 can be used to specify the maximum time interval between {\bf Differential} backup
1505 jobs. When a job starts, if the time since the last Differential backup is
1506 greater than the specified interval, and the job would normally be an
1507 {\bf Incremental}, it will be automatically
1508 upgraded to a {\bf Differential} backup.
1510 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1511 \index[general]{MaxDiffInterval}
1512 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1513 by the user, and when it is set it is an indication to backup programs
1514 to not backup that particular file. This version of Bacula contains a
1515 new Options directive within a FileSet resource, which instructs Bacula to
1516 obey this flag. The new directive is:
1519 Honor No Dump Flag = yes\vb{}no
1522 The default value is {\bf no}.
1525 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1526 \index[general]{IgnoreDir}
1527 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1528 can be added to the Include section of the FileSet resource. If the specified
1529 filename ({\bf filename-string}) is found on the Client in any directory to be
1530 backed up, the whole directory will be ignored (not backed up). For example:
1533 # List of files to be backed up
1541 Exclude Dir Containing = .excludeme
1546 But in /home, there may be hundreds of directories of users and some
1547 people want to indicate that they don't want to have certain
1548 directories backed up. For example, with the above FileSet, if
1549 the user or sysadmin creates a file named {\bf .excludeme} in
1550 specific directories, such as
1553 /home/user/www/cache/.excludeme
1554 /home/user/temp/.excludeme
1557 then Bacula will not backup the two directories named:
1560 /home/user/www/cache
1564 NOTE: subdirectories will not be backed up. That is, the directive
1565 applies to the two directories in question and any children (be they
1566 files, directories, etc).
1569 \section{Bacula Plugins}
1570 \index[general]{Plugin}
1571 Support for shared object plugins has been implemented in the Linux, Unix
1572 and Win32 File daemons. The API will be documented separately in
1573 the Developer's Guide or in a new document. For the moment, there is
1574 a single plugin named {\bf bpipe} that allows an external program to
1575 get control to backup and restore a file.
1577 Plugins are also planned (partially implemented) in the Director and the
1580 \subsection{Plugin Directory}
1581 \index[general]{Plugin Directory}
1582 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1583 be added to the daemon definition resource. The directory takes a quoted
1584 string argument, which is the name of the directory in which the daemon can
1585 find the Bacula plugins. If this directive is not specified, Bacula will not
1586 load any plugins. Since each plugin has a distinctive name, all the daemons
1587 can share the same plugin directory.
1589 \subsection{Plugin Options}
1590 \index[general]{Plugin Options}
1591 The {\bf Plugin Options} directive takes a quoted string
1592 arguement (after the equal sign) and may be specified in the
1593 Job resource. The options specified will be passed to all plugins
1594 when they are run. This each plugin must know what it is looking
1595 for. The value defined in the Job resource can be modified
1596 by the user when he runs a Job via the {\bf bconsole} command line
1599 Note: this directive may be specified, and there is code to modify
1600 the string in the run command, but the plugin options are not yet passed to
1601 the plugin (i.e. not fully implemented).
1603 \subsection{Plugin Options ACL}
1604 \index[general]{Plugin Options ACL}
1605 The {\bf Plugin Options ACL} directive may be specified in the
1606 Director's Console resource. It functions as all the other ACL commands
1607 do by permitting users running restricted consoles to specify a
1608 {\bf Plugin Options} that overrides the one specified in the Job
1609 definition. Without this directive restricted consoles may not modify
1612 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1613 \index[general]{Plugin}
1614 The {\bf Plugin} directive is specified in the Include section of
1615 a FileSet resource where you put your {\bf File = xxx} directives.
1626 Plugin = "bpipe:..."
1631 In the above example, when the File daemon is processing the directives
1632 in the Include section, it will first backup all the files in {\bf /home}
1633 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1634 the Plugin Directory. The syntax and semantics of the Plugin directive
1635 require the first part of the string up to the colon (:) to be the name
1636 of the plugin. Everything after the first colon is ignored by the File daemon but
1637 is passed to the plugin. Thus the plugin writer may define the meaning of the
1638 rest of the string as he wishes.
1640 Please see the next section for information about the {\bf bpipe} Bacula
1643 \section{The bpipe Plugin}
1644 \index[general]{The bpipe Plugin}
1645 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1646 the Bacula source distribution. When the plugin is compiled and linking into
1647 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1648 Please note that this is a very simple plugin that was written for
1649 demonstration and test purposes. It is and can be used in production, but
1650 that was never really intended.
1652 The purpose of the plugin is to provide an interface to any system program for
1653 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1654 the Include section of your Job's FileSet resource. The full syntax of the
1655 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1656 to specify the sytax as it wishes) is:
1659 Plugin = "<field1>:<field2>:<field3>:<field4>"
1664 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1665 stripped off, so in this case, we would put {\bf bpipe} in this field.
1667 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1668 pseudo path and filename under which the backup will be saved. This pseudo
1669 path and filename will be seen by the user in the restore file tree.
1670 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1671 backed up by the plugin will be put under that "pseudo" path and filename.
1672 You must be careful to choose a naming convention that is unique to avoid
1673 a conflict with a path and filename that actually exists on your system.
1675 \item {\bf field3} for the {\bf bpipe} plugin
1676 specifies the "reader" program that is called by the plugin during
1677 backup to read the data. {\bf bpipe} will call this program by doing a
1680 \item {\bf field4} for the {\bf bpipe} plugin
1681 specifies the "writer" program that is called by the plugin during
1682 restore to write the data back to the filesystem.
1685 Please note that for two items above describing the "reader" and "writer"
1686 fields, these programs are "executed" by Bacula, which
1687 means there is no shell interpretation of any command line arguments
1688 you might use. If you want to use shell characters (redirection of input
1689 or output, ...), then we recommend that you put your command or commands
1690 in a shell script and execute the script. In addition if you backup a
1691 file with the reader program, when running the writer program during
1692 the restore, Bacula will not automatically create the path to the file.
1693 Either the path must exist, or you must explicitly do so with your command
1694 or in a shell script.
1696 Putting it all together, the full plugin directive line might look
1700 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1701 --opt --databases bacula:mysql"
1704 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1705 would be written on a single line.
1707 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1708 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1709 program {\bf mysqldump -f --opt --database bacula} to read the data during
1710 backup. The mysqldump command outputs all the data for the database named
1711 {\bf bacula}, which will be read by the plugin and stored in the backup.
1712 During restore, the data that was backed up will be sent to the program
1713 specified in the last field, which in this case is {\bf mysql}. When
1714 {\bf mysql} is called, it will read the data sent to it by the plugn
1715 then write it back to the same database from which it came ({\bf bacula}
1718 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1719 the data from a specified program to Bacula for backup, and then from Bacula to
1720 a specified program for restore.
1722 By using different command lines to {\bf bpipe},
1723 you can backup any kind of data (ASCII or binary) depending
1724 on the program called.
1726 \section{Microsoft Exchange Server 2003/2007 Plugin}
1727 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1728 \subsection{Background}
1729 The Exchange plugin was made possible by a funded development project
1730 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1731 The code for the plugin was written by James Harper, and the Bacula core
1732 code by Kern Sibbald. All the code for this funded development has become
1733 part of the Bacula project. Thanks to everyone who made it happen.
1735 \subsection{Concepts}
1736 Although it is possible to backup Exchange using Bacula VSS the Exchange
1737 plugin adds a good deal of functionality, because while Bacula VSS
1738 completes a full backup (snapshot) of Exchange, it does
1739 not support Incremental or Differential backups, restoring is more
1740 complicated, and a single database restore is not possible.
1742 Microsoft Exchange organises its storage into Storage Groups with
1743 Databases inside them. A default installation of Exchange will have a
1744 single Storage Group called 'First Storage Group', with two Databases
1745 inside it, "Mailbox Store (SERVER NAME)" and
1746 "Public Folder Store (SERVER NAME)",
1747 which hold user email and public folders respectively.
1749 In the default configuration, Exchange logs everything that happens to
1750 log files, such that if you have a backup, and all the log files since,
1751 you can restore to the present time. Each Storage Group has its own set
1752 of log files and operates independently of any other Storage Groups. At
1753 the Storage Group level, the logging can be turned off by enabling a
1754 function called "Enable circular logging". At this time the Exchange
1755 plugin will not function if this option is enabled.
1757 The plugin allows backing up of entire storage groups, and the restoring
1758 of entire storage groups or individual databases. Backing up and
1759 restoring at the individual mailbox or email item is not supported but
1760 can be simulated by use of the "Recovery" Storage Group (see below).
1762 \subsection{Installing}
1763 The Exchange plugin requires a DLL that is shipped with Microsoft
1764 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1765 correctly the Exchange plugin should find this automatically and run
1766 without any additional installation.
1768 If the DLL can not be found automatically it will need to be copied into
1769 the Bacula installation
1770 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1771 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1772 default Exchange installation.
1774 \subsection{Backing Up}
1775 To back up an Exchange server the Fileset definition must contain at
1776 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1777 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1778 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1779 up files are prefixed with something that isn't going to share a name
1780 with something outside the plugin, and the 'Microsoft Information Store'
1781 bit is required also. It is also possible to add the name of a storage
1782 group to the "Plugin =" line, eg \\
1783 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1784 if you want only a single storage group backed up.
1786 Additionally, you can suffix the 'Plugin =' directive with
1787 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1788 database at the end of a full backup.
1790 An Incremental or Differential backup will backup only the database logs
1791 for each Storage Group by inspecting the "modified date" on each
1792 physical log file. Because of the way the Exchange API works, the last
1793 logfile backed up on each backup will always be backed up by the next
1794 Incremental or Differential backup too. This adds 5MB to each
1795 Incremental or Differential backup size but otherwise does not cause any
1798 By default, a normal VSS fileset containing all the drive letters will
1799 also back up the Exchange databases using VSS. This will interfere with
1800 the plugin and Exchange's shared ideas of when the last full backup was
1801 done, and may also truncate log files incorrectly. It is important,
1802 therefore, that the Exchange database files be excluded from the backup,
1803 although the folders the files are in should be included, or they will
1804 have to be recreated manually if a baremetal restore is done.
1809 File = C:/Program Files/Exchsrvr/mdbdata
1810 Plugin = "exchange:..."
1813 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1814 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1815 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1816 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1817 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1818 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1819 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1824 The advantage of excluding the above files is that you can significantly
1825 reduce the size of your backup since all the important Exchange files
1826 will be properly saved by the Plugin.
1829 \subsection{Restoring}
1830 The restore operation is much the same as a normal Bacula restore, with
1831 the following provisos:
1834 \item The {\bf Where} restore option must not be specified
1835 \item Each Database directory must be marked as a whole. You cannot just
1836 select (say) the .edb file and not the others.
1837 \item If a Storage Group is restored, the directory of the Storage Group
1839 \item It is possible to restore only a subset of the available log files,
1840 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1841 if a log file is missing from the sequence of log files
1842 \item Each database to be restored must be dismounted and marked as "Can be
1843 overwritten by restore"
1844 \item If an entire Storage Group is to be restored (eg all databases and
1845 logs in the Storage Group), then it is best to manually delete the
1846 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1847 as Exchange can get confused by stray log files lying around.
1850 \subsection{Restoring to the Recovery Storage Group}
1851 The concept of the Recovery Storage Group is well documented by
1853 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1854 but to briefly summarize...
1856 Microsoft Exchange allows the creation of an additional Storage Group
1857 called the Recovery Storage Group, which is used to restore an older
1858 copy of a database (e.g. before a mailbox was deleted) into without
1859 messing with the current live data. This is required as the Standard and
1860 Small Business Server versions of Exchange can not ordinarily have more
1861 than one Storage Group.
1863 To create the Recovery Storage Group, drill down to the Server in Exchange
1864 System Manager, right click, and select
1865 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1866 locations and click OK. On the Recovery Storage Group, right click and
1867 select {\bf "Add Database to Recover..."} and select the database you will
1870 Restore only the single database nominated as the database in the
1871 Recovery Storage Group. Exchange will redirect the restore to the
1872 Recovery Storage Group automatically.
1873 Then run the restore.
1875 \subsection{Restoring on Microsoft Server 2007}
1876 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1877 2007, and henc you use a new proceedure for recovering a single mail box.
1878 This procedure is ducomented by Microsoft at:
1879 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1880 and involves using the {\bf Restore-Mailbox} and {\bf
1881 Get-MailboxStatistics} shell commands.
1883 \subsection{Caveats}
1884 This plugin is still being developed, so you should consider it
1885 currently in BETA test, and thus use in a production environment
1886 should be done only after very careful testing.
1888 When doing a full backup, the Exchange database logs are truncated by
1889 Exchange as soon as the plugin has completed the backup. If the data
1890 never makes it to the backup medium (eg because of spooling) then the
1891 logs will still be truncated, but they will also not have been backed
1892 up. A solution to this is being worked on. You will have to schedule a
1893 new Full backup to ensure that your next backups will be usable.
1895 The "Enable Circular Logging" option cannot be enabled or the plugin
1898 Exchange insists that a successful Full backup must have taken place if
1899 an Incremental or Differential backup is desired, and the plugin will
1900 fail if this is not the case. If a restore is done, Exchange will
1901 require that a Full backup be done before an Incremental or Differential
1904 The plugin will most likely not work well if another backup application
1905 (eg NTBACKUP) is backing up the Exchange database, especially if the
1906 other backup application is truncating the log files.
1908 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1909 we recommend either carefully testing or that you avoid this option for
1912 The Exchange plugin is not called during processing the bconsole {\bf
1913 estimate} command, and so anything that would be backed up by the plugin
1914 will not be added to the estimate total that is displayed.
1917 \section{libdbi Framework}
1918 \index[general]{libdbi Framework}
1919 As a general guideline, Bacula has support for a few catalog database drivers
1920 (MySQL, PostgreSQL, SQLite)
1921 coded natively by the Bacula team. With the libdbi implementation, which is a
1922 Bacula driver that uses libdbi to access the catalog, we have an open field to
1923 use many different kinds database engines following the needs of users.
1925 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1926 implements a database-independent abstraction layer in C, similar to the
1927 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1928 leverage the power of multiple databases and multiple simultaneous database
1929 connections by using this framework.
1931 Currently the libdbi driver in Bacula project only supports the same drivers
1932 natively coded in Bacula. However the libdbi project has support for many
1933 others database engines. You can view the list at
1934 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1935 supported by Bacula, however, they must be tested properly by the Bacula team.
1937 Some of benefits of using libdbi are:
1939 \item The possibility to use proprietary databases engines in which your
1940 proprietary licenses prevent the Bacula team from developing the driver.
1941 \item The possibility to use the drivers written for the libdbi project.
1942 \item The possibility to use other database engines without recompiling Bacula
1943 to use them. Just change one line in bacula-dir.conf
1944 \item Abstract Database access, this is, unique point to code and profiling
1945 catalog database access.
1948 The following drivers have been tested:
1950 \item PostgreSQL, with and without batch insert
1951 \item Mysql, with and without batch insert
1956 In the future, we will test and approve to use others databases engines
1957 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1959 To compile Bacula to support libdbi we need to configure the code with the
1960 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1961 [database] is the database engine to be used with Bacula (of course we can
1962 change the driver in file bacula-dir.conf, see below). We must configure the
1963 access port of the database engine with the option --with-db-port, because the
1964 libdbi framework doesn't know the default access port of each database.
1966 The next phase is checking (or configuring) the bacula-dir.conf, example:
1970 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1971 dbname = regress; user = regress; password = ""
1975 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1976 mysql database. Currently the drivers supported by Bacula are: postgresql,
1977 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1979 The following limitations apply when Bacula is set to use the libdbi framework:
1980 - Not tested on the Win32 platform
1981 - A little performance is lost if comparing with native database driver.
1982 The reason is bound with the database driver provided by libdbi and the
1983 simple fact that one more layer of code was added.
1985 It is important to remember, when compiling Bacula with libdbi, the
1986 following packages are needed:
1988 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1989 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1992 You can download them and compile them on your system or install the packages
1993 from your OS distribution.
1995 \section{Console Command Additions and Enhancements}
1996 \index[general]{Console Additions}
1998 \subsection{Display Autochanger Content}
1999 \index[general]{StatusSlots}
2001 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2002 autochanger content.
2006 Slot | Volume Name | Status | Media Type | Pool |
2007 ------+---------------+----------+-------------------+------------|
2008 1 | 00001 | Append | DiskChangerMedia | Default |
2009 2 | 00002 | Append | DiskChangerMedia | Default |
2010 3*| 00003 | Append | DiskChangerMedia | Scratch |
2015 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2016 {\bf update slots} command to synchronize autochanger content with your
2019 \subsection{list joblog job=xxx or jobid=nnn}
2020 \index[general]{list joblog}
2021 A new list command has been added that allows you to list the contents
2022 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2023 or for a particular JobId. The {\bf llist} command will include a line with
2024 the time and date of the entry.
2026 Note for the catalog to have Job Log entries, you must have a directive
2033 In your Director's {\bf Messages} resource.
2035 \subsection{Use separator for multiple commands}
2036 \index[general]{Command Separator}
2037 When using bconsole with readline, you can set the command separator with
2038 \textbf{@separator} command to one
2039 of those characters to write commands who require multiple input in one line.
2041 !$%&'()*+,-/:;<>?[]^`{|}~
2044 \subsection{Deleting Volumes}
2045 The delete volume bconsole command has been modified to
2046 require an asterisk (*) in front of a MediaId otherwise the
2047 value you enter is a taken to be a Volume name. This is so that
2048 users may delete numeric Volume names. The previous Bacula versions
2049 assumed that all input that started with a number was a MediaId.
2051 This new behavior is indicated in the prompt if you read it
2054 \section{Bare Metal Recovery}
2055 The old bare metal recovery project is essentially dead. One
2056 of the main features of it was that it would build a recovery
2057 CD based on the kernel on your system. The problem was that
2058 every distribution has a different boot procedure and different
2059 scripts, and worse yet, the boot procedures and scripts change
2060 from one distribution to another. This meant that maintaining
2061 (keeping up with the changes) the rescue CD was too much work.
2063 To replace it, a new bare metal recovery USB boot stick has been developed
2064 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2065 boot from a USB key.
2069 \item Recovery can be done from within graphical environment.
2070 \item Recovery can be done in a shell.
2071 \item Ubuntu boots on a large number of Linux systems.
2072 \item The process of updating the system and adding new
2073 packages is not too difficult.
2074 \item The USB key can easily be upgraded to newer Ubuntu versions.
2075 \item The USB key has writable partitions for modifications to
2076 the OS and for modification to your home directory.
2077 \item You can add new files/directories to the USB key very easily.
2078 \item You can save the environment from multiple machines on
2080 \item Bacula Systems is funding its ongoing development.
2083 The disadvantages are:
2085 \item The USB key is usable but currently under development.
2086 \item Not everyone may be familiar with Ubuntu (no worse
2088 \item Some older OSes cannot be booted from USB. This can
2089 be resolved by first booting a Ubuntu LiveCD then plugging
2091 \item Currently the documentation is sketchy and not yet added
2092 to the main manual. See below ...
2095 The documentation and the code can be found in the {\bf rescue} package
2096 in the directory {\bf linux/usb}.
2098 \section{Miscellaneous}
2099 \index[general]{Misc New Features}
2101 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2102 \index[general]{Allow Mixed Priority}
2103 This directive is only implemented in version 2.5 and later. When
2104 set to {\bf yes} (default {\bf no}), this job may run even if lower
2105 priority jobs are already running. This means a high priority job
2106 will not have to wait for other jobs to finish before starting.
2107 The scheduler will only mix priorities when all running jobs have
2110 Note that only higher priority jobs will start early. Suppose the
2111 director will allow two concurrent jobs, and that two jobs with
2112 priority 10 are running, with two more in the queue. If a job with
2113 priority 5 is added to the queue, it will be run as soon as one of
2114 the running jobs finishes. However, new priority 10 jobs will not
2115 be run until the priority 5 job has finished.
2117 \subsection{Bootstrap File Directive -- FileRegex}
2118 \index[general]{Bootstrap File Directive}
2119 {\bf FileRegex} is a new command that can be added to the bootstrap
2120 (.bsr) file. The value is a regular expression. When specified, only
2121 matching filenames will be restored.
2123 During a restore, if all File records are pruned from the catalog
2124 for a Job, normally Bacula can restore only all files saved. That
2125 is there is no way using the catalog to select individual files.
2126 With this new feature, Bacula will ask if you want to specify a Regex
2127 expression for extracting only a part of the full backup.
2130 Building directory tree for JobId(s) 1,3 ...
2131 There were no files inserted into the tree, so file selection
2132 is not possible.Most likely your retention policy pruned the files
2134 Do you want to restore all the files? (yes\vb{}no): no
2136 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2137 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2140 \subsection{Bootstrap File Optimization Changes}
2141 In order to permit proper seeking on disk files, we have extended the bootstrap
2142 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2143 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2144 address range and end address range respectively. These two directives replace
2145 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2146 VolEndBlock} directives. Bootstrap files containing the old directives will
2147 still work, but will not properly take advantage of proper disk seeking, and
2148 may read completely to the end of a disk volume during a restore. With the new
2149 format (automatically generated by the new Director), restores will seek
2150 properly and stop reading the volume when all the files have been restored.
2152 \subsection{Solaris ZFS/NFSv4 ACLs}
2153 This is an upgrade of the previous Solaris ACL backup code
2154 to the new library format, which will backup both the old
2155 POSIX(UFS) ACLs as well as the ZFS ACLs.
2157 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2158 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2159 be used to transfer from UFS to ZFS filesystems.
2162 \subsection{Virtual Tape Emulation}
2163 \index[general]{Virtual Tape Emulation}
2164 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2165 the tape code but actually reading and writing to a disk file. Used with the
2166 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2167 and 700 slots. This feature is most useful in testing. It is enabled
2168 by using {\bf Device Type = vtape} in the Storage daemon's Device
2169 directive. This feature is only implemented on Linux machines and should not be
2170 used for production.
2172 \subsection{Bat Enhancements}
2173 \index[general]{Bat Enhancements}
2174 Bat (the Bacula Administration Tool) GUI program has been significantly
2175 enhanced and stabilized. In particular, there are new table based status
2176 commands; it can now be easily localized using Qt4 Linguist.
2178 The Bat communications protocol has been significantly enhanced to improve
2179 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2180 the Director you are using otherwise the communications protocol will not
2183 \subsection{RunScript Enhancements}
2184 \index[general]{RunScript Enhancements}
2185 The {\bf RunScript} resource has been enhanced to permit multiple
2186 commands per RunScript. Simply specify multiple {\bf Command} directives
2193 Command = "/bin/echo test"
2194 Command = "/bin/echo an other test"
2195 Command = "/bin/echo 3 commands in the same runscript"
2202 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2203 implemented, which runs the command after the Volume Shadow Copy has been made.
2205 Console commands can be specified within a RunScript by using:
2206 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2207 carefully tested and debugged and is known to easily crash the Director.
2208 We would appreciate feedback. Due to the recursive nature of this command, we
2209 may remove it before the final release.
2211 \subsection{Status Enhancements}
2212 \index[general]{Status Enhancements}
2213 The bconsole {\bf status dir} output has been enhanced to indicate
2214 Storage daemon job spooling and despooling activity.
2216 \subsection{Connect Timeout}
2217 \index[general]{Connect Timeout}
2218 The default connect timeout to the File
2219 daemon has been set to 3 minutes. Previously it was 30 minutes.
2221 \subsection{ftruncate for NFS Volumes}
2222 \index[general]{ftruncate for NFS Volumes}
2223 If you write to a Volume mounted by NFS (say on a local file server),
2224 in previous Bacula versions, when the Volume was recycled, it was not
2225 properly truncated because NFS does not implement ftruncate (file
2226 truncate). This is now corrected in the new version because we have
2227 written code (actually a kind user) that deletes and recreates the Volume,
2228 thus accomplishing the same thing as a truncate.
2230 \subsection{Support for Ubuntu}
2231 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2232 version of Linux, and thus now provides correct autostart routines.
2233 Since Ubuntu officially supports Bacula, you can also obtain any
2234 recent release of Bacula from the Ubuntu repositories.
2236 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2237 \index[general]{Recycle Pool}
2238 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2239 be placed (moved) when it is recycled. Without this directive, a Volume will
2240 remain in the same pool when it is recycled. With this directive, it can be
2241 moved automatically to any existing pool during a recycle. This directive is
2242 probably most useful when defined in the Scratch pool, so that volumes will
2243 be recycled back into the Scratch pool.
2245 \subsection{FD Version}
2246 \index[general]{FD Version}
2247 The File daemon to Director protocol now includes a version
2248 number, which although there is no visible change for users,
2249 will help us in future versions automatically determine
2250 if a File daemon is not compatible.
2252 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2253 \index[general]{Max Run Sched Time}
2254 The time specifies the maximum allowed time that a job may run, counted from
2255 when the job was scheduled. This can be useful to prevent jobs from running
2256 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2259 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2260 \index[general]{Max Wait Time}
2261 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2262 of checking the maximum allowed time that a job may block for a resource,
2263 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2264 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2265 their job depending on the level. Now, they have to use
2266 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2267 directives are now deprecated.
2269 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2270 \index[general]{Incremental Max Wait Time}
2271 \index[general]{Differential Max Wait Time}
2273 These directives have been deprecated in favor of
2274 \texttt{Incremental|Differential Max Run Time}.
2276 \subsection{Max Run Time directives}
2277 \index[general]{Max Run Time directives}
2278 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2279 maximum allowed time that a job can run depending on the level.
2281 \addcontentsline{lof}{figure}{Job time control directives}
2282 \includegraphics{\idir different_time.eps}
2284 \subsection{Statistics Enhancements}
2285 \index[general]{Statistics Enhancements}
2286 If you (or probably your boss) want to have statistics on your backups to
2287 provide some \textit{Service Level Agreement} indicators, you could use a few
2288 SQL queries on the Job table to report how many:
2292 \item jobs have been successful
2293 \item files have been backed up
2297 However, these statistics are accurate only if your job retention is greater
2298 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2299 be able to use them.
2301 Now, you can use the \textbf{update stats [days=num]} console command to fill
2302 the JobHistory table with new Job records. If you want to be sure to take in
2303 account only \textbf{good jobs}, ie if one of your important job has failed but
2304 you have fixed the problem and restarted it on time, you probably want to
2305 delete the first \textit{bad} job record and keep only the successful one. For
2306 that simply let your staff do the job, and update JobHistory table after two or
2307 three days depending on your organization using the \textbf{[days=num]} option.
2309 These statistics records aren't used for restoring, but mainly for
2310 capacity planning, billings, etc.
2312 The Bweb interface provides a statistics module that can use this feature. You
2313 can also use tools like Talend or extract information by yourself.
2315 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2316 the length of time that Bacula will keep statistics job records in the Catalog
2317 database after the Job End time. (In \texttt{JobHistory} table) When this time
2318 period expires, and if user runs \texttt{prune stats} command, Bacula will
2319 prune (remove) Job records that are older than the specified period.
2321 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2322 job to maintain statistics.
2325 Name = BackupCatalog
2328 Console = "update stats days=3"
2329 Console = "prune stats yes"
2336 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2337 \index[general]{ScratchPool}
2338 This directive permits to specify a specific \textsl{Scratch} pool for the
2339 current pool. This is useful when using multiple storage sharing the same
2340 mediatype or when you want to dedicate volumes to a particular set of pool.
2342 \subsection{Enhanced Attribute Despooling}
2343 \index[general]{Attribute Despooling}
2344 If the storage daemon and the Director are on the same machine, the spool file
2345 that contains attributes is read directly by the Director instead of being
2346 transmitted across the network. That should reduce load and speedup insertion.
2348 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2349 \index[general]{SpoolSize}
2350 A new Job directive permits to specify the spool size per job. This is used
2351 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2353 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2354 \index[general]{MaximumConsoleConnections}
2355 A new director directive permits to specify the maximum number of Console
2356 Connections that could run concurrently. The default is set to 20, but you may
2357 set it to a larger number.
2359 \subsection{VerId = \lt{}string\gt{}}
2360 \index[general]{VerId}
2361 A new director directive permits to specify a personnal identifier that will be
2362 displayed in the \texttt{version} command.
2364 \subsection{dbcheck enhancements}
2365 \index[general]{dbcheck enhancements}
2366 If you are using Mysql, dbcheck will now ask you if you want to create
2367 temporary indexes to speed up orphaned Path and Filename elimination.
2369 A new \texttt{-B} option allows you to print catalog information in a simple
2370 text based format. This is useful to backup it in a secure way.
2385 You can now specify the database connection port in the command line.
2387 \subsection{{-}{-}docdir configure option}
2388 \index[general]{{-}{-}docdir configure option}
2389 You can use {-}{-}docdir= on the ./configure command to
2390 specify the directory where you want Bacula to install the
2391 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2392 {\bf /usr/share/doc/bacula}.
2394 \subsection{{-}{-}htmldir configure option}
2395 \index[general]{{-}{-}htmldir configure option}
2396 You can use {-}{-}htmldir= on the ./configure command to
2397 specify the directory where you want Bacula to install the bat html help
2398 files. The default is {\bf /usr/share/doc/bacula/html}
2400 \subsection{{-}{-}with-plugindir configure option}
2401 \index[general]{{-}{-}plugindir configure option}
2402 You can use {-}{-}plugindir= on the ./configure command to
2403 specify the directory where you want Bacula to install
2404 the plugins (currently only bpipe-fd). The default is