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.
13 \section{Maximum concurent jobs for Devices}
14 \label{sec:maximumconcurentjobdevice}
16 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
17 Daemon configuration permits setting the maximum number of Jobs that can
18 run concurrently on a specified Device. Using this directive, it is
19 possible to have different Jobs using multiple drives, because when the
20 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
21 Jobs on any other available compatible drive. This facilitates writing to
22 multiple drives with multiple Jobs that all use the same Pool.
24 \section{Restore from Multiple Storage Daemons}
25 \index[general]{Restore}
27 Previously, you were able to restore from multiple devices in a single Storage
28 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
29 example, if your full backup runs on a Storage Daemon with an autochanger, and
30 your incremental jobs use another Storage Daemon with lots of disks, Bacula
31 will switch automatically from one Storage Daemon to an other within the same
34 You must upgrade your File Daemon to version 3.1.3 or greater to use this feature.
36 This project was funded by Bacula Systems with the help of Equiinet.
38 \section{File Deduplication using Base Jobs}
39 A base job is sort of like a Full save except that you will want the FileSet to
40 contain only files that are unlikely to change in the future (i.e. a snapshot
41 of most of your system after installing it). After the base job has been run,
42 when you are doing a Full save, you specify one or more Base jobs to be used.
43 All files that have been backed up in the Base job/jobs but not modified will
44 then be excluded from the backup. During a restore, the Base jobs will be
45 automatically pulled in where necessary.
47 This is something none of the competition does, as far as we know (except
48 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
49 win for the user, it makes Bacula stand out as offering a unique optimization
50 that immediately saves time and money. Basically, imagine that you have 100
51 nearly identical Windows or Linux machine containing the OS and user files.
52 Now for the OS part, a Base job will be backed up once, and rather than making
53 100 copies of the OS, there will be only one. If one or more of the systems
54 have some files updated, no problem, they will be automatically restored.
56 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
57 files that will be used during Full backup as base.
68 Base = BackupZog4, BackupLinux
74 In this example, the job \texttt{BackupZog4} will use the most recent version
75 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
76 jobs. Base jobs should have run with \texttt{level=Base} to be used.
78 By default, Bacula will compare permissions bits, user and group fields,
79 modification time, size and the checksum of the file to choose between the
80 current backup and the BaseJob file list. You can change this behavior with the
81 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
82 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
99 This project was funded by Bacula Systems.
102 \section{Accurate Fileset options}
103 \label{sec:accuratefileset}
105 In previous version, the accurate code was using file time creation and
106 modification to determine if a file was modified or not. Now you can specify
107 witch attribute to use (time, size, checksum, permission, owner, group,
128 compare the permission bits
131 compare the number of links
143 compare the access time
146 compare the modification time (st\_mtime)
149 compare the change time (st\_ctime)
152 report file size decreases
155 compare the MD5 signature
158 compare the SHA1 signature
161 \textbf{Important note:} If you decide to use checksum in Accurate jobs, the
162 File Daemon will have to read all files even if they won't be saved. It
163 increases the I/O load, but also the security. By default, Bacula will
164 check modification/creation time and size.
169 To help developers in restore GUI interfaces, we have added new \textsl{dot
170 commands} that permit to browse the catalog in a very simple way.
173 \item \texttt{.bvfs_update [jobid=x,y,z]} This command is required to update the
174 Bvfs cache in the catalog. You need to run it before any access to the Bvfs
177 \item \texttt{.bvfs_lsdirs jobid=x,y,z path=/path | pathid=101} This command
178 will list all directories in the specified \texttt{path} or
179 \texttt{pathid}. Using \texttt{pathid} avoids problems with caracters
182 \item \texttt{.bvfs_lsfiles jobid=x,y,z path=/path | pathid=101} This command
183 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
184 \texttt{pathid} avoids problems with caracters encoding.
187 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
188 data that will be displayed.
191 * .bvfs_update jobid=1,2
193 * .bvfs_lsdir path=/ jobid=1,2
196 \section{Testing your tape drive}
197 \label{sec:btapespeed}
199 To determine the best configuration of your tape drive, you can run the new
200 \texttt{speed} command available in \texttt{btape}.
202 This command can have the following arguments:
204 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
205 (between 1 and 5GB). This counter is in GB.
206 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
207 of data should be greater than your memory ($file\_size*nb\_file$).
208 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
210 \item[\texttt{skip\_random}] This flag permits to skip tests with random
212 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
213 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
218 *speed file_size=3 skip_raw
219 btape.c:1078 Test with zero data and bacula block structure.
220 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
221 ++++++++++++++++++++++++++++++++++++++++++
222 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
223 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
225 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
227 btape.c:1090 Test with random data, should give the minimum throughput.
228 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
229 +++++++++++++++++++++++++++++++++++++++++++
230 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
231 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
232 +++++++++++++++++++++++++++++++++++++++++++
234 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
238 When using compression, the random test will give your the minimum throughput
239 of your drive . The test using constant string will give you the maximum speed
240 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
242 You can change the block size in the Storage Daemon configuration file.
244 \section{New {\bf Block Checksum} Device directive}
245 You may now turn off the Block Checksum (CRC32) code
246 that Bacula uses when writing blocks to a Volume. This is
253 doing so can reduce the Storage daemon CPU speed slightly. It
254 will also permit Bacula to read a Volume that has corrupted data.
256 The default is {\bf yes} -- i.e. the checksum is computed on write
259 We do not recommend to turn this off particularly on older tape
260 drives or for disk Volumes where doing so may allow corrupted data
263 \section{New Bat Features}
265 \subsection{Media information view}
267 By double-clicking on a volume (on the Media list, in the Autochanger content
268 or in the Job information panel), you can access a detailed overview of your
269 Volume. (cf \ref{fig:mediainfo}.)
272 \includegraphics[width=13cm]{\idir bat11.eps}
273 \caption{Media information}
274 \label{fig:mediainfo}
277 \subsection{Job information view}
279 By double-clicking on a Job record (on the Job run list or in the Media
280 information panel), you can access a detailed overview of your Job. (cf
284 \includegraphics[width=13cm]{\idir bat12.eps}
285 \caption{Job information}
289 \subsection{Autochanger content view}
291 By double-clicking on a Storage record (on the Storage list panel), you can
292 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
295 \includegraphics[width=13cm]{\idir bat13.eps}
296 \caption{Autochanger content}
297 \label{fig:achcontent}
300 \chapter{New Features in Released Version 3.0.2}
302 This chapter presents the new features added to the
303 Released Bacula Version 3.0.2.
305 \section{Full restore from a given JobId}
306 \index[general]{Restore menu}
308 This feature allows selecting a single JobId and having Bacula
309 automatically select all the other jobs that comprise a full backup up to
310 and including the selected date (through JobId).
312 Assume we start with the following jobs:
314 +-------+--------------+---------------------+-------+----------+------------+
315 | jobid | client | starttime | level | jobfiles | jobbytes |
316 +-------+--------------+---------------------+-------+----------+------------
317 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
318 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
319 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
320 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
321 +-------+--------------+---------------------+-------+----------+------------+
324 Below is an example of this new feature (which is number 12 in the
329 To select the JobIds, you have the following choices:
330 1: List last 20 Jobs run
331 2: List Jobs where a given File is saved
333 12: Select full restore to a specified Job date
336 Select item: (1-13): 12
337 Enter JobId to get the state to restore: 5
338 Selecting jobs to build the Full state at 2009-07-15 11:45:45
339 You have selected the following JobIds: 1,3,5
341 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
342 1,444 files inserted into the tree.
345 This project was funded by Bacula Systems.
347 \section{Source Address}
348 \index[general]{Source Address}
350 A feature has been added which allows the administrator to specify the address
351 from which the Director and File daemons will establish connections. This
352 may be used to simplify system configuration overhead when working in complex
353 networks utilizing multi-homing and policy-routing.
355 To accomplish this, two new configuration directives have been implemented:
358 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
362 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
366 Simply adding specific host routes on the OS
367 would have an undesirable side-effect: any
368 application trying to contact the destination host would be forced to use the
369 more specific route possibly diverting management traffic onto a backup VLAN.
370 Instead of adding host routes for each client connected to a multi-homed backup
371 server (for example where there are management and backup VLANs), one can
372 use the new directives to specify a specific source address at the application
375 Additionally, this allows the simplification and abstraction of firewall rules
376 when dealing with a Hot-Standby director or storage daemon configuration. The
377 Hot-standby pair may share a CARP address, which connections must be sourced
378 from, while system services listen and act from the unique interface addresses.
380 This project was funded by Collaborative Fusion, Inc.
382 \section{Show volume availability when doing restore}
384 When doing a restore the selection dialog ends by displaying this
388 The job will require the following
389 Volume(s) Storage(s) SD Device(s)
390 ===========================================================================
401 Volumes marked with ``*'' are online (in the autochanger).
404 This should help speed up large restores by minimizing the time spent
405 waiting for the operator to discover that he must change tapes in the library.
407 This project was funded by Bacula Systems.
409 \section{Accurate estimate command}
411 The \texttt{estimate} command can now use the accurate code to detect changes
412 and give a better estimation.
414 You can set the accurate behavior on the command line by using
415 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
418 * estimate listing accurate=yes level=incremental job=BackupJob
421 This project was funded by Bacula Systems.
423 \chapter{New Features in 3.0.0}
424 \label{NewFeaturesChapter}
425 \index[general]{New Features}
427 This chapter presents the new features added to the development 2.5.x
428 versions to be released as Bacula version 3.0.0 sometime in April 2009.
430 \section{Accurate Backup}
431 \index[general]{Accurate Backup}
433 As with most other backup programs, by default Bacula decides what files to
434 backup for Incremental and Differental backup by comparing the change
435 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
436 backup completed. If one of those two times is later than the last backup
437 time, then the file will be backed up. This does not, however, permit tracking
438 what files have been deleted and will miss any file with an old time that may
439 have been restored to or moved onto the client filesystem.
441 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
442 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
443 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
444 backup, there is no difference, but for {\bf Differential} and {\bf
445 Incremental} backups, the Director will send a list of all previous files
446 backed up, and the File daemon will use that list to determine if any new files
447 have been added or or moved and if any files have been deleted. This allows
448 Bacula to make an accurate backup of your system to that point in time so that
449 if you do a restore, it will restore your system exactly.
452 about using Accurate backup is that it requires more resources (CPU and memory)
453 on both the Director and the Client machines to create the list of previous
454 files backed up, to send that list to the File daemon, for the File daemon to
455 keep the list (possibly very big) in memory, and for the File daemon to do
456 comparisons between every file in the FileSet and the list. In particular,
457 if your client has lots of files (more than a few million), you will need
458 lots of memory on the client machine.
460 Accurate must not be enabled when backing up with a plugin that is not
461 specially designed to work with Accurate. If you enable it, your restores
462 will probably not work correctly.
464 This project was funded by Bacula Systems.
469 \index[general]{Copy Jobs}
471 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
472 existing Migration feature with the exception that the Job that is copied is
473 left unchanged. This essentially creates two identical copies of the same
474 backup. However, the copy is treated as a copy rather than a backup job, and
475 hence is not directly available for restore. The {\bf restore} command lists
476 copy jobs and allows selection of copies by using \texttt{jobid=}
477 option. If the keyword {\bf copies} is present on the command line, Bacula will
478 display the list of all copies for selected jobs.
483 These JobIds have copies as follows:
484 +-------+------------------------------------+-----------+------------------+
485 | JobId | Job | CopyJobId | MediaType |
486 +-------+------------------------------------+-----------+------------------+
487 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
488 +-------+------------------------------------+-----------+------------------+
489 +-------+-------+----------+----------+---------------------+------------------+
490 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
491 +-------+-------+----------+----------+---------------------+------------------+
492 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
493 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
494 +-------+-------+----------+----------+---------------------+------------------+
495 You have selected the following JobIds: 19,2
497 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
498 5,611 files inserted into the tree.
503 The Copy Job runs without using the File daemon by copying the data from the
504 old backup Volume to a different Volume in a different Pool. See the Migration
505 documentation for additional details. For copy Jobs there is a new selection
506 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
507 not already copied to another Pool.
509 As with Migration, the Client, Volume, Job, or SQL query, are
510 other possible ways of selecting the Jobs to be copied. Selection
511 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
512 work, but are probably more suited for Migration Jobs.
514 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
515 it will promote the Copy to a \textsl{real} backup job and will make it available for
516 automatic restore. If more than one Copy is available, it will promote the copy
517 with the smallest JobId.
519 A nice solution which can be built with the new Copy feature is often
520 called disk-to-disk-to-tape backup (DTDTT). A sample config could
521 look something like the one below:
525 Name = FullBackupsVirtualPool
527 Purge Oldest Volume = Yes
529 NextPool = FullBackupsTapePool
533 Name = FullBackupsTapePool
537 Volume Retention = 365 days
538 Storage = superloader
542 # Fake fileset for copy jobs
554 # Fake client for copy jobs
564 # Default template for a CopyDiskToTape Job
567 Name = CopyDiskToTape
569 Messages = StandardCopy
572 Selection Type = PoolUncopiedJobs
573 Maximum Concurrent Jobs = 10
575 Allow Duplicate Jobs = Yes
576 Allow Higher Duplicates = No
577 Cancel Queued Duplicates = No
578 Cancel Running Duplicates = No
583 Name = DaySchedule7:00
584 Run = Level=Full daily at 7:00
588 Name = CopyDiskToTapeFullBackups
590 Schedule = DaySchedule7:00
591 Pool = FullBackupsVirtualPool
592 JobDefs = CopyDiskToTape
596 The example above had 2 pool which are copied using the PoolUncopiedJobs
597 selection criteria. Normal Full backups go to the Virtual pool and are copied
598 to the Tape pool the next morning.
600 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
605 +-------+------------------------------------+-----------+------------------+
606 | JobId | Job | CopyJobId | MediaType |
607 +-------+------------------------------------+-----------+------------------+
608 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
609 +-------+------------------------------------+-----------+------------------+
612 \section{ACL Updates}
613 \index[general]{ACL Updates}
614 The whole ACL code had been overhauled and in this version each platforms has
615 different streams for each type of acl available on such an platform. As ACLs
616 between platforms tend to be not that portable (most implement POSIX acls but
617 some use an other draft or a completely different format) we currently only
618 allow certain platform specific ACL streams to be decoded and restored on the
619 same platform that they were created on. The old code allowed to restore ACL
620 cross platform but the comments already mention that not being to wise. For
621 backward compatability the new code will accept the two old ACL streams and
622 handle those with the platform specific handler. But for all new backups it
623 will save the ACLs using the new streams.
625 Currently the following platforms support ACLs:
629 \item {\bf Darwin/OSX}
638 Currently we support the following ACL types (these ACL streams use a reserved
639 part of the stream numbers):
642 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
644 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
645 string representation from acl\_to\_text (POSIX acl)
646 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
647 string representation from acl\_to\_text (POSIX acl) for default acls.
648 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
649 string representation from acl\_to\_text (POSIX acl) for access acls.
650 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
651 string representation from acltostr (POSIX acl)
652 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
653 representation from acl\_to\_text (POSIX acl) for default acls.
654 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
655 representation from acl\_to\_text (POSIX acl) for access acls.
656 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
657 string representation from acl\_to\_text (POSIX acl) for default acls.
658 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
659 representation from acl\_to\_text (POSIX acl) for access acls.
660 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
661 string representation from acl\_to\_text (POSIX acl) for default acls.
662 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
663 string representation from acl\_to\_text (POSIX acl) for default acls.
664 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
665 representation from acl\_to\_text (POSIX acl) for access acls.
666 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
667 string representation from acltotext or acl\_totext (POSIX acl)
668 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
669 representation from from acl\_totext (NFSv4 or ZFS acl)
672 In future versions we might support conversion functions from one type of acl
673 into an other for types that are either the same or easily convertable. For now
674 the streams are seperate and restoring them on a platform that doesn't
675 recognize them will give you a warning.
677 \section{Extended Attributes}
678 \index[general]{Extended Attributes}
679 Something that was on the project list for some time is now implemented for
680 platforms that support a similar kind of interface. Its the support for backup
681 and restore of so called extended attributes. As extended attributes are so
682 platform specific these attributes are saved in seperate streams for each
683 platform. Restores of the extended attributes can only be performed on the
684 same platform the backup was done. There is support for all types of extended
685 attributes, but restoring from one type of filesystem onto an other type of
686 filesystem on the same platform may lead to supprises. As extended attributes
687 can contain any type of data they are stored as a series of so called
688 value-pairs. This data must be seen as mostly binary and is stored as such.
689 As security labels from selinux are also extended attributes this option also
690 stores those labels and no specific code is enabled for handling selinux
693 Currently the following platforms support extended attributes:
695 \item {\bf Darwin/OSX}
701 On linux acls are also extended attributes, as such when you enable ACLs on a
702 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
703 and not the same exteneded attribute.
705 To enable the backup of extended attributes please add the following to your
720 \section{Shared objects}
721 \index[general]{Shared objects}
722 A default build of Bacula will now create the libraries as shared objects
723 (.so) rather than static libraries as was previously the case.
724 The shared libraries are built using {\bf libtool} so it should be quite
727 An important advantage of using shared objects is that on a machine with the
728 Directory, File daemon, the Storage daemon, and a console, you will have only
729 one copy of the code in memory rather than four copies. Also the total size of
730 the binary release is smaller since the library code appears only once rather
731 than once for every program that uses it; this results in significant reduction
732 in the size of the binaries particularly for the utility tools.
734 In order for the system loader to find the shared objects when loading the
735 Bacula binaries, the Bacula shared objects must either be in a shared object
736 directory known to the loader (typically /usr/lib) or they must be in the
737 directory that may be specified on the {\bf ./configure} line using the {\bf
738 {-}{-}libdir} option as:
741 ./configure --libdir=/full-path/dir
744 the default is /usr/lib. If {-}{-}libdir is specified, there should be
745 no need to modify your loader configuration provided that
746 the shared objects are installed in that directory (Bacula
747 does this with the make install command). The shared objects
748 that Bacula references are:
757 These files are symbolically linked to the real shared object file,
758 which has a version number to permit running multiple versions of
759 the libraries if desired (not normally the case).
761 If you have problems with libtool or you wish to use the old
762 way of building static libraries, or you want to build a static
763 version of Bacula you may disable
764 libtool on the configure command line with:
767 ./configure --disable-libtool
771 \section{Building Static versions of Bacula}
772 \index[general]{Static linking}
773 In order to build static versions of Bacula, in addition
774 to configuration options that were needed you now must
775 also add --disable-libtool. Example
778 ./configure --enable-static-client-only --disable-libtool
782 \section{Virtual Backup (Vbackup)}
783 \index[general]{Virtual Backup}
784 \index[general]{Vbackup}
786 Bacula's virtual backup feature is often called Synthetic Backup or
787 Consolidation in other backup products. It permits you to consolidate the
788 previous Full backup plus the most recent Differential backup and any
789 subsequent Incremental backups into a new Full backup. This new Full
790 backup will then be considered as the most recent Full for any future
791 Incremental or Differential backups. The VirtualFull backup is
792 accomplished without contacting the client by reading the previous backup
793 data and writing it to a volume in a different pool.
795 In some respects the Vbackup feature works similar to a Migration job, in
796 that Bacula normally reads the data from the pool specified in the
797 Job resource, and writes it to the {\bf Next Pool} specified in the
798 Job resource. Note, this means that usually the output from the Virtual
799 Backup is written into a different pool from where your prior backups
800 are saved. Doing it this way guarantees that you will not get a deadlock
801 situation attempting to read and write to the same volume in the Storage
802 daemon. If you then want to do subsequent backups, you may need to
803 move the Virtual Full Volume back to your normal backup pool.
804 Alternatively, you can set your {\bf Next Pool} to point to the current
805 pool. This will cause Bacula to read and write to Volumes in the
806 current pool. In general, this will work, because Bacula will
807 not allow reading and writing on the same Volume. In any case, once
808 a VirtualFull has been created, and a restore is done involving the
809 most current Full, it will read the Volume or Volumes by the VirtualFull
810 regardless of in which Pool the Volume is found.
812 The Vbackup is enabled on a Job by Job in the Job resource by specifying
813 a level of {\bf VirtualFull}.
815 A typical Job resource definition might look like the following:
829 # Default pool definition
833 Recycle = yes # Automatically recycle Volumes
834 AutoPrune = yes # Prune expired volumes
835 Volume Retention = 365d # one year
843 Recycle = yes # Automatically recycle Volumes
844 AutoPrune = yes # Prune expired volumes
845 Volume Retention = 365d # one year
846 Storage = DiskChanger
849 # Definition of file storage device
856 Maximum Concurrent Jobs = 5
859 # Definition of DDS Virtual tape disk storage device
862 Address = localhost # N.B. Use a fully qualified name here
865 Media Type = DiskChangerMedia
866 Maximum Concurrent Jobs = 4
871 Then in bconsole or via a Run schedule, you would run the job as:
874 run job=MyBackup level=Full
875 run job=MyBackup level=Incremental
876 run job=MyBackup level=Differential
877 run job=MyBackup level=Incremental
878 run job=MyBackup level=Incremental
881 So providing there were changes between each of those jobs, you would end up
882 with a Full backup, a Differential, which includes the first Incremental
883 backup, then two Incremental backups. All the above jobs would be written to
884 the {\bf Default} pool.
886 To consolidate those backups into a new Full backup, you would run the
890 run job=MyBackup level=VirtualFull
893 And it would produce a new Full backup without using the client, and the output
894 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
896 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
899 Note, the Start and End time of the Virtual Full backup is set to the
900 values for the last job included in the Virtual Full (in the above example,
901 it is an Increment). This is so that if another incremental is done, which
902 will be based on the Virtual Full, it will backup all files from the
903 last Job included in the Virtual Full rather than from the time the Virtual
904 Full was actually run.
908 \section{Catalog Format}
909 \index[general]{Catalog Format}
910 Bacula 3.0 comes with some changes to the catalog format. The upgrade
911 operation will convert the FileId field of the File table from 32 bits (max 4
912 billion table entries) to 64 bits (very large number of items). The
913 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
914 your catalog during the conversion. Also you won't be able to run jobs during
915 this conversion period. For example, a 3 million file catalog will take 2
916 minutes to upgrade on a normal machine. Please don't forget to make a valid
917 backup of your database before executing the upgrade script. See the
918 ReleaseNotes for additional details.
920 \section{64 bit Windows Client}
921 \index[general]{Win64 Client}
922 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
923 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
924 As a consequence, we are also releasing a 64 bit version of the Bacula
925 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
926 These binaries should only be installed on 64 bit Windows operating systems.
927 What is important is not your hardware but whether or not you have
928 a 64 bit version of the Windows OS.
930 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
932 \item Before installing the Win64 Bacula Client, you must totally
933 deinstall any prior 2.4.x Client installation using the
934 Bacula deinstallation (see the menu item). You may want
935 to save your .conf files first.
936 \item Only the Client (File daemon) is ported to Win64, the Director
937 and the Storage daemon are not in the 64 bit Windows installer.
938 \item bwx-console is not yet ported.
939 \item bconsole is ported but it has not been tested.
940 \item The documentation is not included in the installer.
941 \item Due to Vista security restrictions imposed on a default installation
942 of Vista, before upgrading the Client, you must manually stop
943 any prior version of Bacula from running, otherwise the install
945 \item Due to Vista security restrictions imposed on a default installation
946 of Vista, attempting to edit the conf files via the menu items
947 will fail. You must directly edit the files with appropriate
948 permissions. Generally double clicking on the appropriate .conf
949 file will work providing you have sufficient permissions.
950 \item All Bacula files are now installed in
951 {\bf C:/Program Files/Bacula} except the main menu items,
952 which are installed as before. This vastly simplifies the installation.
953 \item If you are running on a foreign language version of Windows, most
954 likely {\bf C:/Program Files} does not exist, so you should use the
955 Custom installation and enter an appropriate location to install
957 \item The 3.0.0 Win32 Client continues to install files in the locations used
958 by prior versions. For the next version we will convert it to use
959 the same installation conventions as the Win64 version.
962 This project was funded by Bacula Systems.
965 \section{Duplicate Job Control}
966 \index[general]{Duplicate Jobs}
967 The new version of Bacula provides four new directives that
968 give additional control over what Bacula does if duplicate jobs
969 are started. A duplicate job in the sense we use it here means
970 a second or subsequent job with the same name starts. This
971 happens most frequently when the first job runs longer than expected because no
974 The four directives each take as an argument a {\bf yes} or {\bf no} value and
975 are specified in the Job resource.
979 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
980 \index[general]{Allow Duplicate Jobs}
981 If this directive is enabled duplicate jobs will be run. If
982 the directive is set to {\bf no} (default) then only one job of a given name
983 may run at one time, and the action that Bacula takes to ensure only
984 one job runs is determined by the other directives (see below).
986 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
987 are present and none of the three directives given below permit
988 cancelling a job, then the current job (the second one started)
992 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
993 \index[general]{Allow Higher Duplicates}
994 If this directive is set to {\bf yes} (default) the job with a higher
995 priority (lower priority number) will be permitted to run, and
996 the current job will be cancelled. If the
997 priorities of the two jobs are the same, the outcome is determined by
998 other directives (see below).
1000 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1001 \index[general]{Cancel Queued Duplicates}
1002 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1003 if this directive is set to {\bf yes} any job that is
1004 already queued to run but not yet running will be canceled.
1005 The default is {\bf no}.
1007 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1008 \index[general]{Cancel Running Duplicates}
1009 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1010 if this directive is set to {\bf yes} any job that is already running
1011 will be canceled. The default is {\bf no}.
1014 \section{TLS Authentication}
1015 \index[general]{TLS Authentication}
1016 In Bacula version 2.5.x and later, in addition to the normal Bacula
1017 CRAM-MD5 authentication that is used to authenticate each Bacula
1018 connection, you can specify that you want TLS Authentication as well,
1019 which will provide more secure authentication.
1021 This new feature uses Bacula's existing TLS code (normally used for
1022 communications encryption) to do authentication. To use it, you must
1023 specify all the TLS directives normally used to enable communications
1024 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1027 \subsection{TLS Authenticate = yes}
1029 TLS Authenticate = yes
1032 in the main daemon configuration resource (Director for the Director,
1033 Client for the File daemon, and Storage for the Storage daemon).
1035 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1036 authentication, Bacula will also do TLS authentication, then TLS
1037 encryption will be turned off, and the rest of the communication between
1038 the two Bacula daemons will be done without encryption.
1040 If you want to encrypt communications data, use the normal TLS directives
1041 but do not turn on {\bf TLS Authenticate}.
1043 \section{bextract non-portable Win32 data}
1044 \index[general]{bextract handles Win32 non-portable data}
1045 {\bf bextract} has been enhanced to be able to restore
1046 non-portable Win32 data to any OS. Previous versions were
1047 unable to restore non-portable Win32 data to machines that
1048 did not have the Win32 BackupRead and BackupWrite API calls.
1050 \section{State File updated at Job Termination}
1051 \index[general]{State File}
1052 In previous versions of Bacula, the state file, which provides a
1053 summary of previous jobs run in the {\bf status} command output was
1054 updated only when Bacula terminated, thus if the daemon crashed, the
1055 state file might not contain all the run data. This version of
1056 the Bacula daemons updates the state file on each job termination.
1058 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1059 \index[general]{MaxFullInterval}
1060 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1061 can be used to specify the maximum time interval between {\bf Full} backup
1062 jobs. When a job starts, if the time since the last Full backup is
1063 greater than the specified interval, and the job would normally be an
1064 {\bf Incremental} or {\bf Differential}, it will be automatically
1065 upgraded to a {\bf Full} backup.
1067 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1068 \index[general]{MaxDiffInterval}
1069 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1070 can be used to specify the maximum time interval between {\bf Differential} backup
1071 jobs. When a job starts, if the time since the last Differential backup is
1072 greater than the specified interval, and the job would normally be an
1073 {\bf Incremental}, it will be automatically
1074 upgraded to a {\bf Differential} backup.
1076 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1077 \index[general]{MaxDiffInterval}
1078 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1079 by the user, and when it is set it is an indication to backup programs
1080 to not backup that particular file. This version of Bacula contains a
1081 new Options directive within a FileSet resource, which instructs Bacula to
1082 obey this flag. The new directive is:
1085 Honor No Dump Flag = yes\vb{}no
1088 The default value is {\bf no}.
1091 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1092 \index[general]{IgnoreDir}
1093 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1094 can be added to the Include section of the FileSet resource. If the specified
1095 filename ({\bf filename-string}) is found on the Client in any directory to be
1096 backed up, the whole directory will be ignored (not backed up). For example:
1099 # List of files to be backed up
1107 Exclude Dir Containing = .excludeme
1112 But in /home, there may be hundreds of directories of users and some
1113 people want to indicate that they don't want to have certain
1114 directories backed up. For example, with the above FileSet, if
1115 the user or sysadmin creates a file named {\bf .excludeme} in
1116 specific directories, such as
1119 /home/user/www/cache/.excludeme
1120 /home/user/temp/.excludeme
1123 then Bacula will not backup the two directories named:
1126 /home/user/www/cache
1130 NOTE: subdirectories will not be backed up. That is, the directive
1131 applies to the two directories in question and any children (be they
1132 files, directories, etc).
1135 \section{Bacula Plugins}
1136 \index[general]{Plugin}
1137 Support for shared object plugins has been implemented in the Linux, Unix
1138 and Win32 File daemons. The API will be documented separately in
1139 the Developer's Guide or in a new document. For the moment, there is
1140 a single plugin named {\bf bpipe} that allows an external program to
1141 get control to backup and restore a file.
1143 Plugins are also planned (partially implemented) in the Director and the
1146 \subsection{Plugin Directory}
1147 \index[general]{Plugin Directory}
1148 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1149 be added to the daemon definition resource. The directory takes a quoted
1150 string argument, which is the name of the directory in which the daemon can
1151 find the Bacula plugins. If this directive is not specified, Bacula will not
1152 load any plugins. Since each plugin has a distinctive name, all the daemons
1153 can share the same plugin directory.
1155 \subsection{Plugin Options}
1156 \index[general]{Plugin Options}
1157 The {\bf Plugin Options} directive takes a quoted string
1158 arguement (after the equal sign) and may be specified in the
1159 Job resource. The options specified will be passed to all plugins
1160 when they are run. This each plugin must know what it is looking
1161 for. The value defined in the Job resource can be modified
1162 by the user when he runs a Job via the {\bf bconsole} command line
1165 Note: this directive may be specified, and there is code to modify
1166 the string in the run command, but the plugin options are not yet passed to
1167 the plugin (i.e. not fully implemented).
1169 \subsection{Plugin Options ACL}
1170 \index[general]{Plugin Options ACL}
1171 The {\bf Plugin Options ACL} directive may be specified in the
1172 Director's Console resource. It functions as all the other ACL commands
1173 do by permitting users running restricted consoles to specify a
1174 {\bf Plugin Options} that overrides the one specified in the Job
1175 definition. Without this directive restricted consoles may not modify
1178 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1179 \index[general]{Plugin}
1180 The {\bf Plugin} directive is specified in the Include section of
1181 a FileSet resource where you put your {\bf File = xxx} directives.
1192 Plugin = "bpipe:..."
1197 In the above example, when the File daemon is processing the directives
1198 in the Include section, it will first backup all the files in {\bf /home}
1199 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1200 the Plugin Directory. The syntax and semantics of the Plugin directive
1201 require the first part of the string up to the colon (:) to be the name
1202 of the plugin. Everything after the first colon is ignored by the File daemon but
1203 is passed to the plugin. Thus the plugin writer may define the meaning of the
1204 rest of the string as he wishes.
1206 Please see the next section for information about the {\bf bpipe} Bacula
1209 \section{The bpipe Plugin}
1210 \index[general]{The bpipe Plugin}
1211 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1212 the Bacula source distribution. When the plugin is compiled and linking into
1213 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1215 The purpose of the plugin is to provide an interface to any system program for
1216 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1217 the Include section of your Job's FileSet resource. The full syntax of the
1218 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1219 to specify the sytax as it wishes) is:
1222 Plugin = "<field1>:<field2>:<field3>:<field4>"
1227 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1228 stripped off, so in this case, we would put {\bf bpipe} in this field.
1230 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1231 pseudo path and filename under which the backup will be saved. This pseudo
1232 path and filename will be seen by the user in the restore file tree.
1233 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1234 backed up by the plugin will be put under that "pseudo" path and filename.
1235 You must be careful to choose a naming convention that is unique to avoid
1236 a conflict with a path and filename that actually exists on your system.
1238 \item {\bf field3} for the {\bf bpipe} plugin
1239 specifies the "reader" program that is called by the plugin during
1240 backup to read the data. {\bf bpipe} will call this program by doing a
1243 \item {\bf field4} for the {\bf bpipe} plugin
1244 specifies the "writer" program that is called by the plugin during
1245 restore to write the data back to the filesystem.
1248 Putting it all together, the full plugin directive line might look
1252 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1253 --opt --databases bacula:mysql"
1256 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1257 would be written on a single line.
1259 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1260 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1261 program {\bf mysqldump -f --opt --database bacula} to read the data during
1262 backup. The mysqldump command outputs all the data for the database named
1263 {\bf bacula}, which will be read by the plugin and stored in the backup.
1264 During restore, the data that was backed up will be sent to the program
1265 specified in the last field, which in this case is {\bf mysql}. When
1266 {\bf mysql} is called, it will read the data sent to it by the plugn
1267 then write it back to the same database from which it came ({\bf bacula}
1270 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1271 the data from a specified program to Bacula for backup, and then from Bacula to
1272 a specified program for restore.
1274 By using different command lines to {\bf bpipe},
1275 you can backup any kind of data (ASCII or binary) depending
1276 on the program called.
1278 \section{Microsoft Exchange Server 2003/2007 Plugin}
1279 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1280 \subsection{Background}
1281 The Exchange plugin was made possible by a funded development project
1282 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1283 The code for the plugin was written by James Harper, and the Bacula core
1284 code by Kern Sibbald. All the code for this funded development has become
1285 part of the Bacula project. Thanks to everyone who made it happen.
1287 \subsection{Concepts}
1288 Although it is possible to backup Exchange using Bacula VSS the Exchange
1289 plugin adds a good deal of functionality, because while Bacula VSS
1290 completes a full backup (snapshot) of Exchange, it does
1291 not support Incremental or Differential backups, restoring is more
1292 complicated, and a single database restore is not possible.
1294 Microsoft Exchange organises its storage into Storage Groups with
1295 Databases inside them. A default installation of Exchange will have a
1296 single Storage Group called 'First Storage Group', with two Databases
1297 inside it, "Mailbox Store (SERVER NAME)" and
1298 "Public Folder Store (SERVER NAME)",
1299 which hold user email and public folders respectively.
1301 In the default configuration, Exchange logs everything that happens to
1302 log files, such that if you have a backup, and all the log files since,
1303 you can restore to the present time. Each Storage Group has its own set
1304 of log files and operates independently of any other Storage Groups. At
1305 the Storage Group level, the logging can be turned off by enabling a
1306 function called "Enable circular logging". At this time the Exchange
1307 plugin will not function if this option is enabled.
1309 The plugin allows backing up of entire storage groups, and the restoring
1310 of entire storage groups or individual databases. Backing up and
1311 restoring at the individual mailbox or email item is not supported but
1312 can be simulated by use of the "Recovery" Storage Group (see below).
1314 \subsection{Installing}
1315 The Exchange plugin requires a DLL that is shipped with Microsoft
1316 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1317 correctly the Exchange plugin should find this automatically and run
1318 without any additional installation.
1320 If the DLL can not be found automatically it will need to be copied into
1321 the Bacula installation
1322 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1323 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1324 default Exchange installation.
1326 \subsection{Backup up}
1327 To back up an Exchange server the Fileset definition must contain at
1328 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1329 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1330 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1331 up files are prefixed with something that isn't going to share a name
1332 with something outside the plugin, and the 'Microsoft Information Store'
1333 bit is required also. It is also possible to add the name of a storage
1334 group to the "Plugin =" line, eg \\
1335 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1336 if you want only a single storage group backed up.
1338 Additionally, you can suffix the 'Plugin =' directive with
1339 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1340 database at the end of a full backup.
1342 An Incremental or Differential backup will backup only the database logs
1343 for each Storage Group by inspecting the "modified date" on each
1344 physical log file. Because of the way the Exchange API works, the last
1345 logfile backed up on each backup will always be backed up by the next
1346 Incremental or Differential backup too. This adds 5MB to each
1347 Incremental or Differential backup size but otherwise does not cause any
1350 By default, a normal VSS fileset containing all the drive letters will
1351 also back up the Exchange databases using VSS. This will interfere with
1352 the plugin and Exchange's shared ideas of when the last full backup was
1353 done, and may also truncate log files incorrectly. It is important,
1354 therefore, that the Exchange database files be excluded from the backup,
1355 although the folders the files are in should be included, or they will
1356 have to be recreated manually if a baremetal restore is done.
1361 File = C:/Program Files/Exchsrvr/mdbdata
1362 Plugin = "exchange:..."
1365 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1366 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1367 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1368 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1369 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1370 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1371 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1376 The advantage of excluding the above files is that you can significantly
1377 reduce the size of your backup since all the important Exchange files
1378 will be properly saved by the Plugin.
1381 \subsection{Restoring}
1382 The restore operation is much the same as a normal Bacula restore, with
1383 the following provisos:
1386 \item The {\bf Where} restore option must not be specified
1387 \item Each Database directory must be marked as a whole. You cannot just
1388 select (say) the .edb file and not the others.
1389 \item If a Storage Group is restored, the directory of the Storage Group
1391 \item It is possible to restore only a subset of the available log files,
1392 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1393 if a log file is missing from the sequence of log files
1394 \item Each database to be restored must be dismounted and marked as "Can be
1395 overwritten by restore"
1396 \item If an entire Storage Group is to be restored (eg all databases and
1397 logs in the Storage Group), then it is best to manually delete the
1398 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1399 as Exchange can get confused by stray log files lying around.
1402 \subsection{Restoring to the Recovery Storage Group}
1403 The concept of the Recovery Storage Group is well documented by
1405 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1406 but to briefly summarize...
1408 Microsoft Exchange allows the creation of an additional Storage Group
1409 called the Recovery Storage Group, which is used to restore an older
1410 copy of a database (e.g. before a mailbox was deleted) into without
1411 messing with the current live data. This is required as the Standard and
1412 Small Business Server versions of Exchange can not ordinarily have more
1413 than one Storage Group.
1415 To create the Recovery Storage Group, drill down to the Server in Exchange
1416 System Manager, right click, and select
1417 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1418 locations and click OK. On the Recovery Storage Group, right click and
1419 select {\bf "Add Database to Recover..."} and select the database you will
1422 Restore only the single database nominated as the database in the
1423 Recovery Storage Group. Exchange will redirect the restore to the
1424 Recovery Storage Group automatically.
1425 Then run the restore.
1427 \subsection{Restoring on Microsoft Server 2007}
1428 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1429 2007, and henc you use a new proceedure for recovering a single mail box.
1430 This procedure is ducomented by Microsoft at:
1431 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1432 and involves using the {\bf Restore-Mailbox} and {\bf
1433 Get-MailboxStatistics} shell commands.
1435 \subsection{Caveats}
1436 This plugin is still being developed, so you should consider it
1437 currently in BETA test, and thus use in a production environment
1438 should be done only after very careful testing.
1440 When doing a full backup, the Exchange database logs are truncated by
1441 Exchange as soon as the plugin has completed the backup. If the data
1442 never makes it to the backup medium (eg because of spooling) then the
1443 logs will still be truncated, but they will also not have been backed
1444 up. A solution to this is being worked on. You will have to schedule a
1445 new Full backup to ensure that your next backups will be usable.
1447 The "Enable Circular Logging" option cannot be enabled or the plugin
1450 Exchange insists that a successful Full backup must have taken place if
1451 an Incremental or Differential backup is desired, and the plugin will
1452 fail if this is not the case. If a restore is done, Exchange will
1453 require that a Full backup be done before an Incremental or Differential
1456 The plugin will most likely not work well if another backup application
1457 (eg NTBACKUP) is backing up the Exchange database, especially if the
1458 other backup application is truncating the log files.
1460 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1461 we recommend either carefully testing or that you avoid this option for
1464 The Exchange plugin is not called during processing the bconsole {\bf
1465 estimate} command, and so anything that would be backed up by the plugin
1466 will not be added to the estimate total that is displayed.
1469 \section{libdbi Framework}
1470 \index[general]{libdbi Framework}
1471 As a general guideline, Bacula has support for a few catalog database drivers
1472 (MySQL, PostgreSQL, SQLite)
1473 coded natively by the Bacula team. With the libdbi implementation, which is a
1474 Bacula driver that uses libdbi to access the catalog, we have an open field to
1475 use many different kinds database engines following the needs of users.
1477 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1478 implements a database-independent abstraction layer in C, similar to the
1479 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1480 leverage the power of multiple databases and multiple simultaneous database
1481 connections by using this framework.
1483 Currently the libdbi driver in Bacula project only supports the same drivers
1484 natively coded in Bacula. However the libdbi project has support for many
1485 others database engines. You can view the list at
1486 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1487 supported by Bacula, however, they must be tested properly by the Bacula team.
1489 Some of benefits of using libdbi are:
1491 \item The possibility to use proprietary databases engines in which your
1492 proprietary licenses prevent the Bacula team from developing the driver.
1493 \item The possibility to use the drivers written for the libdbi project.
1494 \item The possibility to use other database engines without recompiling Bacula
1495 to use them. Just change one line in bacula-dir.conf
1496 \item Abstract Database access, this is, unique point to code and profiling
1497 catalog database access.
1500 The following drivers have been tested:
1502 \item PostgreSQL, with and without batch insert
1503 \item Mysql, with and without batch insert
1508 In the future, we will test and approve to use others databases engines
1509 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1511 To compile Bacula to support libdbi we need to configure the code with the
1512 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1513 [database] is the database engine to be used with Bacula (of course we can
1514 change the driver in file bacula-dir.conf, see below). We must configure the
1515 access port of the database engine with the option --with-db-port, because the
1516 libdbi framework doesn't know the default access port of each database.
1518 The next phase is checking (or configuring) the bacula-dir.conf, example:
1522 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1523 dbname = regress; user = regress; password = ""
1527 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1528 mysql database. Currently the drivers supported by Bacula are: postgresql,
1529 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1531 The following limitations apply when Bacula is set to use the libdbi framework:
1532 - Not tested on the Win32 platform
1533 - A little performance is lost if comparing with native database driver.
1534 The reason is bound with the database driver provided by libdbi and the
1535 simple fact that one more layer of code was added.
1537 It is important to remember, when compiling Bacula with libdbi, the
1538 following packages are needed:
1540 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1541 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1544 You can download them and compile them on your system or install the packages
1545 from your OS distribution.
1547 \section{Console Command Additions and Enhancements}
1548 \index[general]{Console Additions}
1550 \subsection{Display Autochanger Content}
1551 \index[general]{StatusSlots}
1553 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1554 autochanger content.
1558 Slot | Volume Name | Status | Media Type | Pool |
1559 ------+---------------+----------+-------------------+------------|
1560 1 | 00001 | Append | DiskChangerMedia | Default |
1561 2 | 00002 | Append | DiskChangerMedia | Default |
1562 3*| 00003 | Append | DiskChangerMedia | Scratch |
1567 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1568 {\bf update slots} command to synchronize autochanger content with your
1571 \subsection{list joblog job=xxx or jobid=nnn}
1572 \index[general]{list joblog}
1573 A new list command has been added that allows you to list the contents
1574 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1575 or for a particular JobId. The {\bf llist} command will include a line with
1576 the time and date of the entry.
1578 Note for the catalog to have Job Log entries, you must have a directive
1585 In your Director's {\bf Messages} resource.
1587 \subsection{Use separator for multiple commands}
1588 \index[general]{Command Separator}
1589 When using bconsole with readline, you can set the command separator with
1590 \textbf{@separator} command to one
1591 of those characters to write commands who require multiple input in one line.
1593 !$%&'()*+,-/:;<>?[]^`{|}~
1596 \subsection{Deleting Volumes}
1597 The delete volume bconsole command has been modified to
1598 require an asterisk (*) in front of a MediaId otherwise the
1599 value you enter is a taken to be a Volume name. This is so that
1600 users may delete numeric Volume names. The previous Bacula versions
1601 assumed that all input that started with a number was a MediaId.
1603 This new behavior is indicated in the prompt if you read it
1606 \section{Bare Metal Recovery}
1607 The old bare metal recovery project is essentially dead. One
1608 of the main features of it was that it would build a recovery
1609 CD based on the kernel on your system. The problem was that
1610 every distribution has a different boot procedure and different
1611 scripts, and worse yet, the boot procedures and scripts change
1612 from one distribution to another. This meant that maintaining
1613 (keeping up with the changes) the rescue CD was too much work.
1615 To replace it, a new bare metal recovery USB boot stick has been developed
1616 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1617 boot from a USB key.
1621 \item Recovery can be done from within graphical environment.
1622 \item Recovery can be done in a shell.
1623 \item Ubuntu boots on a large number of Linux systems.
1624 \item The process of updating the system and adding new
1625 packages is not too difficult.
1626 \item The USB key can easily be upgraded to newer Ubuntu versions.
1627 \item The USB key has writable partitions for modifications to
1628 the OS and for modification to your home directory.
1629 \item You can add new files/directories to the USB key very easily.
1630 \item You can save the environment from multiple machines on
1632 \item Bacula Systems is funding its ongoing development.
1635 The disadvantages are:
1637 \item The USB key is usable but currently under development.
1638 \item Not everyone may be familiar with Ubuntu (no worse
1640 \item Some older OSes cannot be booted from USB. This can
1641 be resolved by first booting a Ubuntu LiveCD then plugging
1643 \item Currently the documentation is sketchy and not yet added
1644 to the main manual. See below ...
1647 The documentation and the code can be found in the {\bf rescue} package
1648 in the directory {\bf linux/usb}.
1650 \section{Miscellaneous}
1651 \index[general]{Misc New Features}
1653 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
1654 \index[general]{Allow Mixed Priority}
1655 This directive is only implemented in version 2.5 and later. When
1656 set to {\bf yes} (default {\bf no}), this job may run even if lower
1657 priority jobs are already running. This means a high priority job
1658 will not have to wait for other jobs to finish before starting.
1659 The scheduler will only mix priorities when all running jobs have
1662 Note that only higher priority jobs will start early. Suppose the
1663 director will allow two concurrent jobs, and that two jobs with
1664 priority 10 are running, with two more in the queue. If a job with
1665 priority 5 is added to the queue, it will be run as soon as one of
1666 the running jobs finishes. However, new priority 10 jobs will not
1667 be run until the priority 5 job has finished.
1669 \subsection{Bootstrap File Directive -- FileRegex}
1670 \index[general]{Bootstrap File Directive}
1671 {\bf FileRegex} is a new command that can be added to the bootstrap
1672 (.bsr) file. The value is a regular expression. When specified, only
1673 matching filenames will be restored.
1675 During a restore, if all File records are pruned from the catalog
1676 for a Job, normally Bacula can restore only all files saved. That
1677 is there is no way using the catalog to select individual files.
1678 With this new feature, Bacula will ask if you want to specify a Regex
1679 expression for extracting only a part of the full backup.
1682 Building directory tree for JobId(s) 1,3 ...
1683 There were no files inserted into the tree, so file selection
1684 is not possible.Most likely your retention policy pruned the files
1686 Do you want to restore all the files? (yes\vb{}no): no
1688 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1689 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1692 \subsection{Bootstrap File Optimization Changes}
1693 In order to permit proper seeking on disk files, we have extended the bootstrap
1694 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1695 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1696 address range and end address range respectively. These two directives replace
1697 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1698 VolEndBlock} directives. Bootstrap files containing the old directives will
1699 still work, but will not properly take advantage of proper disk seeking, and
1700 may read completely to the end of a disk volume during a restore. With the new
1701 format (automatically generated by the new Director), restores will seek
1702 properly and stop reading the volume when all the files have been restored.
1704 \subsection{Solaris ZFS/NFSv4 ACLs}
1705 This is an upgrade of the previous Solaris ACL backup code
1706 to the new library format, which will backup both the old
1707 POSIX(UFS) ACLs as well as the ZFS ACLs.
1709 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1710 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1711 be used to transfer from UFS to ZFS filesystems.
1714 \subsection{Virtual Tape Emulation}
1715 \index[general]{Virtual Tape Emulation}
1716 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1717 the tape code but actually reading and writing to a disk file. Used with the
1718 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1719 and 700 slots. This feature is most useful in testing. It is enabled
1720 by using {\bf Device Type = vtape} in the Storage daemon's Device
1721 directive. This feature is only implemented on Linux machines and should not be
1722 used for production.
1724 \subsection{Bat Enhancements}
1725 \index[general]{Bat Enhancements}
1726 Bat (the Bacula Administration Tool) GUI program has been significantly
1727 enhanced and stabilized. In particular, there are new table based status
1728 commands; it can now be easily localized using Qt4 Linguist.
1730 The Bat communications protocol has been significantly enhanced to improve
1731 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1732 the Director you are using otherwise the communications protocol will not
1735 \subsection{RunScript Enhancements}
1736 \index[general]{RunScript Enhancements}
1737 The {\bf RunScript} resource has been enhanced to permit multiple
1738 commands per RunScript. Simply specify multiple {\bf Command} directives
1745 Command = "/bin/echo test"
1746 Command = "/bin/echo an other test"
1747 Command = "/bin/echo 3 commands in the same runscript"
1754 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1755 implemented, which runs the command after the Volume Shadow Copy has been made.
1757 Console commands can be specified within a RunScript by using:
1758 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1759 carefully tested and debugged and is known to easily crash the Director.
1760 We would appreciate feedback. Due to the recursive nature of this command, we
1761 may remove it before the final release.
1763 \subsection{Status Enhancements}
1764 \index[general]{Status Enhancements}
1765 The bconsole {\bf status dir} output has been enhanced to indicate
1766 Storage daemon job spooling and despooling activity.
1768 \subsection{Connect Timeout}
1769 \index[general]{Connect Timeout}
1770 The default connect timeout to the File
1771 daemon has been set to 3 minutes. Previously it was 30 minutes.
1773 \subsection{ftruncate for NFS Volumes}
1774 \index[general]{ftruncate for NFS Volumes}
1775 If you write to a Volume mounted by NFS (say on a local file server),
1776 in previous Bacula versions, when the Volume was recycled, it was not
1777 properly truncated because NFS does not implement ftruncate (file
1778 truncate). This is now corrected in the new version because we have
1779 written code (actually a kind user) that deletes and recreates the Volume,
1780 thus accomplishing the same thing as a truncate.
1782 \subsection{Support for Ubuntu}
1783 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1784 version of Linux, and thus now provides correct autostart routines.
1785 Since Ubuntu officially supports Bacula, you can also obtain any
1786 recent release of Bacula from the Ubuntu repositories.
1788 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1789 \index[general]{Recycle Pool}
1790 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1791 be placed (moved) when it is recycled. Without this directive, a Volume will
1792 remain in the same pool when it is recycled. With this directive, it can be
1793 moved automatically to any existing pool during a recycle. This directive is
1794 probably most useful when defined in the Scratch pool, so that volumes will
1795 be recycled back into the Scratch pool.
1797 \subsection{FD Version}
1798 \index[general]{FD Version}
1799 The File daemon to Director protocol now includes a version
1800 number, which although there is no visible change for users,
1801 will help us in future versions automatically determine
1802 if a File daemon is not compatible.
1804 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1805 \index[general]{Max Run Sched Time}
1806 The time specifies the maximum allowed time that a job may run, counted from
1807 when the job was scheduled. This can be useful to prevent jobs from running
1808 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1811 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1812 \index[general]{Max Wait Time}
1813 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1814 of checking the maximum allowed time that a job may block for a resource,
1815 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1816 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1817 their job depending on the level. Now, they have to use
1818 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1819 directives are now deprecated.
1821 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1822 \index[general]{Incremental Max Wait Time}
1823 \index[general]{Differential Max Wait Time}
1825 These directives have been deprecated in favor of
1826 \texttt{Incremental|Differential Max Run Time}.
1828 \subsection{Max Run Time directives}
1829 \index[general]{Max Run Time directives}
1830 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1831 maximum allowed time that a job can run depending on the level.
1833 \addcontentsline{lof}{figure}{Job time control directives}
1834 \includegraphics{\idir different_time.eps}
1836 \subsection{Statistics Enhancements}
1837 \index[general]{Statistics Enhancements}
1838 If you (or probably your boss) want to have statistics on your backups to
1839 provide some \textit{Service Level Agreement} indicators, you could use a few
1840 SQL queries on the Job table to report how many:
1844 \item jobs have been successful
1845 \item files have been backed up
1849 However, these statistics are accurate only if your job retention is greater
1850 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1851 be able to use them.
1853 Now, you can use the \textbf{update stats [days=num]} console command to fill
1854 the JobHistory table with new Job records. If you want to be sure to take in
1855 account only \textbf{good jobs}, ie if one of your important job has failed but
1856 you have fixed the problem and restarted it on time, you probably want to
1857 delete the first \textit{bad} job record and keep only the successful one. For
1858 that simply let your staff do the job, and update JobHistory table after two or
1859 three days depending on your organization using the \textbf{[days=num]} option.
1861 These statistics records aren't used for restoring, but mainly for
1862 capacity planning, billings, etc.
1864 The Bweb interface provides a statistics module that can use this feature. You
1865 can also use tools like Talend or extract information by yourself.
1867 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1868 the length of time that Bacula will keep statistics job records in the Catalog
1869 database after the Job End time. (In \texttt{JobHistory} table) When this time
1870 period expires, and if user runs \texttt{prune stats} command, Bacula will
1871 prune (remove) Job records that are older than the specified period.
1873 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1874 job to maintain statistics.
1877 Name = BackupCatalog
1880 Console = "update stats days=3"
1881 Console = "prune stats yes"
1888 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1889 \index[general]{ScratchPool}
1890 This directive permits to specify a specific \textsl{Scratch} pool for the
1891 current pool. This is useful when using multiple storage sharing the same
1892 mediatype or when you want to dedicate volumes to a particular set of pool.
1894 \subsection{Enhanced Attribute Despooling}
1895 \index[general]{Attribute Despooling}
1896 If the storage daemon and the Director are on the same machine, the spool file
1897 that contains attributes is read directly by the Director instead of being
1898 transmitted across the network. That should reduce load and speedup insertion.
1900 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1901 \index[general]{SpoolSize}
1902 A new Job directive permits to specify the spool size per job. This is used
1903 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1905 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1906 \index[general]{MaxConsoleConnections}
1907 A new director directive permits to specify the maximum number of Console
1908 Connections that could run concurrently. The default is set to 20, but you may
1909 set it to a larger number.
1911 \subsection{VerId = \lt{}string\gt{}}
1912 \index[general]{VerId}
1913 A new director directive permits to specify a personnal identifier that will be
1914 displayed in the \texttt{version} command.
1916 \subsection{dbcheck enhancements}
1917 \index[general]{dbcheck enhancements}
1918 If you are using Mysql, dbcheck will now ask you if you want to create
1919 temporary indexes to speed up orphaned Path and Filename elimination.
1921 A new \texttt{-B} option allows you to print catalog information in a simple
1922 text based format. This is useful to backup it in a secure way.
1937 You can now specify the database connection port in the command line.
1939 \subsection{{-}{-}docdir configure option}
1940 \index[general]{{-}{-}docdir configure option}
1941 You can use {-}{-}docdir= on the ./configure command to
1942 specify the directory where you want Bacula to install the
1943 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
1944 {\bf /usr/share/doc/bacula}.
1946 \subsection{{-}{-}htmldir configure option}
1947 \index[general]{{-}{-}htmldir configure option}
1948 You can use {-}{-}htmldir= on the ./configure command to
1949 specify the directory where you want Bacula to install the bat html help
1950 files. The default is {\bf /usr/share/doc/bacula/html}
1952 \subsection{{-}{-}with-plugindir configure option}
1953 \index[general]{{-}{-}plugindir configure option}
1954 You can use {-}{-}plugindir= on the ./configure command to
1955 specify the directory where you want Bacula to install
1956 the plugins (currently only bpipe-fd). The default is