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]
214 \chapter{Release Version 5.0.3}
216 There are no new features in version 5.0.2. This version simply fixes a
217 number of bugs found in version 5.0.1 during the onging development
220 \chapter{Release Version 5.0.2}
222 There are no new features in version 5.0.2. This version simply fixes a
223 number of bugs found in version 5.0.1 during the onging development
229 \chapter{New Features in 5.0.1}
231 This chapter presents the new features that are in the released Bacula version
232 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
233 the onging development process.
235 \section{Truncate Volume after Purge}
236 \label{sec:actiononpurge}
238 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
239 the volume when it is purged with the new command \texttt{purge volume
240 action}. It is useful to prevent disk based volumes from consuming too much
246 Action On Purge = Truncate
251 As usual you can also set this property with the \texttt{update volume} command
253 *update volume=xxx ActionOnPurge=Truncate
254 *update volume=xxx actiononpurge=None
257 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
258 following command in interactive mode or in a RunScript as shown after:
260 *purge volume action=truncate storage=File allpools
261 # or by default, action=all
262 *purge volume action storage=File pool=Default
265 This is possible to specify the volume name, the media type, the pool, the
266 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
267 idle when you decide to run this command.
276 Console = "purge volume action=all allpools storage=File"
281 \textbf{Important note}: This feature doesn't work as
282 expected in version 5.0.0. Please do not use it before version 5.0.1.
284 \section{Allow Higher Duplicates}
285 This directive did not work correctly and has been depreciated
286 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
287 file as it will be removed in a future rlease.
289 \section{Cancel Lower Level Duplicates}
290 This directive was added in Bacula version 5.0.1. It compares the
291 level of a new backup job to old jobs of the same name, if any,
292 and will kill the job which has a lower level than the other one.
293 If the levels are the same (i.e. both are Full backups), then
294 nothing is done and the other Cancel XXX Duplicate directives
297 \chapter{New Features in 5.0.0}
299 \section{Maximum Concurent Jobs for Devices}
300 \label{sec:maximumconcurentjobdevice}
302 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
303 Daemon configuration permits setting the maximum number of Jobs that can
304 run concurrently on a specified Device. Using this directive, it is
305 possible to have different Jobs using multiple drives, because when the
306 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
307 Jobs on any other available compatible drive. This facilitates writing to
308 multiple drives with multiple Jobs that all use the same Pool.
310 This project was funded by Bacula Systems.
312 \section{Restore from Multiple Storage Daemons}
313 \index[general]{Restore}
315 Previously, you were able to restore from multiple devices in a single Storage
316 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
317 example, if your full backup runs on a Storage Daemon with an autochanger, and
318 your incremental jobs use another Storage Daemon with lots of disks, Bacula
319 will switch automatically from one Storage Daemon to an other within the same
322 You must upgrade your File Daemon to version 3.1.3 or greater to use this
325 This project was funded by Bacula Systems with the help of Equiinet.
327 \section{File Deduplication using Base Jobs}
328 A base job is sort of like a Full save except that you will want the FileSet to
329 contain only files that are unlikely to change in the future (i.e. a snapshot
330 of most of your system after installing it). After the base job has been run,
331 when you are doing a Full save, you specify one or more Base jobs to be used.
332 All files that have been backed up in the Base job/jobs but not modified will
333 then be excluded from the backup. During a restore, the Base jobs will be
334 automatically pulled in where necessary.
336 This is something none of the competition does, as far as we know (except
337 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
338 win for the user, it makes Bacula stand out as offering a unique optimization
339 that immediately saves time and money. Basically, imagine that you have 100
340 nearly identical Windows or Linux machine containing the OS and user files.
341 Now for the OS part, a Base job will be backed up once, and rather than making
342 100 copies of the OS, there will be only one. If one or more of the systems
343 have some files updated, no problem, they will be automatically restored.
345 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
346 files that will be used during Full backup as base.
357 Base = BackupZog4, BackupLinux
363 In this example, the job \texttt{BackupZog4} will use the most recent version
364 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
365 jobs. Base jobs should have run with \texttt{level=Base} to be used.
367 By default, Bacula will compare permissions bits, user and group fields,
368 modification time, size and the checksum of the file to choose between the
369 current backup and the BaseJob file list. You can change this behavior with the
370 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
371 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
387 \textbf{Important note}: The current implementation doesn't permit to scan
388 volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
390 This project was funded by Bacula Systems.
392 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
393 \index[dir]{AllowCompression}
395 This new directive may be added to Storage resource within the Director's
396 configuration to allow users to selectively disable the client compression for
397 any job which writes to this storage resource.
403 Address = ultrium-tape
404 Password = storage_password # Password for Storage Daemon
407 AllowCompression = No # Tape drive has hardware compression
410 The above example would cause any jobs running with the UltriumTape storage
411 resource to run without compression from the client file daemons. This
412 effectively overrides any compression settings defined at the FileSet level.
414 This feature is probably most useful if you have a tape drive which supports
415 hardware compression. By setting the \texttt{AllowCompression = No} directive
416 for your tape drive storage resource, you can avoid additional load on the file
417 daemon and possibly speed up tape backups.
419 This project was funded by Collaborative Fusion, Inc.
421 \section{Accurate Fileset Options}
422 \label{sec:accuratefileset}
424 In previous versions, the accurate code used the file creation and modification
425 times to determine if a file was modified or not. Now you can specify which
426 attributes to use (time, size, checksum, permission, owner, group, \dots),
427 similar to the Verify options.
443 \item {\bf i} compare the inodes
444 \item {\bf p} compare the permission bits
445 \item {\bf n} compare the number of links
446 \item {\bf u} compare the user id
447 \item {\bf g} compare the group id
448 \item {\bf s} compare the size
449 \item {\bf a} compare the access time
450 \item {\bf m} compare the modification time (st\_mtime)
451 \item {\bf c} compare the change time (st\_ctime)
452 \item {\bf d} report file size decreases
453 \item {\bf 5} compare the MD5 signature
454 \item {\bf 1} compare the SHA1 signature
457 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
458 the File Daemon will have to read all files even if they normally would not
459 be saved. This increases the I/O load, but also the accuracy of the
460 deduplication. By default, Bacula will check modification/creation time
463 This project was funded by Bacula Systems.
465 \section{Tab-completion for Bconsole}
466 \label{sec:tabcompletion}
468 If you build \texttt{bconsole} with readline support, you will be able to use
469 the new auto-completion mode. This mode supports all commands, gives help
470 inside command, and lists resources when required. It works also in the restore
473 To use this feature, you should have readline development package loaded on
474 your system, and use the following option in configure.
476 ./configure --with-readline=/usr/include/readline --disable-conio ...
479 The new bconsole won't be able to tab-complete with older directors.
481 This project was funded by Bacula Systems.
483 \section{Pool File and Job Retention}
484 \label{sec:poolfilejobretention}
486 We added two new Pool directives, \texttt{FileRetention} and
487 \texttt{JobRetention}, that take precedence over Client directives of the same
488 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
489 example, you can decide to increase Retention times for Archive or OffSite Pool.
491 It seems obvious to us, but apparently not to some users, that given the
492 definition above that the Pool File and Job Retention periods is a global
493 override for the normal Client based prunning, which means that when the
494 Job is prunned, the prunning will apply globally to that particular Job.
496 Currently, there is a bug in the implementation that causes any Pool
497 retention periods specified to apply to {\bf all} Pools for that
498 particular Client. Thus we suggest that you avoid using these two
499 directives until this implementation problem is corrected.
501 \section{Read-only File Daemon using capabilities}
502 \label{sec:fdreadonly}
503 This feature implements support of keeping \textbf{ReadAll} capabilities after
504 UID/GID switch, this allows FD to keep root read but drop write permission.
506 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
507 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
510 root@localhost:~# bacula-fd -k -u nobody -g nobody
513 The code for this feature was contributed by our friends at AltLinux.
518 To help developers of restore GUI interfaces, we have added new \textsl{dot
519 commands} that permit browsing the catalog in a very simple way.
522 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
523 the Bvfs cache in the catalog. You need to run it before any access to the
526 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
527 will list all directories in the specified \texttt{path} or
528 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
529 encoding of path/filenames.
531 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
532 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
533 \texttt{pathid} avoids problems with character encoding.
536 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
537 data that will be displayed.
540 * .bvfs_update jobid=1,2
542 * .bvfs_lsdir path=/ jobid=1,2
545 This project was funded by Bacula Systems.
547 \section{Testing your Tape Drive}
548 \label{sec:btapespeed}
550 To determine the best configuration of your tape drive, you can run the new
551 \texttt{speed} command available in the \texttt{btape} program.
553 This command can have the following arguments:
555 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
556 (between 1 and 5GB). This counter is in GB.
557 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
558 of data should be greater than your memory ($file\_size*nb\_file$).
559 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
561 \item[\texttt{skip\_random}] This flag permits to skip tests with random
563 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
564 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
569 *speed file_size=3 skip_raw
570 btape.c:1078 Test with zero data and bacula block structure.
571 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
572 ++++++++++++++++++++++++++++++++++++++++++
573 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
574 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
576 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
578 btape.c:1090 Test with random data, should give the minimum throughput.
579 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
580 +++++++++++++++++++++++++++++++++++++++++++
581 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
582 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
583 +++++++++++++++++++++++++++++++++++++++++++
585 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
589 When using compression, the random test will give your the minimum throughput
590 of your drive . The test using constant string will give you the maximum speed
591 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
593 You can change the block size in the Storage Daemon configuration file.
595 \section{New {\bf Block Checksum} Device Directive}
596 You may now turn off the Block Checksum (CRC32) code
597 that Bacula uses when writing blocks to a Volume. This is
604 doing so can reduce the Storage daemon CPU usage slightly. It
605 will also permit Bacula to read a Volume that has corrupted data.
607 The default is {\bf yes} -- i.e. the checksum is computed on write
610 We do not recommend to turn this off particularly on older tape
611 drives or for disk Volumes where doing so may allow corrupted data
614 \section{New Bat Features}
616 Those new features were funded by Bacula Systems.
618 \subsection{Media List View}
620 By clicking on ``Media'', you can see the list of all your volumes. You will be
621 able to filter by Pool, Media Type, Location,\dots And sort the result directly
622 in the table. The old ``Media'' view is now known as ``Pool''.
625 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
626 \label{fig:mediaview}
630 \subsection{Media Information View}
632 By double-clicking on a volume (on the Media list, in the Autochanger content
633 or in the Job information panel), you can access a detailed overview of your
634 Volume. (cf \ref{fig:mediainfo}.)
637 \includegraphics[width=13cm]{\idir bat11.eps}
638 \caption{Media information}
639 \label{fig:mediainfo}
642 \subsection{Job Information View}
644 By double-clicking on a Job record (on the Job run list or in the Media
645 information panel), you can access a detailed overview of your Job. (cf
649 \includegraphics[width=13cm]{\idir bat12.eps}
650 \caption{Job information}
654 \subsection{Autochanger Content View}
656 By double-clicking on a Storage record (on the Storage list panel), you can
657 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
660 \includegraphics[width=13cm]{\idir bat13.eps}
661 \caption{Autochanger content}
662 \label{fig:achcontent}
665 To use this feature, you need to use the latest mtx-changer script
666 version. (With new \texttt{listall} and \texttt{transfer} commands)
668 \section{Bat on Windows}
669 We have ported {\bf bat} to Windows and it is now installed
670 by default when the installer is run. It works quite well
671 on Win32, but has not had a lot of testing there, so your
672 feedback would be welcome. Unfortunately, eventhough it is
673 installed by default, it does not yet work on 64 bit Windows
676 \section{New Win32 Installer}
677 The Win32 installer has been modified in several very important
680 \item You must deinstall any current version of the
681 Win32 File daemon before upgrading to the new one.
682 If you forget to do so, the new installation will fail.
683 To correct this failure, you must manually shutdown
684 and deinstall the old File daemon.
685 \item All files (other than menu links) are installed
686 in {\bf c:/Program Files/Bacula}.
687 \item The installer no longer sets this
688 file to require administrator privileges by default. If you want
689 to do so, please do it manually using the {\bf cacls} program.
692 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
694 \item The server daemons (Director and Storage daemon) are
695 no longer included in the Windows installer. If you want the
696 Windows servers, you will either need to build them yourself (note
697 they have not been ported to 64 bits), or you can contact
698 Bacula Systems about this.
701 \section{Win64 Installer}
702 We have corrected a number of problems that required manual
703 editing of the conf files. In most cases, it should now
704 install and work. {\bf bat} is by default installed in
705 {\bf c:/Program Files/Bacula/bin32} rather than
706 {\bf c:/Program Files/Bacula} as is the case with the 32
707 bit Windows installer.
709 \section{Linux Bare Metal Recovery USB Key}
710 We have made a number of significant improvements in the
711 Bare Metal Recovery USB key. Please see the README files
712 it the {\bf rescue} release for more details.
714 We are working on an equivalent USB key for Windows bare
715 metal recovery, but it will take some time to develop it (best
716 estimate 3Q2010 or 4Q2010)
719 \section{bconsole Timeout Option}
720 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
721 for commands. This is useful with GUI programs that use {\bf bconsole}
722 to interface to the Director.
724 \section{Important Changes}
725 \label{sec:importantchanges}
728 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
729 to the same Pool. The Storage daemon ensures that you do not read and
730 write to the same Volume.
731 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
733 \item Virtually all the features of {\bf mtx-changer} have
734 now been parameterized, which allows you to configure
735 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
736 that contains variables that you can set to configure mtx-changer.
737 This configuration file will not be overwritten during upgrades.
738 We encourage you to submit any changes
739 that are made to mtx-changer and to parameterize it all in
740 mtx-changer.conf so that all configuration will be done by
741 changing only mtx-changer.conf.
742 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
743 and \texttt{transfer}. Please configure them as appropriate
745 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
746 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
747 password. If you want to use the new script, you will need to
748 manually change the \texttt{BackupCatalog} Job definition.
749 \item The \texttt{bconsole} \texttt{help} command now accepts
750 an argument, which if provided produces information on that
751 command (ex: \texttt{help run}).
755 \subsubsection*{Truncate volume after purge}
757 Note that the Truncate Volume after purge feature doesn't work as expected
758 in 5.0.0 version. Please, don't use it before version 5.0.1.
760 \subsection{Custom Catalog queries}
762 If you wish to add specialized commands that list the contents of the catalog,
763 you can do so by adding them to the \texttt{query.sql} file. This
764 \texttt{query.sql} file is now empty by default. The file
765 \texttt{examples/sample-query.sql} has an a number of sample commands
766 you might find useful.
768 \subsection{Deprecated parts}
770 The following items have been \textbf{deprecated} for a long time, and are now
771 removed from the code.
774 \item Support for SQLite 2
777 \section{Misc Changes}
778 \label{sec:miscchanges}
781 \item Updated Nagios check\_bacula
782 \item Updated man files
783 \item Added OSX package generation script in platforms/darwin
784 \item Added Spanish and Ukrainian Bacula translations
785 \item Enable/disable command shows only Jobs that can change
786 \item Added \texttt{show disabled} command to show disabled Jobs
787 \item Many ACL improvements
788 \item Added Level to FD status Job output
789 \item Begin Ingres DB driver (not yet working)
790 \item Split RedHat spec files into bacula, bat, mtx, and docs
791 \item Reorganized the manuals (fewer separate manuals)
792 \item Added lock/unlock order protection in lock manager
793 \item Allow 64 bit sizes for a number of variables
794 \item Fixed several deadlocks or potential race conditions in the SD
797 \chapter{Released Version 3.0.3 and 3.0.3a}
799 There are no new features in version 3.0.3. This version simply fixes a
800 number of bugs found in version 3.0.2 during the onging development
803 \chapter{New Features in Released Version 3.0.2}
805 This chapter presents the new features added to the
806 Released Bacula Version 3.0.2.
808 \section{Full Restore from a Given JobId}
809 \index[general]{Restore menu}
811 This feature allows selecting a single JobId and having Bacula
812 automatically select all the other jobs that comprise a full backup up to
813 and including the selected date (through JobId).
815 Assume we start with the following jobs:
817 +-------+--------------+---------------------+-------+----------+------------+
818 | jobid | client | starttime | level | jobfiles | jobbytes |
819 +-------+--------------+---------------------+-------+----------+------------
820 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
821 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
822 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
823 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
824 +-------+--------------+---------------------+-------+----------+------------+
827 Below is an example of this new feature (which is number 12 in the
832 To select the JobIds, you have the following choices:
833 1: List last 20 Jobs run
834 2: List Jobs where a given File is saved
836 12: Select full restore to a specified Job date
839 Select item: (1-13): 12
840 Enter JobId to get the state to restore: 5
841 Selecting jobs to build the Full state at 2009-07-15 11:45:45
842 You have selected the following JobIds: 1,3,5
844 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
845 1,444 files inserted into the tree.
848 This project was funded by Bacula Systems.
850 \section{Source Address}
851 \index[general]{Source Address}
853 A feature has been added which allows the administrator to specify the address
854 from which the Director and File daemons will establish connections. This
855 may be used to simplify system configuration overhead when working in complex
856 networks utilizing multi-homing and policy-routing.
858 To accomplish this, two new configuration directives have been implemented:
861 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
865 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
869 Simply adding specific host routes on the OS
870 would have an undesirable side-effect: any
871 application trying to contact the destination host would be forced to use the
872 more specific route possibly diverting management traffic onto a backup VLAN.
873 Instead of adding host routes for each client connected to a multi-homed backup
874 server (for example where there are management and backup VLANs), one can
875 use the new directives to specify a specific source address at the application
878 Additionally, this allows the simplification and abstraction of firewall rules
879 when dealing with a Hot-Standby director or storage daemon configuration. The
880 Hot-standby pair may share a CARP address, which connections must be sourced
881 from, while system services listen and act from the unique interface addresses.
883 This project was funded by Collaborative Fusion, Inc.
885 \section{Show volume availability when doing restore}
887 When doing a restore the selection dialog ends by displaying this
891 The job will require the following
892 Volume(s) Storage(s) SD Device(s)
893 ===========================================================================
904 Volumes marked with ``*'' are online (in the autochanger).
907 This should help speed up large restores by minimizing the time spent
908 waiting for the operator to discover that he must change tapes in the library.
910 This project was funded by Bacula Systems.
912 \section{Accurate estimate command}
914 The \texttt{estimate} command can now use the accurate code to detect changes
915 and give a better estimation.
917 You can set the accurate behavior on the command line by using
918 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
921 * estimate listing accurate=yes level=incremental job=BackupJob
924 This project was funded by Bacula Systems.
926 \chapter{New Features in 3.0.0}
927 \label{NewFeaturesChapter}
928 \index[general]{New Features}
930 This chapter presents the new features added to the development 2.5.x
931 versions to be released as Bacula version 3.0.0 sometime in April 2009.
933 \section{Accurate Backup}
934 \index[general]{Accurate Backup}
936 As with most other backup programs, by default Bacula decides what files to
937 backup for Incremental and Differental backup by comparing the change
938 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
939 backup completed. If one of those two times is later than the last backup
940 time, then the file will be backed up. This does not, however, permit tracking
941 what files have been deleted and will miss any file with an old time that may
942 have been restored to or moved onto the client filesystem.
944 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
945 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
946 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
947 backup, there is no difference, but for {\bf Differential} and {\bf
948 Incremental} backups, the Director will send a list of all previous files
949 backed up, and the File daemon will use that list to determine if any new files
950 have been added or or moved and if any files have been deleted. This allows
951 Bacula to make an accurate backup of your system to that point in time so that
952 if you do a restore, it will restore your system exactly.
955 about using Accurate backup is that it requires more resources (CPU and memory)
956 on both the Director and the Client machines to create the list of previous
957 files backed up, to send that list to the File daemon, for the File daemon to
958 keep the list (possibly very big) in memory, and for the File daemon to do
959 comparisons between every file in the FileSet and the list. In particular,
960 if your client has lots of files (more than a few million), you will need
961 lots of memory on the client machine.
963 Accurate must not be enabled when backing up with a plugin that is not
964 specially designed to work with Accurate. If you enable it, your restores
965 will probably not work correctly.
967 This project was funded by Bacula Systems.
972 \index[general]{Copy Jobs}
974 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
975 existing Migration feature with the exception that the Job that is copied is
976 left unchanged. This essentially creates two identical copies of the same
977 backup. However, the copy is treated as a copy rather than a backup job, and
978 hence is not directly available for restore. The {\bf restore} command lists
979 copy jobs and allows selection of copies by using \texttt{jobid=}
980 option. If the keyword {\bf copies} is present on the command line, Bacula will
981 display the list of all copies for selected jobs.
986 These JobIds have copies as follows:
987 +-------+------------------------------------+-----------+------------------+
988 | JobId | Job | CopyJobId | MediaType |
989 +-------+------------------------------------+-----------+------------------+
990 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
991 +-------+------------------------------------+-----------+------------------+
992 +-------+-------+----------+----------+---------------------+------------------+
993 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
994 +-------+-------+----------+----------+---------------------+------------------+
995 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
996 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
997 +-------+-------+----------+----------+---------------------+------------------+
998 You have selected the following JobIds: 19,2
1000 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1001 5,611 files inserted into the tree.
1006 The Copy Job runs without using the File daemon by copying the data from the
1007 old backup Volume to a different Volume in a different Pool. See the Migration
1008 documentation for additional details. For copy Jobs there is a new selection
1009 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1010 not already copied to another Pool.
1012 As with Migration, the Client, Volume, Job, or SQL query, are
1013 other possible ways of selecting the Jobs to be copied. Selection
1014 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1015 work, but are probably more suited for Migration Jobs.
1017 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1018 it will promote the Copy to a \textsl{real} backup job and will make it available for
1019 automatic restore. If more than one Copy is available, it will promote the copy
1020 with the smallest JobId.
1022 A nice solution which can be built with the new Copy feature is often
1023 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1024 look something like the one below:
1028 Name = FullBackupsVirtualPool
1030 Purge Oldest Volume = Yes
1032 NextPool = FullBackupsTapePool
1036 Name = FullBackupsTapePool
1040 Volume Retention = 365 days
1041 Storage = superloader
1045 # Fake fileset for copy jobs
1057 # Fake client for copy jobs
1067 # Default template for a CopyDiskToTape Job
1070 Name = CopyDiskToTape
1072 Messages = StandardCopy
1075 Selection Type = PoolUncopiedJobs
1076 Maximum Concurrent Jobs = 10
1078 Allow Duplicate Jobs = Yes
1079 Cancel Queued Duplicates = No
1080 Cancel Running Duplicates = No
1085 Name = DaySchedule7:00
1086 Run = Level=Full daily at 7:00
1090 Name = CopyDiskToTapeFullBackups
1092 Schedule = DaySchedule7:00
1093 Pool = FullBackupsVirtualPool
1094 JobDefs = CopyDiskToTape
1098 The example above had 2 pool which are copied using the PoolUncopiedJobs
1099 selection criteria. Normal Full backups go to the Virtual pool and are copied
1100 to the Tape pool the next morning.
1102 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1107 +-------+------------------------------------+-----------+------------------+
1108 | JobId | Job | CopyJobId | MediaType |
1109 +-------+------------------------------------+-----------+------------------+
1110 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1111 +-------+------------------------------------+-----------+------------------+
1114 \section{ACL Updates}
1115 \index[general]{ACL Updates}
1116 The whole ACL code had been overhauled and in this version each platforms has
1117 different streams for each type of acl available on such an platform. As ACLs
1118 between platforms tend to be not that portable (most implement POSIX acls but
1119 some use an other draft or a completely different format) we currently only
1120 allow certain platform specific ACL streams to be decoded and restored on the
1121 same platform that they were created on. The old code allowed to restore ACL
1122 cross platform but the comments already mention that not being to wise. For
1123 backward compatability the new code will accept the two old ACL streams and
1124 handle those with the platform specific handler. But for all new backups it
1125 will save the ACLs using the new streams.
1127 Currently the following platforms support ACLs:
1131 \item {\bf Darwin/OSX}
1140 Currently we support the following ACL types (these ACL streams use a reserved
1141 part of the stream numbers):
1144 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1146 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1147 string representation from acl\_to\_text (POSIX acl)
1148 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1149 string representation from acl\_to\_text (POSIX acl) for default acls.
1150 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1151 string representation from acl\_to\_text (POSIX acl) for access acls.
1152 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1153 string representation from acltostr (POSIX acl)
1154 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1155 representation from acl\_to\_text (POSIX acl) for default acls.
1156 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1157 representation from acl\_to\_text (POSIX acl) for access acls.
1158 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1159 string representation from acl\_to\_text (POSIX acl) for default acls.
1160 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1161 representation from acl\_to\_text (POSIX acl) for access acls.
1162 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1163 string representation from acl\_to\_text (POSIX acl) for default acls.
1164 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1165 string representation from acl\_to\_text (POSIX acl) for default acls.
1166 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1167 representation from acl\_to\_text (POSIX acl) for access acls.
1168 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1169 string representation from acltotext or acl\_totext (POSIX acl)
1170 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1171 representation from from acl\_totext (NFSv4 or ZFS acl)
1174 In future versions we might support conversion functions from one type of acl
1175 into an other for types that are either the same or easily convertable. For now
1176 the streams are seperate and restoring them on a platform that doesn't
1177 recognize them will give you a warning.
1179 \section{Extended Attributes}
1180 \index[general]{Extended Attributes}
1181 Something that was on the project list for some time is now implemented for
1182 platforms that support a similar kind of interface. Its the support for backup
1183 and restore of so called extended attributes. As extended attributes are so
1184 platform specific these attributes are saved in seperate streams for each
1185 platform. Restores of the extended attributes can only be performed on the
1186 same platform the backup was done. There is support for all types of extended
1187 attributes, but restoring from one type of filesystem onto an other type of
1188 filesystem on the same platform may lead to supprises. As extended attributes
1189 can contain any type of data they are stored as a series of so called
1190 value-pairs. This data must be seen as mostly binary and is stored as such.
1191 As security labels from selinux are also extended attributes this option also
1192 stores those labels and no specific code is enabled for handling selinux
1195 Currently the following platforms support extended attributes:
1197 \item {\bf Darwin/OSX}
1203 On linux acls are also extended attributes, as such when you enable ACLs on a
1204 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1205 and not the same exteneded attribute.
1207 To enable the backup of extended attributes please add the following to your
1222 \section{Shared objects}
1223 \index[general]{Shared objects}
1224 A default build of Bacula will now create the libraries as shared objects
1225 (.so) rather than static libraries as was previously the case.
1226 The shared libraries are built using {\bf libtool} so it should be quite
1229 An important advantage of using shared objects is that on a machine with the
1230 Directory, File daemon, the Storage daemon, and a console, you will have only
1231 one copy of the code in memory rather than four copies. Also the total size of
1232 the binary release is smaller since the library code appears only once rather
1233 than once for every program that uses it; this results in significant reduction
1234 in the size of the binaries particularly for the utility tools.
1236 In order for the system loader to find the shared objects when loading the
1237 Bacula binaries, the Bacula shared objects must either be in a shared object
1238 directory known to the loader (typically /usr/lib) or they must be in the
1239 directory that may be specified on the {\bf ./configure} line using the {\bf
1240 {-}{-}libdir} option as:
1243 ./configure --libdir=/full-path/dir
1246 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1247 no need to modify your loader configuration provided that
1248 the shared objects are installed in that directory (Bacula
1249 does this with the make install command). The shared objects
1250 that Bacula references are:
1259 These files are symbolically linked to the real shared object file,
1260 which has a version number to permit running multiple versions of
1261 the libraries if desired (not normally the case).
1263 If you have problems with libtool or you wish to use the old
1264 way of building static libraries, or you want to build a static
1265 version of Bacula you may disable
1266 libtool on the configure command line with:
1269 ./configure --disable-libtool
1273 \section{Building Static versions of Bacula}
1274 \index[general]{Static linking}
1275 In order to build static versions of Bacula, in addition
1276 to configuration options that were needed you now must
1277 also add --disable-libtool. Example
1280 ./configure --enable-static-client-only --disable-libtool
1284 \section{Virtual Backup (Vbackup)}
1285 \index[general]{Virtual Backup}
1286 \index[general]{Vbackup}
1288 Bacula's virtual backup feature is often called Synthetic Backup or
1289 Consolidation in other backup products. It permits you to consolidate the
1290 previous Full backup plus the most recent Differential backup and any
1291 subsequent Incremental backups into a new Full backup. This new Full
1292 backup will then be considered as the most recent Full for any future
1293 Incremental or Differential backups. The VirtualFull backup is
1294 accomplished without contacting the client by reading the previous backup
1295 data and writing it to a volume in a different pool.
1297 In some respects the Vbackup feature works similar to a Migration job, in
1298 that Bacula normally reads the data from the pool specified in the
1299 Job resource, and writes it to the {\bf Next Pool} specified in the
1300 Job resource. Note, this means that usually the output from the Virtual
1301 Backup is written into a different pool from where your prior backups
1302 are saved. Doing it this way guarantees that you will not get a deadlock
1303 situation attempting to read and write to the same volume in the Storage
1304 daemon. If you then want to do subsequent backups, you may need to
1305 move the Virtual Full Volume back to your normal backup pool.
1306 Alternatively, you can set your {\bf Next Pool} to point to the current
1307 pool. This will cause Bacula to read and write to Volumes in the
1308 current pool. In general, this will work, because Bacula will
1309 not allow reading and writing on the same Volume. In any case, once
1310 a VirtualFull has been created, and a restore is done involving the
1311 most current Full, it will read the Volume or Volumes by the VirtualFull
1312 regardless of in which Pool the Volume is found.
1314 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1315 a level of {\bf VirtualFull}.
1317 A typical Job resource definition might look like the following:
1324 FileSet = "Full Set"
1331 # Default pool definition
1335 Recycle = yes # Automatically recycle Volumes
1336 AutoPrune = yes # Prune expired volumes
1337 Volume Retention = 365d # one year
1345 Recycle = yes # Automatically recycle Volumes
1346 AutoPrune = yes # Prune expired volumes
1347 Volume Retention = 365d # one year
1348 Storage = DiskChanger
1351 # Definition of file storage device
1356 Device = FileStorage
1358 Maximum Concurrent Jobs = 5
1361 # Definition of DDS Virtual tape disk storage device
1364 Address = localhost # N.B. Use a fully qualified name here
1366 Device = DiskChanger
1367 Media Type = DiskChangerMedia
1368 Maximum Concurrent Jobs = 4
1373 Then in bconsole or via a Run schedule, you would run the job as:
1376 run job=MyBackup level=Full
1377 run job=MyBackup level=Incremental
1378 run job=MyBackup level=Differential
1379 run job=MyBackup level=Incremental
1380 run job=MyBackup level=Incremental
1383 So providing there were changes between each of those jobs, you would end up
1384 with a Full backup, a Differential, which includes the first Incremental
1385 backup, then two Incremental backups. All the above jobs would be written to
1386 the {\bf Default} pool.
1388 To consolidate those backups into a new Full backup, you would run the
1392 run job=MyBackup level=VirtualFull
1395 And it would produce a new Full backup without using the client, and the output
1396 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1398 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1401 Note, the Start and End time of the Virtual Full backup is set to the
1402 values for the last job included in the Virtual Full (in the above example,
1403 it is an Increment). This is so that if another incremental is done, which
1404 will be based on the Virtual Full, it will backup all files from the
1405 last Job included in the Virtual Full rather than from the time the Virtual
1406 Full was actually run.
1410 \section{Catalog Format}
1411 \index[general]{Catalog Format}
1412 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1413 operation will convert the FileId field of the File table from 32 bits (max 4
1414 billion table entries) to 64 bits (very large number of items). The
1415 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1416 your catalog during the conversion. Also you won't be able to run jobs during
1417 this conversion period. For example, a 3 million file catalog will take 2
1418 minutes to upgrade on a normal machine. Please don't forget to make a valid
1419 backup of your database before executing the upgrade script. See the
1420 ReleaseNotes for additional details.
1422 \section{64 bit Windows Client}
1423 \index[general]{Win64 Client}
1424 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1425 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1426 As a consequence, we are also releasing a 64 bit version of the Bacula
1427 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1428 These binaries should only be installed on 64 bit Windows operating systems.
1429 What is important is not your hardware but whether or not you have
1430 a 64 bit version of the Windows OS.
1432 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1434 \item Before installing the Win64 Bacula Client, you must totally
1435 deinstall any prior 2.4.x Client installation using the
1436 Bacula deinstallation (see the menu item). You may want
1437 to save your .conf files first.
1438 \item Only the Client (File daemon) is ported to Win64, the Director
1439 and the Storage daemon are not in the 64 bit Windows installer.
1440 \item bwx-console is not yet ported.
1441 \item bconsole is ported but it has not been tested.
1442 \item The documentation is not included in the installer.
1443 \item Due to Vista security restrictions imposed on a default installation
1444 of Vista, before upgrading the Client, you must manually stop
1445 any prior version of Bacula from running, otherwise the install
1447 \item Due to Vista security restrictions imposed on a default installation
1448 of Vista, attempting to edit the conf files via the menu items
1449 will fail. You must directly edit the files with appropriate
1450 permissions. Generally double clicking on the appropriate .conf
1451 file will work providing you have sufficient permissions.
1452 \item All Bacula files are now installed in
1453 {\bf C:/Program Files/Bacula} except the main menu items,
1454 which are installed as before. This vastly simplifies the installation.
1455 \item If you are running on a foreign language version of Windows, most
1456 likely {\bf C:/Program Files} does not exist, so you should use the
1457 Custom installation and enter an appropriate location to install
1459 \item The 3.0.0 Win32 Client continues to install files in the locations used
1460 by prior versions. For the next version we will convert it to use
1461 the same installation conventions as the Win64 version.
1464 This project was funded by Bacula Systems.
1467 \section{Duplicate Job Control}
1468 \index[general]{Duplicate Jobs}
1469 The new version of Bacula provides four new directives that
1470 give additional control over what Bacula does if duplicate jobs
1471 are started. A duplicate job in the sense we use it here means
1472 a second or subsequent job with the same name starts. This
1473 happens most frequently when the first job runs longer than expected because no
1474 tapes are available.
1476 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1477 are specified in the Job resource.
1481 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1482 \index[general]{Allow Duplicate Jobs}
1483 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1484 the directive is set to {\bf no} (default) then only one job of a given name
1485 may run at one time, and the action that Bacula takes to ensure only
1486 one job runs is determined by the other directives (see below).
1488 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1489 are present and none of the three directives given below permit
1490 cancelling a job, then the current job (the second one started)
1493 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1494 \index[general]{Allow Higher Duplicates}
1495 This directive was in version 5.0.0, but does not work as
1496 expected. If used, it should always be set to no. In later versions
1497 of Bacula the directive is disabled (disregarded).
1499 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1500 \index[general]{Cancel Running Duplicates}
1501 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1502 if this directive is set to {\bf yes} any job that is already running
1503 will be canceled. The default is {\bf no}.
1505 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1506 \index[general]{Cancel Queued Duplicates}
1507 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1508 if this directive is set to {\bf yes} any job that is
1509 already queued to run but not yet running will be canceled.
1510 The default is {\bf no}.
1513 \section{TLS Authentication}
1514 \index[general]{TLS Authentication}
1515 In Bacula version 2.5.x and later, in addition to the normal Bacula
1516 CRAM-MD5 authentication that is used to authenticate each Bacula
1517 connection, you can specify that you want TLS Authentication as well,
1518 which will provide more secure authentication.
1520 This new feature uses Bacula's existing TLS code (normally used for
1521 communications encryption) to do authentication. To use it, you must
1522 specify all the TLS directives normally used to enable communications
1523 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1526 \subsection{TLS Authenticate = yes}
1528 TLS Authenticate = yes
1531 in the main daemon configuration resource (Director for the Director,
1532 Client for the File daemon, and Storage for the Storage daemon).
1534 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1535 authentication, Bacula will also do TLS authentication, then TLS
1536 encryption will be turned off, and the rest of the communication between
1537 the two Bacula daemons will be done without encryption.
1539 If you want to encrypt communications data, use the normal TLS directives
1540 but do not turn on {\bf TLS Authenticate}.
1542 \section{bextract non-portable Win32 data}
1543 \index[general]{bextract handles Win32 non-portable data}
1544 {\bf bextract} has been enhanced to be able to restore
1545 non-portable Win32 data to any OS. Previous versions were
1546 unable to restore non-portable Win32 data to machines that
1547 did not have the Win32 BackupRead and BackupWrite API calls.
1549 \section{State File updated at Job Termination}
1550 \index[general]{State File}
1551 In previous versions of Bacula, the state file, which provides a
1552 summary of previous jobs run in the {\bf status} command output was
1553 updated only when Bacula terminated, thus if the daemon crashed, the
1554 state file might not contain all the run data. This version of
1555 the Bacula daemons updates the state file on each job termination.
1557 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1558 \index[general]{MaxFullInterval}
1559 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1560 can be used to specify the maximum time interval between {\bf Full} backup
1561 jobs. When a job starts, if the time since the last Full backup is
1562 greater than the specified interval, and the job would normally be an
1563 {\bf Incremental} or {\bf Differential}, it will be automatically
1564 upgraded to a {\bf Full} backup.
1566 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1567 \index[general]{MaxDiffInterval}
1568 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1569 can be used to specify the maximum time interval between {\bf Differential} backup
1570 jobs. When a job starts, if the time since the last Differential backup is
1571 greater than the specified interval, and the job would normally be an
1572 {\bf Incremental}, it will be automatically
1573 upgraded to a {\bf Differential} backup.
1575 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1576 \index[general]{MaxDiffInterval}
1577 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1578 by the user, and when it is set it is an indication to backup programs
1579 to not backup that particular file. This version of Bacula contains a
1580 new Options directive within a FileSet resource, which instructs Bacula to
1581 obey this flag. The new directive is:
1584 Honor No Dump Flag = yes\vb{}no
1587 The default value is {\bf no}.
1590 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1591 \index[general]{IgnoreDir}
1592 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1593 can be added to the Include section of the FileSet resource. If the specified
1594 filename ({\bf filename-string}) is found on the Client in any directory to be
1595 backed up, the whole directory will be ignored (not backed up). For example:
1598 # List of files to be backed up
1606 Exclude Dir Containing = .excludeme
1611 But in /home, there may be hundreds of directories of users and some
1612 people want to indicate that they don't want to have certain
1613 directories backed up. For example, with the above FileSet, if
1614 the user or sysadmin creates a file named {\bf .excludeme} in
1615 specific directories, such as
1618 /home/user/www/cache/.excludeme
1619 /home/user/temp/.excludeme
1622 then Bacula will not backup the two directories named:
1625 /home/user/www/cache
1629 NOTE: subdirectories will not be backed up. That is, the directive
1630 applies to the two directories in question and any children (be they
1631 files, directories, etc).
1634 \section{Bacula Plugins}
1635 \index[general]{Plugin}
1636 Support for shared object plugins has been implemented in the Linux, Unix
1637 and Win32 File daemons. The API will be documented separately in
1638 the Developer's Guide or in a new document. For the moment, there is
1639 a single plugin named {\bf bpipe} that allows an external program to
1640 get control to backup and restore a file.
1642 Plugins are also planned (partially implemented) in the Director and the
1645 \subsection{Plugin Directory}
1646 \index[general]{Plugin Directory}
1647 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1648 be added to the daemon definition resource. The directory takes a quoted
1649 string argument, which is the name of the directory in which the daemon can
1650 find the Bacula plugins. If this directive is not specified, Bacula will not
1651 load any plugins. Since each plugin has a distinctive name, all the daemons
1652 can share the same plugin directory.
1654 \subsection{Plugin Options}
1655 \index[general]{Plugin Options}
1656 The {\bf Plugin Options} directive takes a quoted string
1657 arguement (after the equal sign) and may be specified in the
1658 Job resource. The options specified will be passed to all plugins
1659 when they are run. This each plugin must know what it is looking
1660 for. The value defined in the Job resource can be modified
1661 by the user when he runs a Job via the {\bf bconsole} command line
1664 Note: this directive may be specified, and there is code to modify
1665 the string in the run command, but the plugin options are not yet passed to
1666 the plugin (i.e. not fully implemented).
1668 \subsection{Plugin Options ACL}
1669 \index[general]{Plugin Options ACL}
1670 The {\bf Plugin Options ACL} directive may be specified in the
1671 Director's Console resource. It functions as all the other ACL commands
1672 do by permitting users running restricted consoles to specify a
1673 {\bf Plugin Options} that overrides the one specified in the Job
1674 definition. Without this directive restricted consoles may not modify
1677 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1678 \index[general]{Plugin}
1679 The {\bf Plugin} directive is specified in the Include section of
1680 a FileSet resource where you put your {\bf File = xxx} directives.
1691 Plugin = "bpipe:..."
1696 In the above example, when the File daemon is processing the directives
1697 in the Include section, it will first backup all the files in {\bf /home}
1698 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1699 the Plugin Directory. The syntax and semantics of the Plugin directive
1700 require the first part of the string up to the colon (:) to be the name
1701 of the plugin. Everything after the first colon is ignored by the File daemon but
1702 is passed to the plugin. Thus the plugin writer may define the meaning of the
1703 rest of the string as he wishes.
1705 Please see the next section for information about the {\bf bpipe} Bacula
1708 \section{The bpipe Plugin}
1709 \index[general]{The bpipe Plugin}
1710 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1711 the Bacula source distribution. When the plugin is compiled and linking into
1712 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1713 Please note that this is a very simple plugin that was written for
1714 demonstration and test purposes. It is and can be used in production, but
1715 that was never really intended.
1717 The purpose of the plugin is to provide an interface to any system program for
1718 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1719 the Include section of your Job's FileSet resource. The full syntax of the
1720 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1721 to specify the sytax as it wishes) is:
1724 Plugin = "<field1>:<field2>:<field3>:<field4>"
1729 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1730 stripped off, so in this case, we would put {\bf bpipe} in this field.
1732 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1733 pseudo path and filename under which the backup will be saved. This pseudo
1734 path and filename will be seen by the user in the restore file tree.
1735 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1736 backed up by the plugin will be put under that "pseudo" path and filename.
1737 You must be careful to choose a naming convention that is unique to avoid
1738 a conflict with a path and filename that actually exists on your system.
1740 \item {\bf field3} for the {\bf bpipe} plugin
1741 specifies the "reader" program that is called by the plugin during
1742 backup to read the data. {\bf bpipe} will call this program by doing a
1745 \item {\bf field4} for the {\bf bpipe} plugin
1746 specifies the "writer" program that is called by the plugin during
1747 restore to write the data back to the filesystem.
1750 Please note that for two items above describing the "reader" and "writer"
1751 fields, these programs are "executed" by Bacula, which
1752 means there is no shell interpretation of any command line arguments
1753 you might use. If you want to use shell characters (redirection of input
1754 or output, ...), then we recommend that you put your command or commands
1755 in a shell script and execute the script. In addition if you backup a
1756 file with the reader program, when running the writer program during
1757 the restore, Bacula will not automatically create the path to the file.
1758 Either the path must exist, or you must explicitly do so with your command
1759 or in a shell script.
1761 Putting it all together, the full plugin directive line might look
1765 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1766 --opt --databases bacula:mysql"
1769 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1770 would be written on a single line.
1772 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1773 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1774 program {\bf mysqldump -f --opt --database bacula} to read the data during
1775 backup. The mysqldump command outputs all the data for the database named
1776 {\bf bacula}, which will be read by the plugin and stored in the backup.
1777 During restore, the data that was backed up will be sent to the program
1778 specified in the last field, which in this case is {\bf mysql}. When
1779 {\bf mysql} is called, it will read the data sent to it by the plugn
1780 then write it back to the same database from which it came ({\bf bacula}
1783 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1784 the data from a specified program to Bacula for backup, and then from Bacula to
1785 a specified program for restore.
1787 By using different command lines to {\bf bpipe},
1788 you can backup any kind of data (ASCII or binary) depending
1789 on the program called.
1791 \section{Microsoft Exchange Server 2003/2007 Plugin}
1792 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1793 \subsection{Background}
1794 The Exchange plugin was made possible by a funded development project
1795 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1796 The code for the plugin was written by James Harper, and the Bacula core
1797 code by Kern Sibbald. All the code for this funded development has become
1798 part of the Bacula project. Thanks to everyone who made it happen.
1800 \subsection{Concepts}
1801 Although it is possible to backup Exchange using Bacula VSS the Exchange
1802 plugin adds a good deal of functionality, because while Bacula VSS
1803 completes a full backup (snapshot) of Exchange, it does
1804 not support Incremental or Differential backups, restoring is more
1805 complicated, and a single database restore is not possible.
1807 Microsoft Exchange organises its storage into Storage Groups with
1808 Databases inside them. A default installation of Exchange will have a
1809 single Storage Group called 'First Storage Group', with two Databases
1810 inside it, "Mailbox Store (SERVER NAME)" and
1811 "Public Folder Store (SERVER NAME)",
1812 which hold user email and public folders respectively.
1814 In the default configuration, Exchange logs everything that happens to
1815 log files, such that if you have a backup, and all the log files since,
1816 you can restore to the present time. Each Storage Group has its own set
1817 of log files and operates independently of any other Storage Groups. At
1818 the Storage Group level, the logging can be turned off by enabling a
1819 function called "Enable circular logging". At this time the Exchange
1820 plugin will not function if this option is enabled.
1822 The plugin allows backing up of entire storage groups, and the restoring
1823 of entire storage groups or individual databases. Backing up and
1824 restoring at the individual mailbox or email item is not supported but
1825 can be simulated by use of the "Recovery" Storage Group (see below).
1827 \subsection{Installing}
1828 The Exchange plugin requires a DLL that is shipped with Microsoft
1829 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1830 correctly the Exchange plugin should find this automatically and run
1831 without any additional installation.
1833 If the DLL can not be found automatically it will need to be copied into
1834 the Bacula installation
1835 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1836 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1837 default Exchange installation.
1839 \subsection{Backing Up}
1840 To back up an Exchange server the Fileset definition must contain at
1841 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1842 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1843 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1844 up files are prefixed with something that isn't going to share a name
1845 with something outside the plugin, and the 'Microsoft Information Store'
1846 bit is required also. It is also possible to add the name of a storage
1847 group to the "Plugin =" line, eg \\
1848 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1849 if you want only a single storage group backed up.
1851 Additionally, you can suffix the 'Plugin =' directive with
1852 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1853 database at the end of a full backup.
1855 An Incremental or Differential backup will backup only the database logs
1856 for each Storage Group by inspecting the "modified date" on each
1857 physical log file. Because of the way the Exchange API works, the last
1858 logfile backed up on each backup will always be backed up by the next
1859 Incremental or Differential backup too. This adds 5MB to each
1860 Incremental or Differential backup size but otherwise does not cause any
1863 By default, a normal VSS fileset containing all the drive letters will
1864 also back up the Exchange databases using VSS. This will interfere with
1865 the plugin and Exchange's shared ideas of when the last full backup was
1866 done, and may also truncate log files incorrectly. It is important,
1867 therefore, that the Exchange database files be excluded from the backup,
1868 although the folders the files are in should be included, or they will
1869 have to be recreated manually if a baremetal restore is done.
1874 File = C:/Program Files/Exchsrvr/mdbdata
1875 Plugin = "exchange:..."
1878 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1879 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1880 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1881 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1882 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1883 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1884 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1889 The advantage of excluding the above files is that you can significantly
1890 reduce the size of your backup since all the important Exchange files
1891 will be properly saved by the Plugin.
1894 \subsection{Restoring}
1895 The restore operation is much the same as a normal Bacula restore, with
1896 the following provisos:
1899 \item The {\bf Where} restore option must not be specified
1900 \item Each Database directory must be marked as a whole. You cannot just
1901 select (say) the .edb file and not the others.
1902 \item If a Storage Group is restored, the directory of the Storage Group
1904 \item It is possible to restore only a subset of the available log files,
1905 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1906 if a log file is missing from the sequence of log files
1907 \item Each database to be restored must be dismounted and marked as "Can be
1908 overwritten by restore"
1909 \item If an entire Storage Group is to be restored (eg all databases and
1910 logs in the Storage Group), then it is best to manually delete the
1911 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1912 as Exchange can get confused by stray log files lying around.
1915 \subsection{Restoring to the Recovery Storage Group}
1916 The concept of the Recovery Storage Group is well documented by
1918 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1919 but to briefly summarize...
1921 Microsoft Exchange allows the creation of an additional Storage Group
1922 called the Recovery Storage Group, which is used to restore an older
1923 copy of a database (e.g. before a mailbox was deleted) into without
1924 messing with the current live data. This is required as the Standard and
1925 Small Business Server versions of Exchange can not ordinarily have more
1926 than one Storage Group.
1928 To create the Recovery Storage Group, drill down to the Server in Exchange
1929 System Manager, right click, and select
1930 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1931 locations and click OK. On the Recovery Storage Group, right click and
1932 select {\bf "Add Database to Recover..."} and select the database you will
1935 Restore only the single database nominated as the database in the
1936 Recovery Storage Group. Exchange will redirect the restore to the
1937 Recovery Storage Group automatically.
1938 Then run the restore.
1940 \subsection{Restoring on Microsoft Server 2007}
1941 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1942 2007, and henc you use a new proceedure for recovering a single mail box.
1943 This procedure is ducomented by Microsoft at:
1944 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1945 and involves using the {\bf Restore-Mailbox} and {\bf
1946 Get-MailboxStatistics} shell commands.
1948 \subsection{Caveats}
1949 This plugin is still being developed, so you should consider it
1950 currently in BETA test, and thus use in a production environment
1951 should be done only after very careful testing.
1953 When doing a full backup, the Exchange database logs are truncated by
1954 Exchange as soon as the plugin has completed the backup. If the data
1955 never makes it to the backup medium (eg because of spooling) then the
1956 logs will still be truncated, but they will also not have been backed
1957 up. A solution to this is being worked on. You will have to schedule a
1958 new Full backup to ensure that your next backups will be usable.
1960 The "Enable Circular Logging" option cannot be enabled or the plugin
1963 Exchange insists that a successful Full backup must have taken place if
1964 an Incremental or Differential backup is desired, and the plugin will
1965 fail if this is not the case. If a restore is done, Exchange will
1966 require that a Full backup be done before an Incremental or Differential
1969 The plugin will most likely not work well if another backup application
1970 (eg NTBACKUP) is backing up the Exchange database, especially if the
1971 other backup application is truncating the log files.
1973 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1974 we recommend either carefully testing or that you avoid this option for
1977 The Exchange plugin is not called during processing the bconsole {\bf
1978 estimate} command, and so anything that would be backed up by the plugin
1979 will not be added to the estimate total that is displayed.
1982 \section{libdbi Framework}
1983 \index[general]{libdbi Framework}
1984 As a general guideline, Bacula has support for a few catalog database drivers
1985 (MySQL, PostgreSQL, SQLite)
1986 coded natively by the Bacula team. With the libdbi implementation, which is a
1987 Bacula driver that uses libdbi to access the catalog, we have an open field to
1988 use many different kinds database engines following the needs of users.
1990 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1991 implements a database-independent abstraction layer in C, similar to the
1992 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1993 leverage the power of multiple databases and multiple simultaneous database
1994 connections by using this framework.
1996 Currently the libdbi driver in Bacula project only supports the same drivers
1997 natively coded in Bacula. However the libdbi project has support for many
1998 others database engines. You can view the list at
1999 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2000 supported by Bacula, however, they must be tested properly by the Bacula team.
2002 Some of benefits of using libdbi are:
2004 \item The possibility to use proprietary databases engines in which your
2005 proprietary licenses prevent the Bacula team from developing the driver.
2006 \item The possibility to use the drivers written for the libdbi project.
2007 \item The possibility to use other database engines without recompiling Bacula
2008 to use them. Just change one line in bacula-dir.conf
2009 \item Abstract Database access, this is, unique point to code and profiling
2010 catalog database access.
2013 The following drivers have been tested:
2015 \item PostgreSQL, with and without batch insert
2016 \item Mysql, with and without batch insert
2021 In the future, we will test and approve to use others databases engines
2022 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2024 To compile Bacula to support libdbi we need to configure the code with the
2025 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2026 [database] is the database engine to be used with Bacula (of course we can
2027 change the driver in file bacula-dir.conf, see below). We must configure the
2028 access port of the database engine with the option --with-db-port, because the
2029 libdbi framework doesn't know the default access port of each database.
2031 The next phase is checking (or configuring) the bacula-dir.conf, example:
2035 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2036 dbname = regress; user = regress; password = ""
2040 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2041 mysql database. Currently the drivers supported by Bacula are: postgresql,
2042 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2044 The following limitations apply when Bacula is set to use the libdbi framework:
2045 - Not tested on the Win32 platform
2046 - A little performance is lost if comparing with native database driver.
2047 The reason is bound with the database driver provided by libdbi and the
2048 simple fact that one more layer of code was added.
2050 It is important to remember, when compiling Bacula with libdbi, the
2051 following packages are needed:
2053 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2054 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2057 You can download them and compile them on your system or install the packages
2058 from your OS distribution.
2060 \section{Console Command Additions and Enhancements}
2061 \index[general]{Console Additions}
2063 \subsection{Display Autochanger Content}
2064 \index[general]{StatusSlots}
2066 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2067 autochanger content.
2071 Slot | Volume Name | Status | Media Type | Pool |
2072 ------+---------------+----------+-------------------+------------|
2073 1 | 00001 | Append | DiskChangerMedia | Default |
2074 2 | 00002 | Append | DiskChangerMedia | Default |
2075 3*| 00003 | Append | DiskChangerMedia | Scratch |
2080 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2081 {\bf update slots} command to synchronize autochanger content with your
2084 \subsection{list joblog job=xxx or jobid=nnn}
2085 \index[general]{list joblog}
2086 A new list command has been added that allows you to list the contents
2087 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2088 or for a particular JobId. The {\bf llist} command will include a line with
2089 the time and date of the entry.
2091 Note for the catalog to have Job Log entries, you must have a directive
2098 In your Director's {\bf Messages} resource.
2100 \subsection{Use separator for multiple commands}
2101 \index[general]{Command Separator}
2102 When using bconsole with readline, you can set the command separator with
2103 \textbf{@separator} command to one
2104 of those characters to write commands who require multiple input in one line.
2106 !$%&'()*+,-/:;<>?[]^`{|}~
2109 \subsection{Deleting Volumes}
2110 The delete volume bconsole command has been modified to
2111 require an asterisk (*) in front of a MediaId otherwise the
2112 value you enter is a taken to be a Volume name. This is so that
2113 users may delete numeric Volume names. The previous Bacula versions
2114 assumed that all input that started with a number was a MediaId.
2116 This new behavior is indicated in the prompt if you read it
2119 \section{Bare Metal Recovery}
2120 The old bare metal recovery project is essentially dead. One
2121 of the main features of it was that it would build a recovery
2122 CD based on the kernel on your system. The problem was that
2123 every distribution has a different boot procedure and different
2124 scripts, and worse yet, the boot procedures and scripts change
2125 from one distribution to another. This meant that maintaining
2126 (keeping up with the changes) the rescue CD was too much work.
2128 To replace it, a new bare metal recovery USB boot stick has been developed
2129 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2130 boot from a USB key.
2134 \item Recovery can be done from within graphical environment.
2135 \item Recovery can be done in a shell.
2136 \item Ubuntu boots on a large number of Linux systems.
2137 \item The process of updating the system and adding new
2138 packages is not too difficult.
2139 \item The USB key can easily be upgraded to newer Ubuntu versions.
2140 \item The USB key has writable partitions for modifications to
2141 the OS and for modification to your home directory.
2142 \item You can add new files/directories to the USB key very easily.
2143 \item You can save the environment from multiple machines on
2145 \item Bacula Systems is funding its ongoing development.
2148 The disadvantages are:
2150 \item The USB key is usable but currently under development.
2151 \item Not everyone may be familiar with Ubuntu (no worse
2153 \item Some older OSes cannot be booted from USB. This can
2154 be resolved by first booting a Ubuntu LiveCD then plugging
2156 \item Currently the documentation is sketchy and not yet added
2157 to the main manual. See below ...
2160 The documentation and the code can be found in the {\bf rescue} package
2161 in the directory {\bf linux/usb}.
2163 \section{Miscellaneous}
2164 \index[general]{Misc New Features}
2166 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2167 \index[general]{Allow Mixed Priority}
2168 This directive is only implemented in version 2.5 and later. When
2169 set to {\bf yes} (default {\bf no}), this job may run even if lower
2170 priority jobs are already running. This means a high priority job
2171 will not have to wait for other jobs to finish before starting.
2172 The scheduler will only mix priorities when all running jobs have
2175 Note that only higher priority jobs will start early. Suppose the
2176 director will allow two concurrent jobs, and that two jobs with
2177 priority 10 are running, with two more in the queue. If a job with
2178 priority 5 is added to the queue, it will be run as soon as one of
2179 the running jobs finishes. However, new priority 10 jobs will not
2180 be run until the priority 5 job has finished.
2182 \subsection{Bootstrap File Directive -- FileRegex}
2183 \index[general]{Bootstrap File Directive}
2184 {\bf FileRegex} is a new command that can be added to the bootstrap
2185 (.bsr) file. The value is a regular expression. When specified, only
2186 matching filenames will be restored.
2188 During a restore, if all File records are pruned from the catalog
2189 for a Job, normally Bacula can restore only all files saved. That
2190 is there is no way using the catalog to select individual files.
2191 With this new feature, Bacula will ask if you want to specify a Regex
2192 expression for extracting only a part of the full backup.
2195 Building directory tree for JobId(s) 1,3 ...
2196 There were no files inserted into the tree, so file selection
2197 is not possible.Most likely your retention policy pruned the files
2199 Do you want to restore all the files? (yes\vb{}no): no
2201 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2202 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2205 \subsection{Bootstrap File Optimization Changes}
2206 In order to permit proper seeking on disk files, we have extended the bootstrap
2207 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2208 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2209 address range and end address range respectively. These two directives replace
2210 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2211 VolEndBlock} directives. Bootstrap files containing the old directives will
2212 still work, but will not properly take advantage of proper disk seeking, and
2213 may read completely to the end of a disk volume during a restore. With the new
2214 format (automatically generated by the new Director), restores will seek
2215 properly and stop reading the volume when all the files have been restored.
2217 \subsection{Solaris ZFS/NFSv4 ACLs}
2218 This is an upgrade of the previous Solaris ACL backup code
2219 to the new library format, which will backup both the old
2220 POSIX(UFS) ACLs as well as the ZFS ACLs.
2222 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2223 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2224 be used to transfer from UFS to ZFS filesystems.
2227 \subsection{Virtual Tape Emulation}
2228 \index[general]{Virtual Tape Emulation}
2229 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2230 the tape code but actually reading and writing to a disk file. Used with the
2231 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2232 and 700 slots. This feature is most useful in testing. It is enabled
2233 by using {\bf Device Type = vtape} in the Storage daemon's Device
2234 directive. This feature is only implemented on Linux machines and should not be
2235 used for production.
2237 \subsection{Bat Enhancements}
2238 \index[general]{Bat Enhancements}
2239 Bat (the Bacula Administration Tool) GUI program has been significantly
2240 enhanced and stabilized. In particular, there are new table based status
2241 commands; it can now be easily localized using Qt4 Linguist.
2243 The Bat communications protocol has been significantly enhanced to improve
2244 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2245 the Director you are using otherwise the communications protocol will not
2248 \subsection{RunScript Enhancements}
2249 \index[general]{RunScript Enhancements}
2250 The {\bf RunScript} resource has been enhanced to permit multiple
2251 commands per RunScript. Simply specify multiple {\bf Command} directives
2258 Command = "/bin/echo test"
2259 Command = "/bin/echo an other test"
2260 Command = "/bin/echo 3 commands in the same runscript"
2267 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2268 implemented, which runs the command after the Volume Shadow Copy has been made.
2270 Console commands can be specified within a RunScript by using:
2271 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2272 carefully tested and debugged and is known to easily crash the Director.
2273 We would appreciate feedback. Due to the recursive nature of this command, we
2274 may remove it before the final release.
2276 \subsection{Status Enhancements}
2277 \index[general]{Status Enhancements}
2278 The bconsole {\bf status dir} output has been enhanced to indicate
2279 Storage daemon job spooling and despooling activity.
2281 \subsection{Connect Timeout}
2282 \index[general]{Connect Timeout}
2283 The default connect timeout to the File
2284 daemon has been set to 3 minutes. Previously it was 30 minutes.
2286 \subsection{ftruncate for NFS Volumes}
2287 \index[general]{ftruncate for NFS Volumes}
2288 If you write to a Volume mounted by NFS (say on a local file server),
2289 in previous Bacula versions, when the Volume was recycled, it was not
2290 properly truncated because NFS does not implement ftruncate (file
2291 truncate). This is now corrected in the new version because we have
2292 written code (actually a kind user) that deletes and recreates the Volume,
2293 thus accomplishing the same thing as a truncate.
2295 \subsection{Support for Ubuntu}
2296 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2297 version of Linux, and thus now provides correct autostart routines.
2298 Since Ubuntu officially supports Bacula, you can also obtain any
2299 recent release of Bacula from the Ubuntu repositories.
2301 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2302 \index[general]{Recycle Pool}
2303 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2304 be placed (moved) when it is recycled. Without this directive, a Volume will
2305 remain in the same pool when it is recycled. With this directive, it can be
2306 moved automatically to any existing pool during a recycle. This directive is
2307 probably most useful when defined in the Scratch pool, so that volumes will
2308 be recycled back into the Scratch pool.
2310 \subsection{FD Version}
2311 \index[general]{FD Version}
2312 The File daemon to Director protocol now includes a version
2313 number, which although there is no visible change for users,
2314 will help us in future versions automatically determine
2315 if a File daemon is not compatible.
2317 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2318 \index[general]{Max Run Sched Time}
2319 The time specifies the maximum allowed time that a job may run, counted from
2320 when the job was scheduled. This can be useful to prevent jobs from running
2321 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2324 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2325 \index[general]{Max Wait Time}
2326 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2327 of checking the maximum allowed time that a job may block for a resource,
2328 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2329 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2330 their job depending on the level. Now, they have to use
2331 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2332 directives are now deprecated.
2334 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2335 \index[general]{Incremental Max Wait Time}
2336 \index[general]{Differential Max Wait Time}
2338 These directives have been deprecated in favor of
2339 \texttt{Incremental|Differential Max Run Time}.
2341 \subsection{Max Run Time directives}
2342 \index[general]{Max Run Time directives}
2343 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2344 maximum allowed time that a job can run depending on the level.
2346 \addcontentsline{lof}{figure}{Job time control directives}
2347 \includegraphics{\idir different_time.eps}
2349 \subsection{Statistics Enhancements}
2350 \index[general]{Statistics Enhancements}
2351 If you (or probably your boss) want to have statistics on your backups to
2352 provide some \textit{Service Level Agreement} indicators, you could use a few
2353 SQL queries on the Job table to report how many:
2357 \item jobs have been successful
2358 \item files have been backed up
2362 However, these statistics are accurate only if your job retention is greater
2363 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2364 be able to use them.
2366 Now, you can use the \textbf{update stats [days=num]} console command to fill
2367 the JobHistory table with new Job records. If you want to be sure to take in
2368 account only \textbf{good jobs}, ie if one of your important job has failed but
2369 you have fixed the problem and restarted it on time, you probably want to
2370 delete the first \textit{bad} job record and keep only the successful one. For
2371 that simply let your staff do the job, and update JobHistory table after two or
2372 three days depending on your organization using the \textbf{[days=num]} option.
2374 These statistics records aren't used for restoring, but mainly for
2375 capacity planning, billings, etc.
2377 The Bweb interface provides a statistics module that can use this feature. You
2378 can also use tools like Talend or extract information by yourself.
2380 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2381 the length of time that Bacula will keep statistics job records in the Catalog
2382 database after the Job End time. (In \texttt{JobHistory} table) When this time
2383 period expires, and if user runs \texttt{prune stats} command, Bacula will
2384 prune (remove) Job records that are older than the specified period.
2386 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2387 job to maintain statistics.
2390 Name = BackupCatalog
2393 Console = "update stats days=3"
2394 Console = "prune stats yes"
2401 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2402 \index[general]{ScratchPool}
2403 This directive permits to specify a specific \textsl{Scratch} pool for the
2404 current pool. This is useful when using multiple storage sharing the same
2405 mediatype or when you want to dedicate volumes to a particular set of pool.
2407 \subsection{Enhanced Attribute Despooling}
2408 \index[general]{Attribute Despooling}
2409 If the storage daemon and the Director are on the same machine, the spool file
2410 that contains attributes is read directly by the Director instead of being
2411 transmitted across the network. That should reduce load and speedup insertion.
2413 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2414 \index[general]{SpoolSize}
2415 A new Job directive permits to specify the spool size per job. This is used
2416 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2418 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2419 \index[general]{MaximumConsoleConnections}
2420 A new director directive permits to specify the maximum number of Console
2421 Connections that could run concurrently. The default is set to 20, but you may
2422 set it to a larger number.
2424 \subsection{VerId = \lt{}string\gt{}}
2425 \index[general]{VerId}
2426 A new director directive permits to specify a personnal identifier that will be
2427 displayed in the \texttt{version} command.
2429 \subsection{dbcheck enhancements}
2430 \index[general]{dbcheck enhancements}
2431 If you are using Mysql, dbcheck will now ask you if you want to create
2432 temporary indexes to speed up orphaned Path and Filename elimination.
2434 A new \texttt{-B} option allows you to print catalog information in a simple
2435 text based format. This is useful to backup it in a secure way.
2450 You can now specify the database connection port in the command line.
2452 \subsection{{-}{-}docdir configure option}
2453 \index[general]{{-}{-}docdir configure option}
2454 You can use {-}{-}docdir= on the ./configure command to
2455 specify the directory where you want Bacula to install the
2456 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2457 {\bf /usr/share/doc/bacula}.
2459 \subsection{{-}{-}htmldir configure option}
2460 \index[general]{{-}{-}htmldir configure option}
2461 You can use {-}{-}htmldir= on the ./configure command to
2462 specify the directory where you want Bacula to install the bat html help
2463 files. The default is {\bf /usr/share/doc/bacula/html}
2465 \subsection{{-}{-}with-plugindir configure option}
2466 \index[general]{{-}{-}plugindir configure option}
2467 You can use {-}{-}plugindir= on the ./configure command to
2468 specify the directory where you want Bacula to install
2469 the plugins (currently only bpipe-fd). The default is