5 \chapter{New Features in 3.0.3}
6 \label{NewFeaturesChapter}
8 This chapter presents the new features added to the development 3.0.3
9 versions to be released as Bacula version 3.0.3 sometime in 2009 or early
13 \section{Maximum concurent jobs for Devices}
14 \label{sec:maximumconcurentjobdevice}
16 A new Device directive in the Storage Daemon configuration permits to set the
17 maximum number of Jobs that can run concurrently on specified Device. This
18 directive permits to dispatch jobs on multiple drives, and when this limit is
19 reached, the Storage Daemon will start new jobs on any other available
20 compatible drive. So it's possible to use the same pool on multiple drives like
21 with the broken \textsl{Prefer Mounted Volume} option.
23 \section{Restore from Multiple Storage Daemons}
24 \index[general]{Restore}
26 Previously, you were able to restore from multiple devices in a single Storage
27 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
28 example, if your full backup runs on a Storage Daemon with an autochanger, and
29 your incremental jobs use another Storage Daemon with lots of disks, Bacula
30 will switch automatically from one Storage Daemon to an other within the same
33 You must upgrade your File Daemon to version 3.0.3 to use this feature.
35 This project was funded by Bacula Systems with the help of Equiinet.
37 \section{File Deduplication using Base Jobs}
38 A base job is sort of like a Full save except that you will want the FileSet to
39 contain only files that are unlikely to change in the future (i.e. a snapshot
40 of most of your system after installing it). After the base job has been run,
41 when you are doing a Full save, you specify one or more Base jobs to be used.
42 All files that have been backed up in the Base job/jobs but not modified will
43 then be excluded from the backup. During a restore, the Base jobs will be
44 automatically pulled in where necessary.
46 This is something none of the competition does, as far as we know (except
47 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
48 win for the user, it makes Bacula stand out as offering a unique optimization
49 that immediately saves time and money. Basically, imagine that you have 100
50 nearly identical Windows or Linux machine containing the OS and user files.
51 Now for the OS part, a Base job will be backed up once, and rather than making
52 100 copies of the OS, there will be only one. If one or more of the systems
53 have some files updated, no problem, they will be automatically restored.
55 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
56 files that will be used during Full backup as base.
67 Base = BackupZog4, BackupLinux
73 In this example, the job \texttt{BackupZog4} will use the most recent version
74 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
75 jobs. Base jobs should have run with \texttt{level=Base} to be used.
77 By default, Bacula will compare permissions bits, user and group fields,
78 modification time, size and the checksum of the file to choose between the
79 current backup and the BaseJob file list. You can change this behavior with the
80 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
81 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
98 This project was funded by Bacula Systems.
103 To help developers in restore GUI interfaces, we have added new \textsl{dot
104 commands} that permit to browse the catalog in a very simple way.
107 \item \texttt{.update [jobid=x,y,z]} This command is required to update the
108 Bvfs cache in the catalog. You need to run it before any access to the Bvfs
110 \item \texttt{.lsdirs jobid=x,y,z path=/path | pathid=101} This command will
111 list all directories in the specified \texttt{path} or \texttt{pathid}. Using
112 \texttt{pathid} avoids problems with caracters encoding.
113 \item \texttt{.lsfiles jobid=x,y,z path=/path | pathid=101} This command will
114 list all files in the specified \texttt{path} or \texttt{pathid}. Using
115 \texttt{pathid} avoids problems with caracters encoding.
118 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
119 data that will be displayed.
124 * .lsdir path=/ jobid=1,2
127 \section{Testing your tape drive}
128 \label{sec:btapespeed}
130 To determine the best configuration of your tape drive, you can run the new
131 \texttt{speed} command available in \texttt{btape}.
133 This command can have the following arguments:
135 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
136 (between 1 and 5GB). This counter is in GB.
137 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
138 of data should be greater than your memory ($file\_size*nb\_file$).
139 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
141 \item[\texttt{skip\_random}] This flag permits to skip tests with random
143 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
144 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
149 *speed file_size=3 skip_raw
150 btape.c:1078 Test with zero data and bacula block structure.
151 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
152 ++++++++++++++++++++++++++++++++++++++++++
153 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
154 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
156 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
158 btape.c:1090 Test with random data, should give the minimum throughput.
159 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
160 +++++++++++++++++++++++++++++++++++++++++++
161 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
162 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
163 +++++++++++++++++++++++++++++++++++++++++++
165 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
169 When using compression, the random test will give your the minimum throughput
170 of your drive . The test using constant string will give you the maximum speed
171 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
173 You can change the block size in the Storage Daemon configuration file.
175 \section{New {\bf Block Checksum} Device directive}
176 You may now turn off the Block Checksum (CRC32) code
177 that Bacula uses when writing blocks to a Volume. This is
184 doing so can reduce the Storage daemon CPU speed slightly. It
185 will also permit Bacula to read a Volume that has corrupted data.
187 The default is {\bf yes} -- i.e. the checksum is computed on write
190 We do not recommend to turn this off particularly on older tape
191 drives or for disk Volumes where doing so may allow corrupted data
194 \section{New Bat Features}
196 \subsection{Media information view}
198 By double-clicking on a volume (on the Media list, in the Autochanger content
199 or in the Job information panel), you can access a detailed overview of your
200 Volume. (cf \ref{fig:mediainfo}.)
203 \includegraphics[width=13cm]{\idir bat11.eps}
204 \caption{Media information}
205 \label{fig:mediainfo}
208 \subsection{Job information view}
210 By double-clicking on a Job record (on the Job run list or in the Media
211 information panel), you can access a detailed overview of your Job. (cf
215 \includegraphics[width=13cm]{\idir bat12.eps}
216 \caption{Job information}
220 \subsection{Autochanger content view}
222 By double-clicking on a Storage record (on the Storage list panel), you can
223 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
226 \includegraphics[width=13cm]{\idir bat13.eps}
227 \caption{Autochanger content}
228 \label{fig:achcontent}
231 \chapter{New Features in 3.0.2}
233 This chapter presents the new features added to the development 3.0.2
234 versions to be released as Bacula version 3.0.2 in july 2009.
236 \section{Full restore from a given JobId}
237 \index[general]{Restore menu}
239 This feature allows selecting a single JobId and having Bacula
240 automatically select all the other jobs that comprise a full backup up to
241 and including the selected JobId.
243 Assume we start with the following jobs:
245 +-------+--------------+---------------------+-------+----------+------------+
246 | jobid | client | starttime | level | jobfiles | jobbytes |
247 +-------+--------------+---------------------+-------+----------+------------
248 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
249 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
250 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
251 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
252 +-------+--------------+---------------------+-------+----------+------------+
255 Below is an example of this new feature (which is number 12 in the
260 To select the JobIds, you have the following choices:
261 1: List last 20 Jobs run
262 2: List Jobs where a given File is saved
264 12: Select full restore to a specified JobId
267 Select item: (1-13): 12
268 Enter JobId to restore: 5
269 You have selected the following JobIds: 1,3,5
271 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
272 1,444 files inserted into the tree.
275 This project was funded by Bacula Systems.
277 \section{Source Address}
278 \index[general]{Source Address}
280 A feature has been added which allows the administrator to specify the address
281 from which the Director and File daemons will establish connections. This
282 may be used to simplify system configuration overhead when working in complex
283 networks utilizing multi-homing and policy-routing.
285 To accomplish this, two new configuration directives have been implemented:
288 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
292 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
296 Simply adding specific host routes on the OS
297 would have an undesirable side-effect: any
298 application trying to contact the destination host would be forced to use the
299 more specific route possibly diverting management traffic onto a backup VLAN.
300 Instead of adding host routes for each client connected to a multi-homed backup
301 server (for example where there are management and backup VLANs), one can
302 use the new directives to specify a specific source address at the application
305 Additionally, this allows the simplification and abstraction of firewall rules
306 when dealing with a Hot-Standby director or storage daemon configuration. The
307 Hot-standby pair may share a CARP address, which connections must be sourced
308 from, while system services listen and act from the unique interface addresses.
310 This project was funded by Collaborative Fusion, Inc.
312 \section{Show volume availability when doing restore}
314 When doing a restore the selection dialog ends by displaying this
318 The job will require the following
319 Volume(s) Storage(s) SD Device(s)
320 ===========================================================================
331 Volumes marked with ``*'' are online (in the autochanger).
334 This should help speed up large restores by minimizing the time spent
335 waiting for the operator to discover that he must change tapes in the library.
337 This project was funded by Bacula Systems.
339 \section{Accurate estimate command}
341 The \texttt{estimate} command can now use the accurate code to detect changes
342 and give a better estimation.
344 You can set the accurate behavior on the command line by using
345 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
348 * estimate listing accurate=yes level=incremental job=BackupJob
351 This project was funded by Bacula Systems.
353 \chapter{New Features in 3.0.0}
354 \label{NewFeaturesChapter}
355 \index[general]{New Features}
357 This chapter presents the new features added to the development 2.5.x
358 versions to be released as Bacula version 3.0.0 sometime in April 2009.
360 \section{Accurate Backup}
361 \index[general]{Accurate Backup}
363 As with most other backup programs, by default Bacula decides what files to
364 backup for Incremental and Differental backup by comparing the change
365 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
366 backup completed. If one of those two times is later than the last backup
367 time, then the file will be backed up. This does not, however, permit tracking
368 what files have been deleted and will miss any file with an old time that may
369 have been restored to or moved onto the client filesystem.
371 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
372 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
373 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
374 backup, there is no difference, but for {\bf Differential} and {\bf
375 Incremental} backups, the Director will send a list of all previous files
376 backed up, and the File daemon will use that list to determine if any new files
377 have been added or or moved and if any files have been deleted. This allows
378 Bacula to make an accurate backup of your system to that point in time so that
379 if you do a restore, it will restore your system exactly.
382 about using Accurate backup is that it requires more resources (CPU and memory)
383 on both the Director and the Client machines to create the list of previous
384 files backed up, to send that list to the File daemon, for the File daemon to
385 keep the list (possibly very big) in memory, and for the File daemon to do
386 comparisons between every file in the FileSet and the list. In particular,
387 if your client has lots of files (more than a few million), you will need
388 lots of memory on the client machine.
390 Accurate must not be enabled when backing up with a plugin that is not
391 specially designed to work with Accurate. If you enable it, your restores
392 will probably not work correctly.
394 This project was funded by Bacula Systems.
399 \index[general]{Copy Jobs}
401 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
402 existing Migration feature with the exception that the Job that is copied is
403 left unchanged. This essentially creates two identical copies of the same
404 backup. However, the copy is treated as a copy rather than a backup job, and
405 hence is not directly available for restore. The {\bf restore} command lists
406 copy jobs and allows selection of copies by using \texttt{jobid=}
407 option. If the keyword {\bf copies} is present on the command line, Bacula will
408 display the list of all copies for selected jobs.
413 These JobIds have copies as follows:
414 +-------+------------------------------------+-----------+------------------+
415 | JobId | Job | CopyJobId | MediaType |
416 +-------+------------------------------------+-----------+------------------+
417 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
418 +-------+------------------------------------+-----------+------------------+
419 +-------+-------+----------+----------+---------------------+------------------+
420 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
421 +-------+-------+----------+----------+---------------------+------------------+
422 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
423 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
424 +-------+-------+----------+----------+---------------------+------------------+
425 You have selected the following JobIds: 19,2
427 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
428 5,611 files inserted into the tree.
433 The Copy Job runs without using the File daemon by copying the data from the
434 old backup Volume to a different Volume in a different Pool. See the Migration
435 documentation for additional details. For copy Jobs there is a new selection
436 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
437 not already copied to another Pool.
439 As with Migration, the Client, Volume, Job, or SQL query, are
440 other possible ways of selecting the Jobs to be copied. Selection
441 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
442 work, but are probably more suited for Migration Jobs.
444 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
445 it will promote the Copy to a \textsl{real} backup job and will make it available for
446 automatic restore. If more than one Copy is available, it will promote the copy
447 with the smallest JobId.
449 A nice solution which can be built with the new Copy feature is often
450 called disk-to-disk-to-tape backup (DTDTT). A sample config could
451 look something like the one below:
455 Name = FullBackupsVirtualPool
457 Purge Oldest Volume = Yes
459 NextPool = FullBackupsTapePool
463 Name = FullBackupsTapePool
467 Volume Retention = 365 days
468 Storage = superloader
472 # Fake fileset for copy jobs
484 # Fake client for copy jobs
494 # Default template for a CopyDiskToTape Job
497 Name = CopyDiskToTape
499 Messages = StandardCopy
502 Selection Type = PoolUncopiedJobs
503 Maximum Concurrent Jobs = 10
505 Allow Duplicate Jobs = Yes
506 Allow Higher Duplicates = No
507 Cancel Queued Duplicates = No
508 Cancel Running Duplicates = No
513 Name = DaySchedule7:00
514 Run = Level=Full daily at 7:00
518 Name = CopyDiskToTapeFullBackups
520 Schedule = DaySchedule7:00
521 Pool = FullBackupsVirtualPool
522 JobDefs = CopyDiskToTape
526 The example above had 2 pool which are copied using the PoolUncopiedJobs
527 selection criteria. Normal Full backups go to the Virtual pool and are copied
528 to the Tape pool the next morning.
530 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
535 +-------+------------------------------------+-----------+------------------+
536 | JobId | Job | CopyJobId | MediaType |
537 +-------+------------------------------------+-----------+------------------+
538 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
539 +-------+------------------------------------+-----------+------------------+
542 \section{ACL Updates}
543 \index[general]{ACL Updates}
544 The whole ACL code had been overhauled and in this version each platforms has
545 different streams for each type of acl available on such an platform. As ACLs
546 between platforms tend to be not that portable (most implement POSIX acls but
547 some use an other draft or a completely different format) we currently only
548 allow certain platform specific ACL streams to be decoded and restored on the
549 same platform that they were created on. The old code allowed to restore ACL
550 cross platform but the comments already mention that not being to wise. For
551 backward compatability the new code will accept the two old ACL streams and
552 handle those with the platform specific handler. But for all new backups it
553 will save the ACLs using the new streams.
555 Currently the following platforms support ACLs:
559 \item {\bf Darwin/OSX}
568 Currently we support the following ACL types (these ACL streams use a reserved
569 part of the stream numbers):
572 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
574 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
575 string representation from acl\_to\_text (POSIX acl)
576 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
577 string representation from acl\_to\_text (POSIX acl) for default acls.
578 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
579 string representation from acl\_to\_text (POSIX acl) for access acls.
580 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
581 string representation from acltostr (POSIX acl)
582 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
583 representation from acl\_to\_text (POSIX acl) for default acls.
584 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
585 representation from acl\_to\_text (POSIX acl) for access acls.
586 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
587 string representation from acl\_to\_text (POSIX acl) for default acls.
588 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
589 representation from acl\_to\_text (POSIX acl) for access acls.
590 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
591 string representation from acl\_to\_text (POSIX acl) for default acls.
592 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
593 string representation from acl\_to\_text (POSIX acl) for default acls.
594 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
595 representation from acl\_to\_text (POSIX acl) for access acls.
596 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
597 string representation from acltotext or acl\_totext (POSIX acl)
598 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
599 representation from from acl\_totext (NFSv4 or ZFS acl)
602 In future versions we might support conversion functions from one type of acl
603 into an other for types that are either the same or easily convertable. For now
604 the streams are seperate and restoring them on a platform that doesn't
605 recognize them will give you a warning.
607 \section{Extended Attributes}
608 \index[general]{Extended Attributes}
609 Something that was on the project list for some time is now implemented for
610 platforms that support a similar kind of interface. Its the support for backup
611 and restore of so called extended attributes. As extended attributes are so
612 platform specific these attributes are saved in seperate streams for each
613 platform. Restores of the extended attributes can only be performed on the
614 same platform the backup was done. There is support for all types of extended
615 attributes, but restoring from one type of filesystem onto an other type of
616 filesystem on the same platform may lead to supprises. As extended attributes
617 can contain any type of data they are stored as a series of so called
618 value-pairs. This data must be seen as mostly binary and is stored as such.
619 As security labels from selinux are also extended attributes this option also
620 stores those labels and no specific code is enabled for handling selinux
623 Currently the following platforms support extended attributes:
625 \item {\bf Darwin/OSX}
631 On linux acls are also extended attributes, as such when you enable ACLs on a
632 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
633 and not the same exteneded attribute.
635 To enable the backup of extended attributes please add the following to your
650 \section{Shared objects}
651 \index[general]{Shared objects}
652 A default build of Bacula will now create the libraries as shared objects
653 (.so) rather than static libraries as was previously the case.
654 The shared libraries are built using {\bf libtool} so it should be quite
657 An important advantage of using shared objects is that on a machine with the
658 Directory, File daemon, the Storage daemon, and a console, you will have only
659 one copy of the code in memory rather than four copies. Also the total size of
660 the binary release is smaller since the library code appears only once rather
661 than once for every program that uses it; this results in significant reduction
662 in the size of the binaries particularly for the utility tools.
664 In order for the system loader to find the shared objects when loading the
665 Bacula binaries, the Bacula shared objects must either be in a shared object
666 directory known to the loader (typically /usr/lib) or they must be in the
667 directory that may be specified on the {\bf ./configure} line using the {\bf
668 {-}{-}libdir} option as:
671 ./configure --libdir=/full-path/dir
674 the default is /usr/lib. If {-}{-}libdir is specified, there should be
675 no need to modify your loader configuration provided that
676 the shared objects are installed in that directory (Bacula
677 does this with the make install command). The shared objects
678 that Bacula references are:
687 These files are symbolically linked to the real shared object file,
688 which has a version number to permit running multiple versions of
689 the libraries if desired (not normally the case).
691 If you have problems with libtool or you wish to use the old
692 way of building static libraries, or you want to build a static
693 version of Bacula you may disable
694 libtool on the configure command line with:
697 ./configure --disable-libtool
701 \section{Building Static versions of Bacula}
702 \index[general]{Static linking}
703 In order to build static versions of Bacula, in addition
704 to configuration options that were needed you now must
705 also add --disable-libtool. Example
708 ./configure --enable-static-client-only --disable-libtool
712 \section{Virtual Backup (Vbackup)}
713 \index[general]{Virtual Backup}
714 \index[general]{Vbackup}
716 Bacula's virtual backup feature is often called Synthetic Backup or
717 Consolidation in other backup products. It permits you to consolidate the
718 previous Full backup plus the most recent Differential backup and any
719 subsequent Incremental backups into a new Full backup. This new Full
720 backup will then be considered as the most recent Full for any future
721 Incremental or Differential backups. The VirtualFull backup is
722 accomplished without contacting the client by reading the previous backup
723 data and writing it to a volume in a different pool.
725 In some respects the Vbackup feature works similar to a Migration job, in
726 that Bacula normally reads the data from the pool specified in the
727 Job resource, and writes it to the {\bf Next Pool} specified in the
728 Job resource. Note, this means that usually the output from the Virtual
729 Backup is written into a different pool from where your prior backups
730 are saved. Doing it this way guarantees that you will not get a deadlock
731 situation attempting to read and write to the same volume in the Storage
732 daemon. If you then want to do subsequent backups, you may need to
733 move the Virtual Full Volume back to your normal backup pool.
734 Alternatively, you can set your {\bf Next Pool} to point to the current
735 pool. This will cause Bacula to read and write to Volumes in the
736 current pool. In general, this will work, because Bacula will
737 not allow reading and writing on the same Volume. In any case, once
738 a VirtualFull has been created, and a restore is done involving the
739 most current Full, it will read the Volume or Volumes by the VirtualFull
740 regardless of in which Pool the Volume is found.
742 The Vbackup is enabled on a Job by Job in the Job resource by specifying
743 a level of {\bf VirtualFull}.
745 A typical Job resource definition might look like the following:
759 # Default pool definition
763 Recycle = yes # Automatically recycle Volumes
764 AutoPrune = yes # Prune expired volumes
765 Volume Retention = 365d # one year
773 Recycle = yes # Automatically recycle Volumes
774 AutoPrune = yes # Prune expired volumes
775 Volume Retention = 365d # one year
776 Storage = DiskChanger
779 # Definition of file storage device
786 Maximum Concurrent Jobs = 5
789 # Definition of DDS Virtual tape disk storage device
792 Address = localhost # N.B. Use a fully qualified name here
795 Media Type = DiskChangerMedia
796 Maximum Concurrent Jobs = 4
801 Then in bconsole or via a Run schedule, you would run the job as:
804 run job=MyBackup level=Full
805 run job=MyBackup level=Incremental
806 run job=MyBackup level=Differential
807 run job=MyBackup level=Incremental
808 run job=MyBackup level=Incremental
811 So providing there were changes between each of those jobs, you would end up
812 with a Full backup, a Differential, which includes the first Incremental
813 backup, then two Incremental backups. All the above jobs would be written to
814 the {\bf Default} pool.
816 To consolidate those backups into a new Full backup, you would run the
820 run job=MyBackup level=VirtualFull
823 And it would produce a new Full backup without using the client, and the output
824 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
826 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
829 Note, the Start and End time of the Virtual Full backup is set to the
830 values for the last job included in the Virtual Full (in the above example,
831 it is an Increment). This is so that if another incremental is done, which
832 will be based on the Virtual Full, it will backup all files from the
833 last Job included in the Virtual Full rather than from the time the Virtual
834 Full was actually run.
838 \section{Catalog Format}
839 \index[general]{Catalog Format}
840 Bacula 3.0 comes with some changes to the catalog format. The upgrade
841 operation will convert the FileId field of the File table from 32 bits (max 4
842 billion table entries) to 64 bits (very large number of items). The
843 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
844 your catalog during the conversion. Also you won't be able to run jobs during
845 this conversion period. For example, a 3 million file catalog will take 2
846 minutes to upgrade on a normal machine. Please don't forget to make a valid
847 backup of your database before executing the upgrade script. See the
848 ReleaseNotes for additional details.
850 \section{64 bit Windows Client}
851 \index[general]{Win64 Client}
852 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
853 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
854 As a consequence, we are also releasing a 64 bit version of the Bacula
855 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
856 These binaries should only be installed on 64 bit Windows operating systems.
857 What is important is not your hardware but whether or not you have
858 a 64 bit version of the Windows OS.
860 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
862 \item Before installing the Win64 Bacula Client, you must totally
863 deinstall any prior 2.4.x Client installation using the
864 Bacula deinstallation (see the menu item). You may want
865 to save your .conf files first.
866 \item Only the Client (File daemon) is ported to Win64, the Director
867 and the Storage daemon are not in the 64 bit Windows installer.
868 \item bwx-console is not yet ported.
869 \item bconsole is ported but it has not been tested.
870 \item The documentation is not included in the installer.
871 \item Due to Vista security restrictions imposed on a default installation
872 of Vista, before upgrading the Client, you must manually stop
873 any prior version of Bacula from running, otherwise the install
875 \item Due to Vista security restrictions imposed on a default installation
876 of Vista, attempting to edit the conf files via the menu items
877 will fail. You must directly edit the files with appropriate
878 permissions. Generally double clicking on the appropriate .conf
879 file will work providing you have sufficient permissions.
880 \item All Bacula files are now installed in
881 {\bf C:/Program Files/Bacula} except the main menu items,
882 which are installed as before. This vastly simplifies the installation.
883 \item If you are running on a foreign language version of Windows, most
884 likely {\bf C:/Program Files} does not exist, so you should use the
885 Custom installation and enter an appropriate location to install
887 \item The 3.0.0 Win32 Client continues to install files in the locations used
888 by prior versions. For the next version we will convert it to use
889 the same installation conventions as the Win64 version.
892 This project was funded by Bacula Systems.
895 \section{Duplicate Job Control}
896 \index[general]{Duplicate Jobs}
897 The new version of Bacula provides four new directives that
898 give additional control over what Bacula does if duplicate jobs
899 are started. A duplicate job in the sense we use it here means
900 a second or subsequent job with the same name starts. This
901 happens most frequently when the first job runs longer than expected because no
904 The four directives each take as an argument a {\bf yes} or {\bf no} value and
905 are specified in the Job resource.
909 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
910 \index[general]{Allow Duplicate Jobs}
911 If this directive is enabled duplicate jobs will be run. If
912 the directive is set to {\bf no} (default) then only one job of a given name
913 may run at one time, and the action that Bacula takes to ensure only
914 one job runs is determined by the other directives (see below).
916 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
917 are present and none of the three directives given below permit
918 cancelling a job, then the current job (the second one started)
922 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
923 \index[general]{Allow Higher Duplicates}
924 If this directive is set to {\bf yes} (default) the job with a higher
925 priority (lower priority number) will be permitted to run, and
926 the current job will be cancelled. If the
927 priorities of the two jobs are the same, the outcome is determined by
928 other directives (see below).
930 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
931 \index[general]{Cancel Queued Duplicates}
932 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
933 if this directive is set to {\bf yes} any job that is
934 already queued to run but not yet running will be canceled.
935 The default is {\bf no}.
937 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
938 \index[general]{Cancel Running Duplicates}
939 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
940 if this directive is set to {\bf yes} any job that is already running
941 will be canceled. The default is {\bf no}.
944 \section{TLS Authentication}
945 \index[general]{TLS Authentication}
946 In Bacula version 2.5.x and later, in addition to the normal Bacula
947 CRAM-MD5 authentication that is used to authenticate each Bacula
948 connection, you can specify that you want TLS Authentication as well,
949 which will provide more secure authentication.
951 This new feature uses Bacula's existing TLS code (normally used for
952 communications encryption) to do authentication. To use it, you must
953 specify all the TLS directives normally used to enable communications
954 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
957 \subsection{TLS Authenticate = yes}
959 TLS Authenticate = yes
962 in the main daemon configuration resource (Director for the Director,
963 Client for the File daemon, and Storage for the Storage daemon).
965 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
966 authentication, Bacula will also do TLS authentication, then TLS
967 encryption will be turned off, and the rest of the communication between
968 the two Bacula daemons will be done without encryption.
970 If you want to encrypt communications data, use the normal TLS directives
971 but do not turn on {\bf TLS Authenticate}.
973 \section{bextract non-portable Win32 data}
974 \index[general]{bextract handles Win32 non-portable data}
975 {\bf bextract} has been enhanced to be able to restore
976 non-portable Win32 data to any OS. Previous versions were
977 unable to restore non-portable Win32 data to machines that
978 did not have the Win32 BackupRead and BackupWrite API calls.
980 \section{State File updated at Job Termination}
981 \index[general]{State File}
982 In previous versions of Bacula, the state file, which provides a
983 summary of previous jobs run in the {\bf status} command output was
984 updated only when Bacula terminated, thus if the daemon crashed, the
985 state file might not contain all the run data. This version of
986 the Bacula daemons updates the state file on each job termination.
988 \section{MaxFullInterval = \lt{}time-interval\gt{}}
989 \index[general]{MaxFullInterval}
990 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
991 can be used to specify the maximum time interval between {\bf Full} backup
992 jobs. When a job starts, if the time since the last Full backup is
993 greater than the specified interval, and the job would normally be an
994 {\bf Incremental} or {\bf Differential}, it will be automatically
995 upgraded to a {\bf Full} backup.
997 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
998 \index[general]{MaxDiffInterval}
999 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1000 can be used to specify the maximum time interval between {\bf Differential} backup
1001 jobs. When a job starts, if the time since the last Differential backup is
1002 greater than the specified interval, and the job would normally be an
1003 {\bf Incremental}, it will be automatically
1004 upgraded to a {\bf Differential} backup.
1006 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1007 \index[general]{MaxDiffInterval}
1008 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1009 by the user, and when it is set it is an indication to backup programs
1010 to not backup that particular file. This version of Bacula contains a
1011 new Options directive within a FileSet resource, which instructs Bacula to
1012 obey this flag. The new directive is:
1015 Honor No Dump Flag = yes\vb{}no
1018 The default value is {\bf no}.
1021 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1022 \index[general]{IgnoreDir}
1023 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1024 can be added to the Include section of the FileSet resource. If the specified
1025 filename ({\bf filename-string}) is found on the Client in any directory to be
1026 backed up, the whole directory will be ignored (not backed up). For example:
1029 # List of files to be backed up
1037 Exclude Dir Containing = .excludeme
1042 But in /home, there may be hundreds of directories of users and some
1043 people want to indicate that they don't want to have certain
1044 directories backed up. For example, with the above FileSet, if
1045 the user or sysadmin creates a file named {\bf .excludeme} in
1046 specific directories, such as
1049 /home/user/www/cache/.excludeme
1050 /home/user/temp/.excludeme
1053 then Bacula will not backup the two directories named:
1056 /home/user/www/cache
1060 NOTE: subdirectories will not be backed up. That is, the directive
1061 applies to the two directories in question and any children (be they
1062 files, directories, etc).
1065 \section{Bacula Plugins}
1066 \index[general]{Plugin}
1067 Support for shared object plugins has been implemented in the Linux, Unix
1068 and Win32 File daemons. The API will be documented separately in
1069 the Developer's Guide or in a new document. For the moment, there is
1070 a single plugin named {\bf bpipe} that allows an external program to
1071 get control to backup and restore a file.
1073 Plugins are also planned (partially implemented) in the Director and the
1076 \subsection{Plugin Directory}
1077 \index[general]{Plugin Directory}
1078 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1079 be added to the daemon definition resource. The directory takes a quoted
1080 string argument, which is the name of the directory in which the daemon can
1081 find the Bacula plugins. If this directive is not specified, Bacula will not
1082 load any plugins. Since each plugin has a distinctive name, all the daemons
1083 can share the same plugin directory.
1085 \subsection{Plugin Options}
1086 \index[general]{Plugin Options}
1087 The {\bf Plugin Options} directive takes a quoted string
1088 arguement (after the equal sign) and may be specified in the
1089 Job resource. The options specified will be passed to all plugins
1090 when they are run. This each plugin must know what it is looking
1091 for. The value defined in the Job resource can be modified
1092 by the user when he runs a Job via the {\bf bconsole} command line
1095 Note: this directive may be specified, and there is code to modify
1096 the string in the run command, but the plugin options are not yet passed to
1097 the plugin (i.e. not fully implemented).
1099 \subsection{Plugin Options ACL}
1100 \index[general]{Plugin Options ACL}
1101 The {\bf Plugin Options ACL} directive may be specified in the
1102 Director's Console resource. It functions as all the other ACL commands
1103 do by permitting users running restricted consoles to specify a
1104 {\bf Plugin Options} that overrides the one specified in the Job
1105 definition. Without this directive restricted consoles may not modify
1108 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1109 \index[general]{Plugin}
1110 The {\bf Plugin} directive is specified in the Include section of
1111 a FileSet resource where you put your {\bf File = xxx} directives.
1122 Plugin = "bpipe:..."
1127 In the above example, when the File daemon is processing the directives
1128 in the Include section, it will first backup all the files in {\bf /home}
1129 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1130 the Plugin Directory. The syntax and semantics of the Plugin directive
1131 require the first part of the string up to the colon (:) to be the name
1132 of the plugin. Everything after the first colon is ignored by the File daemon but
1133 is passed to the plugin. Thus the plugin writer may define the meaning of the
1134 rest of the string as he wishes.
1136 Please see the next section for information about the {\bf bpipe} Bacula
1139 \section{The bpipe Plugin}
1140 \index[general]{The bpipe Plugin}
1141 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1142 the Bacula source distribution. When the plugin is compiled and linking into
1143 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1145 The purpose of the plugin is to provide an interface to any system program for
1146 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1147 the Include section of your Job's FileSet resource. The full syntax of the
1148 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1149 to specify the sytax as it wishes) is:
1152 Plugin = "<field1>:<field2>:<field3>:<field4>"
1157 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1158 stripped off, so in this case, we would put {\bf bpipe} in this field.
1160 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1161 pseudo path and filename under which the backup will be saved. This pseudo
1162 path and filename will be seen by the user in the restore file tree.
1163 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1164 backed up by the plugin will be put under that "pseudo" path and filename.
1165 You must be careful to choose a naming convention that is unique to avoid
1166 a conflict with a path and filename that actually exists on your system.
1168 \item {\bf field3} for the {\bf bpipe} plugin
1169 specifies the "reader" program that is called by the plugin during
1170 backup to read the data. {\bf bpipe} will call this program by doing a
1173 \item {\bf field4} for the {\bf bpipe} plugin
1174 specifies the "writer" program that is called by the plugin during
1175 restore to write the data back to the filesystem.
1178 Putting it all together, the full plugin directive line might look
1182 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1183 --opt --databases bacula:mysql"
1186 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1187 would be written on a single line.
1189 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1190 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1191 program {\bf mysqldump -f --opt --database bacula} to read the data during
1192 backup. The mysqldump command outputs all the data for the database named
1193 {\bf bacula}, which will be read by the plugin and stored in the backup.
1194 During restore, the data that was backed up will be sent to the program
1195 specified in the last field, which in this case is {\bf mysql}. When
1196 {\bf mysql} is called, it will read the data sent to it by the plugn
1197 then write it back to the same database from which it came ({\bf bacula}
1200 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1201 the data from a specified program to Bacula for backup, and then from Bacula to
1202 a specified program for restore.
1204 By using different command lines to {\bf bpipe},
1205 you can backup any kind of data (ASCII or binary) depending
1206 on the program called.
1208 \section{Microsoft Exchange Server 2003/2007 Plugin}
1209 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1210 \subsection{Background}
1211 The Exchange plugin was made possible by a funded development project
1212 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1213 The code for the plugin was written by James Harper, and the Bacula core
1214 code by Kern Sibbald. All the code for this funded development has become
1215 part of the Bacula project. Thanks to everyone who made it happen.
1217 \subsection{Concepts}
1218 Although it is possible to backup Exchange using Bacula VSS the Exchange
1219 plugin adds a good deal of functionality, because while Bacula VSS
1220 completes a full backup (snapshot) of Exchange, it does
1221 not support Incremental or Differential backups, restoring is more
1222 complicated, and a single database restore is not possible.
1224 Microsoft Exchange organises its storage into Storage Groups with
1225 Databases inside them. A default installation of Exchange will have a
1226 single Storage Group called 'First Storage Group', with two Databases
1227 inside it, "Mailbox Store (SERVER NAME)" and
1228 "Public Folder Store (SERVER NAME)",
1229 which hold user email and public folders respectively.
1231 In the default configuration, Exchange logs everything that happens to
1232 log files, such that if you have a backup, and all the log files since,
1233 you can restore to the present time. Each Storage Group has its own set
1234 of log files and operates independently of any other Storage Groups. At
1235 the Storage Group level, the logging can be turned off by enabling a
1236 function called "Enable circular logging". At this time the Exchange
1237 plugin will not function if this option is enabled.
1239 The plugin allows backing up of entire storage groups, and the restoring
1240 of entire storage groups or individual databases. Backing up and
1241 restoring at the individual mailbox or email item is not supported but
1242 can be simulated by use of the "Recovery" Storage Group (see below).
1244 \subsection{Installing}
1245 The Exchange plugin requires a DLL that is shipped with Microsoft
1246 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1247 correctly the Exchange plugin should find this automatically and run
1248 without any additional installation.
1250 If the DLL can not be found automatically it will need to be copied into
1251 the Bacula installation
1252 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1253 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1254 default Exchange installation.
1256 \subsection{Backup up}
1257 To back up an Exchange server the Fileset definition must contain at
1258 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1259 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1260 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1261 up files are prefixed with something that isn't going to share a name
1262 with something outside the plugin, and the 'Microsoft Information Store'
1263 bit is required also. It is also possible to add the name of a storage
1264 group to the "Plugin =" line, eg \\
1265 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1266 if you want only a single storage group backed up.
1268 Additionally, you can suffix the 'Plugin =' directive with
1269 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1270 database at the end of a full backup.
1272 An Incremental or Differential backup will backup only the database logs
1273 for each Storage Group by inspecting the "modified date" on each
1274 physical log file. Because of the way the Exchange API works, the last
1275 logfile backed up on each backup will always be backed up by the next
1276 Incremental or Differential backup too. This adds 5MB to each
1277 Incremental or Differential backup size but otherwise does not cause any
1280 By default, a normal VSS fileset containing all the drive letters will
1281 also back up the Exchange databases using VSS. This will interfere with
1282 the plugin and Exchange's shared ideas of when the last full backup was
1283 done, and may also truncate log files incorrectly. It is important,
1284 therefore, that the Exchange database files be excluded from the backup,
1285 although the folders the files are in should be included, or they will
1286 have to be recreated manually if a baremetal restore is done.
1291 File = C:/Program Files/Exchsrvr/mdbdata
1292 Plugin = "exchange:..."
1295 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1296 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1297 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1298 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1299 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1300 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1301 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1306 The advantage of excluding the above files is that you can significantly
1307 reduce the size of your backup since all the important Exchange files
1308 will be properly saved by the Plugin.
1311 \subsection{Restoring}
1312 The restore operation is much the same as a normal Bacula restore, with
1313 the following provisos:
1316 \item The {\bf Where} restore option must not be specified
1317 \item Each Database directory must be marked as a whole. You cannot just
1318 select (say) the .edb file and not the others.
1319 \item If a Storage Group is restored, the directory of the Storage Group
1321 \item It is possible to restore only a subset of the available log files,
1322 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1323 if a log file is missing from the sequence of log files
1324 \item Each database to be restored must be dismounted and marked as "Can be
1325 overwritten by restore"
1326 \item If an entire Storage Group is to be restored (eg all databases and
1327 logs in the Storage Group), then it is best to manually delete the
1328 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1329 as Exchange can get confused by stray log files lying around.
1332 \subsection{Restoring to the Recovery Storage Group}
1333 The concept of the Recovery Storage Group is well documented by
1335 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1336 but to briefly summarize...
1338 Microsoft Exchange allows the creation of an additional Storage Group
1339 called the Recovery Storage Group, which is used to restore an older
1340 copy of a database (e.g. before a mailbox was deleted) into without
1341 messing with the current live data. This is required as the Standard and
1342 Small Business Server versions of Exchange can not ordinarily have more
1343 than one Storage Group.
1345 To create the Recovery Storage Group, drill down to the Server in Exchange
1346 System Manager, right click, and select
1347 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1348 locations and click OK. On the Recovery Storage Group, right click and
1349 select {\bf "Add Database to Recover..."} and select the database you will
1352 Restore only the single database nominated as the database in the
1353 Recovery Storage Group. Exchange will redirect the restore to the
1354 Recovery Storage Group automatically.
1355 Then run the restore.
1357 \subsection{Restoring on Microsoft Server 2007}
1358 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1359 2007, and henc you use a new proceedure for recovering a single mail box.
1360 This procedure is ducomented by Microsoft at:
1361 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1362 and involves using the {\bf Restore-Mailbox} and {\bf
1363 Get-MailboxStatistics} shell commands.
1365 \subsection{Caveats}
1366 This plugin is still being developed, so you should consider it
1367 currently in BETA test, and thus use in a production environment
1368 should be done only after very careful testing.
1370 When doing a full backup, the Exchange database logs are truncated by
1371 Exchange as soon as the plugin has completed the backup. If the data
1372 never makes it to the backup medium (eg because of spooling) then the
1373 logs will still be truncated, but they will also not have been backed
1374 up. A solution to this is being worked on. You will have to schedule a
1375 new Full backup to ensure that your next backups will be usable.
1377 The "Enable Circular Logging" option cannot be enabled or the plugin
1380 Exchange insists that a successful Full backup must have taken place if
1381 an Incremental or Differential backup is desired, and the plugin will
1382 fail if this is not the case. If a restore is done, Exchange will
1383 require that a Full backup be done before an Incremental or Differential
1386 The plugin will most likely not work well if another backup application
1387 (eg NTBACKUP) is backing up the Exchange database, especially if the
1388 other backup application is truncating the log files.
1390 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1391 we recommend either carefully testing or that you avoid this option for
1394 The Exchange plugin is not called during processing the bconsole {\bf
1395 estimate} command, and so anything that would be backed up by the plugin
1396 will not be added to the estimate total that is displayed.
1399 \section{libdbi Framework}
1400 \index[general]{libdbi Framework}
1401 As a general guideline, Bacula has support for a few catalog database drivers
1402 (MySQL, PostgreSQL, SQLite)
1403 coded natively by the Bacula team. With the libdbi implementation, which is a
1404 Bacula driver that uses libdbi to access the catalog, we have an open field to
1405 use many different kinds database engines following the needs of users.
1407 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1408 implements a database-independent abstraction layer in C, similar to the
1409 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1410 leverage the power of multiple databases and multiple simultaneous database
1411 connections by using this framework.
1413 Currently the libdbi driver in Bacula project only supports the same drivers
1414 natively coded in Bacula. However the libdbi project has support for many
1415 others database engines. You can view the list at
1416 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1417 supported by Bacula, however, they must be tested properly by the Bacula team.
1419 Some of benefits of using libdbi are:
1421 \item The possibility to use proprietary databases engines in which your
1422 proprietary licenses prevent the Bacula team from developing the driver.
1423 \item The possibility to use the drivers written for the libdbi project.
1424 \item The possibility to use other database engines without recompiling Bacula
1425 to use them. Just change one line in bacula-dir.conf
1426 \item Abstract Database access, this is, unique point to code and profiling
1427 catalog database access.
1430 The following drivers have been tested:
1432 \item PostgreSQL, with and without batch insert
1433 \item Mysql, with and without batch insert
1438 In the future, we will test and approve to use others databases engines
1439 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1441 To compile Bacula to support libdbi we need to configure the code with the
1442 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1443 [database] is the database engine to be used with Bacula (of course we can
1444 change the driver in file bacula-dir.conf, see below). We must configure the
1445 access port of the database engine with the option --with-db-port, because the
1446 libdbi framework doesn't know the default access port of each database.
1448 The next phase is checking (or configuring) the bacula-dir.conf, example:
1452 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1453 dbname = regress; user = regress; password = ""
1457 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1458 mysql database. Currently the drivers supported by Bacula are: postgresql,
1459 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1461 The following limitations apply when Bacula is set to use the libdbi framework:
1462 - Not tested on the Win32 platform
1463 - A little performance is lost if comparing with native database driver.
1464 The reason is bound with the database driver provided by libdbi and the
1465 simple fact that one more layer of code was added.
1467 It is important to remember, when compiling Bacula with libdbi, the
1468 following packages are needed:
1470 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1471 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1474 You can download them and compile them on your system or install the packages
1475 from your OS distribution.
1477 \section{Console Command Additions and Enhancements}
1478 \index[general]{Console Additions}
1480 \subsection{Display Autochanger Content}
1481 \index[general]{StatusSlots}
1483 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1484 autochanger content.
1488 Slot | Volume Name | Status | Media Type | Pool |
1489 ------+---------------+----------+-------------------+------------|
1490 1 | 00001 | Append | DiskChangerMedia | Default |
1491 2 | 00002 | Append | DiskChangerMedia | Default |
1492 3*| 00003 | Append | DiskChangerMedia | Scratch |
1497 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1498 {\bf update slots} command to synchronize autochanger content with your
1501 \subsection{list joblog job=xxx or jobid=nnn}
1502 \index[general]{list joblog}
1503 A new list command has been added that allows you to list the contents
1504 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1505 or for a particular JobId. The {\bf llist} command will include a line with
1506 the time and date of the entry.
1508 Note for the catalog to have Job Log entries, you must have a directive
1515 In your Director's {\bf Messages} resource.
1517 \subsection{Use separator for multiple commands}
1518 \index[general]{Command Separator}
1519 When using bconsole with readline, you can set the command separator with
1520 \textbf{@separator} command to one
1521 of those characters to write commands who require multiple input in one line.
1523 !$%&'()*+,-/:;<>?[]^`{|}~
1526 \subsection{Deleting Volumes}
1527 The delete volume bconsole command has been modified to
1528 require an asterisk (*) in front of a MediaId otherwise the
1529 value you enter is a taken to be a Volume name. This is so that
1530 users may delete numeric Volume names. The previous Bacula versions
1531 assumed that all input that started with a number was a MediaId.
1533 This new behavior is indicated in the prompt if you read it
1536 \section{Bare Metal Recovery}
1537 The old bare metal recovery project is essentially dead. One
1538 of the main features of it was that it would build a recovery
1539 CD based on the kernel on your system. The problem was that
1540 every distribution has a different boot procedure and different
1541 scripts, and worse yet, the boot procedures and scripts change
1542 from one distribution to another. This meant that maintaining
1543 (keeping up with the changes) the rescue CD was too much work.
1545 To replace it, a new bare metal recovery USB boot stick has been developed
1546 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1547 boot from a USB key.
1551 \item Recovery can be done from within graphical environment.
1552 \item Recovery can be done in a shell.
1553 \item Ubuntu boots on a large number of Linux systems.
1554 \item The process of updating the system and adding new
1555 packages is not too difficult.
1556 \item The USB key can easily be upgraded to newer Ubuntu versions.
1557 \item The USB key has writable partitions for modifications to
1558 the OS and for modification to your home directory.
1559 \item You can add new files/directories to the USB key very easily.
1560 \item You can save the environment from multiple machines on
1562 \item Bacula Systems is funding its ongoing development.
1565 The disadvantages are:
1567 \item The USB key is usable but currently under development.
1568 \item Not everyone may be familiar with Ubuntu (no worse
1570 \item Some older OSes cannot be booted from USB. This can
1571 be resolved by first booting a Ubuntu LiveCD then plugging
1573 \item Currently the documentation is sketchy and not yet added
1574 to the main manual. See below ...
1577 The documentation and the code can be found in the {\bf rescue} package
1578 in the directory {\bf linux/usb}.
1580 \section{Miscellaneous}
1581 \index[general]{Misc New Features}
1583 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
1584 \index[general]{Allow Mixed Priority}
1585 This directive is only implemented in version 2.5 and later. When
1586 set to {\bf yes} (default {\bf no}), this job may run even if lower
1587 priority jobs are already running. This means a high priority job
1588 will not have to wait for other jobs to finish before starting.
1589 The scheduler will only mix priorities when all running jobs have
1592 Note that only higher priority jobs will start early. Suppose the
1593 director will allow two concurrent jobs, and that two jobs with
1594 priority 10 are running, with two more in the queue. If a job with
1595 priority 5 is added to the queue, it will be run as soon as one of
1596 the running jobs finishes. However, new priority 10 jobs will not
1597 be run until the priority 5 job has finished.
1599 \subsection{Bootstrap File Directive -- FileRegex}
1600 \index[general]{Bootstrap File Directive}
1601 {\bf FileRegex} is a new command that can be added to the bootstrap
1602 (.bsr) file. The value is a regular expression. When specified, only
1603 matching filenames will be restored.
1605 During a restore, if all File records are pruned from the catalog
1606 for a Job, normally Bacula can restore only all files saved. That
1607 is there is no way using the catalog to select individual files.
1608 With this new feature, Bacula will ask if you want to specify a Regex
1609 expression for extracting only a part of the full backup.
1612 Building directory tree for JobId(s) 1,3 ...
1613 There were no files inserted into the tree, so file selection
1614 is not possible.Most likely your retention policy pruned the files
1616 Do you want to restore all the files? (yes\vb{}no): no
1618 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1619 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1622 \subsection{Bootstrap File Optimization Changes}
1623 In order to permit proper seeking on disk files, we have extended the bootstrap
1624 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1625 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1626 address range and end address range respectively. These two directives replace
1627 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1628 VolEndBlock} directives. Bootstrap files containing the old directives will
1629 still work, but will not properly take advantage of proper disk seeking, and
1630 may read completely to the end of a disk volume during a restore. With the new
1631 format (automatically generated by the new Director), restores will seek
1632 properly and stop reading the volume when all the files have been restored.
1634 \subsection{Solaris ZFS/NFSv4 ACLs}
1635 This is an upgrade of the previous Solaris ACL backup code
1636 to the new library format, which will backup both the old
1637 POSIX(UFS) ACLs as well as the ZFS ACLs.
1639 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1640 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1641 be used to transfer from UFS to ZFS filesystems.
1644 \subsection{Virtual Tape Emulation}
1645 \index[general]{Virtual Tape Emulation}
1646 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1647 the tape code but actually reading and writing to a disk file. Used with the
1648 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1649 and 700 slots. This feature is most useful in testing. It is enabled
1650 by using {\bf Device Type = vtape} in the Storage daemon's Device
1651 directive. This feature is only implemented on Linux machines and should not be
1652 used for production.
1654 \subsection{Bat Enhancements}
1655 \index[general]{Bat Enhancements}
1656 Bat (the Bacula Administration Tool) GUI program has been significantly
1657 enhanced and stabilized. In particular, there are new table based status
1658 commands; it can now be easily localized using Qt4 Linguist.
1660 The Bat communications protocol has been significantly enhanced to improve
1661 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1662 the Director you are using otherwise the communications protocol will not
1665 \subsection{RunScript Enhancements}
1666 \index[general]{RunScript Enhancements}
1667 The {\bf RunScript} resource has been enhanced to permit multiple
1668 commands per RunScript. Simply specify multiple {\bf Command} directives
1675 Command = "/bin/echo test"
1676 Command = "/bin/echo an other test"
1677 Command = "/bin/echo 3 commands in the same runscript"
1684 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1685 implemented, which runs the command after the Volume Shadow Copy has been made.
1687 Console commands can be specified within a RunScript by using:
1688 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1689 carefully tested and debugged and is known to easily crash the Director.
1690 We would appreciate feedback. Due to the recursive nature of this command, we
1691 may remove it before the final release.
1693 \subsection{Status Enhancements}
1694 \index[general]{Status Enhancements}
1695 The bconsole {\bf status dir} output has been enhanced to indicate
1696 Storage daemon job spooling and despooling activity.
1698 \subsection{Connect Timeout}
1699 \index[general]{Connect Timeout}
1700 The default connect timeout to the File
1701 daemon has been set to 3 minutes. Previously it was 30 minutes.
1703 \subsection{ftruncate for NFS Volumes}
1704 \index[general]{ftruncate for NFS Volumes}
1705 If you write to a Volume mounted by NFS (say on a local file server),
1706 in previous Bacula versions, when the Volume was recycled, it was not
1707 properly truncated because NFS does not implement ftruncate (file
1708 truncate). This is now corrected in the new version because we have
1709 written code (actually a kind user) that deletes and recreates the Volume,
1710 thus accomplishing the same thing as a truncate.
1712 \subsection{Support for Ubuntu}
1713 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1714 version of Linux, and thus now provides correct autostart routines.
1715 Since Ubuntu officially supports Bacula, you can also obtain any
1716 recent release of Bacula from the Ubuntu repositories.
1718 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1719 \index[general]{Recycle Pool}
1720 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1721 be placed (moved) when it is recycled. Without this directive, a Volume will
1722 remain in the same pool when it is recycled. With this directive, it can be
1723 moved automatically to any existing pool during a recycle. This directive is
1724 probably most useful when defined in the Scratch pool, so that volumes will
1725 be recycled back into the Scratch pool.
1727 \subsection{FD Version}
1728 \index[general]{FD Version}
1729 The File daemon to Director protocol now includes a version
1730 number, which although there is no visible change for users,
1731 will help us in future versions automatically determine
1732 if a File daemon is not compatible.
1734 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1735 \index[general]{Max Run Sched Time}
1736 The time specifies the maximum allowed time that a job may run, counted from
1737 when the job was scheduled. This can be useful to prevent jobs from running
1738 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1741 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1742 \index[general]{Max Wait Time}
1743 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1744 of checking the maximum allowed time that a job may block for a resource,
1745 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1746 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1747 their job depending on the level. Now, they have to use
1748 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1749 directives are now deprecated.
1751 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1752 \index[general]{Incremental Max Wait Time}
1753 \index[general]{Differential Max Wait Time}
1755 These directives have been deprecated in favor of
1756 \texttt{Incremental|Differential Max Run Time}.
1758 \subsection{Max Run Time directives}
1759 \index[general]{Max Run Time directives}
1760 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1761 maximum allowed time that a job can run depending on the level.
1763 \addcontentsline{lof}{figure}{Job time control directives}
1764 \includegraphics{\idir different_time.eps}
1766 \subsection{Statistics Enhancements}
1767 \index[general]{Statistics Enhancements}
1768 If you (or probably your boss) want to have statistics on your backups to
1769 provide some \textit{Service Level Agreement} indicators, you could use a few
1770 SQL queries on the Job table to report how many:
1774 \item jobs have been successful
1775 \item files have been backed up
1779 However, these statistics are accurate only if your job retention is greater
1780 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1781 be able to use them.
1783 Now, you can use the \textbf{update stats [days=num]} console command to fill
1784 the JobHistory table with new Job records. If you want to be sure to take in
1785 account only \textbf{good jobs}, ie if one of your important job has failed but
1786 you have fixed the problem and restarted it on time, you probably want to
1787 delete the first \textit{bad} job record and keep only the successful one. For
1788 that simply let your staff do the job, and update JobHistory table after two or
1789 three days depending on your organization using the \textbf{[days=num]} option.
1791 These statistics records aren't used for restoring, but mainly for
1792 capacity planning, billings, etc.
1794 The Bweb interface provides a statistics module that can use this feature. You
1795 can also use tools like Talend or extract information by yourself.
1797 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1798 the length of time that Bacula will keep statistics job records in the Catalog
1799 database after the Job End time. (In \texttt{JobHistory} table) When this time
1800 period expires, and if user runs \texttt{prune stats} command, Bacula will
1801 prune (remove) Job records that are older than the specified period.
1803 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1804 job to maintain statistics.
1807 Name = BackupCatalog
1810 Console = "update stats days=3"
1811 Console = "prune stats yes"
1818 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1819 \index[general]{ScratchPool}
1820 This directive permits to specify a specific \textsl{Scratch} pool for the
1821 current pool. This is useful when using multiple storage sharing the same
1822 mediatype or when you want to dedicate volumes to a particular set of pool.
1824 \subsection{Enhanced Attribute Despooling}
1825 \index[general]{Attribute Despooling}
1826 If the storage daemon and the Director are on the same machine, the spool file
1827 that contains attributes is read directly by the Director instead of being
1828 transmitted across the network. That should reduce load and speedup insertion.
1830 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1831 \index[general]{SpoolSize}
1832 A new Job directive permits to specify the spool size per job. This is used
1833 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1835 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1836 \index[general]{MaxConsoleConnections}
1837 A new director directive permits to specify the maximum number of Console
1838 Connections that could run concurrently. The default is set to 20, but you may
1839 set it to a larger number.
1841 \subsection{VerId = \lt{}string\gt{}}
1842 \index[general]{VerId}
1843 A new director directive permits to specify a personnal identifier that will be
1844 displayed in the \texttt{version} command.
1846 \subsection{dbcheck enhancements}
1847 \index[general]{dbcheck enhancements}
1848 If you are using Mysql, dbcheck will now ask you if you want to create
1849 temporary indexes to speed up orphaned Path and Filename elimination.
1851 A new \texttt{-B} option allows you to print catalog information in a simple
1852 text based format. This is useful to backup it in a secure way.
1867 You can now specify the database connection port in the command line.
1869 \subsection{{-}{-}docdir configure option}
1870 \index[general]{{-}{-}docdir configure option}
1871 You can use {-}{-}docdir= on the ./configure command to
1872 specify the directory where you want Bacula to install the
1873 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
1874 {\bf /usr/share/doc/bacula}.
1876 \subsection{{-}{-}htmldir configure option}
1877 \index[general]{{-}{-}htmldir configure option}
1878 You can use {-}{-}htmldir= on the ./configure command to
1879 specify the directory where you want Bacula to install the bat html help
1880 files. The default is {\bf /usr/share/doc/bacula/html}
1882 \subsection{{-}{-}with-plugindir configure option}
1883 \index[general]{{-}{-}plugindir configure option}
1884 You can use {-}{-}plugindir= on the ./configure command to
1885 specify the directory where you want Bacula to install
1886 the plugins (currently only bpipe-fd). The default is