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{Changes in the pruning algorithm}
8 We rewrote the job pruning algorithm in this version. Previously, in some users
9 reported that the pruning process at the end of jobs was very long. It should
10 not be longer the case. Now, Bacula won't prune automatically a Job if this
11 particular Job is needed to restore data. Example:
15 JobId: 2 Level: Incremental
16 JobId: 3 Level: Incremental
17 JobId: 4 Level: Differential
18 .. Other incrementals up to now
21 In this example, if the Job Retention defined in the Pool or in the Client
22 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
23 detect that JobId 1 and 4 are essential to restore data at the current state
24 and will prune only JobId 2 and 3.
26 \texttt{Important}, this change affect only the automatic pruning step after a
27 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
28 \texttt{VolumeRetention} period, important jobs can be pruned.
30 \section{Ability to Verify any specified Job}
31 You now have the ability to tell Bacula which Job should verify instead of
32 automatically verify just the last one.
34 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
36 To verify a given job, just specify the Job jobid in argument when starting the
39 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
42 Level: VolumeToCatalog
45 Pool: Default (From Job resource)
46 Storage: File (From Job resource)
47 Verify Job: VerifyVol.2010-09-08_14.17.17_03
48 Verify List: /tmp/regress/working/VerifyVol.bsr
49 When: 2010-09-08 14:17:31
51 OK to run? (yes/mod/no):
54 \section{Additions to the Plugin API}
55 The bfuncs structure has been extended to include a number of
59 The bFuncs structure defines the callback entry points within Bacula
60 that the plugin can use register events, get Bacula values, set
61 Bacula values, and send messages to the Job output or debug output.
63 The exact definition as of this writing is:
65 typedef struct s_baculaFuncs {
68 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
69 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
70 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
71 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
72 int type, utime_t mtime, const char *fmt, ...);
73 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
74 int level, const char *fmt, ...);
75 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
77 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
79 /* New functions follow */
80 bRC (*AddExclude)(bpContext *ctx, const char *file);
81 bRC (*AddInclude)(bpContext *ctx, const char *file);
82 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
83 bRC (*AddRegexToInclude)(bpContext *ctx, const char *item, int type);
84 bRC (*AddWildToInclude)(bpContext *ctx, const char *item, int type);
90 \item [AddExclude] can be called to exclude a file. The file
91 string passed may include wildcards that will be interpreted by
92 the {\bf fnmatch} subroutine. This function can be called
93 multiple times, and each time the file specified will be added
94 to the list of files to be excluded. Note, this function only
95 permits adding excludes of specific file or directory names,
96 or files matched by the rather simple fnmatch mechanism.
97 See below for information on doing wild-card and regex excludes.
99 \item [NewInclude] can be called to create a new Include block. This
100 block will be added before any user defined Include blocks. This
101 function can be called multiple times, but each time, it will create
102 a new Include section (not normally needed). This function should
103 be called only if you want to add an entirely new Include block.
105 \item [AddInclude] can be called to add new files/directories to
106 be included. They are added to the current Include block. If
107 NewInclude has not been included, the current Include block is
108 the last one that the user created. This function
109 should be used only if you want to add totally new files/directories
110 to be included in the backup.
112 \item [NewOptions] adds a new Options block to the current Include
113 in front of any other Options blocks. This permits the plugin to
114 add exclude directives (wild-cards and regexes) in front of the
115 user Options, and thus prevent certain files from being backed up.
116 This can be useful if the plugin backs up files, and they should
117 not be also backed up by the main Bacula code. This function
118 may be called multiple times, and each time, it creates a new
119 prepended Options block. Note: normally you want to call this
120 entry point prior to calling AddOptions, AddRegex, or AddWild.
122 \item [AddOptions] allows the plugin it set options in
123 the current Options block, which is normally created with the
124 NewOptions call just prior to adding Include Options.
125 The permitted options are passed as a character string, where
126 each character has a specific meaning as defined below:
129 \item [a] always replace files (default).
130 \item [e] exclude rather than include.
131 \item [h] no recursion into subdirectories.
132 \item [H] do not handle hard links.
133 \item [i] ignore case in wildcard and regex matches.
134 \item [M] compute an MD5 sum.
135 \item [p] use a portable data format on Windows (not recommended).
136 \item [R] backup resource forks and Findr Info.
137 \item [r] read from a fifo
138 \item [S1] compute an SHA1 sum.
139 \item [S2] compute an SHA256 sum.
140 \item [S3] comput an SHA512 sum.
141 \item [s] handle sparse files.
142 \item [m] use st\_mtime only for file differences.
143 \item [k] restore the st\_atime after accessing a file.
144 \item [A] enable ACL backup.
145 \item [Vxxx:] specify verify options. Must terminate with :
146 \item [Cxxx:] specify accurate options. Must terminate with :
147 \item [Jxxx:] specify base job Options. Must terminate with :
148 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
150 \item [Zn] specify gzip compression level n.
151 \item [K] do not use st\_atime in backup decision.
152 \item [c] check if file changed during backup.
153 \item [N] honor no dump flag.
154 \item [X] enable backup of extended attributes.
157 \item [AddRegex] adds a regex expression to the current Options block.
158 The fillowing options are permitted:
160 \item [ ] (a blank) regex applies to whole path and filename.
161 \item [F] regex applies only to the filename (directory or path stripped).
162 \item [D] regex applies only to the directory (path) part of the name.
165 \item [AddWild] adds a wildcard expression to the current Options block.
166 The fillowing options are permitted:
168 \item [ ] (a blank) regex applies to whole path and filename.
169 \item [F] regex applies only to the filename (directory or path stripped).
170 \item [D] regex applies only to the directory (path) part of the name.
176 \subsection{Bacula events}
177 The list of events has been extended to include:
183 bEventStartBackupJob = 3,
184 bEventEndBackupJob = 4,
185 bEventStartRestoreJob = 5,
186 bEventEndRestoreJob = 6,
187 bEventStartVerifyJob = 7,
188 bEventEndVerifyJob = 8,
189 bEventBackupCommand = 9,
190 bEventRestoreCommand = 10,
195 bEventCancelCommand = 13,
196 bEventVssBackupAddComponents = 14,
197 bEventVssRestoreLoadComponentMetadata = 15,
198 bEventVssRestoreSetComponentsSelected = 16,
199 bEventRestoreObject = 17,
200 bEventEndFileSet = 18
206 \item [bEventCancelCommand] is called whenever the currently
207 running Job is cancelled */
209 \item [bEventVssBackupAddComponents]
218 \chapter{New Features in 5.0.1}
220 This chapter presents the new features that are in the released Bacula version
221 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
222 the onging development process.
224 \section{Truncate Volume after Purge}
225 \label{sec:actiononpurge}
227 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
228 the volume when it is purged with the new command \texttt{purge volume
229 action}. It is useful to prevent disk based volumes from consuming too much
235 Action On Purge = Truncate
240 As usual you can also set this property with the \texttt{update volume} command
242 *update volume=xxx ActionOnPurge=Truncate
243 *update volume=xxx actiononpurge=None
246 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
247 following command in interactive mode or in a RunScript as shown after:
249 *purge volume action=truncate storage=File allpools
250 # or by default, action=all
251 *purge volume action storage=File pool=Default
254 This is possible to specify the volume name, the media type, the pool, the
255 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
256 idle when you decide to run this command.
265 Console = "purge volume action=all allpools storage=File"
270 \textbf{Important note}: This feature doesn't work as
271 expected in version 5.0.0. Please do not use it before version 5.0.1.
273 \section{Allow Higher Duplicates}
274 This directive did not work correctly and has been depreciated
275 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
276 file as it will be removed in a future rlease.
278 \section{Cancel Lower Level Duplicates}
279 This directive was added in Bacula version 5.0.1. It compares the
280 level of a new backup job to old jobs of the same name, if any,
281 and will kill the job which has a lower level than the other one.
282 If the levels are the same (i.e. both are Full backups), then
283 nothing is done and the other Cancel XXX Duplicate directives
286 \chapter{New Features in 5.0.0}
288 \section{Maximum Concurent Jobs for Devices}
289 \label{sec:maximumconcurentjobdevice}
291 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
292 Daemon configuration permits setting the maximum number of Jobs that can
293 run concurrently on a specified Device. Using this directive, it is
294 possible to have different Jobs using multiple drives, because when the
295 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
296 Jobs on any other available compatible drive. This facilitates writing to
297 multiple drives with multiple Jobs that all use the same Pool.
299 This project was funded by Bacula Systems.
301 \section{Restore from Multiple Storage Daemons}
302 \index[general]{Restore}
304 Previously, you were able to restore from multiple devices in a single Storage
305 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
306 example, if your full backup runs on a Storage Daemon with an autochanger, and
307 your incremental jobs use another Storage Daemon with lots of disks, Bacula
308 will switch automatically from one Storage Daemon to an other within the same
311 You must upgrade your File Daemon to version 3.1.3 or greater to use this
314 This project was funded by Bacula Systems with the help of Equiinet.
316 \section{File Deduplication using Base Jobs}
317 A base job is sort of like a Full save except that you will want the FileSet to
318 contain only files that are unlikely to change in the future (i.e. a snapshot
319 of most of your system after installing it). After the base job has been run,
320 when you are doing a Full save, you specify one or more Base jobs to be used.
321 All files that have been backed up in the Base job/jobs but not modified will
322 then be excluded from the backup. During a restore, the Base jobs will be
323 automatically pulled in where necessary.
325 This is something none of the competition does, as far as we know (except
326 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
327 win for the user, it makes Bacula stand out as offering a unique optimization
328 that immediately saves time and money. Basically, imagine that you have 100
329 nearly identical Windows or Linux machine containing the OS and user files.
330 Now for the OS part, a Base job will be backed up once, and rather than making
331 100 copies of the OS, there will be only one. If one or more of the systems
332 have some files updated, no problem, they will be automatically restored.
334 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
335 files that will be used during Full backup as base.
346 Base = BackupZog4, BackupLinux
352 In this example, the job \texttt{BackupZog4} will use the most recent version
353 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
354 jobs. Base jobs should have run with \texttt{level=Base} to be used.
356 By default, Bacula will compare permissions bits, user and group fields,
357 modification time, size and the checksum of the file to choose between the
358 current backup and the BaseJob file list. You can change this behavior with the
359 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
360 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
376 \textbf{Important note}: The current implementation doesn't permit to scan
377 volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
379 This project was funded by Bacula Systems.
381 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
382 \index[dir]{AllowCompression}
384 This new directive may be added to Storage resource within the Director's
385 configuration to allow users to selectively disable the client compression for
386 any job which writes to this storage resource.
392 Address = ultrium-tape
393 Password = storage_password # Password for Storage Daemon
396 AllowCompression = No # Tape drive has hardware compression
399 The above example would cause any jobs running with the UltriumTape storage
400 resource to run without compression from the client file daemons. This
401 effectively overrides any compression settings defined at the FileSet level.
403 This feature is probably most useful if you have a tape drive which supports
404 hardware compression. By setting the \texttt{AllowCompression = No} directive
405 for your tape drive storage resource, you can avoid additional load on the file
406 daemon and possibly speed up tape backups.
408 This project was funded by Collaborative Fusion, Inc.
410 \section{Accurate Fileset Options}
411 \label{sec:accuratefileset}
413 In previous versions, the accurate code used the file creation and modification
414 times to determine if a file was modified or not. Now you can specify which
415 attributes to use (time, size, checksum, permission, owner, group, \dots),
416 similar to the Verify options.
432 \item {\bf i} compare the inodes
433 \item {\bf p} compare the permission bits
434 \item {\bf n} compare the number of links
435 \item {\bf u} compare the user id
436 \item {\bf g} compare the group id
437 \item {\bf s} compare the size
438 \item {\bf a} compare the access time
439 \item {\bf m} compare the modification time (st\_mtime)
440 \item {\bf c} compare the change time (st\_ctime)
441 \item {\bf d} report file size decreases
442 \item {\bf 5} compare the MD5 signature
443 \item {\bf 1} compare the SHA1 signature
446 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
447 the File Daemon will have to read all files even if they normally would not
448 be saved. This increases the I/O load, but also the accuracy of the
449 deduplication. By default, Bacula will check modification/creation time
452 This project was funded by Bacula Systems.
454 \section{Tab-completion for Bconsole}
455 \label{sec:tabcompletion}
457 If you build \texttt{bconsole} with readline support, you will be able to use
458 the new auto-completion mode. This mode supports all commands, gives help
459 inside command, and lists resources when required. It works also in the restore
462 To use this feature, you should have readline development package loaded on
463 your system, and use the following option in configure.
465 ./configure --with-readline=/usr/include/readline --disable-conio ...
468 The new bconsole won't be able to tab-complete with older directors.
470 This project was funded by Bacula Systems.
472 \section{Pool File and Job Retention}
473 \label{sec:poolfilejobretention}
475 We added two new Pool directives, \texttt{FileRetention} and
476 \texttt{JobRetention}, that take precedence over Client directives of the same
477 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
478 example, you can decide to increase Retention times for Archive or OffSite Pool.
480 It seems obvious to us, but apparently not to some users, that given the
481 definition above that the Pool File and Job Retention periods is a global
482 override for the normal Client based prunning, which means that when the
483 Job is prunned, the prunning will apply globally to that particular Job.
485 Currently, there is a bug in the implementation that causes any Pool
486 retention periods specified to apply to {\bf all} Pools for that
487 particular Client. Thus we suggest that you avoid using these two
488 directives until this implementation problem is corrected.
490 \section{Read-only File Daemon using capabilities}
491 \label{sec:fdreadonly}
492 This feature implements support of keeping \textbf{ReadAll} capabilities after
493 UID/GID switch, this allows FD to keep root read but drop write permission.
495 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
496 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
499 root@localhost:~# bacula-fd -k -u nobody -g nobody
502 The code for this feature was contributed by our friends at AltLinux.
507 To help developers of restore GUI interfaces, we have added new \textsl{dot
508 commands} that permit browsing the catalog in a very simple way.
511 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
512 the Bvfs cache in the catalog. You need to run it before any access to the
515 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
516 will list all directories in the specified \texttt{path} or
517 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
518 encoding of path/filenames.
520 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
521 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
522 \texttt{pathid} avoids problems with character encoding.
525 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
526 data that will be displayed.
529 * .bvfs_update jobid=1,2
531 * .bvfs_lsdir path=/ jobid=1,2
534 This project was funded by Bacula Systems.
536 \section{Testing your Tape Drive}
537 \label{sec:btapespeed}
539 To determine the best configuration of your tape drive, you can run the new
540 \texttt{speed} command available in the \texttt{btape} program.
542 This command can have the following arguments:
544 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
545 (between 1 and 5GB). This counter is in GB.
546 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
547 of data should be greater than your memory ($file\_size*nb\_file$).
548 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
550 \item[\texttt{skip\_random}] This flag permits to skip tests with random
552 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
553 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
558 *speed file_size=3 skip_raw
559 btape.c:1078 Test with zero data and bacula block structure.
560 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
561 ++++++++++++++++++++++++++++++++++++++++++
562 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
563 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
565 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
567 btape.c:1090 Test with random data, should give the minimum throughput.
568 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
569 +++++++++++++++++++++++++++++++++++++++++++
570 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
571 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
572 +++++++++++++++++++++++++++++++++++++++++++
574 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
578 When using compression, the random test will give your the minimum throughput
579 of your drive . The test using constant string will give you the maximum speed
580 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
582 You can change the block size in the Storage Daemon configuration file.
584 \section{New {\bf Block Checksum} Device Directive}
585 You may now turn off the Block Checksum (CRC32) code
586 that Bacula uses when writing blocks to a Volume. This is
593 doing so can reduce the Storage daemon CPU usage slightly. It
594 will also permit Bacula to read a Volume that has corrupted data.
596 The default is {\bf yes} -- i.e. the checksum is computed on write
599 We do not recommend to turn this off particularly on older tape
600 drives or for disk Volumes where doing so may allow corrupted data
603 \section{New Bat Features}
605 Those new features were funded by Bacula Systems.
607 \subsection{Media List View}
609 By clicking on ``Media'', you can see the list of all your volumes. You will be
610 able to filter by Pool, Media Type, Location,\dots And sort the result directly
611 in the table. The old ``Media'' view is now known as ``Pool''.
614 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
615 \label{fig:mediaview}
619 \subsection{Media Information View}
621 By double-clicking on a volume (on the Media list, in the Autochanger content
622 or in the Job information panel), you can access a detailed overview of your
623 Volume. (cf \ref{fig:mediainfo}.)
626 \includegraphics[width=13cm]{\idir bat11.eps}
627 \caption{Media information}
628 \label{fig:mediainfo}
631 \subsection{Job Information View}
633 By double-clicking on a Job record (on the Job run list or in the Media
634 information panel), you can access a detailed overview of your Job. (cf
638 \includegraphics[width=13cm]{\idir bat12.eps}
639 \caption{Job information}
643 \subsection{Autochanger Content View}
645 By double-clicking on a Storage record (on the Storage list panel), you can
646 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
649 \includegraphics[width=13cm]{\idir bat13.eps}
650 \caption{Autochanger content}
651 \label{fig:achcontent}
654 To use this feature, you need to use the latest mtx-changer script
655 version. (With new \texttt{listall} and \texttt{transfer} commands)
657 \section{Bat on Windows}
658 We have ported {\bf bat} to Windows and it is now installed
659 by default when the installer is run. It works quite well
660 on Win32, but has not had a lot of testing there, so your
661 feedback would be welcome. Unfortunately, eventhough it is
662 installed by default, it does not yet work on 64 bit Windows
665 \section{New Win32 Installer}
666 The Win32 installer has been modified in several very important
669 \item You must deinstall any current version of the
670 Win32 File daemon before upgrading to the new one.
671 If you forget to do so, the new installation will fail.
672 To correct this failure, you must manually shutdown
673 and deinstall the old File daemon.
674 \item All files (other than menu links) are installed
675 in {\bf c:/Program Files/Bacula}.
676 \item The installer no longer sets this
677 file to require administrator privileges by default. If you want
678 to do so, please do it manually using the {\bf cacls} program.
681 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
683 \item The server daemons (Director and Storage daemon) are
684 no longer included in the Windows installer. If you want the
685 Windows servers, you will either need to build them yourself (note
686 they have not been ported to 64 bits), or you can contact
687 Bacula Systems about this.
690 \section{Win64 Installer}
691 We have corrected a number of problems that required manual
692 editing of the conf files. In most cases, it should now
693 install and work. {\bf bat} is by default installed in
694 {\bf c:/Program Files/Bacula/bin32} rather than
695 {\bf c:/Program Files/Bacula} as is the case with the 32
696 bit Windows installer.
698 \section{Linux Bare Metal Recovery USB Key}
699 We have made a number of significant improvements in the
700 Bare Metal Recovery USB key. Please see the README files
701 it the {\bf rescue} release for more details.
703 We are working on an equivalent USB key for Windows bare
704 metal recovery, but it will take some time to develop it (best
705 estimate 3Q2010 or 4Q2010)
708 \section{bconsole Timeout Option}
709 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
710 for commands. This is useful with GUI programs that use {\bf bconsole}
711 to interface to the Director.
713 \section{Important Changes}
714 \label{sec:importantchanges}
717 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
718 to the same Pool. The Storage daemon ensures that you do not read and
719 write to the same Volume.
720 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
722 \item Virtually all the features of {\bf mtx-changer} have
723 now been parameterized, which allows you to configure
724 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
725 that contains variables that you can set to configure mtx-changer.
726 This configuration file will not be overwritten during upgrades.
727 We encourage you to submit any changes
728 that are made to mtx-changer and to parameterize it all in
729 mtx-changer.conf so that all configuration will be done by
730 changing only mtx-changer.conf.
731 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
732 and \texttt{transfer}. Please configure them as appropriate
734 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
735 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
736 password. If you want to use the new script, you will need to
737 manually change the \texttt{BackupCatalog} Job definition.
738 \item The \texttt{bconsole} \texttt{help} command now accepts
739 an argument, which if provided produces information on that
740 command (ex: \texttt{help run}).
744 \subsubsection*{Truncate volume after purge}
746 Note that the Truncate Volume after purge feature doesn't work as expected
747 in 5.0.0 version. Please, don't use it before version 5.0.1.
749 \subsection{Custom Catalog queries}
751 If you wish to add specialized commands that list the contents of the catalog,
752 you can do so by adding them to the \texttt{query.sql} file. This
753 \texttt{query.sql} file is now empty by default. The file
754 \texttt{examples/sample-query.sql} has an a number of sample commands
755 you might find useful.
757 \subsection{Deprecated parts}
759 The following items have been \textbf{deprecated} for a long time, and are now
760 removed from the code.
763 \item Support for SQLite 2
766 \section{Misc Changes}
767 \label{sec:miscchanges}
770 \item Updated Nagios check\_bacula
771 \item Updated man files
772 \item Added OSX package generation script in platforms/darwin
773 \item Added Spanish and Ukrainian Bacula translations
774 \item Enable/disable command shows only Jobs that can change
775 \item Added \texttt{show disabled} command to show disabled Jobs
776 \item Many ACL improvements
777 \item Added Level to FD status Job output
778 \item Begin Ingres DB driver (not yet working)
779 \item Split RedHat spec files into bacula, bat, mtx, and docs
780 \item Reorganized the manuals (fewer separate manuals)
781 \item Added lock/unlock order protection in lock manager
782 \item Allow 64 bit sizes for a number of variables
783 \item Fixed several deadlocks or potential race conditions in the SD
786 \chapter{Released Version 3.0.3 and 3.0.3a}
788 There are no new features in version 3.0.3. This version simply fixes a
789 number of bugs found in version 3.0.2 during the onging development
792 \chapter{New Features in Released Version 3.0.2}
794 This chapter presents the new features added to the
795 Released Bacula Version 3.0.2.
797 \section{Full Restore from a Given JobId}
798 \index[general]{Restore menu}
800 This feature allows selecting a single JobId and having Bacula
801 automatically select all the other jobs that comprise a full backup up to
802 and including the selected date (through JobId).
804 Assume we start with the following jobs:
806 +-------+--------------+---------------------+-------+----------+------------+
807 | jobid | client | starttime | level | jobfiles | jobbytes |
808 +-------+--------------+---------------------+-------+----------+------------
809 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
810 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
811 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
812 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
813 +-------+--------------+---------------------+-------+----------+------------+
816 Below is an example of this new feature (which is number 12 in the
821 To select the JobIds, you have the following choices:
822 1: List last 20 Jobs run
823 2: List Jobs where a given File is saved
825 12: Select full restore to a specified Job date
828 Select item: (1-13): 12
829 Enter JobId to get the state to restore: 5
830 Selecting jobs to build the Full state at 2009-07-15 11:45:45
831 You have selected the following JobIds: 1,3,5
833 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
834 1,444 files inserted into the tree.
837 This project was funded by Bacula Systems.
839 \section{Source Address}
840 \index[general]{Source Address}
842 A feature has been added which allows the administrator to specify the address
843 from which the Director and File daemons will establish connections. This
844 may be used to simplify system configuration overhead when working in complex
845 networks utilizing multi-homing and policy-routing.
847 To accomplish this, two new configuration directives have been implemented:
850 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
854 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
858 Simply adding specific host routes on the OS
859 would have an undesirable side-effect: any
860 application trying to contact the destination host would be forced to use the
861 more specific route possibly diverting management traffic onto a backup VLAN.
862 Instead of adding host routes for each client connected to a multi-homed backup
863 server (for example where there are management and backup VLANs), one can
864 use the new directives to specify a specific source address at the application
867 Additionally, this allows the simplification and abstraction of firewall rules
868 when dealing with a Hot-Standby director or storage daemon configuration. The
869 Hot-standby pair may share a CARP address, which connections must be sourced
870 from, while system services listen and act from the unique interface addresses.
872 This project was funded by Collaborative Fusion, Inc.
874 \section{Show volume availability when doing restore}
876 When doing a restore the selection dialog ends by displaying this
880 The job will require the following
881 Volume(s) Storage(s) SD Device(s)
882 ===========================================================================
893 Volumes marked with ``*'' are online (in the autochanger).
896 This should help speed up large restores by minimizing the time spent
897 waiting for the operator to discover that he must change tapes in the library.
899 This project was funded by Bacula Systems.
901 \section{Accurate estimate command}
903 The \texttt{estimate} command can now use the accurate code to detect changes
904 and give a better estimation.
906 You can set the accurate behavior on the command line by using
907 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
910 * estimate listing accurate=yes level=incremental job=BackupJob
913 This project was funded by Bacula Systems.
915 \chapter{New Features in 3.0.0}
916 \label{NewFeaturesChapter}
917 \index[general]{New Features}
919 This chapter presents the new features added to the development 2.5.x
920 versions to be released as Bacula version 3.0.0 sometime in April 2009.
922 \section{Accurate Backup}
923 \index[general]{Accurate Backup}
925 As with most other backup programs, by default Bacula decides what files to
926 backup for Incremental and Differental backup by comparing the change
927 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
928 backup completed. If one of those two times is later than the last backup
929 time, then the file will be backed up. This does not, however, permit tracking
930 what files have been deleted and will miss any file with an old time that may
931 have been restored to or moved onto the client filesystem.
933 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
934 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
935 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
936 backup, there is no difference, but for {\bf Differential} and {\bf
937 Incremental} backups, the Director will send a list of all previous files
938 backed up, and the File daemon will use that list to determine if any new files
939 have been added or or moved and if any files have been deleted. This allows
940 Bacula to make an accurate backup of your system to that point in time so that
941 if you do a restore, it will restore your system exactly.
944 about using Accurate backup is that it requires more resources (CPU and memory)
945 on both the Director and the Client machines to create the list of previous
946 files backed up, to send that list to the File daemon, for the File daemon to
947 keep the list (possibly very big) in memory, and for the File daemon to do
948 comparisons between every file in the FileSet and the list. In particular,
949 if your client has lots of files (more than a few million), you will need
950 lots of memory on the client machine.
952 Accurate must not be enabled when backing up with a plugin that is not
953 specially designed to work with Accurate. If you enable it, your restores
954 will probably not work correctly.
956 This project was funded by Bacula Systems.
961 \index[general]{Copy Jobs}
963 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
964 existing Migration feature with the exception that the Job that is copied is
965 left unchanged. This essentially creates two identical copies of the same
966 backup. However, the copy is treated as a copy rather than a backup job, and
967 hence is not directly available for restore. The {\bf restore} command lists
968 copy jobs and allows selection of copies by using \texttt{jobid=}
969 option. If the keyword {\bf copies} is present on the command line, Bacula will
970 display the list of all copies for selected jobs.
975 These JobIds have copies as follows:
976 +-------+------------------------------------+-----------+------------------+
977 | JobId | Job | CopyJobId | MediaType |
978 +-------+------------------------------------+-----------+------------------+
979 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
980 +-------+------------------------------------+-----------+------------------+
981 +-------+-------+----------+----------+---------------------+------------------+
982 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
983 +-------+-------+----------+----------+---------------------+------------------+
984 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
985 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
986 +-------+-------+----------+----------+---------------------+------------------+
987 You have selected the following JobIds: 19,2
989 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
990 5,611 files inserted into the tree.
995 The Copy Job runs without using the File daemon by copying the data from the
996 old backup Volume to a different Volume in a different Pool. See the Migration
997 documentation for additional details. For copy Jobs there is a new selection
998 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
999 not already copied to another Pool.
1001 As with Migration, the Client, Volume, Job, or SQL query, are
1002 other possible ways of selecting the Jobs to be copied. Selection
1003 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1004 work, but are probably more suited for Migration Jobs.
1006 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1007 it will promote the Copy to a \textsl{real} backup job and will make it available for
1008 automatic restore. If more than one Copy is available, it will promote the copy
1009 with the smallest JobId.
1011 A nice solution which can be built with the new Copy feature is often
1012 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1013 look something like the one below:
1017 Name = FullBackupsVirtualPool
1019 Purge Oldest Volume = Yes
1021 NextPool = FullBackupsTapePool
1025 Name = FullBackupsTapePool
1029 Volume Retention = 365 days
1030 Storage = superloader
1034 # Fake fileset for copy jobs
1046 # Fake client for copy jobs
1056 # Default template for a CopyDiskToTape Job
1059 Name = CopyDiskToTape
1061 Messages = StandardCopy
1064 Selection Type = PoolUncopiedJobs
1065 Maximum Concurrent Jobs = 10
1067 Allow Duplicate Jobs = Yes
1068 Cancel Queued Duplicates = No
1069 Cancel Running Duplicates = No
1074 Name = DaySchedule7:00
1075 Run = Level=Full daily at 7:00
1079 Name = CopyDiskToTapeFullBackups
1081 Schedule = DaySchedule7:00
1082 Pool = FullBackupsVirtualPool
1083 JobDefs = CopyDiskToTape
1087 The example above had 2 pool which are copied using the PoolUncopiedJobs
1088 selection criteria. Normal Full backups go to the Virtual pool and are copied
1089 to the Tape pool the next morning.
1091 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1096 +-------+------------------------------------+-----------+------------------+
1097 | JobId | Job | CopyJobId | MediaType |
1098 +-------+------------------------------------+-----------+------------------+
1099 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1100 +-------+------------------------------------+-----------+------------------+
1103 \section{ACL Updates}
1104 \index[general]{ACL Updates}
1105 The whole ACL code had been overhauled and in this version each platforms has
1106 different streams for each type of acl available on such an platform. As ACLs
1107 between platforms tend to be not that portable (most implement POSIX acls but
1108 some use an other draft or a completely different format) we currently only
1109 allow certain platform specific ACL streams to be decoded and restored on the
1110 same platform that they were created on. The old code allowed to restore ACL
1111 cross platform but the comments already mention that not being to wise. For
1112 backward compatability the new code will accept the two old ACL streams and
1113 handle those with the platform specific handler. But for all new backups it
1114 will save the ACLs using the new streams.
1116 Currently the following platforms support ACLs:
1120 \item {\bf Darwin/OSX}
1129 Currently we support the following ACL types (these ACL streams use a reserved
1130 part of the stream numbers):
1133 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1135 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1136 string representation from acl\_to\_text (POSIX acl)
1137 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1138 string representation from acl\_to\_text (POSIX acl) for default acls.
1139 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1140 string representation from acl\_to\_text (POSIX acl) for access acls.
1141 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1142 string representation from acltostr (POSIX acl)
1143 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1144 representation from acl\_to\_text (POSIX acl) for default acls.
1145 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1146 representation from acl\_to\_text (POSIX acl) for access acls.
1147 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1148 string representation from acl\_to\_text (POSIX acl) for default acls.
1149 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1150 representation from acl\_to\_text (POSIX acl) for access acls.
1151 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1152 string representation from acl\_to\_text (POSIX acl) for default acls.
1153 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1154 string representation from acl\_to\_text (POSIX acl) for default acls.
1155 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1156 representation from acl\_to\_text (POSIX acl) for access acls.
1157 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1158 string representation from acltotext or acl\_totext (POSIX acl)
1159 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1160 representation from from acl\_totext (NFSv4 or ZFS acl)
1163 In future versions we might support conversion functions from one type of acl
1164 into an other for types that are either the same or easily convertable. For now
1165 the streams are seperate and restoring them on a platform that doesn't
1166 recognize them will give you a warning.
1168 \section{Extended Attributes}
1169 \index[general]{Extended Attributes}
1170 Something that was on the project list for some time is now implemented for
1171 platforms that support a similar kind of interface. Its the support for backup
1172 and restore of so called extended attributes. As extended attributes are so
1173 platform specific these attributes are saved in seperate streams for each
1174 platform. Restores of the extended attributes can only be performed on the
1175 same platform the backup was done. There is support for all types of extended
1176 attributes, but restoring from one type of filesystem onto an other type of
1177 filesystem on the same platform may lead to supprises. As extended attributes
1178 can contain any type of data they are stored as a series of so called
1179 value-pairs. This data must be seen as mostly binary and is stored as such.
1180 As security labels from selinux are also extended attributes this option also
1181 stores those labels and no specific code is enabled for handling selinux
1184 Currently the following platforms support extended attributes:
1186 \item {\bf Darwin/OSX}
1192 On linux acls are also extended attributes, as such when you enable ACLs on a
1193 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1194 and not the same exteneded attribute.
1196 To enable the backup of extended attributes please add the following to your
1211 \section{Shared objects}
1212 \index[general]{Shared objects}
1213 A default build of Bacula will now create the libraries as shared objects
1214 (.so) rather than static libraries as was previously the case.
1215 The shared libraries are built using {\bf libtool} so it should be quite
1218 An important advantage of using shared objects is that on a machine with the
1219 Directory, File daemon, the Storage daemon, and a console, you will have only
1220 one copy of the code in memory rather than four copies. Also the total size of
1221 the binary release is smaller since the library code appears only once rather
1222 than once for every program that uses it; this results in significant reduction
1223 in the size of the binaries particularly for the utility tools.
1225 In order for the system loader to find the shared objects when loading the
1226 Bacula binaries, the Bacula shared objects must either be in a shared object
1227 directory known to the loader (typically /usr/lib) or they must be in the
1228 directory that may be specified on the {\bf ./configure} line using the {\bf
1229 {-}{-}libdir} option as:
1232 ./configure --libdir=/full-path/dir
1235 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1236 no need to modify your loader configuration provided that
1237 the shared objects are installed in that directory (Bacula
1238 does this with the make install command). The shared objects
1239 that Bacula references are:
1248 These files are symbolically linked to the real shared object file,
1249 which has a version number to permit running multiple versions of
1250 the libraries if desired (not normally the case).
1252 If you have problems with libtool or you wish to use the old
1253 way of building static libraries, or you want to build a static
1254 version of Bacula you may disable
1255 libtool on the configure command line with:
1258 ./configure --disable-libtool
1262 \section{Building Static versions of Bacula}
1263 \index[general]{Static linking}
1264 In order to build static versions of Bacula, in addition
1265 to configuration options that were needed you now must
1266 also add --disable-libtool. Example
1269 ./configure --enable-static-client-only --disable-libtool
1273 \section{Virtual Backup (Vbackup)}
1274 \index[general]{Virtual Backup}
1275 \index[general]{Vbackup}
1277 Bacula's virtual backup feature is often called Synthetic Backup or
1278 Consolidation in other backup products. It permits you to consolidate the
1279 previous Full backup plus the most recent Differential backup and any
1280 subsequent Incremental backups into a new Full backup. This new Full
1281 backup will then be considered as the most recent Full for any future
1282 Incremental or Differential backups. The VirtualFull backup is
1283 accomplished without contacting the client by reading the previous backup
1284 data and writing it to a volume in a different pool.
1286 In some respects the Vbackup feature works similar to a Migration job, in
1287 that Bacula normally reads the data from the pool specified in the
1288 Job resource, and writes it to the {\bf Next Pool} specified in the
1289 Job resource. Note, this means that usually the output from the Virtual
1290 Backup is written into a different pool from where your prior backups
1291 are saved. Doing it this way guarantees that you will not get a deadlock
1292 situation attempting to read and write to the same volume in the Storage
1293 daemon. If you then want to do subsequent backups, you may need to
1294 move the Virtual Full Volume back to your normal backup pool.
1295 Alternatively, you can set your {\bf Next Pool} to point to the current
1296 pool. This will cause Bacula to read and write to Volumes in the
1297 current pool. In general, this will work, because Bacula will
1298 not allow reading and writing on the same Volume. In any case, once
1299 a VirtualFull has been created, and a restore is done involving the
1300 most current Full, it will read the Volume or Volumes by the VirtualFull
1301 regardless of in which Pool the Volume is found.
1303 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1304 a level of {\bf VirtualFull}.
1306 A typical Job resource definition might look like the following:
1313 FileSet = "Full Set"
1320 # Default pool definition
1324 Recycle = yes # Automatically recycle Volumes
1325 AutoPrune = yes # Prune expired volumes
1326 Volume Retention = 365d # one year
1334 Recycle = yes # Automatically recycle Volumes
1335 AutoPrune = yes # Prune expired volumes
1336 Volume Retention = 365d # one year
1337 Storage = DiskChanger
1340 # Definition of file storage device
1345 Device = FileStorage
1347 Maximum Concurrent Jobs = 5
1350 # Definition of DDS Virtual tape disk storage device
1353 Address = localhost # N.B. Use a fully qualified name here
1355 Device = DiskChanger
1356 Media Type = DiskChangerMedia
1357 Maximum Concurrent Jobs = 4
1362 Then in bconsole or via a Run schedule, you would run the job as:
1365 run job=MyBackup level=Full
1366 run job=MyBackup level=Incremental
1367 run job=MyBackup level=Differential
1368 run job=MyBackup level=Incremental
1369 run job=MyBackup level=Incremental
1372 So providing there were changes between each of those jobs, you would end up
1373 with a Full backup, a Differential, which includes the first Incremental
1374 backup, then two Incremental backups. All the above jobs would be written to
1375 the {\bf Default} pool.
1377 To consolidate those backups into a new Full backup, you would run the
1381 run job=MyBackup level=VirtualFull
1384 And it would produce a new Full backup without using the client, and the output
1385 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1387 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1390 Note, the Start and End time of the Virtual Full backup is set to the
1391 values for the last job included in the Virtual Full (in the above example,
1392 it is an Increment). This is so that if another incremental is done, which
1393 will be based on the Virtual Full, it will backup all files from the
1394 last Job included in the Virtual Full rather than from the time the Virtual
1395 Full was actually run.
1399 \section{Catalog Format}
1400 \index[general]{Catalog Format}
1401 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1402 operation will convert the FileId field of the File table from 32 bits (max 4
1403 billion table entries) to 64 bits (very large number of items). The
1404 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1405 your catalog during the conversion. Also you won't be able to run jobs during
1406 this conversion period. For example, a 3 million file catalog will take 2
1407 minutes to upgrade on a normal machine. Please don't forget to make a valid
1408 backup of your database before executing the upgrade script. See the
1409 ReleaseNotes for additional details.
1411 \section{64 bit Windows Client}
1412 \index[general]{Win64 Client}
1413 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1414 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1415 As a consequence, we are also releasing a 64 bit version of the Bacula
1416 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1417 These binaries should only be installed on 64 bit Windows operating systems.
1418 What is important is not your hardware but whether or not you have
1419 a 64 bit version of the Windows OS.
1421 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1423 \item Before installing the Win64 Bacula Client, you must totally
1424 deinstall any prior 2.4.x Client installation using the
1425 Bacula deinstallation (see the menu item). You may want
1426 to save your .conf files first.
1427 \item Only the Client (File daemon) is ported to Win64, the Director
1428 and the Storage daemon are not in the 64 bit Windows installer.
1429 \item bwx-console is not yet ported.
1430 \item bconsole is ported but it has not been tested.
1431 \item The documentation is not included in the installer.
1432 \item Due to Vista security restrictions imposed on a default installation
1433 of Vista, before upgrading the Client, you must manually stop
1434 any prior version of Bacula from running, otherwise the install
1436 \item Due to Vista security restrictions imposed on a default installation
1437 of Vista, attempting to edit the conf files via the menu items
1438 will fail. You must directly edit the files with appropriate
1439 permissions. Generally double clicking on the appropriate .conf
1440 file will work providing you have sufficient permissions.
1441 \item All Bacula files are now installed in
1442 {\bf C:/Program Files/Bacula} except the main menu items,
1443 which are installed as before. This vastly simplifies the installation.
1444 \item If you are running on a foreign language version of Windows, most
1445 likely {\bf C:/Program Files} does not exist, so you should use the
1446 Custom installation and enter an appropriate location to install
1448 \item The 3.0.0 Win32 Client continues to install files in the locations used
1449 by prior versions. For the next version we will convert it to use
1450 the same installation conventions as the Win64 version.
1453 This project was funded by Bacula Systems.
1456 \section{Duplicate Job Control}
1457 \index[general]{Duplicate Jobs}
1458 The new version of Bacula provides four new directives that
1459 give additional control over what Bacula does if duplicate jobs
1460 are started. A duplicate job in the sense we use it here means
1461 a second or subsequent job with the same name starts. This
1462 happens most frequently when the first job runs longer than expected because no
1463 tapes are available.
1465 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1466 are specified in the Job resource.
1470 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1471 \index[general]{Allow Duplicate Jobs}
1472 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1473 the directive is set to {\bf no} (default) then only one job of a given name
1474 may run at one time, and the action that Bacula takes to ensure only
1475 one job runs is determined by the other directives (see below).
1477 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1478 are present and none of the three directives given below permit
1479 cancelling a job, then the current job (the second one started)
1482 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1483 \index[general]{Allow Higher Duplicates}
1484 This directive was in version 5.0.0, but does not work as
1485 expected. If used, it should always be set to no. In later versions
1486 of Bacula the directive is disabled (disregarded).
1488 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1489 \index[general]{Cancel Running Duplicates}
1490 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1491 if this directive is set to {\bf yes} any job that is already running
1492 will be canceled. The default is {\bf no}.
1494 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1495 \index[general]{Cancel Queued Duplicates}
1496 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1497 if this directive is set to {\bf yes} any job that is
1498 already queued to run but not yet running will be canceled.
1499 The default is {\bf no}.
1502 \section{TLS Authentication}
1503 \index[general]{TLS Authentication}
1504 In Bacula version 2.5.x and later, in addition to the normal Bacula
1505 CRAM-MD5 authentication that is used to authenticate each Bacula
1506 connection, you can specify that you want TLS Authentication as well,
1507 which will provide more secure authentication.
1509 This new feature uses Bacula's existing TLS code (normally used for
1510 communications encryption) to do authentication. To use it, you must
1511 specify all the TLS directives normally used to enable communications
1512 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1515 \subsection{TLS Authenticate = yes}
1517 TLS Authenticate = yes
1520 in the main daemon configuration resource (Director for the Director,
1521 Client for the File daemon, and Storage for the Storage daemon).
1523 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1524 authentication, Bacula will also do TLS authentication, then TLS
1525 encryption will be turned off, and the rest of the communication between
1526 the two Bacula daemons will be done without encryption.
1528 If you want to encrypt communications data, use the normal TLS directives
1529 but do not turn on {\bf TLS Authenticate}.
1531 \section{bextract non-portable Win32 data}
1532 \index[general]{bextract handles Win32 non-portable data}
1533 {\bf bextract} has been enhanced to be able to restore
1534 non-portable Win32 data to any OS. Previous versions were
1535 unable to restore non-portable Win32 data to machines that
1536 did not have the Win32 BackupRead and BackupWrite API calls.
1538 \section{State File updated at Job Termination}
1539 \index[general]{State File}
1540 In previous versions of Bacula, the state file, which provides a
1541 summary of previous jobs run in the {\bf status} command output was
1542 updated only when Bacula terminated, thus if the daemon crashed, the
1543 state file might not contain all the run data. This version of
1544 the Bacula daemons updates the state file on each job termination.
1546 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1547 \index[general]{MaxFullInterval}
1548 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1549 can be used to specify the maximum time interval between {\bf Full} backup
1550 jobs. When a job starts, if the time since the last Full backup is
1551 greater than the specified interval, and the job would normally be an
1552 {\bf Incremental} or {\bf Differential}, it will be automatically
1553 upgraded to a {\bf Full} backup.
1555 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1556 \index[general]{MaxDiffInterval}
1557 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1558 can be used to specify the maximum time interval between {\bf Differential} backup
1559 jobs. When a job starts, if the time since the last Differential backup is
1560 greater than the specified interval, and the job would normally be an
1561 {\bf Incremental}, it will be automatically
1562 upgraded to a {\bf Differential} backup.
1564 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1565 \index[general]{MaxDiffInterval}
1566 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1567 by the user, and when it is set it is an indication to backup programs
1568 to not backup that particular file. This version of Bacula contains a
1569 new Options directive within a FileSet resource, which instructs Bacula to
1570 obey this flag. The new directive is:
1573 Honor No Dump Flag = yes\vb{}no
1576 The default value is {\bf no}.
1579 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1580 \index[general]{IgnoreDir}
1581 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1582 can be added to the Include section of the FileSet resource. If the specified
1583 filename ({\bf filename-string}) is found on the Client in any directory to be
1584 backed up, the whole directory will be ignored (not backed up). For example:
1587 # List of files to be backed up
1595 Exclude Dir Containing = .excludeme
1600 But in /home, there may be hundreds of directories of users and some
1601 people want to indicate that they don't want to have certain
1602 directories backed up. For example, with the above FileSet, if
1603 the user or sysadmin creates a file named {\bf .excludeme} in
1604 specific directories, such as
1607 /home/user/www/cache/.excludeme
1608 /home/user/temp/.excludeme
1611 then Bacula will not backup the two directories named:
1614 /home/user/www/cache
1618 NOTE: subdirectories will not be backed up. That is, the directive
1619 applies to the two directories in question and any children (be they
1620 files, directories, etc).
1623 \section{Bacula Plugins}
1624 \index[general]{Plugin}
1625 Support for shared object plugins has been implemented in the Linux, Unix
1626 and Win32 File daemons. The API will be documented separately in
1627 the Developer's Guide or in a new document. For the moment, there is
1628 a single plugin named {\bf bpipe} that allows an external program to
1629 get control to backup and restore a file.
1631 Plugins are also planned (partially implemented) in the Director and the
1634 \subsection{Plugin Directory}
1635 \index[general]{Plugin Directory}
1636 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1637 be added to the daemon definition resource. The directory takes a quoted
1638 string argument, which is the name of the directory in which the daemon can
1639 find the Bacula plugins. If this directive is not specified, Bacula will not
1640 load any plugins. Since each plugin has a distinctive name, all the daemons
1641 can share the same plugin directory.
1643 \subsection{Plugin Options}
1644 \index[general]{Plugin Options}
1645 The {\bf Plugin Options} directive takes a quoted string
1646 arguement (after the equal sign) and may be specified in the
1647 Job resource. The options specified will be passed to all plugins
1648 when they are run. This each plugin must know what it is looking
1649 for. The value defined in the Job resource can be modified
1650 by the user when he runs a Job via the {\bf bconsole} command line
1653 Note: this directive may be specified, and there is code to modify
1654 the string in the run command, but the plugin options are not yet passed to
1655 the plugin (i.e. not fully implemented).
1657 \subsection{Plugin Options ACL}
1658 \index[general]{Plugin Options ACL}
1659 The {\bf Plugin Options ACL} directive may be specified in the
1660 Director's Console resource. It functions as all the other ACL commands
1661 do by permitting users running restricted consoles to specify a
1662 {\bf Plugin Options} that overrides the one specified in the Job
1663 definition. Without this directive restricted consoles may not modify
1666 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1667 \index[general]{Plugin}
1668 The {\bf Plugin} directive is specified in the Include section of
1669 a FileSet resource where you put your {\bf File = xxx} directives.
1680 Plugin = "bpipe:..."
1685 In the above example, when the File daemon is processing the directives
1686 in the Include section, it will first backup all the files in {\bf /home}
1687 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1688 the Plugin Directory. The syntax and semantics of the Plugin directive
1689 require the first part of the string up to the colon (:) to be the name
1690 of the plugin. Everything after the first colon is ignored by the File daemon but
1691 is passed to the plugin. Thus the plugin writer may define the meaning of the
1692 rest of the string as he wishes.
1694 Please see the next section for information about the {\bf bpipe} Bacula
1697 \section{The bpipe Plugin}
1698 \index[general]{The bpipe Plugin}
1699 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1700 the Bacula source distribution. When the plugin is compiled and linking into
1701 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1702 Please note that this is a very simple plugin that was written for
1703 demonstration and test purposes. It is and can be used in production, but
1704 that was never really intended.
1706 The purpose of the plugin is to provide an interface to any system program for
1707 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1708 the Include section of your Job's FileSet resource. The full syntax of the
1709 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1710 to specify the sytax as it wishes) is:
1713 Plugin = "<field1>:<field2>:<field3>:<field4>"
1718 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1719 stripped off, so in this case, we would put {\bf bpipe} in this field.
1721 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1722 pseudo path and filename under which the backup will be saved. This pseudo
1723 path and filename will be seen by the user in the restore file tree.
1724 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1725 backed up by the plugin will be put under that "pseudo" path and filename.
1726 You must be careful to choose a naming convention that is unique to avoid
1727 a conflict with a path and filename that actually exists on your system.
1729 \item {\bf field3} for the {\bf bpipe} plugin
1730 specifies the "reader" program that is called by the plugin during
1731 backup to read the data. {\bf bpipe} will call this program by doing a
1734 \item {\bf field4} for the {\bf bpipe} plugin
1735 specifies the "writer" program that is called by the plugin during
1736 restore to write the data back to the filesystem.
1739 Please note that for two items above describing the "reader" and "writer"
1740 fields, these programs are "executed" by Bacula, which
1741 means there is no shell interpretation of any command line arguments
1742 you might use. If you want to use shell characters (redirection of input
1743 or output, ...), then we recommend that you put your command or commands
1744 in a shell script and execute the script. In addition if you backup a
1745 file with the reader program, when running the writer program during
1746 the restore, Bacula will not automatically create the path to the file.
1747 Either the path must exist, or you must explicitly do so with your command
1748 or in a shell script.
1750 Putting it all together, the full plugin directive line might look
1754 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1755 --opt --databases bacula:mysql"
1758 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1759 would be written on a single line.
1761 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1762 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1763 program {\bf mysqldump -f --opt --database bacula} to read the data during
1764 backup. The mysqldump command outputs all the data for the database named
1765 {\bf bacula}, which will be read by the plugin and stored in the backup.
1766 During restore, the data that was backed up will be sent to the program
1767 specified in the last field, which in this case is {\bf mysql}. When
1768 {\bf mysql} is called, it will read the data sent to it by the plugn
1769 then write it back to the same database from which it came ({\bf bacula}
1772 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1773 the data from a specified program to Bacula for backup, and then from Bacula to
1774 a specified program for restore.
1776 By using different command lines to {\bf bpipe},
1777 you can backup any kind of data (ASCII or binary) depending
1778 on the program called.
1780 \section{Microsoft Exchange Server 2003/2007 Plugin}
1781 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1782 \subsection{Background}
1783 The Exchange plugin was made possible by a funded development project
1784 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1785 The code for the plugin was written by James Harper, and the Bacula core
1786 code by Kern Sibbald. All the code for this funded development has become
1787 part of the Bacula project. Thanks to everyone who made it happen.
1789 \subsection{Concepts}
1790 Although it is possible to backup Exchange using Bacula VSS the Exchange
1791 plugin adds a good deal of functionality, because while Bacula VSS
1792 completes a full backup (snapshot) of Exchange, it does
1793 not support Incremental or Differential backups, restoring is more
1794 complicated, and a single database restore is not possible.
1796 Microsoft Exchange organises its storage into Storage Groups with
1797 Databases inside them. A default installation of Exchange will have a
1798 single Storage Group called 'First Storage Group', with two Databases
1799 inside it, "Mailbox Store (SERVER NAME)" and
1800 "Public Folder Store (SERVER NAME)",
1801 which hold user email and public folders respectively.
1803 In the default configuration, Exchange logs everything that happens to
1804 log files, such that if you have a backup, and all the log files since,
1805 you can restore to the present time. Each Storage Group has its own set
1806 of log files and operates independently of any other Storage Groups. At
1807 the Storage Group level, the logging can be turned off by enabling a
1808 function called "Enable circular logging". At this time the Exchange
1809 plugin will not function if this option is enabled.
1811 The plugin allows backing up of entire storage groups, and the restoring
1812 of entire storage groups or individual databases. Backing up and
1813 restoring at the individual mailbox or email item is not supported but
1814 can be simulated by use of the "Recovery" Storage Group (see below).
1816 \subsection{Installing}
1817 The Exchange plugin requires a DLL that is shipped with Microsoft
1818 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1819 correctly the Exchange plugin should find this automatically and run
1820 without any additional installation.
1822 If the DLL can not be found automatically it will need to be copied into
1823 the Bacula installation
1824 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1825 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1826 default Exchange installation.
1828 \subsection{Backing Up}
1829 To back up an Exchange server the Fileset definition must contain at
1830 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1831 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1832 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1833 up files are prefixed with something that isn't going to share a name
1834 with something outside the plugin, and the 'Microsoft Information Store'
1835 bit is required also. It is also possible to add the name of a storage
1836 group to the "Plugin =" line, eg \\
1837 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1838 if you want only a single storage group backed up.
1840 Additionally, you can suffix the 'Plugin =' directive with
1841 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1842 database at the end of a full backup.
1844 An Incremental or Differential backup will backup only the database logs
1845 for each Storage Group by inspecting the "modified date" on each
1846 physical log file. Because of the way the Exchange API works, the last
1847 logfile backed up on each backup will always be backed up by the next
1848 Incremental or Differential backup too. This adds 5MB to each
1849 Incremental or Differential backup size but otherwise does not cause any
1852 By default, a normal VSS fileset containing all the drive letters will
1853 also back up the Exchange databases using VSS. This will interfere with
1854 the plugin and Exchange's shared ideas of when the last full backup was
1855 done, and may also truncate log files incorrectly. It is important,
1856 therefore, that the Exchange database files be excluded from the backup,
1857 although the folders the files are in should be included, or they will
1858 have to be recreated manually if a baremetal restore is done.
1863 File = C:/Program Files/Exchsrvr/mdbdata
1864 Plugin = "exchange:..."
1867 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1868 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1869 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1870 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1871 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1872 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1873 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1878 The advantage of excluding the above files is that you can significantly
1879 reduce the size of your backup since all the important Exchange files
1880 will be properly saved by the Plugin.
1883 \subsection{Restoring}
1884 The restore operation is much the same as a normal Bacula restore, with
1885 the following provisos:
1888 \item The {\bf Where} restore option must not be specified
1889 \item Each Database directory must be marked as a whole. You cannot just
1890 select (say) the .edb file and not the others.
1891 \item If a Storage Group is restored, the directory of the Storage Group
1893 \item It is possible to restore only a subset of the available log files,
1894 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1895 if a log file is missing from the sequence of log files
1896 \item Each database to be restored must be dismounted and marked as "Can be
1897 overwritten by restore"
1898 \item If an entire Storage Group is to be restored (eg all databases and
1899 logs in the Storage Group), then it is best to manually delete the
1900 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1901 as Exchange can get confused by stray log files lying around.
1904 \subsection{Restoring to the Recovery Storage Group}
1905 The concept of the Recovery Storage Group is well documented by
1907 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1908 but to briefly summarize...
1910 Microsoft Exchange allows the creation of an additional Storage Group
1911 called the Recovery Storage Group, which is used to restore an older
1912 copy of a database (e.g. before a mailbox was deleted) into without
1913 messing with the current live data. This is required as the Standard and
1914 Small Business Server versions of Exchange can not ordinarily have more
1915 than one Storage Group.
1917 To create the Recovery Storage Group, drill down to the Server in Exchange
1918 System Manager, right click, and select
1919 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1920 locations and click OK. On the Recovery Storage Group, right click and
1921 select {\bf "Add Database to Recover..."} and select the database you will
1924 Restore only the single database nominated as the database in the
1925 Recovery Storage Group. Exchange will redirect the restore to the
1926 Recovery Storage Group automatically.
1927 Then run the restore.
1929 \subsection{Restoring on Microsoft Server 2007}
1930 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1931 2007, and henc you use a new proceedure for recovering a single mail box.
1932 This procedure is ducomented by Microsoft at:
1933 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1934 and involves using the {\bf Restore-Mailbox} and {\bf
1935 Get-MailboxStatistics} shell commands.
1937 \subsection{Caveats}
1938 This plugin is still being developed, so you should consider it
1939 currently in BETA test, and thus use in a production environment
1940 should be done only after very careful testing.
1942 When doing a full backup, the Exchange database logs are truncated by
1943 Exchange as soon as the plugin has completed the backup. If the data
1944 never makes it to the backup medium (eg because of spooling) then the
1945 logs will still be truncated, but they will also not have been backed
1946 up. A solution to this is being worked on. You will have to schedule a
1947 new Full backup to ensure that your next backups will be usable.
1949 The "Enable Circular Logging" option cannot be enabled or the plugin
1952 Exchange insists that a successful Full backup must have taken place if
1953 an Incremental or Differential backup is desired, and the plugin will
1954 fail if this is not the case. If a restore is done, Exchange will
1955 require that a Full backup be done before an Incremental or Differential
1958 The plugin will most likely not work well if another backup application
1959 (eg NTBACKUP) is backing up the Exchange database, especially if the
1960 other backup application is truncating the log files.
1962 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1963 we recommend either carefully testing or that you avoid this option for
1966 The Exchange plugin is not called during processing the bconsole {\bf
1967 estimate} command, and so anything that would be backed up by the plugin
1968 will not be added to the estimate total that is displayed.
1971 \section{libdbi Framework}
1972 \index[general]{libdbi Framework}
1973 As a general guideline, Bacula has support for a few catalog database drivers
1974 (MySQL, PostgreSQL, SQLite)
1975 coded natively by the Bacula team. With the libdbi implementation, which is a
1976 Bacula driver that uses libdbi to access the catalog, we have an open field to
1977 use many different kinds database engines following the needs of users.
1979 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1980 implements a database-independent abstraction layer in C, similar to the
1981 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1982 leverage the power of multiple databases and multiple simultaneous database
1983 connections by using this framework.
1985 Currently the libdbi driver in Bacula project only supports the same drivers
1986 natively coded in Bacula. However the libdbi project has support for many
1987 others database engines. You can view the list at
1988 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1989 supported by Bacula, however, they must be tested properly by the Bacula team.
1991 Some of benefits of using libdbi are:
1993 \item The possibility to use proprietary databases engines in which your
1994 proprietary licenses prevent the Bacula team from developing the driver.
1995 \item The possibility to use the drivers written for the libdbi project.
1996 \item The possibility to use other database engines without recompiling Bacula
1997 to use them. Just change one line in bacula-dir.conf
1998 \item Abstract Database access, this is, unique point to code and profiling
1999 catalog database access.
2002 The following drivers have been tested:
2004 \item PostgreSQL, with and without batch insert
2005 \item Mysql, with and without batch insert
2010 In the future, we will test and approve to use others databases engines
2011 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2013 To compile Bacula to support libdbi we need to configure the code with the
2014 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2015 [database] is the database engine to be used with Bacula (of course we can
2016 change the driver in file bacula-dir.conf, see below). We must configure the
2017 access port of the database engine with the option --with-db-port, because the
2018 libdbi framework doesn't know the default access port of each database.
2020 The next phase is checking (or configuring) the bacula-dir.conf, example:
2024 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2025 dbname = regress; user = regress; password = ""
2029 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2030 mysql database. Currently the drivers supported by Bacula are: postgresql,
2031 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2033 The following limitations apply when Bacula is set to use the libdbi framework:
2034 - Not tested on the Win32 platform
2035 - A little performance is lost if comparing with native database driver.
2036 The reason is bound with the database driver provided by libdbi and the
2037 simple fact that one more layer of code was added.
2039 It is important to remember, when compiling Bacula with libdbi, the
2040 following packages are needed:
2042 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2043 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2046 You can download them and compile them on your system or install the packages
2047 from your OS distribution.
2049 \section{Console Command Additions and Enhancements}
2050 \index[general]{Console Additions}
2052 \subsection{Display Autochanger Content}
2053 \index[general]{StatusSlots}
2055 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2056 autochanger content.
2060 Slot | Volume Name | Status | Media Type | Pool |
2061 ------+---------------+----------+-------------------+------------|
2062 1 | 00001 | Append | DiskChangerMedia | Default |
2063 2 | 00002 | Append | DiskChangerMedia | Default |
2064 3*| 00003 | Append | DiskChangerMedia | Scratch |
2069 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2070 {\bf update slots} command to synchronize autochanger content with your
2073 \subsection{list joblog job=xxx or jobid=nnn}
2074 \index[general]{list joblog}
2075 A new list command has been added that allows you to list the contents
2076 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2077 or for a particular JobId. The {\bf llist} command will include a line with
2078 the time and date of the entry.
2080 Note for the catalog to have Job Log entries, you must have a directive
2087 In your Director's {\bf Messages} resource.
2089 \subsection{Use separator for multiple commands}
2090 \index[general]{Command Separator}
2091 When using bconsole with readline, you can set the command separator with
2092 \textbf{@separator} command to one
2093 of those characters to write commands who require multiple input in one line.
2095 !$%&'()*+,-/:;<>?[]^`{|}~
2098 \subsection{Deleting Volumes}
2099 The delete volume bconsole command has been modified to
2100 require an asterisk (*) in front of a MediaId otherwise the
2101 value you enter is a taken to be a Volume name. This is so that
2102 users may delete numeric Volume names. The previous Bacula versions
2103 assumed that all input that started with a number was a MediaId.
2105 This new behavior is indicated in the prompt if you read it
2108 \section{Bare Metal Recovery}
2109 The old bare metal recovery project is essentially dead. One
2110 of the main features of it was that it would build a recovery
2111 CD based on the kernel on your system. The problem was that
2112 every distribution has a different boot procedure and different
2113 scripts, and worse yet, the boot procedures and scripts change
2114 from one distribution to another. This meant that maintaining
2115 (keeping up with the changes) the rescue CD was too much work.
2117 To replace it, a new bare metal recovery USB boot stick has been developed
2118 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2119 boot from a USB key.
2123 \item Recovery can be done from within graphical environment.
2124 \item Recovery can be done in a shell.
2125 \item Ubuntu boots on a large number of Linux systems.
2126 \item The process of updating the system and adding new
2127 packages is not too difficult.
2128 \item The USB key can easily be upgraded to newer Ubuntu versions.
2129 \item The USB key has writable partitions for modifications to
2130 the OS and for modification to your home directory.
2131 \item You can add new files/directories to the USB key very easily.
2132 \item You can save the environment from multiple machines on
2134 \item Bacula Systems is funding its ongoing development.
2137 The disadvantages are:
2139 \item The USB key is usable but currently under development.
2140 \item Not everyone may be familiar with Ubuntu (no worse
2142 \item Some older OSes cannot be booted from USB. This can
2143 be resolved by first booting a Ubuntu LiveCD then plugging
2145 \item Currently the documentation is sketchy and not yet added
2146 to the main manual. See below ...
2149 The documentation and the code can be found in the {\bf rescue} package
2150 in the directory {\bf linux/usb}.
2152 \section{Miscellaneous}
2153 \index[general]{Misc New Features}
2155 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2156 \index[general]{Allow Mixed Priority}
2157 This directive is only implemented in version 2.5 and later. When
2158 set to {\bf yes} (default {\bf no}), this job may run even if lower
2159 priority jobs are already running. This means a high priority job
2160 will not have to wait for other jobs to finish before starting.
2161 The scheduler will only mix priorities when all running jobs have
2164 Note that only higher priority jobs will start early. Suppose the
2165 director will allow two concurrent jobs, and that two jobs with
2166 priority 10 are running, with two more in the queue. If a job with
2167 priority 5 is added to the queue, it will be run as soon as one of
2168 the running jobs finishes. However, new priority 10 jobs will not
2169 be run until the priority 5 job has finished.
2171 \subsection{Bootstrap File Directive -- FileRegex}
2172 \index[general]{Bootstrap File Directive}
2173 {\bf FileRegex} is a new command that can be added to the bootstrap
2174 (.bsr) file. The value is a regular expression. When specified, only
2175 matching filenames will be restored.
2177 During a restore, if all File records are pruned from the catalog
2178 for a Job, normally Bacula can restore only all files saved. That
2179 is there is no way using the catalog to select individual files.
2180 With this new feature, Bacula will ask if you want to specify a Regex
2181 expression for extracting only a part of the full backup.
2184 Building directory tree for JobId(s) 1,3 ...
2185 There were no files inserted into the tree, so file selection
2186 is not possible.Most likely your retention policy pruned the files
2188 Do you want to restore all the files? (yes\vb{}no): no
2190 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2191 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2194 \subsection{Bootstrap File Optimization Changes}
2195 In order to permit proper seeking on disk files, we have extended the bootstrap
2196 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2197 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2198 address range and end address range respectively. These two directives replace
2199 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2200 VolEndBlock} directives. Bootstrap files containing the old directives will
2201 still work, but will not properly take advantage of proper disk seeking, and
2202 may read completely to the end of a disk volume during a restore. With the new
2203 format (automatically generated by the new Director), restores will seek
2204 properly and stop reading the volume when all the files have been restored.
2206 \subsection{Solaris ZFS/NFSv4 ACLs}
2207 This is an upgrade of the previous Solaris ACL backup code
2208 to the new library format, which will backup both the old
2209 POSIX(UFS) ACLs as well as the ZFS ACLs.
2211 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2212 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2213 be used to transfer from UFS to ZFS filesystems.
2216 \subsection{Virtual Tape Emulation}
2217 \index[general]{Virtual Tape Emulation}
2218 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2219 the tape code but actually reading and writing to a disk file. Used with the
2220 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2221 and 700 slots. This feature is most useful in testing. It is enabled
2222 by using {\bf Device Type = vtape} in the Storage daemon's Device
2223 directive. This feature is only implemented on Linux machines and should not be
2224 used for production.
2226 \subsection{Bat Enhancements}
2227 \index[general]{Bat Enhancements}
2228 Bat (the Bacula Administration Tool) GUI program has been significantly
2229 enhanced and stabilized. In particular, there are new table based status
2230 commands; it can now be easily localized using Qt4 Linguist.
2232 The Bat communications protocol has been significantly enhanced to improve
2233 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2234 the Director you are using otherwise the communications protocol will not
2237 \subsection{RunScript Enhancements}
2238 \index[general]{RunScript Enhancements}
2239 The {\bf RunScript} resource has been enhanced to permit multiple
2240 commands per RunScript. Simply specify multiple {\bf Command} directives
2247 Command = "/bin/echo test"
2248 Command = "/bin/echo an other test"
2249 Command = "/bin/echo 3 commands in the same runscript"
2256 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2257 implemented, which runs the command after the Volume Shadow Copy has been made.
2259 Console commands can be specified within a RunScript by using:
2260 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2261 carefully tested and debugged and is known to easily crash the Director.
2262 We would appreciate feedback. Due to the recursive nature of this command, we
2263 may remove it before the final release.
2265 \subsection{Status Enhancements}
2266 \index[general]{Status Enhancements}
2267 The bconsole {\bf status dir} output has been enhanced to indicate
2268 Storage daemon job spooling and despooling activity.
2270 \subsection{Connect Timeout}
2271 \index[general]{Connect Timeout}
2272 The default connect timeout to the File
2273 daemon has been set to 3 minutes. Previously it was 30 minutes.
2275 \subsection{ftruncate for NFS Volumes}
2276 \index[general]{ftruncate for NFS Volumes}
2277 If you write to a Volume mounted by NFS (say on a local file server),
2278 in previous Bacula versions, when the Volume was recycled, it was not
2279 properly truncated because NFS does not implement ftruncate (file
2280 truncate). This is now corrected in the new version because we have
2281 written code (actually a kind user) that deletes and recreates the Volume,
2282 thus accomplishing the same thing as a truncate.
2284 \subsection{Support for Ubuntu}
2285 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2286 version of Linux, and thus now provides correct autostart routines.
2287 Since Ubuntu officially supports Bacula, you can also obtain any
2288 recent release of Bacula from the Ubuntu repositories.
2290 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2291 \index[general]{Recycle Pool}
2292 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2293 be placed (moved) when it is recycled. Without this directive, a Volume will
2294 remain in the same pool when it is recycled. With this directive, it can be
2295 moved automatically to any existing pool during a recycle. This directive is
2296 probably most useful when defined in the Scratch pool, so that volumes will
2297 be recycled back into the Scratch pool.
2299 \subsection{FD Version}
2300 \index[general]{FD Version}
2301 The File daemon to Director protocol now includes a version
2302 number, which although there is no visible change for users,
2303 will help us in future versions automatically determine
2304 if a File daemon is not compatible.
2306 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2307 \index[general]{Max Run Sched Time}
2308 The time specifies the maximum allowed time that a job may run, counted from
2309 when the job was scheduled. This can be useful to prevent jobs from running
2310 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2313 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2314 \index[general]{Max Wait Time}
2315 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2316 of checking the maximum allowed time that a job may block for a resource,
2317 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2318 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2319 their job depending on the level. Now, they have to use
2320 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2321 directives are now deprecated.
2323 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2324 \index[general]{Incremental Max Wait Time}
2325 \index[general]{Differential Max Wait Time}
2327 These directives have been deprecated in favor of
2328 \texttt{Incremental|Differential Max Run Time}.
2330 \subsection{Max Run Time directives}
2331 \index[general]{Max Run Time directives}
2332 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2333 maximum allowed time that a job can run depending on the level.
2335 \addcontentsline{lof}{figure}{Job time control directives}
2336 \includegraphics{\idir different_time.eps}
2338 \subsection{Statistics Enhancements}
2339 \index[general]{Statistics Enhancements}
2340 If you (or probably your boss) want to have statistics on your backups to
2341 provide some \textit{Service Level Agreement} indicators, you could use a few
2342 SQL queries on the Job table to report how many:
2346 \item jobs have been successful
2347 \item files have been backed up
2351 However, these statistics are accurate only if your job retention is greater
2352 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2353 be able to use them.
2355 Now, you can use the \textbf{update stats [days=num]} console command to fill
2356 the JobHistory table with new Job records. If you want to be sure to take in
2357 account only \textbf{good jobs}, ie if one of your important job has failed but
2358 you have fixed the problem and restarted it on time, you probably want to
2359 delete the first \textit{bad} job record and keep only the successful one. For
2360 that simply let your staff do the job, and update JobHistory table after two or
2361 three days depending on your organization using the \textbf{[days=num]} option.
2363 These statistics records aren't used for restoring, but mainly for
2364 capacity planning, billings, etc.
2366 The Bweb interface provides a statistics module that can use this feature. You
2367 can also use tools like Talend or extract information by yourself.
2369 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2370 the length of time that Bacula will keep statistics job records in the Catalog
2371 database after the Job End time. (In \texttt{JobHistory} table) When this time
2372 period expires, and if user runs \texttt{prune stats} command, Bacula will
2373 prune (remove) Job records that are older than the specified period.
2375 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2376 job to maintain statistics.
2379 Name = BackupCatalog
2382 Console = "update stats days=3"
2383 Console = "prune stats yes"
2390 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2391 \index[general]{ScratchPool}
2392 This directive permits to specify a specific \textsl{Scratch} pool for the
2393 current pool. This is useful when using multiple storage sharing the same
2394 mediatype or when you want to dedicate volumes to a particular set of pool.
2396 \subsection{Enhanced Attribute Despooling}
2397 \index[general]{Attribute Despooling}
2398 If the storage daemon and the Director are on the same machine, the spool file
2399 that contains attributes is read directly by the Director instead of being
2400 transmitted across the network. That should reduce load and speedup insertion.
2402 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2403 \index[general]{SpoolSize}
2404 A new Job directive permits to specify the spool size per job. This is used
2405 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2407 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2408 \index[general]{MaximumConsoleConnections}
2409 A new director directive permits to specify the maximum number of Console
2410 Connections that could run concurrently. The default is set to 20, but you may
2411 set it to a larger number.
2413 \subsection{VerId = \lt{}string\gt{}}
2414 \index[general]{VerId}
2415 A new director directive permits to specify a personnal identifier that will be
2416 displayed in the \texttt{version} command.
2418 \subsection{dbcheck enhancements}
2419 \index[general]{dbcheck enhancements}
2420 If you are using Mysql, dbcheck will now ask you if you want to create
2421 temporary indexes to speed up orphaned Path and Filename elimination.
2423 A new \texttt{-B} option allows you to print catalog information in a simple
2424 text based format. This is useful to backup it in a secure way.
2439 You can now specify the database connection port in the command line.
2441 \subsection{{-}{-}docdir configure option}
2442 \index[general]{{-}{-}docdir configure option}
2443 You can use {-}{-}docdir= on the ./configure command to
2444 specify the directory where you want Bacula to install the
2445 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2446 {\bf /usr/share/doc/bacula}.
2448 \subsection{{-}{-}htmldir configure option}
2449 \index[general]{{-}{-}htmldir configure option}
2450 You can use {-}{-}htmldir= on the ./configure command to
2451 specify the directory where you want Bacula to install the bat html help
2452 files. The default is {\bf /usr/share/doc/bacula/html}
2454 \subsection{{-}{-}with-plugindir configure option}
2455 \index[general]{{-}{-}plugindir configure option}
2456 You can use {-}{-}plugindir= on the ./configure command to
2457 specify the directory where you want Bacula to install
2458 the plugins (currently only bpipe-fd). The default is