1 \chapter{New Features in Enterprise 4.0.x}
2 There are new features in the Bacula Enterprise version.
3 This is an older version and this documentation remains
4 for historical reasons.
6 \section{New Features in Version 4.0.8}
8 \subsection{Always Backup a File}
10 When the Accurate mode is turned on, you can decide to always backup a file
11 by using the following option:
34 \section{New Features in 4.0.5}
36 There are new features in version 4.0.5 and this version fixes a number of bugs
37 found in version 4.0.4.
39 \subsection{Support for the VSS plugin}
41 The System State component of the VSS plugin (see below) is now supported.
42 All tests indicate that it is functioning correctly.
44 The Exchange component of the VSS plugin appears to work in Full backup
45 mode only. Incremental restores fail, so please do not attempt Incremental
46 backups. We are therefore releasing this plugin for testing in Full backup
47 mode only. However, please carefully test it before using it. We are
48 working on fixing the problem with Incremental restores.
50 The MSSQL component of the VSS plugin works in Full backup mode only.
51 Incremental backups and restores do not work because they need the delta
52 backup capability that is only in the next major version (not yet
53 released), so please do not attempt Incremental backups. We are therefore
54 releasing this plugin for testing in Full backup mode only. However,
55 please carefully test it before using it.
57 The Sharepoint component of the VSS plugin has not been tested. Any
58 feedback on testing it would be appreciated.
61 \subsection{Support for NDMP Protocol}
63 The new \texttt{ndmp} Plugin is able to backup a NAS through NDMP protocol
64 using \textbf{Filer to server} approach, where the Filer is backing up across
65 the LAN to your Bacula server.
67 Accurate option should be turned on in the Job resource.
79 Plugin = "ndmp:host=nasbox user=root pass=root file=/vol/vol1"
84 This plugin is available as an option. Please
85 contact Bacula Systems to get access to the NDMP Plugin packages and the
90 This project was funded by Bacula Systems and is available with Bacula
93 \subsection{Include All Windows Drives in FileSet}
95 The \texttt{alldrives} Windows Plugin allows you to include all local drives
96 with a simple directive. This plugin is available in the Windows 64 and 32 bit
109 You exclude some specific drives with the \texttt{exclude} option.
116 Plugin = "alldrives: exclude=D,E"
122 This project was funded by Bacula Systems and is available with Bacula
125 \subsection{Additions to RunScript variables}
126 You can have access to JobBytes and JobFiles using \%b and \%f in your runscript
130 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%f"
133 \section{Release Version 4.0.1 to 4.0.4}
135 There are no new features between version 4.0.1 and 4.0.4. These versions
136 simply fixe a number of bugs found in previous version during the onging
139 \section{New Features in 4.0.0}
140 This chapter presents the new features that have been added to the
141 current version of the Bacula Enterprise Edition since the previous
144 \subsection{Microsoft VSS Writer Plugin}
145 \index[general]{Microsoft VSS writer plugin}
146 We provide a single plugin named {\bf vss-fd.dll} that
147 permits you to backup a number of different components
148 on Windows machines. This plugin is available from Bacula Systems
151 Only the System State component is currently supported. The Sharepoint,
152 MSSQL, and Exchange components are available only for testing.
155 \item System State writers
159 \item COM+ REGDB (COM Registration Database)
160 \item System (Systems files -- most of what is under c:/windows and more)
161 \item WMI (Windows Management and Instrumentation)
162 \item NTDS (Active Directory)
163 \item NTFRS (SYSVOL etc replication -- Windows 2003 domains)
164 \item DFS Replication (SYSVOLS etc replication -- Windows 2008 domains)
167 This component is known to work.
168 \item Sharepoint writers \\
169 This component has not yet been tested. It is included so that you
170 may test it, but please do not use it in production without careful
172 \item MSSQL databases (except those owned by Sharepoint if that plugin is
174 This component has been tested, but only works for Full backups. Please
175 do not attempt to use it for incremental backups. The Windows writer
176 performs block level delta for Incremental backups, which are only
177 supported by Bacula version 4.2.0, not yet released. If you use
178 this component, please do not use it in production without careful
180 \item Exchange (all exchange databases) \\
181 We have tested this component and found it to work, but only for Full
182 backups. Please do not attempt to use it for incremental or differential
183 backups. We are including this component for you to test. Please do not
184 use it in production without careful testing. \\ Bacula Systems has a
185 White Paper that describes backup and restore of MS Exchange 2010 in
189 Each of the above specified Microsoft components can be backed up
190 by specifying a different plugin option within the Bacula FileSet.
191 All specifications must start with {\bf vss:} and be followed
192 with a keyword which indicates the writer, such as {\bf /@SYSTEMSTATE/}
194 To activate each component you use the following:
197 \item System State writers
199 Plugin = "vss:/@SYSTEMSTATE/"
201 Note, exactly which subcomponents will be backed up depends on
202 which ones you have enabled within Windows. For example, on a standard
203 default Vista system only ASR Writer, COM+ REGDB, System State, and WMI
205 \item Sharepoint writers
207 Plugin = "vss:/@SHAREPOINT/"
209 \item MSSQL databases (except those owned by Sharepoint if that plugin is
212 Plugin = "vss:/@MSSQL/"
214 To use the sharepoint writer you'll need to enable the mssql writer
215 which is not enabled by default (a Microsoft restriction). The Microsoft
216 literature says that the mssql writer is only good for snapshots
218 enabled via a registry tweak or else the older MSDE writer will be
220 \item Exchange (all exchange databases)
222 Plugin = "vss:/@EXCHANGE/"
226 The plugin directives must be specified exactly as shown above.
227 A Job may have one or more of the {\bf vss} plugins components specified.
230 Also ensure that the vss-fd.dll plugin is in the plugins directory
231 on the FD doing the backup, and that the plugin directory config line is
232 present in the FD's configuration file (bacula-fd.conf).
234 \subsubsection{Backup}
235 If everything is set up correctly as above then the backup should
236 include the system state. The system state files backed up will appear
237 in a {\bf bconsole} or {\bf bat} restore like:
241 /@SYSTEMSTATE/ASR Writer/
242 /@SYSTEMSTATE/COM+ REGDB Writer/
246 Only a complete backup of the system state is supported at this time. That
247 is it is not currently possible to just back up the Registry or Active
248 Directory by itself. In almost all cases a complete backup is a good idea
249 anyway as most of the components are interconnected in some way. Also, if
250 an incremental or differential backup is specified on the backup Job then a
251 full backup of the system state will still be done. The size varies
252 according to your installation. We have seen up to 6GB
253 under Windows 2008, mostly because of the "System" writer, and
254 up to 20GB on Vista. The actual size depends on how many Windows
255 components are enabled.
257 The system state component automatically respects all the excludes present
258 in the FilesNotToBackup registry key, which includes things like \%TEMP\%,
259 pagefile.sys, hiberfil.sys, etc. Each plugin may additionally specify
260 files to exclude, eg the VSS Registry Writer will tell Bacula to not back
261 up the registry hives under \lstinline+C:\WINDOWS\system32\config+ because they
262 are backed up as part of the system state.
264 \subsubsection{Restore}
265 In most cases a restore of the entire backed up system state is
266 recommended. Individual writers can be selected for restore, but currently
267 not individual components of those writers. To restore just the Registry,
268 you would need to mark @SYSTEMSTATE (only the directory, not the
269 subdirectories), and then do {\bf mark Registry*} to mark the Registry writer
270 and everything under it.
272 Restoring anything less than a single component may not produce the
273 intended results and should only be done if a specific need arises and you
274 know what you are doing, and not without testing on a non-critical system
277 To restore Active Directory, the system will need to be booted into
278 Directory Services Restore Mode, an option at Windows boot time.
280 Only a non-authoritative restore of NTFRS/DFSR is supported at this
281 time. There exists Windows literature to turn a Domain Controller
282 restored in non-authoritative mode back into an authoritative Domain
283 Controller. If only one DC exists it appears that Windows does an
284 authoritative restore anyway.
286 Most VSS components will want to restore to files that are currently in
287 use. A reboot will be required to complete the restore (eg to bring the
288 restored registry online).
290 Starting another restore of VSS data after the restore of the registry
291 without first rebooting will not produce the intended results as the 'to be
292 replaced next reboot' file list will only be updated in the 'to be
293 replaced' copy of the registry and so will not be actioned.
295 \subsubsection{Example}
296 Suppose you have the following backup FileSet:
314 If only the Registry needs to be restored, then you could use the
315 following commands in {\bf bconsole}:
320 markdir "Registry Writer"
326 \subsubsection{Windows Plugins Items to Note}
328 \item Reboot Required after a Plugin Restore\\
329 In general after any VSS plugin is used to restore a component, you will
330 need to reboot the system. This is required because in-use files cannot be
331 replaced during restore time, so they are noted in the registry and
332 replaced when the system reboots.
333 \item After a System State restore, a reboot will generally take
334 longer than normal because the pre-boot process must move the newly restored
335 files into their final place prior to actually booting the OS.
336 \item One File from Each Drive needed by the Plugins must be backed up\\
337 At least one file from each drive that will be needed by the plugin must
338 have a regular file that is marked for backup. This is to ensure that the
339 main Bacula code does a snapshot of all the required drives. At a later
340 time, we will find a way to accomplish this automatically.
341 \item Bacula does not Automatically Backup Mounted Drives\\
342 Any drive that is mounted in the normal file structure using a mount point
343 or junction point will not be backed up by Bacula. If you want it backed
344 up, you must explicitly mention it in a Bacula "File" directive in your
346 \item When doing a backup that is to be used as a Bare Metal Recovery, do
347 not use the VSS plugin. The reason is that during a Bare Metal Recovery,
348 VSS is not available nor are the writers from the various components that
349 are needed to do the restore. You might do full backup to be used with
350 a Bare Metal Recovery once a month or once a week, and all other days,
351 do a backup using the VSS plugin, but under a different Job name. Then
352 to restore your system, use the last Full non-VSS backup to restore your
353 system, and after rebooting do a restore with the VSS plugin to get
354 everything fully up to date.
357 \subsubsection{Bare Metal Restore}
358 Depending on the bare metal restore environment, the VSS writers may not
359 be running correctly so this may not work. If this is the case,
360 the System State must be restored after the Bare Metal Recovery procedure
361 is complete and the system and Bacula are running normally.
363 \subsection{Additions to the Plugin API}
364 The bfuncs structure has been extended to include a number of
368 \subsection{Truncate Volume after Purge}
369 \label{sec:actiononpurge}
371 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
372 the volume when it is purged with the new command \texttt{purge volume
373 action}. It is useful to prevent disk based volumes from consuming too much
379 Action On Purge = Truncate
384 As usual you can also set this property with the \texttt{update volume} command
386 *update volume=xxx ActionOnPurge=Truncate
387 *update volume=xxx actiononpurge=None
390 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
391 following command in interactive mode or in a RunScript as shown after:
393 *purge volume action=truncate storage=File allpools
394 # or by default, action=all
395 *purge volume action storage=File pool=Default
398 This is possible to specify the volume name, the media type, the pool, the
399 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
400 idle when you decide to run this command.
409 Console = "purge volume action=all allpools storage=File"
414 \textbf{Important note}: This feature doesn't work as
415 expected in version 5.0.0. Please do not use it before version 5.0.1.
417 \subsection{Allow Higher Duplicates}
418 This directive did not work correctly and has been depreciated
419 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
420 file as it will be removed in a future rlease.
422 \subsection{Cancel Lower Level Duplicates}
423 This directive was added in Bacula version 5.0.1. It compares the
424 level of a new backup job to old jobs of the same name, if any,
425 and will kill the job which has a lower level than the other one.
426 If the levels are the same (i.e. both are Full backups), then
427 nothing is done and the other Cancel XXX Duplicate directives
431 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
432 Daemon configuration permits setting the maximum number of Jobs that can
433 run concurrently on a specified Device. Using this directive, it is
434 possible to have different Jobs using multiple drives, because when the
435 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
436 Jobs on any other available compatible drive. This facilitates writing to
437 multiple drives with multiple Jobs that all use the same Pool.
439 This project was funded by Bacula Systems.
441 \subsection{Restore from Multiple Storage Daemons}
442 \index[general]{Restore}
444 Previously, you were able to restore from multiple devices in a single Storage
445 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
446 example, if your full backup runs on a Storage Daemon with an autochanger, and
447 your incremental jobs use another Storage Daemon with lots of disks, Bacula
448 will switch automatically from one Storage Daemon to an other within the same
451 You must upgrade your File Daemon to version 3.1.3 or greater to use this
454 This project was funded by Bacula Systems with the help of Equiinet.
456 \subsection{File Deduplication using Base Jobs}
457 A base job is sort of like a Full save except that you will want the FileSet to
458 contain only files that are unlikely to change in the future (i.e. a snapshot
459 of most of your system after installing it). After the base job has been run,
460 when you are doing a Full save, you specify one or more Base jobs to be used.
461 All files that have been backed up in the Base job/jobs but not modified will
462 then be excluded from the backup. During a restore, the Base jobs will be
463 automatically pulled in where necessary.
465 This is something none of the competition does, as far as we know (except
466 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
467 win for the user, it makes Bacula stand out as offering a unique optimization
468 that immediately saves time and money. Basically, imagine that you have 100
469 nearly identical Windows or Linux machine containing the OS and user files.
470 Now for the OS part, a Base job will be backed up once, and rather than making
471 100 copies of the OS, there will be only one. If one or more of the systems
472 have some files updated, no problem, they will be automatically restored.
474 See the \ilink{Base Job Chapter}{basejobs} for more information.
476 This project was funded by Bacula Systems.
478 \subsection{AllowCompression = \lt{}yes\vb{}no\gt{}}
479 \index[dir]{AllowCompression}
481 This new directive may be added to Storage resource within the Director's
482 configuration to allow users to selectively disable the client compression for
483 any job which writes to this storage resource.
489 Address = ultrium-tape
490 Password = storage_password # Password for Storage Daemon
493 AllowCompression = No # Tape drive has hardware compression
496 The above example would cause any jobs running with the UltriumTape storage
497 resource to run without compression from the client file daemons. This
498 effectively overrides any compression settings defined at the FileSet level.
500 This feature is probably most useful if you have a tape drive which supports
501 hardware compression. By setting the \texttt{AllowCompression = No} directive
502 for your tape drive storage resource, you can avoid additional load on the file
503 daemon and possibly speed up tape backups.
505 This project was funded by Collaborative Fusion, Inc.
507 \subsection{Accurate Fileset Options}
508 \label{sec:accuratefileset}
510 In previous versions, the accurate code used the file creation and modification
511 times to determine if a file was modified or not. Now you can specify which
512 attributes to use (time, size, checksum, permission, owner, group, \dots),
513 similar to the Verify options.
529 \item {\bf i} compare the inodes
530 \item {\bf p} compare the permission bits
531 \item {\bf n} compare the number of links
532 \item {\bf u} compare the user id
533 \item {\bf g} compare the group id
534 \item {\bf s} compare the size
535 \item {\bf a} compare the access time
536 \item {\bf m} compare the modification time (st\_mtime)
537 \item {\bf c} compare the change time (st\_ctime)
538 \item {\bf d} report file size decreases
539 \item {\bf 5} compare the MD5 signature
540 \item {\bf 1} compare the SHA1 signature
543 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
544 the File Daemon will have to read all files even if they normally would not
545 be saved. This increases the I/O load, but also the accuracy of the
546 deduplication. By default, Bacula will check modification/creation time
549 This project was funded by Bacula Systems.
551 \subsection{Tab-completion for Bconsole}
552 \label{sec:tabcompletion}
554 If you build \texttt{bconsole} with readline support, you will be able to use
555 the new auto-completion mode. This mode supports all commands, gives help
556 inside command, and lists resources when required. It works also in the restore
559 To use this feature, you should have readline development package loaded on
560 your system, and use the following option in configure.
562 ./configure --with-readline=/usr/include/readline --disable-conio ...
565 The new bconsole won't be able to tab-complete with older directors.
567 This project was funded by Bacula Systems.
569 \subsection{Pool File and Job retention}
570 \label{sec:poolfilejobretention}
573 We added two new Pool directives, \texttt{FileRetention} and
574 \texttt{JobRetention}, that take precedence over Client directives of the same
575 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
576 example, you can decide to increase Retention times for Archive or OffSite Pool.
578 \subsection{Read-only File Daemon using capabilities}
579 \label{sec:fdreadonly}
580 This feature implements support of keeping \textbf{ReadAll} capabilities after
581 UID/GID switch, this allows FD to keep root read but drop write permission.
583 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
584 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
587 root@localhost:~# bacula-fd -k -u nobody -g nobody
590 The code for this feature was contributed by our friends at AltLinux.
592 \subsection{Bvfs API}
595 To help developers of restore GUI interfaces, we have added new \textsl{dot
596 commands} that permit browsing the catalog in a very simple way.
599 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
600 the Bvfs cache in the catalog. You need to run it before any access to the
603 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
604 will list all directories in the specified \texttt{path} or
605 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
606 encoding of path/filenames.
608 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
609 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
610 \texttt{pathid} avoids problems with character encoding.
613 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
614 data that will be displayed.
617 * .bvfs_update jobid=1,2
619 * .bvfs_lsdir path=/ jobid=1,2
622 This project was funded by Bacula Systems.
624 \subsection{Testing your Tape Drive}
625 \label{sec:btapespeed}
627 To determine the best configuration of your tape drive, you can run the new
628 \texttt{speed} command available in the \texttt{btape} program.
630 This command can have the following arguments:
632 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
633 (between 1 and 5GB). This counter is in GB.
634 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
635 of data should be greater than your memory ($file\_size*nb\_file$).
636 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
638 \item[\texttt{skip\_random}] This flag permits to skip tests with random
640 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
641 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
646 *speed file_size=3 skip_raw
647 btape.c:1078 Test with zero data and bacula block structure.
648 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
649 ++++++++++++++++++++++++++++++++++++++++++
650 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
651 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
653 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
655 btape.c:1090 Test with random data, should give the minimum throughput.
656 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
657 +++++++++++++++++++++++++++++++++++++++++++
658 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
659 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
660 +++++++++++++++++++++++++++++++++++++++++++
662 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
666 When using compression, the random test will give your the minimum throughput
667 of your drive . The test using constant string will give you the maximum speed
668 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
670 You can change the block size in the Storage Daemon configuration file.
672 \subsection{New {\bf Block Checksum} Device Directive}
673 You may now turn off the Block Checksum (CRC32) code
674 that Bacula uses when writing blocks to a Volume. This is
681 doing so can reduce the Storage daemon CPU usage slightly. It
682 will also permit Bacula to read a Volume that has corrupted data.
684 The default is {\bf yes} -- i.e. the checksum is computed on write
687 We do not recommend to turn this off particularly on older tape
688 drives or for disk Volumes where doing so may allow corrupted data
691 \subsection{New Bat Features}
693 Those new features were funded by Bacula Systems.
695 \subsubsection{Media List View}
697 By clicking on ``Media'', you can see the list of all your volumes. You will be
698 able to filter by Pool, Media Type, Location,\dots And sort the result directly
699 in the table. The old ``Media'' view is now known as ``Pool''.
700 %\begin{figure}[htbp]
702 % \includegraphics[width=13cm]{\idir
703 \bsysimageH{bat-mediaview}{List volumes with BAT}{figbs4:mediaview}
704 % \label{fig:mediaview}
708 \subsubsection{Media Information View}
710 By double-clicking on a volume (on the Media list, in the Autochanger content
711 or in the Job information panel), you can access a detailed overview of your
712 Volume. (cf. figure \bsysref{figbs4:mediainfo}.)
713 %\begin{figure}[htbp]
715 % \includegraphics[width=13cm]{\idir
716 \bsysimageH{bat11}{Media information}{figbs4:mediainfo}
717 % \caption{Media information}
718 % \label{fig:mediainfo}
721 \subsubsection{Job Information View}
723 By double-clicking on a Job record (on the Job run list or in the Media
724 information panel), you can access a detailed overview of your Job. (cf. figure
725 \bsysref{figbs4:jobinfo}.)
726 %\begin{figure}[htbp]
728 % \includegraphics[width=13cm]{\idir
729 \bsysimageH{bat12}{Job information}{figbs4:jobinfo}
730 % \caption{Job information}
731 % \label{fig:jobinfo}
734 \subsubsection{Autochanger Content View}
736 By double-clicking on a Storage record (on the Storage list panel), you can
737 access a detailed overview of your Autochanger. (cf. figure \bsysref{figbs4:jobinfo}.)
738 %\begin{figure}[htbp]
740 % \includegraphics[width=13cm]{\idir
741 \bsysimageH{bat13}{Autochanger content}{figbs4:achcontent}
742 % \caption{Autochanger content}
743 % \label{fig:achcontent}
746 To use this feature, you need to use the latest mtx-changer script
747 version. (With new \texttt{listall} and \texttt{transfer} commands)
749 \subsection{Bat on Windows}
750 We have ported {\bf bat} to Windows and it is now installed
751 by default when the installer is run. It works quite well
752 on Win32, but has not had a lot of testing there, so your
753 feedback would be welcome. Unfortunately, eventhough it is
754 installed by default, it does not yet work on 64 bit Windows
757 \subsection{New Win32 Installer}
758 The Win32 installer has been modified in several very important
761 \item You must deinstall any current version of the
762 Win32 File daemon before upgrading to the new one.
763 If you forget to do so, the new installation will fail.
764 To correct this failure, you must manually shutdown
765 and deinstall the old File daemon.
766 \item All files (other than menu links) are installed
767 in {\bf c:/Program Files/Bacula}.
768 \item The installer no longer sets this
769 file to require administrator privileges by default. If you want
770 to do so, please do it manually using the {\bf cacls} program.
773 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
775 \item The server daemons (Director and Storage daemon) are
776 no longer included in the Windows installer. If you want the
777 Windows servers, you will either need to build them yourself (note
778 they have not been ported to 64 bits), or you can contact
779 Bacula Systems about this.
782 \subsection{Win64 Installer}
783 We have corrected a number of problems that required manual
784 editing of the conf files. In most cases, it should now
785 install and work. {\bf bat} is by default installed in
786 {\bf c:/Program Files/Bacula/bin32} rather than
787 {\bf c:/Program Files/Bacula} as is the case with the 32
788 bit Windows installer.
790 \subsection{Linux Bare Metal Recovery USB Key}
791 We have made a number of significant improvements in the
792 Bare Metal Recovery USB key. Please see the README files
793 it the {\bf rescue} release for more details.
795 We are working on an equivalent USB key for Windows bare
796 metal recovery, but it will take some time to develop it (best
797 estimate 3Q2010 or 4Q2010)
800 \subsection{bconsole Timeout Option}
801 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
802 for commands. This is useful with GUI programs that use {\bf bconsole}
803 to interface to the Director.
805 \subsection{Important Changes}
806 \label{sec:importantchanges}
809 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
810 to the same Pool. The Storage daemon ensures that you do not read and
811 write to the same Volume.
812 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
814 \item Virtually all the features of {\bf mtx-changer} have
815 now been parameterized, which allows you to configure
816 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
817 that contains variables that you can set to configure mtx-changer.
818 This configuration file will not be overwritten during upgrades.
819 We encourage you to submit any changes
820 that are made to mtx-changer and to parameterize it all in
821 mtx-changer.conf so that all configuration will be done by
822 changing only mtx-changer.conf.
823 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
824 and \texttt{transfer}. Please configure them as appropriate
826 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
827 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
828 password. If you want to use the new script, you will need to
829 manually change the \texttt{BackupCatalog} Job definition.
830 \item The \texttt{bconsole} \texttt{help} command now accepts
831 an argument, which if provided produces information on that
832 command (ex: \texttt{help run}).
836 \subsubsection*{Truncate volume after purge}
838 Note that the Truncate Volume after purge feature doesn't work as expected
839 in 5.0.0 version. Please, don't use it before version 5.0.1.
841 \subsubsection{Custom Catalog queries}
843 If you wish to add specialized commands that list the contents of the catalog,
844 you can do so by adding them to the \texttt{query.sql} file. This
845 \texttt{query.sql} file is now empty by default. The file
846 \texttt{examples/sample-query.sql} has an a number of sample commands
847 you might find useful.
849 \subsubsection{Deprecated parts}
851 The following items have been \textbf{deprecated} for a long time, and are now
852 removed from the code.
855 \item Support for SQLite 2
858 \subsection{Misc Changes}
859 \label{sec:miscchanges}
862 \item Updated Nagios check\_bacula
863 \item Updated man files
864 \item Added OSX package generation script in platforms/darwin
865 \item Added Spanish and Ukrainian Bacula translations
866 \item Enable/disable command shows only Jobs that can change
867 \item Added \texttt{show disabled} command to show disabled Jobs
868 \item Many ACL improvements
869 \item Added Level to FD status Job output
870 \item Begin Ingres DB driver (not yet working)
871 \item Split RedHat spec files into bacula, bat, mtx, and docs
872 \item Reorganized the manuals (fewer separate manuals)
873 \item Added lock/unlock order protection in lock manager
874 \item Allow 64 bit sizes for a number of variables
875 \item Fixed several deadlocks or potential race conditions in the SD
878 \subsection{Full Restore from a Given JobId}
879 \index[general]{Restore menu}
881 This feature allows selecting a single JobId and having Bacula
882 automatically select all the other jobs that comprise a full backup up to
883 and including the selected date (through JobId).
885 Assume we start with the following jobs:
887 +-------+--------------+---------------------+-------+----------+------------+
888 | jobid | client | starttime | level | jobfiles | jobbytes |
889 +-------+--------------+---------------------+-------+----------+------------+
890 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
891 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
892 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
893 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
894 +-------+--------------+---------------------+-------+----------+------------+
897 Below is an example of this new feature (which is number 12 in the
902 To select the JobIds, you have the following choices:
903 1: List last 20 Jobs run
904 2: List Jobs where a given File is saved
906 12: Select full restore to a specified Job date
909 Select item: (1-13): 12
910 Enter JobId to get the state to restore: 5
911 Selecting jobs to build the Full state at 2009-07-15 11:45:45
912 You have selected the following JobIds: 1,3,5
914 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
915 1,444 files inserted into the tree.
918 This project was funded by Bacula Systems.
920 \subsection{Source Address}
921 \index[general]{Source address}
923 A feature has been added which allows the administrator to specify the address
924 from which the Director and File daemons will establish connections. This
925 may be used to simplify system configuration overhead when working in complex
926 networks utilizing multi-homing and policy-routing.
928 To accomplish this, two new configuration directives have been implemented:
931 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
935 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
939 Simply adding specific host routes on the OS
940 would have an undesirable side-effect: any
941 application trying to contact the destination host would be forced to use the
942 more specific route possibly diverting management traffic onto a backup VLAN.
943 Instead of adding host routes for each client connected to a multi-homed backup
944 server (for example where there are management and backup VLANs), one can
945 use the new directives to specify a specific source address at the application
948 Additionally, this allows the simplification and abstraction of firewall rules
949 when dealing with a Hot-Standby director or storage daemon configuration. The
950 Hot-standby pair may share a CARP address, which connections must be sourced
951 from, while system services listen and act from the unique interface addresses.
953 This project was funded by Collaborative Fusion, Inc.
955 \subsection{Show volume availability when doing restore}
957 When doing a restore the selection dialog ends by displaying this
961 The job will require the following
962 Volume(s) Storage(s) SD Device(s)
963 ===========================================================================
974 Volumes marked with ``*'' are online (in the autochanger).
977 This should help speed up large restores by minimizing the time spent
978 waiting for the operator to discover that he must change tapes in the library.
980 This project was funded by Bacula Systems.
982 \subsection{Accurate estimate command}
984 The \texttt{estimate} command can now use the accurate code to detect changes
985 and give a better estimation.
987 You can set the accurate behavior on the command line by using
988 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
991 * estimate listing accurate=yes level=incremental job=BackupJob
994 This project was funded by Bacula Systems.
996 \subsection{Accurate Backup}
997 \index[general]{Accurate backup}
999 As with most other backup programs, by default Bacula decides what files to
1000 backup for Incremental and Differental backup by comparing the change
1001 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1002 backup completed. If one of those two times is later than the last backup
1003 time, then the file will be backed up. This does not, however, permit tracking
1004 what files have been deleted and will miss any file with an old time that may
1005 have been restored to or moved onto the client filesystem.
1007 \subsubsection{Accurate = \lt{}yes\vb{}no\gt{}}
1008 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1009 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1010 backup, there is no difference, but for {\bf Differential} and {\bf
1011 Incremental} backups, the Director will send a list of all previous files
1012 backed up, and the File daemon will use that list to determine if any new files
1013 have been added or or moved and if any files have been deleted. This allows
1014 Bacula to make an accurate backup of your system to that point in time so that
1015 if you do a restore, it will restore your system exactly.
1018 about using Accurate backup is that it requires more resources (CPU and memory)
1019 on both the Director and the Client machines to create the list of previous
1020 files backed up, to send that list to the File daemon, for the File daemon to
1021 keep the list (possibly very big) in memory, and for the File daemon to do
1022 comparisons between every file in the FileSet and the list. In particular,
1023 if your client has lots of files (more than a few million), you will need
1024 lots of memory on the client machine.
1026 Accurate must not be enabled when backing up with a plugin that is not
1027 specially designed to work with Accurate. If you enable it, your restores
1028 will probably not work correctly.
1030 This project was funded by Bacula Systems.
1034 \subsection{Copy Jobs}
1035 \index[general]{Copy jobs}
1037 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1038 existing Migration feature with the exception that the Job that is copied is
1039 left unchanged. This essentially creates two identical copies of the same
1040 backup. However, the copy is treated as a copy rather than a backup job, and
1041 hence is not directly available for restore. The {\bf restore} command lists
1042 copy jobs and allows selection of copies by using \texttt{jobid=}
1043 option. If the keyword {\bf copies} is present on the command line, Bacula will
1044 display the list of all copies for selected jobs.
1049 These JobIds have copies as follows:
1050 +-------+------------------------------------+-----------+------------------+
1051 | JobId | Job | CopyJobId | MediaType |
1052 +-------+------------------------------------+-----------+------------------+
1053 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1054 +-------+------------------------------------+-----------+------------------+
1055 +-------+-------+----------+----------+---------------------+------------------+
1056 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1057 +-------+-------+----------+----------+---------------------+------------------+
1058 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1059 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1060 +-------+-------+----------+----------+---------------------+------------------+
1061 You have selected the following JobIds: 19,2
1063 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1064 5,611 files inserted into the tree.
1069 The Copy Job runs without using the File daemon by copying the data from the
1070 old backup Volume to a different Volume in a different Pool. See the Migration
1071 documentation for additional details. For copy Jobs there is a new selection
1072 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1073 not already copied to another Pool.
1075 As with Migration, the Client, Volume, Job, or SQL query, are
1076 other possible ways of selecting the Jobs to be copied. Selection
1077 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1078 work, but are probably more suited for Migration Jobs.
1080 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1081 it will promote the Copy to a \textsl{real} backup job and will make it available for
1082 automatic restore. If more than one Copy is available, it will promote the copy
1083 with the smallest JobId.
1085 A nice solution which can be built with the new Copy feature is often
1086 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1087 look something like the one below:
1091 Name = FullBackupsVirtualPool
1093 Purge Oldest Volume = Yes
1095 NextPool = FullBackupsTapePool
1099 Name = FullBackupsTapePool
1103 Volume Retention = 365 days
1104 Storage = superloader
1108 # Fake fileset for copy jobs
1120 # Fake client for copy jobs
1130 # Default template for a CopyDiskToTape Job
1133 Name = CopyDiskToTape
1135 Messages = StandardCopy
1138 Selection Type = PoolUncopiedJobs
1139 Maximum Concurrent Jobs = 10
1141 Allow Duplicate Jobs = Yes
1142 Cancel Queued Duplicates = No
1143 Cancel Running Duplicates = No
1148 Name = DaySchedule7:00
1149 Run = Level=Full daily at 7:00
1153 Name = CopyDiskToTapeFullBackups
1155 Schedule = DaySchedule7:00
1156 Pool = FullBackupsVirtualPool
1157 JobDefs = CopyDiskToTape
1161 The example above had 2 pool which are copied using the PoolUncopiedJobs
1162 selection criteria. Normal Full backups go to the Virtual pool and are copied
1163 to the Tape pool the next morning.
1165 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1170 +-------+------------------------------------+-----------+------------------+
1171 | JobId | Job | CopyJobId | MediaType |
1172 +-------+------------------------------------+-----------+------------------+
1173 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1174 +-------+------------------------------------+-----------+------------------+
1177 \subsection{ACL Updates}
1178 \index[general]{ACL updates}
1179 The whole ACL code had been overhauled and in this version each platforms has
1180 different streams for each type of acl available on such an platform. As ACLs
1181 between platforms tend to be not that portable (most implement POSIX acls but
1182 some use an other draft or a completely different format) we currently only
1183 allow certain platform specific ACL streams to be decoded and restored on the
1184 same platform that they were created on. The old code allowed to restore ACL
1185 cross platform but the comments already mention that not being to wise. For
1186 backward compatability the new code will accept the two old ACL streams and
1187 handle those with the platform specific handler. But for all new backups it
1188 will save the ACLs using the new streams.
1190 Currently the following platforms support ACLs:
1194 \item {\bf Darwin/OSX}
1203 Currently we support the following ACL types (these ACL streams use a reserved
1204 part of the stream numbers):
1207 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1209 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1210 string representation from acl\_to\_text (POSIX acl)
1211 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1212 string representation from acl\_to\_text (POSIX acl) for default acls.
1213 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1214 string representation from acl\_to\_text (POSIX acl) for access acls.
1215 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1216 string representation from acltostr (POSIX acl)
1217 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1218 representation from acl\_to\_text (POSIX acl) for default acls.
1219 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1220 representation from acl\_to\_text (POSIX acl) for access acls.
1221 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1222 string representation from acl\_to\_text (POSIX acl) for default acls.
1223 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1224 representation from acl\_to\_text (POSIX acl) for access acls.
1225 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1226 string representation from acl\_to\_text (POSIX acl) for default acls.
1227 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1228 string representation from acl\_to\_text (POSIX acl) for default acls.
1229 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1230 representation from acl\_to\_text (POSIX acl) for access acls.
1231 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1232 string representation from acltotext or acl\_totext (POSIX acl)
1233 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1234 representation from from acl\_totext (NFSv4 or ZFS acl)
1237 In future versions we might support conversion functions from one type of acl
1238 into an other for types that are either the same or easily convertable. For now
1239 the streams are seperate and restoring them on a platform that doesn't
1240 recognize them will give you a warning.
1242 \subsection{Extended Attributes}
1243 \index[general]{Extended attributes}
1244 Something that was on the project list for some time is now implemented for
1245 platforms that support a similar kind of interface. Its the support for backup
1246 and restore of so called extended attributes. As extended attributes are so
1247 platform specific these attributes are saved in seperate streams for each
1248 platform. Restores of the extended attributes can only be performed on the
1249 same platform the backup was done. There is support for all types of extended
1250 attributes, but restoring from one type of filesystem onto an other type of
1251 filesystem on the same platform may lead to supprises. As extended attributes
1252 can contain any type of data they are stored as a series of so called
1253 value-pairs. This data must be seen as mostly binary and is stored as such.
1254 As security labels from selinux are also extended attributes this option also
1255 stores those labels and no specific code is enabled for handling selinux
1258 Currently the following platforms support extended attributes:
1260 \item {\bf Darwin/OSX}
1266 On linux acls are also extended attributes, as such when you enable ACLs on a
1267 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1268 and not the same exteneded attribute.
1270 To enable the backup of extended attributes please add the following to your
1285 \subsection{Shared objects}
1286 \index[general]{Shared objects}
1287 A default build of Bacula will now create the libraries as shared objects
1288 (.so) rather than static libraries as was previously the case.
1289 The shared libraries are built using {\bf libtool} so it should be quite
1292 An important advantage of using shared objects is that on a machine with the
1293 Directory, File daemon, the Storage daemon, and a console, you will have only
1294 one copy of the code in memory rather than four copies. Also the total size of
1295 the binary release is smaller since the library code appears only once rather
1296 than once for every program that uses it; this results in significant reduction
1297 in the size of the binaries particularly for the utility tools.
1299 In order for the system loader to find the shared objects when loading the
1300 Bacula binaries, the Bacula shared objects must either be in a shared object
1301 directory known to the loader (typically /usr/lib) or they must be in the
1302 directory that may be specified on the {\bf ./configure} line using the {\bf
1303 {-}{-}libdir} option as:
1306 ./configure --libdir=/full-path/dir
1309 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1310 no need to modify your loader configuration provided that
1311 the shared objects are installed in that directory (Bacula
1312 does this with the make install command). The shared objects
1313 that Bacula references are:
1322 These files are symbolically linked to the real shared object file,
1323 which has a version number to permit running multiple versions of
1324 the libraries if desired (not normally the case).
1326 If you have problems with libtool or you wish to use the old
1327 way of building static libraries, or you want to build a static
1328 version of Bacula you may disable
1329 libtool on the configure command line with:
1332 ./configure --disable-libtool
1336 \subsection{Building Static versions of Bacula}
1337 \index[general]{Static linking}
1338 In order to build static versions of Bacula, in addition
1339 to configuration options that were needed you now must
1340 also add --disable-libtool. Example
1343 ./configure --enable-static-client-only --disable-libtool
1347 \subsection{Virtual Backup (Vbackup)}
1348 \index[general]{Virtual backup}
1349 \index[general]{Vbackup}
1351 Bacula's virtual backup feature is often called Synthetic Backup or
1352 Consolidation in other backup products. It permits you to consolidate the
1353 previous Full backup plus the most recent Differential backup and any
1354 subsequent Incremental backups into a new Full backup. This new Full
1355 backup will then be considered as the most recent Full for any future
1356 Incremental or Differential backups. The VirtualFull backup is
1357 accomplished without contacting the client by reading the previous backup
1358 data and writing it to a volume in a different pool.
1360 In some respects the Vbackup feature works similar to a Migration job, in
1361 that Bacula normally reads the data from the pool specified in the
1362 Job resource, and writes it to the {\bf Next Pool} specified in the
1363 Job resource. Note, this means that usually the output from the Virtual
1364 Backup is written into a different pool from where your prior backups
1365 are saved. Doing it this way guarantees that you will not get a deadlock
1366 situation attempting to read and write to the same volume in the Storage
1367 daemon. If you then want to do subsequent backups, you may need to
1368 move the Virtual Full Volume back to your normal backup pool.
1369 Alternatively, you can set your {\bf Next Pool} to point to the current
1370 pool. This will cause Bacula to read and write to Volumes in the
1371 current pool. In general, this will work, because Bacula will
1372 not allow reading and writing on the same Volume. In any case, once
1373 a VirtualFull has been created, and a restore is done involving the
1374 most current Full, it will read the Volume or Volumes by the VirtualFull
1375 regardless of in which Pool the Volume is found.
1377 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1378 a level of {\bf VirtualFull}.
1380 A typical Job resource definition might look like the following:
1387 FileSet = "Full Set"
1394 # Default pool definition
1398 Recycle = yes # Automatically recycle Volumes
1399 AutoPrune = yes # Prune expired volumes
1400 Volume Retention = 365d # one year
1408 Recycle = yes # Automatically recycle Volumes
1409 AutoPrune = yes # Prune expired volumes
1410 Volume Retention = 365d # one year
1411 Storage = DiskChanger
1414 # Definition of file storage device
1419 Device = FileStorage
1421 Maximum Concurrent Jobs = 5
1424 # Definition of DDS Virtual tape disk storage device
1427 Address = localhost # N.B. Use a fully qualified name here
1429 Device = DiskChanger
1430 Media Type = DiskChangerMedia
1431 Maximum Concurrent Jobs = 4
1436 Then in bconsole or via a Run schedule, you would run the job as:
1439 run job=MyBackup level=Full
1440 run job=MyBackup level=Incremental
1441 run job=MyBackup level=Differential
1442 run job=MyBackup level=Incremental
1443 run job=MyBackup level=Incremental
1446 So providing there were changes between each of those jobs, you would end up
1447 with a Full backup, a Differential, which includes the first Incremental
1448 backup, then two Incremental backups. All the above jobs would be written to
1449 the {\bf Default} pool.
1451 To consolidate those backups into a new Full backup, you would run the
1455 run job=MyBackup level=VirtualFull
1458 And it would produce a new Full backup without using the client, and the output
1459 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1461 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1464 Note, the Start and End time of the Virtual Full backup is set to the
1465 values for the last job included in the Virtual Full (in the above example,
1466 it is an Increment). This is so that if another incremental is done, which
1467 will be based on the Virtual Full, it will backup all files from the
1468 last Job included in the Virtual Full rather than from the time the Virtual
1469 Full was actually run.
1473 \subsection{Catalog Format}
1474 \index[general]{Catalog format}
1475 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1476 operation will convert the FileId field of the File table from 32 bits (max 4
1477 billion table entries) to 64 bits (very large number of items). The
1478 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1479 your catalog during the conversion. Also you won't be able to run jobs during
1480 this conversion period. For example, a 3 million file catalog will take 2
1481 minutes to upgrade on a normal machine. Please don't forget to make a valid
1482 backup of your database before executing the upgrade script. See the
1483 ReleaseNotes for additional details.
1485 \subsection{64 bit Windows Client}
1486 \index[general]{Win64 client}
1487 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1488 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1489 As a consequence, we are also releasing a 64 bit version of the Bacula
1490 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1491 These binaries should only be installed on 64 bit Windows operating systems.
1492 What is important is not your hardware but whether or not you have
1493 a 64 bit version of the Windows OS.
1495 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1497 \item Before installing the Win64 Bacula Client, you must totally
1498 deinstall any prior 2.4.x Client installation using the
1499 Bacula deinstallation (see the menu item). You may want
1500 to save your .conf files first.
1501 \item Only the Client (File daemon) is ported to Win64, the Director
1502 and the Storage daemon are not in the 64 bit Windows installer.
1503 \item bwx-console is not yet ported.
1504 \item bconsole is ported but it has not been tested.
1505 \item The documentation is not included in the installer.
1506 \item Due to Vista security restrictions imposed on a default installation
1507 of Vista, before upgrading the Client, you must manually stop
1508 any prior version of Bacula from running, otherwise the install
1510 \item Due to Vista security restrictions imposed on a default installation
1511 of Vista, attempting to edit the conf files via the menu items
1512 will fail. You must directly edit the files with appropriate
1513 permissions. Generally double clicking on the appropriate .conf
1514 file will work providing you have sufficient permissions.
1515 \item All Bacula files are now installed in
1516 {\bf C:/Program Files/Bacula} except the main menu items,
1517 which are installed as before. This vastly simplifies the installation.
1518 \item If you are running on a foreign language version of Windows, most
1519 likely {\bf C:/Program Files} does not exist, so you should use the
1520 Custom installation and enter an appropriate location to install
1522 \item The 3.0.0 Win32 Client continues to install files in the locations used
1523 by prior versions. For the next version we will convert it to use
1524 the same installation conventions as the Win64 version.
1527 This project was funded by Bacula Systems.
1530 \subsection{Duplicate Job Control}
1531 \index[general]{Duplicate jobs}
1532 The new version of Bacula provides four new directives that
1533 give additional control over what Bacula does if duplicate jobs
1534 are started. A duplicate job in the sense we use it here means
1535 a second or subsequent job with the same name starts. This
1536 happens most frequently when the first job runs longer than expected because no
1537 tapes are available.
1539 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1540 are specified in the Job resource.
1544 \subsubsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1545 \index[general]{Allow Duplicate Jobs}
1546 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1547 the directive is set to {\bf no} (default) then only one job of a given name
1548 may run at one time, and the action that Bacula takes to ensure only
1549 one job runs is determined by the other directives (see below).
1551 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1552 are present and none of the three directives given below permit
1553 cancelling a job, then the current job (the second one started)
1556 \subsubsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1557 \index[general]{Allow Higher Duplicates}
1558 This directive was in version 5.0.0, but does not work as
1559 expected. If used, it should always be set to no. In later versions
1560 of Bacula the directive is disabled (disregarded).
1562 \subsubsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1563 \index[general]{Cancel Running Duplicates}
1564 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1565 if this directive is set to {\bf yes} any job that is already running
1566 will be canceled. The default is {\bf no}.
1568 \subsubsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1569 \index[general]{Cancel Queued Duplicates}
1570 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1571 if this directive is set to {\bf yes} any job that is
1572 already queued to run but not yet running will be canceled.
1573 The default is {\bf no}.
1576 \subsection{TLS Authentication}
1577 \index[general]{TLS authentication}
1578 In Bacula version 2.5.x and later, in addition to the normal Bacula
1579 CRAM-MD5 authentication that is used to authenticate each Bacula
1580 connection, you can specify that you want TLS Authentication as well,
1581 which will provide more secure authentication.
1583 This new feature uses Bacula's existing TLS code (normally used for
1584 communications encryption) to do authentication. To use it, you must
1585 specify all the TLS directives normally used to enable communications
1586 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, \ldots{}) and
1589 \subsubsection{TLS Authenticate = yes}
1591 TLS Authenticate = yes
1594 in the main daemon configuration resource (Director for the Director,
1595 Client for the File daemon, and Storage for the Storage daemon).
1597 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1598 authentication, Bacula will also do TLS authentication, then TLS
1599 encryption will be turned off, and the rest of the communication between
1600 the two Bacula daemons will be done without encryption.
1602 If you want to encrypt communications data, use the normal TLS directives
1603 but do not turn on {\bf TLS Authenticate}.
1605 \subsection{bextract non-portable Win32 data}
1606 \index[general]{bextract handles Win32 non-portable data}
1607 \index[general]{Win32!bextract handles non-portable data}
1608 {\bf bextract} has been enhanced to be able to restore
1609 non-portable Win32 data to any OS. Previous versions were
1610 unable to restore non-portable Win32 data to machines that
1611 did not have the Win32 BackupRead and BackupWrite API calls.
1613 \subsection{State File updated at Job Termination}
1614 \index[general]{State file}
1615 In previous versions of Bacula, the state file, which provides a
1616 summary of previous jobs run in the {\bf status} command output was
1617 updated only when Bacula terminated, thus if the daemon crashed, the
1618 state file might not contain all the run data. This version of
1619 the Bacula daemons updates the state file on each job termination.
1621 \subsection{MaxFullInterval = \lt{}time-interval\gt{}}
1622 \index[general]{MaxFullInterval}
1623 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1624 can be used to specify the maximum time interval between {\bf Full} backup
1625 jobs. When a job starts, if the time since the last Full backup is
1626 greater than the specified interval, and the job would normally be an
1627 {\bf Incremental} or {\bf Differential}, it will be automatically
1628 upgraded to a {\bf Full} backup.
1630 \subsection{MaxDiffInterval = \lt{}time-interval\gt{}}
1631 \index[general]{MaxDiffInterval}
1632 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1633 can be used to specify the maximum time interval between {\bf Differential} backup
1634 jobs. When a job starts, if the time since the last Differential backup is
1635 greater than the specified interval, and the job would normally be an
1636 {\bf Incremental}, it will be automatically
1637 upgraded to a {\bf Differential} backup.
1639 \subsection{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1640 \index[general]{MaxDiffInterval}
1641 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1642 by the user, and when it is set it is an indication to backup programs
1643 to not backup that particular file. This version of Bacula contains a
1644 new Options directive within a FileSet resource, which instructs Bacula to
1645 obey this flag. The new directive is:
1648 Honor No Dump Flag = yes\vb{}no
1651 The default value is {\bf no}.
1654 \subsection{Exclude Dir Containing = \lt{}filename-string\gt{}}
1655 \index[general]{IgnoreDir}
1656 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1657 can be added to the Include section of the FileSet resource. If the specified
1658 filename ({\bf filename-string}) is found on the Client in any directory to be
1659 backed up, the whole directory will be ignored (not backed up). For example:
1662 # List of files to be backed up
1670 Exclude Dir Containing = .excludeme
1675 But in /home, there may be hundreds of directories of users and some
1676 people want to indicate that they don't want to have certain
1677 directories backed up. For example, with the above FileSet, if
1678 the user or sysadmin creates a file named {\bf .excludeme} in
1679 specific directories, such as
1682 /home/user/www/cache/.excludeme
1683 /home/user/temp/.excludeme
1686 then Bacula will not backup the two directories named:
1689 /home/user/www/cache
1693 NOTE: subdirectories will not be backed up. That is, the directive
1694 applies to the two directories in question and any children (be they
1695 files, directories, etc).
1697 \subsubsection{bfuncs}
1698 The bFuncs structure defines the callback entry points within Bacula
1699 that the plugin can use register events, get Bacula values, set
1700 Bacula values, and send messages to the Job output or debug output.
1702 The exact definition as of this writing is:
1704 typedef struct s_baculaFuncs {
1707 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
1708 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
1709 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
1710 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
1711 int type, utime_t mtime, const char *fmt, ...);
1712 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
1713 int level, const char *fmt, ...);
1714 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
1716 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
1718 /* New functions follow */
1719 bRC (*AddExclude)(bpContext *ctx, const char *file);
1720 bRC (*AddInclude)(bpContext *ctx, const char *file);
1721 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
1722 bRC (*AddRegexToInclude)(bpContext *ctx, const char *item, int type);
1723 bRC (*AddWildToInclude)(bpContext *ctx, const char *item, int type);
1729 \item [AddExclude] can be called to exclude a file. The file
1730 string passed may include wildcards that will be interpreted by
1731 the {\bf fnmatch} subroutine. This function can be called
1732 multiple times, and each time the file specified will be added
1733 to the list of files to be excluded. Note, this function only
1734 permits adding excludes of specific file or directory names,
1735 or files matched by the rather simple fnmatch mechanism.
1736 See below for information on doing wild-card and regex excludes.
1738 \item [NewInclude] can be called to create a new Include block. This
1739 block will be added before any user defined Include blocks. This
1740 function can be called multiple times, but each time, it will create
1741 a new Include section (not normally needed). This function should
1742 be called only if you want to add an entirely new Include block.
1744 \item [AddInclude] can be called to add new files/directories to
1745 be included. They are added to the current Include block. If
1746 NewInclude has not been included, the current Include block is
1747 the last one that the user created. This function
1748 should be used only if you want to add totally new files/directories
1749 to be included in the backup.
1751 \item [NewOptions] adds a new Options block to the current Include
1752 in front of any other Options blocks. This permits the plugin to
1753 add exclude directives (wild-cards and regexes) in front of the
1754 user Options, and thus prevent certain files from being backed up.
1755 This can be useful if the plugin backs up files, and they should
1756 not be also backed up by the main Bacula code. This function
1757 may be called multiple times, and each time, it creates a new
1758 prepended Options block. Note: normally you want to call this
1759 entry point prior to calling AddOptions, AddRegex, or AddWild.
1761 \item [AddOptions] allows the plugin it set options in
1762 the current Options block, which is normally created with the
1763 NewOptions call just prior to adding Include Options.
1764 The permitted options are passed as a character string, where
1765 each character has a specific meaning as defined below:
1768 \item [a] always replace files (default).
1769 \item [e] exclude rather than include.
1770 \item [h] no recursion into subdirectories.
1771 \item [H] do not handle hard links.
1772 \item [i] ignore case in wildcard and regex matches.
1773 \item [M] compute an MD5 sum.
1774 \item [p] use a portable data format on Windows (not recommended).
1775 \item [R] backup resource forks and Findr Info.
1776 \item [r] read from a fifo
1777 \item [S1] compute an SHA1 sum.
1778 \item [S2] compute an SHA256 sum.
1779 \item [S3] comput an SHA512 sum.
1780 \item [s] handle sparse files.
1781 \item [m] use st\_mtime only for file differences.
1782 \item [k] restore the st\_atime after accessing a file.
1783 \item [A] enable ACL backup.
1784 \item [Vxxx:] specify verify options. Must terminate with :
1785 \item [Cxxx:] specify accurate options. Must terminate with :
1786 \item [Jxxx:] specify base job Options. Must terminate with :
1787 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
1789 \item [Zn] specify gzip compression level n.
1790 \item [K] do not use st\_atime in backup decision.
1791 \item [c] check if file changed during backup.
1792 \item [N] honor no dump flag.
1793 \item [X] enable backup of extended attributes.
1796 \item [AddRegex] adds a regex expression to the current Options block.
1797 The fillowing options are permitted:
1799 \item [ ] (a blank) regex applies to whole path and filename.
1800 \item [F] regex applies only to the filename (directory or path stripped).
1801 \item [D] regex applies only to the directory (path) part of the name.
1804 \item [AddWild] adds a wildcard expression to the current Options block.
1805 The fillowing options are permitted:
1807 \item [ ] (a blank) regex applies to whole path and filename.
1808 \item [F] regex applies only to the filename (directory or path stripped).
1809 \item [D] regex applies only to the directory (path) part of the name.
1815 \subsubsection{Bacula events}
1816 The list of events has been extended to include:
1822 bEventStartBackupJob = 3,
1823 bEventEndBackupJob = 4,
1824 bEventStartRestoreJob = 5,
1825 bEventEndRestoreJob = 6,
1826 bEventStartVerifyJob = 7,
1827 bEventEndVerifyJob = 8,
1828 bEventBackupCommand = 9,
1829 bEventRestoreCommand = 10,
1834 bEventCancelCommand = 13,
1835 bEventVssBackupAddComponents = 14,
1836 bEventVssRestoreLoadComponentMetadata = 15,
1837 bEventVssRestoreSetComponentsSelected = 16,
1838 bEventRestoreObject = 17,
1839 bEventEndFileSet = 18,
1840 bEventPluginCommand = 19
1846 \item [bEventCancelCommand] is called whenever the currently
1847 running Job is cancelled
1849 \item [bEventVssBackupAddComponents]
1850 \item [bEventPluginCommand] is called for each PluginCommand present in the
1851 current FileSet. The event will be sent only on plugin specifed in the
1852 command. The argument is the PluginCommand (read-only).
1856 \subsection{Bacula Plugins}
1857 \index[general]{Plugin}
1858 Support for shared object plugins has been implemented in the Linux, Unix
1859 and Win32 File daemons. The API will be documented separately in
1860 the Developer's Guide or in a new document. For the moment, there is
1861 a single plugin named {\bf bpipe} that allows an external program to
1862 get control to backup and restore a file.
1864 Plugins are also planned (partially implemented) in the Director and the
1867 \subsubsection{Plugin Directory}
1868 \index[general]{Plugin Directory}
1869 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1870 be added to the daemon definition resource. The directory takes a quoted
1871 string argument, which is the name of the directory in which the daemon can
1872 find the Bacula plugins. If this directive is not specified, Bacula will not
1873 load any plugins. Since each plugin has a distinctive name, all the daemons
1874 can share the same plugin directory.
1876 \subsubsection{Plugin Options}
1877 \index[general]{Plugin Options}
1878 The {\bf Plugin Options} directive takes a quoted string
1879 arguement (after the equal sign) and may be specified in the
1880 Job resource. The options specified will be passed to all plugins
1881 when they are run. This each plugin must know what it is looking
1882 for. The value defined in the Job resource can be modified
1883 by the user when he runs a Job via the {\bf bconsole} command line
1886 Note: this directive may be specified, and there is code to modify
1887 the string in the run command, but the plugin options are not yet passed to
1888 the plugin (i.e. not fully implemented).
1890 \subsubsection{Plugin Options ACL}
1891 \index[general]{Plugin Options ACL}
1892 The {\bf Plugin Options ACL} directive may be specified in the
1893 Director's Console resource. It functions as all the other ACL commands
1894 do by permitting users running restricted consoles to specify a
1895 {\bf Plugin Options} that overrides the one specified in the Job
1896 definition. Without this directive restricted consoles may not modify
1899 \subsubsection{Plugin = \lt{}plugin-command-string\gt{}}
1900 \index[general]{Plugin}
1901 The {\bf Plugin} directive is specified in the Include section of
1902 a FileSet resource where you put your {\bf File = xxx} directives.
1913 Plugin = "bpipe:..."
1918 In the above example, when the File daemon is processing the directives
1919 in the Include section, it will first backup all the files in {\bf /home}
1920 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1921 the Plugin Directory. The syntax and semantics of the Plugin directive
1922 require the first part of the string up to the colon (:) to be the name
1923 of the plugin. Everything after the first colon is ignored by the File daemon but
1924 is passed to the plugin. Thus the plugin writer may define the meaning of the
1925 rest of the string as he wishes.
1927 Please see the next section for information about the {\bf bpipe} Bacula
1930 \subsection{The bpipe Plugin}
1931 \index[general]{The bpipe plugin}
1932 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1933 the Bacula source distribution. When the plugin is compiled and linking into
1934 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1935 Please note that this is a very simple plugin that was written for
1936 demonstration and test purposes. It is and can be used in production, but
1937 that was never really intended.
1939 The purpose of the plugin is to provide an interface to any system program for
1940 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1941 the Include section of your Job's FileSet resource. The full syntax of the
1942 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1943 to specify the sytax as it wishes) is:
1946 Plugin = "<field1>:<field2>:<field3>:<field4>"
1951 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1952 stripped off, so in this case, we would put {\bf bpipe} in this field.
1954 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1955 pseudo path and filename under which the backup will be saved. This pseudo
1956 path and filename will be seen by the user in the restore file tree.
1957 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1958 backed up by the plugin will be put under that "pseudo" path and filename.
1959 You must be careful to choose a naming convention that is unique to avoid
1960 a conflict with a path and filename that actually exists on your system.
1962 \item {\bf field3} for the {\bf bpipe} plugin
1963 specifies the "reader" program that is called by the plugin during
1964 backup to read the data. {\bf bpipe} will call this program by doing a
1967 \item {\bf field4} for the {\bf bpipe} plugin
1968 specifies the "writer" program that is called by the plugin during
1969 restore to write the data back to the filesystem.
1972 Please note that for two items above describing the "reader" and "writer"
1973 fields, these programs are "executed" by Bacula, which
1974 means there is no shell interpretation of any command line arguments
1975 you might use. If you want to use shell characters (redirection of input
1976 or output, \ldots{}), then we recommend that you put your command or commands
1977 in a shell script and execute the script. In addition if you backup a
1978 file with the reader program, when running the writer program during
1979 the restore, Bacula will not automatically create the path to the file.
1980 Either the path must exist, or you must explicitly do so with your command
1981 or in a shell script.
1983 Putting it all together, the full plugin directive line might look
1987 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1988 --opt --databases bacula:mysql"
1991 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1992 would be written on a single line.
1994 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1995 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1996 program {\bf mysqldump -f --opt --database bacula} to read the data during
1997 backup. The mysqldump command outputs all the data for the database named
1998 {\bf bacula}, which will be read by the plugin and stored in the backup.
1999 During restore, the data that was backed up will be sent to the program
2000 specified in the last field, which in this case is {\bf mysql}. When
2001 {\bf mysql} is called, it will read the data sent to it by the plugn
2002 then write it back to the same database from which it came ({\bf bacula}
2005 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2006 the data from a specified program to Bacula for backup, and then from Bacula to
2007 a specified program for restore.
2009 By using different command lines to {\bf bpipe},
2010 you can backup any kind of data (ASCII or binary) depending
2011 on the program called.
2013 \subsection{Microsoft Exchange Server 2003/2007 Plugin}
2014 \index[general]{Microsoft Exchange Server 2003/2007 plugin}
2015 \subsubsection{Background}
2016 The Exchange plugin was made possible by a funded development project
2017 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2018 The code for the plugin was written by James Harper, and the Bacula core
2019 code by Kern Sibbald. All the code for this funded development has become
2020 part of the Bacula project. Thanks to everyone who made it happen.
2022 \subsubsection{Concepts}
2023 Although it is possible to backup Exchange using Bacula VSS the Exchange
2024 plugin adds a good deal of functionality, because while Bacula VSS
2025 completes a full backup (snapshot) of Exchange, it does
2026 not support Incremental or Differential backups, restoring is more
2027 complicated, and a single database restore is not possible.
2029 Microsoft Exchange organises its storage into Storage Groups with
2030 Databases inside them. A default installation of Exchange will have a
2031 single Storage Group called 'First Storage Group', with two Databases
2032 inside it, "Mailbox Store (SERVER NAME)" and
2033 "Public Folder Store (SERVER NAME)",
2034 which hold user email and public folders respectively.
2036 In the default configuration, Exchange logs everything that happens to
2037 log files, such that if you have a backup, and all the log files since,
2038 you can restore to the present time. Each Storage Group has its own set
2039 of log files and operates independently of any other Storage Groups. At
2040 the Storage Group level, the logging can be turned off by enabling a
2041 function called "Enable circular logging". At this time the Exchange
2042 plugin will not function if this option is enabled.
2044 The plugin allows backing up of entire storage groups, and the restoring
2045 of entire storage groups or individual databases. Backing up and
2046 restoring at the individual mailbox or email item is not supported but
2047 can be simulated by use of the "Recovery" Storage Group (see below).
2049 \subsubsection{Installing}
2050 The Exchange plugin requires a DLL that is shipped with Microsoft
2051 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2052 correctly the Exchange plugin should find this automatically and run
2053 without any additional installation.
2055 If the DLL can not be found automatically it will need to be copied into
2056 the Bacula installation
2057 directory (eg C:\lstinline+\+Program Files\lstinline+\+Bacula\lstinline+\+bin). The Exchange API DLL is
2058 named esebcli2.dll and is found in C:\lstinline+\+Program Files\lstinline+\+Exchsrvr\lstinline+\+bin on a
2059 default Exchange installation.
2061 \subsubsection{Backing Up}
2062 To back up an Exchange server the Fileset definition must contain at
2063 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2064 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2065 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2066 up files are prefixed with something that isn't going to share a name
2067 with something outside the plugin, and the 'Microsoft Information Store'
2068 bit is required also. It is also possible to add the name of a storage
2069 group to the "Plugin =" line, eg \\
2070 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2071 if you want only a single storage group backed up.
2073 Additionally, you can suffix the 'Plugin =' directive with
2074 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2075 database at the end of a full backup.
2077 An Incremental or Differential backup will backup only the database logs
2078 for each Storage Group by inspecting the "modified date" on each
2079 physical log file. Because of the way the Exchange API works, the last
2080 logfile backed up on each backup will always be backed up by the next
2081 Incremental or Differential backup too. This adds 5MB to each
2082 Incremental or Differential backup size but otherwise does not cause any
2085 By default, a normal VSS fileset containing all the drive letters will
2086 also back up the Exchange databases using VSS. This will interfere with
2087 the plugin and Exchange's shared ideas of when the last full backup was
2088 done, and may also truncate log files incorrectly. It is important,
2089 therefore, that the Exchange database files be excluded from the backup,
2090 although the folders the files are in should be included, or they will
2091 have to be recreated manually if a baremetal restore is done.
2096 File = C:/Program Files/Exchsrvr/mdbdata
2097 Plugin = "exchange:..."
2100 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2101 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2102 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2103 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2104 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2105 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2106 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2111 The advantage of excluding the above files is that you can significantly
2112 reduce the size of your backup since all the important Exchange files
2113 will be properly saved by the Plugin.
2116 \subsubsection{Restoring}
2117 The restore operation is much the same as a normal Bacula restore, with
2118 the following provisos:
2121 \item The {\bf Where} restore option must not be specified
2122 \item Each Database directory must be marked as a whole. You cannot just
2123 select (say) the .edb file and not the others.
2124 \item If a Storage Group is restored, the directory of the Storage Group
2126 \item It is possible to restore only a subset of the available log files,
2127 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2128 if a log file is missing from the sequence of log files
2129 \item Each database to be restored must be dismounted and marked as "Can be
2130 overwritten by restore"
2131 \item If an entire Storage Group is to be restored (eg all databases and
2132 logs in the Storage Group), then it is best to manually delete the
2133 database files from the server (eg C:\lstinline+\+Program Files\lstinline+\+Exchsrvr\lstinline+\+mdbdata\lstinline+\+*)
2134 as Exchange can get confused by stray log files lying around.
2137 \subsubsection{Restoring to the Recovery Storage Group}
2138 The concept of the Recovery Storage Group is well documented by
2140 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2141 but to briefly summarize\ldots{}
2143 Microsoft Exchange allows the creation of an additional Storage Group
2144 called the Recovery Storage Group, which is used to restore an older
2145 copy of a database (e.g. before a mailbox was deleted) into without
2146 messing with the current live data. This is required as the Standard and
2147 Small Business Server versions of Exchange can not ordinarily have more
2148 than one Storage Group.
2150 To create the Recovery Storage Group, drill down to the Server in Exchange
2151 System Manager, right click, and select
2152 {\bf "New -> Recovery Storage Group\ldots{}"}. Accept or change the file
2153 locations and click OK. On the Recovery Storage Group, right click and
2154 select {\bf "Add Database to Recover\ldots{}"} and select the database you will
2157 Restore only the single database nominated as the database in the
2158 Recovery Storage Group. Exchange will redirect the restore to the
2159 Recovery Storage Group automatically.
2160 Then run the restore.
2162 \subsubsection{Restoring on Microsoft Server 2007}
2163 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2164 2007, and henc you use a new proceedure for recovering a single mail box.
2165 This procedure is ducomented by Microsoft at:
2166 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2167 and involves using the {\bf Restore-Mailbox} and {\bf
2168 Get-MailboxStatistics} shell commands.
2170 \subsubsection{Caveats}
2171 This plugin is still being developed, so you should consider it
2172 currently in BETA test, and thus use in a production environment
2173 should be done only after very careful testing.
2175 When doing a full backup, the Exchange database logs are truncated by
2176 Exchange as soon as the plugin has completed the backup. If the data
2177 never makes it to the backup medium (eg because of spooling) then the
2178 logs will still be truncated, but they will also not have been backed
2179 up. A solution to this is being worked on. You will have to schedule a
2180 new Full backup to ensure that your next backups will be usable.
2182 The "Enable Circular Logging" option cannot be enabled or the plugin
2185 Exchange insists that a successful Full backup must have taken place if
2186 an Incremental or Differential backup is desired, and the plugin will
2187 fail if this is not the case. If a restore is done, Exchange will
2188 require that a Full backup be done before an Incremental or Differential
2191 The plugin will most likely not work well if another backup application
2192 (eg NTBACKUP) is backing up the Exchange database, especially if the
2193 other backup application is truncating the log files.
2195 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2196 we recommend either carefully testing or that you avoid this option for
2199 The Exchange plugin is not called during processing the bconsole {\bf
2200 estimate} command, and so anything that would be backed up by the plugin
2201 will not be added to the estimate total that is displayed.
2204 \subsection{libdbi Framework}
2205 \index[general]{libdbi framework}
2206 As a general guideline, Bacula has support for a few catalog database drivers
2207 (MySQL, PostgreSQL, SQLite)
2208 coded natively by the Bacula team. With the libdbi implementation, which is a
2209 Bacula driver that uses libdbi to access the catalog, we have an open field to
2210 use many different kinds database engines following the needs of users.
2212 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2213 implements a database-independent abstraction layer in C, similar to the
2214 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2215 leverage the power of multiple databases and multiple simultaneous database
2216 connections by using this framework.
2218 Currently the libdbi driver in Bacula project only supports the same drivers
2219 natively coded in Bacula. However the libdbi project has support for many
2220 others database engines. You can view the list at
2221 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2222 supported by Bacula, however, they must be tested properly by the Bacula team.
2224 Some of benefits of using libdbi are:
2226 \item The possibility to use proprietary databases engines in which your
2227 proprietary licenses prevent the Bacula team from developing the driver.
2228 \item The possibility to use the drivers written for the libdbi project.
2229 \item The possibility to use other database engines without recompiling Bacula
2230 to use them. Just change one line in bacula-dir.conf
2231 \item Abstract Database access, this is, unique point to code and profiling
2232 catalog database access.
2235 The following drivers have been tested:
2237 \item PostgreSQL, with and without batch insert
2238 \item Mysql, with and without batch insert
2243 In the future, we will test and approve to use others databases engines
2244 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2246 To compile Bacula to support libdbi we need to configure the code with the
2247 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2248 [database] is the database engine to be used with Bacula (of course we can
2249 change the driver in file bacula-dir.conf, see below). We must configure the
2250 access port of the database engine with the option --with-db-port, because the
2251 libdbi framework doesn't know the default access port of each database.
2253 The next phase is checking (or configuring) the bacula-dir.conf, example:
2257 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2258 dbname = regress; user = regress; password = ""
2262 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2263 mysql database. Currently the drivers supported by Bacula are: postgresql,
2264 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2266 The following limitations apply when Bacula is set to use the libdbi framework:
2267 - Not tested on the Win32 platform
2268 - A little performance is lost if comparing with native database driver.
2269 The reason is bound with the database driver provided by libdbi and the
2270 simple fact that one more layer of code was added.
2272 It is important to remember, when compiling Bacula with libdbi, the
2273 following packages are needed:
2275 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2276 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2279 You can download them and compile them on your system or install the packages
2280 from your OS distribution.
2282 \subsection{Console Command Additions and Enhancements}
2283 \index[general]{Console additions}
2285 \subsubsection{Display Autochanger Content}
2286 \index[general]{StatusSlots}
2288 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2289 autochanger content.
2293 Slot | Volume Name | Status | Media Type | Pool |
2294 ------+---------------+----------+-------------------+------------|
2295 1 | 00001 | Append | DiskChangerMedia | Default |
2296 2 | 00002 | Append | DiskChangerMedia | Default |
2297 3*| 00003 | Append | DiskChangerMedia | Scratch |
2302 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2303 {\bf update slots} command to synchronize autochanger content with your
2306 \subsubsection{list joblog job=xxx or jobid=nnn}
2307 \index[general]{list joblog}
2308 A new list command has been added that allows you to list the contents
2309 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2310 or for a particular JobId. The {\bf llist} command will include a line with
2311 the time and date of the entry.
2313 Note for the catalog to have Job Log entries, you must have a directive
2320 In your Director's {\bf Messages} resource.
2322 \subsubsection{Use separator for multiple commands}
2323 \index[general]{Command separator}
2324 When using bconsole with readline, you can set the command separator with
2325 \textbf{@separator} command to one
2326 of those characters to write commands who require multiple input in one line.
2328 !$%&'()*+,-/:;<>?[]^`{|}~
2331 \subsubsection{Deleting Volumes}
2332 The delete volume bconsole command has been modified to
2333 require an asterisk (*) in front of a MediaId otherwise the
2334 value you enter is a taken to be a Volume name. This is so that
2335 users may delete numeric Volume names. The previous Bacula versions
2336 assumed that all input that started with a number was a MediaId.
2338 This new behavior is indicated in the prompt if you read it
2341 \subsection{Bare Metal Recovery}
2342 The old bare metal recovery project is essentially dead. One
2343 of the main features of it was that it would build a recovery
2344 CD based on the kernel on your system. The problem was that
2345 every distribution has a different boot procedure and different
2346 scripts, and worse yet, the boot procedures and scripts change
2347 from one distribution to another. This meant that maintaining
2348 (keeping up with the changes) the rescue CD was too much work.
2350 To replace it, a new bare metal recovery USB boot stick has been developed
2351 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2352 boot from a USB key.
2356 \item Recovery can be done from within graphical environment.
2357 \item Recovery can be done in a shell.
2358 \item Ubuntu boots on a large number of Linux systems.
2359 \item The process of updating the system and adding new
2360 packages is not too difficult.
2361 \item The USB key can easily be upgraded to newer Ubuntu versions.
2362 \item The USB key has writable partitions for modifications to
2363 the OS and for modification to your home directory.
2364 \item You can add new files/directories to the USB key very easily.
2365 \item You can save the environment from multiple machines on
2367 \item Bacula Systems is funding its ongoing development.
2370 The disadvantages are:
2372 \item The USB key is usable but currently under development.
2373 \item Not everyone may be familiar with Ubuntu (no worse
2375 \item Some older OSes cannot be booted from USB. This can
2376 be resolved by first booting a Ubuntu LiveCD then plugging
2378 \item Currently the documentation is sketchy and not yet added
2379 to the main manual. See below \ldots{}
2382 The documentation and the code can be found in the {\bf rescue} package
2383 in the directory {\bf linux/usb}.
2385 \subsection{Miscellaneous}
2386 \index[general]{Misc new features}
2388 \subsubsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2389 \index[general]{Allow Mixed Priority}
2390 This directive is only implemented in version 2.5 and later. When
2391 set to {\bf yes} (default {\bf no}), this job may run even if lower
2392 priority jobs are already running. This means a high priority job
2393 will not have to wait for other jobs to finish before starting.
2394 The scheduler will only mix priorities when all running jobs have
2397 Note that only higher priority jobs will start early. Suppose the
2398 director will allow two concurrent jobs, and that two jobs with
2399 priority 10 are running, with two more in the queue. If a job with
2400 priority 5 is added to the queue, it will be run as soon as one of
2401 the running jobs finishes. However, new priority 10 jobs will not
2402 be run until the priority 5 job has finished.
2404 \subsubsection{Bootstrap File Directive -- FileRegex}
2405 \index[general]{Bootstrap File directive}
2406 {\bf FileRegex} is a new command that can be added to the bootstrap
2407 (.bsr) file. The value is a regular expression. When specified, only
2408 matching filenames will be restored.
2410 During a restore, if all File records are pruned from the catalog
2411 for a Job, normally Bacula can restore only all files saved. That
2412 is there is no way using the catalog to select individual files.
2413 With this new feature, Bacula will ask if you want to specify a Regex
2414 expression for extracting only a part of the full backup.
2417 Building directory tree for JobId(s) 1,3 ...
2418 There were no files inserted into the tree, so file selection
2419 is not possible.Most likely your retention policy pruned the files
2421 Do you want to restore all the files? (yes\vb{}no): no
2423 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2424 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2427 \subsubsection{Bootstrap File Optimization Changes}
2428 In order to permit proper seeking on disk files, we have extended the bootstrap
2429 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2430 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2431 address range and end address range respectively. These two directives replace
2432 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2433 VolEndBlock} directives. Bootstrap files containing the old directives will
2434 still work, but will not properly take advantage of proper disk seeking, and
2435 may read completely to the end of a disk volume during a restore. With the new
2436 format (automatically generated by the new Director), restores will seek
2437 properly and stop reading the volume when all the files have been restored.
2439 \subsubsection{Solaris ZFS/NFSv4 ACLs}
2440 This is an upgrade of the previous Solaris ACL backup code
2441 to the new library format, which will backup both the old
2442 POSIX(UFS) ACLs as well as the ZFS ACLs.
2444 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2445 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2446 be used to transfer from UFS to ZFS filesystems.
2449 \subsubsection{Virtual Tape Emulation}
2450 \index[general]{Virtual tape emulation}
2451 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2452 the tape code but actually reading and writing to a disk file. Used with the
2453 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2454 and 700 slots. This feature is most useful in testing. It is enabled
2455 by using {\bf Device Type = vtape} in the Storage daemon's Device
2456 directive. This feature is only implemented on Linux machines and should not be
2457 used for production.
2459 \subsubsection{Bat Enhancements}
2460 \index[general]{Bat enhancements}
2461 Bat (the Bacula Administration Tool) GUI program has been significantly
2462 enhanced and stabilized. In particular, there are new table based status
2463 commands; it can now be easily localized using Qt4 Linguist.
2465 The Bat communications protocol has been significantly enhanced to improve
2466 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2467 the Director you are using otherwise the communications protocol will not
2470 \subsubsection{RunScript Enhancements}
2471 \index[general]{RunScript enhancements}
2472 The {\bf RunScript} resource has been enhanced to permit multiple
2473 commands per RunScript. Simply specify multiple {\bf Command} directives
2480 Command = "/bin/echo test"
2481 Command = "/bin/echo an other test"
2482 Command = "/bin/echo 3 commands in the same runscript"
2489 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2490 implemented, which runs the command after the Volume Shadow Copy has been made.
2492 Console commands can be specified within a RunScript by using:
2493 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2494 carefully tested and debugged and is known to easily crash the Director.
2495 We would appreciate feedback. Due to the recursive nature of this command, we
2496 may remove it before the final release.
2498 \subsubsection{Status Enhancements}
2499 \index[general]{Status enhancements}
2500 The bconsole {\bf status dir} output has been enhanced to indicate
2501 Storage daemon job spooling and despooling activity.
2503 \subsubsection{Connect Timeout}
2504 \index[general]{Connect timeout}
2505 The default connect timeout to the File
2506 daemon has been set to 3 minutes. Previously it was 30 minutes.
2508 \subsubsection{ftruncate for NFS Volumes}
2509 \index[general]{ftruncate for NFS volumes}
2510 If you write to a Volume mounted by NFS (say on a local file server),
2511 in previous Bacula versions, when the Volume was recycled, it was not
2512 properly truncated because NFS does not implement ftruncate (file
2513 truncate). This is now corrected in the new version because we have
2514 written code (actually a kind user) that deletes and recreates the Volume,
2515 thus accomplishing the same thing as a truncate.
2517 \subsubsection{Support for Ubuntu}
2518 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2519 version of Linux, and thus now provides correct autostart routines.
2520 Since Ubuntu officially supports Bacula, you can also obtain any
2521 recent release of Bacula from the Ubuntu repositories.
2523 \subsubsection{Recycle Pool = \lt{}pool-name\gt{}}
2524 \index[general]{Recycle Pool}
2525 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2526 be placed (moved) when it is recycled. Without this directive, a Volume will
2527 remain in the same pool when it is recycled. With this directive, it can be
2528 moved automatically to any existing pool during a recycle. This directive is
2529 probably most useful when defined in the Scratch pool, so that volumes will
2530 be recycled back into the Scratch pool.
2532 \subsubsection{FD Version}
2533 \index[general]{FD version}
2534 The File daemon to Director protocol now includes a version
2535 number, which although there is no visible change for users,
2536 will help us in future versions automatically determine
2537 if a File daemon is not compatible.
2539 \subsubsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2540 \index[general]{Max Run Sched Time}
2541 The time specifies the maximum allowed time that a job may run, counted from
2542 when the job was scheduled. This can be useful to prevent jobs from running
2543 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2546 \subsubsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2547 \index[general]{Max Wait Time}
2548 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2549 of checking the maximum allowed time that a job may block for a resource,
2550 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2551 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2552 their job depending on the level. Now, they have to use
2553 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2554 directives are now deprecated.
2556 \subsubsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2557 \index[general]{Incremental Max Wait Time}
2558 \index[general]{Differential Max Wait Time}
2560 These directives have been deprecated in favor of
2561 \texttt{Incremental|Differential Max Run Time}.
2563 \subsubsection{Max Run Time directives}
2564 \index[general]{Max Run Time directives}
2565 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2566 maximum allowed time that a job can run depending on the level.
2568 %\addcontentsline{lof}{figure}{Job time control directives}
2569 \bsysimageH{different_time}{Job time control directives}{}
2570 %\includegraphics{\idir different_time}
2572 \subsubsection{Statistics Enhancements}
2573 \index[general]{Statistics enhancements}
2574 If you (or probably your boss) want to have statistics on your backups to
2575 provide some \textit{Service Level Agreement} indicators, you could use a few
2576 SQL queries on the Job table to report how many:
2580 \item jobs have been successful
2581 \item files have been backed up
2585 However, these statistics are accurate only if your job retention is greater
2586 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2587 be able to use them.
2589 Now, you can use the \textbf{update stats [days=num]} console command to fill
2590 the JobHistory table with new Job records. If you want to be sure to take in
2591 account only \textbf{good jobs}, ie if one of your important job has failed but
2592 you have fixed the problem and restarted it on time, you probably want to
2593 delete the first \textit{bad} job record and keep only the successful one. For
2594 that simply let your staff do the job, and update JobHistory table after two or
2595 three days depending on your organization using the \textbf{[days=num]} option.
2597 These statistics records aren't used for restoring, but mainly for
2598 capacity planning, billings, etc.
2600 The Bweb interface provides a statistics module that can use this feature. You
2601 can also use tools like Talend or extract information by yourself.
2603 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2604 the length of time that Bacula will keep statistics job records in the Catalog
2605 database after the Job End time. (In \texttt{JobHistory} table) When this time
2606 period expires, and if user runs \texttt{prune stats} command, Bacula will
2607 prune (remove) Job records that are older than the specified period.
2609 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2610 job to maintain statistics.
2613 Name = BackupCatalog
2616 Console = "update stats days=3"
2617 Console = "prune stats yes"
2624 \subsubsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2625 \index[general]{Scratch Pool}
2626 This directive permits to specify a specific \textsl{Scratch} pool for the
2627 current pool. This is useful when using multiple storage sharing the same
2628 mediatype or when you want to dedicate volumes to a particular set of pool.
2630 \subsubsection{Enhanced Attribute Despooling}
2631 \index[general]{Attribute despooling}
2632 If the storage daemon and the Director are on the same machine, the spool file
2633 that contains attributes is read directly by the Director instead of being
2634 transmitted across the network. That should reduce load and speedup insertion.
2636 \subsubsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2637 \index[general]{Spool Size}
2638 A new Job directive permits to specify the spool size per job. This is used
2639 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2641 \subsubsection{MaximumConsoleConnections = \lt{}number\gt{}}
2642 \index[general]{Maximum Console Connections}
2643 A new director directive permits to specify the maximum number of Console
2644 Connections that could run concurrently. The default is set to 20, but you may
2645 set it to a larger number.
2647 \subsubsection{VerId = \lt{}string\gt{}}
2648 \index[general]{VerId}
2649 A new director directive permits to specify a personnal identifier that will be
2650 displayed in the \texttt{version} command.
2652 \subsubsection{dbcheck enhancements}
2653 \index[general]{dbcheck enhancements}
2654 If you are using Mysql, dbcheck will now ask you if you want to create
2655 temporary indexes to speed up orphaned Path and Filename elimination.
2657 A new \texttt{-B} option allows you to print catalog information in a simple
2658 text based format. This is useful to backup it in a secure way.
2673 You can now specify the database connection port in the command line.
2675 \subsubsection{{-}{-}docdir configure option}
2676 \index[general]{{-}{-}docdir configure option}
2677 You can use {-}{-}docdir= on the ./configure command to
2678 specify the directory where you want Bacula to install the
2679 LICENSE, ReleaseNotes, ChangeLog, \ldots{} files. The default is
2680 {\bf /usr/share/doc/bacula}.
2682 \subsubsection{{-}{-}htmldir configure option}
2683 \index[general]{{-}{-}htmldir configure option}
2684 You can use {-}{-}htmldir= on the ./configure command to
2685 specify the directory where you want Bacula to install the bat html help
2686 files. The default is {\bf /usr/share/doc/bacula/html}
2688 \subsubsection{{-}{-}with-plugindir configure option}
2689 \index[general]{{-}{-}plugindir configure option}
2690 You can use {-}{-}plugindir= on the ./configure command to
2691 specify the directory where you want Bacula to install
2692 the plugins (currently only bpipe-fd). The default is