5 \chapter{New Features in 3.0.3}
6 \label{NewFeaturesChapter}
8 This chapter presents the new features added to the development 3.0.3
9 versions to be released as Bacula version 3.0.3 sometime in 2009.
11 \section{Restore from multiple Storage Daemon}
12 \index[general]{Restore}
14 Previously, you were able to restore from multiple devices in a single Storage
15 Daemon. Now, Bacula is able to restore from multiple Storage Daemon. For
16 example, if your full backup runs on a Storage Daemon with an autochanger, and
17 your incremental jobs use an other Storage Daemon with lots of disks, Bacula
18 will switch automatically from a Storage Daemon to an other in the same Restore
21 You need to upgrade your File Daemon to use this feature.
23 This project was funded by Bacula Systems with the help of Equiinet.
25 \section{File deduplication using Base jobs}
27 A base job is sort of like a Full save except that you will want the FileSet to
28 contain only files that are unlikely to change in the future (i.e. a snapshot
29 of most of your system after installing it). After the base job has been run,
30 when you are doing a Full save, you specify one or more Base jobs to be used.
31 All files that have been backed up in the Base job/jobs but not modified will
32 then be excluded from the backup. During a restore, the Base jobs will be
33 automatically pulled in where necessary.
35 This is something none of the competition does, as far as we know (except
36 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
37 win for the user, it makes Bacula stand out as offering a unique optimization
38 that immediately saves time and money. Basically, imagine that you have 100
39 nearly identical Windows or Linux machine containing the OS and user files.
40 Now for the OS part, a Base job will be backed up once, and rather than making
41 100 copies of the OS, there will be only one. If one or more of the systems
42 have some files updated, no problem, they will be automatically restored.
44 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
45 files that will be used during Full backup as base.
56 Base = BackupZog4, BackupLinux
62 In this example, the job \texttt{BackupZog4} will use the most recent version
63 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
64 jobs. Base jobs should have run with \texttt{level=Base} to be used.
66 By default, Bacula will compare permissions bits, user and group fields,
67 modification time, size and the checksum of the file to choose between the
68 current backup and the BaseJob file list. You can change this behavior with the
69 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
70 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
87 This project was funded by Bacula Systems.
92 To help developers in restore GUI interfaces, we have added new \textsl{dot
93 commands} that permit to browse the catalog in a very simple way.
96 \item \texttt{.update [jobid=x,y,z]} This command is required to update the
97 Bvfs cache in the catalog. You need to run it before any access to the Bvfs
99 \item \texttt{.lsdirs jobid=x,y,z path=/path | pathid=101} This command will
100 list all directories in the specified \texttt{path} or \texttt{pathid}. Using
101 \texttt{pathid} avoids problems with caracters encoding.
102 \item \texttt{.lsfiles jobid=x,y,z path=/path | pathid=101} This command will
103 list all files in the specified \texttt{path} or \texttt{pathid}. Using
104 \texttt{pathid} avoids problems with caracters encoding.
107 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
108 data that will be displayed.
113 * .lsdir path=/ jobid=1,2
116 \section{Testing your tape drive}
117 \label{sec:btapespeed}
119 To determine the best configuration of your tape drive, you can run the new
120 \texttt{speed} command available in \texttt{btape}.
122 This command can have the following arguments:
124 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
125 (between 1 and 5GB). This counter is in GB.
126 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
127 of data should be greater than your memory ($file\_size*nb\_file$).
128 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
130 \item[\texttt{skip\_random}] This flag permits to skip tests with random
132 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
133 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
138 *speed file_size=3 skip_raw
139 btape.c:1078 Test with zero data and bacula block structure.
140 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
141 ++++++++++++++++++++++++++++++++++++++++++
142 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
143 btape.c:406 Volume bytes=3.221 GB. Write rate = 44128.0 KB/s
144 +++++++++++++++++++++++++++++++++++++++++++
145 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
146 btape.c:406 Volume bytes=3.221 GB. Write rate = 42951.2 KB/s
147 +++++++++++++++++++++++++++++++++++++++++++
148 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
149 btape.c:406 Volume bytes=3.221 GB. Write rate = 43531.7 KB/s
150 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43531.7 KB/s
153 When using compression, the random test will give your the minimum throughput
154 of your drive . The test using constant string will give you the maximum speed
155 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
157 You can change the block size in the Storage Daemon configuration file.
159 \section{Bat new features}
161 \subsection{Media information view}
163 When double-clicking on a volume (on the Media list, in the Autochanger content
164 or in the Job information panel), you can access to a detailed overview of your
165 volume. (cf \ref{fig:mediainfo}.)
168 \includegraphics[width=13cm]{\idir bat11.eps}
169 \caption{Media information}
170 \label{fig:mediainfo}
173 \subsection{Job information view}
175 When double-clicking on a Job record (on the Job run list or in the Media
176 information panel), you can access to a detailed overview of your Job. (cf
180 \includegraphics[width=13cm]{\idir bat12.eps}
181 \caption{Job information}
185 \subsection{Autochanger content view}
187 When double-clicking on a Storage record (on the Storage list panel), you can
188 access to a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
191 \includegraphics[width=13cm]{\idir bat13.eps}
192 \caption{Autochanger content}
193 \label{fig:achcontent}
196 \chapter{New Features in 3.0.2}
198 This chapter presents the new features added to the development 3.0.2
199 versions to be released as Bacula version 3.0.2 in july 2009.
201 \section{Full restore from a given JobId}
202 \index[general]{Restore menu}
204 This feature allows selecting a JobId and having Bacula automatically select all
205 other jobs that comprise a full backup up to and including the selected JobId.
207 Assume we start with the following jobs:
209 +-------+--------------+---------------------+-------+----------+------------+
210 | jobid | client | starttime | level | jobfiles | jobbytes |
211 +-------+--------------+---------------------+-------+----------+------------
212 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
213 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
214 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
215 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
216 +-------+--------------+---------------------+-------+----------+------------+
219 Below is an example of selecting this new feature (which is number 12 in the
224 To select the JobIds, you have the following choices:
225 1: List last 20 Jobs run
226 2: List Jobs where a given File is saved
228 12: Select full restore to a specified JobId
231 Select item: (1-13): 12
232 Enter JobId to restore: 5
233 You have selected the following JobIds: 1,3,5
235 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
236 1,444 files inserted into the tree.
239 This project was funded by Bacula Systems.
241 \section{Source Address}
242 \index[general]{Source Address}
244 A feature has been added which allows the administrator to specify the address
245 from which the director and file daemons will attempt connections from. This
246 may be used to simplify system configuration overhead when working in complex
247 networks utilizing multi-homing and policy-routing.
249 To accomplish this, two new configuration directives have been implemented:
252 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
256 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
260 Simply adding specific host routes would have an undesirable side-effect: any
261 application trying to contact the destination host would be forced to use the
262 more specific route, possibly diverting management traffic onto a backup VLAN.
263 Instead of adding host routes for each client connected to a multi-homed backup
264 server (for example where there are management and backup VLANs), one can
265 use the new directives to specify a specific source address at the application
268 Additionally, this allows the simplification and abstraction of firewall rules
269 when dealing with a Hot-Standby director or storage daemon configuration. The
270 Hot-standby pair may share a CARP address, which connections must be sourced
271 from, while system services listen and act from the unique interface addresses.
273 This project was funded by Collaborative Fusion, Inc.
275 \section{Show volume availability when doing restore}
277 When doing a restore the restore selection dialog ends by displaying this
281 The job will require the following
282 Volume(s) Storage(s) SD Device(s)
283 ===========================================================================
294 Volumes marked with ``*'' are online.
297 This should help getting large restores through minimizing the time spent
298 waiting for operator to drop by and change tapes in the library.
300 This project was funded by Bacula Systems.
302 \section{Accurate estimate command}
304 The \texttt{estimate} command can now use the accurate code to detect changes
305 and give a better estimation.
307 You can set the accurate behavior on command line using
308 \texttt{accurate=yes/no} or use the Job setting as default value.
311 * estimate listing accurate=yes level=incremental job=BackupJob
314 This project was funded by Bacula Systems.
316 \chapter{New Features in 3.0.0}
317 \label{NewFeaturesChapter}
318 \index[general]{New Features}
320 This chapter presents the new features added to the development 2.5.x
321 versions to be released as Bacula version 3.0.0 sometime in April 2009.
323 \section{Accurate Backup}
324 \index[general]{Accurate Backup}
326 As with most other backup programs, by default Bacula decides what files to
327 backup for Incremental and Differental backup by comparing the change
328 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
329 backup completed. If one of those two times is later than the last backup
330 time, then the file will be backed up. This does not, however, permit tracking
331 what files have been deleted and will miss any file with an old time that may
332 have been restored to or moved onto the client filesystem.
334 \subsection{Accurate = \lt{}yes|no\gt{}}
335 If the {\bf Accurate = \lt{}yes|no\gt{}} directive is enabled (default no) in
336 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
337 backup, there is no difference, but for {\bf Differential} and {\bf
338 Incremental} backups, the Director will send a list of all previous files
339 backed up, and the File daemon will use that list to determine if any new files
340 have been added or or moved and if any files have been deleted. This allows
341 Bacula to make an accurate backup of your system to that point in time so that
342 if you do a restore, it will restore your system exactly.
345 about using Accurate backup is that it requires more resources (CPU and memory)
346 on both the Director and the Client machines to create the list of previous
347 files backed up, to send that list to the File daemon, for the File daemon to
348 keep the list (possibly very big) in memory, and for the File daemon to do
349 comparisons between every file in the FileSet and the list. In particular,
350 if your client has lots of files (more than a few million), you will need
351 lots of memory on the client machine.
353 Accurate must not be enabled when backing up with a plugin that is not
354 specially designed to work with Accurate. If you enable it, your restores
355 will probably not work correctly.
357 This project was funded by Bacula Systems.
362 \index[general]{Copy Jobs}
364 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
365 existing Migration feature with the exception that the Job that is copied is
366 left unchanged. This essentially creates two identical copies of the same
367 backup. However, the copy is treated as a copy rather than a backup job, and
368 hence is not directly available for restore. The {\bf restore} command lists
369 copy jobs and allows selection of copies by using \texttt{jobid=}
370 option. If the keyword {\bf copies} is present on the command line, Bacula will
371 display the list of all copies for selected jobs.
376 These JobIds have copies as follows:
377 +-------+------------------------------------+-----------+------------------+
378 | JobId | Job | CopyJobId | MediaType |
379 +-------+------------------------------------+-----------+------------------+
380 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
381 +-------+------------------------------------+-----------+------------------+
382 +-------+-------+----------+----------+---------------------+------------------+
383 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
384 +-------+-------+----------+----------+---------------------+------------------+
385 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
386 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
387 +-------+-------+----------+----------+---------------------+------------------+
388 You have selected the following JobIds: 19,2
390 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
391 5,611 files inserted into the tree.
396 The Copy Job runs without using the File daemon by copying the data from the
397 old backup Volume to a different Volume in a different Pool. See the Migration
398 documentation for additional details. For copy Jobs there is a new selection
399 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
400 not already copied to another Pool.
402 As with Migration, the Client, Volume, Job, or SQL query, are
403 other possible ways of selecting the Jobs to be copied. Selection
404 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
405 work, but are probably more suited for Migration Jobs.
407 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
408 it will promote the Copy to a \textsl{real} backup job and will make it available for
409 automatic restore. If more than one Copy is available, it will promote the copy
410 with the smallest JobId.
412 A nice solution which can be built with the new Copy feature is often
413 called disk-to-disk-to-tape backup (DTDTT). A sample config could
414 look something like the one below:
418 Name = FullBackupsVirtualPool
420 Purge Oldest Volume = Yes
422 NextPool = FullBackupsTapePool
426 Name = FullBackupsTapePool
430 Volume Retention = 365 days
431 Storage = superloader
435 # Fake fileset for copy jobs
447 # Fake client for copy jobs
457 # Default template for a CopyDiskToTape Job
460 Name = CopyDiskToTape
462 Messages = StandardCopy
465 Selection Type = PoolUncopiedJobs
466 Maximum Concurrent Jobs = 10
468 Allow Duplicate Jobs = Yes
469 Allow Higher Duplicates = No
470 Cancel Queued Duplicates = No
471 Cancel Running Duplicates = No
476 Name = DaySchedule7:00
477 Run = Level=Full daily at 7:00
481 Name = CopyDiskToTapeFullBackups
483 Schedule = DaySchedule7:00
484 Pool = FullBackupsVirtualPool
485 JobDefs = CopyDiskToTape
489 The example above had 2 pool which are copied using the PoolUncopiedJobs
490 selection criteria. Normal Full backups go to the Virtual pool and are copied
491 to the Tape pool the next morning.
493 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
498 +-------+------------------------------------+-----------+------------------+
499 | JobId | Job | CopyJobId | MediaType |
500 +-------+------------------------------------+-----------+------------------+
501 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
502 +-------+------------------------------------+-----------+------------------+
505 \section{ACL Updates}
506 \index[general]{ACL Updates}
507 The whole ACL code had been overhauled and in this version each platforms has
508 different streams for each type of acl available on such an platform. As ACLs
509 between platforms tend to be not that portable (most implement POSIX acls but
510 some use an other draft or a completely different format) we currently only
511 allow certain platform specific ACL streams to be decoded and restored on the
512 same platform that they were created on. The old code allowed to restore ACL
513 cross platform but the comments already mention that not being to wise. For
514 backward compatability the new code will accept the two old ACL streams and
515 handle those with the platform specific handler. But for all new backups it
516 will save the ACLs using the new streams.
518 Currently the following platforms support ACLs:
522 \item {\bf Darwin/OSX}
531 Currently we support the following ACL types (these ACL streams use a reserved
532 part of the stream numbers):
535 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
537 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
538 string representation from acl\_to\_text (POSIX acl)
539 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
540 string representation from acl\_to\_text (POSIX acl) for default acls.
541 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
542 string representation from acl\_to\_text (POSIX acl) for access acls.
543 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
544 string representation from acltostr (POSIX acl)
545 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
546 representation from acl\_to\_text (POSIX acl) for default acls.
547 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
548 representation from acl\_to\_text (POSIX acl) for access acls.
549 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
550 string representation from acl\_to\_text (POSIX acl) for default acls.
551 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
552 representation from acl\_to\_text (POSIX acl) for access acls.
553 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
554 string representation from acl\_to\_text (POSIX acl) for default acls.
555 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
556 string representation from acl\_to\_text (POSIX acl) for default acls.
557 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
558 representation from acl\_to\_text (POSIX acl) for access acls.
559 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
560 string representation from acltotext or acl\_totext (POSIX acl)
561 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
562 representation from from acl\_totext (NFSv4 or ZFS acl)
565 In future versions we might support conversion functions from one type of acl
566 into an other for types that are either the same or easily convertable. For now
567 the streams are seperate and restoring them on a platform that doesn't
568 recognize them will give you a warning.
570 \section{Extended Attributes}
571 \index[general]{Extended Attributes}
572 Something that was on the project list for some time is now implemented for
573 platforms that support a similar kind of interface. Its the support for backup
574 and restore of so called extended attributes. As extended attributes are so
575 platform specific these attributes are saved in seperate streams for each
576 platform. Restores of the extended attributes can only be performed on the
577 same platform the backup was done. There is support for all types of extended
578 attributes, but restoring from one type of filesystem onto an other type of
579 filesystem on the same platform may lead to supprises. As extended attributes
580 can contain any type of data they are stored as a series of so called
581 value-pairs. This data must be seen as mostly binary and is stored as such.
582 As security labels from selinux are also extended attributes this option also
583 stores those labels and no specific code is enabled for handling selinux
586 Currently the following platforms support extended attributes:
588 \item {\bf Darwin/OSX}
594 On linux acls are also extended attributes, as such when you enable ACLs on a
595 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
596 and not the same exteneded attribute.
598 To enable the backup of extended attributes please add the following to your
613 \section{Shared objects}
614 \index[general]{Shared objects}
615 A default build of Bacula will now create the libraries as shared objects
616 (.so) rather than static libraries as was previously the case.
617 The shared libraries are built using {\bf libtool} so it should be quite
620 An important advantage of using shared objects is that on a machine with the
621 Directory, File daemon, the Storage daemon, and a console, you will have only
622 one copy of the code in memory rather than four copies. Also the total size of
623 the binary release is smaller since the library code appears only once rather
624 than once for every program that uses it; this results in significant reduction
625 in the size of the binaries particularly for the utility tools.
627 In order for the system loader to find the shared objects when loading the
628 Bacula binaries, the Bacula shared objects must either be in a shared object
629 directory known to the loader (typically /usr/lib) or they must be in the
630 directory that may be specified on the {\bf ./configure} line using the {\bf
631 {-}{-}libdir} option as:
634 ./configure --libdir=/full-path/dir
637 the default is /usr/lib. If {-}{-}libdir is specified, there should be
638 no need to modify your loader configuration provided that
639 the shared objects are installed in that directory (Bacula
640 does this with the make install command). The shared objects
641 that Bacula references are:
650 These files are symbolically linked to the real shared object file,
651 which has a version number to permit running multiple versions of
652 the libraries if desired (not normally the case).
654 If you have problems with libtool or you wish to use the old
655 way of building static libraries, or you want to build a static
656 version of Bacula you may disable
657 libtool on the configure command line with:
660 ./configure --disable-libtool
664 \section{Building Static versions of Bacula}
665 \index[general]{Static linking}
666 In order to build static versions of Bacula, in addition
667 to configuration options that were needed you now must
668 also add --disable-libtool. Example
671 ./configure --enable-static-client-only --disable-libtool
675 \section{Virtual Backup (Vbackup)}
676 \index[general]{Virtual Backup}
677 \index[general]{Vbackup}
679 Bacula's virtual backup feature is often called Synthetic Backup or
680 Consolidation in other backup products. It permits you to consolidate the
681 previous Full backup plus the most recent Differential backup and any
682 subsequent Incremental backups into a new Full backup. This new Full
683 backup will then be considered as the most recent Full for any future
684 Incremental or Differential backups. The VirtualFull backup is
685 accomplished without contacting the client by reading the previous backup
686 data and writing it to a volume in a different pool.
688 In some respects the Vbackup feature works similar to a Migration job, in
689 that Bacula normally reads the data from the pool specified in the
690 Job resource, and writes it to the {\bf Next Pool} specified in the
691 Job resource. Note, this means that usually the output from the Virtual
692 Backup is written into a different pool from where your prior backups
693 are saved. Doing it this way guarantees that you will not get a deadlock
694 situation attempting to read and write to the same volume in the Storage
695 daemon. If you then want to do subsequent backups, you may need to
696 move the Virtual Full Volume back to your normal backup pool.
697 Alternatively, you can set your {\bf Next Pool} to point to the current
698 pool. This will cause Bacula to read and write to Volumes in the
699 current pool. In general, this will work, because Bacula will
700 not allow reading and writing on the same Volume. In any case, once
701 a VirtualFull has been created, and a restore is done involving the
702 most current Full, it will read the Volume or Volumes by the VirtualFull
703 regardless of in which Pool the Volume is found.
705 The Vbackup is enabled on a Job by Job in the Job resource by specifying
706 a level of {\bf VirtualFull}.
708 A typical Job resource definition might look like the following:
722 # Default pool definition
726 Recycle = yes # Automatically recycle Volumes
727 AutoPrune = yes # Prune expired volumes
728 Volume Retention = 365d # one year
736 Recycle = yes # Automatically recycle Volumes
737 AutoPrune = yes # Prune expired volumes
738 Volume Retention = 365d # one year
739 Storage = DiskChanger
742 # Definition of file storage device
749 Maximum Concurrent Jobs = 5
752 # Definition of DDS Virtual tape disk storage device
755 Address = localhost # N.B. Use a fully qualified name here
758 Media Type = DiskChangerMedia
759 Maximum Concurrent Jobs = 4
764 Then in bconsole or via a Run schedule, you would run the job as:
767 run job=MyBackup level=Full
768 run job=MyBackup level=Incremental
769 run job=MyBackup level=Differential
770 run job=MyBackup level=Incremental
771 run job=MyBackup level=Incremental
774 So providing there were changes between each of those jobs, you would end up
775 with a Full backup, a Differential, which includes the first Incremental
776 backup, then two Incremental backups. All the above jobs would be written to
777 the {\bf Default} pool.
779 To consolidate those backups into a new Full backup, you would run the
783 run job=MyBackup level=VirtualFull
786 And it would produce a new Full backup without using the client, and the output
787 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
789 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
792 Note, the Start and End time of the Virtual Full backup is set to the
793 values for the last job included in the Virtual Full (in the above example,
794 it is an Increment). This is so that if another incremental is done, which
795 will be based on the Virtual Full, it will backup all files from the
796 last Job included in the Virtual Full rather than from the time the Virtual
797 Full was actually run.
801 \section{Catalog Format}
802 \index[general]{Catalog Format}
803 Bacula 3.0 comes with some changes to the catalog format. The upgrade
804 operation will convert the FileId field of the File table from 32 bits (max 4
805 billion table entries) to 64 bits (very large number of items). The
806 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
807 your catalog during the conversion. Also you won't be able to run jobs during
808 this conversion period. For example, a 3 million file catalog will take 2
809 minutes to upgrade on a normal machine. Please don't forget to make a valid
810 backup of your database before executing the upgrade script. See the
811 ReleaseNotes for additional details.
813 \section{64 bit Windows Client}
814 \index[general]{Win64 Client}
815 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
816 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
817 As a consequence, we are also releasing a 64 bit version of the Bacula
818 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
819 These binaries should only be installed on 64 bit Windows operating systems.
820 What is important is not your hardware but whether or not you have
821 a 64 bit version of the Windows OS.
823 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
825 \item Before installing the Win64 Bacula Client, you must totally
826 deinstall any prior 2.4.x Client installation using the
827 Bacula deinstallation (see the menu item). You may want
828 to save your .conf files first.
829 \item Only the Client (File daemon) is ported to Win64, the Director
830 and the Storage daemon are not in the 64 bit Windows installer.
831 \item bwx-console is not yet ported.
832 \item bconsole is ported but it has not been tested.
833 \item The documentation is not included in the installer.
834 \item Due to Vista security restrictions imposed on a default installation
835 of Vista, before upgrading the Client, you must manually stop
836 any prior version of Bacula from running, otherwise the install
838 \item Due to Vista security restrictions imposed on a default installation
839 of Vista, attempting to edit the conf files via the menu items
840 will fail. You must directly edit the files with appropriate
841 permissions. Generally double clicking on the appropriate .conf
842 file will work providing you have sufficient permissions.
843 \item All Bacula files are now installed in
844 {\bf C:/Program Files/Bacula} except the main menu items,
845 which are installed as before. This vastly simplifies the installation.
846 \item If you are running on a foreign language version of Windows, most
847 likely {\bf C:/Program Files} does not exist, so you should use the
848 Custom installation and enter an appropriate location to install
850 \item The 3.0.0 Win32 Client continues to install files in the locations used
851 by prior versions. For the next version we will convert it to use
852 the same installation conventions as the Win64 version.
855 This project was funded by Bacula Systems.
858 \section{Duplicate Job Control}
859 \index[general]{Duplicate Jobs}
860 The new version of Bacula provides four new directives that
861 give additional control over what Bacula does if duplicate jobs
862 are started. A duplicate job in the sense we use it here means
863 a second or subsequent job with the same name starts. This
864 happens most frequently when the first job runs longer than expected because no
867 The four directives each take as an argument a {\bf yes} or {\bf no} value and
868 are specified in the Job resource.
872 \subsection{Allow Duplicate Jobs = \lt{}yes|no\gt{}}
873 \index[general]{Allow Duplicate Jobs}
874 If this directive is enabled duplicate jobs will be run. If
875 the directive is set to {\bf no} (default) then only one job of a given name
876 may run at one time, and the action that Bacula takes to ensure only
877 one job runs is determined by the other directives (see below).
879 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
880 are present and none of the three directives given below permit
881 cancelling a job, then the current job (the second one started)
885 \subsection{Allow Higher Duplicates = \lt{}yes|no\gt{}}
886 \index[general]{Allow Higher Duplicates}
887 If this directive is set to {\bf yes} (default) the job with a higher
888 priority (lower priority number) will be permitted to run, and
889 the current job will be cancelled. If the
890 priorities of the two jobs are the same, the outcome is determined by
891 other directives (see below).
893 \subsection{Cancel Queued Duplicates = \lt{}yes|no\gt{}}
894 \index[general]{Cancel Queued Duplicates}
895 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
896 if this directive is set to {\bf yes} any job that is
897 already queued to run but not yet running will be canceled.
898 The default is {\bf no}.
900 \subsection{Cancel Running Duplicates = \lt{}yes|no\gt{}}
901 \index[general]{Cancel Running Duplicates}
902 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
903 if this directive is set to {\bf yes} any job that is already running
904 will be canceled. The default is {\bf no}.
907 \section{TLS Authentication}
908 \index[general]{TLS Authentication}
909 In Bacula version 2.5.x and later, in addition to the normal Bacula
910 CRAM-MD5 authentication that is used to authenticate each Bacula
911 connection, you can specify that you want TLS Authentication as well,
912 which will provide more secure authentication.
914 This new feature uses Bacula's existing TLS code (normally used for
915 communications encryption) to do authentication. To use it, you must
916 specify all the TLS directives normally used to enable communications
917 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
920 \subsection{TLS Authenticate = yes}
922 TLS Authenticate = yes
925 in the main daemon configuration resource (Director for the Director,
926 Client for the File daemon, and Storage for the Storage daemon).
928 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
929 authentication, Bacula will also do TLS authentication, then TLS
930 encryption will be turned off, and the rest of the communication between
931 the two Bacula daemons will be done without encryption.
933 If you want to encrypt communications data, use the normal TLS directives
934 but do not turn on {\bf TLS Authenticate}.
936 \section{bextract non-portable Win32 data}
937 \index[general]{bextract handles Win32 non-portable data}
938 {\bf bextract} has been enhanced to be able to restore
939 non-portable Win32 data to any OS. Previous versions were
940 unable to restore non-portable Win32 data to machines that
941 did not have the Win32 BackupRead and BackupWrite API calls.
943 \section{State File updated at Job Termination}
944 \index[general]{State File}
945 In previous versions of Bacula, the state file, which provides a
946 summary of previous jobs run in the {\bf status} command output was
947 updated only when Bacula terminated, thus if the daemon crashed, the
948 state file might not contain all the run data. This version of
949 the Bacula daemons updates the state file on each job termination.
951 \section{MaxFullInterval = \lt{}time-interval\gt{}}
952 \index[general]{MaxFullInterval}
953 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
954 can be used to specify the maximum time interval between {\bf Full} backup
955 jobs. When a job starts, if the time since the last Full backup is
956 greater than the specified interval, and the job would normally be an
957 {\bf Incremental} or {\bf Differential}, it will be automatically
958 upgraded to a {\bf Full} backup.
960 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
961 \index[general]{MaxDiffInterval}
962 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
963 can be used to specify the maximum time interval between {\bf Differential} backup
964 jobs. When a job starts, if the time since the last Differential backup is
965 greater than the specified interval, and the job would normally be an
966 {\bf Incremental}, it will be automatically
967 upgraded to a {\bf Differential} backup.
969 \section{Honor No Dump Flag = \lt{}yes|no\gt{}}
970 \index[general]{MaxDiffInterval}
971 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
972 by the user, and when it is set it is an indication to backup programs
973 to not backup that particular file. This version of Bacula contains a
974 new Options directive within a FileSet resource, which instructs Bacula to
975 obey this flag. The new directive is:
978 Honor No Dump Flag = yes|no
981 The default value is {\bf no}.
984 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
985 \index[general]{IgnoreDir}
986 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
987 can be added to the Include section of the FileSet resource. If the specified
988 filename ({\bf filename-string}) is found on the Client in any directory to be
989 backed up, the whole directory will be ignored (not backed up). For example:
992 # List of files to be backed up
1000 Exclude Dir Containing = .excludeme
1005 But in /home, there may be hundreds of directories of users and some
1006 people want to indicate that they don't want to have certain
1007 directories backed up. For example, with the above FileSet, if
1008 the user or sysadmin creates a file named {\bf .excludeme} in
1009 specific directories, such as
1012 /home/user/www/cache/.excludeme
1013 /home/user/temp/.excludeme
1016 then Bacula will not backup the two directories named:
1019 /home/user/www/cache
1023 NOTE: subdirectories will not be backed up. That is, the directive
1024 applies to the two directories in question and any children (be they
1025 files, directories, etc).
1028 \section{Bacula Plugins}
1029 \index[general]{Plugin}
1030 Support for shared object plugins has been implemented in the Linux, Unix
1031 and Win32 File daemons. The API will be documented separately in
1032 the Developer's Guide or in a new document. For the moment, there is
1033 a single plugin named {\bf bpipe} that allows an external program to
1034 get control to backup and restore a file.
1036 Plugins are also planned (partially implemented) in the Director and the
1039 \subsection{Plugin Directory}
1040 \index[general]{Plugin Directory}
1041 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1042 be added to the daemon definition resource. The directory takes a quoted
1043 string argument, which is the name of the directory in which the daemon can
1044 find the Bacula plugins. If this directive is not specified, Bacula will not
1045 load any plugins. Since each plugin has a distinctive name, all the daemons
1046 can share the same plugin directory.
1048 \subsection{Plugin Options}
1049 \index[general]{Plugin Options}
1050 The {\bf Plugin Options} directive takes a quoted string
1051 arguement (after the equal sign) and may be specified in the
1052 Job resource. The options specified will be passed to all plugins
1053 when they are run. This each plugin must know what it is looking
1054 for. The value defined in the Job resource can be modified
1055 by the user when he runs a Job via the {\bf bconsole} command line
1058 Note: this directive may be specified, and there is code to modify
1059 the string in the run command, but the plugin options are not yet passed to
1060 the plugin (i.e. not fully implemented).
1062 \subsection{Plugin Options ACL}
1063 \index[general]{Plugin Options ACL}
1064 The {\bf Plugin Options ACL} directive may be specified in the
1065 Director's Console resource. It functions as all the other ACL commands
1066 do by permitting users running restricted consoles to specify a
1067 {\bf Plugin Options} that overrides the one specified in the Job
1068 definition. Without this directive restricted consoles may not modify
1071 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1072 \index[general]{Plugin}
1073 The {\bf Plugin} directive is specified in the Include section of
1074 a FileSet resource where you put your {\bf File = xxx} directives.
1085 Plugin = "bpipe:..."
1090 In the above example, when the File daemon is processing the directives
1091 in the Include section, it will first backup all the files in {\bf /home}
1092 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1093 the Plugin Directory. The syntax and semantics of the Plugin directive
1094 require the first part of the string up to the colon (:) to be the name
1095 of the plugin. Everything after the first colon is ignored by the File daemon but
1096 is passed to the plugin. Thus the plugin writer may define the meaning of the
1097 rest of the string as he wishes.
1099 Please see the next section for information about the {\bf bpipe} Bacula
1102 \section{The bpipe Plugin}
1103 \index[general]{The bpipe Plugin}
1104 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1105 the Bacula source distribution. When the plugin is compiled and linking into
1106 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1108 The purpose of the plugin is to provide an interface to any system program for
1109 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1110 the Include section of your Job's FileSet resource. The full syntax of the
1111 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1112 to specify the sytax as it wishes) is:
1115 Plugin = "<field1>:<field2>:<field3>:<field4>"
1120 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1121 stripped off, so in this case, we would put {\bf bpipe} in this field.
1123 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1124 pseudo path and filename under which the backup will be saved. This pseudo
1125 path and filename will be seen by the user in the restore file tree.
1126 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1127 backed up by the plugin will be put under that "pseudo" path and filename.
1128 You must be careful to choose a naming convention that is unique to avoid
1129 a conflict with a path and filename that actually exists on your system.
1131 \item {\bf field3} for the {\bf bpipe} plugin
1132 specifies the "reader" program that is called by the plugin during
1133 backup to read the data. {\bf bpipe} will call this program by doing a
1136 \item {\bf field4} for the {\bf bpipe} plugin
1137 specifies the "writer" program that is called by the plugin during
1138 restore to write the data back to the filesystem.
1141 Putting it all together, the full plugin directive line might look
1145 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1146 --opt --databases bacula:mysql"
1149 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1150 would be written on a single line.
1152 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1153 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1154 program {\bf mysqldump -f --opt --database bacula} to read the data during
1155 backup. The mysqldump command outputs all the data for the database named
1156 {\bf bacula}, which will be read by the plugin and stored in the backup.
1157 During restore, the data that was backed up will be sent to the program
1158 specified in the last field, which in this case is {\bf mysql}. When
1159 {\bf mysql} is called, it will read the data sent to it by the plugn
1160 then write it back to the same database from which it came ({\bf bacula}
1163 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1164 the data from a specified program to Bacula for backup, and then from Bacula to
1165 a specified program for restore.
1167 By using different command lines to {\bf bpipe},
1168 you can backup any kind of data (ASCII or binary) depending
1169 on the program called.
1171 \section{Microsoft Exchange Server 2003/2007 Plugin}
1172 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1173 \subsection{Background}
1174 The Exchange plugin was made possible by a funded development project
1175 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1176 The code for the plugin was written by James Harper, and the Bacula core
1177 code by Kern Sibbald. All the code for this funded development has become
1178 part of the Bacula project. Thanks to everyone who made it happen.
1180 \subsection{Concepts}
1181 Although it is possible to backup Exchange using Bacula VSS the Exchange
1182 plugin adds a good deal of functionality, because while Bacula VSS
1183 completes a full backup (snapshot) of Exchange, it does
1184 not support Incremental or Differential backups, restoring is more
1185 complicated, and a single database restore is not possible.
1187 Microsoft Exchange organises its storage into Storage Groups with
1188 Databases inside them. A default installation of Exchange will have a
1189 single Storage Group called 'First Storage Group', with two Databases
1190 inside it, "Mailbox Store (SERVER NAME)" and
1191 "Public Folder Store (SERVER NAME)",
1192 which hold user email and public folders respectively.
1194 In the default configuration, Exchange logs everything that happens to
1195 log files, such that if you have a backup, and all the log files since,
1196 you can restore to the present time. Each Storage Group has its own set
1197 of log files and operates independently of any other Storage Groups. At
1198 the Storage Group level, the logging can be turned off by enabling a
1199 function called "Enable circular logging". At this time the Exchange
1200 plugin will not function if this option is enabled.
1202 The plugin allows backing up of entire storage groups, and the restoring
1203 of entire storage groups or individual databases. Backing up and
1204 restoring at the individual mailbox or email item is not supported but
1205 can be simulated by use of the "Recovery" Storage Group (see below).
1207 \subsection{Installing}
1208 The Exchange plugin requires a DLL that is shipped with Microsoft
1209 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1210 correctly the Exchange plugin should find this automatically and run
1211 without any additional installation.
1213 If the DLL can not be found automatically it will need to be copied into
1214 the Bacula installation
1215 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1216 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1217 default Exchange installation.
1219 \subsection{Backup up}
1220 To back up an Exchange server the Fileset definition must contain at
1221 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1222 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1223 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1224 up files are prefixed with something that isn't going to share a name
1225 with something outside the plugin, and the 'Microsoft Information Store'
1226 bit is required also. It is also possible to add the name of a storage
1227 group to the "Plugin =" line, eg \\
1228 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1229 if you want only a single storage group backed up.
1231 Additionally, you can suffix the 'Plugin =' directive with
1232 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1233 database at the end of a full backup.
1235 An Incremental or Differential backup will backup only the database logs
1236 for each Storage Group by inspecting the "modified date" on each
1237 physical log file. Because of the way the Exchange API works, the last
1238 logfile backed up on each backup will always be backed up by the next
1239 Incremental or Differential backup too. This adds 5MB to each
1240 Incremental or Differential backup size but otherwise does not cause any
1243 By default, a normal VSS fileset containing all the drive letters will
1244 also back up the Exchange databases using VSS. This will interfere with
1245 the plugin and Exchange's shared ideas of when the last full backup was
1246 done, and may also truncate log files incorrectly. It is important,
1247 therefore, that the Exchange database files be excluded from the backup,
1248 although the folders the files are in should be included, or they will
1249 have to be recreated manually if a baremetal restore is done.
1254 File = C:/Program Files/Exchsrvr/mdbdata
1255 Plugin = "exchange:..."
1258 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1259 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1260 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1261 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1262 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1263 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1264 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1269 The advantage of excluding the above files is that you can significantly
1270 reduce the size of your backup since all the important Exchange files
1271 will be properly saved by the Plugin.
1274 \subsection{Restoring}
1275 The restore operation is much the same as a normal Bacula restore, with
1276 the following provisos:
1279 \item The {\bf Where} restore option must not be specified
1280 \item Each Database directory must be marked as a whole. You cannot just
1281 select (say) the .edb file and not the others.
1282 \item If a Storage Group is restored, the directory of the Storage Group
1284 \item It is possible to restore only a subset of the available log files,
1285 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1286 if a log file is missing from the sequence of log files
1287 \item Each database to be restored must be dismounted and marked as "Can be
1288 overwritten by restore"
1289 \item If an entire Storage Group is to be restored (eg all databases and
1290 logs in the Storage Group), then it is best to manually delete the
1291 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1292 as Exchange can get confused by stray log files lying around.
1295 \subsection{Restoring to the Recovery Storage Group}
1296 The concept of the Recovery Storage Group is well documented by
1298 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1299 but to briefly summarize...
1301 Microsoft Exchange allows the creation of an additional Storage Group
1302 called the Recovery Storage Group, which is used to restore an older
1303 copy of a database (e.g. before a mailbox was deleted) into without
1304 messing with the current live data. This is required as the Standard and
1305 Small Business Server versions of Exchange can not ordinarily have more
1306 than one Storage Group.
1308 To create the Recovery Storage Group, drill down to the Server in Exchange
1309 System Manager, right click, and select
1310 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1311 locations and click OK. On the Recovery Storage Group, right click and
1312 select {\bf "Add Database to Recover..."} and select the database you will
1315 Restore only the single database nominated as the database in the
1316 Recovery Storage Group. Exchange will redirect the restore to the
1317 Recovery Storage Group automatically.
1318 Then run the restore.
1320 \subsection{Restoring on Microsoft Server 2007}
1321 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1322 2007, and henc you use a new proceedure for recovering a single mail box.
1323 This procedure is ducomented by Microsoft at:
1324 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1325 and involves using the {\bf Restore-Mailbox} and {\bf
1326 Get-MailboxStatistics} shell commands.
1328 \subsection{Caveats}
1329 This plugin is still being developed, so you should consider it
1330 currently in BETA test, and thus use in a production environment
1331 should be done only after very careful testing.
1333 When doing a full backup, the Exchange database logs are truncated by
1334 Exchange as soon as the plugin has completed the backup. If the data
1335 never makes it to the backup medium (eg because of spooling) then the
1336 logs will still be truncated, but they will also not have been backed
1337 up. A solution to this is being worked on. You will have to schedule a
1338 new Full backup to ensure that your next backups will be usable.
1340 The "Enable Circular Logging" option cannot be enabled or the plugin
1343 Exchange insists that a successful Full backup must have taken place if
1344 an Incremental or Differential backup is desired, and the plugin will
1345 fail if this is not the case. If a restore is done, Exchange will
1346 require that a Full backup be done before an Incremental or Differential
1349 The plugin will most likely not work well if another backup application
1350 (eg NTBACKUP) is backing up the Exchange database, especially if the
1351 other backup application is truncating the log files.
1353 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1354 we recommend either carefully testing or that you avoid this option for
1357 The Exchange plugin is not called during processing the bconsole {\bf
1358 estimate} command, and so anything that would be backed up by the plugin
1359 will not be added to the estimate total that is displayed.
1362 \section{libdbi Framework}
1363 \index[general]{libdbi Framework}
1364 As a general guideline, Bacula has support for a few catalog database drivers
1365 (MySQL, PostgreSQL, SQLite)
1366 coded natively by the Bacula team. With the libdbi implementation, which is a
1367 Bacula driver that uses libdbi to access the catalog, we have an open field to
1368 use many different kinds database engines following the needs of users.
1370 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1371 implements a database-independent abstraction layer in C, similar to the
1372 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1373 leverage the power of multiple databases and multiple simultaneous database
1374 connections by using this framework.
1376 Currently the libdbi driver in Bacula project only supports the same drivers
1377 natively coded in Bacula. However the libdbi project has support for many
1378 others database engines. You can view the list at
1379 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1380 supported by Bacula, however, they must be tested properly by the Bacula team.
1382 Some of benefits of using libdbi are:
1384 \item The possibility to use proprietary databases engines in which your
1385 proprietary licenses prevent the Bacula team from developing the driver.
1386 \item The possibility to use the drivers written for the libdbi project.
1387 \item The possibility to use other database engines without recompiling Bacula
1388 to use them. Just change one line in bacula-dir.conf
1389 \item Abstract Database access, this is, unique point to code and profiling
1390 catalog database access.
1393 The following drivers have been tested:
1395 \item PostgreSQL, with and without batch insert
1396 \item Mysql, with and without batch insert
1401 In the future, we will test and approve to use others databases engines
1402 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1404 To compile Bacula to support libdbi we need to configure the code with the
1405 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1406 [database] is the database engine to be used with Bacula (of course we can
1407 change the driver in file bacula-dir.conf, see below). We must configure the
1408 access port of the database engine with the option --with-db-port, because the
1409 libdbi framework doesn't know the default access port of each database.
1411 The next phase is checking (or configuring) the bacula-dir.conf, example:
1415 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1416 dbname = regress; user = regress; password = ""
1420 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1421 mysql database. Currently the drivers supported by Bacula are: postgresql,
1422 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1424 The following limitations apply when Bacula is set to use the libdbi framework:
1425 - Not tested on the Win32 platform
1426 - A little performance is lost if comparing with native database driver.
1427 The reason is bound with the database driver provided by libdbi and the
1428 simple fact that one more layer of code was added.
1430 It is important to remember, when compiling Bacula with libdbi, the
1431 following packages are needed:
1433 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1434 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1437 You can download them and compile them on your system or install the packages
1438 from your OS distribution.
1440 \section{Console Command Additions and Enhancements}
1441 \index[general]{Console Additions}
1443 \subsection{Display Autochanger Content}
1444 \index[general]{StatusSlots}
1446 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1447 autochanger content.
1451 Slot | Volume Name | Status | Media Type | Pool |
1452 ------+---------------+----------+-------------------+------------|
1453 1 | 00001 | Append | DiskChangerMedia | Default |
1454 2 | 00002 | Append | DiskChangerMedia | Default |
1455 3*| 00003 | Append | DiskChangerMedia | Scratch |
1460 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1461 {\bf update slots} command to synchronize autochanger content with your
1464 \subsection{list joblog job=xxx or jobid=nnn}
1465 \index[general]{list joblog}
1466 A new list command has been added that allows you to list the contents
1467 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1468 or for a particular JobId. The {\bf llist} command will include a line with
1469 the time and date of the entry.
1471 Note for the catalog to have Job Log entries, you must have a directive
1478 In your Director's {\bf Messages} resource.
1480 \subsection{Use separator for multiple commands}
1481 \index[general]{Command Separator}
1482 When using bconsole with readline, you can set the command separator with
1483 \textbf{@separator} command to one
1484 of those characters to write commands who require multiple input in one line.
1486 !$%&'()*+,-/:;<>?[]^`{|}~
1489 \subsection{Deleting Volumes}
1490 The delete volume bconsole command has been modified to
1491 require an asterisk (*) in front of a MediaId otherwise the
1492 value you enter is a taken to be a Volume name. This is so that
1493 users may delete numeric Volume names. The previous Bacula versions
1494 assumed that all input that started with a number was a MediaId.
1496 This new behavior is indicated in the prompt if you read it
1499 \section{Bare Metal Recovery}
1500 The old bare metal recovery project is essentially dead. One
1501 of the main features of it was that it would build a recovery
1502 CD based on the kernel on your system. The problem was that
1503 every distribution has a different boot procedure and different
1504 scripts, and worse yet, the boot procedures and scripts change
1505 from one distribution to another. This meant that maintaining
1506 (keeping up with the changes) the rescue CD was too much work.
1508 To replace it, a new bare metal recovery USB boot stick has been developed
1509 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1510 boot from a USB key.
1514 \item Recovery can be done from within graphical environment.
1515 \item Recovery can be done in a shell.
1516 \item Ubuntu boots on a large number of Linux systems.
1517 \item The process of updating the system and adding new
1518 packages is not too difficult.
1519 \item The USB key can easily be upgraded to newer Ubuntu versions.
1520 \item The USB key has writable partitions for modifications to
1521 the OS and for modification to your home directory.
1522 \item You can add new files/directories to the USB key very easily.
1523 \item You can save the environment from multiple machines on
1525 \item Bacula Systems is funding its ongoing development.
1528 The disadvantages are:
1530 \item The USB key is usable but currently under development.
1531 \item Not everyone may be familiar with Ubuntu (no worse
1533 \item Some older OSes cannot be booted from USB. This can
1534 be resolved by first booting a Ubuntu LiveCD then plugging
1536 \item Currently the documentation is sketchy and not yet added
1537 to the main manual. See below ...
1540 The documentation and the code can be found in the {\bf rescue} package
1541 in the directory {\bf linux/usb}.
1543 \section{Miscellaneous}
1544 \index[general]{Misc New Features}
1546 \subsection{Allow Mixed Priority = \lt{}yes|no\gt{}}
1547 \index[general]{Allow Mixed Priority}
1548 This directive is only implemented in version 2.5 and later. When
1549 set to {\bf yes} (default {\bf no}), this job may run even if lower
1550 priority jobs are already running. This means a high priority job
1551 will not have to wait for other jobs to finish before starting.
1552 The scheduler will only mix priorities when all running jobs have
1555 Note that only higher priority jobs will start early. Suppose the
1556 director will allow two concurrent jobs, and that two jobs with
1557 priority 10 are running, with two more in the queue. If a job with
1558 priority 5 is added to the queue, it will be run as soon as one of
1559 the running jobs finishes. However, new priority 10 jobs will not
1560 be run until the priority 5 job has finished.
1562 \subsection{Bootstrap File Directive -- FileRegex}
1563 \index[general]{Bootstrap File Directive}
1564 {\bf FileRegex} is a new command that can be added to the bootstrap
1565 (.bsr) file. The value is a regular expression. When specified, only
1566 matching filenames will be restored.
1568 During a restore, if all File records are pruned from the catalog
1569 for a Job, normally Bacula can restore only all files saved. That
1570 is there is no way using the catalog to select individual files.
1571 With this new feature, Bacula will ask if you want to specify a Regex
1572 expression for extracting only a part of the full backup.
1575 Building directory tree for JobId(s) 1,3 ...
1576 There were no files inserted into the tree, so file selection
1577 is not possible.Most likely your retention policy pruned the files
1579 Do you want to restore all the files? (yes|no): no
1581 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1582 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1585 \subsection{Bootstrap File Optimization Changes}
1586 In order to permit proper seeking on disk files, we have extended the bootstrap
1587 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1588 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1589 address range and end address range respectively. These two directives replace
1590 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1591 VolEndBlock} directives. Bootstrap files containing the old directives will
1592 still work, but will not properly take advantage of proper disk seeking, and
1593 may read completely to the end of a disk volume during a restore. With the new
1594 format (automatically generated by the new Director), restores will seek
1595 properly and stop reading the volume when all the files have been restored.
1597 \subsection{Solaris ZFS/NFSv4 ACLs}
1598 This is an upgrade of the previous Solaris ACL backup code
1599 to the new library format, which will backup both the old
1600 POSIX(UFS) ACLs as well as the ZFS ACLs.
1602 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1603 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1604 be used to transfer from UFS to ZFS filesystems.
1607 \subsection{Virtual Tape Emulation}
1608 \index[general]{Virtual Tape Emulation}
1609 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1610 the tape code but actually reading and writing to a disk file. Used with the
1611 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1612 and 700 slots. This feature is most useful in testing. It is enabled
1613 by using {\bf Device Type = vtape} in the Storage daemon's Device
1614 directive. This feature is only implemented on Linux machines and should not be
1615 used for production.
1617 \subsection{Bat Enhancements}
1618 \index[general]{Bat Enhancements}
1619 Bat (the Bacula Administration Tool) GUI program has been significantly
1620 enhanced and stabilized. In particular, there are new table based status
1621 commands; it can now be easily localized using Qt4 Linguist.
1623 The Bat communications protocol has been significantly enhanced to improve
1624 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1625 the Director you are using otherwise the communications protocol will not
1628 \subsection{RunScript Enhancements}
1629 \index[general]{RunScript Enhancements}
1630 The {\bf RunScript} resource has been enhanced to permit multiple
1631 commands per RunScript. Simply specify multiple {\bf Command} directives
1638 Command = "/bin/echo test"
1639 Command = "/bin/echo an other test"
1640 Command = "/bin/echo 3 commands in the same runscript"
1647 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1648 implemented, which runs the command after the Volume Shadow Copy has been made.
1650 Console commands can be specified within a RunScript by using:
1651 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1652 carefully tested and debugged and is known to easily crash the Director.
1653 We would appreciate feedback. Due to the recursive nature of this command, we
1654 may remove it before the final release.
1656 \subsection{Status Enhancements}
1657 \index[general]{Status Enhancements}
1658 The bconsole {\bf status dir} output has been enhanced to indicate
1659 Storage daemon job spooling and despooling activity.
1661 \subsection{Connect Timeout}
1662 \index[general]{Connect Timeout}
1663 The default connect timeout to the File
1664 daemon has been set to 3 minutes. Previously it was 30 minutes.
1666 \subsection{ftruncate for NFS Volumes}
1667 \index[general]{ftruncate for NFS Volumes}
1668 If you write to a Volume mounted by NFS (say on a local file server),
1669 in previous Bacula versions, when the Volume was recycled, it was not
1670 properly truncated because NFS does not implement ftruncate (file
1671 truncate). This is now corrected in the new version because we have
1672 written code (actually a kind user) that deletes and recreates the Volume,
1673 thus accomplishing the same thing as a truncate.
1675 \subsection{Support for Ubuntu}
1676 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1677 version of Linux, and thus now provides correct autostart routines.
1678 Since Ubuntu officially supports Bacula, you can also obtain any
1679 recent release of Bacula from the Ubuntu repositories.
1681 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1682 \index[general]{Recycle Pool}
1683 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1684 be placed (moved) when it is recycled. Without this directive, a Volume will
1685 remain in the same pool when it is recycled. With this directive, it can be
1686 moved automatically to any existing pool during a recycle. This directive is
1687 probably most useful when defined in the Scratch pool, so that volumes will
1688 be recycled back into the Scratch pool.
1690 \subsection{FD Version}
1691 \index[general]{FD Version}
1692 The File daemon to Director protocol now includes a version
1693 number, which although there is no visible change for users,
1694 will help us in future versions automatically determine
1695 if a File daemon is not compatible.
1697 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1698 \index[general]{Max Run Sched Time}
1699 The time specifies the maximum allowed time that a job may run, counted from
1700 when the job was scheduled. This can be useful to prevent jobs from running
1701 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1704 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1705 \index[general]{Max Wait Time}
1706 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1707 of checking the maximum allowed time that a job may block for a resource,
1708 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1709 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1710 their job depending on the level. Now, they have to use
1711 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1712 directives are now deprecated.
1714 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1715 \index[general]{Incremental Max Wait Time}
1716 \index[general]{Differential Max Wait Time}
1718 These directives have been deprecated in favor of
1719 \texttt{Incremental|Differential Max Run Time}.
1721 \subsection{Max Run Time directives}
1722 \index[general]{Max Run Time directives}
1723 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1724 maximum allowed time that a job can run depending on the level.
1726 \addcontentsline{lof}{figure}{Job time control directives}
1727 \includegraphics{\idir different_time.eps}
1729 \subsection{Statistics Enhancements}
1730 \index[general]{Statistics Enhancements}
1731 If you (or probably your boss) want to have statistics on your backups to
1732 provide some \textit{Service Level Agreement} indicators, you could use a few
1733 SQL queries on the Job table to report how many:
1737 \item jobs have been successful
1738 \item files have been backed up
1742 However, these statistics are accurate only if your job retention is greater
1743 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1744 be able to use them.
1746 Now, you can use the \textbf{update stats [days=num]} console command to fill
1747 the JobHistory table with new Job records. If you want to be sure to take in
1748 account only \textbf{good jobs}, ie if one of your important job has failed but
1749 you have fixed the problem and restarted it on time, you probably want to
1750 delete the first \textit{bad} job record and keep only the successful one. For
1751 that simply let your staff do the job, and update JobHistory table after two or
1752 three days depending on your organization using the \textbf{[days=num]} option.
1754 These statistics records aren't used for restoring, but mainly for
1755 capacity planning, billings, etc.
1757 The Bweb interface provides a statistics module that can use this feature. You
1758 can also use tools like Talend or extract information by yourself.
1760 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1761 the length of time that Bacula will keep statistics job records in the Catalog
1762 database after the Job End time. (In \texttt{JobHistory} table) When this time
1763 period expires, and if user runs \texttt{prune stats} command, Bacula will
1764 prune (remove) Job records that are older than the specified period.
1766 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1767 job to maintain statistics.
1770 Name = BackupCatalog
1773 Console = "update stats days=3"
1774 Console = "prune stats yes"
1781 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1782 \index[general]{ScratchPool}
1783 This directive permits to specify a specific \textsl{Scratch} pool for the
1784 current pool. This is useful when using multiple storage sharing the same
1785 mediatype or when you want to dedicate volumes to a particular set of pool.
1787 \subsection{Enhanced Attribute Despooling}
1788 \index[general]{Attribute Despooling}
1789 If the storage daemon and the Director are on the same machine, the spool file
1790 that contains attributes is read directly by the Director instead of being
1791 transmitted across the network. That should reduce load and speedup insertion.
1793 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1794 \index[general]{SpoolSize}
1795 A new Job directive permits to specify the spool size per job. This is used
1796 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1798 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1799 \index[general]{MaxConsoleConnections}
1800 A new director directive permits to specify the maximum number of Console
1801 Connections that could run concurrently. The default is set to 20, but you may
1802 set it to a larger number.
1804 \subsection{VerId = \lt{}string\gt{}}
1805 \index[general]{VerId}
1806 A new director directive permits to specify a personnal identifier that will be
1807 displayed in the \texttt{version} command.
1809 \subsection{dbcheck enhancements}
1810 \index[general]{dbcheck enhancements}
1811 If you are using Mysql, dbcheck will now ask you if you want to create
1812 temporary indexes to speed up orphaned Path and Filename elimination.
1814 A new \texttt{-B} option allows you to print catalog information in a simple
1815 text based format. This is useful to backup it in a secure way.
1830 You can now specify the database connection port in the command line.
1832 \subsection{{-}{-}docdir configure option}
1833 \index[general]{{-}{-}docdir configure option}
1834 You can use {-}{-}docdir= on the ./configure command to
1835 specify the directory where you want Bacula to install the
1836 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
1837 {\bf /usr/share/doc/bacula}.
1839 \subsection{{-}{-}htmldir configure option}
1840 \index[general]{{-}{-}htmldir configure option}
1841 You can use {-}{-}htmldir= on the ./configure command to
1842 specify the directory where you want Bacula to install the bat html help
1843 files. The default is {\bf /usr/share/doc/bacula/html}
1845 \subsection{{-}{-}with-plugindir configure option}
1846 \index[general]{{-}{-}plugindir configure option}
1847 You can use {-}{-}plugindir= on the ./configure command to
1848 specify the directory where you want Bacula to install
1849 the plugins (currently only bpipe-fd). The default is