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
51 This project was funded by Bacula Systems with the help of Equiinet.
53 \section{File Deduplication using Base Jobs}
54 A base job is sort of like a Full save except that you will want the FileSet to
55 contain only files that are unlikely to change in the future (i.e. a snapshot
56 of most of your system after installing it). After the base job has been run,
57 when you are doing a Full save, you specify one or more Base jobs to be used.
58 All files that have been backed up in the Base job/jobs but not modified will
59 then be excluded from the backup. During a restore, the Base jobs will be
60 automatically pulled in where necessary.
62 This is something none of the competition does, as far as we know (except
63 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
64 win for the user, it makes Bacula stand out as offering a unique optimization
65 that immediately saves time and money. Basically, imagine that you have 100
66 nearly identical Windows or Linux machine containing the OS and user files.
67 Now for the OS part, a Base job will be backed up once, and rather than making
68 100 copies of the OS, there will be only one. If one or more of the systems
69 have some files updated, no problem, they will be automatically restored.
71 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
72 files that will be used during Full backup as base.
83 Base = BackupZog4, BackupLinux
89 In this example, the job \texttt{BackupZog4} will use the most recent version
90 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
91 jobs. Base jobs should have run with \texttt{level=Base} to be used.
93 By default, Bacula will compare permissions bits, user and group fields,
94 modification time, size and the checksum of the file to choose between the
95 current backup and the BaseJob file list. You can change this behavior with the
96 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
97 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
114 This project was funded by Bacula Systems.
116 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
117 \index[dir]{AllowCompression}
119 This new directive may be added to Storage resource within the Director's
120 configuration to allow users to selectively disable the client compression for
121 any job which writes to this storage resource.
127 Address = ultrium-tape
128 Password = storage_password # Password for Storage Daemon
131 AllowCompression = No # Tape drive has hardware compression
134 The above example would cause any jobs running with the UltriumTape storage
135 resource to run without compression from the client file daemons. This
136 effectively overrides any compression settings defined at the FileSet level.
138 This feature is probably most useful if you have a tape drive which supports
139 hardware compression. By setting the \texttt{AllowCompression = No} directive
140 for your tape drive storage resource, you can avoid additional load on the file
141 daemon and possibly speed up tape backups.
143 This project was funded by Collaborative Fusion, Inc.
145 \section{Accurate Fileset Options}
146 \label{sec:accuratefileset}
148 In previous versions, the accurate code used the file creation and modification
149 times to determine if a file was modified or not. Now you can specify which
150 attributes to use (time, size, checksum, permission, owner, group, \dots),
151 similar to the Verify options.
171 compare the permission bits
174 compare the number of links
186 compare the access time
189 compare the modification time (st\_mtime)
192 compare the change time (st\_ctime)
195 report file size decreases
198 compare the MD5 signature
201 compare the SHA1 signature
204 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
205 the File Daemon will have to read all files even if they normally would not
206 be saved. This increases the I/O load, but also the accuracy of the
207 deduplication. By default, Bacula will check modification/creation time
210 \section{Tab-completion for Bconsole}
211 \label{sec:tabcompletion}
213 If you build \texttt{bconsole} with readline support, you will be able to use
214 the new auto-completion mode. This mode supports all commands, gives help
215 inside command, and lists resources when required. It works also in the restore
218 To use this feature, you should have readline development package loaded on
219 your system, and use the following option in configure.
221 ./configure --with-readline=/usr/include/readline --disable-conio ...
224 The new bconsole won't be able to tab-complete with older directors.
229 To help developers of restore GUI interfaces, we have added new \textsl{dot
230 commands} that permit browsing the catalog in a very simple way.
233 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
234 the Bvfs cache in the catalog. You need to run it before any access to the
237 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
238 will list all directories in the specified \texttt{path} or
239 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
240 encoding of path/filenames.
242 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
243 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
244 \texttt{pathid} avoids problems with character encoding.
247 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
248 data that will be displayed.
251 * .bvfs_update jobid=1,2
253 * .bvfs_lsdir path=/ jobid=1,2
256 \section{Testing your Tape Drive}
257 \label{sec:btapespeed}
259 To determine the best configuration of your tape drive, you can run the new
260 \texttt{speed} command available in the \texttt{btape} program.
262 This command can have the following arguments:
264 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
265 (between 1 and 5GB). This counter is in GB.
266 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
267 of data should be greater than your memory ($file\_size*nb\_file$).
268 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
270 \item[\texttt{skip\_random}] This flag permits to skip tests with random
272 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
273 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
278 *speed file_size=3 skip_raw
279 btape.c:1078 Test with zero data and bacula block structure.
280 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
281 ++++++++++++++++++++++++++++++++++++++++++
282 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
283 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
285 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
287 btape.c:1090 Test with random data, should give the minimum throughput.
288 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
289 +++++++++++++++++++++++++++++++++++++++++++
290 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
291 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
292 +++++++++++++++++++++++++++++++++++++++++++
294 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
298 When using compression, the random test will give your the minimum throughput
299 of your drive . The test using constant string will give you the maximum speed
300 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
302 You can change the block size in the Storage Daemon configuration file.
304 \section{New {\bf Block Checksum} Device Directive}
305 You may now turn off the Block Checksum (CRC32) code
306 that Bacula uses when writing blocks to a Volume. This is
313 doing so can reduce the Storage daemon CPU usage slightly. It
314 will also permit Bacula to read a Volume that has corrupted data.
316 The default is {\bf yes} -- i.e. the checksum is computed on write
319 We do not recommend to turn this off particularly on older tape
320 drives or for disk Volumes where doing so may allow corrupted data
323 \section{New Bat Features}
325 \subsection{Media List View}
327 By clicking on ``Media'', you can see the list of all your volumes. You will be
328 able to filter by Pool, Media Type, Location,\dots And sort the result directly
329 in the table. The old ``Media'' view is now known as ``Pool''.
332 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
333 \label{fig:mediaview}
337 \subsection{Media Information View}
339 By double-clicking on a volume (on the Media list, in the Autochanger content
340 or in the Job information panel), you can access a detailed overview of your
341 Volume. (cf \ref{fig:mediainfo}.)
344 \includegraphics[width=13cm]{\idir bat11.eps}
345 \caption{Media information}
346 \label{fig:mediainfo}
349 \subsection{Job Information View}
351 By double-clicking on a Job record (on the Job run list or in the Media
352 information panel), you can access a detailed overview of your Job. (cf
356 \includegraphics[width=13cm]{\idir bat12.eps}
357 \caption{Job information}
361 \subsection{Autochanger Content View}
363 By double-clicking on a Storage record (on the Storage list panel), you can
364 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
367 \includegraphics[width=13cm]{\idir bat13.eps}
368 \caption{Autochanger content}
369 \label{fig:achcontent}
372 \section{Console Timeout Option}
373 You can now use the -u option of bconsole to set a timeout for each command.
375 \chapter{New Features in Released Version 3.0.2}
377 This chapter presents the new features added to the
378 Released Bacula Version 3.0.2.
380 \section{Full Restore from a Given JobId}
381 \index[general]{Restore menu}
383 This feature allows selecting a single JobId and having Bacula
384 automatically select all the other jobs that comprise a full backup up to
385 and including the selected date (through JobId).
387 Assume we start with the following jobs:
389 +-------+--------------+---------------------+-------+----------+------------+
390 | jobid | client | starttime | level | jobfiles | jobbytes |
391 +-------+--------------+---------------------+-------+----------+------------
392 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
393 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
394 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
395 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
396 +-------+--------------+---------------------+-------+----------+------------+
399 Below is an example of this new feature (which is number 12 in the
404 To select the JobIds, you have the following choices:
405 1: List last 20 Jobs run
406 2: List Jobs where a given File is saved
408 12: Select full restore to a specified Job date
411 Select item: (1-13): 12
412 Enter JobId to get the state to restore: 5
413 Selecting jobs to build the Full state at 2009-07-15 11:45:45
414 You have selected the following JobIds: 1,3,5
416 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
417 1,444 files inserted into the tree.
420 This project was funded by Bacula Systems.
422 \section{Source Address}
423 \index[general]{Source Address}
425 A feature has been added which allows the administrator to specify the address
426 from which the Director and File daemons will establish connections. This
427 may be used to simplify system configuration overhead when working in complex
428 networks utilizing multi-homing and policy-routing.
430 To accomplish this, two new configuration directives have been implemented:
433 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
437 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
441 Simply adding specific host routes on the OS
442 would have an undesirable side-effect: any
443 application trying to contact the destination host would be forced to use the
444 more specific route possibly diverting management traffic onto a backup VLAN.
445 Instead of adding host routes for each client connected to a multi-homed backup
446 server (for example where there are management and backup VLANs), one can
447 use the new directives to specify a specific source address at the application
450 Additionally, this allows the simplification and abstraction of firewall rules
451 when dealing with a Hot-Standby director or storage daemon configuration. The
452 Hot-standby pair may share a CARP address, which connections must be sourced
453 from, while system services listen and act from the unique interface addresses.
455 This project was funded by Collaborative Fusion, Inc.
457 \section{Show volume availability when doing restore}
459 When doing a restore the selection dialog ends by displaying this
463 The job will require the following
464 Volume(s) Storage(s) SD Device(s)
465 ===========================================================================
476 Volumes marked with ``*'' are online (in the autochanger).
479 This should help speed up large restores by minimizing the time spent
480 waiting for the operator to discover that he must change tapes in the library.
482 This project was funded by Bacula Systems.
484 \section{Accurate estimate command}
486 The \texttt{estimate} command can now use the accurate code to detect changes
487 and give a better estimation.
489 You can set the accurate behavior on the command line by using
490 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
493 * estimate listing accurate=yes level=incremental job=BackupJob
496 This project was funded by Bacula Systems.
498 \chapter{New Features in 3.0.0}
499 \label{NewFeaturesChapter}
500 \index[general]{New Features}
502 This chapter presents the new features added to the development 2.5.x
503 versions to be released as Bacula version 3.0.0 sometime in April 2009.
505 \section{Accurate Backup}
506 \index[general]{Accurate Backup}
508 As with most other backup programs, by default Bacula decides what files to
509 backup for Incremental and Differental backup by comparing the change
510 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
511 backup completed. If one of those two times is later than the last backup
512 time, then the file will be backed up. This does not, however, permit tracking
513 what files have been deleted and will miss any file with an old time that may
514 have been restored to or moved onto the client filesystem.
516 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
517 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
518 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
519 backup, there is no difference, but for {\bf Differential} and {\bf
520 Incremental} backups, the Director will send a list of all previous files
521 backed up, and the File daemon will use that list to determine if any new files
522 have been added or or moved and if any files have been deleted. This allows
523 Bacula to make an accurate backup of your system to that point in time so that
524 if you do a restore, it will restore your system exactly.
527 about using Accurate backup is that it requires more resources (CPU and memory)
528 on both the Director and the Client machines to create the list of previous
529 files backed up, to send that list to the File daemon, for the File daemon to
530 keep the list (possibly very big) in memory, and for the File daemon to do
531 comparisons between every file in the FileSet and the list. In particular,
532 if your client has lots of files (more than a few million), you will need
533 lots of memory on the client machine.
535 Accurate must not be enabled when backing up with a plugin that is not
536 specially designed to work with Accurate. If you enable it, your restores
537 will probably not work correctly.
539 This project was funded by Bacula Systems.
544 \index[general]{Copy Jobs}
546 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
547 existing Migration feature with the exception that the Job that is copied is
548 left unchanged. This essentially creates two identical copies of the same
549 backup. However, the copy is treated as a copy rather than a backup job, and
550 hence is not directly available for restore. The {\bf restore} command lists
551 copy jobs and allows selection of copies by using \texttt{jobid=}
552 option. If the keyword {\bf copies} is present on the command line, Bacula will
553 display the list of all copies for selected jobs.
558 These JobIds have copies as follows:
559 +-------+------------------------------------+-----------+------------------+
560 | JobId | Job | CopyJobId | MediaType |
561 +-------+------------------------------------+-----------+------------------+
562 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
563 +-------+------------------------------------+-----------+------------------+
564 +-------+-------+----------+----------+---------------------+------------------+
565 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
566 +-------+-------+----------+----------+---------------------+------------------+
567 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
568 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
569 +-------+-------+----------+----------+---------------------+------------------+
570 You have selected the following JobIds: 19,2
572 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
573 5,611 files inserted into the tree.
578 The Copy Job runs without using the File daemon by copying the data from the
579 old backup Volume to a different Volume in a different Pool. See the Migration
580 documentation for additional details. For copy Jobs there is a new selection
581 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
582 not already copied to another Pool.
584 As with Migration, the Client, Volume, Job, or SQL query, are
585 other possible ways of selecting the Jobs to be copied. Selection
586 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
587 work, but are probably more suited for Migration Jobs.
589 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
590 it will promote the Copy to a \textsl{real} backup job and will make it available for
591 automatic restore. If more than one Copy is available, it will promote the copy
592 with the smallest JobId.
594 A nice solution which can be built with the new Copy feature is often
595 called disk-to-disk-to-tape backup (DTDTT). A sample config could
596 look something like the one below:
600 Name = FullBackupsVirtualPool
602 Purge Oldest Volume = Yes
604 NextPool = FullBackupsTapePool
608 Name = FullBackupsTapePool
612 Volume Retention = 365 days
613 Storage = superloader
617 # Fake fileset for copy jobs
629 # Fake client for copy jobs
639 # Default template for a CopyDiskToTape Job
642 Name = CopyDiskToTape
644 Messages = StandardCopy
647 Selection Type = PoolUncopiedJobs
648 Maximum Concurrent Jobs = 10
650 Allow Duplicate Jobs = Yes
651 Allow Higher Duplicates = No
652 Cancel Queued Duplicates = No
653 Cancel Running Duplicates = No
658 Name = DaySchedule7:00
659 Run = Level=Full daily at 7:00
663 Name = CopyDiskToTapeFullBackups
665 Schedule = DaySchedule7:00
666 Pool = FullBackupsVirtualPool
667 JobDefs = CopyDiskToTape
671 The example above had 2 pool which are copied using the PoolUncopiedJobs
672 selection criteria. Normal Full backups go to the Virtual pool and are copied
673 to the Tape pool the next morning.
675 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
680 +-------+------------------------------------+-----------+------------------+
681 | JobId | Job | CopyJobId | MediaType |
682 +-------+------------------------------------+-----------+------------------+
683 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
684 +-------+------------------------------------+-----------+------------------+
687 \section{ACL Updates}
688 \index[general]{ACL Updates}
689 The whole ACL code had been overhauled and in this version each platforms has
690 different streams for each type of acl available on such an platform. As ACLs
691 between platforms tend to be not that portable (most implement POSIX acls but
692 some use an other draft or a completely different format) we currently only
693 allow certain platform specific ACL streams to be decoded and restored on the
694 same platform that they were created on. The old code allowed to restore ACL
695 cross platform but the comments already mention that not being to wise. For
696 backward compatability the new code will accept the two old ACL streams and
697 handle those with the platform specific handler. But for all new backups it
698 will save the ACLs using the new streams.
700 Currently the following platforms support ACLs:
704 \item {\bf Darwin/OSX}
713 Currently we support the following ACL types (these ACL streams use a reserved
714 part of the stream numbers):
717 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
719 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
720 string representation from acl\_to\_text (POSIX acl)
721 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
722 string representation from acl\_to\_text (POSIX acl) for default acls.
723 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
724 string representation from acl\_to\_text (POSIX acl) for access acls.
725 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
726 string representation from acltostr (POSIX acl)
727 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
728 representation from acl\_to\_text (POSIX acl) for default acls.
729 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
730 representation from acl\_to\_text (POSIX acl) for access acls.
731 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
732 string representation from acl\_to\_text (POSIX acl) for default acls.
733 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
734 representation from acl\_to\_text (POSIX acl) for access acls.
735 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
736 string representation from acl\_to\_text (POSIX acl) for default acls.
737 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
738 string representation from acl\_to\_text (POSIX acl) for default acls.
739 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
740 representation from acl\_to\_text (POSIX acl) for access acls.
741 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
742 string representation from acltotext or acl\_totext (POSIX acl)
743 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
744 representation from from acl\_totext (NFSv4 or ZFS acl)
747 In future versions we might support conversion functions from one type of acl
748 into an other for types that are either the same or easily convertable. For now
749 the streams are seperate and restoring them on a platform that doesn't
750 recognize them will give you a warning.
752 \section{Extended Attributes}
753 \index[general]{Extended Attributes}
754 Something that was on the project list for some time is now implemented for
755 platforms that support a similar kind of interface. Its the support for backup
756 and restore of so called extended attributes. As extended attributes are so
757 platform specific these attributes are saved in seperate streams for each
758 platform. Restores of the extended attributes can only be performed on the
759 same platform the backup was done. There is support for all types of extended
760 attributes, but restoring from one type of filesystem onto an other type of
761 filesystem on the same platform may lead to supprises. As extended attributes
762 can contain any type of data they are stored as a series of so called
763 value-pairs. This data must be seen as mostly binary and is stored as such.
764 As security labels from selinux are also extended attributes this option also
765 stores those labels and no specific code is enabled for handling selinux
768 Currently the following platforms support extended attributes:
770 \item {\bf Darwin/OSX}
776 On linux acls are also extended attributes, as such when you enable ACLs on a
777 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
778 and not the same exteneded attribute.
780 To enable the backup of extended attributes please add the following to your
795 \section{Shared objects}
796 \index[general]{Shared objects}
797 A default build of Bacula will now create the libraries as shared objects
798 (.so) rather than static libraries as was previously the case.
799 The shared libraries are built using {\bf libtool} so it should be quite
802 An important advantage of using shared objects is that on a machine with the
803 Directory, File daemon, the Storage daemon, and a console, you will have only
804 one copy of the code in memory rather than four copies. Also the total size of
805 the binary release is smaller since the library code appears only once rather
806 than once for every program that uses it; this results in significant reduction
807 in the size of the binaries particularly for the utility tools.
809 In order for the system loader to find the shared objects when loading the
810 Bacula binaries, the Bacula shared objects must either be in a shared object
811 directory known to the loader (typically /usr/lib) or they must be in the
812 directory that may be specified on the {\bf ./configure} line using the {\bf
813 {-}{-}libdir} option as:
816 ./configure --libdir=/full-path/dir
819 the default is /usr/lib. If {-}{-}libdir is specified, there should be
820 no need to modify your loader configuration provided that
821 the shared objects are installed in that directory (Bacula
822 does this with the make install command). The shared objects
823 that Bacula references are:
832 These files are symbolically linked to the real shared object file,
833 which has a version number to permit running multiple versions of
834 the libraries if desired (not normally the case).
836 If you have problems with libtool or you wish to use the old
837 way of building static libraries, or you want to build a static
838 version of Bacula you may disable
839 libtool on the configure command line with:
842 ./configure --disable-libtool
846 \section{Building Static versions of Bacula}
847 \index[general]{Static linking}
848 In order to build static versions of Bacula, in addition
849 to configuration options that were needed you now must
850 also add --disable-libtool. Example
853 ./configure --enable-static-client-only --disable-libtool
857 \section{Virtual Backup (Vbackup)}
858 \index[general]{Virtual Backup}
859 \index[general]{Vbackup}
861 Bacula's virtual backup feature is often called Synthetic Backup or
862 Consolidation in other backup products. It permits you to consolidate the
863 previous Full backup plus the most recent Differential backup and any
864 subsequent Incremental backups into a new Full backup. This new Full
865 backup will then be considered as the most recent Full for any future
866 Incremental or Differential backups. The VirtualFull backup is
867 accomplished without contacting the client by reading the previous backup
868 data and writing it to a volume in a different pool.
870 In some respects the Vbackup feature works similar to a Migration job, in
871 that Bacula normally reads the data from the pool specified in the
872 Job resource, and writes it to the {\bf Next Pool} specified in the
873 Job resource. Note, this means that usually the output from the Virtual
874 Backup is written into a different pool from where your prior backups
875 are saved. Doing it this way guarantees that you will not get a deadlock
876 situation attempting to read and write to the same volume in the Storage
877 daemon. If you then want to do subsequent backups, you may need to
878 move the Virtual Full Volume back to your normal backup pool.
879 Alternatively, you can set your {\bf Next Pool} to point to the current
880 pool. This will cause Bacula to read and write to Volumes in the
881 current pool. In general, this will work, because Bacula will
882 not allow reading and writing on the same Volume. In any case, once
883 a VirtualFull has been created, and a restore is done involving the
884 most current Full, it will read the Volume or Volumes by the VirtualFull
885 regardless of in which Pool the Volume is found.
887 The Vbackup is enabled on a Job by Job in the Job resource by specifying
888 a level of {\bf VirtualFull}.
890 A typical Job resource definition might look like the following:
904 # Default pool definition
908 Recycle = yes # Automatically recycle Volumes
909 AutoPrune = yes # Prune expired volumes
910 Volume Retention = 365d # one year
918 Recycle = yes # Automatically recycle Volumes
919 AutoPrune = yes # Prune expired volumes
920 Volume Retention = 365d # one year
921 Storage = DiskChanger
924 # Definition of file storage device
931 Maximum Concurrent Jobs = 5
934 # Definition of DDS Virtual tape disk storage device
937 Address = localhost # N.B. Use a fully qualified name here
940 Media Type = DiskChangerMedia
941 Maximum Concurrent Jobs = 4
946 Then in bconsole or via a Run schedule, you would run the job as:
949 run job=MyBackup level=Full
950 run job=MyBackup level=Incremental
951 run job=MyBackup level=Differential
952 run job=MyBackup level=Incremental
953 run job=MyBackup level=Incremental
956 So providing there were changes between each of those jobs, you would end up
957 with a Full backup, a Differential, which includes the first Incremental
958 backup, then two Incremental backups. All the above jobs would be written to
959 the {\bf Default} pool.
961 To consolidate those backups into a new Full backup, you would run the
965 run job=MyBackup level=VirtualFull
968 And it would produce a new Full backup without using the client, and the output
969 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
971 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
974 Note, the Start and End time of the Virtual Full backup is set to the
975 values for the last job included in the Virtual Full (in the above example,
976 it is an Increment). This is so that if another incremental is done, which
977 will be based on the Virtual Full, it will backup all files from the
978 last Job included in the Virtual Full rather than from the time the Virtual
979 Full was actually run.
983 \section{Catalog Format}
984 \index[general]{Catalog Format}
985 Bacula 3.0 comes with some changes to the catalog format. The upgrade
986 operation will convert the FileId field of the File table from 32 bits (max 4
987 billion table entries) to 64 bits (very large number of items). The
988 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
989 your catalog during the conversion. Also you won't be able to run jobs during
990 this conversion period. For example, a 3 million file catalog will take 2
991 minutes to upgrade on a normal machine. Please don't forget to make a valid
992 backup of your database before executing the upgrade script. See the
993 ReleaseNotes for additional details.
995 \section{64 bit Windows Client}
996 \index[general]{Win64 Client}
997 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
998 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
999 As a consequence, we are also releasing a 64 bit version of the Bacula
1000 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1001 These binaries should only be installed on 64 bit Windows operating systems.
1002 What is important is not your hardware but whether or not you have
1003 a 64 bit version of the Windows OS.
1005 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1007 \item Before installing the Win64 Bacula Client, you must totally
1008 deinstall any prior 2.4.x Client installation using the
1009 Bacula deinstallation (see the menu item). You may want
1010 to save your .conf files first.
1011 \item Only the Client (File daemon) is ported to Win64, the Director
1012 and the Storage daemon are not in the 64 bit Windows installer.
1013 \item bwx-console is not yet ported.
1014 \item bconsole is ported but it has not been tested.
1015 \item The documentation is not included in the installer.
1016 \item Due to Vista security restrictions imposed on a default installation
1017 of Vista, before upgrading the Client, you must manually stop
1018 any prior version of Bacula from running, otherwise the install
1020 \item Due to Vista security restrictions imposed on a default installation
1021 of Vista, attempting to edit the conf files via the menu items
1022 will fail. You must directly edit the files with appropriate
1023 permissions. Generally double clicking on the appropriate .conf
1024 file will work providing you have sufficient permissions.
1025 \item All Bacula files are now installed in
1026 {\bf C:/Program Files/Bacula} except the main menu items,
1027 which are installed as before. This vastly simplifies the installation.
1028 \item If you are running on a foreign language version of Windows, most
1029 likely {\bf C:/Program Files} does not exist, so you should use the
1030 Custom installation and enter an appropriate location to install
1032 \item The 3.0.0 Win32 Client continues to install files in the locations used
1033 by prior versions. For the next version we will convert it to use
1034 the same installation conventions as the Win64 version.
1037 This project was funded by Bacula Systems.
1040 \section{Duplicate Job Control}
1041 \index[general]{Duplicate Jobs}
1042 The new version of Bacula provides four new directives that
1043 give additional control over what Bacula does if duplicate jobs
1044 are started. A duplicate job in the sense we use it here means
1045 a second or subsequent job with the same name starts. This
1046 happens most frequently when the first job runs longer than expected because no
1047 tapes are available.
1049 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1050 are specified in the Job resource.
1054 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1055 \index[general]{Allow Duplicate Jobs}
1056 If this directive is enabled duplicate jobs will be run. If
1057 the directive is set to {\bf no} (default) then only one job of a given name
1058 may run at one time, and the action that Bacula takes to ensure only
1059 one job runs is determined by the other directives (see below).
1061 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1062 are present and none of the three directives given below permit
1063 cancelling a job, then the current job (the second one started)
1067 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1068 \index[general]{Allow Higher Duplicates}
1069 If this directive is set to {\bf yes} (default) the job with a higher
1070 priority (lower priority number) will be permitted to run, and
1071 the current job will be cancelled. If the
1072 priorities of the two jobs are the same, the outcome is determined by
1073 other directives (see below).
1075 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1076 \index[general]{Cancel Queued Duplicates}
1077 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1078 if this directive is set to {\bf yes} any job that is
1079 already queued to run but not yet running will be canceled.
1080 The default is {\bf no}.
1082 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1083 \index[general]{Cancel Running Duplicates}
1084 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1085 if this directive is set to {\bf yes} any job that is already running
1086 will be canceled. The default is {\bf no}.
1089 \section{TLS Authentication}
1090 \index[general]{TLS Authentication}
1091 In Bacula version 2.5.x and later, in addition to the normal Bacula
1092 CRAM-MD5 authentication that is used to authenticate each Bacula
1093 connection, you can specify that you want TLS Authentication as well,
1094 which will provide more secure authentication.
1096 This new feature uses Bacula's existing TLS code (normally used for
1097 communications encryption) to do authentication. To use it, you must
1098 specify all the TLS directives normally used to enable communications
1099 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1102 \subsection{TLS Authenticate = yes}
1104 TLS Authenticate = yes
1107 in the main daemon configuration resource (Director for the Director,
1108 Client for the File daemon, and Storage for the Storage daemon).
1110 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1111 authentication, Bacula will also do TLS authentication, then TLS
1112 encryption will be turned off, and the rest of the communication between
1113 the two Bacula daemons will be done without encryption.
1115 If you want to encrypt communications data, use the normal TLS directives
1116 but do not turn on {\bf TLS Authenticate}.
1118 \section{bextract non-portable Win32 data}
1119 \index[general]{bextract handles Win32 non-portable data}
1120 {\bf bextract} has been enhanced to be able to restore
1121 non-portable Win32 data to any OS. Previous versions were
1122 unable to restore non-portable Win32 data to machines that
1123 did not have the Win32 BackupRead and BackupWrite API calls.
1125 \section{State File updated at Job Termination}
1126 \index[general]{State File}
1127 In previous versions of Bacula, the state file, which provides a
1128 summary of previous jobs run in the {\bf status} command output was
1129 updated only when Bacula terminated, thus if the daemon crashed, the
1130 state file might not contain all the run data. This version of
1131 the Bacula daemons updates the state file on each job termination.
1133 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1134 \index[general]{MaxFullInterval}
1135 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1136 can be used to specify the maximum time interval between {\bf Full} backup
1137 jobs. When a job starts, if the time since the last Full backup is
1138 greater than the specified interval, and the job would normally be an
1139 {\bf Incremental} or {\bf Differential}, it will be automatically
1140 upgraded to a {\bf Full} backup.
1142 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1143 \index[general]{MaxDiffInterval}
1144 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1145 can be used to specify the maximum time interval between {\bf Differential} backup
1146 jobs. When a job starts, if the time since the last Differential backup is
1147 greater than the specified interval, and the job would normally be an
1148 {\bf Incremental}, it will be automatically
1149 upgraded to a {\bf Differential} backup.
1151 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1152 \index[general]{MaxDiffInterval}
1153 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1154 by the user, and when it is set it is an indication to backup programs
1155 to not backup that particular file. This version of Bacula contains a
1156 new Options directive within a FileSet resource, which instructs Bacula to
1157 obey this flag. The new directive is:
1160 Honor No Dump Flag = yes\vb{}no
1163 The default value is {\bf no}.
1166 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1167 \index[general]{IgnoreDir}
1168 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1169 can be added to the Include section of the FileSet resource. If the specified
1170 filename ({\bf filename-string}) is found on the Client in any directory to be
1171 backed up, the whole directory will be ignored (not backed up). For example:
1174 # List of files to be backed up
1182 Exclude Dir Containing = .excludeme
1187 But in /home, there may be hundreds of directories of users and some
1188 people want to indicate that they don't want to have certain
1189 directories backed up. For example, with the above FileSet, if
1190 the user or sysadmin creates a file named {\bf .excludeme} in
1191 specific directories, such as
1194 /home/user/www/cache/.excludeme
1195 /home/user/temp/.excludeme
1198 then Bacula will not backup the two directories named:
1201 /home/user/www/cache
1205 NOTE: subdirectories will not be backed up. That is, the directive
1206 applies to the two directories in question and any children (be they
1207 files, directories, etc).
1210 \section{Bacula Plugins}
1211 \index[general]{Plugin}
1212 Support for shared object plugins has been implemented in the Linux, Unix
1213 and Win32 File daemons. The API will be documented separately in
1214 the Developer's Guide or in a new document. For the moment, there is
1215 a single plugin named {\bf bpipe} that allows an external program to
1216 get control to backup and restore a file.
1218 Plugins are also planned (partially implemented) in the Director and the
1221 \subsection{Plugin Directory}
1222 \index[general]{Plugin Directory}
1223 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1224 be added to the daemon definition resource. The directory takes a quoted
1225 string argument, which is the name of the directory in which the daemon can
1226 find the Bacula plugins. If this directive is not specified, Bacula will not
1227 load any plugins. Since each plugin has a distinctive name, all the daemons
1228 can share the same plugin directory.
1230 \subsection{Plugin Options}
1231 \index[general]{Plugin Options}
1232 The {\bf Plugin Options} directive takes a quoted string
1233 arguement (after the equal sign) and may be specified in the
1234 Job resource. The options specified will be passed to all plugins
1235 when they are run. This each plugin must know what it is looking
1236 for. The value defined in the Job resource can be modified
1237 by the user when he runs a Job via the {\bf bconsole} command line
1240 Note: this directive may be specified, and there is code to modify
1241 the string in the run command, but the plugin options are not yet passed to
1242 the plugin (i.e. not fully implemented).
1244 \subsection{Plugin Options ACL}
1245 \index[general]{Plugin Options ACL}
1246 The {\bf Plugin Options ACL} directive may be specified in the
1247 Director's Console resource. It functions as all the other ACL commands
1248 do by permitting users running restricted consoles to specify a
1249 {\bf Plugin Options} that overrides the one specified in the Job
1250 definition. Without this directive restricted consoles may not modify
1253 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1254 \index[general]{Plugin}
1255 The {\bf Plugin} directive is specified in the Include section of
1256 a FileSet resource where you put your {\bf File = xxx} directives.
1267 Plugin = "bpipe:..."
1272 In the above example, when the File daemon is processing the directives
1273 in the Include section, it will first backup all the files in {\bf /home}
1274 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1275 the Plugin Directory. The syntax and semantics of the Plugin directive
1276 require the first part of the string up to the colon (:) to be the name
1277 of the plugin. Everything after the first colon is ignored by the File daemon but
1278 is passed to the plugin. Thus the plugin writer may define the meaning of the
1279 rest of the string as he wishes.
1281 Please see the next section for information about the {\bf bpipe} Bacula
1284 \section{The bpipe Plugin}
1285 \index[general]{The bpipe Plugin}
1286 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1287 the Bacula source distribution. When the plugin is compiled and linking into
1288 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1290 The purpose of the plugin is to provide an interface to any system program for
1291 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1292 the Include section of your Job's FileSet resource. The full syntax of the
1293 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1294 to specify the sytax as it wishes) is:
1297 Plugin = "<field1>:<field2>:<field3>:<field4>"
1302 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1303 stripped off, so in this case, we would put {\bf bpipe} in this field.
1305 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1306 pseudo path and filename under which the backup will be saved. This pseudo
1307 path and filename will be seen by the user in the restore file tree.
1308 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1309 backed up by the plugin will be put under that "pseudo" path and filename.
1310 You must be careful to choose a naming convention that is unique to avoid
1311 a conflict with a path and filename that actually exists on your system.
1313 \item {\bf field3} for the {\bf bpipe} plugin
1314 specifies the "reader" program that is called by the plugin during
1315 backup to read the data. {\bf bpipe} will call this program by doing a
1318 \item {\bf field4} for the {\bf bpipe} plugin
1319 specifies the "writer" program that is called by the plugin during
1320 restore to write the data back to the filesystem.
1323 Putting it all together, the full plugin directive line might look
1327 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1328 --opt --databases bacula:mysql"
1331 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1332 would be written on a single line.
1334 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1335 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1336 program {\bf mysqldump -f --opt --database bacula} to read the data during
1337 backup. The mysqldump command outputs all the data for the database named
1338 {\bf bacula}, which will be read by the plugin and stored in the backup.
1339 During restore, the data that was backed up will be sent to the program
1340 specified in the last field, which in this case is {\bf mysql}. When
1341 {\bf mysql} is called, it will read the data sent to it by the plugn
1342 then write it back to the same database from which it came ({\bf bacula}
1345 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1346 the data from a specified program to Bacula for backup, and then from Bacula to
1347 a specified program for restore.
1349 By using different command lines to {\bf bpipe},
1350 you can backup any kind of data (ASCII or binary) depending
1351 on the program called.
1353 \section{Microsoft Exchange Server 2003/2007 Plugin}
1354 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1355 \subsection{Background}
1356 The Exchange plugin was made possible by a funded development project
1357 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1358 The code for the plugin was written by James Harper, and the Bacula core
1359 code by Kern Sibbald. All the code for this funded development has become
1360 part of the Bacula project. Thanks to everyone who made it happen.
1362 \subsection{Concepts}
1363 Although it is possible to backup Exchange using Bacula VSS the Exchange
1364 plugin adds a good deal of functionality, because while Bacula VSS
1365 completes a full backup (snapshot) of Exchange, it does
1366 not support Incremental or Differential backups, restoring is more
1367 complicated, and a single database restore is not possible.
1369 Microsoft Exchange organises its storage into Storage Groups with
1370 Databases inside them. A default installation of Exchange will have a
1371 single Storage Group called 'First Storage Group', with two Databases
1372 inside it, "Mailbox Store (SERVER NAME)" and
1373 "Public Folder Store (SERVER NAME)",
1374 which hold user email and public folders respectively.
1376 In the default configuration, Exchange logs everything that happens to
1377 log files, such that if you have a backup, and all the log files since,
1378 you can restore to the present time. Each Storage Group has its own set
1379 of log files and operates independently of any other Storage Groups. At
1380 the Storage Group level, the logging can be turned off by enabling a
1381 function called "Enable circular logging". At this time the Exchange
1382 plugin will not function if this option is enabled.
1384 The plugin allows backing up of entire storage groups, and the restoring
1385 of entire storage groups or individual databases. Backing up and
1386 restoring at the individual mailbox or email item is not supported but
1387 can be simulated by use of the "Recovery" Storage Group (see below).
1389 \subsection{Installing}
1390 The Exchange plugin requires a DLL that is shipped with Microsoft
1391 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1392 correctly the Exchange plugin should find this automatically and run
1393 without any additional installation.
1395 If the DLL can not be found automatically it will need to be copied into
1396 the Bacula installation
1397 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1398 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1399 default Exchange installation.
1401 \subsection{Backing Up}
1402 To back up an Exchange server the Fileset definition must contain at
1403 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1404 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1405 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1406 up files are prefixed with something that isn't going to share a name
1407 with something outside the plugin, and the 'Microsoft Information Store'
1408 bit is required also. It is also possible to add the name of a storage
1409 group to the "Plugin =" line, eg \\
1410 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1411 if you want only a single storage group backed up.
1413 Additionally, you can suffix the 'Plugin =' directive with
1414 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1415 database at the end of a full backup.
1417 An Incremental or Differential backup will backup only the database logs
1418 for each Storage Group by inspecting the "modified date" on each
1419 physical log file. Because of the way the Exchange API works, the last
1420 logfile backed up on each backup will always be backed up by the next
1421 Incremental or Differential backup too. This adds 5MB to each
1422 Incremental or Differential backup size but otherwise does not cause any
1425 By default, a normal VSS fileset containing all the drive letters will
1426 also back up the Exchange databases using VSS. This will interfere with
1427 the plugin and Exchange's shared ideas of when the last full backup was
1428 done, and may also truncate log files incorrectly. It is important,
1429 therefore, that the Exchange database files be excluded from the backup,
1430 although the folders the files are in should be included, or they will
1431 have to be recreated manually if a baremetal restore is done.
1436 File = C:/Program Files/Exchsrvr/mdbdata
1437 Plugin = "exchange:..."
1440 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1441 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1442 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1443 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1444 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1445 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1446 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1451 The advantage of excluding the above files is that you can significantly
1452 reduce the size of your backup since all the important Exchange files
1453 will be properly saved by the Plugin.
1456 \subsection{Restoring}
1457 The restore operation is much the same as a normal Bacula restore, with
1458 the following provisos:
1461 \item The {\bf Where} restore option must not be specified
1462 \item Each Database directory must be marked as a whole. You cannot just
1463 select (say) the .edb file and not the others.
1464 \item If a Storage Group is restored, the directory of the Storage Group
1466 \item It is possible to restore only a subset of the available log files,
1467 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1468 if a log file is missing from the sequence of log files
1469 \item Each database to be restored must be dismounted and marked as "Can be
1470 overwritten by restore"
1471 \item If an entire Storage Group is to be restored (eg all databases and
1472 logs in the Storage Group), then it is best to manually delete the
1473 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1474 as Exchange can get confused by stray log files lying around.
1477 \subsection{Restoring to the Recovery Storage Group}
1478 The concept of the Recovery Storage Group is well documented by
1480 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1481 but to briefly summarize...
1483 Microsoft Exchange allows the creation of an additional Storage Group
1484 called the Recovery Storage Group, which is used to restore an older
1485 copy of a database (e.g. before a mailbox was deleted) into without
1486 messing with the current live data. This is required as the Standard and
1487 Small Business Server versions of Exchange can not ordinarily have more
1488 than one Storage Group.
1490 To create the Recovery Storage Group, drill down to the Server in Exchange
1491 System Manager, right click, and select
1492 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1493 locations and click OK. On the Recovery Storage Group, right click and
1494 select {\bf "Add Database to Recover..."} and select the database you will
1497 Restore only the single database nominated as the database in the
1498 Recovery Storage Group. Exchange will redirect the restore to the
1499 Recovery Storage Group automatically.
1500 Then run the restore.
1502 \subsection{Restoring on Microsoft Server 2007}
1503 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1504 2007, and henc you use a new proceedure for recovering a single mail box.
1505 This procedure is ducomented by Microsoft at:
1506 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1507 and involves using the {\bf Restore-Mailbox} and {\bf
1508 Get-MailboxStatistics} shell commands.
1510 \subsection{Caveats}
1511 This plugin is still being developed, so you should consider it
1512 currently in BETA test, and thus use in a production environment
1513 should be done only after very careful testing.
1515 When doing a full backup, the Exchange database logs are truncated by
1516 Exchange as soon as the plugin has completed the backup. If the data
1517 never makes it to the backup medium (eg because of spooling) then the
1518 logs will still be truncated, but they will also not have been backed
1519 up. A solution to this is being worked on. You will have to schedule a
1520 new Full backup to ensure that your next backups will be usable.
1522 The "Enable Circular Logging" option cannot be enabled or the plugin
1525 Exchange insists that a successful Full backup must have taken place if
1526 an Incremental or Differential backup is desired, and the plugin will
1527 fail if this is not the case. If a restore is done, Exchange will
1528 require that a Full backup be done before an Incremental or Differential
1531 The plugin will most likely not work well if another backup application
1532 (eg NTBACKUP) is backing up the Exchange database, especially if the
1533 other backup application is truncating the log files.
1535 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1536 we recommend either carefully testing or that you avoid this option for
1539 The Exchange plugin is not called during processing the bconsole {\bf
1540 estimate} command, and so anything that would be backed up by the plugin
1541 will not be added to the estimate total that is displayed.
1544 \section{libdbi Framework}
1545 \index[general]{libdbi Framework}
1546 As a general guideline, Bacula has support for a few catalog database drivers
1547 (MySQL, PostgreSQL, SQLite)
1548 coded natively by the Bacula team. With the libdbi implementation, which is a
1549 Bacula driver that uses libdbi to access the catalog, we have an open field to
1550 use many different kinds database engines following the needs of users.
1552 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1553 implements a database-independent abstraction layer in C, similar to the
1554 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1555 leverage the power of multiple databases and multiple simultaneous database
1556 connections by using this framework.
1558 Currently the libdbi driver in Bacula project only supports the same drivers
1559 natively coded in Bacula. However the libdbi project has support for many
1560 others database engines. You can view the list at
1561 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1562 supported by Bacula, however, they must be tested properly by the Bacula team.
1564 Some of benefits of using libdbi are:
1566 \item The possibility to use proprietary databases engines in which your
1567 proprietary licenses prevent the Bacula team from developing the driver.
1568 \item The possibility to use the drivers written for the libdbi project.
1569 \item The possibility to use other database engines without recompiling Bacula
1570 to use them. Just change one line in bacula-dir.conf
1571 \item Abstract Database access, this is, unique point to code and profiling
1572 catalog database access.
1575 The following drivers have been tested:
1577 \item PostgreSQL, with and without batch insert
1578 \item Mysql, with and without batch insert
1583 In the future, we will test and approve to use others databases engines
1584 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1586 To compile Bacula to support libdbi we need to configure the code with the
1587 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1588 [database] is the database engine to be used with Bacula (of course we can
1589 change the driver in file bacula-dir.conf, see below). We must configure the
1590 access port of the database engine with the option --with-db-port, because the
1591 libdbi framework doesn't know the default access port of each database.
1593 The next phase is checking (or configuring) the bacula-dir.conf, example:
1597 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1598 dbname = regress; user = regress; password = ""
1602 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1603 mysql database. Currently the drivers supported by Bacula are: postgresql,
1604 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1606 The following limitations apply when Bacula is set to use the libdbi framework:
1607 - Not tested on the Win32 platform
1608 - A little performance is lost if comparing with native database driver.
1609 The reason is bound with the database driver provided by libdbi and the
1610 simple fact that one more layer of code was added.
1612 It is important to remember, when compiling Bacula with libdbi, the
1613 following packages are needed:
1615 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1616 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1619 You can download them and compile them on your system or install the packages
1620 from your OS distribution.
1622 \section{Console Command Additions and Enhancements}
1623 \index[general]{Console Additions}
1625 \subsection{Display Autochanger Content}
1626 \index[general]{StatusSlots}
1628 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1629 autochanger content.
1633 Slot | Volume Name | Status | Media Type | Pool |
1634 ------+---------------+----------+-------------------+------------|
1635 1 | 00001 | Append | DiskChangerMedia | Default |
1636 2 | 00002 | Append | DiskChangerMedia | Default |
1637 3*| 00003 | Append | DiskChangerMedia | Scratch |
1642 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1643 {\bf update slots} command to synchronize autochanger content with your
1646 \subsection{list joblog job=xxx or jobid=nnn}
1647 \index[general]{list joblog}
1648 A new list command has been added that allows you to list the contents
1649 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1650 or for a particular JobId. The {\bf llist} command will include a line with
1651 the time and date of the entry.
1653 Note for the catalog to have Job Log entries, you must have a directive
1660 In your Director's {\bf Messages} resource.
1662 \subsection{Use separator for multiple commands}
1663 \index[general]{Command Separator}
1664 When using bconsole with readline, you can set the command separator with
1665 \textbf{@separator} command to one
1666 of those characters to write commands who require multiple input in one line.
1668 !$%&'()*+,-/:;<>?[]^`{|}~
1671 \subsection{Deleting Volumes}
1672 The delete volume bconsole command has been modified to
1673 require an asterisk (*) in front of a MediaId otherwise the
1674 value you enter is a taken to be a Volume name. This is so that
1675 users may delete numeric Volume names. The previous Bacula versions
1676 assumed that all input that started with a number was a MediaId.
1678 This new behavior is indicated in the prompt if you read it
1681 \section{Bare Metal Recovery}
1682 The old bare metal recovery project is essentially dead. One
1683 of the main features of it was that it would build a recovery
1684 CD based on the kernel on your system. The problem was that
1685 every distribution has a different boot procedure and different
1686 scripts, and worse yet, the boot procedures and scripts change
1687 from one distribution to another. This meant that maintaining
1688 (keeping up with the changes) the rescue CD was too much work.
1690 To replace it, a new bare metal recovery USB boot stick has been developed
1691 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1692 boot from a USB key.
1696 \item Recovery can be done from within graphical environment.
1697 \item Recovery can be done in a shell.
1698 \item Ubuntu boots on a large number of Linux systems.
1699 \item The process of updating the system and adding new
1700 packages is not too difficult.
1701 \item The USB key can easily be upgraded to newer Ubuntu versions.
1702 \item The USB key has writable partitions for modifications to
1703 the OS and for modification to your home directory.
1704 \item You can add new files/directories to the USB key very easily.
1705 \item You can save the environment from multiple machines on
1707 \item Bacula Systems is funding its ongoing development.
1710 The disadvantages are:
1712 \item The USB key is usable but currently under development.
1713 \item Not everyone may be familiar with Ubuntu (no worse
1715 \item Some older OSes cannot be booted from USB. This can
1716 be resolved by first booting a Ubuntu LiveCD then plugging
1718 \item Currently the documentation is sketchy and not yet added
1719 to the main manual. See below ...
1722 The documentation and the code can be found in the {\bf rescue} package
1723 in the directory {\bf linux/usb}.
1725 \section{Miscellaneous}
1726 \index[general]{Misc New Features}
1728 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
1729 \index[general]{Allow Mixed Priority}
1730 This directive is only implemented in version 2.5 and later. When
1731 set to {\bf yes} (default {\bf no}), this job may run even if lower
1732 priority jobs are already running. This means a high priority job
1733 will not have to wait for other jobs to finish before starting.
1734 The scheduler will only mix priorities when all running jobs have
1737 Note that only higher priority jobs will start early. Suppose the
1738 director will allow two concurrent jobs, and that two jobs with
1739 priority 10 are running, with two more in the queue. If a job with
1740 priority 5 is added to the queue, it will be run as soon as one of
1741 the running jobs finishes. However, new priority 10 jobs will not
1742 be run until the priority 5 job has finished.
1744 \subsection{Bootstrap File Directive -- FileRegex}
1745 \index[general]{Bootstrap File Directive}
1746 {\bf FileRegex} is a new command that can be added to the bootstrap
1747 (.bsr) file. The value is a regular expression. When specified, only
1748 matching filenames will be restored.
1750 During a restore, if all File records are pruned from the catalog
1751 for a Job, normally Bacula can restore only all files saved. That
1752 is there is no way using the catalog to select individual files.
1753 With this new feature, Bacula will ask if you want to specify a Regex
1754 expression for extracting only a part of the full backup.
1757 Building directory tree for JobId(s) 1,3 ...
1758 There were no files inserted into the tree, so file selection
1759 is not possible.Most likely your retention policy pruned the files
1761 Do you want to restore all the files? (yes\vb{}no): no
1763 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1764 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1767 \subsection{Bootstrap File Optimization Changes}
1768 In order to permit proper seeking on disk files, we have extended the bootstrap
1769 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1770 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1771 address range and end address range respectively. These two directives replace
1772 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1773 VolEndBlock} directives. Bootstrap files containing the old directives will
1774 still work, but will not properly take advantage of proper disk seeking, and
1775 may read completely to the end of a disk volume during a restore. With the new
1776 format (automatically generated by the new Director), restores will seek
1777 properly and stop reading the volume when all the files have been restored.
1779 \subsection{Solaris ZFS/NFSv4 ACLs}
1780 This is an upgrade of the previous Solaris ACL backup code
1781 to the new library format, which will backup both the old
1782 POSIX(UFS) ACLs as well as the ZFS ACLs.
1784 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1785 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1786 be used to transfer from UFS to ZFS filesystems.
1789 \subsection{Virtual Tape Emulation}
1790 \index[general]{Virtual Tape Emulation}
1791 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1792 the tape code but actually reading and writing to a disk file. Used with the
1793 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1794 and 700 slots. This feature is most useful in testing. It is enabled
1795 by using {\bf Device Type = vtape} in the Storage daemon's Device
1796 directive. This feature is only implemented on Linux machines and should not be
1797 used for production.
1799 \subsection{Bat Enhancements}
1800 \index[general]{Bat Enhancements}
1801 Bat (the Bacula Administration Tool) GUI program has been significantly
1802 enhanced and stabilized. In particular, there are new table based status
1803 commands; it can now be easily localized using Qt4 Linguist.
1805 The Bat communications protocol has been significantly enhanced to improve
1806 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1807 the Director you are using otherwise the communications protocol will not
1810 \subsection{RunScript Enhancements}
1811 \index[general]{RunScript Enhancements}
1812 The {\bf RunScript} resource has been enhanced to permit multiple
1813 commands per RunScript. Simply specify multiple {\bf Command} directives
1820 Command = "/bin/echo test"
1821 Command = "/bin/echo an other test"
1822 Command = "/bin/echo 3 commands in the same runscript"
1829 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1830 implemented, which runs the command after the Volume Shadow Copy has been made.
1832 Console commands can be specified within a RunScript by using:
1833 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1834 carefully tested and debugged and is known to easily crash the Director.
1835 We would appreciate feedback. Due to the recursive nature of this command, we
1836 may remove it before the final release.
1838 \subsection{Status Enhancements}
1839 \index[general]{Status Enhancements}
1840 The bconsole {\bf status dir} output has been enhanced to indicate
1841 Storage daemon job spooling and despooling activity.
1843 \subsection{Connect Timeout}
1844 \index[general]{Connect Timeout}
1845 The default connect timeout to the File
1846 daemon has been set to 3 minutes. Previously it was 30 minutes.
1848 \subsection{ftruncate for NFS Volumes}
1849 \index[general]{ftruncate for NFS Volumes}
1850 If you write to a Volume mounted by NFS (say on a local file server),
1851 in previous Bacula versions, when the Volume was recycled, it was not
1852 properly truncated because NFS does not implement ftruncate (file
1853 truncate). This is now corrected in the new version because we have
1854 written code (actually a kind user) that deletes and recreates the Volume,
1855 thus accomplishing the same thing as a truncate.
1857 \subsection{Support for Ubuntu}
1858 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1859 version of Linux, and thus now provides correct autostart routines.
1860 Since Ubuntu officially supports Bacula, you can also obtain any
1861 recent release of Bacula from the Ubuntu repositories.
1863 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1864 \index[general]{Recycle Pool}
1865 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1866 be placed (moved) when it is recycled. Without this directive, a Volume will
1867 remain in the same pool when it is recycled. With this directive, it can be
1868 moved automatically to any existing pool during a recycle. This directive is
1869 probably most useful when defined in the Scratch pool, so that volumes will
1870 be recycled back into the Scratch pool.
1872 \subsection{FD Version}
1873 \index[general]{FD Version}
1874 The File daemon to Director protocol now includes a version
1875 number, which although there is no visible change for users,
1876 will help us in future versions automatically determine
1877 if a File daemon is not compatible.
1879 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1880 \index[general]{Max Run Sched Time}
1881 The time specifies the maximum allowed time that a job may run, counted from
1882 when the job was scheduled. This can be useful to prevent jobs from running
1883 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1886 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1887 \index[general]{Max Wait Time}
1888 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1889 of checking the maximum allowed time that a job may block for a resource,
1890 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1891 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1892 their job depending on the level. Now, they have to use
1893 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1894 directives are now deprecated.
1896 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1897 \index[general]{Incremental Max Wait Time}
1898 \index[general]{Differential Max Wait Time}
1900 These directives have been deprecated in favor of
1901 \texttt{Incremental|Differential Max Run Time}.
1903 \subsection{Max Run Time directives}
1904 \index[general]{Max Run Time directives}
1905 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1906 maximum allowed time that a job can run depending on the level.
1908 \addcontentsline{lof}{figure}{Job time control directives}
1909 \includegraphics{\idir different_time.eps}
1911 \subsection{Statistics Enhancements}
1912 \index[general]{Statistics Enhancements}
1913 If you (or probably your boss) want to have statistics on your backups to
1914 provide some \textit{Service Level Agreement} indicators, you could use a few
1915 SQL queries on the Job table to report how many:
1919 \item jobs have been successful
1920 \item files have been backed up
1924 However, these statistics are accurate only if your job retention is greater
1925 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1926 be able to use them.
1928 Now, you can use the \textbf{update stats [days=num]} console command to fill
1929 the JobHistory table with new Job records. If you want to be sure to take in
1930 account only \textbf{good jobs}, ie if one of your important job has failed but
1931 you have fixed the problem and restarted it on time, you probably want to
1932 delete the first \textit{bad} job record and keep only the successful one. For
1933 that simply let your staff do the job, and update JobHistory table after two or
1934 three days depending on your organization using the \textbf{[days=num]} option.
1936 These statistics records aren't used for restoring, but mainly for
1937 capacity planning, billings, etc.
1939 The Bweb interface provides a statistics module that can use this feature. You
1940 can also use tools like Talend or extract information by yourself.
1942 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1943 the length of time that Bacula will keep statistics job records in the Catalog
1944 database after the Job End time. (In \texttt{JobHistory} table) When this time
1945 period expires, and if user runs \texttt{prune stats} command, Bacula will
1946 prune (remove) Job records that are older than the specified period.
1948 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1949 job to maintain statistics.
1952 Name = BackupCatalog
1955 Console = "update stats days=3"
1956 Console = "prune stats yes"
1963 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1964 \index[general]{ScratchPool}
1965 This directive permits to specify a specific \textsl{Scratch} pool for the
1966 current pool. This is useful when using multiple storage sharing the same
1967 mediatype or when you want to dedicate volumes to a particular set of pool.
1969 \subsection{Enhanced Attribute Despooling}
1970 \index[general]{Attribute Despooling}
1971 If the storage daemon and the Director are on the same machine, the spool file
1972 that contains attributes is read directly by the Director instead of being
1973 transmitted across the network. That should reduce load and speedup insertion.
1975 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1976 \index[general]{SpoolSize}
1977 A new Job directive permits to specify the spool size per job. This is used
1978 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1980 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1981 \index[general]{MaxConsoleConnections}
1982 A new director directive permits to specify the maximum number of Console
1983 Connections that could run concurrently. The default is set to 20, but you may
1984 set it to a larger number.
1986 \subsection{VerId = \lt{}string\gt{}}
1987 \index[general]{VerId}
1988 A new director directive permits to specify a personnal identifier that will be
1989 displayed in the \texttt{version} command.
1991 \subsection{dbcheck enhancements}
1992 \index[general]{dbcheck enhancements}
1993 If you are using Mysql, dbcheck will now ask you if you want to create
1994 temporary indexes to speed up orphaned Path and Filename elimination.
1996 A new \texttt{-B} option allows you to print catalog information in a simple
1997 text based format. This is useful to backup it in a secure way.
2012 You can now specify the database connection port in the command line.
2014 \subsection{{-}{-}docdir configure option}
2015 \index[general]{{-}{-}docdir configure option}
2016 You can use {-}{-}docdir= on the ./configure command to
2017 specify the directory where you want Bacula to install the
2018 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2019 {\bf /usr/share/doc/bacula}.
2021 \subsection{{-}{-}htmldir configure option}
2022 \index[general]{{-}{-}htmldir configure option}
2023 You can use {-}{-}htmldir= on the ./configure command to
2024 specify the directory where you want Bacula to install the bat html help
2025 files. The default is {\bf /usr/share/doc/bacula/html}
2027 \subsection{{-}{-}with-plugindir configure option}
2028 \index[general]{{-}{-}plugindir configure option}
2029 You can use {-}{-}plugindir= on the ./configure command to
2030 specify the directory where you want Bacula to install
2031 the plugins (currently only bpipe-fd). The default is