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
12 \section{Restore from Multiple Storage Daemons}
13 \index[general]{Restore}
15 Previously, you were able to restore from multiple devices in a single Storage
16 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
17 example, if your full backup runs on a Storage Daemon with an autochanger, and
18 your incremental jobs use another Storage Daemon with lots of disks, Bacula
19 will switch automatically from one Storage Daemon to an other within the same Restore
22 You must upgrade your File Daemon to version 3.0.3 to use this feature.
24 This project was funded by Bacula Systems with the help of Equiinet.
26 \section{File Deduplication using Base Jobs}
27 A base job is sort of like a Full save except that you will want the FileSet to
28 contain only files that are unlikely to change in the future (i.e. a snapshot
29 of most of your system after installing it). After the base job has been run,
30 when you are doing a Full save, you specify one or more Base jobs to be used.
31 All files that have been backed up in the Base job/jobs but not modified will
32 then be excluded from the backup. During a restore, the Base jobs will be
33 automatically pulled in where necessary.
35 This is something none of the competition does, as far as we know (except
36 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
37 win for the user, it makes Bacula stand out as offering a unique optimization
38 that immediately saves time and money. Basically, imagine that you have 100
39 nearly identical Windows or Linux machine containing the OS and user files.
40 Now for the OS part, a Base job will be backed up once, and rather than making
41 100 copies of the OS, there will be only one. If one or more of the systems
42 have some files updated, no problem, they will be automatically restored.
44 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
45 files that will be used during Full backup as base.
56 Base = BackupZog4, BackupLinux
62 In this example, the job \texttt{BackupZog4} will use the most recent version
63 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
64 jobs. Base jobs should have run with \texttt{level=Base} to be used.
66 By default, Bacula will compare permissions bits, user and group fields,
67 modification time, size and the checksum of the file to choose between the
68 current backup and the BaseJob file list. You can change this behavior with the
69 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
70 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
87 This project was funded by Bacula Systems.
92 To help developers in restore GUI interfaces, we have added new \textsl{dot
93 commands} that permit to browse the catalog in a very simple way.
96 \item \texttt{.update [jobid=x,y,z]} This command is required to update the
97 Bvfs cache in the catalog. You need to run it before any access to the Bvfs
99 \item \texttt{.lsdirs jobid=x,y,z path=/path | pathid=101} This command will
100 list all directories in the specified \texttt{path} or \texttt{pathid}. Using
101 \texttt{pathid} avoids problems with caracters encoding.
102 \item \texttt{.lsfiles jobid=x,y,z path=/path | pathid=101} This command will
103 list all files in the specified \texttt{path} or \texttt{pathid}. Using
104 \texttt{pathid} avoids problems with caracters encoding.
107 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
108 data that will be displayed.
113 * .lsdir path=/ jobid=1,2
116 \section{Testing your tape drive}
117 \label{sec:btapespeed}
119 To determine the best configuration of your tape drive, you can run the new
120 \texttt{speed} command available in \texttt{btape}.
122 This command can have the following arguments:
124 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
125 (between 1 and 5GB). This counter is in GB.
126 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
127 of data should be greater than your memory ($file\_size*nb\_file$).
128 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
130 \item[\texttt{skip\_random}] This flag permits to skip tests with random
132 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
133 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
138 *speed file_size=3 skip_raw
139 btape.c:1078 Test with zero data and bacula block structure.
140 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
141 ++++++++++++++++++++++++++++++++++++++++++
142 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
143 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 GB/s
145 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 GKB/s
147 btape.c:1090 Test with random data, should give the minimum throughput.
148 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
149 +++++++++++++++++++++++++++++++++++++++++++
150 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
151 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 GB/s
152 +++++++++++++++++++++++++++++++++++++++++++
154 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 GB/s
158 When using compression, the random test will give your the minimum throughput
159 of your drive . The test using constant string will give you the maximum speed
160 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
162 You can change the block size in the Storage Daemon configuration file.
164 \section{New {\bf Block Checksum} Device directive}
165 You may now turn off the Block Checksum (CRC32) code
166 that Bacula uses when writing blocks to a Volume. This is
173 doing so can reduce the Storage daemon CPU speed slightly. It
174 will also permit Bacula to read a Volume that has corrupted data.
176 The default is {\bf yes} -- i.e. the checksum is computed on write
179 We do not recommend to turn this off particularly on older tape
180 drives or for disk Volumes where doing so may allow corrupted data
183 \section{New Bat Features}
185 \subsection{Media information view}
187 By double-clicking on a volume (on the Media list, in the Autochanger content
188 or in the Job information panel), you can access a detailed overview of your
189 Volume. (cf \ref{fig:mediainfo}.)
192 \includegraphics[width=13cm]{\idir bat11.eps}
193 \caption{Media information}
194 \label{fig:mediainfo}
197 \subsection{Job information view}
199 By double-clicking on a Job record (on the Job run list or in the Media
200 information panel), you can access a detailed overview of your Job. (cf
204 \includegraphics[width=13cm]{\idir bat12.eps}
205 \caption{Job information}
209 \subsection{Autochanger content view}
211 By double-clicking on a Storage record (on the Storage list panel), you can
212 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
215 \includegraphics[width=13cm]{\idir bat13.eps}
216 \caption{Autochanger content}
217 \label{fig:achcontent}
220 \chapter{New Features in 3.0.2}
222 This chapter presents the new features added to the development 3.0.2
223 versions to be released as Bacula version 3.0.2 in july 2009.
225 \section{Full restore from a given JobId}
226 \index[general]{Restore menu}
228 This feature allows selecting a single JobId and having Bacula
229 automatically select all the other jobs that comprise a full backup up to
230 and including the selected JobId.
232 Assume we start with the following jobs:
234 +-------+--------------+---------------------+-------+----------+------------+
235 | jobid | client | starttime | level | jobfiles | jobbytes |
236 +-------+--------------+---------------------+-------+----------+------------
237 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
238 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
239 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
240 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
241 +-------+--------------+---------------------+-------+----------+------------+
244 Below is an example of this new feature (which is number 12 in the
249 To select the JobIds, you have the following choices:
250 1: List last 20 Jobs run
251 2: List Jobs where a given File is saved
253 12: Select full restore to a specified JobId
256 Select item: (1-13): 12
257 Enter JobId to restore: 5
258 You have selected the following JobIds: 1,3,5
260 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
261 1,444 files inserted into the tree.
264 This project was funded by Bacula Systems.
266 \section{Source Address}
267 \index[general]{Source Address}
269 A feature has been added which allows the administrator to specify the address
270 from which the Director and File daemons will establish connections. This
271 may be used to simplify system configuration overhead when working in complex
272 networks utilizing multi-homing and policy-routing.
274 To accomplish this, two new configuration directives have been implemented:
277 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
281 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
285 Simply adding specific host routes on the OS
286 would have an undesirable side-effect: any
287 application trying to contact the destination host would be forced to use the
288 more specific route possibly diverting management traffic onto a backup VLAN.
289 Instead of adding host routes for each client connected to a multi-homed backup
290 server (for example where there are management and backup VLANs), one can
291 use the new directives to specify a specific source address at the application
294 Additionally, this allows the simplification and abstraction of firewall rules
295 when dealing with a Hot-Standby director or storage daemon configuration. The
296 Hot-standby pair may share a CARP address, which connections must be sourced
297 from, while system services listen and act from the unique interface addresses.
299 This project was funded by Collaborative Fusion, Inc.
301 \section{Show volume availability when doing restore}
303 When doing a restore the selection dialog ends by displaying this
307 The job will require the following
308 Volume(s) Storage(s) SD Device(s)
309 ===========================================================================
320 Volumes marked with ``*'' are online (in the autochanger).
323 This should help speed up large restores by minimizing the time spent
324 waiting for the operator to discover that he must change tapes in the library.
326 This project was funded by Bacula Systems.
328 \section{Accurate estimate command}
330 The \texttt{estimate} command can now use the accurate code to detect changes
331 and give a better estimation.
333 You can set the accurate behavior on the command line by using
334 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
337 * estimate listing accurate=yes level=incremental job=BackupJob
340 This project was funded by Bacula Systems.
342 \chapter{New Features in 3.0.0}
343 \label{NewFeaturesChapter}
344 \index[general]{New Features}
346 This chapter presents the new features added to the development 2.5.x
347 versions to be released as Bacula version 3.0.0 sometime in April 2009.
349 \section{Accurate Backup}
350 \index[general]{Accurate Backup}
352 As with most other backup programs, by default Bacula decides what files to
353 backup for Incremental and Differental backup by comparing the change
354 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
355 backup completed. If one of those two times is later than the last backup
356 time, then the file will be backed up. This does not, however, permit tracking
357 what files have been deleted and will miss any file with an old time that may
358 have been restored to or moved onto the client filesystem.
360 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
361 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
362 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
363 backup, there is no difference, but for {\bf Differential} and {\bf
364 Incremental} backups, the Director will send a list of all previous files
365 backed up, and the File daemon will use that list to determine if any new files
366 have been added or or moved and if any files have been deleted. This allows
367 Bacula to make an accurate backup of your system to that point in time so that
368 if you do a restore, it will restore your system exactly.
371 about using Accurate backup is that it requires more resources (CPU and memory)
372 on both the Director and the Client machines to create the list of previous
373 files backed up, to send that list to the File daemon, for the File daemon to
374 keep the list (possibly very big) in memory, and for the File daemon to do
375 comparisons between every file in the FileSet and the list. In particular,
376 if your client has lots of files (more than a few million), you will need
377 lots of memory on the client machine.
379 Accurate must not be enabled when backing up with a plugin that is not
380 specially designed to work with Accurate. If you enable it, your restores
381 will probably not work correctly.
383 This project was funded by Bacula Systems.
388 \index[general]{Copy Jobs}
390 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
391 existing Migration feature with the exception that the Job that is copied is
392 left unchanged. This essentially creates two identical copies of the same
393 backup. However, the copy is treated as a copy rather than a backup job, and
394 hence is not directly available for restore. The {\bf restore} command lists
395 copy jobs and allows selection of copies by using \texttt{jobid=}
396 option. If the keyword {\bf copies} is present on the command line, Bacula will
397 display the list of all copies for selected jobs.
402 These JobIds have copies as follows:
403 +-------+------------------------------------+-----------+------------------+
404 | JobId | Job | CopyJobId | MediaType |
405 +-------+------------------------------------+-----------+------------------+
406 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
407 +-------+------------------------------------+-----------+------------------+
408 +-------+-------+----------+----------+---------------------+------------------+
409 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
410 +-------+-------+----------+----------+---------------------+------------------+
411 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
412 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
413 +-------+-------+----------+----------+---------------------+------------------+
414 You have selected the following JobIds: 19,2
416 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
417 5,611 files inserted into the tree.
422 The Copy Job runs without using the File daemon by copying the data from the
423 old backup Volume to a different Volume in a different Pool. See the Migration
424 documentation for additional details. For copy Jobs there is a new selection
425 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
426 not already copied to another Pool.
428 As with Migration, the Client, Volume, Job, or SQL query, are
429 other possible ways of selecting the Jobs to be copied. Selection
430 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
431 work, but are probably more suited for Migration Jobs.
433 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
434 it will promote the Copy to a \textsl{real} backup job and will make it available for
435 automatic restore. If more than one Copy is available, it will promote the copy
436 with the smallest JobId.
438 A nice solution which can be built with the new Copy feature is often
439 called disk-to-disk-to-tape backup (DTDTT). A sample config could
440 look something like the one below:
444 Name = FullBackupsVirtualPool
446 Purge Oldest Volume = Yes
448 NextPool = FullBackupsTapePool
452 Name = FullBackupsTapePool
456 Volume Retention = 365 days
457 Storage = superloader
461 # Fake fileset for copy jobs
473 # Fake client for copy jobs
483 # Default template for a CopyDiskToTape Job
486 Name = CopyDiskToTape
488 Messages = StandardCopy
491 Selection Type = PoolUncopiedJobs
492 Maximum Concurrent Jobs = 10
494 Allow Duplicate Jobs = Yes
495 Allow Higher Duplicates = No
496 Cancel Queued Duplicates = No
497 Cancel Running Duplicates = No
502 Name = DaySchedule7:00
503 Run = Level=Full daily at 7:00
507 Name = CopyDiskToTapeFullBackups
509 Schedule = DaySchedule7:00
510 Pool = FullBackupsVirtualPool
511 JobDefs = CopyDiskToTape
515 The example above had 2 pool which are copied using the PoolUncopiedJobs
516 selection criteria. Normal Full backups go to the Virtual pool and are copied
517 to the Tape pool the next morning.
519 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
524 +-------+------------------------------------+-----------+------------------+
525 | JobId | Job | CopyJobId | MediaType |
526 +-------+------------------------------------+-----------+------------------+
527 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
528 +-------+------------------------------------+-----------+------------------+
531 \section{ACL Updates}
532 \index[general]{ACL Updates}
533 The whole ACL code had been overhauled and in this version each platforms has
534 different streams for each type of acl available on such an platform. As ACLs
535 between platforms tend to be not that portable (most implement POSIX acls but
536 some use an other draft or a completely different format) we currently only
537 allow certain platform specific ACL streams to be decoded and restored on the
538 same platform that they were created on. The old code allowed to restore ACL
539 cross platform but the comments already mention that not being to wise. For
540 backward compatability the new code will accept the two old ACL streams and
541 handle those with the platform specific handler. But for all new backups it
542 will save the ACLs using the new streams.
544 Currently the following platforms support ACLs:
548 \item {\bf Darwin/OSX}
557 Currently we support the following ACL types (these ACL streams use a reserved
558 part of the stream numbers):
561 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
563 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
564 string representation from acl\_to\_text (POSIX acl)
565 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
566 string representation from acl\_to\_text (POSIX acl) for default acls.
567 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
568 string representation from acl\_to\_text (POSIX acl) for access acls.
569 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
570 string representation from acltostr (POSIX acl)
571 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
572 representation from acl\_to\_text (POSIX acl) for default acls.
573 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
574 representation from acl\_to\_text (POSIX acl) for access acls.
575 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
576 string representation from acl\_to\_text (POSIX acl) for default acls.
577 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
578 representation from acl\_to\_text (POSIX acl) for access acls.
579 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
580 string representation from acl\_to\_text (POSIX acl) for default acls.
581 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
582 string representation from acl\_to\_text (POSIX acl) for default acls.
583 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
584 representation from acl\_to\_text (POSIX acl) for access acls.
585 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
586 string representation from acltotext or acl\_totext (POSIX acl)
587 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
588 representation from from acl\_totext (NFSv4 or ZFS acl)
591 In future versions we might support conversion functions from one type of acl
592 into an other for types that are either the same or easily convertable. For now
593 the streams are seperate and restoring them on a platform that doesn't
594 recognize them will give you a warning.
596 \section{Extended Attributes}
597 \index[general]{Extended Attributes}
598 Something that was on the project list for some time is now implemented for
599 platforms that support a similar kind of interface. Its the support for backup
600 and restore of so called extended attributes. As extended attributes are so
601 platform specific these attributes are saved in seperate streams for each
602 platform. Restores of the extended attributes can only be performed on the
603 same platform the backup was done. There is support for all types of extended
604 attributes, but restoring from one type of filesystem onto an other type of
605 filesystem on the same platform may lead to supprises. As extended attributes
606 can contain any type of data they are stored as a series of so called
607 value-pairs. This data must be seen as mostly binary and is stored as such.
608 As security labels from selinux are also extended attributes this option also
609 stores those labels and no specific code is enabled for handling selinux
612 Currently the following platforms support extended attributes:
614 \item {\bf Darwin/OSX}
620 On linux acls are also extended attributes, as such when you enable ACLs on a
621 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
622 and not the same exteneded attribute.
624 To enable the backup of extended attributes please add the following to your
639 \section{Shared objects}
640 \index[general]{Shared objects}
641 A default build of Bacula will now create the libraries as shared objects
642 (.so) rather than static libraries as was previously the case.
643 The shared libraries are built using {\bf libtool} so it should be quite
646 An important advantage of using shared objects is that on a machine with the
647 Directory, File daemon, the Storage daemon, and a console, you will have only
648 one copy of the code in memory rather than four copies. Also the total size of
649 the binary release is smaller since the library code appears only once rather
650 than once for every program that uses it; this results in significant reduction
651 in the size of the binaries particularly for the utility tools.
653 In order for the system loader to find the shared objects when loading the
654 Bacula binaries, the Bacula shared objects must either be in a shared object
655 directory known to the loader (typically /usr/lib) or they must be in the
656 directory that may be specified on the {\bf ./configure} line using the {\bf
657 {-}{-}libdir} option as:
660 ./configure --libdir=/full-path/dir
663 the default is /usr/lib. If {-}{-}libdir is specified, there should be
664 no need to modify your loader configuration provided that
665 the shared objects are installed in that directory (Bacula
666 does this with the make install command). The shared objects
667 that Bacula references are:
676 These files are symbolically linked to the real shared object file,
677 which has a version number to permit running multiple versions of
678 the libraries if desired (not normally the case).
680 If you have problems with libtool or you wish to use the old
681 way of building static libraries, or you want to build a static
682 version of Bacula you may disable
683 libtool on the configure command line with:
686 ./configure --disable-libtool
690 \section{Building Static versions of Bacula}
691 \index[general]{Static linking}
692 In order to build static versions of Bacula, in addition
693 to configuration options that were needed you now must
694 also add --disable-libtool. Example
697 ./configure --enable-static-client-only --disable-libtool
701 \section{Virtual Backup (Vbackup)}
702 \index[general]{Virtual Backup}
703 \index[general]{Vbackup}
705 Bacula's virtual backup feature is often called Synthetic Backup or
706 Consolidation in other backup products. It permits you to consolidate the
707 previous Full backup plus the most recent Differential backup and any
708 subsequent Incremental backups into a new Full backup. This new Full
709 backup will then be considered as the most recent Full for any future
710 Incremental or Differential backups. The VirtualFull backup is
711 accomplished without contacting the client by reading the previous backup
712 data and writing it to a volume in a different pool.
714 In some respects the Vbackup feature works similar to a Migration job, in
715 that Bacula normally reads the data from the pool specified in the
716 Job resource, and writes it to the {\bf Next Pool} specified in the
717 Job resource. Note, this means that usually the output from the Virtual
718 Backup is written into a different pool from where your prior backups
719 are saved. Doing it this way guarantees that you will not get a deadlock
720 situation attempting to read and write to the same volume in the Storage
721 daemon. If you then want to do subsequent backups, you may need to
722 move the Virtual Full Volume back to your normal backup pool.
723 Alternatively, you can set your {\bf Next Pool} to point to the current
724 pool. This will cause Bacula to read and write to Volumes in the
725 current pool. In general, this will work, because Bacula will
726 not allow reading and writing on the same Volume. In any case, once
727 a VirtualFull has been created, and a restore is done involving the
728 most current Full, it will read the Volume or Volumes by the VirtualFull
729 regardless of in which Pool the Volume is found.
731 The Vbackup is enabled on a Job by Job in the Job resource by specifying
732 a level of {\bf VirtualFull}.
734 A typical Job resource definition might look like the following:
748 # Default pool definition
752 Recycle = yes # Automatically recycle Volumes
753 AutoPrune = yes # Prune expired volumes
754 Volume Retention = 365d # one year
762 Recycle = yes # Automatically recycle Volumes
763 AutoPrune = yes # Prune expired volumes
764 Volume Retention = 365d # one year
765 Storage = DiskChanger
768 # Definition of file storage device
775 Maximum Concurrent Jobs = 5
778 # Definition of DDS Virtual tape disk storage device
781 Address = localhost # N.B. Use a fully qualified name here
784 Media Type = DiskChangerMedia
785 Maximum Concurrent Jobs = 4
790 Then in bconsole or via a Run schedule, you would run the job as:
793 run job=MyBackup level=Full
794 run job=MyBackup level=Incremental
795 run job=MyBackup level=Differential
796 run job=MyBackup level=Incremental
797 run job=MyBackup level=Incremental
800 So providing there were changes between each of those jobs, you would end up
801 with a Full backup, a Differential, which includes the first Incremental
802 backup, then two Incremental backups. All the above jobs would be written to
803 the {\bf Default} pool.
805 To consolidate those backups into a new Full backup, you would run the
809 run job=MyBackup level=VirtualFull
812 And it would produce a new Full backup without using the client, and the output
813 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
815 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
818 Note, the Start and End time of the Virtual Full backup is set to the
819 values for the last job included in the Virtual Full (in the above example,
820 it is an Increment). This is so that if another incremental is done, which
821 will be based on the Virtual Full, it will backup all files from the
822 last Job included in the Virtual Full rather than from the time the Virtual
823 Full was actually run.
827 \section{Catalog Format}
828 \index[general]{Catalog Format}
829 Bacula 3.0 comes with some changes to the catalog format. The upgrade
830 operation will convert the FileId field of the File table from 32 bits (max 4
831 billion table entries) to 64 bits (very large number of items). The
832 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
833 your catalog during the conversion. Also you won't be able to run jobs during
834 this conversion period. For example, a 3 million file catalog will take 2
835 minutes to upgrade on a normal machine. Please don't forget to make a valid
836 backup of your database before executing the upgrade script. See the
837 ReleaseNotes for additional details.
839 \section{64 bit Windows Client}
840 \index[general]{Win64 Client}
841 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
842 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
843 As a consequence, we are also releasing a 64 bit version of the Bacula
844 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
845 These binaries should only be installed on 64 bit Windows operating systems.
846 What is important is not your hardware but whether or not you have
847 a 64 bit version of the Windows OS.
849 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
851 \item Before installing the Win64 Bacula Client, you must totally
852 deinstall any prior 2.4.x Client installation using the
853 Bacula deinstallation (see the menu item). You may want
854 to save your .conf files first.
855 \item Only the Client (File daemon) is ported to Win64, the Director
856 and the Storage daemon are not in the 64 bit Windows installer.
857 \item bwx-console is not yet ported.
858 \item bconsole is ported but it has not been tested.
859 \item The documentation is not included in the installer.
860 \item Due to Vista security restrictions imposed on a default installation
861 of Vista, before upgrading the Client, you must manually stop
862 any prior version of Bacula from running, otherwise the install
864 \item Due to Vista security restrictions imposed on a default installation
865 of Vista, attempting to edit the conf files via the menu items
866 will fail. You must directly edit the files with appropriate
867 permissions. Generally double clicking on the appropriate .conf
868 file will work providing you have sufficient permissions.
869 \item All Bacula files are now installed in
870 {\bf C:/Program Files/Bacula} except the main menu items,
871 which are installed as before. This vastly simplifies the installation.
872 \item If you are running on a foreign language version of Windows, most
873 likely {\bf C:/Program Files} does not exist, so you should use the
874 Custom installation and enter an appropriate location to install
876 \item The 3.0.0 Win32 Client continues to install files in the locations used
877 by prior versions. For the next version we will convert it to use
878 the same installation conventions as the Win64 version.
881 This project was funded by Bacula Systems.
884 \section{Duplicate Job Control}
885 \index[general]{Duplicate Jobs}
886 The new version of Bacula provides four new directives that
887 give additional control over what Bacula does if duplicate jobs
888 are started. A duplicate job in the sense we use it here means
889 a second or subsequent job with the same name starts. This
890 happens most frequently when the first job runs longer than expected because no
893 The four directives each take as an argument a {\bf yes} or {\bf no} value and
894 are specified in the Job resource.
898 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
899 \index[general]{Allow Duplicate Jobs}
900 If this directive is enabled duplicate jobs will be run. If
901 the directive is set to {\bf no} (default) then only one job of a given name
902 may run at one time, and the action that Bacula takes to ensure only
903 one job runs is determined by the other directives (see below).
905 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
906 are present and none of the three directives given below permit
907 cancelling a job, then the current job (the second one started)
911 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
912 \index[general]{Allow Higher Duplicates}
913 If this directive is set to {\bf yes} (default) the job with a higher
914 priority (lower priority number) will be permitted to run, and
915 the current job will be cancelled. If the
916 priorities of the two jobs are the same, the outcome is determined by
917 other directives (see below).
919 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
920 \index[general]{Cancel Queued Duplicates}
921 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
922 if this directive is set to {\bf yes} any job that is
923 already queued to run but not yet running will be canceled.
924 The default is {\bf no}.
926 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
927 \index[general]{Cancel Running Duplicates}
928 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
929 if this directive is set to {\bf yes} any job that is already running
930 will be canceled. The default is {\bf no}.
933 \section{TLS Authentication}
934 \index[general]{TLS Authentication}
935 In Bacula version 2.5.x and later, in addition to the normal Bacula
936 CRAM-MD5 authentication that is used to authenticate each Bacula
937 connection, you can specify that you want TLS Authentication as well,
938 which will provide more secure authentication.
940 This new feature uses Bacula's existing TLS code (normally used for
941 communications encryption) to do authentication. To use it, you must
942 specify all the TLS directives normally used to enable communications
943 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
946 \subsection{TLS Authenticate = yes}
948 TLS Authenticate = yes
951 in the main daemon configuration resource (Director for the Director,
952 Client for the File daemon, and Storage for the Storage daemon).
954 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
955 authentication, Bacula will also do TLS authentication, then TLS
956 encryption will be turned off, and the rest of the communication between
957 the two Bacula daemons will be done without encryption.
959 If you want to encrypt communications data, use the normal TLS directives
960 but do not turn on {\bf TLS Authenticate}.
962 \section{bextract non-portable Win32 data}
963 \index[general]{bextract handles Win32 non-portable data}
964 {\bf bextract} has been enhanced to be able to restore
965 non-portable Win32 data to any OS. Previous versions were
966 unable to restore non-portable Win32 data to machines that
967 did not have the Win32 BackupRead and BackupWrite API calls.
969 \section{State File updated at Job Termination}
970 \index[general]{State File}
971 In previous versions of Bacula, the state file, which provides a
972 summary of previous jobs run in the {\bf status} command output was
973 updated only when Bacula terminated, thus if the daemon crashed, the
974 state file might not contain all the run data. This version of
975 the Bacula daemons updates the state file on each job termination.
977 \section{MaxFullInterval = \lt{}time-interval\gt{}}
978 \index[general]{MaxFullInterval}
979 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
980 can be used to specify the maximum time interval between {\bf Full} backup
981 jobs. When a job starts, if the time since the last Full backup is
982 greater than the specified interval, and the job would normally be an
983 {\bf Incremental} or {\bf Differential}, it will be automatically
984 upgraded to a {\bf Full} backup.
986 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
987 \index[general]{MaxDiffInterval}
988 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
989 can be used to specify the maximum time interval between {\bf Differential} backup
990 jobs. When a job starts, if the time since the last Differential backup is
991 greater than the specified interval, and the job would normally be an
992 {\bf Incremental}, it will be automatically
993 upgraded to a {\bf Differential} backup.
995 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
996 \index[general]{MaxDiffInterval}
997 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
998 by the user, and when it is set it is an indication to backup programs
999 to not backup that particular file. This version of Bacula contains a
1000 new Options directive within a FileSet resource, which instructs Bacula to
1001 obey this flag. The new directive is:
1004 Honor No Dump Flag = yes\vb{}no
1007 The default value is {\bf no}.
1010 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1011 \index[general]{IgnoreDir}
1012 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1013 can be added to the Include section of the FileSet resource. If the specified
1014 filename ({\bf filename-string}) is found on the Client in any directory to be
1015 backed up, the whole directory will be ignored (not backed up). For example:
1018 # List of files to be backed up
1026 Exclude Dir Containing = .excludeme
1031 But in /home, there may be hundreds of directories of users and some
1032 people want to indicate that they don't want to have certain
1033 directories backed up. For example, with the above FileSet, if
1034 the user or sysadmin creates a file named {\bf .excludeme} in
1035 specific directories, such as
1038 /home/user/www/cache/.excludeme
1039 /home/user/temp/.excludeme
1042 then Bacula will not backup the two directories named:
1045 /home/user/www/cache
1049 NOTE: subdirectories will not be backed up. That is, the directive
1050 applies to the two directories in question and any children (be they
1051 files, directories, etc).
1054 \section{Bacula Plugins}
1055 \index[general]{Plugin}
1056 Support for shared object plugins has been implemented in the Linux, Unix
1057 and Win32 File daemons. The API will be documented separately in
1058 the Developer's Guide or in a new document. For the moment, there is
1059 a single plugin named {\bf bpipe} that allows an external program to
1060 get control to backup and restore a file.
1062 Plugins are also planned (partially implemented) in the Director and the
1065 \subsection{Plugin Directory}
1066 \index[general]{Plugin Directory}
1067 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1068 be added to the daemon definition resource. The directory takes a quoted
1069 string argument, which is the name of the directory in which the daemon can
1070 find the Bacula plugins. If this directive is not specified, Bacula will not
1071 load any plugins. Since each plugin has a distinctive name, all the daemons
1072 can share the same plugin directory.
1074 \subsection{Plugin Options}
1075 \index[general]{Plugin Options}
1076 The {\bf Plugin Options} directive takes a quoted string
1077 arguement (after the equal sign) and may be specified in the
1078 Job resource. The options specified will be passed to all plugins
1079 when they are run. This each plugin must know what it is looking
1080 for. The value defined in the Job resource can be modified
1081 by the user when he runs a Job via the {\bf bconsole} command line
1084 Note: this directive may be specified, and there is code to modify
1085 the string in the run command, but the plugin options are not yet passed to
1086 the plugin (i.e. not fully implemented).
1088 \subsection{Plugin Options ACL}
1089 \index[general]{Plugin Options ACL}
1090 The {\bf Plugin Options ACL} directive may be specified in the
1091 Director's Console resource. It functions as all the other ACL commands
1092 do by permitting users running restricted consoles to specify a
1093 {\bf Plugin Options} that overrides the one specified in the Job
1094 definition. Without this directive restricted consoles may not modify
1097 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1098 \index[general]{Plugin}
1099 The {\bf Plugin} directive is specified in the Include section of
1100 a FileSet resource where you put your {\bf File = xxx} directives.
1111 Plugin = "bpipe:..."
1116 In the above example, when the File daemon is processing the directives
1117 in the Include section, it will first backup all the files in {\bf /home}
1118 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1119 the Plugin Directory. The syntax and semantics of the Plugin directive
1120 require the first part of the string up to the colon (:) to be the name
1121 of the plugin. Everything after the first colon is ignored by the File daemon but
1122 is passed to the plugin. Thus the plugin writer may define the meaning of the
1123 rest of the string as he wishes.
1125 Please see the next section for information about the {\bf bpipe} Bacula
1128 \section{The bpipe Plugin}
1129 \index[general]{The bpipe Plugin}
1130 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1131 the Bacula source distribution. When the plugin is compiled and linking into
1132 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1134 The purpose of the plugin is to provide an interface to any system program for
1135 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1136 the Include section of your Job's FileSet resource. The full syntax of the
1137 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1138 to specify the sytax as it wishes) is:
1141 Plugin = "<field1>:<field2>:<field3>:<field4>"
1146 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1147 stripped off, so in this case, we would put {\bf bpipe} in this field.
1149 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1150 pseudo path and filename under which the backup will be saved. This pseudo
1151 path and filename will be seen by the user in the restore file tree.
1152 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1153 backed up by the plugin will be put under that "pseudo" path and filename.
1154 You must be careful to choose a naming convention that is unique to avoid
1155 a conflict with a path and filename that actually exists on your system.
1157 \item {\bf field3} for the {\bf bpipe} plugin
1158 specifies the "reader" program that is called by the plugin during
1159 backup to read the data. {\bf bpipe} will call this program by doing a
1162 \item {\bf field4} for the {\bf bpipe} plugin
1163 specifies the "writer" program that is called by the plugin during
1164 restore to write the data back to the filesystem.
1167 Putting it all together, the full plugin directive line might look
1171 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1172 --opt --databases bacula:mysql"
1175 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1176 would be written on a single line.
1178 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1179 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1180 program {\bf mysqldump -f --opt --database bacula} to read the data during
1181 backup. The mysqldump command outputs all the data for the database named
1182 {\bf bacula}, which will be read by the plugin and stored in the backup.
1183 During restore, the data that was backed up will be sent to the program
1184 specified in the last field, which in this case is {\bf mysql}. When
1185 {\bf mysql} is called, it will read the data sent to it by the plugn
1186 then write it back to the same database from which it came ({\bf bacula}
1189 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1190 the data from a specified program to Bacula for backup, and then from Bacula to
1191 a specified program for restore.
1193 By using different command lines to {\bf bpipe},
1194 you can backup any kind of data (ASCII or binary) depending
1195 on the program called.
1197 \section{Microsoft Exchange Server 2003/2007 Plugin}
1198 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1199 \subsection{Background}
1200 The Exchange plugin was made possible by a funded development project
1201 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1202 The code for the plugin was written by James Harper, and the Bacula core
1203 code by Kern Sibbald. All the code for this funded development has become
1204 part of the Bacula project. Thanks to everyone who made it happen.
1206 \subsection{Concepts}
1207 Although it is possible to backup Exchange using Bacula VSS the Exchange
1208 plugin adds a good deal of functionality, because while Bacula VSS
1209 completes a full backup (snapshot) of Exchange, it does
1210 not support Incremental or Differential backups, restoring is more
1211 complicated, and a single database restore is not possible.
1213 Microsoft Exchange organises its storage into Storage Groups with
1214 Databases inside them. A default installation of Exchange will have a
1215 single Storage Group called 'First Storage Group', with two Databases
1216 inside it, "Mailbox Store (SERVER NAME)" and
1217 "Public Folder Store (SERVER NAME)",
1218 which hold user email and public folders respectively.
1220 In the default configuration, Exchange logs everything that happens to
1221 log files, such that if you have a backup, and all the log files since,
1222 you can restore to the present time. Each Storage Group has its own set
1223 of log files and operates independently of any other Storage Groups. At
1224 the Storage Group level, the logging can be turned off by enabling a
1225 function called "Enable circular logging". At this time the Exchange
1226 plugin will not function if this option is enabled.
1228 The plugin allows backing up of entire storage groups, and the restoring
1229 of entire storage groups or individual databases. Backing up and
1230 restoring at the individual mailbox or email item is not supported but
1231 can be simulated by use of the "Recovery" Storage Group (see below).
1233 \subsection{Installing}
1234 The Exchange plugin requires a DLL that is shipped with Microsoft
1235 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1236 correctly the Exchange plugin should find this automatically and run
1237 without any additional installation.
1239 If the DLL can not be found automatically it will need to be copied into
1240 the Bacula installation
1241 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1242 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1243 default Exchange installation.
1245 \subsection{Backup up}
1246 To back up an Exchange server the Fileset definition must contain at
1247 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1248 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1249 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1250 up files are prefixed with something that isn't going to share a name
1251 with something outside the plugin, and the 'Microsoft Information Store'
1252 bit is required also. It is also possible to add the name of a storage
1253 group to the "Plugin =" line, eg \\
1254 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1255 if you want only a single storage group backed up.
1257 Additionally, you can suffix the 'Plugin =' directive with
1258 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1259 database at the end of a full backup.
1261 An Incremental or Differential backup will backup only the database logs
1262 for each Storage Group by inspecting the "modified date" on each
1263 physical log file. Because of the way the Exchange API works, the last
1264 logfile backed up on each backup will always be backed up by the next
1265 Incremental or Differential backup too. This adds 5MB to each
1266 Incremental or Differential backup size but otherwise does not cause any
1269 By default, a normal VSS fileset containing all the drive letters will
1270 also back up the Exchange databases using VSS. This will interfere with
1271 the plugin and Exchange's shared ideas of when the last full backup was
1272 done, and may also truncate log files incorrectly. It is important,
1273 therefore, that the Exchange database files be excluded from the backup,
1274 although the folders the files are in should be included, or they will
1275 have to be recreated manually if a baremetal restore is done.
1280 File = C:/Program Files/Exchsrvr/mdbdata
1281 Plugin = "exchange:..."
1284 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1285 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1286 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1287 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1288 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1289 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1290 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1295 The advantage of excluding the above files is that you can significantly
1296 reduce the size of your backup since all the important Exchange files
1297 will be properly saved by the Plugin.
1300 \subsection{Restoring}
1301 The restore operation is much the same as a normal Bacula restore, with
1302 the following provisos:
1305 \item The {\bf Where} restore option must not be specified
1306 \item Each Database directory must be marked as a whole. You cannot just
1307 select (say) the .edb file and not the others.
1308 \item If a Storage Group is restored, the directory of the Storage Group
1310 \item It is possible to restore only a subset of the available log files,
1311 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1312 if a log file is missing from the sequence of log files
1313 \item Each database to be restored must be dismounted and marked as "Can be
1314 overwritten by restore"
1315 \item If an entire Storage Group is to be restored (eg all databases and
1316 logs in the Storage Group), then it is best to manually delete the
1317 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1318 as Exchange can get confused by stray log files lying around.
1321 \subsection{Restoring to the Recovery Storage Group}
1322 The concept of the Recovery Storage Group is well documented by
1324 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1325 but to briefly summarize...
1327 Microsoft Exchange allows the creation of an additional Storage Group
1328 called the Recovery Storage Group, which is used to restore an older
1329 copy of a database (e.g. before a mailbox was deleted) into without
1330 messing with the current live data. This is required as the Standard and
1331 Small Business Server versions of Exchange can not ordinarily have more
1332 than one Storage Group.
1334 To create the Recovery Storage Group, drill down to the Server in Exchange
1335 System Manager, right click, and select
1336 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1337 locations and click OK. On the Recovery Storage Group, right click and
1338 select {\bf "Add Database to Recover..."} and select the database you will
1341 Restore only the single database nominated as the database in the
1342 Recovery Storage Group. Exchange will redirect the restore to the
1343 Recovery Storage Group automatically.
1344 Then run the restore.
1346 \subsection{Restoring on Microsoft Server 2007}
1347 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1348 2007, and henc you use a new proceedure for recovering a single mail box.
1349 This procedure is ducomented by Microsoft at:
1350 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1351 and involves using the {\bf Restore-Mailbox} and {\bf
1352 Get-MailboxStatistics} shell commands.
1354 \subsection{Caveats}
1355 This plugin is still being developed, so you should consider it
1356 currently in BETA test, and thus use in a production environment
1357 should be done only after very careful testing.
1359 When doing a full backup, the Exchange database logs are truncated by
1360 Exchange as soon as the plugin has completed the backup. If the data
1361 never makes it to the backup medium (eg because of spooling) then the
1362 logs will still be truncated, but they will also not have been backed
1363 up. A solution to this is being worked on. You will have to schedule a
1364 new Full backup to ensure that your next backups will be usable.
1366 The "Enable Circular Logging" option cannot be enabled or the plugin
1369 Exchange insists that a successful Full backup must have taken place if
1370 an Incremental or Differential backup is desired, and the plugin will
1371 fail if this is not the case. If a restore is done, Exchange will
1372 require that a Full backup be done before an Incremental or Differential
1375 The plugin will most likely not work well if another backup application
1376 (eg NTBACKUP) is backing up the Exchange database, especially if the
1377 other backup application is truncating the log files.
1379 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1380 we recommend either carefully testing or that you avoid this option for
1383 The Exchange plugin is not called during processing the bconsole {\bf
1384 estimate} command, and so anything that would be backed up by the plugin
1385 will not be added to the estimate total that is displayed.
1388 \section{libdbi Framework}
1389 \index[general]{libdbi Framework}
1390 As a general guideline, Bacula has support for a few catalog database drivers
1391 (MySQL, PostgreSQL, SQLite)
1392 coded natively by the Bacula team. With the libdbi implementation, which is a
1393 Bacula driver that uses libdbi to access the catalog, we have an open field to
1394 use many different kinds database engines following the needs of users.
1396 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1397 implements a database-independent abstraction layer in C, similar to the
1398 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1399 leverage the power of multiple databases and multiple simultaneous database
1400 connections by using this framework.
1402 Currently the libdbi driver in Bacula project only supports the same drivers
1403 natively coded in Bacula. However the libdbi project has support for many
1404 others database engines. You can view the list at
1405 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1406 supported by Bacula, however, they must be tested properly by the Bacula team.
1408 Some of benefits of using libdbi are:
1410 \item The possibility to use proprietary databases engines in which your
1411 proprietary licenses prevent the Bacula team from developing the driver.
1412 \item The possibility to use the drivers written for the libdbi project.
1413 \item The possibility to use other database engines without recompiling Bacula
1414 to use them. Just change one line in bacula-dir.conf
1415 \item Abstract Database access, this is, unique point to code and profiling
1416 catalog database access.
1419 The following drivers have been tested:
1421 \item PostgreSQL, with and without batch insert
1422 \item Mysql, with and without batch insert
1427 In the future, we will test and approve to use others databases engines
1428 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1430 To compile Bacula to support libdbi we need to configure the code with the
1431 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1432 [database] is the database engine to be used with Bacula (of course we can
1433 change the driver in file bacula-dir.conf, see below). We must configure the
1434 access port of the database engine with the option --with-db-port, because the
1435 libdbi framework doesn't know the default access port of each database.
1437 The next phase is checking (or configuring) the bacula-dir.conf, example:
1441 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1442 dbname = regress; user = regress; password = ""
1446 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1447 mysql database. Currently the drivers supported by Bacula are: postgresql,
1448 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1450 The following limitations apply when Bacula is set to use the libdbi framework:
1451 - Not tested on the Win32 platform
1452 - A little performance is lost if comparing with native database driver.
1453 The reason is bound with the database driver provided by libdbi and the
1454 simple fact that one more layer of code was added.
1456 It is important to remember, when compiling Bacula with libdbi, the
1457 following packages are needed:
1459 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1460 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1463 You can download them and compile them on your system or install the packages
1464 from your OS distribution.
1466 \section{Console Command Additions and Enhancements}
1467 \index[general]{Console Additions}
1469 \subsection{Display Autochanger Content}
1470 \index[general]{StatusSlots}
1472 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1473 autochanger content.
1477 Slot | Volume Name | Status | Media Type | Pool |
1478 ------+---------------+----------+-------------------+------------|
1479 1 | 00001 | Append | DiskChangerMedia | Default |
1480 2 | 00002 | Append | DiskChangerMedia | Default |
1481 3*| 00003 | Append | DiskChangerMedia | Scratch |
1486 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1487 {\bf update slots} command to synchronize autochanger content with your
1490 \subsection{list joblog job=xxx or jobid=nnn}
1491 \index[general]{list joblog}
1492 A new list command has been added that allows you to list the contents
1493 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1494 or for a particular JobId. The {\bf llist} command will include a line with
1495 the time and date of the entry.
1497 Note for the catalog to have Job Log entries, you must have a directive
1504 In your Director's {\bf Messages} resource.
1506 \subsection{Use separator for multiple commands}
1507 \index[general]{Command Separator}
1508 When using bconsole with readline, you can set the command separator with
1509 \textbf{@separator} command to one
1510 of those characters to write commands who require multiple input in one line.
1512 !$%&'()*+,-/:;<>?[]^`{|}~
1515 \subsection{Deleting Volumes}
1516 The delete volume bconsole command has been modified to
1517 require an asterisk (*) in front of a MediaId otherwise the
1518 value you enter is a taken to be a Volume name. This is so that
1519 users may delete numeric Volume names. The previous Bacula versions
1520 assumed that all input that started with a number was a MediaId.
1522 This new behavior is indicated in the prompt if you read it
1525 \section{Bare Metal Recovery}
1526 The old bare metal recovery project is essentially dead. One
1527 of the main features of it was that it would build a recovery
1528 CD based on the kernel on your system. The problem was that
1529 every distribution has a different boot procedure and different
1530 scripts, and worse yet, the boot procedures and scripts change
1531 from one distribution to another. This meant that maintaining
1532 (keeping up with the changes) the rescue CD was too much work.
1534 To replace it, a new bare metal recovery USB boot stick has been developed
1535 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1536 boot from a USB key.
1540 \item Recovery can be done from within graphical environment.
1541 \item Recovery can be done in a shell.
1542 \item Ubuntu boots on a large number of Linux systems.
1543 \item The process of updating the system and adding new
1544 packages is not too difficult.
1545 \item The USB key can easily be upgraded to newer Ubuntu versions.
1546 \item The USB key has writable partitions for modifications to
1547 the OS and for modification to your home directory.
1548 \item You can add new files/directories to the USB key very easily.
1549 \item You can save the environment from multiple machines on
1551 \item Bacula Systems is funding its ongoing development.
1554 The disadvantages are:
1556 \item The USB key is usable but currently under development.
1557 \item Not everyone may be familiar with Ubuntu (no worse
1559 \item Some older OSes cannot be booted from USB. This can
1560 be resolved by first booting a Ubuntu LiveCD then plugging
1562 \item Currently the documentation is sketchy and not yet added
1563 to the main manual. See below ...
1566 The documentation and the code can be found in the {\bf rescue} package
1567 in the directory {\bf linux/usb}.
1569 \section{Miscellaneous}
1570 \index[general]{Misc New Features}
1572 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
1573 \index[general]{Allow Mixed Priority}
1574 This directive is only implemented in version 2.5 and later. When
1575 set to {\bf yes} (default {\bf no}), this job may run even if lower
1576 priority jobs are already running. This means a high priority job
1577 will not have to wait for other jobs to finish before starting.
1578 The scheduler will only mix priorities when all running jobs have
1581 Note that only higher priority jobs will start early. Suppose the
1582 director will allow two concurrent jobs, and that two jobs with
1583 priority 10 are running, with two more in the queue. If a job with
1584 priority 5 is added to the queue, it will be run as soon as one of
1585 the running jobs finishes. However, new priority 10 jobs will not
1586 be run until the priority 5 job has finished.
1588 \subsection{Bootstrap File Directive -- FileRegex}
1589 \index[general]{Bootstrap File Directive}
1590 {\bf FileRegex} is a new command that can be added to the bootstrap
1591 (.bsr) file. The value is a regular expression. When specified, only
1592 matching filenames will be restored.
1594 During a restore, if all File records are pruned from the catalog
1595 for a Job, normally Bacula can restore only all files saved. That
1596 is there is no way using the catalog to select individual files.
1597 With this new feature, Bacula will ask if you want to specify a Regex
1598 expression for extracting only a part of the full backup.
1601 Building directory tree for JobId(s) 1,3 ...
1602 There were no files inserted into the tree, so file selection
1603 is not possible.Most likely your retention policy pruned the files
1605 Do you want to restore all the files? (yes\vb{}no): no
1607 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1608 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1611 \subsection{Bootstrap File Optimization Changes}
1612 In order to permit proper seeking on disk files, we have extended the bootstrap
1613 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1614 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1615 address range and end address range respectively. These two directives replace
1616 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1617 VolEndBlock} directives. Bootstrap files containing the old directives will
1618 still work, but will not properly take advantage of proper disk seeking, and
1619 may read completely to the end of a disk volume during a restore. With the new
1620 format (automatically generated by the new Director), restores will seek
1621 properly and stop reading the volume when all the files have been restored.
1623 \subsection{Solaris ZFS/NFSv4 ACLs}
1624 This is an upgrade of the previous Solaris ACL backup code
1625 to the new library format, which will backup both the old
1626 POSIX(UFS) ACLs as well as the ZFS ACLs.
1628 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1629 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1630 be used to transfer from UFS to ZFS filesystems.
1633 \subsection{Virtual Tape Emulation}
1634 \index[general]{Virtual Tape Emulation}
1635 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1636 the tape code but actually reading and writing to a disk file. Used with the
1637 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1638 and 700 slots. This feature is most useful in testing. It is enabled
1639 by using {\bf Device Type = vtape} in the Storage daemon's Device
1640 directive. This feature is only implemented on Linux machines and should not be
1641 used for production.
1643 \subsection{Bat Enhancements}
1644 \index[general]{Bat Enhancements}
1645 Bat (the Bacula Administration Tool) GUI program has been significantly
1646 enhanced and stabilized. In particular, there are new table based status
1647 commands; it can now be easily localized using Qt4 Linguist.
1649 The Bat communications protocol has been significantly enhanced to improve
1650 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1651 the Director you are using otherwise the communications protocol will not
1654 \subsection{RunScript Enhancements}
1655 \index[general]{RunScript Enhancements}
1656 The {\bf RunScript} resource has been enhanced to permit multiple
1657 commands per RunScript. Simply specify multiple {\bf Command} directives
1664 Command = "/bin/echo test"
1665 Command = "/bin/echo an other test"
1666 Command = "/bin/echo 3 commands in the same runscript"
1673 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1674 implemented, which runs the command after the Volume Shadow Copy has been made.
1676 Console commands can be specified within a RunScript by using:
1677 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1678 carefully tested and debugged and is known to easily crash the Director.
1679 We would appreciate feedback. Due to the recursive nature of this command, we
1680 may remove it before the final release.
1682 \subsection{Status Enhancements}
1683 \index[general]{Status Enhancements}
1684 The bconsole {\bf status dir} output has been enhanced to indicate
1685 Storage daemon job spooling and despooling activity.
1687 \subsection{Connect Timeout}
1688 \index[general]{Connect Timeout}
1689 The default connect timeout to the File
1690 daemon has been set to 3 minutes. Previously it was 30 minutes.
1692 \subsection{ftruncate for NFS Volumes}
1693 \index[general]{ftruncate for NFS Volumes}
1694 If you write to a Volume mounted by NFS (say on a local file server),
1695 in previous Bacula versions, when the Volume was recycled, it was not
1696 properly truncated because NFS does not implement ftruncate (file
1697 truncate). This is now corrected in the new version because we have
1698 written code (actually a kind user) that deletes and recreates the Volume,
1699 thus accomplishing the same thing as a truncate.
1701 \subsection{Support for Ubuntu}
1702 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1703 version of Linux, and thus now provides correct autostart routines.
1704 Since Ubuntu officially supports Bacula, you can also obtain any
1705 recent release of Bacula from the Ubuntu repositories.
1707 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1708 \index[general]{Recycle Pool}
1709 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1710 be placed (moved) when it is recycled. Without this directive, a Volume will
1711 remain in the same pool when it is recycled. With this directive, it can be
1712 moved automatically to any existing pool during a recycle. This directive is
1713 probably most useful when defined in the Scratch pool, so that volumes will
1714 be recycled back into the Scratch pool.
1716 \subsection{FD Version}
1717 \index[general]{FD Version}
1718 The File daemon to Director protocol now includes a version
1719 number, which although there is no visible change for users,
1720 will help us in future versions automatically determine
1721 if a File daemon is not compatible.
1723 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1724 \index[general]{Max Run Sched Time}
1725 The time specifies the maximum allowed time that a job may run, counted from
1726 when the job was scheduled. This can be useful to prevent jobs from running
1727 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1730 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1731 \index[general]{Max Wait Time}
1732 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1733 of checking the maximum allowed time that a job may block for a resource,
1734 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1735 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1736 their job depending on the level. Now, they have to use
1737 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1738 directives are now deprecated.
1740 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1741 \index[general]{Incremental Max Wait Time}
1742 \index[general]{Differential Max Wait Time}
1744 These directives have been deprecated in favor of
1745 \texttt{Incremental|Differential Max Run Time}.
1747 \subsection{Max Run Time directives}
1748 \index[general]{Max Run Time directives}
1749 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1750 maximum allowed time that a job can run depending on the level.
1752 \addcontentsline{lof}{figure}{Job time control directives}
1753 \includegraphics{\idir different_time.eps}
1755 \subsection{Statistics Enhancements}
1756 \index[general]{Statistics Enhancements}
1757 If you (or probably your boss) want to have statistics on your backups to
1758 provide some \textit{Service Level Agreement} indicators, you could use a few
1759 SQL queries on the Job table to report how many:
1763 \item jobs have been successful
1764 \item files have been backed up
1768 However, these statistics are accurate only if your job retention is greater
1769 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1770 be able to use them.
1772 Now, you can use the \textbf{update stats [days=num]} console command to fill
1773 the JobHistory table with new Job records. If you want to be sure to take in
1774 account only \textbf{good jobs}, ie if one of your important job has failed but
1775 you have fixed the problem and restarted it on time, you probably want to
1776 delete the first \textit{bad} job record and keep only the successful one. For
1777 that simply let your staff do the job, and update JobHistory table after two or
1778 three days depending on your organization using the \textbf{[days=num]} option.
1780 These statistics records aren't used for restoring, but mainly for
1781 capacity planning, billings, etc.
1783 The Bweb interface provides a statistics module that can use this feature. You
1784 can also use tools like Talend or extract information by yourself.
1786 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1787 the length of time that Bacula will keep statistics job records in the Catalog
1788 database after the Job End time. (In \texttt{JobHistory} table) When this time
1789 period expires, and if user runs \texttt{prune stats} command, Bacula will
1790 prune (remove) Job records that are older than the specified period.
1792 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1793 job to maintain statistics.
1796 Name = BackupCatalog
1799 Console = "update stats days=3"
1800 Console = "prune stats yes"
1807 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1808 \index[general]{ScratchPool}
1809 This directive permits to specify a specific \textsl{Scratch} pool for the
1810 current pool. This is useful when using multiple storage sharing the same
1811 mediatype or when you want to dedicate volumes to a particular set of pool.
1813 \subsection{Enhanced Attribute Despooling}
1814 \index[general]{Attribute Despooling}
1815 If the storage daemon and the Director are on the same machine, the spool file
1816 that contains attributes is read directly by the Director instead of being
1817 transmitted across the network. That should reduce load and speedup insertion.
1819 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1820 \index[general]{SpoolSize}
1821 A new Job directive permits to specify the spool size per job. This is used
1822 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1824 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1825 \index[general]{MaxConsoleConnections}
1826 A new director directive permits to specify the maximum number of Console
1827 Connections that could run concurrently. The default is set to 20, but you may
1828 set it to a larger number.
1830 \subsection{VerId = \lt{}string\gt{}}
1831 \index[general]{VerId}
1832 A new director directive permits to specify a personnal identifier that will be
1833 displayed in the \texttt{version} command.
1835 \subsection{dbcheck enhancements}
1836 \index[general]{dbcheck enhancements}
1837 If you are using Mysql, dbcheck will now ask you if you want to create
1838 temporary indexes to speed up orphaned Path and Filename elimination.
1840 A new \texttt{-B} option allows you to print catalog information in a simple
1841 text based format. This is useful to backup it in a secure way.
1856 You can now specify the database connection port in the command line.
1858 \subsection{{-}{-}docdir configure option}
1859 \index[general]{{-}{-}docdir configure option}
1860 You can use {-}{-}docdir= on the ./configure command to
1861 specify the directory where you want Bacula to install the
1862 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
1863 {\bf /usr/share/doc/bacula}.
1865 \subsection{{-}{-}htmldir configure option}
1866 \index[general]{{-}{-}htmldir configure option}
1867 You can use {-}{-}htmldir= on the ./configure command to
1868 specify the directory where you want Bacula to install the bat html help
1869 files. The default is {\bf /usr/share/doc/bacula/html}
1871 \subsection{{-}{-}with-plugindir configure option}
1872 \index[general]{{-}{-}plugindir configure option}
1873 You can use {-}{-}plugindir= on the ./configure command to
1874 specify the directory where you want Bacula to install
1875 the plugins (currently only bpipe-fd). The default is