5 \chapter{New Features in 3.1.4 (Development Version}
6 \label{NewFeaturesChapter}
8 This chapter presents the new features that are currently under development
9 in the 3.1.x versions to be released as Bacula version 3.2.0 sometime in
10 late 2009 or early 2010.
12 \section{Truncate volume after purge}
13 \label{sec:actiononpurge}
15 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
16 the volume when it is purged. It is useful to prevent disk based volumes from
17 consuming too much space.
22 Action On Purge = Truncate
27 \section{Maximum Concurent Jobs for Devices}
28 \label{sec:maximumconcurentjobdevice}
30 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
31 Daemon configuration permits setting the maximum number of Jobs that can
32 run concurrently on a specified Device. Using this directive, it is
33 possible to have different Jobs using multiple drives, because when the
34 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
35 Jobs on any other available compatible drive. This facilitates writing to
36 multiple drives with multiple Jobs that all use the same Pool.
38 \section{Restore from Multiple Storage Daemons}
39 \index[general]{Restore}
41 Previously, you were able to restore from multiple devices in a single Storage
42 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
43 example, if your full backup runs on a Storage Daemon with an autochanger, and
44 your incremental jobs use another Storage Daemon with lots of disks, Bacula
45 will switch automatically from one Storage Daemon to an other within the same
48 You must upgrade your File Daemon to version 3.1.3 or greater to use this feature.
50 This project was funded by Bacula Systems with the help of Equiinet.
52 \section{File Deduplication using Base Jobs}
53 A base job is sort of like a Full save except that you will want the FileSet to
54 contain only files that are unlikely to change in the future (i.e. a snapshot
55 of most of your system after installing it). After the base job has been run,
56 when you are doing a Full save, you specify one or more Base jobs to be used.
57 All files that have been backed up in the Base job/jobs but not modified will
58 then be excluded from the backup. During a restore, the Base jobs will be
59 automatically pulled in where necessary.
61 This is something none of the competition does, as far as we know (except
62 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
63 win for the user, it makes Bacula stand out as offering a unique optimization
64 that immediately saves time and money. Basically, imagine that you have 100
65 nearly identical Windows or Linux machine containing the OS and user files.
66 Now for the OS part, a Base job will be backed up once, and rather than making
67 100 copies of the OS, there will be only one. If one or more of the systems
68 have some files updated, no problem, they will be automatically restored.
70 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
71 files that will be used during Full backup as base.
82 Base = BackupZog4, BackupLinux
88 In this example, the job \texttt{BackupZog4} will use the most recent version
89 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
90 jobs. Base jobs should have run with \texttt{level=Base} to be used.
92 By default, Bacula will compare permissions bits, user and group fields,
93 modification time, size and the checksum of the file to choose between the
94 current backup and the BaseJob file list. You can change this behavior with the
95 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
96 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
113 This project was funded by Bacula Systems.
116 \section{Accurate Fileset Options}
117 \label{sec:accuratefileset}
119 In previous versions, the accurate code used the file creation and
120 modification times to determine if a file was modified or not. Now you can specify
121 which attributes to use (time, size, checksum, permission, owner, group,
122 \dots), similar to the Verify options.
142 compare the permission bits
145 compare the number of links
157 compare the access time
160 compare the modification time (st\_mtime)
163 compare the change time (st\_ctime)
166 report file size decreases
169 compare the MD5 signature
172 compare the SHA1 signature
175 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
176 the File Daemon will have to read all files even if they normally would not
177 be saved. This increases the I/O load, but also the accuracy of the
178 deduplication. By default, Bacula will check modification/creation time
181 \section{Tab-completion for Bconsole}
182 \label{sec:tabcompletion}
184 If you build \texttt{bconsole} with readline support, you will be able to use
185 the new auto-completion mode. This mode supports all commands, gives help
186 inside command, and lists resources when required.
191 To help developers of restore GUI interfaces, we have added new \textsl{dot
192 commands} that permit browsing the catalog in a very simple way.
195 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update the
196 Bvfs cache in the catalog. You need to run it before any access to the Bvfs
199 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
200 will list all directories in the specified \texttt{path} or
201 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
202 encoding of path/filenames.
204 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
205 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
206 \texttt{pathid} avoids problems with character encoding.
209 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
210 data that will be displayed.
213 * .bvfs_update jobid=1,2
215 * .bvfs_lsdir path=/ jobid=1,2
218 \section{Testing your Tape Drive}
219 \label{sec:btapespeed}
221 To determine the best configuration of your tape drive, you can run the new
222 \texttt{speed} command available in the \texttt{btape} program.
224 This command can have the following arguments:
226 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
227 (between 1 and 5GB). This counter is in GB.
228 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
229 of data should be greater than your memory ($file\_size*nb\_file$).
230 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
232 \item[\texttt{skip\_random}] This flag permits to skip tests with random
234 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
235 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
240 *speed file_size=3 skip_raw
241 btape.c:1078 Test with zero data and bacula block structure.
242 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
243 ++++++++++++++++++++++++++++++++++++++++++
244 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
245 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
247 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
249 btape.c:1090 Test with random data, should give the minimum throughput.
250 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
251 +++++++++++++++++++++++++++++++++++++++++++
252 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
253 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
254 +++++++++++++++++++++++++++++++++++++++++++
256 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
260 When using compression, the random test will give your the minimum throughput
261 of your drive . The test using constant string will give you the maximum speed
262 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
264 You can change the block size in the Storage Daemon configuration file.
266 \section{New {\bf Block Checksum} Device Directive}
267 You may now turn off the Block Checksum (CRC32) code
268 that Bacula uses when writing blocks to a Volume. This is
275 doing so can reduce the Storage daemon CPU usage slightly. It
276 will also permit Bacula to read a Volume that has corrupted data.
278 The default is {\bf yes} -- i.e. the checksum is computed on write
281 We do not recommend to turn this off particularly on older tape
282 drives or for disk Volumes where doing so may allow corrupted data
285 \section{New Bat Features}
287 \subsection{Media List View}
289 By clicking on ``Media'', you can see the list of all your volumes. You will be
290 able to filter by Pool, Media Type, Location,\dots And sort the result directly
291 in the table. The old ``Media'' view is now known as ``Pool''.
294 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
295 \label{fig:mediaview}
299 \subsection{Media Information View}
301 By double-clicking on a volume (on the Media list, in the Autochanger content
302 or in the Job information panel), you can access a detailed overview of your
303 Volume. (cf \ref{fig:mediainfo}.)
306 \includegraphics[width=13cm]{\idir bat11.eps}
307 \caption{Media information}
308 \label{fig:mediainfo}
311 \subsection{Job Information View}
313 By double-clicking on a Job record (on the Job run list or in the Media
314 information panel), you can access a detailed overview of your Job. (cf
318 \includegraphics[width=13cm]{\idir bat12.eps}
319 \caption{Job information}
323 \subsection{Autochanger Content View}
325 By double-clicking on a Storage record (on the Storage list panel), you can
326 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
329 \includegraphics[width=13cm]{\idir bat13.eps}
330 \caption{Autochanger content}
331 \label{fig:achcontent}
334 \section{Console Timeout Option}
335 You can now use the -u option of bconsole to set a timeout for each command.
337 \chapter{New Features in Released Version 3.0.2}
339 This chapter presents the new features added to the
340 Released Bacula Version 3.0.2.
342 \section{Full Restore from a Given JobId}
343 \index[general]{Restore menu}
345 This feature allows selecting a single JobId and having Bacula
346 automatically select all the other jobs that comprise a full backup up to
347 and including the selected date (through JobId).
349 Assume we start with the following jobs:
351 +-------+--------------+---------------------+-------+----------+------------+
352 | jobid | client | starttime | level | jobfiles | jobbytes |
353 +-------+--------------+---------------------+-------+----------+------------
354 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
355 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
356 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
357 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
358 +-------+--------------+---------------------+-------+----------+------------+
361 Below is an example of this new feature (which is number 12 in the
366 To select the JobIds, you have the following choices:
367 1: List last 20 Jobs run
368 2: List Jobs where a given File is saved
370 12: Select full restore to a specified Job date
373 Select item: (1-13): 12
374 Enter JobId to get the state to restore: 5
375 Selecting jobs to build the Full state at 2009-07-15 11:45:45
376 You have selected the following JobIds: 1,3,5
378 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
379 1,444 files inserted into the tree.
382 This project was funded by Bacula Systems.
384 \section{Source Address}
385 \index[general]{Source Address}
387 A feature has been added which allows the administrator to specify the address
388 from which the Director and File daemons will establish connections. This
389 may be used to simplify system configuration overhead when working in complex
390 networks utilizing multi-homing and policy-routing.
392 To accomplish this, two new configuration directives have been implemented:
395 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
399 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
403 Simply adding specific host routes on the OS
404 would have an undesirable side-effect: any
405 application trying to contact the destination host would be forced to use the
406 more specific route possibly diverting management traffic onto a backup VLAN.
407 Instead of adding host routes for each client connected to a multi-homed backup
408 server (for example where there are management and backup VLANs), one can
409 use the new directives to specify a specific source address at the application
412 Additionally, this allows the simplification and abstraction of firewall rules
413 when dealing with a Hot-Standby director or storage daemon configuration. The
414 Hot-standby pair may share a CARP address, which connections must be sourced
415 from, while system services listen and act from the unique interface addresses.
417 This project was funded by Collaborative Fusion, Inc.
419 \section{Show volume availability when doing restore}
421 When doing a restore the selection dialog ends by displaying this
425 The job will require the following
426 Volume(s) Storage(s) SD Device(s)
427 ===========================================================================
438 Volumes marked with ``*'' are online (in the autochanger).
441 This should help speed up large restores by minimizing the time spent
442 waiting for the operator to discover that he must change tapes in the library.
444 This project was funded by Bacula Systems.
446 \section{Accurate estimate command}
448 The \texttt{estimate} command can now use the accurate code to detect changes
449 and give a better estimation.
451 You can set the accurate behavior on the command line by using
452 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
455 * estimate listing accurate=yes level=incremental job=BackupJob
458 This project was funded by Bacula Systems.
460 \chapter{New Features in 3.0.0}
461 \label{NewFeaturesChapter}
462 \index[general]{New Features}
464 This chapter presents the new features added to the development 2.5.x
465 versions to be released as Bacula version 3.0.0 sometime in April 2009.
467 \section{Accurate Backup}
468 \index[general]{Accurate Backup}
470 As with most other backup programs, by default Bacula decides what files to
471 backup for Incremental and Differental backup by comparing the change
472 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
473 backup completed. If one of those two times is later than the last backup
474 time, then the file will be backed up. This does not, however, permit tracking
475 what files have been deleted and will miss any file with an old time that may
476 have been restored to or moved onto the client filesystem.
478 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
479 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
480 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
481 backup, there is no difference, but for {\bf Differential} and {\bf
482 Incremental} backups, the Director will send a list of all previous files
483 backed up, and the File daemon will use that list to determine if any new files
484 have been added or or moved and if any files have been deleted. This allows
485 Bacula to make an accurate backup of your system to that point in time so that
486 if you do a restore, it will restore your system exactly.
489 about using Accurate backup is that it requires more resources (CPU and memory)
490 on both the Director and the Client machines to create the list of previous
491 files backed up, to send that list to the File daemon, for the File daemon to
492 keep the list (possibly very big) in memory, and for the File daemon to do
493 comparisons between every file in the FileSet and the list. In particular,
494 if your client has lots of files (more than a few million), you will need
495 lots of memory on the client machine.
497 Accurate must not be enabled when backing up with a plugin that is not
498 specially designed to work with Accurate. If you enable it, your restores
499 will probably not work correctly.
501 This project was funded by Bacula Systems.
506 \index[general]{Copy Jobs}
508 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
509 existing Migration feature with the exception that the Job that is copied is
510 left unchanged. This essentially creates two identical copies of the same
511 backup. However, the copy is treated as a copy rather than a backup job, and
512 hence is not directly available for restore. The {\bf restore} command lists
513 copy jobs and allows selection of copies by using \texttt{jobid=}
514 option. If the keyword {\bf copies} is present on the command line, Bacula will
515 display the list of all copies for selected jobs.
520 These JobIds have copies as follows:
521 +-------+------------------------------------+-----------+------------------+
522 | JobId | Job | CopyJobId | MediaType |
523 +-------+------------------------------------+-----------+------------------+
524 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
525 +-------+------------------------------------+-----------+------------------+
526 +-------+-------+----------+----------+---------------------+------------------+
527 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
528 +-------+-------+----------+----------+---------------------+------------------+
529 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
530 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
531 +-------+-------+----------+----------+---------------------+------------------+
532 You have selected the following JobIds: 19,2
534 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
535 5,611 files inserted into the tree.
540 The Copy Job runs without using the File daemon by copying the data from the
541 old backup Volume to a different Volume in a different Pool. See the Migration
542 documentation for additional details. For copy Jobs there is a new selection
543 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
544 not already copied to another Pool.
546 As with Migration, the Client, Volume, Job, or SQL query, are
547 other possible ways of selecting the Jobs to be copied. Selection
548 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
549 work, but are probably more suited for Migration Jobs.
551 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
552 it will promote the Copy to a \textsl{real} backup job and will make it available for
553 automatic restore. If more than one Copy is available, it will promote the copy
554 with the smallest JobId.
556 A nice solution which can be built with the new Copy feature is often
557 called disk-to-disk-to-tape backup (DTDTT). A sample config could
558 look something like the one below:
562 Name = FullBackupsVirtualPool
564 Purge Oldest Volume = Yes
566 NextPool = FullBackupsTapePool
570 Name = FullBackupsTapePool
574 Volume Retention = 365 days
575 Storage = superloader
579 # Fake fileset for copy jobs
591 # Fake client for copy jobs
601 # Default template for a CopyDiskToTape Job
604 Name = CopyDiskToTape
606 Messages = StandardCopy
609 Selection Type = PoolUncopiedJobs
610 Maximum Concurrent Jobs = 10
612 Allow Duplicate Jobs = Yes
613 Allow Higher Duplicates = No
614 Cancel Queued Duplicates = No
615 Cancel Running Duplicates = No
620 Name = DaySchedule7:00
621 Run = Level=Full daily at 7:00
625 Name = CopyDiskToTapeFullBackups
627 Schedule = DaySchedule7:00
628 Pool = FullBackupsVirtualPool
629 JobDefs = CopyDiskToTape
633 The example above had 2 pool which are copied using the PoolUncopiedJobs
634 selection criteria. Normal Full backups go to the Virtual pool and are copied
635 to the Tape pool the next morning.
637 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
642 +-------+------------------------------------+-----------+------------------+
643 | JobId | Job | CopyJobId | MediaType |
644 +-------+------------------------------------+-----------+------------------+
645 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
646 +-------+------------------------------------+-----------+------------------+
649 \section{ACL Updates}
650 \index[general]{ACL Updates}
651 The whole ACL code had been overhauled and in this version each platforms has
652 different streams for each type of acl available on such an platform. As ACLs
653 between platforms tend to be not that portable (most implement POSIX acls but
654 some use an other draft or a completely different format) we currently only
655 allow certain platform specific ACL streams to be decoded and restored on the
656 same platform that they were created on. The old code allowed to restore ACL
657 cross platform but the comments already mention that not being to wise. For
658 backward compatability the new code will accept the two old ACL streams and
659 handle those with the platform specific handler. But for all new backups it
660 will save the ACLs using the new streams.
662 Currently the following platforms support ACLs:
666 \item {\bf Darwin/OSX}
675 Currently we support the following ACL types (these ACL streams use a reserved
676 part of the stream numbers):
679 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
681 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
682 string representation from acl\_to\_text (POSIX acl)
683 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
684 string representation from acl\_to\_text (POSIX acl) for default acls.
685 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
686 string representation from acl\_to\_text (POSIX acl) for access acls.
687 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
688 string representation from acltostr (POSIX acl)
689 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
690 representation from acl\_to\_text (POSIX acl) for default acls.
691 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
692 representation from acl\_to\_text (POSIX acl) for access acls.
693 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
694 string representation from acl\_to\_text (POSIX acl) for default acls.
695 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
696 representation from acl\_to\_text (POSIX acl) for access acls.
697 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
698 string representation from acl\_to\_text (POSIX acl) for default acls.
699 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
700 string representation from acl\_to\_text (POSIX acl) for default acls.
701 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
702 representation from acl\_to\_text (POSIX acl) for access acls.
703 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
704 string representation from acltotext or acl\_totext (POSIX acl)
705 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
706 representation from from acl\_totext (NFSv4 or ZFS acl)
709 In future versions we might support conversion functions from one type of acl
710 into an other for types that are either the same or easily convertable. For now
711 the streams are seperate and restoring them on a platform that doesn't
712 recognize them will give you a warning.
714 \section{Extended Attributes}
715 \index[general]{Extended Attributes}
716 Something that was on the project list for some time is now implemented for
717 platforms that support a similar kind of interface. Its the support for backup
718 and restore of so called extended attributes. As extended attributes are so
719 platform specific these attributes are saved in seperate streams for each
720 platform. Restores of the extended attributes can only be performed on the
721 same platform the backup was done. There is support for all types of extended
722 attributes, but restoring from one type of filesystem onto an other type of
723 filesystem on the same platform may lead to supprises. As extended attributes
724 can contain any type of data they are stored as a series of so called
725 value-pairs. This data must be seen as mostly binary and is stored as such.
726 As security labels from selinux are also extended attributes this option also
727 stores those labels and no specific code is enabled for handling selinux
730 Currently the following platforms support extended attributes:
732 \item {\bf Darwin/OSX}
738 On linux acls are also extended attributes, as such when you enable ACLs on a
739 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
740 and not the same exteneded attribute.
742 To enable the backup of extended attributes please add the following to your
757 \section{Shared objects}
758 \index[general]{Shared objects}
759 A default build of Bacula will now create the libraries as shared objects
760 (.so) rather than static libraries as was previously the case.
761 The shared libraries are built using {\bf libtool} so it should be quite
764 An important advantage of using shared objects is that on a machine with the
765 Directory, File daemon, the Storage daemon, and a console, you will have only
766 one copy of the code in memory rather than four copies. Also the total size of
767 the binary release is smaller since the library code appears only once rather
768 than once for every program that uses it; this results in significant reduction
769 in the size of the binaries particularly for the utility tools.
771 In order for the system loader to find the shared objects when loading the
772 Bacula binaries, the Bacula shared objects must either be in a shared object
773 directory known to the loader (typically /usr/lib) or they must be in the
774 directory that may be specified on the {\bf ./configure} line using the {\bf
775 {-}{-}libdir} option as:
778 ./configure --libdir=/full-path/dir
781 the default is /usr/lib. If {-}{-}libdir is specified, there should be
782 no need to modify your loader configuration provided that
783 the shared objects are installed in that directory (Bacula
784 does this with the make install command). The shared objects
785 that Bacula references are:
794 These files are symbolically linked to the real shared object file,
795 which has a version number to permit running multiple versions of
796 the libraries if desired (not normally the case).
798 If you have problems with libtool or you wish to use the old
799 way of building static libraries, or you want to build a static
800 version of Bacula you may disable
801 libtool on the configure command line with:
804 ./configure --disable-libtool
808 \section{Building Static versions of Bacula}
809 \index[general]{Static linking}
810 In order to build static versions of Bacula, in addition
811 to configuration options that were needed you now must
812 also add --disable-libtool. Example
815 ./configure --enable-static-client-only --disable-libtool
819 \section{Virtual Backup (Vbackup)}
820 \index[general]{Virtual Backup}
821 \index[general]{Vbackup}
823 Bacula's virtual backup feature is often called Synthetic Backup or
824 Consolidation in other backup products. It permits you to consolidate the
825 previous Full backup plus the most recent Differential backup and any
826 subsequent Incremental backups into a new Full backup. This new Full
827 backup will then be considered as the most recent Full for any future
828 Incremental or Differential backups. The VirtualFull backup is
829 accomplished without contacting the client by reading the previous backup
830 data and writing it to a volume in a different pool.
832 In some respects the Vbackup feature works similar to a Migration job, in
833 that Bacula normally reads the data from the pool specified in the
834 Job resource, and writes it to the {\bf Next Pool} specified in the
835 Job resource. Note, this means that usually the output from the Virtual
836 Backup is written into a different pool from where your prior backups
837 are saved. Doing it this way guarantees that you will not get a deadlock
838 situation attempting to read and write to the same volume in the Storage
839 daemon. If you then want to do subsequent backups, you may need to
840 move the Virtual Full Volume back to your normal backup pool.
841 Alternatively, you can set your {\bf Next Pool} to point to the current
842 pool. This will cause Bacula to read and write to Volumes in the
843 current pool. In general, this will work, because Bacula will
844 not allow reading and writing on the same Volume. In any case, once
845 a VirtualFull has been created, and a restore is done involving the
846 most current Full, it will read the Volume or Volumes by the VirtualFull
847 regardless of in which Pool the Volume is found.
849 The Vbackup is enabled on a Job by Job in the Job resource by specifying
850 a level of {\bf VirtualFull}.
852 A typical Job resource definition might look like the following:
866 # Default pool definition
870 Recycle = yes # Automatically recycle Volumes
871 AutoPrune = yes # Prune expired volumes
872 Volume Retention = 365d # one year
880 Recycle = yes # Automatically recycle Volumes
881 AutoPrune = yes # Prune expired volumes
882 Volume Retention = 365d # one year
883 Storage = DiskChanger
886 # Definition of file storage device
893 Maximum Concurrent Jobs = 5
896 # Definition of DDS Virtual tape disk storage device
899 Address = localhost # N.B. Use a fully qualified name here
902 Media Type = DiskChangerMedia
903 Maximum Concurrent Jobs = 4
908 Then in bconsole or via a Run schedule, you would run the job as:
911 run job=MyBackup level=Full
912 run job=MyBackup level=Incremental
913 run job=MyBackup level=Differential
914 run job=MyBackup level=Incremental
915 run job=MyBackup level=Incremental
918 So providing there were changes between each of those jobs, you would end up
919 with a Full backup, a Differential, which includes the first Incremental
920 backup, then two Incremental backups. All the above jobs would be written to
921 the {\bf Default} pool.
923 To consolidate those backups into a new Full backup, you would run the
927 run job=MyBackup level=VirtualFull
930 And it would produce a new Full backup without using the client, and the output
931 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
933 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
936 Note, the Start and End time of the Virtual Full backup is set to the
937 values for the last job included in the Virtual Full (in the above example,
938 it is an Increment). This is so that if another incremental is done, which
939 will be based on the Virtual Full, it will backup all files from the
940 last Job included in the Virtual Full rather than from the time the Virtual
941 Full was actually run.
945 \section{Catalog Format}
946 \index[general]{Catalog Format}
947 Bacula 3.0 comes with some changes to the catalog format. The upgrade
948 operation will convert the FileId field of the File table from 32 bits (max 4
949 billion table entries) to 64 bits (very large number of items). The
950 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
951 your catalog during the conversion. Also you won't be able to run jobs during
952 this conversion period. For example, a 3 million file catalog will take 2
953 minutes to upgrade on a normal machine. Please don't forget to make a valid
954 backup of your database before executing the upgrade script. See the
955 ReleaseNotes for additional details.
957 \section{64 bit Windows Client}
958 \index[general]{Win64 Client}
959 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
960 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
961 As a consequence, we are also releasing a 64 bit version of the Bacula
962 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
963 These binaries should only be installed on 64 bit Windows operating systems.
964 What is important is not your hardware but whether or not you have
965 a 64 bit version of the Windows OS.
967 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
969 \item Before installing the Win64 Bacula Client, you must totally
970 deinstall any prior 2.4.x Client installation using the
971 Bacula deinstallation (see the menu item). You may want
972 to save your .conf files first.
973 \item Only the Client (File daemon) is ported to Win64, the Director
974 and the Storage daemon are not in the 64 bit Windows installer.
975 \item bwx-console is not yet ported.
976 \item bconsole is ported but it has not been tested.
977 \item The documentation is not included in the installer.
978 \item Due to Vista security restrictions imposed on a default installation
979 of Vista, before upgrading the Client, you must manually stop
980 any prior version of Bacula from running, otherwise the install
982 \item Due to Vista security restrictions imposed on a default installation
983 of Vista, attempting to edit the conf files via the menu items
984 will fail. You must directly edit the files with appropriate
985 permissions. Generally double clicking on the appropriate .conf
986 file will work providing you have sufficient permissions.
987 \item All Bacula files are now installed in
988 {\bf C:/Program Files/Bacula} except the main menu items,
989 which are installed as before. This vastly simplifies the installation.
990 \item If you are running on a foreign language version of Windows, most
991 likely {\bf C:/Program Files} does not exist, so you should use the
992 Custom installation and enter an appropriate location to install
994 \item The 3.0.0 Win32 Client continues to install files in the locations used
995 by prior versions. For the next version we will convert it to use
996 the same installation conventions as the Win64 version.
999 This project was funded by Bacula Systems.
1002 \section{Duplicate Job Control}
1003 \index[general]{Duplicate Jobs}
1004 The new version of Bacula provides four new directives that
1005 give additional control over what Bacula does if duplicate jobs
1006 are started. A duplicate job in the sense we use it here means
1007 a second or subsequent job with the same name starts. This
1008 happens most frequently when the first job runs longer than expected because no
1009 tapes are available.
1011 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1012 are specified in the Job resource.
1016 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1017 \index[general]{Allow Duplicate Jobs}
1018 If this directive is enabled duplicate jobs will be run. If
1019 the directive is set to {\bf no} (default) then only one job of a given name
1020 may run at one time, and the action that Bacula takes to ensure only
1021 one job runs is determined by the other directives (see below).
1023 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1024 are present and none of the three directives given below permit
1025 cancelling a job, then the current job (the second one started)
1029 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1030 \index[general]{Allow Higher Duplicates}
1031 If this directive is set to {\bf yes} (default) the job with a higher
1032 priority (lower priority number) will be permitted to run, and
1033 the current job will be cancelled. If the
1034 priorities of the two jobs are the same, the outcome is determined by
1035 other directives (see below).
1037 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1038 \index[general]{Cancel Queued Duplicates}
1039 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1040 if this directive is set to {\bf yes} any job that is
1041 already queued to run but not yet running will be canceled.
1042 The default is {\bf no}.
1044 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1045 \index[general]{Cancel Running Duplicates}
1046 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1047 if this directive is set to {\bf yes} any job that is already running
1048 will be canceled. The default is {\bf no}.
1051 \section{TLS Authentication}
1052 \index[general]{TLS Authentication}
1053 In Bacula version 2.5.x and later, in addition to the normal Bacula
1054 CRAM-MD5 authentication that is used to authenticate each Bacula
1055 connection, you can specify that you want TLS Authentication as well,
1056 which will provide more secure authentication.
1058 This new feature uses Bacula's existing TLS code (normally used for
1059 communications encryption) to do authentication. To use it, you must
1060 specify all the TLS directives normally used to enable communications
1061 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1064 \subsection{TLS Authenticate = yes}
1066 TLS Authenticate = yes
1069 in the main daemon configuration resource (Director for the Director,
1070 Client for the File daemon, and Storage for the Storage daemon).
1072 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1073 authentication, Bacula will also do TLS authentication, then TLS
1074 encryption will be turned off, and the rest of the communication between
1075 the two Bacula daemons will be done without encryption.
1077 If you want to encrypt communications data, use the normal TLS directives
1078 but do not turn on {\bf TLS Authenticate}.
1080 \section{bextract non-portable Win32 data}
1081 \index[general]{bextract handles Win32 non-portable data}
1082 {\bf bextract} has been enhanced to be able to restore
1083 non-portable Win32 data to any OS. Previous versions were
1084 unable to restore non-portable Win32 data to machines that
1085 did not have the Win32 BackupRead and BackupWrite API calls.
1087 \section{State File updated at Job Termination}
1088 \index[general]{State File}
1089 In previous versions of Bacula, the state file, which provides a
1090 summary of previous jobs run in the {\bf status} command output was
1091 updated only when Bacula terminated, thus if the daemon crashed, the
1092 state file might not contain all the run data. This version of
1093 the Bacula daemons updates the state file on each job termination.
1095 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1096 \index[general]{MaxFullInterval}
1097 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1098 can be used to specify the maximum time interval between {\bf Full} backup
1099 jobs. When a job starts, if the time since the last Full backup is
1100 greater than the specified interval, and the job would normally be an
1101 {\bf Incremental} or {\bf Differential}, it will be automatically
1102 upgraded to a {\bf Full} backup.
1104 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1105 \index[general]{MaxDiffInterval}
1106 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1107 can be used to specify the maximum time interval between {\bf Differential} backup
1108 jobs. When a job starts, if the time since the last Differential backup is
1109 greater than the specified interval, and the job would normally be an
1110 {\bf Incremental}, it will be automatically
1111 upgraded to a {\bf Differential} backup.
1113 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1114 \index[general]{MaxDiffInterval}
1115 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1116 by the user, and when it is set it is an indication to backup programs
1117 to not backup that particular file. This version of Bacula contains a
1118 new Options directive within a FileSet resource, which instructs Bacula to
1119 obey this flag. The new directive is:
1122 Honor No Dump Flag = yes\vb{}no
1125 The default value is {\bf no}.
1128 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1129 \index[general]{IgnoreDir}
1130 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1131 can be added to the Include section of the FileSet resource. If the specified
1132 filename ({\bf filename-string}) is found on the Client in any directory to be
1133 backed up, the whole directory will be ignored (not backed up). For example:
1136 # List of files to be backed up
1144 Exclude Dir Containing = .excludeme
1149 But in /home, there may be hundreds of directories of users and some
1150 people want to indicate that they don't want to have certain
1151 directories backed up. For example, with the above FileSet, if
1152 the user or sysadmin creates a file named {\bf .excludeme} in
1153 specific directories, such as
1156 /home/user/www/cache/.excludeme
1157 /home/user/temp/.excludeme
1160 then Bacula will not backup the two directories named:
1163 /home/user/www/cache
1167 NOTE: subdirectories will not be backed up. That is, the directive
1168 applies to the two directories in question and any children (be they
1169 files, directories, etc).
1172 \section{Bacula Plugins}
1173 \index[general]{Plugin}
1174 Support for shared object plugins has been implemented in the Linux, Unix
1175 and Win32 File daemons. The API will be documented separately in
1176 the Developer's Guide or in a new document. For the moment, there is
1177 a single plugin named {\bf bpipe} that allows an external program to
1178 get control to backup and restore a file.
1180 Plugins are also planned (partially implemented) in the Director and the
1183 \subsection{Plugin Directory}
1184 \index[general]{Plugin Directory}
1185 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1186 be added to the daemon definition resource. The directory takes a quoted
1187 string argument, which is the name of the directory in which the daemon can
1188 find the Bacula plugins. If this directive is not specified, Bacula will not
1189 load any plugins. Since each plugin has a distinctive name, all the daemons
1190 can share the same plugin directory.
1192 \subsection{Plugin Options}
1193 \index[general]{Plugin Options}
1194 The {\bf Plugin Options} directive takes a quoted string
1195 arguement (after the equal sign) and may be specified in the
1196 Job resource. The options specified will be passed to all plugins
1197 when they are run. This each plugin must know what it is looking
1198 for. The value defined in the Job resource can be modified
1199 by the user when he runs a Job via the {\bf bconsole} command line
1202 Note: this directive may be specified, and there is code to modify
1203 the string in the run command, but the plugin options are not yet passed to
1204 the plugin (i.e. not fully implemented).
1206 \subsection{Plugin Options ACL}
1207 \index[general]{Plugin Options ACL}
1208 The {\bf Plugin Options ACL} directive may be specified in the
1209 Director's Console resource. It functions as all the other ACL commands
1210 do by permitting users running restricted consoles to specify a
1211 {\bf Plugin Options} that overrides the one specified in the Job
1212 definition. Without this directive restricted consoles may not modify
1215 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1216 \index[general]{Plugin}
1217 The {\bf Plugin} directive is specified in the Include section of
1218 a FileSet resource where you put your {\bf File = xxx} directives.
1229 Plugin = "bpipe:..."
1234 In the above example, when the File daemon is processing the directives
1235 in the Include section, it will first backup all the files in {\bf /home}
1236 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1237 the Plugin Directory. The syntax and semantics of the Plugin directive
1238 require the first part of the string up to the colon (:) to be the name
1239 of the plugin. Everything after the first colon is ignored by the File daemon but
1240 is passed to the plugin. Thus the plugin writer may define the meaning of the
1241 rest of the string as he wishes.
1243 Please see the next section for information about the {\bf bpipe} Bacula
1246 \section{The bpipe Plugin}
1247 \index[general]{The bpipe Plugin}
1248 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1249 the Bacula source distribution. When the plugin is compiled and linking into
1250 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1252 The purpose of the plugin is to provide an interface to any system program for
1253 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1254 the Include section of your Job's FileSet resource. The full syntax of the
1255 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1256 to specify the sytax as it wishes) is:
1259 Plugin = "<field1>:<field2>:<field3>:<field4>"
1264 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1265 stripped off, so in this case, we would put {\bf bpipe} in this field.
1267 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1268 pseudo path and filename under which the backup will be saved. This pseudo
1269 path and filename will be seen by the user in the restore file tree.
1270 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1271 backed up by the plugin will be put under that "pseudo" path and filename.
1272 You must be careful to choose a naming convention that is unique to avoid
1273 a conflict with a path and filename that actually exists on your system.
1275 \item {\bf field3} for the {\bf bpipe} plugin
1276 specifies the "reader" program that is called by the plugin during
1277 backup to read the data. {\bf bpipe} will call this program by doing a
1280 \item {\bf field4} for the {\bf bpipe} plugin
1281 specifies the "writer" program that is called by the plugin during
1282 restore to write the data back to the filesystem.
1285 Putting it all together, the full plugin directive line might look
1289 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1290 --opt --databases bacula:mysql"
1293 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1294 would be written on a single line.
1296 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1297 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1298 program {\bf mysqldump -f --opt --database bacula} to read the data during
1299 backup. The mysqldump command outputs all the data for the database named
1300 {\bf bacula}, which will be read by the plugin and stored in the backup.
1301 During restore, the data that was backed up will be sent to the program
1302 specified in the last field, which in this case is {\bf mysql}. When
1303 {\bf mysql} is called, it will read the data sent to it by the plugn
1304 then write it back to the same database from which it came ({\bf bacula}
1307 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1308 the data from a specified program to Bacula for backup, and then from Bacula to
1309 a specified program for restore.
1311 By using different command lines to {\bf bpipe},
1312 you can backup any kind of data (ASCII or binary) depending
1313 on the program called.
1315 \section{Microsoft Exchange Server 2003/2007 Plugin}
1316 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1317 \subsection{Background}
1318 The Exchange plugin was made possible by a funded development project
1319 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1320 The code for the plugin was written by James Harper, and the Bacula core
1321 code by Kern Sibbald. All the code for this funded development has become
1322 part of the Bacula project. Thanks to everyone who made it happen.
1324 \subsection{Concepts}
1325 Although it is possible to backup Exchange using Bacula VSS the Exchange
1326 plugin adds a good deal of functionality, because while Bacula VSS
1327 completes a full backup (snapshot) of Exchange, it does
1328 not support Incremental or Differential backups, restoring is more
1329 complicated, and a single database restore is not possible.
1331 Microsoft Exchange organises its storage into Storage Groups with
1332 Databases inside them. A default installation of Exchange will have a
1333 single Storage Group called 'First Storage Group', with two Databases
1334 inside it, "Mailbox Store (SERVER NAME)" and
1335 "Public Folder Store (SERVER NAME)",
1336 which hold user email and public folders respectively.
1338 In the default configuration, Exchange logs everything that happens to
1339 log files, such that if you have a backup, and all the log files since,
1340 you can restore to the present time. Each Storage Group has its own set
1341 of log files and operates independently of any other Storage Groups. At
1342 the Storage Group level, the logging can be turned off by enabling a
1343 function called "Enable circular logging". At this time the Exchange
1344 plugin will not function if this option is enabled.
1346 The plugin allows backing up of entire storage groups, and the restoring
1347 of entire storage groups or individual databases. Backing up and
1348 restoring at the individual mailbox or email item is not supported but
1349 can be simulated by use of the "Recovery" Storage Group (see below).
1351 \subsection{Installing}
1352 The Exchange plugin requires a DLL that is shipped with Microsoft
1353 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1354 correctly the Exchange plugin should find this automatically and run
1355 without any additional installation.
1357 If the DLL can not be found automatically it will need to be copied into
1358 the Bacula installation
1359 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1360 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1361 default Exchange installation.
1363 \subsection{Backup up}
1364 To back up an Exchange server the Fileset definition must contain at
1365 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1366 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1367 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1368 up files are prefixed with something that isn't going to share a name
1369 with something outside the plugin, and the 'Microsoft Information Store'
1370 bit is required also. It is also possible to add the name of a storage
1371 group to the "Plugin =" line, eg \\
1372 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1373 if you want only a single storage group backed up.
1375 Additionally, you can suffix the 'Plugin =' directive with
1376 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1377 database at the end of a full backup.
1379 An Incremental or Differential backup will backup only the database logs
1380 for each Storage Group by inspecting the "modified date" on each
1381 physical log file. Because of the way the Exchange API works, the last
1382 logfile backed up on each backup will always be backed up by the next
1383 Incremental or Differential backup too. This adds 5MB to each
1384 Incremental or Differential backup size but otherwise does not cause any
1387 By default, a normal VSS fileset containing all the drive letters will
1388 also back up the Exchange databases using VSS. This will interfere with
1389 the plugin and Exchange's shared ideas of when the last full backup was
1390 done, and may also truncate log files incorrectly. It is important,
1391 therefore, that the Exchange database files be excluded from the backup,
1392 although the folders the files are in should be included, or they will
1393 have to be recreated manually if a baremetal restore is done.
1398 File = C:/Program Files/Exchsrvr/mdbdata
1399 Plugin = "exchange:..."
1402 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1403 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1404 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1405 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1406 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1407 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1408 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1413 The advantage of excluding the above files is that you can significantly
1414 reduce the size of your backup since all the important Exchange files
1415 will be properly saved by the Plugin.
1418 \subsection{Restoring}
1419 The restore operation is much the same as a normal Bacula restore, with
1420 the following provisos:
1423 \item The {\bf Where} restore option must not be specified
1424 \item Each Database directory must be marked as a whole. You cannot just
1425 select (say) the .edb file and not the others.
1426 \item If a Storage Group is restored, the directory of the Storage Group
1428 \item It is possible to restore only a subset of the available log files,
1429 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1430 if a log file is missing from the sequence of log files
1431 \item Each database to be restored must be dismounted and marked as "Can be
1432 overwritten by restore"
1433 \item If an entire Storage Group is to be restored (eg all databases and
1434 logs in the Storage Group), then it is best to manually delete the
1435 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1436 as Exchange can get confused by stray log files lying around.
1439 \subsection{Restoring to the Recovery Storage Group}
1440 The concept of the Recovery Storage Group is well documented by
1442 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1443 but to briefly summarize...
1445 Microsoft Exchange allows the creation of an additional Storage Group
1446 called the Recovery Storage Group, which is used to restore an older
1447 copy of a database (e.g. before a mailbox was deleted) into without
1448 messing with the current live data. This is required as the Standard and
1449 Small Business Server versions of Exchange can not ordinarily have more
1450 than one Storage Group.
1452 To create the Recovery Storage Group, drill down to the Server in Exchange
1453 System Manager, right click, and select
1454 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1455 locations and click OK. On the Recovery Storage Group, right click and
1456 select {\bf "Add Database to Recover..."} and select the database you will
1459 Restore only the single database nominated as the database in the
1460 Recovery Storage Group. Exchange will redirect the restore to the
1461 Recovery Storage Group automatically.
1462 Then run the restore.
1464 \subsection{Restoring on Microsoft Server 2007}
1465 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1466 2007, and henc you use a new proceedure for recovering a single mail box.
1467 This procedure is ducomented by Microsoft at:
1468 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1469 and involves using the {\bf Restore-Mailbox} and {\bf
1470 Get-MailboxStatistics} shell commands.
1472 \subsection{Caveats}
1473 This plugin is still being developed, so you should consider it
1474 currently in BETA test, and thus use in a production environment
1475 should be done only after very careful testing.
1477 When doing a full backup, the Exchange database logs are truncated by
1478 Exchange as soon as the plugin has completed the backup. If the data
1479 never makes it to the backup medium (eg because of spooling) then the
1480 logs will still be truncated, but they will also not have been backed
1481 up. A solution to this is being worked on. You will have to schedule a
1482 new Full backup to ensure that your next backups will be usable.
1484 The "Enable Circular Logging" option cannot be enabled or the plugin
1487 Exchange insists that a successful Full backup must have taken place if
1488 an Incremental or Differential backup is desired, and the plugin will
1489 fail if this is not the case. If a restore is done, Exchange will
1490 require that a Full backup be done before an Incremental or Differential
1493 The plugin will most likely not work well if another backup application
1494 (eg NTBACKUP) is backing up the Exchange database, especially if the
1495 other backup application is truncating the log files.
1497 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1498 we recommend either carefully testing or that you avoid this option for
1501 The Exchange plugin is not called during processing the bconsole {\bf
1502 estimate} command, and so anything that would be backed up by the plugin
1503 will not be added to the estimate total that is displayed.
1506 \section{libdbi Framework}
1507 \index[general]{libdbi Framework}
1508 As a general guideline, Bacula has support for a few catalog database drivers
1509 (MySQL, PostgreSQL, SQLite)
1510 coded natively by the Bacula team. With the libdbi implementation, which is a
1511 Bacula driver that uses libdbi to access the catalog, we have an open field to
1512 use many different kinds database engines following the needs of users.
1514 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1515 implements a database-independent abstraction layer in C, similar to the
1516 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1517 leverage the power of multiple databases and multiple simultaneous database
1518 connections by using this framework.
1520 Currently the libdbi driver in Bacula project only supports the same drivers
1521 natively coded in Bacula. However the libdbi project has support for many
1522 others database engines. You can view the list at
1523 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1524 supported by Bacula, however, they must be tested properly by the Bacula team.
1526 Some of benefits of using libdbi are:
1528 \item The possibility to use proprietary databases engines in which your
1529 proprietary licenses prevent the Bacula team from developing the driver.
1530 \item The possibility to use the drivers written for the libdbi project.
1531 \item The possibility to use other database engines without recompiling Bacula
1532 to use them. Just change one line in bacula-dir.conf
1533 \item Abstract Database access, this is, unique point to code and profiling
1534 catalog database access.
1537 The following drivers have been tested:
1539 \item PostgreSQL, with and without batch insert
1540 \item Mysql, with and without batch insert
1545 In the future, we will test and approve to use others databases engines
1546 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1548 To compile Bacula to support libdbi we need to configure the code with the
1549 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1550 [database] is the database engine to be used with Bacula (of course we can
1551 change the driver in file bacula-dir.conf, see below). We must configure the
1552 access port of the database engine with the option --with-db-port, because the
1553 libdbi framework doesn't know the default access port of each database.
1555 The next phase is checking (or configuring) the bacula-dir.conf, example:
1559 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1560 dbname = regress; user = regress; password = ""
1564 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1565 mysql database. Currently the drivers supported by Bacula are: postgresql,
1566 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1568 The following limitations apply when Bacula is set to use the libdbi framework:
1569 - Not tested on the Win32 platform
1570 - A little performance is lost if comparing with native database driver.
1571 The reason is bound with the database driver provided by libdbi and the
1572 simple fact that one more layer of code was added.
1574 It is important to remember, when compiling Bacula with libdbi, the
1575 following packages are needed:
1577 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1578 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1581 You can download them and compile them on your system or install the packages
1582 from your OS distribution.
1584 \section{Console Command Additions and Enhancements}
1585 \index[general]{Console Additions}
1587 \subsection{Display Autochanger Content}
1588 \index[general]{StatusSlots}
1590 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1591 autochanger content.
1595 Slot | Volume Name | Status | Media Type | Pool |
1596 ------+---------------+----------+-------------------+------------|
1597 1 | 00001 | Append | DiskChangerMedia | Default |
1598 2 | 00002 | Append | DiskChangerMedia | Default |
1599 3*| 00003 | Append | DiskChangerMedia | Scratch |
1604 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1605 {\bf update slots} command to synchronize autochanger content with your
1608 \subsection{list joblog job=xxx or jobid=nnn}
1609 \index[general]{list joblog}
1610 A new list command has been added that allows you to list the contents
1611 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1612 or for a particular JobId. The {\bf llist} command will include a line with
1613 the time and date of the entry.
1615 Note for the catalog to have Job Log entries, you must have a directive
1622 In your Director's {\bf Messages} resource.
1624 \subsection{Use separator for multiple commands}
1625 \index[general]{Command Separator}
1626 When using bconsole with readline, you can set the command separator with
1627 \textbf{@separator} command to one
1628 of those characters to write commands who require multiple input in one line.
1630 !$%&'()*+,-/:;<>?[]^`{|}~
1633 \subsection{Deleting Volumes}
1634 The delete volume bconsole command has been modified to
1635 require an asterisk (*) in front of a MediaId otherwise the
1636 value you enter is a taken to be a Volume name. This is so that
1637 users may delete numeric Volume names. The previous Bacula versions
1638 assumed that all input that started with a number was a MediaId.
1640 This new behavior is indicated in the prompt if you read it
1643 \section{Bare Metal Recovery}
1644 The old bare metal recovery project is essentially dead. One
1645 of the main features of it was that it would build a recovery
1646 CD based on the kernel on your system. The problem was that
1647 every distribution has a different boot procedure and different
1648 scripts, and worse yet, the boot procedures and scripts change
1649 from one distribution to another. This meant that maintaining
1650 (keeping up with the changes) the rescue CD was too much work.
1652 To replace it, a new bare metal recovery USB boot stick has been developed
1653 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1654 boot from a USB key.
1658 \item Recovery can be done from within graphical environment.
1659 \item Recovery can be done in a shell.
1660 \item Ubuntu boots on a large number of Linux systems.
1661 \item The process of updating the system and adding new
1662 packages is not too difficult.
1663 \item The USB key can easily be upgraded to newer Ubuntu versions.
1664 \item The USB key has writable partitions for modifications to
1665 the OS and for modification to your home directory.
1666 \item You can add new files/directories to the USB key very easily.
1667 \item You can save the environment from multiple machines on
1669 \item Bacula Systems is funding its ongoing development.
1672 The disadvantages are:
1674 \item The USB key is usable but currently under development.
1675 \item Not everyone may be familiar with Ubuntu (no worse
1677 \item Some older OSes cannot be booted from USB. This can
1678 be resolved by first booting a Ubuntu LiveCD then plugging
1680 \item Currently the documentation is sketchy and not yet added
1681 to the main manual. See below ...
1684 The documentation and the code can be found in the {\bf rescue} package
1685 in the directory {\bf linux/usb}.
1687 \section{Miscellaneous}
1688 \index[general]{Misc New Features}
1690 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
1691 \index[general]{Allow Mixed Priority}
1692 This directive is only implemented in version 2.5 and later. When
1693 set to {\bf yes} (default {\bf no}), this job may run even if lower
1694 priority jobs are already running. This means a high priority job
1695 will not have to wait for other jobs to finish before starting.
1696 The scheduler will only mix priorities when all running jobs have
1699 Note that only higher priority jobs will start early. Suppose the
1700 director will allow two concurrent jobs, and that two jobs with
1701 priority 10 are running, with two more in the queue. If a job with
1702 priority 5 is added to the queue, it will be run as soon as one of
1703 the running jobs finishes. However, new priority 10 jobs will not
1704 be run until the priority 5 job has finished.
1706 \subsection{Bootstrap File Directive -- FileRegex}
1707 \index[general]{Bootstrap File Directive}
1708 {\bf FileRegex} is a new command that can be added to the bootstrap
1709 (.bsr) file. The value is a regular expression. When specified, only
1710 matching filenames will be restored.
1712 During a restore, if all File records are pruned from the catalog
1713 for a Job, normally Bacula can restore only all files saved. That
1714 is there is no way using the catalog to select individual files.
1715 With this new feature, Bacula will ask if you want to specify a Regex
1716 expression for extracting only a part of the full backup.
1719 Building directory tree for JobId(s) 1,3 ...
1720 There were no files inserted into the tree, so file selection
1721 is not possible.Most likely your retention policy pruned the files
1723 Do you want to restore all the files? (yes\vb{}no): no
1725 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1726 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1729 \subsection{Bootstrap File Optimization Changes}
1730 In order to permit proper seeking on disk files, we have extended the bootstrap
1731 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1732 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1733 address range and end address range respectively. These two directives replace
1734 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1735 VolEndBlock} directives. Bootstrap files containing the old directives will
1736 still work, but will not properly take advantage of proper disk seeking, and
1737 may read completely to the end of a disk volume during a restore. With the new
1738 format (automatically generated by the new Director), restores will seek
1739 properly and stop reading the volume when all the files have been restored.
1741 \subsection{Solaris ZFS/NFSv4 ACLs}
1742 This is an upgrade of the previous Solaris ACL backup code
1743 to the new library format, which will backup both the old
1744 POSIX(UFS) ACLs as well as the ZFS ACLs.
1746 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1747 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1748 be used to transfer from UFS to ZFS filesystems.
1751 \subsection{Virtual Tape Emulation}
1752 \index[general]{Virtual Tape Emulation}
1753 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1754 the tape code but actually reading and writing to a disk file. Used with the
1755 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1756 and 700 slots. This feature is most useful in testing. It is enabled
1757 by using {\bf Device Type = vtape} in the Storage daemon's Device
1758 directive. This feature is only implemented on Linux machines and should not be
1759 used for production.
1761 \subsection{Bat Enhancements}
1762 \index[general]{Bat Enhancements}
1763 Bat (the Bacula Administration Tool) GUI program has been significantly
1764 enhanced and stabilized. In particular, there are new table based status
1765 commands; it can now be easily localized using Qt4 Linguist.
1767 The Bat communications protocol has been significantly enhanced to improve
1768 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1769 the Director you are using otherwise the communications protocol will not
1772 \subsection{RunScript Enhancements}
1773 \index[general]{RunScript Enhancements}
1774 The {\bf RunScript} resource has been enhanced to permit multiple
1775 commands per RunScript. Simply specify multiple {\bf Command} directives
1782 Command = "/bin/echo test"
1783 Command = "/bin/echo an other test"
1784 Command = "/bin/echo 3 commands in the same runscript"
1791 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1792 implemented, which runs the command after the Volume Shadow Copy has been made.
1794 Console commands can be specified within a RunScript by using:
1795 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1796 carefully tested and debugged and is known to easily crash the Director.
1797 We would appreciate feedback. Due to the recursive nature of this command, we
1798 may remove it before the final release.
1800 \subsection{Status Enhancements}
1801 \index[general]{Status Enhancements}
1802 The bconsole {\bf status dir} output has been enhanced to indicate
1803 Storage daemon job spooling and despooling activity.
1805 \subsection{Connect Timeout}
1806 \index[general]{Connect Timeout}
1807 The default connect timeout to the File
1808 daemon has been set to 3 minutes. Previously it was 30 minutes.
1810 \subsection{ftruncate for NFS Volumes}
1811 \index[general]{ftruncate for NFS Volumes}
1812 If you write to a Volume mounted by NFS (say on a local file server),
1813 in previous Bacula versions, when the Volume was recycled, it was not
1814 properly truncated because NFS does not implement ftruncate (file
1815 truncate). This is now corrected in the new version because we have
1816 written code (actually a kind user) that deletes and recreates the Volume,
1817 thus accomplishing the same thing as a truncate.
1819 \subsection{Support for Ubuntu}
1820 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1821 version of Linux, and thus now provides correct autostart routines.
1822 Since Ubuntu officially supports Bacula, you can also obtain any
1823 recent release of Bacula from the Ubuntu repositories.
1825 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1826 \index[general]{Recycle Pool}
1827 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1828 be placed (moved) when it is recycled. Without this directive, a Volume will
1829 remain in the same pool when it is recycled. With this directive, it can be
1830 moved automatically to any existing pool during a recycle. This directive is
1831 probably most useful when defined in the Scratch pool, so that volumes will
1832 be recycled back into the Scratch pool.
1834 \subsection{FD Version}
1835 \index[general]{FD Version}
1836 The File daemon to Director protocol now includes a version
1837 number, which although there is no visible change for users,
1838 will help us in future versions automatically determine
1839 if a File daemon is not compatible.
1841 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1842 \index[general]{Max Run Sched Time}
1843 The time specifies the maximum allowed time that a job may run, counted from
1844 when the job was scheduled. This can be useful to prevent jobs from running
1845 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1848 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1849 \index[general]{Max Wait Time}
1850 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1851 of checking the maximum allowed time that a job may block for a resource,
1852 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1853 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1854 their job depending on the level. Now, they have to use
1855 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1856 directives are now deprecated.
1858 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1859 \index[general]{Incremental Max Wait Time}
1860 \index[general]{Differential Max Wait Time}
1862 These directives have been deprecated in favor of
1863 \texttt{Incremental|Differential Max Run Time}.
1865 \subsection{Max Run Time directives}
1866 \index[general]{Max Run Time directives}
1867 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1868 maximum allowed time that a job can run depending on the level.
1870 \addcontentsline{lof}{figure}{Job time control directives}
1871 \includegraphics{\idir different_time.eps}
1873 \subsection{Statistics Enhancements}
1874 \index[general]{Statistics Enhancements}
1875 If you (or probably your boss) want to have statistics on your backups to
1876 provide some \textit{Service Level Agreement} indicators, you could use a few
1877 SQL queries on the Job table to report how many:
1881 \item jobs have been successful
1882 \item files have been backed up
1886 However, these statistics are accurate only if your job retention is greater
1887 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1888 be able to use them.
1890 Now, you can use the \textbf{update stats [days=num]} console command to fill
1891 the JobHistory table with new Job records. If you want to be sure to take in
1892 account only \textbf{good jobs}, ie if one of your important job has failed but
1893 you have fixed the problem and restarted it on time, you probably want to
1894 delete the first \textit{bad} job record and keep only the successful one. For
1895 that simply let your staff do the job, and update JobHistory table after two or
1896 three days depending on your organization using the \textbf{[days=num]} option.
1898 These statistics records aren't used for restoring, but mainly for
1899 capacity planning, billings, etc.
1901 The Bweb interface provides a statistics module that can use this feature. You
1902 can also use tools like Talend or extract information by yourself.
1904 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1905 the length of time that Bacula will keep statistics job records in the Catalog
1906 database after the Job End time. (In \texttt{JobHistory} table) When this time
1907 period expires, and if user runs \texttt{prune stats} command, Bacula will
1908 prune (remove) Job records that are older than the specified period.
1910 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1911 job to maintain statistics.
1914 Name = BackupCatalog
1917 Console = "update stats days=3"
1918 Console = "prune stats yes"
1925 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1926 \index[general]{ScratchPool}
1927 This directive permits to specify a specific \textsl{Scratch} pool for the
1928 current pool. This is useful when using multiple storage sharing the same
1929 mediatype or when you want to dedicate volumes to a particular set of pool.
1931 \subsection{Enhanced Attribute Despooling}
1932 \index[general]{Attribute Despooling}
1933 If the storage daemon and the Director are on the same machine, the spool file
1934 that contains attributes is read directly by the Director instead of being
1935 transmitted across the network. That should reduce load and speedup insertion.
1937 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1938 \index[general]{SpoolSize}
1939 A new Job directive permits to specify the spool size per job. This is used
1940 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1942 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1943 \index[general]{MaxConsoleConnections}
1944 A new director directive permits to specify the maximum number of Console
1945 Connections that could run concurrently. The default is set to 20, but you may
1946 set it to a larger number.
1948 \subsection{VerId = \lt{}string\gt{}}
1949 \index[general]{VerId}
1950 A new director directive permits to specify a personnal identifier that will be
1951 displayed in the \texttt{version} command.
1953 \subsection{dbcheck enhancements}
1954 \index[general]{dbcheck enhancements}
1955 If you are using Mysql, dbcheck will now ask you if you want to create
1956 temporary indexes to speed up orphaned Path and Filename elimination.
1958 A new \texttt{-B} option allows you to print catalog information in a simple
1959 text based format. This is useful to backup it in a secure way.
1974 You can now specify the database connection port in the command line.
1976 \subsection{{-}{-}docdir configure option}
1977 \index[general]{{-}{-}docdir configure option}
1978 You can use {-}{-}docdir= on the ./configure command to
1979 specify the directory where you want Bacula to install the
1980 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
1981 {\bf /usr/share/doc/bacula}.
1983 \subsection{{-}{-}htmldir configure option}
1984 \index[general]{{-}{-}htmldir configure option}
1985 You can use {-}{-}htmldir= on the ./configure command to
1986 specify the directory where you want Bacula to install the bat html help
1987 files. The default is {\bf /usr/share/doc/bacula/html}
1989 \subsection{{-}{-}with-plugindir configure option}
1990 \index[general]{{-}{-}plugindir configure option}
1991 You can use {-}{-}plugindir= on the ./configure command to
1992 specify the directory where you want Bacula to install
1993 the plugins (currently only bpipe-fd). The default is