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.0.3 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{.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
176 \item \texttt{.lsdirs jobid=x,y,z path=/path | pathid=101} This command will
177 list all directories in the specified \texttt{path} or \texttt{pathid}. Using
178 \texttt{pathid} avoids problems with caracters encoding.
179 \item \texttt{.lsfiles jobid=x,y,z path=/path | pathid=101} This command will
180 list all files in the specified \texttt{path} or \texttt{pathid}. Using
181 \texttt{pathid} avoids problems with caracters encoding.
184 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
185 data that will be displayed.
190 * .lsdir path=/ jobid=1,2
193 \section{Testing your tape drive}
194 \label{sec:btapespeed}
196 To determine the best configuration of your tape drive, you can run the new
197 \texttt{speed} command available in \texttt{btape}.
199 This command can have the following arguments:
201 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
202 (between 1 and 5GB). This counter is in GB.
203 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
204 of data should be greater than your memory ($file\_size*nb\_file$).
205 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
207 \item[\texttt{skip\_random}] This flag permits to skip tests with random
209 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
210 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
215 *speed file_size=3 skip_raw
216 btape.c:1078 Test with zero data and bacula block structure.
217 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
218 ++++++++++++++++++++++++++++++++++++++++++
219 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
220 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
222 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
224 btape.c:1090 Test with random data, should give the minimum throughput.
225 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
226 +++++++++++++++++++++++++++++++++++++++++++
227 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
228 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
229 +++++++++++++++++++++++++++++++++++++++++++
231 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
235 When using compression, the random test will give your the minimum throughput
236 of your drive . The test using constant string will give you the maximum speed
237 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
239 You can change the block size in the Storage Daemon configuration file.
241 \section{New {\bf Block Checksum} Device directive}
242 You may now turn off the Block Checksum (CRC32) code
243 that Bacula uses when writing blocks to a Volume. This is
250 doing so can reduce the Storage daemon CPU speed slightly. It
251 will also permit Bacula to read a Volume that has corrupted data.
253 The default is {\bf yes} -- i.e. the checksum is computed on write
256 We do not recommend to turn this off particularly on older tape
257 drives or for disk Volumes where doing so may allow corrupted data
260 \section{New Bat Features}
262 \subsection{Media information view}
264 By double-clicking on a volume (on the Media list, in the Autochanger content
265 or in the Job information panel), you can access a detailed overview of your
266 Volume. (cf \ref{fig:mediainfo}.)
269 \includegraphics[width=13cm]{\idir bat11.eps}
270 \caption{Media information}
271 \label{fig:mediainfo}
274 \subsection{Job information view}
276 By double-clicking on a Job record (on the Job run list or in the Media
277 information panel), you can access a detailed overview of your Job. (cf
281 \includegraphics[width=13cm]{\idir bat12.eps}
282 \caption{Job information}
286 \subsection{Autochanger content view}
288 By double-clicking on a Storage record (on the Storage list panel), you can
289 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
292 \includegraphics[width=13cm]{\idir bat13.eps}
293 \caption{Autochanger content}
294 \label{fig:achcontent}
297 \chapter{New Features in Released Version 3.0.2}
299 This chapter presents the new features added to the
300 Released Bacula Version 3.0.2.
302 \section{Full restore from a given JobId}
303 \index[general]{Restore menu}
305 This feature allows selecting a single JobId and having Bacula
306 automatically select all the other jobs that comprise a full backup up to
307 and including the selected JobId.
309 Assume we start with the following jobs:
311 +-------+--------------+---------------------+-------+----------+------------+
312 | jobid | client | starttime | level | jobfiles | jobbytes |
313 +-------+--------------+---------------------+-------+----------+------------
314 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
315 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
316 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
317 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
318 +-------+--------------+---------------------+-------+----------+------------+
321 Below is an example of this new feature (which is number 12 in the
326 To select the JobIds, you have the following choices:
327 1: List last 20 Jobs run
328 2: List Jobs where a given File is saved
330 12: Select full restore to a specified JobId
333 Select item: (1-13): 12
334 Enter JobId to restore: 5
335 You have selected the following JobIds: 1,3,5
337 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
338 1,444 files inserted into the tree.
341 This project was funded by Bacula Systems.
343 \section{Source Address}
344 \index[general]{Source Address}
346 A feature has been added which allows the administrator to specify the address
347 from which the Director and File daemons will establish connections. This
348 may be used to simplify system configuration overhead when working in complex
349 networks utilizing multi-homing and policy-routing.
351 To accomplish this, two new configuration directives have been implemented:
354 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
358 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
362 Simply adding specific host routes on the OS
363 would have an undesirable side-effect: any
364 application trying to contact the destination host would be forced to use the
365 more specific route possibly diverting management traffic onto a backup VLAN.
366 Instead of adding host routes for each client connected to a multi-homed backup
367 server (for example where there are management and backup VLANs), one can
368 use the new directives to specify a specific source address at the application
371 Additionally, this allows the simplification and abstraction of firewall rules
372 when dealing with a Hot-Standby director or storage daemon configuration. The
373 Hot-standby pair may share a CARP address, which connections must be sourced
374 from, while system services listen and act from the unique interface addresses.
376 This project was funded by Collaborative Fusion, Inc.
378 \section{Show volume availability when doing restore}
380 When doing a restore the selection dialog ends by displaying this
384 The job will require the following
385 Volume(s) Storage(s) SD Device(s)
386 ===========================================================================
397 Volumes marked with ``*'' are online (in the autochanger).
400 This should help speed up large restores by minimizing the time spent
401 waiting for the operator to discover that he must change tapes in the library.
403 This project was funded by Bacula Systems.
405 \section{Accurate estimate command}
407 The \texttt{estimate} command can now use the accurate code to detect changes
408 and give a better estimation.
410 You can set the accurate behavior on the command line by using
411 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
414 * estimate listing accurate=yes level=incremental job=BackupJob
417 This project was funded by Bacula Systems.
419 \chapter{New Features in 3.0.0}
420 \label{NewFeaturesChapter}
421 \index[general]{New Features}
423 This chapter presents the new features added to the development 2.5.x
424 versions to be released as Bacula version 3.0.0 sometime in April 2009.
426 \section{Accurate Backup}
427 \index[general]{Accurate Backup}
429 As with most other backup programs, by default Bacula decides what files to
430 backup for Incremental and Differental backup by comparing the change
431 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
432 backup completed. If one of those two times is later than the last backup
433 time, then the file will be backed up. This does not, however, permit tracking
434 what files have been deleted and will miss any file with an old time that may
435 have been restored to or moved onto the client filesystem.
437 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
438 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
439 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
440 backup, there is no difference, but for {\bf Differential} and {\bf
441 Incremental} backups, the Director will send a list of all previous files
442 backed up, and the File daemon will use that list to determine if any new files
443 have been added or or moved and if any files have been deleted. This allows
444 Bacula to make an accurate backup of your system to that point in time so that
445 if you do a restore, it will restore your system exactly.
448 about using Accurate backup is that it requires more resources (CPU and memory)
449 on both the Director and the Client machines to create the list of previous
450 files backed up, to send that list to the File daemon, for the File daemon to
451 keep the list (possibly very big) in memory, and for the File daemon to do
452 comparisons between every file in the FileSet and the list. In particular,
453 if your client has lots of files (more than a few million), you will need
454 lots of memory on the client machine.
456 Accurate must not be enabled when backing up with a plugin that is not
457 specially designed to work with Accurate. If you enable it, your restores
458 will probably not work correctly.
460 This project was funded by Bacula Systems.
465 \index[general]{Copy Jobs}
467 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
468 existing Migration feature with the exception that the Job that is copied is
469 left unchanged. This essentially creates two identical copies of the same
470 backup. However, the copy is treated as a copy rather than a backup job, and
471 hence is not directly available for restore. The {\bf restore} command lists
472 copy jobs and allows selection of copies by using \texttt{jobid=}
473 option. If the keyword {\bf copies} is present on the command line, Bacula will
474 display the list of all copies for selected jobs.
479 These JobIds have copies as follows:
480 +-------+------------------------------------+-----------+------------------+
481 | JobId | Job | CopyJobId | MediaType |
482 +-------+------------------------------------+-----------+------------------+
483 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
484 +-------+------------------------------------+-----------+------------------+
485 +-------+-------+----------+----------+---------------------+------------------+
486 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
487 +-------+-------+----------+----------+---------------------+------------------+
488 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
489 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
490 +-------+-------+----------+----------+---------------------+------------------+
491 You have selected the following JobIds: 19,2
493 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
494 5,611 files inserted into the tree.
499 The Copy Job runs without using the File daemon by copying the data from the
500 old backup Volume to a different Volume in a different Pool. See the Migration
501 documentation for additional details. For copy Jobs there is a new selection
502 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
503 not already copied to another Pool.
505 As with Migration, the Client, Volume, Job, or SQL query, are
506 other possible ways of selecting the Jobs to be copied. Selection
507 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
508 work, but are probably more suited for Migration Jobs.
510 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
511 it will promote the Copy to a \textsl{real} backup job and will make it available for
512 automatic restore. If more than one Copy is available, it will promote the copy
513 with the smallest JobId.
515 A nice solution which can be built with the new Copy feature is often
516 called disk-to-disk-to-tape backup (DTDTT). A sample config could
517 look something like the one below:
521 Name = FullBackupsVirtualPool
523 Purge Oldest Volume = Yes
525 NextPool = FullBackupsTapePool
529 Name = FullBackupsTapePool
533 Volume Retention = 365 days
534 Storage = superloader
538 # Fake fileset for copy jobs
550 # Fake client for copy jobs
560 # Default template for a CopyDiskToTape Job
563 Name = CopyDiskToTape
565 Messages = StandardCopy
568 Selection Type = PoolUncopiedJobs
569 Maximum Concurrent Jobs = 10
571 Allow Duplicate Jobs = Yes
572 Allow Higher Duplicates = No
573 Cancel Queued Duplicates = No
574 Cancel Running Duplicates = No
579 Name = DaySchedule7:00
580 Run = Level=Full daily at 7:00
584 Name = CopyDiskToTapeFullBackups
586 Schedule = DaySchedule7:00
587 Pool = FullBackupsVirtualPool
588 JobDefs = CopyDiskToTape
592 The example above had 2 pool which are copied using the PoolUncopiedJobs
593 selection criteria. Normal Full backups go to the Virtual pool and are copied
594 to the Tape pool the next morning.
596 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
601 +-------+------------------------------------+-----------+------------------+
602 | JobId | Job | CopyJobId | MediaType |
603 +-------+------------------------------------+-----------+------------------+
604 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
605 +-------+------------------------------------+-----------+------------------+
608 \section{ACL Updates}
609 \index[general]{ACL Updates}
610 The whole ACL code had been overhauled and in this version each platforms has
611 different streams for each type of acl available on such an platform. As ACLs
612 between platforms tend to be not that portable (most implement POSIX acls but
613 some use an other draft or a completely different format) we currently only
614 allow certain platform specific ACL streams to be decoded and restored on the
615 same platform that they were created on. The old code allowed to restore ACL
616 cross platform but the comments already mention that not being to wise. For
617 backward compatability the new code will accept the two old ACL streams and
618 handle those with the platform specific handler. But for all new backups it
619 will save the ACLs using the new streams.
621 Currently the following platforms support ACLs:
625 \item {\bf Darwin/OSX}
634 Currently we support the following ACL types (these ACL streams use a reserved
635 part of the stream numbers):
638 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
640 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
641 string representation from acl\_to\_text (POSIX acl)
642 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
643 string representation from acl\_to\_text (POSIX acl) for default acls.
644 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
645 string representation from acl\_to\_text (POSIX acl) for access acls.
646 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
647 string representation from acltostr (POSIX acl)
648 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
649 representation from acl\_to\_text (POSIX acl) for default acls.
650 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
651 representation from acl\_to\_text (POSIX acl) for access acls.
652 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
653 string representation from acl\_to\_text (POSIX acl) for default acls.
654 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
655 representation from acl\_to\_text (POSIX acl) for access acls.
656 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
657 string representation from acl\_to\_text (POSIX acl) for default acls.
658 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
659 string representation from acl\_to\_text (POSIX acl) for default acls.
660 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
661 representation from acl\_to\_text (POSIX acl) for access acls.
662 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
663 string representation from acltotext or acl\_totext (POSIX acl)
664 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
665 representation from from acl\_totext (NFSv4 or ZFS acl)
668 In future versions we might support conversion functions from one type of acl
669 into an other for types that are either the same or easily convertable. For now
670 the streams are seperate and restoring them on a platform that doesn't
671 recognize them will give you a warning.
673 \section{Extended Attributes}
674 \index[general]{Extended Attributes}
675 Something that was on the project list for some time is now implemented for
676 platforms that support a similar kind of interface. Its the support for backup
677 and restore of so called extended attributes. As extended attributes are so
678 platform specific these attributes are saved in seperate streams for each
679 platform. Restores of the extended attributes can only be performed on the
680 same platform the backup was done. There is support for all types of extended
681 attributes, but restoring from one type of filesystem onto an other type of
682 filesystem on the same platform may lead to supprises. As extended attributes
683 can contain any type of data they are stored as a series of so called
684 value-pairs. This data must be seen as mostly binary and is stored as such.
685 As security labels from selinux are also extended attributes this option also
686 stores those labels and no specific code is enabled for handling selinux
689 Currently the following platforms support extended attributes:
691 \item {\bf Darwin/OSX}
697 On linux acls are also extended attributes, as such when you enable ACLs on a
698 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
699 and not the same exteneded attribute.
701 To enable the backup of extended attributes please add the following to your
716 \section{Shared objects}
717 \index[general]{Shared objects}
718 A default build of Bacula will now create the libraries as shared objects
719 (.so) rather than static libraries as was previously the case.
720 The shared libraries are built using {\bf libtool} so it should be quite
723 An important advantage of using shared objects is that on a machine with the
724 Directory, File daemon, the Storage daemon, and a console, you will have only
725 one copy of the code in memory rather than four copies. Also the total size of
726 the binary release is smaller since the library code appears only once rather
727 than once for every program that uses it; this results in significant reduction
728 in the size of the binaries particularly for the utility tools.
730 In order for the system loader to find the shared objects when loading the
731 Bacula binaries, the Bacula shared objects must either be in a shared object
732 directory known to the loader (typically /usr/lib) or they must be in the
733 directory that may be specified on the {\bf ./configure} line using the {\bf
734 {-}{-}libdir} option as:
737 ./configure --libdir=/full-path/dir
740 the default is /usr/lib. If {-}{-}libdir is specified, there should be
741 no need to modify your loader configuration provided that
742 the shared objects are installed in that directory (Bacula
743 does this with the make install command). The shared objects
744 that Bacula references are:
753 These files are symbolically linked to the real shared object file,
754 which has a version number to permit running multiple versions of
755 the libraries if desired (not normally the case).
757 If you have problems with libtool or you wish to use the old
758 way of building static libraries, or you want to build a static
759 version of Bacula you may disable
760 libtool on the configure command line with:
763 ./configure --disable-libtool
767 \section{Building Static versions of Bacula}
768 \index[general]{Static linking}
769 In order to build static versions of Bacula, in addition
770 to configuration options that were needed you now must
771 also add --disable-libtool. Example
774 ./configure --enable-static-client-only --disable-libtool
778 \section{Virtual Backup (Vbackup)}
779 \index[general]{Virtual Backup}
780 \index[general]{Vbackup}
782 Bacula's virtual backup feature is often called Synthetic Backup or
783 Consolidation in other backup products. It permits you to consolidate the
784 previous Full backup plus the most recent Differential backup and any
785 subsequent Incremental backups into a new Full backup. This new Full
786 backup will then be considered as the most recent Full for any future
787 Incremental or Differential backups. The VirtualFull backup is
788 accomplished without contacting the client by reading the previous backup
789 data and writing it to a volume in a different pool.
791 In some respects the Vbackup feature works similar to a Migration job, in
792 that Bacula normally reads the data from the pool specified in the
793 Job resource, and writes it to the {\bf Next Pool} specified in the
794 Job resource. Note, this means that usually the output from the Virtual
795 Backup is written into a different pool from where your prior backups
796 are saved. Doing it this way guarantees that you will not get a deadlock
797 situation attempting to read and write to the same volume in the Storage
798 daemon. If you then want to do subsequent backups, you may need to
799 move the Virtual Full Volume back to your normal backup pool.
800 Alternatively, you can set your {\bf Next Pool} to point to the current
801 pool. This will cause Bacula to read and write to Volumes in the
802 current pool. In general, this will work, because Bacula will
803 not allow reading and writing on the same Volume. In any case, once
804 a VirtualFull has been created, and a restore is done involving the
805 most current Full, it will read the Volume or Volumes by the VirtualFull
806 regardless of in which Pool the Volume is found.
808 The Vbackup is enabled on a Job by Job in the Job resource by specifying
809 a level of {\bf VirtualFull}.
811 A typical Job resource definition might look like the following:
825 # Default pool definition
829 Recycle = yes # Automatically recycle Volumes
830 AutoPrune = yes # Prune expired volumes
831 Volume Retention = 365d # one year
839 Recycle = yes # Automatically recycle Volumes
840 AutoPrune = yes # Prune expired volumes
841 Volume Retention = 365d # one year
842 Storage = DiskChanger
845 # Definition of file storage device
852 Maximum Concurrent Jobs = 5
855 # Definition of DDS Virtual tape disk storage device
858 Address = localhost # N.B. Use a fully qualified name here
861 Media Type = DiskChangerMedia
862 Maximum Concurrent Jobs = 4
867 Then in bconsole or via a Run schedule, you would run the job as:
870 run job=MyBackup level=Full
871 run job=MyBackup level=Incremental
872 run job=MyBackup level=Differential
873 run job=MyBackup level=Incremental
874 run job=MyBackup level=Incremental
877 So providing there were changes between each of those jobs, you would end up
878 with a Full backup, a Differential, which includes the first Incremental
879 backup, then two Incremental backups. All the above jobs would be written to
880 the {\bf Default} pool.
882 To consolidate those backups into a new Full backup, you would run the
886 run job=MyBackup level=VirtualFull
889 And it would produce a new Full backup without using the client, and the output
890 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
892 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
895 Note, the Start and End time of the Virtual Full backup is set to the
896 values for the last job included in the Virtual Full (in the above example,
897 it is an Increment). This is so that if another incremental is done, which
898 will be based on the Virtual Full, it will backup all files from the
899 last Job included in the Virtual Full rather than from the time the Virtual
900 Full was actually run.
904 \section{Catalog Format}
905 \index[general]{Catalog Format}
906 Bacula 3.0 comes with some changes to the catalog format. The upgrade
907 operation will convert the FileId field of the File table from 32 bits (max 4
908 billion table entries) to 64 bits (very large number of items). The
909 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
910 your catalog during the conversion. Also you won't be able to run jobs during
911 this conversion period. For example, a 3 million file catalog will take 2
912 minutes to upgrade on a normal machine. Please don't forget to make a valid
913 backup of your database before executing the upgrade script. See the
914 ReleaseNotes for additional details.
916 \section{64 bit Windows Client}
917 \index[general]{Win64 Client}
918 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
919 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
920 As a consequence, we are also releasing a 64 bit version of the Bacula
921 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
922 These binaries should only be installed on 64 bit Windows operating systems.
923 What is important is not your hardware but whether or not you have
924 a 64 bit version of the Windows OS.
926 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
928 \item Before installing the Win64 Bacula Client, you must totally
929 deinstall any prior 2.4.x Client installation using the
930 Bacula deinstallation (see the menu item). You may want
931 to save your .conf files first.
932 \item Only the Client (File daemon) is ported to Win64, the Director
933 and the Storage daemon are not in the 64 bit Windows installer.
934 \item bwx-console is not yet ported.
935 \item bconsole is ported but it has not been tested.
936 \item The documentation is not included in the installer.
937 \item Due to Vista security restrictions imposed on a default installation
938 of Vista, before upgrading the Client, you must manually stop
939 any prior version of Bacula from running, otherwise the install
941 \item Due to Vista security restrictions imposed on a default installation
942 of Vista, attempting to edit the conf files via the menu items
943 will fail. You must directly edit the files with appropriate
944 permissions. Generally double clicking on the appropriate .conf
945 file will work providing you have sufficient permissions.
946 \item All Bacula files are now installed in
947 {\bf C:/Program Files/Bacula} except the main menu items,
948 which are installed as before. This vastly simplifies the installation.
949 \item If you are running on a foreign language version of Windows, most
950 likely {\bf C:/Program Files} does not exist, so you should use the
951 Custom installation and enter an appropriate location to install
953 \item The 3.0.0 Win32 Client continues to install files in the locations used
954 by prior versions. For the next version we will convert it to use
955 the same installation conventions as the Win64 version.
958 This project was funded by Bacula Systems.
961 \section{Duplicate Job Control}
962 \index[general]{Duplicate Jobs}
963 The new version of Bacula provides four new directives that
964 give additional control over what Bacula does if duplicate jobs
965 are started. A duplicate job in the sense we use it here means
966 a second or subsequent job with the same name starts. This
967 happens most frequently when the first job runs longer than expected because no
970 The four directives each take as an argument a {\bf yes} or {\bf no} value and
971 are specified in the Job resource.
975 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
976 \index[general]{Allow Duplicate Jobs}
977 If this directive is enabled duplicate jobs will be run. If
978 the directive is set to {\bf no} (default) then only one job of a given name
979 may run at one time, and the action that Bacula takes to ensure only
980 one job runs is determined by the other directives (see below).
982 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
983 are present and none of the three directives given below permit
984 cancelling a job, then the current job (the second one started)
988 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
989 \index[general]{Allow Higher Duplicates}
990 If this directive is set to {\bf yes} (default) the job with a higher
991 priority (lower priority number) will be permitted to run, and
992 the current job will be cancelled. If the
993 priorities of the two jobs are the same, the outcome is determined by
994 other directives (see below).
996 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
997 \index[general]{Cancel Queued Duplicates}
998 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
999 if this directive is set to {\bf yes} any job that is
1000 already queued to run but not yet running will be canceled.
1001 The default is {\bf no}.
1003 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1004 \index[general]{Cancel Running Duplicates}
1005 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1006 if this directive is set to {\bf yes} any job that is already running
1007 will be canceled. The default is {\bf no}.
1010 \section{TLS Authentication}
1011 \index[general]{TLS Authentication}
1012 In Bacula version 2.5.x and later, in addition to the normal Bacula
1013 CRAM-MD5 authentication that is used to authenticate each Bacula
1014 connection, you can specify that you want TLS Authentication as well,
1015 which will provide more secure authentication.
1017 This new feature uses Bacula's existing TLS code (normally used for
1018 communications encryption) to do authentication. To use it, you must
1019 specify all the TLS directives normally used to enable communications
1020 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1023 \subsection{TLS Authenticate = yes}
1025 TLS Authenticate = yes
1028 in the main daemon configuration resource (Director for the Director,
1029 Client for the File daemon, and Storage for the Storage daemon).
1031 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1032 authentication, Bacula will also do TLS authentication, then TLS
1033 encryption will be turned off, and the rest of the communication between
1034 the two Bacula daemons will be done without encryption.
1036 If you want to encrypt communications data, use the normal TLS directives
1037 but do not turn on {\bf TLS Authenticate}.
1039 \section{bextract non-portable Win32 data}
1040 \index[general]{bextract handles Win32 non-portable data}
1041 {\bf bextract} has been enhanced to be able to restore
1042 non-portable Win32 data to any OS. Previous versions were
1043 unable to restore non-portable Win32 data to machines that
1044 did not have the Win32 BackupRead and BackupWrite API calls.
1046 \section{State File updated at Job Termination}
1047 \index[general]{State File}
1048 In previous versions of Bacula, the state file, which provides a
1049 summary of previous jobs run in the {\bf status} command output was
1050 updated only when Bacula terminated, thus if the daemon crashed, the
1051 state file might not contain all the run data. This version of
1052 the Bacula daemons updates the state file on each job termination.
1054 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1055 \index[general]{MaxFullInterval}
1056 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1057 can be used to specify the maximum time interval between {\bf Full} backup
1058 jobs. When a job starts, if the time since the last Full backup is
1059 greater than the specified interval, and the job would normally be an
1060 {\bf Incremental} or {\bf Differential}, it will be automatically
1061 upgraded to a {\bf Full} backup.
1063 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1064 \index[general]{MaxDiffInterval}
1065 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1066 can be used to specify the maximum time interval between {\bf Differential} backup
1067 jobs. When a job starts, if the time since the last Differential backup is
1068 greater than the specified interval, and the job would normally be an
1069 {\bf Incremental}, it will be automatically
1070 upgraded to a {\bf Differential} backup.
1072 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1073 \index[general]{MaxDiffInterval}
1074 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1075 by the user, and when it is set it is an indication to backup programs
1076 to not backup that particular file. This version of Bacula contains a
1077 new Options directive within a FileSet resource, which instructs Bacula to
1078 obey this flag. The new directive is:
1081 Honor No Dump Flag = yes\vb{}no
1084 The default value is {\bf no}.
1087 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1088 \index[general]{IgnoreDir}
1089 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1090 can be added to the Include section of the FileSet resource. If the specified
1091 filename ({\bf filename-string}) is found on the Client in any directory to be
1092 backed up, the whole directory will be ignored (not backed up). For example:
1095 # List of files to be backed up
1103 Exclude Dir Containing = .excludeme
1108 But in /home, there may be hundreds of directories of users and some
1109 people want to indicate that they don't want to have certain
1110 directories backed up. For example, with the above FileSet, if
1111 the user or sysadmin creates a file named {\bf .excludeme} in
1112 specific directories, such as
1115 /home/user/www/cache/.excludeme
1116 /home/user/temp/.excludeme
1119 then Bacula will not backup the two directories named:
1122 /home/user/www/cache
1126 NOTE: subdirectories will not be backed up. That is, the directive
1127 applies to the two directories in question and any children (be they
1128 files, directories, etc).
1131 \section{Bacula Plugins}
1132 \index[general]{Plugin}
1133 Support for shared object plugins has been implemented in the Linux, Unix
1134 and Win32 File daemons. The API will be documented separately in
1135 the Developer's Guide or in a new document. For the moment, there is
1136 a single plugin named {\bf bpipe} that allows an external program to
1137 get control to backup and restore a file.
1139 Plugins are also planned (partially implemented) in the Director and the
1142 \subsection{Plugin Directory}
1143 \index[general]{Plugin Directory}
1144 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1145 be added to the daemon definition resource. The directory takes a quoted
1146 string argument, which is the name of the directory in which the daemon can
1147 find the Bacula plugins. If this directive is not specified, Bacula will not
1148 load any plugins. Since each plugin has a distinctive name, all the daemons
1149 can share the same plugin directory.
1151 \subsection{Plugin Options}
1152 \index[general]{Plugin Options}
1153 The {\bf Plugin Options} directive takes a quoted string
1154 arguement (after the equal sign) and may be specified in the
1155 Job resource. The options specified will be passed to all plugins
1156 when they are run. This each plugin must know what it is looking
1157 for. The value defined in the Job resource can be modified
1158 by the user when he runs a Job via the {\bf bconsole} command line
1161 Note: this directive may be specified, and there is code to modify
1162 the string in the run command, but the plugin options are not yet passed to
1163 the plugin (i.e. not fully implemented).
1165 \subsection{Plugin Options ACL}
1166 \index[general]{Plugin Options ACL}
1167 The {\bf Plugin Options ACL} directive may be specified in the
1168 Director's Console resource. It functions as all the other ACL commands
1169 do by permitting users running restricted consoles to specify a
1170 {\bf Plugin Options} that overrides the one specified in the Job
1171 definition. Without this directive restricted consoles may not modify
1174 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1175 \index[general]{Plugin}
1176 The {\bf Plugin} directive is specified in the Include section of
1177 a FileSet resource where you put your {\bf File = xxx} directives.
1188 Plugin = "bpipe:..."
1193 In the above example, when the File daemon is processing the directives
1194 in the Include section, it will first backup all the files in {\bf /home}
1195 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1196 the Plugin Directory. The syntax and semantics of the Plugin directive
1197 require the first part of the string up to the colon (:) to be the name
1198 of the plugin. Everything after the first colon is ignored by the File daemon but
1199 is passed to the plugin. Thus the plugin writer may define the meaning of the
1200 rest of the string as he wishes.
1202 Please see the next section for information about the {\bf bpipe} Bacula
1205 \section{The bpipe Plugin}
1206 \index[general]{The bpipe Plugin}
1207 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1208 the Bacula source distribution. When the plugin is compiled and linking into
1209 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1211 The purpose of the plugin is to provide an interface to any system program for
1212 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1213 the Include section of your Job's FileSet resource. The full syntax of the
1214 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1215 to specify the sytax as it wishes) is:
1218 Plugin = "<field1>:<field2>:<field3>:<field4>"
1223 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1224 stripped off, so in this case, we would put {\bf bpipe} in this field.
1226 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1227 pseudo path and filename under which the backup will be saved. This pseudo
1228 path and filename will be seen by the user in the restore file tree.
1229 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1230 backed up by the plugin will be put under that "pseudo" path and filename.
1231 You must be careful to choose a naming convention that is unique to avoid
1232 a conflict with a path and filename that actually exists on your system.
1234 \item {\bf field3} for the {\bf bpipe} plugin
1235 specifies the "reader" program that is called by the plugin during
1236 backup to read the data. {\bf bpipe} will call this program by doing a
1239 \item {\bf field4} for the {\bf bpipe} plugin
1240 specifies the "writer" program that is called by the plugin during
1241 restore to write the data back to the filesystem.
1244 Putting it all together, the full plugin directive line might look
1248 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1249 --opt --databases bacula:mysql"
1252 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1253 would be written on a single line.
1255 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1256 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1257 program {\bf mysqldump -f --opt --database bacula} to read the data during
1258 backup. The mysqldump command outputs all the data for the database named
1259 {\bf bacula}, which will be read by the plugin and stored in the backup.
1260 During restore, the data that was backed up will be sent to the program
1261 specified in the last field, which in this case is {\bf mysql}. When
1262 {\bf mysql} is called, it will read the data sent to it by the plugn
1263 then write it back to the same database from which it came ({\bf bacula}
1266 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1267 the data from a specified program to Bacula for backup, and then from Bacula to
1268 a specified program for restore.
1270 By using different command lines to {\bf bpipe},
1271 you can backup any kind of data (ASCII or binary) depending
1272 on the program called.
1274 \section{Microsoft Exchange Server 2003/2007 Plugin}
1275 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1276 \subsection{Background}
1277 The Exchange plugin was made possible by a funded development project
1278 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1279 The code for the plugin was written by James Harper, and the Bacula core
1280 code by Kern Sibbald. All the code for this funded development has become
1281 part of the Bacula project. Thanks to everyone who made it happen.
1283 \subsection{Concepts}
1284 Although it is possible to backup Exchange using Bacula VSS the Exchange
1285 plugin adds a good deal of functionality, because while Bacula VSS
1286 completes a full backup (snapshot) of Exchange, it does
1287 not support Incremental or Differential backups, restoring is more
1288 complicated, and a single database restore is not possible.
1290 Microsoft Exchange organises its storage into Storage Groups with
1291 Databases inside them. A default installation of Exchange will have a
1292 single Storage Group called 'First Storage Group', with two Databases
1293 inside it, "Mailbox Store (SERVER NAME)" and
1294 "Public Folder Store (SERVER NAME)",
1295 which hold user email and public folders respectively.
1297 In the default configuration, Exchange logs everything that happens to
1298 log files, such that if you have a backup, and all the log files since,
1299 you can restore to the present time. Each Storage Group has its own set
1300 of log files and operates independently of any other Storage Groups. At
1301 the Storage Group level, the logging can be turned off by enabling a
1302 function called "Enable circular logging". At this time the Exchange
1303 plugin will not function if this option is enabled.
1305 The plugin allows backing up of entire storage groups, and the restoring
1306 of entire storage groups or individual databases. Backing up and
1307 restoring at the individual mailbox or email item is not supported but
1308 can be simulated by use of the "Recovery" Storage Group (see below).
1310 \subsection{Installing}
1311 The Exchange plugin requires a DLL that is shipped with Microsoft
1312 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1313 correctly the Exchange plugin should find this automatically and run
1314 without any additional installation.
1316 If the DLL can not be found automatically it will need to be copied into
1317 the Bacula installation
1318 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1319 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1320 default Exchange installation.
1322 \subsection{Backup up}
1323 To back up an Exchange server the Fileset definition must contain at
1324 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1325 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1326 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1327 up files are prefixed with something that isn't going to share a name
1328 with something outside the plugin, and the 'Microsoft Information Store'
1329 bit is required also. It is also possible to add the name of a storage
1330 group to the "Plugin =" line, eg \\
1331 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1332 if you want only a single storage group backed up.
1334 Additionally, you can suffix the 'Plugin =' directive with
1335 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1336 database at the end of a full backup.
1338 An Incremental or Differential backup will backup only the database logs
1339 for each Storage Group by inspecting the "modified date" on each
1340 physical log file. Because of the way the Exchange API works, the last
1341 logfile backed up on each backup will always be backed up by the next
1342 Incremental or Differential backup too. This adds 5MB to each
1343 Incremental or Differential backup size but otherwise does not cause any
1346 By default, a normal VSS fileset containing all the drive letters will
1347 also back up the Exchange databases using VSS. This will interfere with
1348 the plugin and Exchange's shared ideas of when the last full backup was
1349 done, and may also truncate log files incorrectly. It is important,
1350 therefore, that the Exchange database files be excluded from the backup,
1351 although the folders the files are in should be included, or they will
1352 have to be recreated manually if a baremetal restore is done.
1357 File = C:/Program Files/Exchsrvr/mdbdata
1358 Plugin = "exchange:..."
1361 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1362 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1363 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1364 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1365 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1366 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1367 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1372 The advantage of excluding the above files is that you can significantly
1373 reduce the size of your backup since all the important Exchange files
1374 will be properly saved by the Plugin.
1377 \subsection{Restoring}
1378 The restore operation is much the same as a normal Bacula restore, with
1379 the following provisos:
1382 \item The {\bf Where} restore option must not be specified
1383 \item Each Database directory must be marked as a whole. You cannot just
1384 select (say) the .edb file and not the others.
1385 \item If a Storage Group is restored, the directory of the Storage Group
1387 \item It is possible to restore only a subset of the available log files,
1388 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1389 if a log file is missing from the sequence of log files
1390 \item Each database to be restored must be dismounted and marked as "Can be
1391 overwritten by restore"
1392 \item If an entire Storage Group is to be restored (eg all databases and
1393 logs in the Storage Group), then it is best to manually delete the
1394 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1395 as Exchange can get confused by stray log files lying around.
1398 \subsection{Restoring to the Recovery Storage Group}
1399 The concept of the Recovery Storage Group is well documented by
1401 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1402 but to briefly summarize...
1404 Microsoft Exchange allows the creation of an additional Storage Group
1405 called the Recovery Storage Group, which is used to restore an older
1406 copy of a database (e.g. before a mailbox was deleted) into without
1407 messing with the current live data. This is required as the Standard and
1408 Small Business Server versions of Exchange can not ordinarily have more
1409 than one Storage Group.
1411 To create the Recovery Storage Group, drill down to the Server in Exchange
1412 System Manager, right click, and select
1413 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1414 locations and click OK. On the Recovery Storage Group, right click and
1415 select {\bf "Add Database to Recover..."} and select the database you will
1418 Restore only the single database nominated as the database in the
1419 Recovery Storage Group. Exchange will redirect the restore to the
1420 Recovery Storage Group automatically.
1421 Then run the restore.
1423 \subsection{Restoring on Microsoft Server 2007}
1424 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1425 2007, and henc you use a new proceedure for recovering a single mail box.
1426 This procedure is ducomented by Microsoft at:
1427 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1428 and involves using the {\bf Restore-Mailbox} and {\bf
1429 Get-MailboxStatistics} shell commands.
1431 \subsection{Caveats}
1432 This plugin is still being developed, so you should consider it
1433 currently in BETA test, and thus use in a production environment
1434 should be done only after very careful testing.
1436 When doing a full backup, the Exchange database logs are truncated by
1437 Exchange as soon as the plugin has completed the backup. If the data
1438 never makes it to the backup medium (eg because of spooling) then the
1439 logs will still be truncated, but they will also not have been backed
1440 up. A solution to this is being worked on. You will have to schedule a
1441 new Full backup to ensure that your next backups will be usable.
1443 The "Enable Circular Logging" option cannot be enabled or the plugin
1446 Exchange insists that a successful Full backup must have taken place if
1447 an Incremental or Differential backup is desired, and the plugin will
1448 fail if this is not the case. If a restore is done, Exchange will
1449 require that a Full backup be done before an Incremental or Differential
1452 The plugin will most likely not work well if another backup application
1453 (eg NTBACKUP) is backing up the Exchange database, especially if the
1454 other backup application is truncating the log files.
1456 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1457 we recommend either carefully testing or that you avoid this option for
1460 The Exchange plugin is not called during processing the bconsole {\bf
1461 estimate} command, and so anything that would be backed up by the plugin
1462 will not be added to the estimate total that is displayed.
1465 \section{libdbi Framework}
1466 \index[general]{libdbi Framework}
1467 As a general guideline, Bacula has support for a few catalog database drivers
1468 (MySQL, PostgreSQL, SQLite)
1469 coded natively by the Bacula team. With the libdbi implementation, which is a
1470 Bacula driver that uses libdbi to access the catalog, we have an open field to
1471 use many different kinds database engines following the needs of users.
1473 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1474 implements a database-independent abstraction layer in C, similar to the
1475 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1476 leverage the power of multiple databases and multiple simultaneous database
1477 connections by using this framework.
1479 Currently the libdbi driver in Bacula project only supports the same drivers
1480 natively coded in Bacula. However the libdbi project has support for many
1481 others database engines. You can view the list at
1482 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1483 supported by Bacula, however, they must be tested properly by the Bacula team.
1485 Some of benefits of using libdbi are:
1487 \item The possibility to use proprietary databases engines in which your
1488 proprietary licenses prevent the Bacula team from developing the driver.
1489 \item The possibility to use the drivers written for the libdbi project.
1490 \item The possibility to use other database engines without recompiling Bacula
1491 to use them. Just change one line in bacula-dir.conf
1492 \item Abstract Database access, this is, unique point to code and profiling
1493 catalog database access.
1496 The following drivers have been tested:
1498 \item PostgreSQL, with and without batch insert
1499 \item Mysql, with and without batch insert
1504 In the future, we will test and approve to use others databases engines
1505 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1507 To compile Bacula to support libdbi we need to configure the code with the
1508 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1509 [database] is the database engine to be used with Bacula (of course we can
1510 change the driver in file bacula-dir.conf, see below). We must configure the
1511 access port of the database engine with the option --with-db-port, because the
1512 libdbi framework doesn't know the default access port of each database.
1514 The next phase is checking (or configuring) the bacula-dir.conf, example:
1518 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1519 dbname = regress; user = regress; password = ""
1523 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1524 mysql database. Currently the drivers supported by Bacula are: postgresql,
1525 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1527 The following limitations apply when Bacula is set to use the libdbi framework:
1528 - Not tested on the Win32 platform
1529 - A little performance is lost if comparing with native database driver.
1530 The reason is bound with the database driver provided by libdbi and the
1531 simple fact that one more layer of code was added.
1533 It is important to remember, when compiling Bacula with libdbi, the
1534 following packages are needed:
1536 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1537 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1540 You can download them and compile them on your system or install the packages
1541 from your OS distribution.
1543 \section{Console Command Additions and Enhancements}
1544 \index[general]{Console Additions}
1546 \subsection{Display Autochanger Content}
1547 \index[general]{StatusSlots}
1549 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1550 autochanger content.
1554 Slot | Volume Name | Status | Media Type | Pool |
1555 ------+---------------+----------+-------------------+------------|
1556 1 | 00001 | Append | DiskChangerMedia | Default |
1557 2 | 00002 | Append | DiskChangerMedia | Default |
1558 3*| 00003 | Append | DiskChangerMedia | Scratch |
1563 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1564 {\bf update slots} command to synchronize autochanger content with your
1567 \subsection{list joblog job=xxx or jobid=nnn}
1568 \index[general]{list joblog}
1569 A new list command has been added that allows you to list the contents
1570 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1571 or for a particular JobId. The {\bf llist} command will include a line with
1572 the time and date of the entry.
1574 Note for the catalog to have Job Log entries, you must have a directive
1581 In your Director's {\bf Messages} resource.
1583 \subsection{Use separator for multiple commands}
1584 \index[general]{Command Separator}
1585 When using bconsole with readline, you can set the command separator with
1586 \textbf{@separator} command to one
1587 of those characters to write commands who require multiple input in one line.
1589 !$%&'()*+,-/:;<>?[]^`{|}~
1592 \subsection{Deleting Volumes}
1593 The delete volume bconsole command has been modified to
1594 require an asterisk (*) in front of a MediaId otherwise the
1595 value you enter is a taken to be a Volume name. This is so that
1596 users may delete numeric Volume names. The previous Bacula versions
1597 assumed that all input that started with a number was a MediaId.
1599 This new behavior is indicated in the prompt if you read it
1602 \section{Bare Metal Recovery}
1603 The old bare metal recovery project is essentially dead. One
1604 of the main features of it was that it would build a recovery
1605 CD based on the kernel on your system. The problem was that
1606 every distribution has a different boot procedure and different
1607 scripts, and worse yet, the boot procedures and scripts change
1608 from one distribution to another. This meant that maintaining
1609 (keeping up with the changes) the rescue CD was too much work.
1611 To replace it, a new bare metal recovery USB boot stick has been developed
1612 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1613 boot from a USB key.
1617 \item Recovery can be done from within graphical environment.
1618 \item Recovery can be done in a shell.
1619 \item Ubuntu boots on a large number of Linux systems.
1620 \item The process of updating the system and adding new
1621 packages is not too difficult.
1622 \item The USB key can easily be upgraded to newer Ubuntu versions.
1623 \item The USB key has writable partitions for modifications to
1624 the OS and for modification to your home directory.
1625 \item You can add new files/directories to the USB key very easily.
1626 \item You can save the environment from multiple machines on
1628 \item Bacula Systems is funding its ongoing development.
1631 The disadvantages are:
1633 \item The USB key is usable but currently under development.
1634 \item Not everyone may be familiar with Ubuntu (no worse
1636 \item Some older OSes cannot be booted from USB. This can
1637 be resolved by first booting a Ubuntu LiveCD then plugging
1639 \item Currently the documentation is sketchy and not yet added
1640 to the main manual. See below ...
1643 The documentation and the code can be found in the {\bf rescue} package
1644 in the directory {\bf linux/usb}.
1646 \section{Miscellaneous}
1647 \index[general]{Misc New Features}
1649 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
1650 \index[general]{Allow Mixed Priority}
1651 This directive is only implemented in version 2.5 and later. When
1652 set to {\bf yes} (default {\bf no}), this job may run even if lower
1653 priority jobs are already running. This means a high priority job
1654 will not have to wait for other jobs to finish before starting.
1655 The scheduler will only mix priorities when all running jobs have
1658 Note that only higher priority jobs will start early. Suppose the
1659 director will allow two concurrent jobs, and that two jobs with
1660 priority 10 are running, with two more in the queue. If a job with
1661 priority 5 is added to the queue, it will be run as soon as one of
1662 the running jobs finishes. However, new priority 10 jobs will not
1663 be run until the priority 5 job has finished.
1665 \subsection{Bootstrap File Directive -- FileRegex}
1666 \index[general]{Bootstrap File Directive}
1667 {\bf FileRegex} is a new command that can be added to the bootstrap
1668 (.bsr) file. The value is a regular expression. When specified, only
1669 matching filenames will be restored.
1671 During a restore, if all File records are pruned from the catalog
1672 for a Job, normally Bacula can restore only all files saved. That
1673 is there is no way using the catalog to select individual files.
1674 With this new feature, Bacula will ask if you want to specify a Regex
1675 expression for extracting only a part of the full backup.
1678 Building directory tree for JobId(s) 1,3 ...
1679 There were no files inserted into the tree, so file selection
1680 is not possible.Most likely your retention policy pruned the files
1682 Do you want to restore all the files? (yes\vb{}no): no
1684 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1685 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1688 \subsection{Bootstrap File Optimization Changes}
1689 In order to permit proper seeking on disk files, we have extended the bootstrap
1690 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1691 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1692 address range and end address range respectively. These two directives replace
1693 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1694 VolEndBlock} directives. Bootstrap files containing the old directives will
1695 still work, but will not properly take advantage of proper disk seeking, and
1696 may read completely to the end of a disk volume during a restore. With the new
1697 format (automatically generated by the new Director), restores will seek
1698 properly and stop reading the volume when all the files have been restored.
1700 \subsection{Solaris ZFS/NFSv4 ACLs}
1701 This is an upgrade of the previous Solaris ACL backup code
1702 to the new library format, which will backup both the old
1703 POSIX(UFS) ACLs as well as the ZFS ACLs.
1705 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1706 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1707 be used to transfer from UFS to ZFS filesystems.
1710 \subsection{Virtual Tape Emulation}
1711 \index[general]{Virtual Tape Emulation}
1712 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1713 the tape code but actually reading and writing to a disk file. Used with the
1714 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1715 and 700 slots. This feature is most useful in testing. It is enabled
1716 by using {\bf Device Type = vtape} in the Storage daemon's Device
1717 directive. This feature is only implemented on Linux machines and should not be
1718 used for production.
1720 \subsection{Bat Enhancements}
1721 \index[general]{Bat Enhancements}
1722 Bat (the Bacula Administration Tool) GUI program has been significantly
1723 enhanced and stabilized. In particular, there are new table based status
1724 commands; it can now be easily localized using Qt4 Linguist.
1726 The Bat communications protocol has been significantly enhanced to improve
1727 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1728 the Director you are using otherwise the communications protocol will not
1731 \subsection{RunScript Enhancements}
1732 \index[general]{RunScript Enhancements}
1733 The {\bf RunScript} resource has been enhanced to permit multiple
1734 commands per RunScript. Simply specify multiple {\bf Command} directives
1741 Command = "/bin/echo test"
1742 Command = "/bin/echo an other test"
1743 Command = "/bin/echo 3 commands in the same runscript"
1750 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1751 implemented, which runs the command after the Volume Shadow Copy has been made.
1753 Console commands can be specified within a RunScript by using:
1754 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1755 carefully tested and debugged and is known to easily crash the Director.
1756 We would appreciate feedback. Due to the recursive nature of this command, we
1757 may remove it before the final release.
1759 \subsection{Status Enhancements}
1760 \index[general]{Status Enhancements}
1761 The bconsole {\bf status dir} output has been enhanced to indicate
1762 Storage daemon job spooling and despooling activity.
1764 \subsection{Connect Timeout}
1765 \index[general]{Connect Timeout}
1766 The default connect timeout to the File
1767 daemon has been set to 3 minutes. Previously it was 30 minutes.
1769 \subsection{ftruncate for NFS Volumes}
1770 \index[general]{ftruncate for NFS Volumes}
1771 If you write to a Volume mounted by NFS (say on a local file server),
1772 in previous Bacula versions, when the Volume was recycled, it was not
1773 properly truncated because NFS does not implement ftruncate (file
1774 truncate). This is now corrected in the new version because we have
1775 written code (actually a kind user) that deletes and recreates the Volume,
1776 thus accomplishing the same thing as a truncate.
1778 \subsection{Support for Ubuntu}
1779 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1780 version of Linux, and thus now provides correct autostart routines.
1781 Since Ubuntu officially supports Bacula, you can also obtain any
1782 recent release of Bacula from the Ubuntu repositories.
1784 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1785 \index[general]{Recycle Pool}
1786 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1787 be placed (moved) when it is recycled. Without this directive, a Volume will
1788 remain in the same pool when it is recycled. With this directive, it can be
1789 moved automatically to any existing pool during a recycle. This directive is
1790 probably most useful when defined in the Scratch pool, so that volumes will
1791 be recycled back into the Scratch pool.
1793 \subsection{FD Version}
1794 \index[general]{FD Version}
1795 The File daemon to Director protocol now includes a version
1796 number, which although there is no visible change for users,
1797 will help us in future versions automatically determine
1798 if a File daemon is not compatible.
1800 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1801 \index[general]{Max Run Sched Time}
1802 The time specifies the maximum allowed time that a job may run, counted from
1803 when the job was scheduled. This can be useful to prevent jobs from running
1804 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1807 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1808 \index[general]{Max Wait Time}
1809 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1810 of checking the maximum allowed time that a job may block for a resource,
1811 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1812 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1813 their job depending on the level. Now, they have to use
1814 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1815 directives are now deprecated.
1817 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1818 \index[general]{Incremental Max Wait Time}
1819 \index[general]{Differential Max Wait Time}
1821 These directives have been deprecated in favor of
1822 \texttt{Incremental|Differential Max Run Time}.
1824 \subsection{Max Run Time directives}
1825 \index[general]{Max Run Time directives}
1826 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1827 maximum allowed time that a job can run depending on the level.
1829 \addcontentsline{lof}{figure}{Job time control directives}
1830 \includegraphics{\idir different_time.eps}
1832 \subsection{Statistics Enhancements}
1833 \index[general]{Statistics Enhancements}
1834 If you (or probably your boss) want to have statistics on your backups to
1835 provide some \textit{Service Level Agreement} indicators, you could use a few
1836 SQL queries on the Job table to report how many:
1840 \item jobs have been successful
1841 \item files have been backed up
1845 However, these statistics are accurate only if your job retention is greater
1846 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1847 be able to use them.
1849 Now, you can use the \textbf{update stats [days=num]} console command to fill
1850 the JobHistory table with new Job records. If you want to be sure to take in
1851 account only \textbf{good jobs}, ie if one of your important job has failed but
1852 you have fixed the problem and restarted it on time, you probably want to
1853 delete the first \textit{bad} job record and keep only the successful one. For
1854 that simply let your staff do the job, and update JobHistory table after two or
1855 three days depending on your organization using the \textbf{[days=num]} option.
1857 These statistics records aren't used for restoring, but mainly for
1858 capacity planning, billings, etc.
1860 The Bweb interface provides a statistics module that can use this feature. You
1861 can also use tools like Talend or extract information by yourself.
1863 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1864 the length of time that Bacula will keep statistics job records in the Catalog
1865 database after the Job End time. (In \texttt{JobHistory} table) When this time
1866 period expires, and if user runs \texttt{prune stats} command, Bacula will
1867 prune (remove) Job records that are older than the specified period.
1869 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1870 job to maintain statistics.
1873 Name = BackupCatalog
1876 Console = "update stats days=3"
1877 Console = "prune stats yes"
1884 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1885 \index[general]{ScratchPool}
1886 This directive permits to specify a specific \textsl{Scratch} pool for the
1887 current pool. This is useful when using multiple storage sharing the same
1888 mediatype or when you want to dedicate volumes to a particular set of pool.
1890 \subsection{Enhanced Attribute Despooling}
1891 \index[general]{Attribute Despooling}
1892 If the storage daemon and the Director are on the same machine, the spool file
1893 that contains attributes is read directly by the Director instead of being
1894 transmitted across the network. That should reduce load and speedup insertion.
1896 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1897 \index[general]{SpoolSize}
1898 A new Job directive permits to specify the spool size per job. This is used
1899 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1901 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1902 \index[general]{MaxConsoleConnections}
1903 A new director directive permits to specify the maximum number of Console
1904 Connections that could run concurrently. The default is set to 20, but you may
1905 set it to a larger number.
1907 \subsection{VerId = \lt{}string\gt{}}
1908 \index[general]{VerId}
1909 A new director directive permits to specify a personnal identifier that will be
1910 displayed in the \texttt{version} command.
1912 \subsection{dbcheck enhancements}
1913 \index[general]{dbcheck enhancements}
1914 If you are using Mysql, dbcheck will now ask you if you want to create
1915 temporary indexes to speed up orphaned Path and Filename elimination.
1917 A new \texttt{-B} option allows you to print catalog information in a simple
1918 text based format. This is useful to backup it in a secure way.
1933 You can now specify the database connection port in the command line.
1935 \subsection{{-}{-}docdir configure option}
1936 \index[general]{{-}{-}docdir configure option}
1937 You can use {-}{-}docdir= on the ./configure command to
1938 specify the directory where you want Bacula to install the
1939 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
1940 {\bf /usr/share/doc/bacula}.
1942 \subsection{{-}{-}htmldir configure option}
1943 \index[general]{{-}{-}htmldir configure option}
1944 You can use {-}{-}htmldir= on the ./configure command to
1945 specify the directory where you want Bacula to install the bat html help
1946 files. The default is {\bf /usr/share/doc/bacula/html}
1948 \subsection{{-}{-}with-plugindir configure option}
1949 \index[general]{{-}{-}plugindir configure option}
1950 You can use {-}{-}plugindir= on the ./configure command to
1951 specify the directory where you want Bacula to install
1952 the plugins (currently only bpipe-fd). The default is