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 RunScript variables}
55 You can have access to JobBytes and JobFiles using %b and %f in your runscript
59 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%f"
62 \section{Additions to the Plugin API}
63 The bfuncs structure has been extended to include a number of
67 The bFuncs structure defines the callback entry points within Bacula
68 that the plugin can use register events, get Bacula values, set
69 Bacula values, and send messages to the Job output or debug output.
71 The exact definition as of this writing is:
73 typedef struct s_baculaFuncs {
76 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
77 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
78 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
79 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
80 int type, utime_t mtime, const char *fmt, ...);
81 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
82 int level, const char *fmt, ...);
83 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
85 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
87 /* New functions follow */
88 bRC (*AddExclude)(bpContext *ctx, const char *file);
89 bRC (*AddInclude)(bpContext *ctx, const char *file);
90 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
91 bRC (*AddRegexToInclude)(bpContext *ctx, const char *item, int type);
92 bRC (*AddWildToInclude)(bpContext *ctx, const char *item, int type);
98 \item [AddExclude] can be called to exclude a file. The file
99 string passed may include wildcards that will be interpreted by
100 the {\bf fnmatch} subroutine. This function can be called
101 multiple times, and each time the file specified will be added
102 to the list of files to be excluded. Note, this function only
103 permits adding excludes of specific file or directory names,
104 or files matched by the rather simple fnmatch mechanism.
105 See below for information on doing wild-card and regex excludes.
107 \item [NewInclude] can be called to create a new Include block. This
108 block will be added before any user defined Include blocks. This
109 function can be called multiple times, but each time, it will create
110 a new Include section (not normally needed). This function should
111 be called only if you want to add an entirely new Include block.
113 \item [AddInclude] can be called to add new files/directories to
114 be included. They are added to the current Include block. If
115 NewInclude has not been included, the current Include block is
116 the last one that the user created. This function
117 should be used only if you want to add totally new files/directories
118 to be included in the backup.
120 \item [NewOptions] adds a new Options block to the current Include
121 in front of any other Options blocks. This permits the plugin to
122 add exclude directives (wild-cards and regexes) in front of the
123 user Options, and thus prevent certain files from being backed up.
124 This can be useful if the plugin backs up files, and they should
125 not be also backed up by the main Bacula code. This function
126 may be called multiple times, and each time, it creates a new
127 prepended Options block. Note: normally you want to call this
128 entry point prior to calling AddOptions, AddRegex, or AddWild.
130 \item [AddOptions] allows the plugin it set options in
131 the current Options block, which is normally created with the
132 NewOptions call just prior to adding Include Options.
133 The permitted options are passed as a character string, where
134 each character has a specific meaning as defined below:
137 \item [a] always replace files (default).
138 \item [e] exclude rather than include.
139 \item [h] no recursion into subdirectories.
140 \item [H] do not handle hard links.
141 \item [i] ignore case in wildcard and regex matches.
142 \item [M] compute an MD5 sum.
143 \item [p] use a portable data format on Windows (not recommended).
144 \item [R] backup resource forks and Findr Info.
145 \item [r] read from a fifo
146 \item [S1] compute an SHA1 sum.
147 \item [S2] compute an SHA256 sum.
148 \item [S3] comput an SHA512 sum.
149 \item [s] handle sparse files.
150 \item [m] use st\_mtime only for file differences.
151 \item [k] restore the st\_atime after accessing a file.
152 \item [A] enable ACL backup.
153 \item [Vxxx:] specify verify options. Must terminate with :
154 \item [Cxxx:] specify accurate options. Must terminate with :
155 \item [Jxxx:] specify base job Options. Must terminate with :
156 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
158 \item [Zn] specify gzip compression level n.
159 \item [K] do not use st\_atime in backup decision.
160 \item [c] check if file changed during backup.
161 \item [N] honor no dump flag.
162 \item [X] enable backup of extended attributes.
165 \item [AddRegex] adds a regex 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.
173 \item [AddWild] adds a wildcard expression to the current Options block.
174 The fillowing options are permitted:
176 \item [ ] (a blank) regex applies to whole path and filename.
177 \item [F] regex applies only to the filename (directory or path stripped).
178 \item [D] regex applies only to the directory (path) part of the name.
184 \subsection{Bacula events}
185 The list of events has been extended to include:
191 bEventStartBackupJob = 3,
192 bEventEndBackupJob = 4,
193 bEventStartRestoreJob = 5,
194 bEventEndRestoreJob = 6,
195 bEventStartVerifyJob = 7,
196 bEventEndVerifyJob = 8,
197 bEventBackupCommand = 9,
198 bEventRestoreCommand = 10,
203 bEventCancelCommand = 13,
204 bEventVssBackupAddComponents = 14,
205 bEventVssRestoreLoadComponentMetadata = 15,
206 bEventVssRestoreSetComponentsSelected = 16,
207 bEventRestoreObject = 17,
208 bEventEndFileSet = 18
214 \item [bEventCancelCommand] is called whenever the currently
215 running Job is cancelled */
217 \item [bEventVssBackupAddComponents]
222 \chapter{Release Version 5.0.3}
224 There are no new features in version 5.0.2. This version simply fixes a
225 number of bugs found in version 5.0.1 during the onging development
228 \chapter{Release Version 5.0.2}
230 There are no new features in version 5.0.2. This version simply fixes a
231 number of bugs found in version 5.0.1 during the onging development
237 \chapter{New Features in 5.0.1}
239 This chapter presents the new features that are in the released Bacula version
240 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
241 the onging development process.
243 \section{Truncate Volume after Purge}
244 \label{sec:actiononpurge}
246 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
247 the volume when it is purged with the new command \texttt{purge volume
248 action}. It is useful to prevent disk based volumes from consuming too much
254 Action On Purge = Truncate
259 As usual you can also set this property with the \texttt{update volume} command
261 *update volume=xxx ActionOnPurge=Truncate
262 *update volume=xxx actiononpurge=None
265 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
266 following command in interactive mode or in a RunScript as shown after:
268 *purge volume action=truncate storage=File allpools
269 # or by default, action=all
270 *purge volume action storage=File pool=Default
273 This is possible to specify the volume name, the media type, the pool, the
274 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
275 idle when you decide to run this command.
284 Console = "purge volume action=all allpools storage=File"
289 \textbf{Important note}: This feature doesn't work as
290 expected in version 5.0.0. Please do not use it before version 5.0.1.
292 \section{Allow Higher Duplicates}
293 This directive did not work correctly and has been depreciated
294 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
295 file as it will be removed in a future rlease.
297 \section{Cancel Lower Level Duplicates}
298 This directive was added in Bacula version 5.0.1. It compares the
299 level of a new backup job to old jobs of the same name, if any,
300 and will kill the job which has a lower level than the other one.
301 If the levels are the same (i.e. both are Full backups), then
302 nothing is done and the other Cancel XXX Duplicate directives
305 \chapter{New Features in 5.0.0}
307 \section{Maximum Concurent Jobs for Devices}
308 \label{sec:maximumconcurentjobdevice}
310 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
311 Daemon configuration permits setting the maximum number of Jobs that can
312 run concurrently on a specified Device. Using this directive, it is
313 possible to have different Jobs using multiple drives, because when the
314 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
315 Jobs on any other available compatible drive. This facilitates writing to
316 multiple drives with multiple Jobs that all use the same Pool.
318 This project was funded by Bacula Systems.
320 \section{Restore from Multiple Storage Daemons}
321 \index[general]{Restore}
323 Previously, you were able to restore from multiple devices in a single Storage
324 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
325 example, if your full backup runs on a Storage Daemon with an autochanger, and
326 your incremental jobs use another Storage Daemon with lots of disks, Bacula
327 will switch automatically from one Storage Daemon to an other within the same
330 You must upgrade your File Daemon to version 3.1.3 or greater to use this
333 This project was funded by Bacula Systems with the help of Equiinet.
335 \section{File Deduplication using Base Jobs}
336 A base job is sort of like a Full save except that you will want the FileSet to
337 contain only files that are unlikely to change in the future (i.e. a snapshot
338 of most of your system after installing it). After the base job has been run,
339 when you are doing a Full save, you specify one or more Base jobs to be used.
340 All files that have been backed up in the Base job/jobs but not modified will
341 then be excluded from the backup. During a restore, the Base jobs will be
342 automatically pulled in where necessary.
344 This is something none of the competition does, as far as we know (except
345 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
346 win for the user, it makes Bacula stand out as offering a unique optimization
347 that immediately saves time and money. Basically, imagine that you have 100
348 nearly identical Windows or Linux machine containing the OS and user files.
349 Now for the OS part, a Base job will be backed up once, and rather than making
350 100 copies of the OS, there will be only one. If one or more of the systems
351 have some files updated, no problem, they will be automatically restored.
353 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
354 files that will be used during Full backup as base.
365 Base = BackupZog4, BackupLinux
371 In this example, the job \texttt{BackupZog4} will use the most recent version
372 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
373 jobs. Base jobs should have run with \texttt{level=Base} to be used.
375 By default, Bacula will compare permissions bits, user and group fields,
376 modification time, size and the checksum of the file to choose between the
377 current backup and the BaseJob file list. You can change this behavior with the
378 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
379 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
395 \textbf{Important note}: The current implementation doesn't permit to scan
396 volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
398 This project was funded by Bacula Systems.
400 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
401 \index[dir]{AllowCompression}
403 This new directive may be added to Storage resource within the Director's
404 configuration to allow users to selectively disable the client compression for
405 any job which writes to this storage resource.
411 Address = ultrium-tape
412 Password = storage_password # Password for Storage Daemon
415 AllowCompression = No # Tape drive has hardware compression
418 The above example would cause any jobs running with the UltriumTape storage
419 resource to run without compression from the client file daemons. This
420 effectively overrides any compression settings defined at the FileSet level.
422 This feature is probably most useful if you have a tape drive which supports
423 hardware compression. By setting the \texttt{AllowCompression = No} directive
424 for your tape drive storage resource, you can avoid additional load on the file
425 daemon and possibly speed up tape backups.
427 This project was funded by Collaborative Fusion, Inc.
429 \section{Accurate Fileset Options}
430 \label{sec:accuratefileset}
432 In previous versions, the accurate code used the file creation and modification
433 times to determine if a file was modified or not. Now you can specify which
434 attributes to use (time, size, checksum, permission, owner, group, \dots),
435 similar to the Verify options.
451 \item {\bf i} compare the inodes
452 \item {\bf p} compare the permission bits
453 \item {\bf n} compare the number of links
454 \item {\bf u} compare the user id
455 \item {\bf g} compare the group id
456 \item {\bf s} compare the size
457 \item {\bf a} compare the access time
458 \item {\bf m} compare the modification time (st\_mtime)
459 \item {\bf c} compare the change time (st\_ctime)
460 \item {\bf d} report file size decreases
461 \item {\bf 5} compare the MD5 signature
462 \item {\bf 1} compare the SHA1 signature
465 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
466 the File Daemon will have to read all files even if they normally would not
467 be saved. This increases the I/O load, but also the accuracy of the
468 deduplication. By default, Bacula will check modification/creation time
471 This project was funded by Bacula Systems.
473 \section{Tab-completion for Bconsole}
474 \label{sec:tabcompletion}
476 If you build \texttt{bconsole} with readline support, you will be able to use
477 the new auto-completion mode. This mode supports all commands, gives help
478 inside command, and lists resources when required. It works also in the restore
481 To use this feature, you should have readline development package loaded on
482 your system, and use the following option in configure.
484 ./configure --with-readline=/usr/include/readline --disable-conio ...
487 The new bconsole won't be able to tab-complete with older directors.
489 This project was funded by Bacula Systems.
491 \section{Pool File and Job Retention}
492 \label{sec:poolfilejobretention}
494 We added two new Pool directives, \texttt{FileRetention} and
495 \texttt{JobRetention}, that take precedence over Client directives of the same
496 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
497 example, you can decide to increase Retention times for Archive or OffSite Pool.
499 It seems obvious to us, but apparently not to some users, that given the
500 definition above that the Pool File and Job Retention periods is a global
501 override for the normal Client based prunning, which means that when the
502 Job is prunned, the prunning will apply globally to that particular Job.
504 Currently, there is a bug in the implementation that causes any Pool
505 retention periods specified to apply to {\bf all} Pools for that
506 particular Client. Thus we suggest that you avoid using these two
507 directives until this implementation problem is corrected.
509 \section{Read-only File Daemon using capabilities}
510 \label{sec:fdreadonly}
511 This feature implements support of keeping \textbf{ReadAll} capabilities after
512 UID/GID switch, this allows FD to keep root read but drop write permission.
514 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
515 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
518 root@localhost:~# bacula-fd -k -u nobody -g nobody
521 The code for this feature was contributed by our friends at AltLinux.
526 To help developers of restore GUI interfaces, we have added new \textsl{dot
527 commands} that permit browsing the catalog in a very simple way.
530 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
531 the Bvfs cache in the catalog. You need to run it before any access to the
534 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
535 will list all directories in the specified \texttt{path} or
536 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
537 encoding of path/filenames.
539 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
540 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
541 \texttt{pathid} avoids problems with character encoding.
544 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
545 data that will be displayed.
548 * .bvfs_update jobid=1,2
550 * .bvfs_lsdir path=/ jobid=1,2
553 This project was funded by Bacula Systems.
555 \section{Testing your Tape Drive}
556 \label{sec:btapespeed}
558 To determine the best configuration of your tape drive, you can run the new
559 \texttt{speed} command available in the \texttt{btape} program.
561 This command can have the following arguments:
563 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
564 (between 1 and 5GB). This counter is in GB.
565 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
566 of data should be greater than your memory ($file\_size*nb\_file$).
567 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
569 \item[\texttt{skip\_random}] This flag permits to skip tests with random
571 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
572 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
577 *speed file_size=3 skip_raw
578 btape.c:1078 Test with zero data and bacula block structure.
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 = 44.128 MB/s
584 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
586 btape.c:1090 Test with random data, should give the minimum throughput.
587 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
588 +++++++++++++++++++++++++++++++++++++++++++
589 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
590 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
591 +++++++++++++++++++++++++++++++++++++++++++
593 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
597 When using compression, the random test will give your the minimum throughput
598 of your drive . The test using constant string will give you the maximum speed
599 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
601 You can change the block size in the Storage Daemon configuration file.
603 \section{New {\bf Block Checksum} Device Directive}
604 You may now turn off the Block Checksum (CRC32) code
605 that Bacula uses when writing blocks to a Volume. This is
612 doing so can reduce the Storage daemon CPU usage slightly. It
613 will also permit Bacula to read a Volume that has corrupted data.
615 The default is {\bf yes} -- i.e. the checksum is computed on write
618 We do not recommend to turn this off particularly on older tape
619 drives or for disk Volumes where doing so may allow corrupted data
622 \section{New Bat Features}
624 Those new features were funded by Bacula Systems.
626 \subsection{Media List View}
628 By clicking on ``Media'', you can see the list of all your volumes. You will be
629 able to filter by Pool, Media Type, Location,\dots And sort the result directly
630 in the table. The old ``Media'' view is now known as ``Pool''.
633 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
634 \label{fig:mediaview}
638 \subsection{Media Information View}
640 By double-clicking on a volume (on the Media list, in the Autochanger content
641 or in the Job information panel), you can access a detailed overview of your
642 Volume. (cf \ref{fig:mediainfo}.)
645 \includegraphics[width=13cm]{\idir bat11.eps}
646 \caption{Media information}
647 \label{fig:mediainfo}
650 \subsection{Job Information View}
652 By double-clicking on a Job record (on the Job run list or in the Media
653 information panel), you can access a detailed overview of your Job. (cf
657 \includegraphics[width=13cm]{\idir bat12.eps}
658 \caption{Job information}
662 \subsection{Autochanger Content View}
664 By double-clicking on a Storage record (on the Storage list panel), you can
665 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
668 \includegraphics[width=13cm]{\idir bat13.eps}
669 \caption{Autochanger content}
670 \label{fig:achcontent}
673 To use this feature, you need to use the latest mtx-changer script
674 version. (With new \texttt{listall} and \texttt{transfer} commands)
676 \section{Bat on Windows}
677 We have ported {\bf bat} to Windows and it is now installed
678 by default when the installer is run. It works quite well
679 on Win32, but has not had a lot of testing there, so your
680 feedback would be welcome. Unfortunately, eventhough it is
681 installed by default, it does not yet work on 64 bit Windows
684 \section{New Win32 Installer}
685 The Win32 installer has been modified in several very important
688 \item You must deinstall any current version of the
689 Win32 File daemon before upgrading to the new one.
690 If you forget to do so, the new installation will fail.
691 To correct this failure, you must manually shutdown
692 and deinstall the old File daemon.
693 \item All files (other than menu links) are installed
694 in {\bf c:/Program Files/Bacula}.
695 \item The installer no longer sets this
696 file to require administrator privileges by default. If you want
697 to do so, please do it manually using the {\bf cacls} program.
700 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
702 \item The server daemons (Director and Storage daemon) are
703 no longer included in the Windows installer. If you want the
704 Windows servers, you will either need to build them yourself (note
705 they have not been ported to 64 bits), or you can contact
706 Bacula Systems about this.
709 \section{Win64 Installer}
710 We have corrected a number of problems that required manual
711 editing of the conf files. In most cases, it should now
712 install and work. {\bf bat} is by default installed in
713 {\bf c:/Program Files/Bacula/bin32} rather than
714 {\bf c:/Program Files/Bacula} as is the case with the 32
715 bit Windows installer.
717 \section{Linux Bare Metal Recovery USB Key}
718 We have made a number of significant improvements in the
719 Bare Metal Recovery USB key. Please see the README files
720 it the {\bf rescue} release for more details.
722 We are working on an equivalent USB key for Windows bare
723 metal recovery, but it will take some time to develop it (best
724 estimate 3Q2010 or 4Q2010)
727 \section{bconsole Timeout Option}
728 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
729 for commands. This is useful with GUI programs that use {\bf bconsole}
730 to interface to the Director.
732 \section{Important Changes}
733 \label{sec:importantchanges}
736 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
737 to the same Pool. The Storage daemon ensures that you do not read and
738 write to the same Volume.
739 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
741 \item Virtually all the features of {\bf mtx-changer} have
742 now been parameterized, which allows you to configure
743 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
744 that contains variables that you can set to configure mtx-changer.
745 This configuration file will not be overwritten during upgrades.
746 We encourage you to submit any changes
747 that are made to mtx-changer and to parameterize it all in
748 mtx-changer.conf so that all configuration will be done by
749 changing only mtx-changer.conf.
750 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
751 and \texttt{transfer}. Please configure them as appropriate
753 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
754 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
755 password. If you want to use the new script, you will need to
756 manually change the \texttt{BackupCatalog} Job definition.
757 \item The \texttt{bconsole} \texttt{help} command now accepts
758 an argument, which if provided produces information on that
759 command (ex: \texttt{help run}).
763 \subsubsection*{Truncate volume after purge}
765 Note that the Truncate Volume after purge feature doesn't work as expected
766 in 5.0.0 version. Please, don't use it before version 5.0.1.
768 \subsection{Custom Catalog queries}
770 If you wish to add specialized commands that list the contents of the catalog,
771 you can do so by adding them to the \texttt{query.sql} file. This
772 \texttt{query.sql} file is now empty by default. The file
773 \texttt{examples/sample-query.sql} has an a number of sample commands
774 you might find useful.
776 \subsection{Deprecated parts}
778 The following items have been \textbf{deprecated} for a long time, and are now
779 removed from the code.
782 \item Support for SQLite 2
785 \section{Misc Changes}
786 \label{sec:miscchanges}
789 \item Updated Nagios check\_bacula
790 \item Updated man files
791 \item Added OSX package generation script in platforms/darwin
792 \item Added Spanish and Ukrainian Bacula translations
793 \item Enable/disable command shows only Jobs that can change
794 \item Added \texttt{show disabled} command to show disabled Jobs
795 \item Many ACL improvements
796 \item Added Level to FD status Job output
797 \item Begin Ingres DB driver (not yet working)
798 \item Split RedHat spec files into bacula, bat, mtx, and docs
799 \item Reorganized the manuals (fewer separate manuals)
800 \item Added lock/unlock order protection in lock manager
801 \item Allow 64 bit sizes for a number of variables
802 \item Fixed several deadlocks or potential race conditions in the SD
805 \chapter{Released Version 3.0.3 and 3.0.3a}
807 There are no new features in version 3.0.3. This version simply fixes a
808 number of bugs found in version 3.0.2 during the onging development
811 \chapter{New Features in Released Version 3.0.2}
813 This chapter presents the new features added to the
814 Released Bacula Version 3.0.2.
816 \section{Full Restore from a Given JobId}
817 \index[general]{Restore menu}
819 This feature allows selecting a single JobId and having Bacula
820 automatically select all the other jobs that comprise a full backup up to
821 and including the selected date (through JobId).
823 Assume we start with the following jobs:
825 +-------+--------------+---------------------+-------+----------+------------+
826 | jobid | client | starttime | level | jobfiles | jobbytes |
827 +-------+--------------+---------------------+-------+----------+------------
828 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
829 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
830 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
831 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
832 +-------+--------------+---------------------+-------+----------+------------+
835 Below is an example of this new feature (which is number 12 in the
840 To select the JobIds, you have the following choices:
841 1: List last 20 Jobs run
842 2: List Jobs where a given File is saved
844 12: Select full restore to a specified Job date
847 Select item: (1-13): 12
848 Enter JobId to get the state to restore: 5
849 Selecting jobs to build the Full state at 2009-07-15 11:45:45
850 You have selected the following JobIds: 1,3,5
852 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
853 1,444 files inserted into the tree.
856 This project was funded by Bacula Systems.
858 \section{Source Address}
859 \index[general]{Source Address}
861 A feature has been added which allows the administrator to specify the address
862 from which the Director and File daemons will establish connections. This
863 may be used to simplify system configuration overhead when working in complex
864 networks utilizing multi-homing and policy-routing.
866 To accomplish this, two new configuration directives have been implemented:
869 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
873 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
877 Simply adding specific host routes on the OS
878 would have an undesirable side-effect: any
879 application trying to contact the destination host would be forced to use the
880 more specific route possibly diverting management traffic onto a backup VLAN.
881 Instead of adding host routes for each client connected to a multi-homed backup
882 server (for example where there are management and backup VLANs), one can
883 use the new directives to specify a specific source address at the application
886 Additionally, this allows the simplification and abstraction of firewall rules
887 when dealing with a Hot-Standby director or storage daemon configuration. The
888 Hot-standby pair may share a CARP address, which connections must be sourced
889 from, while system services listen and act from the unique interface addresses.
891 This project was funded by Collaborative Fusion, Inc.
893 \section{Show volume availability when doing restore}
895 When doing a restore the selection dialog ends by displaying this
899 The job will require the following
900 Volume(s) Storage(s) SD Device(s)
901 ===========================================================================
912 Volumes marked with ``*'' are online (in the autochanger).
915 This should help speed up large restores by minimizing the time spent
916 waiting for the operator to discover that he must change tapes in the library.
918 This project was funded by Bacula Systems.
920 \section{Accurate estimate command}
922 The \texttt{estimate} command can now use the accurate code to detect changes
923 and give a better estimation.
925 You can set the accurate behavior on the command line by using
926 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
929 * estimate listing accurate=yes level=incremental job=BackupJob
932 This project was funded by Bacula Systems.
934 \chapter{New Features in 3.0.0}
935 \label{NewFeaturesChapter}
936 \index[general]{New Features}
938 This chapter presents the new features added to the development 2.5.x
939 versions to be released as Bacula version 3.0.0 sometime in April 2009.
941 \section{Accurate Backup}
942 \index[general]{Accurate Backup}
944 As with most other backup programs, by default Bacula decides what files to
945 backup for Incremental and Differental backup by comparing the change
946 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
947 backup completed. If one of those two times is later than the last backup
948 time, then the file will be backed up. This does not, however, permit tracking
949 what files have been deleted and will miss any file with an old time that may
950 have been restored to or moved onto the client filesystem.
952 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
953 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
954 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
955 backup, there is no difference, but for {\bf Differential} and {\bf
956 Incremental} backups, the Director will send a list of all previous files
957 backed up, and the File daemon will use that list to determine if any new files
958 have been added or or moved and if any files have been deleted. This allows
959 Bacula to make an accurate backup of your system to that point in time so that
960 if you do a restore, it will restore your system exactly.
963 about using Accurate backup is that it requires more resources (CPU and memory)
964 on both the Director and the Client machines to create the list of previous
965 files backed up, to send that list to the File daemon, for the File daemon to
966 keep the list (possibly very big) in memory, and for the File daemon to do
967 comparisons between every file in the FileSet and the list. In particular,
968 if your client has lots of files (more than a few million), you will need
969 lots of memory on the client machine.
971 Accurate must not be enabled when backing up with a plugin that is not
972 specially designed to work with Accurate. If you enable it, your restores
973 will probably not work correctly.
975 This project was funded by Bacula Systems.
980 \index[general]{Copy Jobs}
982 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
983 existing Migration feature with the exception that the Job that is copied is
984 left unchanged. This essentially creates two identical copies of the same
985 backup. However, the copy is treated as a copy rather than a backup job, and
986 hence is not directly available for restore. The {\bf restore} command lists
987 copy jobs and allows selection of copies by using \texttt{jobid=}
988 option. If the keyword {\bf copies} is present on the command line, Bacula will
989 display the list of all copies for selected jobs.
994 These JobIds have copies as follows:
995 +-------+------------------------------------+-----------+------------------+
996 | JobId | Job | CopyJobId | MediaType |
997 +-------+------------------------------------+-----------+------------------+
998 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
999 +-------+------------------------------------+-----------+------------------+
1000 +-------+-------+----------+----------+---------------------+------------------+
1001 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1002 +-------+-------+----------+----------+---------------------+------------------+
1003 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1004 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1005 +-------+-------+----------+----------+---------------------+------------------+
1006 You have selected the following JobIds: 19,2
1008 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1009 5,611 files inserted into the tree.
1014 The Copy Job runs without using the File daemon by copying the data from the
1015 old backup Volume to a different Volume in a different Pool. See the Migration
1016 documentation for additional details. For copy Jobs there is a new selection
1017 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1018 not already copied to another Pool.
1020 As with Migration, the Client, Volume, Job, or SQL query, are
1021 other possible ways of selecting the Jobs to be copied. Selection
1022 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1023 work, but are probably more suited for Migration Jobs.
1025 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1026 it will promote the Copy to a \textsl{real} backup job and will make it available for
1027 automatic restore. If more than one Copy is available, it will promote the copy
1028 with the smallest JobId.
1030 A nice solution which can be built with the new Copy feature is often
1031 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1032 look something like the one below:
1036 Name = FullBackupsVirtualPool
1038 Purge Oldest Volume = Yes
1040 NextPool = FullBackupsTapePool
1044 Name = FullBackupsTapePool
1048 Volume Retention = 365 days
1049 Storage = superloader
1053 # Fake fileset for copy jobs
1065 # Fake client for copy jobs
1075 # Default template for a CopyDiskToTape Job
1078 Name = CopyDiskToTape
1080 Messages = StandardCopy
1083 Selection Type = PoolUncopiedJobs
1084 Maximum Concurrent Jobs = 10
1086 Allow Duplicate Jobs = Yes
1087 Cancel Queued Duplicates = No
1088 Cancel Running Duplicates = No
1093 Name = DaySchedule7:00
1094 Run = Level=Full daily at 7:00
1098 Name = CopyDiskToTapeFullBackups
1100 Schedule = DaySchedule7:00
1101 Pool = FullBackupsVirtualPool
1102 JobDefs = CopyDiskToTape
1106 The example above had 2 pool which are copied using the PoolUncopiedJobs
1107 selection criteria. Normal Full backups go to the Virtual pool and are copied
1108 to the Tape pool the next morning.
1110 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1115 +-------+------------------------------------+-----------+------------------+
1116 | JobId | Job | CopyJobId | MediaType |
1117 +-------+------------------------------------+-----------+------------------+
1118 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1119 +-------+------------------------------------+-----------+------------------+
1122 \section{ACL Updates}
1123 \index[general]{ACL Updates}
1124 The whole ACL code had been overhauled and in this version each platforms has
1125 different streams for each type of acl available on such an platform. As ACLs
1126 between platforms tend to be not that portable (most implement POSIX acls but
1127 some use an other draft or a completely different format) we currently only
1128 allow certain platform specific ACL streams to be decoded and restored on the
1129 same platform that they were created on. The old code allowed to restore ACL
1130 cross platform but the comments already mention that not being to wise. For
1131 backward compatability the new code will accept the two old ACL streams and
1132 handle those with the platform specific handler. But for all new backups it
1133 will save the ACLs using the new streams.
1135 Currently the following platforms support ACLs:
1139 \item {\bf Darwin/OSX}
1148 Currently we support the following ACL types (these ACL streams use a reserved
1149 part of the stream numbers):
1152 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1154 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1155 string representation from acl\_to\_text (POSIX acl)
1156 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1157 string representation from acl\_to\_text (POSIX acl) for default acls.
1158 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1159 string representation from acl\_to\_text (POSIX acl) for access acls.
1160 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1161 string representation from acltostr (POSIX acl)
1162 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1163 representation from acl\_to\_text (POSIX acl) for default acls.
1164 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1165 representation from acl\_to\_text (POSIX acl) for access acls.
1166 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1167 string representation from acl\_to\_text (POSIX acl) for default acls.
1168 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1169 representation from acl\_to\_text (POSIX acl) for access acls.
1170 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1171 string representation from acl\_to\_text (POSIX acl) for default acls.
1172 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1173 string representation from acl\_to\_text (POSIX acl) for default acls.
1174 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1175 representation from acl\_to\_text (POSIX acl) for access acls.
1176 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1177 string representation from acltotext or acl\_totext (POSIX acl)
1178 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1179 representation from from acl\_totext (NFSv4 or ZFS acl)
1182 In future versions we might support conversion functions from one type of acl
1183 into an other for types that are either the same or easily convertable. For now
1184 the streams are seperate and restoring them on a platform that doesn't
1185 recognize them will give you a warning.
1187 \section{Extended Attributes}
1188 \index[general]{Extended Attributes}
1189 Something that was on the project list for some time is now implemented for
1190 platforms that support a similar kind of interface. Its the support for backup
1191 and restore of so called extended attributes. As extended attributes are so
1192 platform specific these attributes are saved in seperate streams for each
1193 platform. Restores of the extended attributes can only be performed on the
1194 same platform the backup was done. There is support for all types of extended
1195 attributes, but restoring from one type of filesystem onto an other type of
1196 filesystem on the same platform may lead to supprises. As extended attributes
1197 can contain any type of data they are stored as a series of so called
1198 value-pairs. This data must be seen as mostly binary and is stored as such.
1199 As security labels from selinux are also extended attributes this option also
1200 stores those labels and no specific code is enabled for handling selinux
1203 Currently the following platforms support extended attributes:
1205 \item {\bf Darwin/OSX}
1211 On linux acls are also extended attributes, as such when you enable ACLs on a
1212 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1213 and not the same exteneded attribute.
1215 To enable the backup of extended attributes please add the following to your
1230 \section{Shared objects}
1231 \index[general]{Shared objects}
1232 A default build of Bacula will now create the libraries as shared objects
1233 (.so) rather than static libraries as was previously the case.
1234 The shared libraries are built using {\bf libtool} so it should be quite
1237 An important advantage of using shared objects is that on a machine with the
1238 Directory, File daemon, the Storage daemon, and a console, you will have only
1239 one copy of the code in memory rather than four copies. Also the total size of
1240 the binary release is smaller since the library code appears only once rather
1241 than once for every program that uses it; this results in significant reduction
1242 in the size of the binaries particularly for the utility tools.
1244 In order for the system loader to find the shared objects when loading the
1245 Bacula binaries, the Bacula shared objects must either be in a shared object
1246 directory known to the loader (typically /usr/lib) or they must be in the
1247 directory that may be specified on the {\bf ./configure} line using the {\bf
1248 {-}{-}libdir} option as:
1251 ./configure --libdir=/full-path/dir
1254 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1255 no need to modify your loader configuration provided that
1256 the shared objects are installed in that directory (Bacula
1257 does this with the make install command). The shared objects
1258 that Bacula references are:
1267 These files are symbolically linked to the real shared object file,
1268 which has a version number to permit running multiple versions of
1269 the libraries if desired (not normally the case).
1271 If you have problems with libtool or you wish to use the old
1272 way of building static libraries, or you want to build a static
1273 version of Bacula you may disable
1274 libtool on the configure command line with:
1277 ./configure --disable-libtool
1281 \section{Building Static versions of Bacula}
1282 \index[general]{Static linking}
1283 In order to build static versions of Bacula, in addition
1284 to configuration options that were needed you now must
1285 also add --disable-libtool. Example
1288 ./configure --enable-static-client-only --disable-libtool
1292 \section{Virtual Backup (Vbackup)}
1293 \index[general]{Virtual Backup}
1294 \index[general]{Vbackup}
1296 Bacula's virtual backup feature is often called Synthetic Backup or
1297 Consolidation in other backup products. It permits you to consolidate the
1298 previous Full backup plus the most recent Differential backup and any
1299 subsequent Incremental backups into a new Full backup. This new Full
1300 backup will then be considered as the most recent Full for any future
1301 Incremental or Differential backups. The VirtualFull backup is
1302 accomplished without contacting the client by reading the previous backup
1303 data and writing it to a volume in a different pool.
1305 In some respects the Vbackup feature works similar to a Migration job, in
1306 that Bacula normally reads the data from the pool specified in the
1307 Job resource, and writes it to the {\bf Next Pool} specified in the
1308 Job resource. Note, this means that usually the output from the Virtual
1309 Backup is written into a different pool from where your prior backups
1310 are saved. Doing it this way guarantees that you will not get a deadlock
1311 situation attempting to read and write to the same volume in the Storage
1312 daemon. If you then want to do subsequent backups, you may need to
1313 move the Virtual Full Volume back to your normal backup pool.
1314 Alternatively, you can set your {\bf Next Pool} to point to the current
1315 pool. This will cause Bacula to read and write to Volumes in the
1316 current pool. In general, this will work, because Bacula will
1317 not allow reading and writing on the same Volume. In any case, once
1318 a VirtualFull has been created, and a restore is done involving the
1319 most current Full, it will read the Volume or Volumes by the VirtualFull
1320 regardless of in which Pool the Volume is found.
1322 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1323 a level of {\bf VirtualFull}.
1325 A typical Job resource definition might look like the following:
1332 FileSet = "Full Set"
1339 # Default pool definition
1343 Recycle = yes # Automatically recycle Volumes
1344 AutoPrune = yes # Prune expired volumes
1345 Volume Retention = 365d # one year
1353 Recycle = yes # Automatically recycle Volumes
1354 AutoPrune = yes # Prune expired volumes
1355 Volume Retention = 365d # one year
1356 Storage = DiskChanger
1359 # Definition of file storage device
1364 Device = FileStorage
1366 Maximum Concurrent Jobs = 5
1369 # Definition of DDS Virtual tape disk storage device
1372 Address = localhost # N.B. Use a fully qualified name here
1374 Device = DiskChanger
1375 Media Type = DiskChangerMedia
1376 Maximum Concurrent Jobs = 4
1381 Then in bconsole or via a Run schedule, you would run the job as:
1384 run job=MyBackup level=Full
1385 run job=MyBackup level=Incremental
1386 run job=MyBackup level=Differential
1387 run job=MyBackup level=Incremental
1388 run job=MyBackup level=Incremental
1391 So providing there were changes between each of those jobs, you would end up
1392 with a Full backup, a Differential, which includes the first Incremental
1393 backup, then two Incremental backups. All the above jobs would be written to
1394 the {\bf Default} pool.
1396 To consolidate those backups into a new Full backup, you would run the
1400 run job=MyBackup level=VirtualFull
1403 And it would produce a new Full backup without using the client, and the output
1404 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1406 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1409 Note, the Start and End time of the Virtual Full backup is set to the
1410 values for the last job included in the Virtual Full (in the above example,
1411 it is an Increment). This is so that if another incremental is done, which
1412 will be based on the Virtual Full, it will backup all files from the
1413 last Job included in the Virtual Full rather than from the time the Virtual
1414 Full was actually run.
1418 \section{Catalog Format}
1419 \index[general]{Catalog Format}
1420 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1421 operation will convert the FileId field of the File table from 32 bits (max 4
1422 billion table entries) to 64 bits (very large number of items). The
1423 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1424 your catalog during the conversion. Also you won't be able to run jobs during
1425 this conversion period. For example, a 3 million file catalog will take 2
1426 minutes to upgrade on a normal machine. Please don't forget to make a valid
1427 backup of your database before executing the upgrade script. See the
1428 ReleaseNotes for additional details.
1430 \section{64 bit Windows Client}
1431 \index[general]{Win64 Client}
1432 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1433 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1434 As a consequence, we are also releasing a 64 bit version of the Bacula
1435 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1436 These binaries should only be installed on 64 bit Windows operating systems.
1437 What is important is not your hardware but whether or not you have
1438 a 64 bit version of the Windows OS.
1440 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1442 \item Before installing the Win64 Bacula Client, you must totally
1443 deinstall any prior 2.4.x Client installation using the
1444 Bacula deinstallation (see the menu item). You may want
1445 to save your .conf files first.
1446 \item Only the Client (File daemon) is ported to Win64, the Director
1447 and the Storage daemon are not in the 64 bit Windows installer.
1448 \item bwx-console is not yet ported.
1449 \item bconsole is ported but it has not been tested.
1450 \item The documentation is not included in the installer.
1451 \item Due to Vista security restrictions imposed on a default installation
1452 of Vista, before upgrading the Client, you must manually stop
1453 any prior version of Bacula from running, otherwise the install
1455 \item Due to Vista security restrictions imposed on a default installation
1456 of Vista, attempting to edit the conf files via the menu items
1457 will fail. You must directly edit the files with appropriate
1458 permissions. Generally double clicking on the appropriate .conf
1459 file will work providing you have sufficient permissions.
1460 \item All Bacula files are now installed in
1461 {\bf C:/Program Files/Bacula} except the main menu items,
1462 which are installed as before. This vastly simplifies the installation.
1463 \item If you are running on a foreign language version of Windows, most
1464 likely {\bf C:/Program Files} does not exist, so you should use the
1465 Custom installation and enter an appropriate location to install
1467 \item The 3.0.0 Win32 Client continues to install files in the locations used
1468 by prior versions. For the next version we will convert it to use
1469 the same installation conventions as the Win64 version.
1472 This project was funded by Bacula Systems.
1475 \section{Duplicate Job Control}
1476 \index[general]{Duplicate Jobs}
1477 The new version of Bacula provides four new directives that
1478 give additional control over what Bacula does if duplicate jobs
1479 are started. A duplicate job in the sense we use it here means
1480 a second or subsequent job with the same name starts. This
1481 happens most frequently when the first job runs longer than expected because no
1482 tapes are available.
1484 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1485 are specified in the Job resource.
1489 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1490 \index[general]{Allow Duplicate Jobs}
1491 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1492 the directive is set to {\bf no} (default) then only one job of a given name
1493 may run at one time, and the action that Bacula takes to ensure only
1494 one job runs is determined by the other directives (see below).
1496 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1497 are present and none of the three directives given below permit
1498 cancelling a job, then the current job (the second one started)
1501 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1502 \index[general]{Allow Higher Duplicates}
1503 This directive was in version 5.0.0, but does not work as
1504 expected. If used, it should always be set to no. In later versions
1505 of Bacula the directive is disabled (disregarded).
1507 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1508 \index[general]{Cancel Running Duplicates}
1509 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1510 if this directive is set to {\bf yes} any job that is already running
1511 will be canceled. The default is {\bf no}.
1513 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1514 \index[general]{Cancel Queued Duplicates}
1515 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1516 if this directive is set to {\bf yes} any job that is
1517 already queued to run but not yet running will be canceled.
1518 The default is {\bf no}.
1521 \section{TLS Authentication}
1522 \index[general]{TLS Authentication}
1523 In Bacula version 2.5.x and later, in addition to the normal Bacula
1524 CRAM-MD5 authentication that is used to authenticate each Bacula
1525 connection, you can specify that you want TLS Authentication as well,
1526 which will provide more secure authentication.
1528 This new feature uses Bacula's existing TLS code (normally used for
1529 communications encryption) to do authentication. To use it, you must
1530 specify all the TLS directives normally used to enable communications
1531 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1534 \subsection{TLS Authenticate = yes}
1536 TLS Authenticate = yes
1539 in the main daemon configuration resource (Director for the Director,
1540 Client for the File daemon, and Storage for the Storage daemon).
1542 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1543 authentication, Bacula will also do TLS authentication, then TLS
1544 encryption will be turned off, and the rest of the communication between
1545 the two Bacula daemons will be done without encryption.
1547 If you want to encrypt communications data, use the normal TLS directives
1548 but do not turn on {\bf TLS Authenticate}.
1550 \section{bextract non-portable Win32 data}
1551 \index[general]{bextract handles Win32 non-portable data}
1552 {\bf bextract} has been enhanced to be able to restore
1553 non-portable Win32 data to any OS. Previous versions were
1554 unable to restore non-portable Win32 data to machines that
1555 did not have the Win32 BackupRead and BackupWrite API calls.
1557 \section{State File updated at Job Termination}
1558 \index[general]{State File}
1559 In previous versions of Bacula, the state file, which provides a
1560 summary of previous jobs run in the {\bf status} command output was
1561 updated only when Bacula terminated, thus if the daemon crashed, the
1562 state file might not contain all the run data. This version of
1563 the Bacula daemons updates the state file on each job termination.
1565 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1566 \index[general]{MaxFullInterval}
1567 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1568 can be used to specify the maximum time interval between {\bf Full} backup
1569 jobs. When a job starts, if the time since the last Full backup is
1570 greater than the specified interval, and the job would normally be an
1571 {\bf Incremental} or {\bf Differential}, it will be automatically
1572 upgraded to a {\bf Full} backup.
1574 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1575 \index[general]{MaxDiffInterval}
1576 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1577 can be used to specify the maximum time interval between {\bf Differential} backup
1578 jobs. When a job starts, if the time since the last Differential backup is
1579 greater than the specified interval, and the job would normally be an
1580 {\bf Incremental}, it will be automatically
1581 upgraded to a {\bf Differential} backup.
1583 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1584 \index[general]{MaxDiffInterval}
1585 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1586 by the user, and when it is set it is an indication to backup programs
1587 to not backup that particular file. This version of Bacula contains a
1588 new Options directive within a FileSet resource, which instructs Bacula to
1589 obey this flag. The new directive is:
1592 Honor No Dump Flag = yes\vb{}no
1595 The default value is {\bf no}.
1598 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1599 \index[general]{IgnoreDir}
1600 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1601 can be added to the Include section of the FileSet resource. If the specified
1602 filename ({\bf filename-string}) is found on the Client in any directory to be
1603 backed up, the whole directory will be ignored (not backed up). For example:
1606 # List of files to be backed up
1614 Exclude Dir Containing = .excludeme
1619 But in /home, there may be hundreds of directories of users and some
1620 people want to indicate that they don't want to have certain
1621 directories backed up. For example, with the above FileSet, if
1622 the user or sysadmin creates a file named {\bf .excludeme} in
1623 specific directories, such as
1626 /home/user/www/cache/.excludeme
1627 /home/user/temp/.excludeme
1630 then Bacula will not backup the two directories named:
1633 /home/user/www/cache
1637 NOTE: subdirectories will not be backed up. That is, the directive
1638 applies to the two directories in question and any children (be they
1639 files, directories, etc).
1642 \section{Bacula Plugins}
1643 \index[general]{Plugin}
1644 Support for shared object plugins has been implemented in the Linux, Unix
1645 and Win32 File daemons. The API will be documented separately in
1646 the Developer's Guide or in a new document. For the moment, there is
1647 a single plugin named {\bf bpipe} that allows an external program to
1648 get control to backup and restore a file.
1650 Plugins are also planned (partially implemented) in the Director and the
1653 \subsection{Plugin Directory}
1654 \index[general]{Plugin Directory}
1655 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1656 be added to the daemon definition resource. The directory takes a quoted
1657 string argument, which is the name of the directory in which the daemon can
1658 find the Bacula plugins. If this directive is not specified, Bacula will not
1659 load any plugins. Since each plugin has a distinctive name, all the daemons
1660 can share the same plugin directory.
1662 \subsection{Plugin Options}
1663 \index[general]{Plugin Options}
1664 The {\bf Plugin Options} directive takes a quoted string
1665 arguement (after the equal sign) and may be specified in the
1666 Job resource. The options specified will be passed to all plugins
1667 when they are run. This each plugin must know what it is looking
1668 for. The value defined in the Job resource can be modified
1669 by the user when he runs a Job via the {\bf bconsole} command line
1672 Note: this directive may be specified, and there is code to modify
1673 the string in the run command, but the plugin options are not yet passed to
1674 the plugin (i.e. not fully implemented).
1676 \subsection{Plugin Options ACL}
1677 \index[general]{Plugin Options ACL}
1678 The {\bf Plugin Options ACL} directive may be specified in the
1679 Director's Console resource. It functions as all the other ACL commands
1680 do by permitting users running restricted consoles to specify a
1681 {\bf Plugin Options} that overrides the one specified in the Job
1682 definition. Without this directive restricted consoles may not modify
1685 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1686 \index[general]{Plugin}
1687 The {\bf Plugin} directive is specified in the Include section of
1688 a FileSet resource where you put your {\bf File = xxx} directives.
1699 Plugin = "bpipe:..."
1704 In the above example, when the File daemon is processing the directives
1705 in the Include section, it will first backup all the files in {\bf /home}
1706 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1707 the Plugin Directory. The syntax and semantics of the Plugin directive
1708 require the first part of the string up to the colon (:) to be the name
1709 of the plugin. Everything after the first colon is ignored by the File daemon but
1710 is passed to the plugin. Thus the plugin writer may define the meaning of the
1711 rest of the string as he wishes.
1713 Please see the next section for information about the {\bf bpipe} Bacula
1716 \section{The bpipe Plugin}
1717 \index[general]{The bpipe Plugin}
1718 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1719 the Bacula source distribution. When the plugin is compiled and linking into
1720 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1721 Please note that this is a very simple plugin that was written for
1722 demonstration and test purposes. It is and can be used in production, but
1723 that was never really intended.
1725 The purpose of the plugin is to provide an interface to any system program for
1726 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1727 the Include section of your Job's FileSet resource. The full syntax of the
1728 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1729 to specify the sytax as it wishes) is:
1732 Plugin = "<field1>:<field2>:<field3>:<field4>"
1737 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1738 stripped off, so in this case, we would put {\bf bpipe} in this field.
1740 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1741 pseudo path and filename under which the backup will be saved. This pseudo
1742 path and filename will be seen by the user in the restore file tree.
1743 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1744 backed up by the plugin will be put under that "pseudo" path and filename.
1745 You must be careful to choose a naming convention that is unique to avoid
1746 a conflict with a path and filename that actually exists on your system.
1748 \item {\bf field3} for the {\bf bpipe} plugin
1749 specifies the "reader" program that is called by the plugin during
1750 backup to read the data. {\bf bpipe} will call this program by doing a
1753 \item {\bf field4} for the {\bf bpipe} plugin
1754 specifies the "writer" program that is called by the plugin during
1755 restore to write the data back to the filesystem.
1758 Please note that for two items above describing the "reader" and "writer"
1759 fields, these programs are "executed" by Bacula, which
1760 means there is no shell interpretation of any command line arguments
1761 you might use. If you want to use shell characters (redirection of input
1762 or output, ...), then we recommend that you put your command or commands
1763 in a shell script and execute the script. In addition if you backup a
1764 file with the reader program, when running the writer program during
1765 the restore, Bacula will not automatically create the path to the file.
1766 Either the path must exist, or you must explicitly do so with your command
1767 or in a shell script.
1769 Putting it all together, the full plugin directive line might look
1773 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1774 --opt --databases bacula:mysql"
1777 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1778 would be written on a single line.
1780 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1781 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1782 program {\bf mysqldump -f --opt --database bacula} to read the data during
1783 backup. The mysqldump command outputs all the data for the database named
1784 {\bf bacula}, which will be read by the plugin and stored in the backup.
1785 During restore, the data that was backed up will be sent to the program
1786 specified in the last field, which in this case is {\bf mysql}. When
1787 {\bf mysql} is called, it will read the data sent to it by the plugn
1788 then write it back to the same database from which it came ({\bf bacula}
1791 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1792 the data from a specified program to Bacula for backup, and then from Bacula to
1793 a specified program for restore.
1795 By using different command lines to {\bf bpipe},
1796 you can backup any kind of data (ASCII or binary) depending
1797 on the program called.
1799 \section{Microsoft Exchange Server 2003/2007 Plugin}
1800 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1801 \subsection{Background}
1802 The Exchange plugin was made possible by a funded development project
1803 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1804 The code for the plugin was written by James Harper, and the Bacula core
1805 code by Kern Sibbald. All the code for this funded development has become
1806 part of the Bacula project. Thanks to everyone who made it happen.
1808 \subsection{Concepts}
1809 Although it is possible to backup Exchange using Bacula VSS the Exchange
1810 plugin adds a good deal of functionality, because while Bacula VSS
1811 completes a full backup (snapshot) of Exchange, it does
1812 not support Incremental or Differential backups, restoring is more
1813 complicated, and a single database restore is not possible.
1815 Microsoft Exchange organises its storage into Storage Groups with
1816 Databases inside them. A default installation of Exchange will have a
1817 single Storage Group called 'First Storage Group', with two Databases
1818 inside it, "Mailbox Store (SERVER NAME)" and
1819 "Public Folder Store (SERVER NAME)",
1820 which hold user email and public folders respectively.
1822 In the default configuration, Exchange logs everything that happens to
1823 log files, such that if you have a backup, and all the log files since,
1824 you can restore to the present time. Each Storage Group has its own set
1825 of log files and operates independently of any other Storage Groups. At
1826 the Storage Group level, the logging can be turned off by enabling a
1827 function called "Enable circular logging". At this time the Exchange
1828 plugin will not function if this option is enabled.
1830 The plugin allows backing up of entire storage groups, and the restoring
1831 of entire storage groups or individual databases. Backing up and
1832 restoring at the individual mailbox or email item is not supported but
1833 can be simulated by use of the "Recovery" Storage Group (see below).
1835 \subsection{Installing}
1836 The Exchange plugin requires a DLL that is shipped with Microsoft
1837 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1838 correctly the Exchange plugin should find this automatically and run
1839 without any additional installation.
1841 If the DLL can not be found automatically it will need to be copied into
1842 the Bacula installation
1843 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1844 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1845 default Exchange installation.
1847 \subsection{Backing Up}
1848 To back up an Exchange server the Fileset definition must contain at
1849 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1850 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1851 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1852 up files are prefixed with something that isn't going to share a name
1853 with something outside the plugin, and the 'Microsoft Information Store'
1854 bit is required also. It is also possible to add the name of a storage
1855 group to the "Plugin =" line, eg \\
1856 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1857 if you want only a single storage group backed up.
1859 Additionally, you can suffix the 'Plugin =' directive with
1860 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1861 database at the end of a full backup.
1863 An Incremental or Differential backup will backup only the database logs
1864 for each Storage Group by inspecting the "modified date" on each
1865 physical log file. Because of the way the Exchange API works, the last
1866 logfile backed up on each backup will always be backed up by the next
1867 Incremental or Differential backup too. This adds 5MB to each
1868 Incremental or Differential backup size but otherwise does not cause any
1871 By default, a normal VSS fileset containing all the drive letters will
1872 also back up the Exchange databases using VSS. This will interfere with
1873 the plugin and Exchange's shared ideas of when the last full backup was
1874 done, and may also truncate log files incorrectly. It is important,
1875 therefore, that the Exchange database files be excluded from the backup,
1876 although the folders the files are in should be included, or they will
1877 have to be recreated manually if a baremetal restore is done.
1882 File = C:/Program Files/Exchsrvr/mdbdata
1883 Plugin = "exchange:..."
1886 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1887 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1888 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1889 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1890 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1891 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1892 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1897 The advantage of excluding the above files is that you can significantly
1898 reduce the size of your backup since all the important Exchange files
1899 will be properly saved by the Plugin.
1902 \subsection{Restoring}
1903 The restore operation is much the same as a normal Bacula restore, with
1904 the following provisos:
1907 \item The {\bf Where} restore option must not be specified
1908 \item Each Database directory must be marked as a whole. You cannot just
1909 select (say) the .edb file and not the others.
1910 \item If a Storage Group is restored, the directory of the Storage Group
1912 \item It is possible to restore only a subset of the available log files,
1913 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1914 if a log file is missing from the sequence of log files
1915 \item Each database to be restored must be dismounted and marked as "Can be
1916 overwritten by restore"
1917 \item If an entire Storage Group is to be restored (eg all databases and
1918 logs in the Storage Group), then it is best to manually delete the
1919 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1920 as Exchange can get confused by stray log files lying around.
1923 \subsection{Restoring to the Recovery Storage Group}
1924 The concept of the Recovery Storage Group is well documented by
1926 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1927 but to briefly summarize...
1929 Microsoft Exchange allows the creation of an additional Storage Group
1930 called the Recovery Storage Group, which is used to restore an older
1931 copy of a database (e.g. before a mailbox was deleted) into without
1932 messing with the current live data. This is required as the Standard and
1933 Small Business Server versions of Exchange can not ordinarily have more
1934 than one Storage Group.
1936 To create the Recovery Storage Group, drill down to the Server in Exchange
1937 System Manager, right click, and select
1938 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1939 locations and click OK. On the Recovery Storage Group, right click and
1940 select {\bf "Add Database to Recover..."} and select the database you will
1943 Restore only the single database nominated as the database in the
1944 Recovery Storage Group. Exchange will redirect the restore to the
1945 Recovery Storage Group automatically.
1946 Then run the restore.
1948 \subsection{Restoring on Microsoft Server 2007}
1949 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1950 2007, and henc you use a new proceedure for recovering a single mail box.
1951 This procedure is ducomented by Microsoft at:
1952 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1953 and involves using the {\bf Restore-Mailbox} and {\bf
1954 Get-MailboxStatistics} shell commands.
1956 \subsection{Caveats}
1957 This plugin is still being developed, so you should consider it
1958 currently in BETA test, and thus use in a production environment
1959 should be done only after very careful testing.
1961 When doing a full backup, the Exchange database logs are truncated by
1962 Exchange as soon as the plugin has completed the backup. If the data
1963 never makes it to the backup medium (eg because of spooling) then the
1964 logs will still be truncated, but they will also not have been backed
1965 up. A solution to this is being worked on. You will have to schedule a
1966 new Full backup to ensure that your next backups will be usable.
1968 The "Enable Circular Logging" option cannot be enabled or the plugin
1971 Exchange insists that a successful Full backup must have taken place if
1972 an Incremental or Differential backup is desired, and the plugin will
1973 fail if this is not the case. If a restore is done, Exchange will
1974 require that a Full backup be done before an Incremental or Differential
1977 The plugin will most likely not work well if another backup application
1978 (eg NTBACKUP) is backing up the Exchange database, especially if the
1979 other backup application is truncating the log files.
1981 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1982 we recommend either carefully testing or that you avoid this option for
1985 The Exchange plugin is not called during processing the bconsole {\bf
1986 estimate} command, and so anything that would be backed up by the plugin
1987 will not be added to the estimate total that is displayed.
1990 \section{libdbi Framework}
1991 \index[general]{libdbi Framework}
1992 As a general guideline, Bacula has support for a few catalog database drivers
1993 (MySQL, PostgreSQL, SQLite)
1994 coded natively by the Bacula team. With the libdbi implementation, which is a
1995 Bacula driver that uses libdbi to access the catalog, we have an open field to
1996 use many different kinds database engines following the needs of users.
1998 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1999 implements a database-independent abstraction layer in C, similar to the
2000 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2001 leverage the power of multiple databases and multiple simultaneous database
2002 connections by using this framework.
2004 Currently the libdbi driver in Bacula project only supports the same drivers
2005 natively coded in Bacula. However the libdbi project has support for many
2006 others database engines. You can view the list at
2007 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2008 supported by Bacula, however, they must be tested properly by the Bacula team.
2010 Some of benefits of using libdbi are:
2012 \item The possibility to use proprietary databases engines in which your
2013 proprietary licenses prevent the Bacula team from developing the driver.
2014 \item The possibility to use the drivers written for the libdbi project.
2015 \item The possibility to use other database engines without recompiling Bacula
2016 to use them. Just change one line in bacula-dir.conf
2017 \item Abstract Database access, this is, unique point to code and profiling
2018 catalog database access.
2021 The following drivers have been tested:
2023 \item PostgreSQL, with and without batch insert
2024 \item Mysql, with and without batch insert
2029 In the future, we will test and approve to use others databases engines
2030 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2032 To compile Bacula to support libdbi we need to configure the code with the
2033 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2034 [database] is the database engine to be used with Bacula (of course we can
2035 change the driver in file bacula-dir.conf, see below). We must configure the
2036 access port of the database engine with the option --with-db-port, because the
2037 libdbi framework doesn't know the default access port of each database.
2039 The next phase is checking (or configuring) the bacula-dir.conf, example:
2043 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2044 dbname = regress; user = regress; password = ""
2048 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2049 mysql database. Currently the drivers supported by Bacula are: postgresql,
2050 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2052 The following limitations apply when Bacula is set to use the libdbi framework:
2053 - Not tested on the Win32 platform
2054 - A little performance is lost if comparing with native database driver.
2055 The reason is bound with the database driver provided by libdbi and the
2056 simple fact that one more layer of code was added.
2058 It is important to remember, when compiling Bacula with libdbi, the
2059 following packages are needed:
2061 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2062 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2065 You can download them and compile them on your system or install the packages
2066 from your OS distribution.
2068 \section{Console Command Additions and Enhancements}
2069 \index[general]{Console Additions}
2071 \subsection{Display Autochanger Content}
2072 \index[general]{StatusSlots}
2074 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2075 autochanger content.
2079 Slot | Volume Name | Status | Media Type | Pool |
2080 ------+---------------+----------+-------------------+------------|
2081 1 | 00001 | Append | DiskChangerMedia | Default |
2082 2 | 00002 | Append | DiskChangerMedia | Default |
2083 3*| 00003 | Append | DiskChangerMedia | Scratch |
2088 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2089 {\bf update slots} command to synchronize autochanger content with your
2092 \subsection{list joblog job=xxx or jobid=nnn}
2093 \index[general]{list joblog}
2094 A new list command has been added that allows you to list the contents
2095 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2096 or for a particular JobId. The {\bf llist} command will include a line with
2097 the time and date of the entry.
2099 Note for the catalog to have Job Log entries, you must have a directive
2106 In your Director's {\bf Messages} resource.
2108 \subsection{Use separator for multiple commands}
2109 \index[general]{Command Separator}
2110 When using bconsole with readline, you can set the command separator with
2111 \textbf{@separator} command to one
2112 of those characters to write commands who require multiple input in one line.
2114 !$%&'()*+,-/:;<>?[]^`{|}~
2117 \subsection{Deleting Volumes}
2118 The delete volume bconsole command has been modified to
2119 require an asterisk (*) in front of a MediaId otherwise the
2120 value you enter is a taken to be a Volume name. This is so that
2121 users may delete numeric Volume names. The previous Bacula versions
2122 assumed that all input that started with a number was a MediaId.
2124 This new behavior is indicated in the prompt if you read it
2127 \section{Bare Metal Recovery}
2128 The old bare metal recovery project is essentially dead. One
2129 of the main features of it was that it would build a recovery
2130 CD based on the kernel on your system. The problem was that
2131 every distribution has a different boot procedure and different
2132 scripts, and worse yet, the boot procedures and scripts change
2133 from one distribution to another. This meant that maintaining
2134 (keeping up with the changes) the rescue CD was too much work.
2136 To replace it, a new bare metal recovery USB boot stick has been developed
2137 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2138 boot from a USB key.
2142 \item Recovery can be done from within graphical environment.
2143 \item Recovery can be done in a shell.
2144 \item Ubuntu boots on a large number of Linux systems.
2145 \item The process of updating the system and adding new
2146 packages is not too difficult.
2147 \item The USB key can easily be upgraded to newer Ubuntu versions.
2148 \item The USB key has writable partitions for modifications to
2149 the OS and for modification to your home directory.
2150 \item You can add new files/directories to the USB key very easily.
2151 \item You can save the environment from multiple machines on
2153 \item Bacula Systems is funding its ongoing development.
2156 The disadvantages are:
2158 \item The USB key is usable but currently under development.
2159 \item Not everyone may be familiar with Ubuntu (no worse
2161 \item Some older OSes cannot be booted from USB. This can
2162 be resolved by first booting a Ubuntu LiveCD then plugging
2164 \item Currently the documentation is sketchy and not yet added
2165 to the main manual. See below ...
2168 The documentation and the code can be found in the {\bf rescue} package
2169 in the directory {\bf linux/usb}.
2171 \section{Miscellaneous}
2172 \index[general]{Misc New Features}
2174 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2175 \index[general]{Allow Mixed Priority}
2176 This directive is only implemented in version 2.5 and later. When
2177 set to {\bf yes} (default {\bf no}), this job may run even if lower
2178 priority jobs are already running. This means a high priority job
2179 will not have to wait for other jobs to finish before starting.
2180 The scheduler will only mix priorities when all running jobs have
2183 Note that only higher priority jobs will start early. Suppose the
2184 director will allow two concurrent jobs, and that two jobs with
2185 priority 10 are running, with two more in the queue. If a job with
2186 priority 5 is added to the queue, it will be run as soon as one of
2187 the running jobs finishes. However, new priority 10 jobs will not
2188 be run until the priority 5 job has finished.
2190 \subsection{Bootstrap File Directive -- FileRegex}
2191 \index[general]{Bootstrap File Directive}
2192 {\bf FileRegex} is a new command that can be added to the bootstrap
2193 (.bsr) file. The value is a regular expression. When specified, only
2194 matching filenames will be restored.
2196 During a restore, if all File records are pruned from the catalog
2197 for a Job, normally Bacula can restore only all files saved. That
2198 is there is no way using the catalog to select individual files.
2199 With this new feature, Bacula will ask if you want to specify a Regex
2200 expression for extracting only a part of the full backup.
2203 Building directory tree for JobId(s) 1,3 ...
2204 There were no files inserted into the tree, so file selection
2205 is not possible.Most likely your retention policy pruned the files
2207 Do you want to restore all the files? (yes\vb{}no): no
2209 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2210 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2213 \subsection{Bootstrap File Optimization Changes}
2214 In order to permit proper seeking on disk files, we have extended the bootstrap
2215 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2216 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2217 address range and end address range respectively. These two directives replace
2218 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2219 VolEndBlock} directives. Bootstrap files containing the old directives will
2220 still work, but will not properly take advantage of proper disk seeking, and
2221 may read completely to the end of a disk volume during a restore. With the new
2222 format (automatically generated by the new Director), restores will seek
2223 properly and stop reading the volume when all the files have been restored.
2225 \subsection{Solaris ZFS/NFSv4 ACLs}
2226 This is an upgrade of the previous Solaris ACL backup code
2227 to the new library format, which will backup both the old
2228 POSIX(UFS) ACLs as well as the ZFS ACLs.
2230 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2231 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2232 be used to transfer from UFS to ZFS filesystems.
2235 \subsection{Virtual Tape Emulation}
2236 \index[general]{Virtual Tape Emulation}
2237 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2238 the tape code but actually reading and writing to a disk file. Used with the
2239 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2240 and 700 slots. This feature is most useful in testing. It is enabled
2241 by using {\bf Device Type = vtape} in the Storage daemon's Device
2242 directive. This feature is only implemented on Linux machines and should not be
2243 used for production.
2245 \subsection{Bat Enhancements}
2246 \index[general]{Bat Enhancements}
2247 Bat (the Bacula Administration Tool) GUI program has been significantly
2248 enhanced and stabilized. In particular, there are new table based status
2249 commands; it can now be easily localized using Qt4 Linguist.
2251 The Bat communications protocol has been significantly enhanced to improve
2252 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2253 the Director you are using otherwise the communications protocol will not
2256 \subsection{RunScript Enhancements}
2257 \index[general]{RunScript Enhancements}
2258 The {\bf RunScript} resource has been enhanced to permit multiple
2259 commands per RunScript. Simply specify multiple {\bf Command} directives
2266 Command = "/bin/echo test"
2267 Command = "/bin/echo an other test"
2268 Command = "/bin/echo 3 commands in the same runscript"
2275 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2276 implemented, which runs the command after the Volume Shadow Copy has been made.
2278 Console commands can be specified within a RunScript by using:
2279 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2280 carefully tested and debugged and is known to easily crash the Director.
2281 We would appreciate feedback. Due to the recursive nature of this command, we
2282 may remove it before the final release.
2284 \subsection{Status Enhancements}
2285 \index[general]{Status Enhancements}
2286 The bconsole {\bf status dir} output has been enhanced to indicate
2287 Storage daemon job spooling and despooling activity.
2289 \subsection{Connect Timeout}
2290 \index[general]{Connect Timeout}
2291 The default connect timeout to the File
2292 daemon has been set to 3 minutes. Previously it was 30 minutes.
2294 \subsection{ftruncate for NFS Volumes}
2295 \index[general]{ftruncate for NFS Volumes}
2296 If you write to a Volume mounted by NFS (say on a local file server),
2297 in previous Bacula versions, when the Volume was recycled, it was not
2298 properly truncated because NFS does not implement ftruncate (file
2299 truncate). This is now corrected in the new version because we have
2300 written code (actually a kind user) that deletes and recreates the Volume,
2301 thus accomplishing the same thing as a truncate.
2303 \subsection{Support for Ubuntu}
2304 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2305 version of Linux, and thus now provides correct autostart routines.
2306 Since Ubuntu officially supports Bacula, you can also obtain any
2307 recent release of Bacula from the Ubuntu repositories.
2309 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2310 \index[general]{Recycle Pool}
2311 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2312 be placed (moved) when it is recycled. Without this directive, a Volume will
2313 remain in the same pool when it is recycled. With this directive, it can be
2314 moved automatically to any existing pool during a recycle. This directive is
2315 probably most useful when defined in the Scratch pool, so that volumes will
2316 be recycled back into the Scratch pool.
2318 \subsection{FD Version}
2319 \index[general]{FD Version}
2320 The File daemon to Director protocol now includes a version
2321 number, which although there is no visible change for users,
2322 will help us in future versions automatically determine
2323 if a File daemon is not compatible.
2325 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2326 \index[general]{Max Run Sched Time}
2327 The time specifies the maximum allowed time that a job may run, counted from
2328 when the job was scheduled. This can be useful to prevent jobs from running
2329 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2332 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2333 \index[general]{Max Wait Time}
2334 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2335 of checking the maximum allowed time that a job may block for a resource,
2336 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2337 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2338 their job depending on the level. Now, they have to use
2339 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2340 directives are now deprecated.
2342 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2343 \index[general]{Incremental Max Wait Time}
2344 \index[general]{Differential Max Wait Time}
2346 These directives have been deprecated in favor of
2347 \texttt{Incremental|Differential Max Run Time}.
2349 \subsection{Max Run Time directives}
2350 \index[general]{Max Run Time directives}
2351 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2352 maximum allowed time that a job can run depending on the level.
2354 \addcontentsline{lof}{figure}{Job time control directives}
2355 \includegraphics{\idir different_time.eps}
2357 \subsection{Statistics Enhancements}
2358 \index[general]{Statistics Enhancements}
2359 If you (or probably your boss) want to have statistics on your backups to
2360 provide some \textit{Service Level Agreement} indicators, you could use a few
2361 SQL queries on the Job table to report how many:
2365 \item jobs have been successful
2366 \item files have been backed up
2370 However, these statistics are accurate only if your job retention is greater
2371 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2372 be able to use them.
2374 Now, you can use the \textbf{update stats [days=num]} console command to fill
2375 the JobHistory table with new Job records. If you want to be sure to take in
2376 account only \textbf{good jobs}, ie if one of your important job has failed but
2377 you have fixed the problem and restarted it on time, you probably want to
2378 delete the first \textit{bad} job record and keep only the successful one. For
2379 that simply let your staff do the job, and update JobHistory table after two or
2380 three days depending on your organization using the \textbf{[days=num]} option.
2382 These statistics records aren't used for restoring, but mainly for
2383 capacity planning, billings, etc.
2385 The Bweb interface provides a statistics module that can use this feature. You
2386 can also use tools like Talend or extract information by yourself.
2388 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2389 the length of time that Bacula will keep statistics job records in the Catalog
2390 database after the Job End time. (In \texttt{JobHistory} table) When this time
2391 period expires, and if user runs \texttt{prune stats} command, Bacula will
2392 prune (remove) Job records that are older than the specified period.
2394 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2395 job to maintain statistics.
2398 Name = BackupCatalog
2401 Console = "update stats days=3"
2402 Console = "prune stats yes"
2409 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2410 \index[general]{ScratchPool}
2411 This directive permits to specify a specific \textsl{Scratch} pool for the
2412 current pool. This is useful when using multiple storage sharing the same
2413 mediatype or when you want to dedicate volumes to a particular set of pool.
2415 \subsection{Enhanced Attribute Despooling}
2416 \index[general]{Attribute Despooling}
2417 If the storage daemon and the Director are on the same machine, the spool file
2418 that contains attributes is read directly by the Director instead of being
2419 transmitted across the network. That should reduce load and speedup insertion.
2421 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2422 \index[general]{SpoolSize}
2423 A new Job directive permits to specify the spool size per job. This is used
2424 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2426 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2427 \index[general]{MaximumConsoleConnections}
2428 A new director directive permits to specify the maximum number of Console
2429 Connections that could run concurrently. The default is set to 20, but you may
2430 set it to a larger number.
2432 \subsection{VerId = \lt{}string\gt{}}
2433 \index[general]{VerId}
2434 A new director directive permits to specify a personnal identifier that will be
2435 displayed in the \texttt{version} command.
2437 \subsection{dbcheck enhancements}
2438 \index[general]{dbcheck enhancements}
2439 If you are using Mysql, dbcheck will now ask you if you want to create
2440 temporary indexes to speed up orphaned Path and Filename elimination.
2442 A new \texttt{-B} option allows you to print catalog information in a simple
2443 text based format. This is useful to backup it in a secure way.
2458 You can now specify the database connection port in the command line.
2460 \subsection{{-}{-}docdir configure option}
2461 \index[general]{{-}{-}docdir configure option}
2462 You can use {-}{-}docdir= on the ./configure command to
2463 specify the directory where you want Bacula to install the
2464 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2465 {\bf /usr/share/doc/bacula}.
2467 \subsection{{-}{-}htmldir configure option}
2468 \index[general]{{-}{-}htmldir configure option}
2469 You can use {-}{-}htmldir= on the ./configure command to
2470 specify the directory where you want Bacula to install the bat html help
2471 files. The default is {\bf /usr/share/doc/bacula/html}
2473 \subsection{{-}{-}with-plugindir configure option}
2474 \index[general]{{-}{-}plugindir configure option}
2475 You can use {-}{-}plugindir= on the ./configure command to
2476 specify the directory where you want Bacula to install
2477 the plugins (currently only bpipe-fd). The default is