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}
428 We added two new Pool directives, \texttt{FileRetention} and
429 \texttt{JobRetention}, that take precedence over Client directives of the same
430 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
431 example, you can decide to increase Retention times for Archive or OffSite Pool.
433 \section{Read-only File Daemon using capabilities}
434 \label{sec:fdreadonly}
435 This feature implements support of keeping \textbf{ReadAll} capabilities after
436 UID/GID switch, this allows FD to keep root read but drop write permission.
438 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
439 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
442 root@localhost:~# bacula-fd -k -u nobody -g nobody
445 The code for this feature was contributed by our friends at AltLinux.
450 To help developers of restore GUI interfaces, we have added new \textsl{dot
451 commands} that permit browsing the catalog in a very simple way.
454 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
455 the Bvfs cache in the catalog. You need to run it before any access to the
458 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
459 will list all directories in the specified \texttt{path} or
460 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
461 encoding of path/filenames.
463 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
464 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
465 \texttt{pathid} avoids problems with character encoding.
468 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
469 data that will be displayed.
472 * .bvfs_update jobid=1,2
474 * .bvfs_lsdir path=/ jobid=1,2
477 This project was funded by Bacula Systems.
479 \section{Testing your Tape Drive}
480 \label{sec:btapespeed}
482 To determine the best configuration of your tape drive, you can run the new
483 \texttt{speed} command available in the \texttt{btape} program.
485 This command can have the following arguments:
487 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
488 (between 1 and 5GB). This counter is in GB.
489 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
490 of data should be greater than your memory ($file\_size*nb\_file$).
491 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
493 \item[\texttt{skip\_random}] This flag permits to skip tests with random
495 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
496 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
501 *speed file_size=3 skip_raw
502 btape.c:1078 Test with zero data and bacula block structure.
503 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
504 ++++++++++++++++++++++++++++++++++++++++++
505 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
506 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
508 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
510 btape.c:1090 Test with random data, should give the minimum throughput.
511 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
512 +++++++++++++++++++++++++++++++++++++++++++
513 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
514 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
515 +++++++++++++++++++++++++++++++++++++++++++
517 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
521 When using compression, the random test will give your the minimum throughput
522 of your drive . The test using constant string will give you the maximum speed
523 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
525 You can change the block size in the Storage Daemon configuration file.
527 \section{New {\bf Block Checksum} Device Directive}
528 You may now turn off the Block Checksum (CRC32) code
529 that Bacula uses when writing blocks to a Volume. This is
536 doing so can reduce the Storage daemon CPU usage slightly. It
537 will also permit Bacula to read a Volume that has corrupted data.
539 The default is {\bf yes} -- i.e. the checksum is computed on write
542 We do not recommend to turn this off particularly on older tape
543 drives or for disk Volumes where doing so may allow corrupted data
546 \section{New Bat Features}
548 Those new features were funded by Bacula Systems.
550 \subsection{Media List View}
552 By clicking on ``Media'', you can see the list of all your volumes. You will be
553 able to filter by Pool, Media Type, Location,\dots And sort the result directly
554 in the table. The old ``Media'' view is now known as ``Pool''.
557 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
558 \label{fig:mediaview}
562 \subsection{Media Information View}
564 By double-clicking on a volume (on the Media list, in the Autochanger content
565 or in the Job information panel), you can access a detailed overview of your
566 Volume. (cf \ref{fig:mediainfo}.)
569 \includegraphics[width=13cm]{\idir bat11.eps}
570 \caption{Media information}
571 \label{fig:mediainfo}
574 \subsection{Job Information View}
576 By double-clicking on a Job record (on the Job run list or in the Media
577 information panel), you can access a detailed overview of your Job. (cf
581 \includegraphics[width=13cm]{\idir bat12.eps}
582 \caption{Job information}
586 \subsection{Autochanger Content View}
588 By double-clicking on a Storage record (on the Storage list panel), you can
589 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
592 \includegraphics[width=13cm]{\idir bat13.eps}
593 \caption{Autochanger content}
594 \label{fig:achcontent}
597 To use this feature, you need to use the latest mtx-changer script
598 version. (With new \texttt{listall} and \texttt{transfer} commands)
600 \section{Bat on Windows}
601 We have ported {\bf bat} to Windows and it is now installed
602 by default when the installer is run. It works quite well
603 on Win32, but has not had a lot of testing there, so your
604 feedback would be welcome. Unfortunately, eventhough it is
605 installed by default, it does not yet work on 64 bit Windows
608 \section{New Win32 Installer}
609 The Win32 installer has been modified in several very important
612 \item You must deinstall any current version of the
613 Win32 File daemon before upgrading to the new one.
614 If you forget to do so, the new installation will fail.
615 To correct this failure, you must manually shutdown
616 and deinstall the old File daemon.
617 \item All files (other than menu links) are installed
618 in {\bf c:/Program Files/Bacula}.
619 \item The installer no longer sets this
620 file to require administrator privileges by default. If you want
621 to do so, please do it manually using the {\bf cacls} program.
624 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
626 \item The server daemons (Director and Storage daemon) are
627 no longer included in the Windows installer. If you want the
628 Windows servers, you will either need to build them yourself (note
629 they have not been ported to 64 bits), or you can contact
630 Bacula Systems about this.
633 \section{Win64 Installer}
634 We have corrected a number of problems that required manual
635 editing of the conf files. In most cases, it should now
636 install and work. {\bf bat} is by default installed in
637 {\bf c:/Program Files/Bacula/bin32} rather than
638 {\bf c:/Program Files/Bacula} as is the case with the 32
639 bit Windows installer.
641 \section{Linux Bare Metal Recovery USB Key}
642 We have made a number of significant improvements in the
643 Bare Metal Recovery USB key. Please see the README files
644 it the {\bf rescue} release for more details.
646 We are working on an equivalent USB key for Windows bare
647 metal recovery, but it will take some time to develop it (best
648 estimate 3Q2010 or 4Q2010)
651 \section{bconsole Timeout Option}
652 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
653 for commands. This is useful with GUI programs that use {\bf bconsole}
654 to interface to the Director.
656 \section{Important Changes}
657 \label{sec:importantchanges}
660 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
661 to the same Pool. The Storage daemon ensures that you do not read and
662 write to the same Volume.
663 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
665 \item Virtually all the features of {\bf mtx-changer} have
666 now been parameterized, which allows you to configure
667 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
668 that contains variables that you can set to configure mtx-changer.
669 This configuration file will not be overwritten during upgrades.
670 We encourage you to submit any changes
671 that are made to mtx-changer and to parameterize it all in
672 mtx-changer.conf so that all configuration will be done by
673 changing only mtx-changer.conf.
674 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
675 and \texttt{transfer}. Please configure them as appropriate
677 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
678 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
679 password. If you want to use the new script, you will need to
680 manually change the \texttt{BackupCatalog} Job definition.
681 \item The \texttt{bconsole} \texttt{help} command now accepts
682 an argument, which if provided produces information on that
683 command (ex: \texttt{help run}).
687 \subsubsection*{Truncate volume after purge}
689 Note that the Truncate Volume after purge feature doesn't work as expected
690 in 5.0.0 version. Please, don't use it before version 5.0.1.
692 \subsection{Custom Catalog queries}
694 If you wish to add specialized commands that list the contents of the catalog,
695 you can do so by adding them to the \texttt{query.sql} file. This
696 \texttt{query.sql} file is now empty by default. The file
697 \texttt{examples/sample-query.sql} has an a number of sample commands
698 you might find useful.
700 \subsection{Deprecated parts}
702 The following items have been \textbf{deprecated} for a long time, and are now
703 removed from the code.
706 \item Support for SQLite 2
709 \section{Misc Changes}
710 \label{sec:miscchanges}
713 \item Updated Nagios check\_bacula
714 \item Updated man files
715 \item Added OSX package generation script in platforms/darwin
716 \item Added Spanish and Ukrainian Bacula translations
717 \item Enable/disable command shows only Jobs that can change
718 \item Added \texttt{show disabled} command to show disabled Jobs
719 \item Many ACL improvements
720 \item Added Level to FD status Job output
721 \item Begin Ingres DB driver (not yet working)
722 \item Split RedHat spec files into bacula, bat, mtx, and docs
723 \item Reorganized the manuals (fewer separate manuals)
724 \item Added lock/unlock order protection in lock manager
725 \item Allow 64 bit sizes for a number of variables
726 \item Fixed several deadlocks or potential race conditions in the SD
729 \chapter{Released Version 3.0.3 and 3.0.3a}
731 There are no new features in version 3.0.3. This version simply fixes a
732 number of bugs found in version 3.0.2 during the onging development
735 \chapter{New Features in Released Version 3.0.2}
737 This chapter presents the new features added to the
738 Released Bacula Version 3.0.2.
740 \section{Full Restore from a Given JobId}
741 \index[general]{Restore menu}
743 This feature allows selecting a single JobId and having Bacula
744 automatically select all the other jobs that comprise a full backup up to
745 and including the selected date (through JobId).
747 Assume we start with the following jobs:
749 +-------+--------------+---------------------+-------+----------+------------+
750 | jobid | client | starttime | level | jobfiles | jobbytes |
751 +-------+--------------+---------------------+-------+----------+------------
752 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
753 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
754 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
755 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
756 +-------+--------------+---------------------+-------+----------+------------+
759 Below is an example of this new feature (which is number 12 in the
764 To select the JobIds, you have the following choices:
765 1: List last 20 Jobs run
766 2: List Jobs where a given File is saved
768 12: Select full restore to a specified Job date
771 Select item: (1-13): 12
772 Enter JobId to get the state to restore: 5
773 Selecting jobs to build the Full state at 2009-07-15 11:45:45
774 You have selected the following JobIds: 1,3,5
776 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
777 1,444 files inserted into the tree.
780 This project was funded by Bacula Systems.
782 \section{Source Address}
783 \index[general]{Source Address}
785 A feature has been added which allows the administrator to specify the address
786 from which the Director and File daemons will establish connections. This
787 may be used to simplify system configuration overhead when working in complex
788 networks utilizing multi-homing and policy-routing.
790 To accomplish this, two new configuration directives have been implemented:
793 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
797 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
801 Simply adding specific host routes on the OS
802 would have an undesirable side-effect: any
803 application trying to contact the destination host would be forced to use the
804 more specific route possibly diverting management traffic onto a backup VLAN.
805 Instead of adding host routes for each client connected to a multi-homed backup
806 server (for example where there are management and backup VLANs), one can
807 use the new directives to specify a specific source address at the application
810 Additionally, this allows the simplification and abstraction of firewall rules
811 when dealing with a Hot-Standby director or storage daemon configuration. The
812 Hot-standby pair may share a CARP address, which connections must be sourced
813 from, while system services listen and act from the unique interface addresses.
815 This project was funded by Collaborative Fusion, Inc.
817 \section{Show volume availability when doing restore}
819 When doing a restore the selection dialog ends by displaying this
823 The job will require the following
824 Volume(s) Storage(s) SD Device(s)
825 ===========================================================================
836 Volumes marked with ``*'' are online (in the autochanger).
839 This should help speed up large restores by minimizing the time spent
840 waiting for the operator to discover that he must change tapes in the library.
842 This project was funded by Bacula Systems.
844 \section{Accurate estimate command}
846 The \texttt{estimate} command can now use the accurate code to detect changes
847 and give a better estimation.
849 You can set the accurate behavior on the command line by using
850 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
853 * estimate listing accurate=yes level=incremental job=BackupJob
856 This project was funded by Bacula Systems.
858 \chapter{New Features in 3.0.0}
859 \label{NewFeaturesChapter}
860 \index[general]{New Features}
862 This chapter presents the new features added to the development 2.5.x
863 versions to be released as Bacula version 3.0.0 sometime in April 2009.
865 \section{Accurate Backup}
866 \index[general]{Accurate Backup}
868 As with most other backup programs, by default Bacula decides what files to
869 backup for Incremental and Differental backup by comparing the change
870 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
871 backup completed. If one of those two times is later than the last backup
872 time, then the file will be backed up. This does not, however, permit tracking
873 what files have been deleted and will miss any file with an old time that may
874 have been restored to or moved onto the client filesystem.
876 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
877 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
878 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
879 backup, there is no difference, but for {\bf Differential} and {\bf
880 Incremental} backups, the Director will send a list of all previous files
881 backed up, and the File daemon will use that list to determine if any new files
882 have been added or or moved and if any files have been deleted. This allows
883 Bacula to make an accurate backup of your system to that point in time so that
884 if you do a restore, it will restore your system exactly.
887 about using Accurate backup is that it requires more resources (CPU and memory)
888 on both the Director and the Client machines to create the list of previous
889 files backed up, to send that list to the File daemon, for the File daemon to
890 keep the list (possibly very big) in memory, and for the File daemon to do
891 comparisons between every file in the FileSet and the list. In particular,
892 if your client has lots of files (more than a few million), you will need
893 lots of memory on the client machine.
895 Accurate must not be enabled when backing up with a plugin that is not
896 specially designed to work with Accurate. If you enable it, your restores
897 will probably not work correctly.
899 This project was funded by Bacula Systems.
904 \index[general]{Copy Jobs}
906 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
907 existing Migration feature with the exception that the Job that is copied is
908 left unchanged. This essentially creates two identical copies of the same
909 backup. However, the copy is treated as a copy rather than a backup job, and
910 hence is not directly available for restore. The {\bf restore} command lists
911 copy jobs and allows selection of copies by using \texttt{jobid=}
912 option. If the keyword {\bf copies} is present on the command line, Bacula will
913 display the list of all copies for selected jobs.
918 These JobIds have copies as follows:
919 +-------+------------------------------------+-----------+------------------+
920 | JobId | Job | CopyJobId | MediaType |
921 +-------+------------------------------------+-----------+------------------+
922 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
923 +-------+------------------------------------+-----------+------------------+
924 +-------+-------+----------+----------+---------------------+------------------+
925 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
926 +-------+-------+----------+----------+---------------------+------------------+
927 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
928 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
929 +-------+-------+----------+----------+---------------------+------------------+
930 You have selected the following JobIds: 19,2
932 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
933 5,611 files inserted into the tree.
938 The Copy Job runs without using the File daemon by copying the data from the
939 old backup Volume to a different Volume in a different Pool. See the Migration
940 documentation for additional details. For copy Jobs there is a new selection
941 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
942 not already copied to another Pool.
944 As with Migration, the Client, Volume, Job, or SQL query, are
945 other possible ways of selecting the Jobs to be copied. Selection
946 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
947 work, but are probably more suited for Migration Jobs.
949 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
950 it will promote the Copy to a \textsl{real} backup job and will make it available for
951 automatic restore. If more than one Copy is available, it will promote the copy
952 with the smallest JobId.
954 A nice solution which can be built with the new Copy feature is often
955 called disk-to-disk-to-tape backup (DTDTT). A sample config could
956 look something like the one below:
960 Name = FullBackupsVirtualPool
962 Purge Oldest Volume = Yes
964 NextPool = FullBackupsTapePool
968 Name = FullBackupsTapePool
972 Volume Retention = 365 days
973 Storage = superloader
977 # Fake fileset for copy jobs
989 # Fake client for copy jobs
999 # Default template for a CopyDiskToTape Job
1002 Name = CopyDiskToTape
1004 Messages = StandardCopy
1007 Selection Type = PoolUncopiedJobs
1008 Maximum Concurrent Jobs = 10
1010 Allow Duplicate Jobs = Yes
1011 Cancel Queued Duplicates = No
1012 Cancel Running Duplicates = No
1017 Name = DaySchedule7:00
1018 Run = Level=Full daily at 7:00
1022 Name = CopyDiskToTapeFullBackups
1024 Schedule = DaySchedule7:00
1025 Pool = FullBackupsVirtualPool
1026 JobDefs = CopyDiskToTape
1030 The example above had 2 pool which are copied using the PoolUncopiedJobs
1031 selection criteria. Normal Full backups go to the Virtual pool and are copied
1032 to the Tape pool the next morning.
1034 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1039 +-------+------------------------------------+-----------+------------------+
1040 | JobId | Job | CopyJobId | MediaType |
1041 +-------+------------------------------------+-----------+------------------+
1042 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1043 +-------+------------------------------------+-----------+------------------+
1046 \section{ACL Updates}
1047 \index[general]{ACL Updates}
1048 The whole ACL code had been overhauled and in this version each platforms has
1049 different streams for each type of acl available on such an platform. As ACLs
1050 between platforms tend to be not that portable (most implement POSIX acls but
1051 some use an other draft or a completely different format) we currently only
1052 allow certain platform specific ACL streams to be decoded and restored on the
1053 same platform that they were created on. The old code allowed to restore ACL
1054 cross platform but the comments already mention that not being to wise. For
1055 backward compatability the new code will accept the two old ACL streams and
1056 handle those with the platform specific handler. But for all new backups it
1057 will save the ACLs using the new streams.
1059 Currently the following platforms support ACLs:
1063 \item {\bf Darwin/OSX}
1072 Currently we support the following ACL types (these ACL streams use a reserved
1073 part of the stream numbers):
1076 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1078 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1079 string representation from acl\_to\_text (POSIX acl)
1080 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1081 string representation from acl\_to\_text (POSIX acl) for default acls.
1082 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1083 string representation from acl\_to\_text (POSIX acl) for access acls.
1084 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1085 string representation from acltostr (POSIX acl)
1086 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1087 representation from acl\_to\_text (POSIX acl) for default acls.
1088 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1089 representation from acl\_to\_text (POSIX acl) for access acls.
1090 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1091 string representation from acl\_to\_text (POSIX acl) for default acls.
1092 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1093 representation from acl\_to\_text (POSIX acl) for access acls.
1094 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1095 string representation from acl\_to\_text (POSIX acl) for default acls.
1096 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1097 string representation from acl\_to\_text (POSIX acl) for default acls.
1098 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1099 representation from acl\_to\_text (POSIX acl) for access acls.
1100 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1101 string representation from acltotext or acl\_totext (POSIX acl)
1102 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1103 representation from from acl\_totext (NFSv4 or ZFS acl)
1106 In future versions we might support conversion functions from one type of acl
1107 into an other for types that are either the same or easily convertable. For now
1108 the streams are seperate and restoring them on a platform that doesn't
1109 recognize them will give you a warning.
1111 \section{Extended Attributes}
1112 \index[general]{Extended Attributes}
1113 Something that was on the project list for some time is now implemented for
1114 platforms that support a similar kind of interface. Its the support for backup
1115 and restore of so called extended attributes. As extended attributes are so
1116 platform specific these attributes are saved in seperate streams for each
1117 platform. Restores of the extended attributes can only be performed on the
1118 same platform the backup was done. There is support for all types of extended
1119 attributes, but restoring from one type of filesystem onto an other type of
1120 filesystem on the same platform may lead to supprises. As extended attributes
1121 can contain any type of data they are stored as a series of so called
1122 value-pairs. This data must be seen as mostly binary and is stored as such.
1123 As security labels from selinux are also extended attributes this option also
1124 stores those labels and no specific code is enabled for handling selinux
1127 Currently the following platforms support extended attributes:
1129 \item {\bf Darwin/OSX}
1135 On linux acls are also extended attributes, as such when you enable ACLs on a
1136 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1137 and not the same exteneded attribute.
1139 To enable the backup of extended attributes please add the following to your
1154 \section{Shared objects}
1155 \index[general]{Shared objects}
1156 A default build of Bacula will now create the libraries as shared objects
1157 (.so) rather than static libraries as was previously the case.
1158 The shared libraries are built using {\bf libtool} so it should be quite
1161 An important advantage of using shared objects is that on a machine with the
1162 Directory, File daemon, the Storage daemon, and a console, you will have only
1163 one copy of the code in memory rather than four copies. Also the total size of
1164 the binary release is smaller since the library code appears only once rather
1165 than once for every program that uses it; this results in significant reduction
1166 in the size of the binaries particularly for the utility tools.
1168 In order for the system loader to find the shared objects when loading the
1169 Bacula binaries, the Bacula shared objects must either be in a shared object
1170 directory known to the loader (typically /usr/lib) or they must be in the
1171 directory that may be specified on the {\bf ./configure} line using the {\bf
1172 {-}{-}libdir} option as:
1175 ./configure --libdir=/full-path/dir
1178 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1179 no need to modify your loader configuration provided that
1180 the shared objects are installed in that directory (Bacula
1181 does this with the make install command). The shared objects
1182 that Bacula references are:
1191 These files are symbolically linked to the real shared object file,
1192 which has a version number to permit running multiple versions of
1193 the libraries if desired (not normally the case).
1195 If you have problems with libtool or you wish to use the old
1196 way of building static libraries, or you want to build a static
1197 version of Bacula you may disable
1198 libtool on the configure command line with:
1201 ./configure --disable-libtool
1205 \section{Building Static versions of Bacula}
1206 \index[general]{Static linking}
1207 In order to build static versions of Bacula, in addition
1208 to configuration options that were needed you now must
1209 also add --disable-libtool. Example
1212 ./configure --enable-static-client-only --disable-libtool
1216 \section{Virtual Backup (Vbackup)}
1217 \index[general]{Virtual Backup}
1218 \index[general]{Vbackup}
1220 Bacula's virtual backup feature is often called Synthetic Backup or
1221 Consolidation in other backup products. It permits you to consolidate the
1222 previous Full backup plus the most recent Differential backup and any
1223 subsequent Incremental backups into a new Full backup. This new Full
1224 backup will then be considered as the most recent Full for any future
1225 Incremental or Differential backups. The VirtualFull backup is
1226 accomplished without contacting the client by reading the previous backup
1227 data and writing it to a volume in a different pool.
1229 In some respects the Vbackup feature works similar to a Migration job, in
1230 that Bacula normally reads the data from the pool specified in the
1231 Job resource, and writes it to the {\bf Next Pool} specified in the
1232 Job resource. Note, this means that usually the output from the Virtual
1233 Backup is written into a different pool from where your prior backups
1234 are saved. Doing it this way guarantees that you will not get a deadlock
1235 situation attempting to read and write to the same volume in the Storage
1236 daemon. If you then want to do subsequent backups, you may need to
1237 move the Virtual Full Volume back to your normal backup pool.
1238 Alternatively, you can set your {\bf Next Pool} to point to the current
1239 pool. This will cause Bacula to read and write to Volumes in the
1240 current pool. In general, this will work, because Bacula will
1241 not allow reading and writing on the same Volume. In any case, once
1242 a VirtualFull has been created, and a restore is done involving the
1243 most current Full, it will read the Volume or Volumes by the VirtualFull
1244 regardless of in which Pool the Volume is found.
1246 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1247 a level of {\bf VirtualFull}.
1249 A typical Job resource definition might look like the following:
1256 FileSet = "Full Set"
1263 # Default pool definition
1267 Recycle = yes # Automatically recycle Volumes
1268 AutoPrune = yes # Prune expired volumes
1269 Volume Retention = 365d # one year
1277 Recycle = yes # Automatically recycle Volumes
1278 AutoPrune = yes # Prune expired volumes
1279 Volume Retention = 365d # one year
1280 Storage = DiskChanger
1283 # Definition of file storage device
1288 Device = FileStorage
1290 Maximum Concurrent Jobs = 5
1293 # Definition of DDS Virtual tape disk storage device
1296 Address = localhost # N.B. Use a fully qualified name here
1298 Device = DiskChanger
1299 Media Type = DiskChangerMedia
1300 Maximum Concurrent Jobs = 4
1305 Then in bconsole or via a Run schedule, you would run the job as:
1308 run job=MyBackup level=Full
1309 run job=MyBackup level=Incremental
1310 run job=MyBackup level=Differential
1311 run job=MyBackup level=Incremental
1312 run job=MyBackup level=Incremental
1315 So providing there were changes between each of those jobs, you would end up
1316 with a Full backup, a Differential, which includes the first Incremental
1317 backup, then two Incremental backups. All the above jobs would be written to
1318 the {\bf Default} pool.
1320 To consolidate those backups into a new Full backup, you would run the
1324 run job=MyBackup level=VirtualFull
1327 And it would produce a new Full backup without using the client, and the output
1328 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1330 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1333 Note, the Start and End time of the Virtual Full backup is set to the
1334 values for the last job included in the Virtual Full (in the above example,
1335 it is an Increment). This is so that if another incremental is done, which
1336 will be based on the Virtual Full, it will backup all files from the
1337 last Job included in the Virtual Full rather than from the time the Virtual
1338 Full was actually run.
1342 \section{Catalog Format}
1343 \index[general]{Catalog Format}
1344 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1345 operation will convert the FileId field of the File table from 32 bits (max 4
1346 billion table entries) to 64 bits (very large number of items). The
1347 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1348 your catalog during the conversion. Also you won't be able to run jobs during
1349 this conversion period. For example, a 3 million file catalog will take 2
1350 minutes to upgrade on a normal machine. Please don't forget to make a valid
1351 backup of your database before executing the upgrade script. See the
1352 ReleaseNotes for additional details.
1354 \section{64 bit Windows Client}
1355 \index[general]{Win64 Client}
1356 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1357 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1358 As a consequence, we are also releasing a 64 bit version of the Bacula
1359 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1360 These binaries should only be installed on 64 bit Windows operating systems.
1361 What is important is not your hardware but whether or not you have
1362 a 64 bit version of the Windows OS.
1364 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1366 \item Before installing the Win64 Bacula Client, you must totally
1367 deinstall any prior 2.4.x Client installation using the
1368 Bacula deinstallation (see the menu item). You may want
1369 to save your .conf files first.
1370 \item Only the Client (File daemon) is ported to Win64, the Director
1371 and the Storage daemon are not in the 64 bit Windows installer.
1372 \item bwx-console is not yet ported.
1373 \item bconsole is ported but it has not been tested.
1374 \item The documentation is not included in the installer.
1375 \item Due to Vista security restrictions imposed on a default installation
1376 of Vista, before upgrading the Client, you must manually stop
1377 any prior version of Bacula from running, otherwise the install
1379 \item Due to Vista security restrictions imposed on a default installation
1380 of Vista, attempting to edit the conf files via the menu items
1381 will fail. You must directly edit the files with appropriate
1382 permissions. Generally double clicking on the appropriate .conf
1383 file will work providing you have sufficient permissions.
1384 \item All Bacula files are now installed in
1385 {\bf C:/Program Files/Bacula} except the main menu items,
1386 which are installed as before. This vastly simplifies the installation.
1387 \item If you are running on a foreign language version of Windows, most
1388 likely {\bf C:/Program Files} does not exist, so you should use the
1389 Custom installation and enter an appropriate location to install
1391 \item The 3.0.0 Win32 Client continues to install files in the locations used
1392 by prior versions. For the next version we will convert it to use
1393 the same installation conventions as the Win64 version.
1396 This project was funded by Bacula Systems.
1399 \section{Duplicate Job Control}
1400 \index[general]{Duplicate Jobs}
1401 The new version of Bacula provides four new directives that
1402 give additional control over what Bacula does if duplicate jobs
1403 are started. A duplicate job in the sense we use it here means
1404 a second or subsequent job with the same name starts. This
1405 happens most frequently when the first job runs longer than expected because no
1406 tapes are available.
1408 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1409 are specified in the Job resource.
1413 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1414 \index[general]{Allow Duplicate Jobs}
1415 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1416 the directive is set to {\bf no} (default) then only one job of a given name
1417 may run at one time, and the action that Bacula takes to ensure only
1418 one job runs is determined by the other directives (see below).
1420 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1421 are present and none of the three directives given below permit
1422 cancelling a job, then the current job (the second one started)
1425 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1426 \index[general]{Allow Higher Duplicates}
1427 This directive was in version 5.0.0, but does not work as
1428 expected. If used, it should always be set to no. In later versions
1429 of Bacula the directive is disabled (disregarded).
1431 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1432 \index[general]{Cancel Running Duplicates}
1433 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1434 if this directive is set to {\bf yes} any job that is already running
1435 will be canceled. The default is {\bf no}.
1437 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1438 \index[general]{Cancel Queued Duplicates}
1439 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1440 if this directive is set to {\bf yes} any job that is
1441 already queued to run but not yet running will be canceled.
1442 The default is {\bf no}.
1445 \section{TLS Authentication}
1446 \index[general]{TLS Authentication}
1447 In Bacula version 2.5.x and later, in addition to the normal Bacula
1448 CRAM-MD5 authentication that is used to authenticate each Bacula
1449 connection, you can specify that you want TLS Authentication as well,
1450 which will provide more secure authentication.
1452 This new feature uses Bacula's existing TLS code (normally used for
1453 communications encryption) to do authentication. To use it, you must
1454 specify all the TLS directives normally used to enable communications
1455 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1458 \subsection{TLS Authenticate = yes}
1460 TLS Authenticate = yes
1463 in the main daemon configuration resource (Director for the Director,
1464 Client for the File daemon, and Storage for the Storage daemon).
1466 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1467 authentication, Bacula will also do TLS authentication, then TLS
1468 encryption will be turned off, and the rest of the communication between
1469 the two Bacula daemons will be done without encryption.
1471 If you want to encrypt communications data, use the normal TLS directives
1472 but do not turn on {\bf TLS Authenticate}.
1474 \section{bextract non-portable Win32 data}
1475 \index[general]{bextract handles Win32 non-portable data}
1476 {\bf bextract} has been enhanced to be able to restore
1477 non-portable Win32 data to any OS. Previous versions were
1478 unable to restore non-portable Win32 data to machines that
1479 did not have the Win32 BackupRead and BackupWrite API calls.
1481 \section{State File updated at Job Termination}
1482 \index[general]{State File}
1483 In previous versions of Bacula, the state file, which provides a
1484 summary of previous jobs run in the {\bf status} command output was
1485 updated only when Bacula terminated, thus if the daemon crashed, the
1486 state file might not contain all the run data. This version of
1487 the Bacula daemons updates the state file on each job termination.
1489 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1490 \index[general]{MaxFullInterval}
1491 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1492 can be used to specify the maximum time interval between {\bf Full} backup
1493 jobs. When a job starts, if the time since the last Full backup is
1494 greater than the specified interval, and the job would normally be an
1495 {\bf Incremental} or {\bf Differential}, it will be automatically
1496 upgraded to a {\bf Full} backup.
1498 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1499 \index[general]{MaxDiffInterval}
1500 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1501 can be used to specify the maximum time interval between {\bf Differential} backup
1502 jobs. When a job starts, if the time since the last Differential backup is
1503 greater than the specified interval, and the job would normally be an
1504 {\bf Incremental}, it will be automatically
1505 upgraded to a {\bf Differential} backup.
1507 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1508 \index[general]{MaxDiffInterval}
1509 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1510 by the user, and when it is set it is an indication to backup programs
1511 to not backup that particular file. This version of Bacula contains a
1512 new Options directive within a FileSet resource, which instructs Bacula to
1513 obey this flag. The new directive is:
1516 Honor No Dump Flag = yes\vb{}no
1519 The default value is {\bf no}.
1522 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1523 \index[general]{IgnoreDir}
1524 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1525 can be added to the Include section of the FileSet resource. If the specified
1526 filename ({\bf filename-string}) is found on the Client in any directory to be
1527 backed up, the whole directory will be ignored (not backed up). For example:
1530 # List of files to be backed up
1538 Exclude Dir Containing = .excludeme
1543 But in /home, there may be hundreds of directories of users and some
1544 people want to indicate that they don't want to have certain
1545 directories backed up. For example, with the above FileSet, if
1546 the user or sysadmin creates a file named {\bf .excludeme} in
1547 specific directories, such as
1550 /home/user/www/cache/.excludeme
1551 /home/user/temp/.excludeme
1554 then Bacula will not backup the two directories named:
1557 /home/user/www/cache
1561 NOTE: subdirectories will not be backed up. That is, the directive
1562 applies to the two directories in question and any children (be they
1563 files, directories, etc).
1566 \section{Bacula Plugins}
1567 \index[general]{Plugin}
1568 Support for shared object plugins has been implemented in the Linux, Unix
1569 and Win32 File daemons. The API will be documented separately in
1570 the Developer's Guide or in a new document. For the moment, there is
1571 a single plugin named {\bf bpipe} that allows an external program to
1572 get control to backup and restore a file.
1574 Plugins are also planned (partially implemented) in the Director and the
1577 \subsection{Plugin Directory}
1578 \index[general]{Plugin Directory}
1579 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1580 be added to the daemon definition resource. The directory takes a quoted
1581 string argument, which is the name of the directory in which the daemon can
1582 find the Bacula plugins. If this directive is not specified, Bacula will not
1583 load any plugins. Since each plugin has a distinctive name, all the daemons
1584 can share the same plugin directory.
1586 \subsection{Plugin Options}
1587 \index[general]{Plugin Options}
1588 The {\bf Plugin Options} directive takes a quoted string
1589 arguement (after the equal sign) and may be specified in the
1590 Job resource. The options specified will be passed to all plugins
1591 when they are run. This each plugin must know what it is looking
1592 for. The value defined in the Job resource can be modified
1593 by the user when he runs a Job via the {\bf bconsole} command line
1596 Note: this directive may be specified, and there is code to modify
1597 the string in the run command, but the plugin options are not yet passed to
1598 the plugin (i.e. not fully implemented).
1600 \subsection{Plugin Options ACL}
1601 \index[general]{Plugin Options ACL}
1602 The {\bf Plugin Options ACL} directive may be specified in the
1603 Director's Console resource. It functions as all the other ACL commands
1604 do by permitting users running restricted consoles to specify a
1605 {\bf Plugin Options} that overrides the one specified in the Job
1606 definition. Without this directive restricted consoles may not modify
1609 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1610 \index[general]{Plugin}
1611 The {\bf Plugin} directive is specified in the Include section of
1612 a FileSet resource where you put your {\bf File = xxx} directives.
1623 Plugin = "bpipe:..."
1628 In the above example, when the File daemon is processing the directives
1629 in the Include section, it will first backup all the files in {\bf /home}
1630 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1631 the Plugin Directory. The syntax and semantics of the Plugin directive
1632 require the first part of the string up to the colon (:) to be the name
1633 of the plugin. Everything after the first colon is ignored by the File daemon but
1634 is passed to the plugin. Thus the plugin writer may define the meaning of the
1635 rest of the string as he wishes.
1637 Please see the next section for information about the {\bf bpipe} Bacula
1640 \section{The bpipe Plugin}
1641 \index[general]{The bpipe Plugin}
1642 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1643 the Bacula source distribution. When the plugin is compiled and linking into
1644 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1646 The purpose of the plugin is to provide an interface to any system program for
1647 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1648 the Include section of your Job's FileSet resource. The full syntax of the
1649 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1650 to specify the sytax as it wishes) is:
1653 Plugin = "<field1>:<field2>:<field3>:<field4>"
1658 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1659 stripped off, so in this case, we would put {\bf bpipe} in this field.
1661 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1662 pseudo path and filename under which the backup will be saved. This pseudo
1663 path and filename will be seen by the user in the restore file tree.
1664 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1665 backed up by the plugin will be put under that "pseudo" path and filename.
1666 You must be careful to choose a naming convention that is unique to avoid
1667 a conflict with a path and filename that actually exists on your system.
1669 \item {\bf field3} for the {\bf bpipe} plugin
1670 specifies the "reader" program that is called by the plugin during
1671 backup to read the data. {\bf bpipe} will call this program by doing a
1674 \item {\bf field4} for the {\bf bpipe} plugin
1675 specifies the "writer" program that is called by the plugin during
1676 restore to write the data back to the filesystem.
1679 Putting it all together, the full plugin directive line might look
1683 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1684 --opt --databases bacula:mysql"
1687 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1688 would be written on a single line.
1690 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1691 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1692 program {\bf mysqldump -f --opt --database bacula} to read the data during
1693 backup. The mysqldump command outputs all the data for the database named
1694 {\bf bacula}, which will be read by the plugin and stored in the backup.
1695 During restore, the data that was backed up will be sent to the program
1696 specified in the last field, which in this case is {\bf mysql}. When
1697 {\bf mysql} is called, it will read the data sent to it by the plugn
1698 then write it back to the same database from which it came ({\bf bacula}
1701 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1702 the data from a specified program to Bacula for backup, and then from Bacula to
1703 a specified program for restore.
1705 By using different command lines to {\bf bpipe},
1706 you can backup any kind of data (ASCII or binary) depending
1707 on the program called.
1709 \section{Microsoft Exchange Server 2003/2007 Plugin}
1710 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1711 \subsection{Background}
1712 The Exchange plugin was made possible by a funded development project
1713 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1714 The code for the plugin was written by James Harper, and the Bacula core
1715 code by Kern Sibbald. All the code for this funded development has become
1716 part of the Bacula project. Thanks to everyone who made it happen.
1718 \subsection{Concepts}
1719 Although it is possible to backup Exchange using Bacula VSS the Exchange
1720 plugin adds a good deal of functionality, because while Bacula VSS
1721 completes a full backup (snapshot) of Exchange, it does
1722 not support Incremental or Differential backups, restoring is more
1723 complicated, and a single database restore is not possible.
1725 Microsoft Exchange organises its storage into Storage Groups with
1726 Databases inside them. A default installation of Exchange will have a
1727 single Storage Group called 'First Storage Group', with two Databases
1728 inside it, "Mailbox Store (SERVER NAME)" and
1729 "Public Folder Store (SERVER NAME)",
1730 which hold user email and public folders respectively.
1732 In the default configuration, Exchange logs everything that happens to
1733 log files, such that if you have a backup, and all the log files since,
1734 you can restore to the present time. Each Storage Group has its own set
1735 of log files and operates independently of any other Storage Groups. At
1736 the Storage Group level, the logging can be turned off by enabling a
1737 function called "Enable circular logging". At this time the Exchange
1738 plugin will not function if this option is enabled.
1740 The plugin allows backing up of entire storage groups, and the restoring
1741 of entire storage groups or individual databases. Backing up and
1742 restoring at the individual mailbox or email item is not supported but
1743 can be simulated by use of the "Recovery" Storage Group (see below).
1745 \subsection{Installing}
1746 The Exchange plugin requires a DLL that is shipped with Microsoft
1747 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1748 correctly the Exchange plugin should find this automatically and run
1749 without any additional installation.
1751 If the DLL can not be found automatically it will need to be copied into
1752 the Bacula installation
1753 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1754 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1755 default Exchange installation.
1757 \subsection{Backing Up}
1758 To back up an Exchange server the Fileset definition must contain at
1759 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1760 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1761 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1762 up files are prefixed with something that isn't going to share a name
1763 with something outside the plugin, and the 'Microsoft Information Store'
1764 bit is required also. It is also possible to add the name of a storage
1765 group to the "Plugin =" line, eg \\
1766 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1767 if you want only a single storage group backed up.
1769 Additionally, you can suffix the 'Plugin =' directive with
1770 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1771 database at the end of a full backup.
1773 An Incremental or Differential backup will backup only the database logs
1774 for each Storage Group by inspecting the "modified date" on each
1775 physical log file. Because of the way the Exchange API works, the last
1776 logfile backed up on each backup will always be backed up by the next
1777 Incremental or Differential backup too. This adds 5MB to each
1778 Incremental or Differential backup size but otherwise does not cause any
1781 By default, a normal VSS fileset containing all the drive letters will
1782 also back up the Exchange databases using VSS. This will interfere with
1783 the plugin and Exchange's shared ideas of when the last full backup was
1784 done, and may also truncate log files incorrectly. It is important,
1785 therefore, that the Exchange database files be excluded from the backup,
1786 although the folders the files are in should be included, or they will
1787 have to be recreated manually if a baremetal restore is done.
1792 File = C:/Program Files/Exchsrvr/mdbdata
1793 Plugin = "exchange:..."
1796 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1797 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1798 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1799 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1800 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1801 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1802 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1807 The advantage of excluding the above files is that you can significantly
1808 reduce the size of your backup since all the important Exchange files
1809 will be properly saved by the Plugin.
1812 \subsection{Restoring}
1813 The restore operation is much the same as a normal Bacula restore, with
1814 the following provisos:
1817 \item The {\bf Where} restore option must not be specified
1818 \item Each Database directory must be marked as a whole. You cannot just
1819 select (say) the .edb file and not the others.
1820 \item If a Storage Group is restored, the directory of the Storage Group
1822 \item It is possible to restore only a subset of the available log files,
1823 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1824 if a log file is missing from the sequence of log files
1825 \item Each database to be restored must be dismounted and marked as "Can be
1826 overwritten by restore"
1827 \item If an entire Storage Group is to be restored (eg all databases and
1828 logs in the Storage Group), then it is best to manually delete the
1829 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1830 as Exchange can get confused by stray log files lying around.
1833 \subsection{Restoring to the Recovery Storage Group}
1834 The concept of the Recovery Storage Group is well documented by
1836 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1837 but to briefly summarize...
1839 Microsoft Exchange allows the creation of an additional Storage Group
1840 called the Recovery Storage Group, which is used to restore an older
1841 copy of a database (e.g. before a mailbox was deleted) into without
1842 messing with the current live data. This is required as the Standard and
1843 Small Business Server versions of Exchange can not ordinarily have more
1844 than one Storage Group.
1846 To create the Recovery Storage Group, drill down to the Server in Exchange
1847 System Manager, right click, and select
1848 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1849 locations and click OK. On the Recovery Storage Group, right click and
1850 select {\bf "Add Database to Recover..."} and select the database you will
1853 Restore only the single database nominated as the database in the
1854 Recovery Storage Group. Exchange will redirect the restore to the
1855 Recovery Storage Group automatically.
1856 Then run the restore.
1858 \subsection{Restoring on Microsoft Server 2007}
1859 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1860 2007, and henc you use a new proceedure for recovering a single mail box.
1861 This procedure is ducomented by Microsoft at:
1862 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1863 and involves using the {\bf Restore-Mailbox} and {\bf
1864 Get-MailboxStatistics} shell commands.
1866 \subsection{Caveats}
1867 This plugin is still being developed, so you should consider it
1868 currently in BETA test, and thus use in a production environment
1869 should be done only after very careful testing.
1871 When doing a full backup, the Exchange database logs are truncated by
1872 Exchange as soon as the plugin has completed the backup. If the data
1873 never makes it to the backup medium (eg because of spooling) then the
1874 logs will still be truncated, but they will also not have been backed
1875 up. A solution to this is being worked on. You will have to schedule a
1876 new Full backup to ensure that your next backups will be usable.
1878 The "Enable Circular Logging" option cannot be enabled or the plugin
1881 Exchange insists that a successful Full backup must have taken place if
1882 an Incremental or Differential backup is desired, and the plugin will
1883 fail if this is not the case. If a restore is done, Exchange will
1884 require that a Full backup be done before an Incremental or Differential
1887 The plugin will most likely not work well if another backup application
1888 (eg NTBACKUP) is backing up the Exchange database, especially if the
1889 other backup application is truncating the log files.
1891 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1892 we recommend either carefully testing or that you avoid this option for
1895 The Exchange plugin is not called during processing the bconsole {\bf
1896 estimate} command, and so anything that would be backed up by the plugin
1897 will not be added to the estimate total that is displayed.
1900 \section{libdbi Framework}
1901 \index[general]{libdbi Framework}
1902 As a general guideline, Bacula has support for a few catalog database drivers
1903 (MySQL, PostgreSQL, SQLite)
1904 coded natively by the Bacula team. With the libdbi implementation, which is a
1905 Bacula driver that uses libdbi to access the catalog, we have an open field to
1906 use many different kinds database engines following the needs of users.
1908 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1909 implements a database-independent abstraction layer in C, similar to the
1910 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1911 leverage the power of multiple databases and multiple simultaneous database
1912 connections by using this framework.
1914 Currently the libdbi driver in Bacula project only supports the same drivers
1915 natively coded in Bacula. However the libdbi project has support for many
1916 others database engines. You can view the list at
1917 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1918 supported by Bacula, however, they must be tested properly by the Bacula team.
1920 Some of benefits of using libdbi are:
1922 \item The possibility to use proprietary databases engines in which your
1923 proprietary licenses prevent the Bacula team from developing the driver.
1924 \item The possibility to use the drivers written for the libdbi project.
1925 \item The possibility to use other database engines without recompiling Bacula
1926 to use them. Just change one line in bacula-dir.conf
1927 \item Abstract Database access, this is, unique point to code and profiling
1928 catalog database access.
1931 The following drivers have been tested:
1933 \item PostgreSQL, with and without batch insert
1934 \item Mysql, with and without batch insert
1939 In the future, we will test and approve to use others databases engines
1940 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1942 To compile Bacula to support libdbi we need to configure the code with the
1943 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1944 [database] is the database engine to be used with Bacula (of course we can
1945 change the driver in file bacula-dir.conf, see below). We must configure the
1946 access port of the database engine with the option --with-db-port, because the
1947 libdbi framework doesn't know the default access port of each database.
1949 The next phase is checking (or configuring) the bacula-dir.conf, example:
1953 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1954 dbname = regress; user = regress; password = ""
1958 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1959 mysql database. Currently the drivers supported by Bacula are: postgresql,
1960 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1962 The following limitations apply when Bacula is set to use the libdbi framework:
1963 - Not tested on the Win32 platform
1964 - A little performance is lost if comparing with native database driver.
1965 The reason is bound with the database driver provided by libdbi and the
1966 simple fact that one more layer of code was added.
1968 It is important to remember, when compiling Bacula with libdbi, the
1969 following packages are needed:
1971 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1972 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1975 You can download them and compile them on your system or install the packages
1976 from your OS distribution.
1978 \section{Console Command Additions and Enhancements}
1979 \index[general]{Console Additions}
1981 \subsection{Display Autochanger Content}
1982 \index[general]{StatusSlots}
1984 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1985 autochanger content.
1989 Slot | Volume Name | Status | Media Type | Pool |
1990 ------+---------------+----------+-------------------+------------|
1991 1 | 00001 | Append | DiskChangerMedia | Default |
1992 2 | 00002 | Append | DiskChangerMedia | Default |
1993 3*| 00003 | Append | DiskChangerMedia | Scratch |
1998 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1999 {\bf update slots} command to synchronize autochanger content with your
2002 \subsection{list joblog job=xxx or jobid=nnn}
2003 \index[general]{list joblog}
2004 A new list command has been added that allows you to list the contents
2005 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2006 or for a particular JobId. The {\bf llist} command will include a line with
2007 the time and date of the entry.
2009 Note for the catalog to have Job Log entries, you must have a directive
2016 In your Director's {\bf Messages} resource.
2018 \subsection{Use separator for multiple commands}
2019 \index[general]{Command Separator}
2020 When using bconsole with readline, you can set the command separator with
2021 \textbf{@separator} command to one
2022 of those characters to write commands who require multiple input in one line.
2024 !$%&'()*+,-/:;<>?[]^`{|}~
2027 \subsection{Deleting Volumes}
2028 The delete volume bconsole command has been modified to
2029 require an asterisk (*) in front of a MediaId otherwise the
2030 value you enter is a taken to be a Volume name. This is so that
2031 users may delete numeric Volume names. The previous Bacula versions
2032 assumed that all input that started with a number was a MediaId.
2034 This new behavior is indicated in the prompt if you read it
2037 \section{Bare Metal Recovery}
2038 The old bare metal recovery project is essentially dead. One
2039 of the main features of it was that it would build a recovery
2040 CD based on the kernel on your system. The problem was that
2041 every distribution has a different boot procedure and different
2042 scripts, and worse yet, the boot procedures and scripts change
2043 from one distribution to another. This meant that maintaining
2044 (keeping up with the changes) the rescue CD was too much work.
2046 To replace it, a new bare metal recovery USB boot stick has been developed
2047 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2048 boot from a USB key.
2052 \item Recovery can be done from within graphical environment.
2053 \item Recovery can be done in a shell.
2054 \item Ubuntu boots on a large number of Linux systems.
2055 \item The process of updating the system and adding new
2056 packages is not too difficult.
2057 \item The USB key can easily be upgraded to newer Ubuntu versions.
2058 \item The USB key has writable partitions for modifications to
2059 the OS and for modification to your home directory.
2060 \item You can add new files/directories to the USB key very easily.
2061 \item You can save the environment from multiple machines on
2063 \item Bacula Systems is funding its ongoing development.
2066 The disadvantages are:
2068 \item The USB key is usable but currently under development.
2069 \item Not everyone may be familiar with Ubuntu (no worse
2071 \item Some older OSes cannot be booted from USB. This can
2072 be resolved by first booting a Ubuntu LiveCD then plugging
2074 \item Currently the documentation is sketchy and not yet added
2075 to the main manual. See below ...
2078 The documentation and the code can be found in the {\bf rescue} package
2079 in the directory {\bf linux/usb}.
2081 \section{Miscellaneous}
2082 \index[general]{Misc New Features}
2084 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2085 \index[general]{Allow Mixed Priority}
2086 This directive is only implemented in version 2.5 and later. When
2087 set to {\bf yes} (default {\bf no}), this job may run even if lower
2088 priority jobs are already running. This means a high priority job
2089 will not have to wait for other jobs to finish before starting.
2090 The scheduler will only mix priorities when all running jobs have
2093 Note that only higher priority jobs will start early. Suppose the
2094 director will allow two concurrent jobs, and that two jobs with
2095 priority 10 are running, with two more in the queue. If a job with
2096 priority 5 is added to the queue, it will be run as soon as one of
2097 the running jobs finishes. However, new priority 10 jobs will not
2098 be run until the priority 5 job has finished.
2100 \subsection{Bootstrap File Directive -- FileRegex}
2101 \index[general]{Bootstrap File Directive}
2102 {\bf FileRegex} is a new command that can be added to the bootstrap
2103 (.bsr) file. The value is a regular expression. When specified, only
2104 matching filenames will be restored.
2106 During a restore, if all File records are pruned from the catalog
2107 for a Job, normally Bacula can restore only all files saved. That
2108 is there is no way using the catalog to select individual files.
2109 With this new feature, Bacula will ask if you want to specify a Regex
2110 expression for extracting only a part of the full backup.
2113 Building directory tree for JobId(s) 1,3 ...
2114 There were no files inserted into the tree, so file selection
2115 is not possible.Most likely your retention policy pruned the files
2117 Do you want to restore all the files? (yes\vb{}no): no
2119 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2120 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2123 \subsection{Bootstrap File Optimization Changes}
2124 In order to permit proper seeking on disk files, we have extended the bootstrap
2125 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2126 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2127 address range and end address range respectively. These two directives replace
2128 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2129 VolEndBlock} directives. Bootstrap files containing the old directives will
2130 still work, but will not properly take advantage of proper disk seeking, and
2131 may read completely to the end of a disk volume during a restore. With the new
2132 format (automatically generated by the new Director), restores will seek
2133 properly and stop reading the volume when all the files have been restored.
2135 \subsection{Solaris ZFS/NFSv4 ACLs}
2136 This is an upgrade of the previous Solaris ACL backup code
2137 to the new library format, which will backup both the old
2138 POSIX(UFS) ACLs as well as the ZFS ACLs.
2140 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2141 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2142 be used to transfer from UFS to ZFS filesystems.
2145 \subsection{Virtual Tape Emulation}
2146 \index[general]{Virtual Tape Emulation}
2147 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2148 the tape code but actually reading and writing to a disk file. Used with the
2149 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2150 and 700 slots. This feature is most useful in testing. It is enabled
2151 by using {\bf Device Type = vtape} in the Storage daemon's Device
2152 directive. This feature is only implemented on Linux machines and should not be
2153 used for production.
2155 \subsection{Bat Enhancements}
2156 \index[general]{Bat Enhancements}
2157 Bat (the Bacula Administration Tool) GUI program has been significantly
2158 enhanced and stabilized. In particular, there are new table based status
2159 commands; it can now be easily localized using Qt4 Linguist.
2161 The Bat communications protocol has been significantly enhanced to improve
2162 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2163 the Director you are using otherwise the communications protocol will not
2166 \subsection{RunScript Enhancements}
2167 \index[general]{RunScript Enhancements}
2168 The {\bf RunScript} resource has been enhanced to permit multiple
2169 commands per RunScript. Simply specify multiple {\bf Command} directives
2176 Command = "/bin/echo test"
2177 Command = "/bin/echo an other test"
2178 Command = "/bin/echo 3 commands in the same runscript"
2185 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2186 implemented, which runs the command after the Volume Shadow Copy has been made.
2188 Console commands can be specified within a RunScript by using:
2189 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2190 carefully tested and debugged and is known to easily crash the Director.
2191 We would appreciate feedback. Due to the recursive nature of this command, we
2192 may remove it before the final release.
2194 \subsection{Status Enhancements}
2195 \index[general]{Status Enhancements}
2196 The bconsole {\bf status dir} output has been enhanced to indicate
2197 Storage daemon job spooling and despooling activity.
2199 \subsection{Connect Timeout}
2200 \index[general]{Connect Timeout}
2201 The default connect timeout to the File
2202 daemon has been set to 3 minutes. Previously it was 30 minutes.
2204 \subsection{ftruncate for NFS Volumes}
2205 \index[general]{ftruncate for NFS Volumes}
2206 If you write to a Volume mounted by NFS (say on a local file server),
2207 in previous Bacula versions, when the Volume was recycled, it was not
2208 properly truncated because NFS does not implement ftruncate (file
2209 truncate). This is now corrected in the new version because we have
2210 written code (actually a kind user) that deletes and recreates the Volume,
2211 thus accomplishing the same thing as a truncate.
2213 \subsection{Support for Ubuntu}
2214 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2215 version of Linux, and thus now provides correct autostart routines.
2216 Since Ubuntu officially supports Bacula, you can also obtain any
2217 recent release of Bacula from the Ubuntu repositories.
2219 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2220 \index[general]{Recycle Pool}
2221 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2222 be placed (moved) when it is recycled. Without this directive, a Volume will
2223 remain in the same pool when it is recycled. With this directive, it can be
2224 moved automatically to any existing pool during a recycle. This directive is
2225 probably most useful when defined in the Scratch pool, so that volumes will
2226 be recycled back into the Scratch pool.
2228 \subsection{FD Version}
2229 \index[general]{FD Version}
2230 The File daemon to Director protocol now includes a version
2231 number, which although there is no visible change for users,
2232 will help us in future versions automatically determine
2233 if a File daemon is not compatible.
2235 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2236 \index[general]{Max Run Sched Time}
2237 The time specifies the maximum allowed time that a job may run, counted from
2238 when the job was scheduled. This can be useful to prevent jobs from running
2239 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2242 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2243 \index[general]{Max Wait Time}
2244 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2245 of checking the maximum allowed time that a job may block for a resource,
2246 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2247 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2248 their job depending on the level. Now, they have to use
2249 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2250 directives are now deprecated.
2252 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2253 \index[general]{Incremental Max Wait Time}
2254 \index[general]{Differential Max Wait Time}
2256 These directives have been deprecated in favor of
2257 \texttt{Incremental|Differential Max Run Time}.
2259 \subsection{Max Run Time directives}
2260 \index[general]{Max Run Time directives}
2261 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2262 maximum allowed time that a job can run depending on the level.
2264 \addcontentsline{lof}{figure}{Job time control directives}
2265 \includegraphics{\idir different_time.eps}
2267 \subsection{Statistics Enhancements}
2268 \index[general]{Statistics Enhancements}
2269 If you (or probably your boss) want to have statistics on your backups to
2270 provide some \textit{Service Level Agreement} indicators, you could use a few
2271 SQL queries on the Job table to report how many:
2275 \item jobs have been successful
2276 \item files have been backed up
2280 However, these statistics are accurate only if your job retention is greater
2281 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2282 be able to use them.
2284 Now, you can use the \textbf{update stats [days=num]} console command to fill
2285 the JobHistory table with new Job records. If you want to be sure to take in
2286 account only \textbf{good jobs}, ie if one of your important job has failed but
2287 you have fixed the problem and restarted it on time, you probably want to
2288 delete the first \textit{bad} job record and keep only the successful one. For
2289 that simply let your staff do the job, and update JobHistory table after two or
2290 three days depending on your organization using the \textbf{[days=num]} option.
2292 These statistics records aren't used for restoring, but mainly for
2293 capacity planning, billings, etc.
2295 The Bweb interface provides a statistics module that can use this feature. You
2296 can also use tools like Talend or extract information by yourself.
2298 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2299 the length of time that Bacula will keep statistics job records in the Catalog
2300 database after the Job End time. (In \texttt{JobHistory} table) When this time
2301 period expires, and if user runs \texttt{prune stats} command, Bacula will
2302 prune (remove) Job records that are older than the specified period.
2304 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2305 job to maintain statistics.
2308 Name = BackupCatalog
2311 Console = "update stats days=3"
2312 Console = "prune stats yes"
2319 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2320 \index[general]{ScratchPool}
2321 This directive permits to specify a specific \textsl{Scratch} pool for the
2322 current pool. This is useful when using multiple storage sharing the same
2323 mediatype or when you want to dedicate volumes to a particular set of pool.
2325 \subsection{Enhanced Attribute Despooling}
2326 \index[general]{Attribute Despooling}
2327 If the storage daemon and the Director are on the same machine, the spool file
2328 that contains attributes is read directly by the Director instead of being
2329 transmitted across the network. That should reduce load and speedup insertion.
2331 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2332 \index[general]{SpoolSize}
2333 A new Job directive permits to specify the spool size per job. This is used
2334 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2336 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2337 \index[general]{MaximumConsoleConnections}
2338 A new director directive permits to specify the maximum number of Console
2339 Connections that could run concurrently. The default is set to 20, but you may
2340 set it to a larger number.
2342 \subsection{VerId = \lt{}string\gt{}}
2343 \index[general]{VerId}
2344 A new director directive permits to specify a personnal identifier that will be
2345 displayed in the \texttt{version} command.
2347 \subsection{dbcheck enhancements}
2348 \index[general]{dbcheck enhancements}
2349 If you are using Mysql, dbcheck will now ask you if you want to create
2350 temporary indexes to speed up orphaned Path and Filename elimination.
2352 A new \texttt{-B} option allows you to print catalog information in a simple
2353 text based format. This is useful to backup it in a secure way.
2368 You can now specify the database connection port in the command line.
2370 \subsection{{-}{-}docdir configure option}
2371 \index[general]{{-}{-}docdir configure option}
2372 You can use {-}{-}docdir= on the ./configure command to
2373 specify the directory where you want Bacula to install the
2374 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2375 {\bf /usr/share/doc/bacula}.
2377 \subsection{{-}{-}htmldir configure option}
2378 \index[general]{{-}{-}htmldir configure option}
2379 You can use {-}{-}htmldir= on the ./configure command to
2380 specify the directory where you want Bacula to install the bat html help
2381 files. The default is {\bf /usr/share/doc/bacula/html}
2383 \subsection{{-}{-}with-plugindir configure option}
2384 \index[general]{{-}{-}plugindir configure option}
2385 You can use {-}{-}plugindir= on the ./configure command to
2386 specify the directory where you want Bacula to install
2387 the plugins (currently only bpipe-fd). The default is