5 \chapter{New Features in 3.0.2}
6 \label{NewFeaturesChapter}
8 This chapter presents the new features added to the development 3.0.2
9 versions to be released as Bacula version 3.0.2 sometime in 2009.
11 \section{Source Address}
12 \index[general]{Source Address}
14 A feature has been added which allows the administrator to specify the address
15 from which the director and file daemons will attempt connections from. This
16 may be used to simplify system configuration overhead when working in complex
17 networks utilizing multi-homing and policy-routing.
19 To accomplish this, two new configuration directives have been implemented:
22 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
26 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
30 Simply adding specific host routes would have an undesirable side-effect: any
31 application trying to contact the destination host would be forced to use the
32 more specific route, possibly diverting management traffic onto a backup VLAN.
33 Instead of adding host routes for each client connected to a multi-homed backup
34 server (for example where there are management and backup VLANs), one can
35 use the new directives to specify a specific source address at the application
38 Additionally, this allows the simplification and abstraction of firewall rules
39 when dealing with a Hot-Standby director or storage daemon configuration. The
40 Hot-standby pair may share a CARP address, which connections must be sourced
41 from, while system services listen and act from the unique interface addresses.
43 This project was funded by Collaborative Fusion, Inc.
45 \section{Show volume availability when doing restore}
47 When doing a restore the restore selection dialog ends by displaying this
51 The job will require the following
52 Volume(s) Storage(s) SD Device(s)
53 ===========================================================================
64 Volumes marked with ``*'' are online.
67 This should help getting large restores through minimizing the time spent
68 waiting for operator to drop by and change tapes in the library.
70 This project was funded by Bacula Systems.
72 \section{Accurate estimate command}
74 The \texttt{estimate} command can now use the accurate code to detect changes
75 and give a better estimation.
77 You can set the accurate behavior on command line using
78 \texttt{accurate=yes/no} or use the Job setting as default value.
81 * estimate listing accurate=yes level=incremental job=BackupJob
84 This project was funded by Bacula Systems.
86 \chapter{New Features in 3.0.0}
87 \label{NewFeaturesChapter}
88 \index[general]{New Features}
90 This chapter presents the new features added to the development 2.5.x
91 versions to be released as Bacula version 3.0.0 sometime in April 2009.
93 \section{Accurate Backup}
94 \index[general]{Accurate Backup}
96 As with most other backup programs, by default Bacula decides what files to
97 backup for Incremental and Differental backup by comparing the change
98 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
99 backup completed. If one of those two times is later than the last backup
100 time, then the file will be backed up. This does not, however, permit tracking
101 what files have been deleted and will miss any file with an old time that may
102 have been restored to or moved onto the client filesystem.
104 \subsection{Accurate = \lt{}yes|no\gt{}}
105 If the {\bf Accurate = \lt{}yes|no\gt{}} directive is enabled (default no) in
106 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
107 backup, there is no difference, but for {\bf Differential} and {\bf
108 Incremental} backups, the Director will send a list of all previous files
109 backed up, and the File daemon will use that list to determine if any new files
110 have been added or or moved and if any files have been deleted. This allows
111 Bacula to make an accurate backup of your system to that point in time so that
112 if you do a restore, it will restore your system exactly.
115 about using Accurate backup is that it requires more resources (CPU and memory)
116 on both the Director and the Client machines to create the list of previous
117 files backed up, to send that list to the File daemon, for the File daemon to
118 keep the list (possibly very big) in memory, and for the File daemon to do
119 comparisons between every file in the FileSet and the list. In particular,
120 if your client has lots of files (more than a few million), you will need
121 lots of memory on the client machine.
123 Accurate must not be enabled when backing up with a plugin that is not
124 specially designed to work with Accurate. If you enable it, your restores
125 will probably not work correctly.
127 This project was funded by Bacula Systems.
132 \index[general]{Copy Jobs}
134 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
135 existing Migration feature with the exception that the Job that is copied is
136 left unchanged. This essentially creates two identical copies of the same
137 backup. However, the copy is treated as a copy rather than a backup job, and
138 hence is not directly available for restore. The {\bf restore} command lists
139 copy jobs and allows selection of copies by using \texttt{jobid=}
140 option. If the keyword {\bf copies} is present on the command line, Bacula will
141 display the list of all copies for selected jobs.
146 These JobIds have copies as follows:
147 +-------+------------------------------------+-----------+------------------+
148 | JobId | Job | CopyJobId | MediaType |
149 +-------+------------------------------------+-----------+------------------+
150 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
151 +-------+------------------------------------+-----------+------------------+
152 +-------+-------+----------+----------+---------------------+------------------+
153 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
154 +-------+-------+----------+----------+---------------------+------------------+
155 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
156 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
157 +-------+-------+----------+----------+---------------------+------------------+
158 You have selected the following JobIds: 19,2
160 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
161 5,611 files inserted into the tree.
166 The Copy Job runs without using the File daemon by copying the data from the
167 old backup Volume to a different Volume in a different Pool. See the Migration
168 documentation for additional details. For copy Jobs there is a new selection
169 criterium named PoolUncopiedJobs which copies all jobs from a pool to an other
170 pool which were not copied before. Next to that the client, volume, job or sql
171 query are possible ways of selecting jobs which should be copied. Selection
172 types like smallestvolume, oldestvolume, pooloccupancy and pooltime are
173 probably more suited for migration jobs only. But we could imagine some people
174 have a valid use for those kind of copy jobs too.
176 If bacula founds a copy when a job record is purged (deleted) from the catalog,
177 it will promote the copy as \textsl{real} backup and will make it available for
178 automatic restore. If more than one copy is available, it will promote the copy
179 with the smallest jobid.
181 A nice solution which can be build with the new copy jobs is what is
182 called the disk-to-disk-to-tape backup (DTDTT). A sample config could
183 look somethings like the one below:
187 Name = FullBackupsVirtualPool
189 Purge Oldest Volume = Yes
191 NextPool = FullBackupsTapePool
195 Name = FullBackupsTapePool
199 Volume Retention = 365 days
200 Storage = superloader
204 # Fake fileset for copy jobs
216 # Fake client for copy jobs
226 # Default template for a CopyDiskToTape Job
229 Name = CopyDiskToTape
231 Messages = StandardCopy
234 Selection Type = PoolUncopiedJobs
235 Maximum Concurrent Jobs = 10
237 Allow Duplicate Jobs = Yes
238 Allow Higher Duplicates = No
239 Cancel Queued Duplicates = No
240 Cancel Running Duplicates = No
245 Name = DaySchedule7:00
246 Run = Level=Full daily at 7:00
250 Name = CopyDiskToTapeFullBackups
252 Schedule = DaySchedule7:00
253 Pool = FullBackupsVirtualPool
254 JobDefs = CopyDiskToTape
258 The example above had 2 pool which are copied using the PoolUncopiedJobs
259 selection criteria. Normal Full backups go to the Virtual pool and are copied
260 to the Tape pool the next morning.
262 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
267 +-------+------------------------------------+-----------+------------------+
268 | JobId | Job | CopyJobId | MediaType |
269 +-------+------------------------------------+-----------+------------------+
270 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
271 +-------+------------------------------------+-----------+------------------+
274 \section{ACL Updates}
275 \index[general]{ACL Updates}
276 The whole ACL code had been overhauled and in this version each platforms has
277 different streams for each type of acl available on such an platform. As ACLs
278 between platforms tend to be not that portable (most implement POSIX acls but
279 some use an other draft or a completely different format) we currently only
280 allow certain platform specific ACL streams to be decoded and restored on the
281 same platform that they were created on. The old code allowed to restore ACL
282 cross platform but the comments already mention that not being to wise. For
283 backward compatability the new code will accept the two old ACL streams and
284 handle those with the platform specific handler. But for all new backups it
285 will save the ACLs using the new streams.
287 Currently the following platforms support ACLs:
291 \item {\bf Darwin/OSX}
300 Currently we support the following ACL types (these ACL streams use a reserved
301 part of the stream numbers):
304 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
306 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
307 string representation from acl\_to\_text (POSIX acl)
308 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
309 string representation from acl\_to\_text (POSIX acl) for default acls.
310 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
311 string representation from acl\_to\_text (POSIX acl) for access acls.
312 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
313 string representation from acltostr (POSIX acl)
314 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
315 representation from acl\_to\_text (POSIX acl) for default acls.
316 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
317 representation from acl\_to\_text (POSIX acl) for access acls.
318 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
319 string representation from acl\_to\_text (POSIX acl) for default acls.
320 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
321 representation from acl\_to\_text (POSIX acl) for access acls.
322 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
323 string representation from acl\_to\_text (POSIX acl) for default acls.
324 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
325 string representation from acl\_to\_text (POSIX acl) for default acls.
326 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
327 representation from acl\_to\_text (POSIX acl) for access acls.
328 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
329 string representation from acltotext or acl\_totext (POSIX acl)
330 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
331 representation from from acl\_totext (NFSv4 or ZFS acl)
334 In future versions we might support conversion functions from one type of acl
335 into an other for types that are either the same or easily convertable. For now
336 the streams are seperate and restoring them on a platform that doesn't
337 recognize them will give you a warning.
339 \section{Extended Attributes}
340 \index[general]{Extended Attributes}
341 Something that was on the project list for some time is now implemented for
342 platforms that support a similar kind of interface. Its the support for backup
343 and restore of so called extended attributes. As extended attributes are so
344 platform specific these attributes are saved in seperate streams for each
345 platform. Restores of the extended attributes can only be performed on the
346 same platform the backup was done. There is support for all types of extended
347 attributes, but restoring from one type of filesystem onto an other type of
348 filesystem on the same platform may lead to supprises. As extended attributes
349 can contain any type of data they are stored as a series of so called
350 value-pairs. This data must be seen as mostly binary and is stored as such.
351 As security labels from selinux are also extended attributes this option also
352 stores those labels and no specific code is enabled for handling selinux
355 Currently the following platforms support extended attributes:
357 \item {\bf Darwin/OSX}
363 On linux acls are also extended attributes, as such when you enable ACLs on a
364 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
365 and not the same exteneded attribute.
367 To enable the backup of extended attributes please add the following to your
382 \section{Shared objects}
383 \index[general]{Shared objects}
384 A default build of Bacula will now create the libraries as shared objects
385 (.so) rather than static libraries as was previously the case.
386 The shared libraries are built using {\bf libtool} so it should be quite
389 An important advantage of using shared objects is that on a machine with the
390 Directory, File daemon, the Storage daemon, and a console, you will have only
391 one copy of the code in memory rather than four copies. Also the total size of
392 the binary release is smaller since the library code appears only once rather
393 than once for every program that uses it; this results in significant reduction
394 in the size of the binaries particularly for the utility tools.
396 In order for the system loader to find the shared objects when loading the
397 Bacula binaries, the Bacula shared objects must either be in a shared object
398 directory known to the loader (typically /usr/lib) or they must be in the
399 directory that may be specified on the {\bf ./configure} line using the {\bf
400 {-}{-}libdir} option as:
403 ./configure --libdir=/full-path/dir
406 the default is /usr/lib. If {-}{-}libdir is specified, there should be
407 no need to modify your loader configuration provided that
408 the shared objects are installed in that directory (Bacula
409 does this with the make install command). The shared objects
410 that Bacula references are:
419 These files are symbolically linked to the real shared object file,
420 which has a version number to permit running multiple versions of
421 the libraries if desired (not normally the case).
423 If you have problems with libtool or you wish to use the old
424 way of building static libraries, or you want to build a static
425 version of Bacula you may disable
426 libtool on the configure command line with:
429 ./configure --disable-libtool
433 \section{Building Static versions of Bacula}
434 \index[general]{Static linking}
435 In order to build static versions of Bacula, in addition
436 to configuration options that were needed you now must
437 also add --disable-libtool. Example
440 ./configure --enable-static-client-only --disable-libtool
444 \section{Virtual Backup (Vbackup)}
445 \index[general]{Virtual Backup}
446 \index[general]{Vbackup}
448 Bacula's virtual backup feature is often called Synthetic Backup or
449 Consolidation in other backup products. It permits you to consolidate the
450 previous Full backup plus the most recent Differential backup and any
451 subsequent Incremental backups into a new Full backup. This new Full
452 backup will then be considered as the most recent Full for any future
453 Incremental or Differential backups. The VirtualFull backup is
454 accomplished without contacting the client by reading the previous backup
455 data and writing it to a volume in a different pool.
457 In some respects the Vbackup feature works similar to a Migration job, in
458 that Bacula normally reads the data from the pool specified in the
459 Job resource, and writes it to the {\bf Next Pool} specified in the
460 Job resource. Note, this means that usually the output from the Virtual
461 Backup is written into a different pool from where your prior backups
462 are saved. Doing it this way guarantees that you will not get a deadlock
463 situation attempting to read and write to the same volume in the Storage
464 daemon. If you then want to do subsequent backups, you may need to
465 move the Virtual Full Volume back to your normal backup pool.
466 Alternatively, you can set your {\bf Next Pool} to point to the current
467 pool. This will cause Bacula to read and write to Volumes in the
468 current pool. In general, this will work, because Bacula will
469 not allow reading and writing on the same Volume. In any case, once
470 a VirtualFull has been created, and a restore is done involving the
471 most current Full, it will read the Volume or Volumes by the VirtualFull
472 regardless of in which Pool the Volume is found.
474 The Vbackup is enabled on a Job by Job in the Job resource by specifying
475 a level of {\bf VirtualFull}.
477 A typical Job resource definition might look like the following:
491 # Default pool definition
495 Recycle = yes # Automatically recycle Volumes
496 AutoPrune = yes # Prune expired volumes
497 Volume Retention = 365d # one year
505 Recycle = yes # Automatically recycle Volumes
506 AutoPrune = yes # Prune expired volumes
507 Volume Retention = 365d # one year
508 Storage = DiskChanger
511 # Definition of file storage device
518 Maximum Concurrent Jobs = 5
521 # Definition of DDS Virtual tape disk storage device
524 Address = localhost # N.B. Use a fully qualified name here
527 Media Type = DiskChangerMedia
528 Maximum Concurrent Jobs = 4
533 Then in bconsole or via a Run schedule, you would run the job as:
536 run job=MyBackup level=Full
537 run job=MyBackup level=Incremental
538 run job=MyBackup level=Differential
539 run job=MyBackup level=Incremental
540 run job=MyBackup level=Incremental
543 So providing there were changes between each of those jobs, you would end up
544 with a Full backup, a Differential, which includes the first Incremental
545 backup, then two Incremental backups. All the above jobs would be written to
546 the {\bf Default} pool.
548 To consolidate those backups into a new Full backup, you would run the
552 run job=MyBackup level=VirtualFull
555 And it would produce a new Full backup without using the client, and the output
556 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
558 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
561 Note, the Start and End time of the Virtual Full backup is set to the
562 values for the last job included in the Virtual Full (in the above example,
563 it is an Increment). This is so that if another incremental is done, which
564 will be based on the Virtual Full, it will backup all files from the
565 last Job included in the Virtual Full rather than from the time the Virtual
566 Full was actually run.
570 \section{Catalog Format}
571 \index[general]{Catalog Format}
572 Bacula 3.0 comes with some changes to the catalog format. The upgrade
573 operation will convert the FileId field of the File table from 32 bits (max 4
574 billion table entries) to 64 bits (very large number of items). The
575 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
576 your catalog during the conversion. Also you won't be able to run jobs during
577 this conversion period. For example, a 3 million file catalog will take 2
578 minutes to upgrade on a normal machine. Please don't forget to make a valid
579 backup of your database before executing the upgrade script. See the
580 ReleaseNotes for additional details.
582 \section{64 bit Windows Client}
583 \index[general]{Win64 Client}
584 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
585 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
586 As a consequence, we are also releasing a 64 bit version of the Bacula
587 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
588 These binaries should only be installed on 64 bit Windows operating systems.
589 What is important is not your hardware but whether or not you have
590 a 64 bit version of the Windows OS.
592 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
594 \item Before installing the Win64 Bacula Client, you must totally
595 deinstall any prior 2.4.x Client installation using the
596 Bacula deinstallation (see the menu item). You may want
597 to save your .conf files first.
598 \item Only the Client (File daemon) is ported to Win64, the Director
599 and the Storage daemon are not in the 64 bit Windows installer.
600 \item bwx-console is not yet ported.
601 \item bconsole is ported but it has not been tested.
602 \item The documentation is not included in the installer.
603 \item Due to Vista security restrictions imposed on a default installation
604 of Vista, before upgrading the Client, you must manually stop
605 any prior version of Bacula from running, otherwise the install
607 \item Due to Vista security restrictions imposed on a default installation
608 of Vista, attempting to edit the conf files via the menu items
609 will fail. You must directly edit the files with appropriate
610 permissions. Generally double clicking on the appropriate .conf
611 file will work providing you have sufficient permissions.
612 \item All Bacula files are now installed in
613 {\bf C:/Program Files/Bacula} except the main menu items,
614 which are installed as before. This vastly simplifies the installation.
615 \item If you are running on a foreign language version of Windows, most
616 likely {\bf C:/Program Files} does not exist, so you should use the
617 Custom installation and enter an appropriate location to install
619 \item The 3.0.0 Win32 Client continues to install files in the locations used
620 by prior versions. For the next version we will convert it to use
621 the same installation conventions as the Win64 version.
624 This project was funded by Bacula Systems.
627 \section{Duplicate Job Control}
628 \index[general]{Duplicate Jobs}
629 The new version of Bacula provides four new directives that
630 give additional control over what Bacula does if duplicate jobs
631 are started. A duplicate job in the sense we use it here means
632 a second or subsequent job with the same name starts. This
633 happens most frequently when the first job runs longer than expected because no
636 The four directives each take as an argument a {\bf yes} or {\bf no} value and
637 are specified in the Job resource.
641 \subsection{Allow Duplicate Jobs = \lt{}yes|no\gt{}}
642 \index[general]{Allow Duplicate Jobs}
643 If this directive is enabled duplicate jobs will be run. If
644 the directive is set to {\bf no} (default) then only one job of a given name
645 may run at one time, and the action that Bacula takes to ensure only
646 one job runs is determined by the other directives (see below).
648 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
649 are present and none of the three directives given below permit
650 cancelling a job, then the current job (the second one started)
654 \subsection{Allow Higher Duplicates = \lt{}yes|no\gt{}}
655 \index[general]{Allow Higher Duplicates}
656 If this directive is set to {\bf yes} (default) the job with a higher
657 priority (lower priority number) will be permitted to run, and
658 the current job will be cancelled. If the
659 priorities of the two jobs are the same, the outcome is determined by
660 other directives (see below).
662 \subsection{Cancel Queued Duplicates = \lt{}yes|no\gt{}}
663 \index[general]{Cancel Queued Duplicates}
664 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
665 if this directive is set to {\bf yes} any job that is
666 already queued to run but not yet running will be canceled.
667 The default is {\bf no}.
669 \subsection{Cancel Running Duplicates = \lt{}yes|no\gt{}}
670 \index[general]{Cancel Running Duplicates}
671 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
672 if this directive is set to {\bf yes} any job that is already running
673 will be canceled. The default is {\bf no}.
676 \section{TLS Authentication}
677 \index[general]{TLS Authentication}
678 In Bacula version 2.5.x and later, in addition to the normal Bacula
679 CRAM-MD5 authentication that is used to authenticate each Bacula
680 connection, you can specify that you want TLS Authentication as well,
681 which will provide more secure authentication.
683 This new feature uses Bacula's existing TLS code (normally used for
684 communications encryption) to do authentication. To use it, you must
685 specify all the TLS directives normally used to enable communications
686 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
689 \subsection{TLS Authenticate = yes}
691 TLS Authenticate = yes
694 in the main daemon configuration resource (Director for the Director,
695 Client for the File daemon, and Storage for the Storage daemon).
697 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
698 authentication, Bacula will also do TLS authentication, then TLS
699 encryption will be turned off, and the rest of the communication between
700 the two Bacula daemons will be done without encryption.
702 If you want to encrypt communications data, use the normal TLS directives
703 but do not turn on {\bf TLS Authenticate}.
705 \section{bextract non-portable Win32 data}
706 \index[general]{bextract handles Win32 non-portable data}
707 {\bf bextract} has been enhanced to be able to restore
708 non-portable Win32 data to any OS. Previous versions were
709 unable to restore non-portable Win32 data to machines that
710 did not have the Win32 BackupRead and BackupWrite API calls.
712 \section{State File updated at Job Termination}
713 \index[general]{State File}
714 In previous versions of Bacula, the state file, which provides a
715 summary of previous jobs run in the {\bf status} command output was
716 updated only when Bacula terminated, thus if the daemon crashed, the
717 state file might not contain all the run data. This version of
718 the Bacula daemons updates the state file on each job termination.
720 \section{MaxFullInterval = \lt{}time-interval\gt{}}
721 \index[general]{MaxFullInterval}
722 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
723 can be used to specify the maximum time interval between {\bf Full} backup
724 jobs. When a job starts, if the time since the last Full backup is
725 greater than the specified interval, and the job would normally be an
726 {\bf Incremental} or {\bf Differential}, it will be automatically
727 upgraded to a {\bf Full} backup.
729 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
730 \index[general]{MaxDiffInterval}
731 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
732 can be used to specify the maximum time interval between {\bf Differential} backup
733 jobs. When a job starts, if the time since the last Differential backup is
734 greater than the specified interval, and the job would normally be an
735 {\bf Incremental}, it will be automatically
736 upgraded to a {\bf Differential} backup.
738 \section{Honor No Dump Flag = \lt{}yes|no\gt{}}
739 \index[general]{MaxDiffInterval}
740 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
741 by the user, and when it is set it is an indication to backup programs
742 to not backup that particular file. This version of Bacula contains a
743 new Options directive within a FileSet resource, which instructs Bacula to
744 obey this flag. The new directive is:
747 Honor No Dump Flag = yes|no
750 The default value is {\bf no}.
753 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
754 \index[general]{IgnoreDir}
755 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
756 can be added to the Include section of the FileSet resource. If the specified
757 filename ({\bf filename-string}) is found on the Client in any directory to be
758 backed up, the whole directory will be ignored (not backed up). For example:
761 # List of files to be backed up
769 Exclude Dir Containing = .excludeme
774 But in /home, there may be hundreds of directories of users and some
775 people want to indicate that they don't want to have certain
776 directories backed up. For example, with the above FileSet, if
777 the user or sysadmin creates a file named {\bf .excludeme} in
778 specific directories, such as
781 /home/user/www/cache/.excludeme
782 /home/user/temp/.excludeme
785 then Bacula will not backup the two directories named:
792 NOTE: subdirectories will not be backed up. That is, the directive
793 applies to the two directories in question and any children (be they
794 files, directories, etc).
797 \section{Bacula Plugins}
798 \index[general]{Plugin}
799 Support for shared object plugins has been implemented in the Linux, Unix
800 and Win32 File daemons. The API will be documented separately in
801 the Developer's Guide or in a new document. For the moment, there is
802 a single plugin named {\bf bpipe} that allows an external program to
803 get control to backup and restore a file.
805 Plugins are also planned (partially implemented) in the Director and the
808 \subsection{Plugin Directory}
809 \index[general]{Plugin Directory}
810 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
811 be added to the daemon definition resource. The directory takes a quoted
812 string argument, which is the name of the directory in which the daemon can
813 find the Bacula plugins. If this directive is not specified, Bacula will not
814 load any plugins. Since each plugin has a distinctive name, all the daemons
815 can share the same plugin directory.
817 \subsection{Plugin Options}
818 \index[general]{Plugin Options}
819 The {\bf Plugin Options} directive takes a quoted string
820 arguement (after the equal sign) and may be specified in the
821 Job resource. The options specified will be passed to all plugins
822 when they are run. This each plugin must know what it is looking
823 for. The value defined in the Job resource can be modified
824 by the user when he runs a Job via the {\bf bconsole} command line
827 Note: this directive may be specified, and there is code to modify
828 the string in the run command, but the plugin options are not yet passed to
829 the plugin (i.e. not fully implemented).
831 \subsection{Plugin Options ACL}
832 \index[general]{Plugin Options ACL}
833 The {\bf Plugin Options ACL} directive may be specified in the
834 Director's Console resource. It functions as all the other ACL commands
835 do by permitting users running restricted consoles to specify a
836 {\bf Plugin Options} that overrides the one specified in the Job
837 definition. Without this directive restricted consoles may not modify
840 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
841 \index[general]{Plugin}
842 The {\bf Plugin} directive is specified in the Include section of
843 a FileSet resource where you put your {\bf File = xxx} directives.
859 In the above example, when the File daemon is processing the directives
860 in the Include section, it will first backup all the files in {\bf /home}
861 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
862 the Plugin Directory. The syntax and semantics of the Plugin directive
863 require the first part of the string up to the colon (:) to be the name
864 of the plugin. Everything after the first colon is ignored by the File daemon but
865 is passed to the plugin. Thus the plugin writer may define the meaning of the
866 rest of the string as he wishes.
868 Please see the next section for information about the {\bf bpipe} Bacula
871 \section{The bpipe Plugin}
872 \index[general]{The bpipe Plugin}
873 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
874 the Bacula source distribution. When the plugin is compiled and linking into
875 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
877 The purpose of the plugin is to provide an interface to any system program for
878 backup and restore. As specified above the {\bf bpipe} plugin is specified in
879 the Include section of your Job's FileSet resource. The full syntax of the
880 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
881 to specify the sytax as it wishes) is:
884 Plugin = "<field1>:<field2>:<field3>:<field4>"
889 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
890 stripped off, so in this case, we would put {\bf bpipe} in this field.
892 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
893 pseudo path and filename under which the backup will be saved. This pseudo
894 path and filename will be seen by the user in the restore file tree.
895 For example, if the value is {\bf /MYSQL/regress.sql}, the data
896 backed up by the plugin will be put under that "pseudo" path and filename.
897 You must be careful to choose a naming convention that is unique to avoid
898 a conflict with a path and filename that actually exists on your system.
900 \item {\bf field3} for the {\bf bpipe} plugin
901 specifies the "reader" program that is called by the plugin during
902 backup to read the data. {\bf bpipe} will call this program by doing a
905 \item {\bf field4} for the {\bf bpipe} plugin
906 specifies the "writer" program that is called by the plugin during
907 restore to write the data back to the filesystem.
910 Putting it all together, the full plugin directive line might look
914 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
915 --opt --databases bacula:mysql"
918 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
919 would be written on a single line.
921 This causes the File daemon to call the {\bf bpipe} plugin, which will write
922 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
923 program {\bf mysqldump -f --opt --database bacula} to read the data during
924 backup. The mysqldump command outputs all the data for the database named
925 {\bf bacula}, which will be read by the plugin and stored in the backup.
926 During restore, the data that was backed up will be sent to the program
927 specified in the last field, which in this case is {\bf mysql}. When
928 {\bf mysql} is called, it will read the data sent to it by the plugn
929 then write it back to the same database from which it came ({\bf bacula}
932 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
933 the data from a specified program to Bacula for backup, and then from Bacula to
934 a specified program for restore.
936 By using different command lines to {\bf bpipe},
937 you can backup any kind of data (ASCII or binary) depending
938 on the program called.
940 \section{Microsoft Exchange Server 2003/2007 Plugin}
941 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
942 \subsection{Background}
943 The Exchange plugin was made possible by a funded development project
944 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
945 The code for the plugin was written by James Harper, and the Bacula core
946 code by Kern Sibbald. All the code for this funded development has become
947 part of the Bacula project. Thanks to everyone who made it happen.
949 \subsection{Concepts}
950 Although it is possible to backup Exchange using Bacula VSS the Exchange
951 plugin adds a good deal of functionality, because while Bacula VSS
952 completes a full backup (snapshot) of Exchange, it does
953 not support Incremental or Differential backups, restoring is more
954 complicated, and a single database restore is not possible.
956 Microsoft Exchange organises its storage into Storage Groups with
957 Databases inside them. A default installation of Exchange will have a
958 single Storage Group called 'First Storage Group', with two Databases
959 inside it, "Mailbox Store (SERVER NAME)" and
960 "Public Folder Store (SERVER NAME)",
961 which hold user email and public folders respectively.
963 In the default configuration, Exchange logs everything that happens to
964 log files, such that if you have a backup, and all the log files since,
965 you can restore to the present time. Each Storage Group has its own set
966 of log files and operates independently of any other Storage Groups. At
967 the Storage Group level, the logging can be turned off by enabling a
968 function called "Enable circular logging". At this time the Exchange
969 plugin will not function if this option is enabled.
971 The plugin allows backing up of entire storage groups, and the restoring
972 of entire storage groups or individual databases. Backing up and
973 restoring at the individual mailbox or email item is not supported but
974 can be simulated by use of the "Recovery" Storage Group (see below).
976 \subsection{Installing}
977 The Exchange plugin requires a DLL that is shipped with Microsoft
978 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
979 correctly the Exchange plugin should find this automatically and run
980 without any additional installation.
982 If the DLL can not be found automatically it will need to be copied into
983 the Bacula installation
984 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
985 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
986 default Exchange installation.
988 \subsection{Backup up}
989 To back up an Exchange server the Fileset definition must contain at
990 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
991 the backup to work correctly. The 'exchange:' bit tells Bacula to look
992 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
993 up files are prefixed with something that isn't going to share a name
994 with something outside the plugin, and the 'Microsoft Information Store'
995 bit is required also. It is also possible to add the name of a storage
996 group to the "Plugin =" line, eg \\
997 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
998 if you want only a single storage group backed up.
1000 Additionally, you can suffix the 'Plugin =' directive with
1001 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1002 database at the end of a full backup.
1004 An Incremental or Differential backup will backup only the database logs
1005 for each Storage Group by inspecting the "modified date" on each
1006 physical log file. Because of the way the Exchange API works, the last
1007 logfile backed up on each backup will always be backed up by the next
1008 Incremental or Differential backup too. This adds 5MB to each
1009 Incremental or Differential backup size but otherwise does not cause any
1012 By default, a normal VSS fileset containing all the drive letters will
1013 also back up the Exchange databases using VSS. This will interfere with
1014 the plugin and Exchange's shared ideas of when the last full backup was
1015 done, and may also truncate log files incorrectly. It is important,
1016 therefore, that the Exchange database files be excluded from the backup,
1017 although the folders the files are in should be included, or they will
1018 have to be recreated manually if a baremetal restore is done.
1023 File = C:/Program Files/Exchsrvr/mdbdata
1024 Plugin = "exchange:..."
1027 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1028 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1029 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1030 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1031 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1032 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1033 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1038 The advantage of excluding the above files is that you can significantly
1039 reduce the size of your backup since all the important Exchange files
1040 will be properly saved by the Plugin.
1043 \subsection{Restoring}
1044 The restore operation is much the same as a normal Bacula restore, with
1045 the following provisos:
1048 \item The {\bf Where} restore option must not be specified
1049 \item Each Database directory must be marked as a whole. You cannot just
1050 select (say) the .edb file and not the others.
1051 \item If a Storage Group is restored, the directory of the Storage Group
1053 \item It is possible to restore only a subset of the available log files,
1054 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1055 if a log file is missing from the sequence of log files
1056 \item Each database to be restored must be dismounted and marked as "Can be
1057 overwritten by restore"
1058 \item If an entire Storage Group is to be restored (eg all databases and
1059 logs in the Storage Group), then it is best to manually delete the
1060 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1061 as Exchange can get confused by stray log files lying around.
1064 \subsection{Restoring to the Recovery Storage Group}
1065 The concept of the Recovery Storage Group is well documented by
1067 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1068 but to briefly summarize...
1070 Microsoft Exchange allows the creation of an additional Storage Group
1071 called the Recovery Storage Group, which is used to restore an older
1072 copy of a database (e.g. before a mailbox was deleted) into without
1073 messing with the current live data. This is required as the Standard and
1074 Small Business Server versions of Exchange can not ordinarily have more
1075 than one Storage Group.
1077 To create the Recovery Storage Group, drill down to the Server in Exchange
1078 System Manager, right click, and select
1079 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1080 locations and click OK. On the Recovery Storage Group, right click and
1081 select {\bf "Add Database to Recover..."} and select the database you will
1084 Restore only the single database nominated as the database in the
1085 Recovery Storage Group. Exchange will redirect the restore to the
1086 Recovery Storage Group automatically.
1087 Then run the restore.
1089 \subsection{Restoring on Microsoft Server 2007}
1090 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1091 2007, and henc you use a new proceedure for recovering a single mail box.
1092 This procedure is ducomented by Microsoft at:
1093 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1094 and involves using the {\bf Restore-Mailbox} and {\bf
1095 Get-MailboxStatistics} shell commands.
1097 \subsection{Caveats}
1098 This plugin is still being developed, so you should consider it
1099 currently in BETA test, and thus use in a production environment
1100 should be done only after very careful testing.
1102 When doing a full backup, the Exchange database logs are truncated by
1103 Exchange as soon as the plugin has completed the backup. If the data
1104 never makes it to the backup medium (eg because of spooling) then the
1105 logs will still be truncated, but they will also not have been backed
1106 up. A solution to this is being worked on. You will have to schedule a
1107 new Full backup to ensure that your next backups will be usable.
1109 The "Enable Circular Logging" option cannot be enabled or the plugin
1112 Exchange insists that a successful Full backup must have taken place if
1113 an Incremental or Differential backup is desired, and the plugin will
1114 fail if this is not the case. If a restore is done, Exchange will
1115 require that a Full backup be done before an Incremental or Differential
1118 The plugin will most likely not work well if another backup application
1119 (eg NTBACKUP) is backing up the Exchange database, especially if the
1120 other backup application is truncating the log files.
1122 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1123 we recommend either carefully testing or that you avoid this option for
1126 The Exchange plugin is not called during processing the bconsole {\bf
1127 estimate} command, and so anything that would be backed up by the plugin
1128 will not be added to the estimate total that is displayed.
1131 \section{libdbi Framework}
1132 \index[general]{libdbi Framework}
1133 As a general guideline, Bacula has support for a few catalog database drivers
1134 (MySQL, PostgreSQL, SQLite)
1135 coded natively by the Bacula team. With the libdbi implementation, which is a
1136 Bacula driver that uses libdbi to access the catalog, we have an open field to
1137 use many different kinds database engines following the needs of users.
1139 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1140 implements a database-independent abstraction layer in C, similar to the
1141 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1142 leverage the power of multiple databases and multiple simultaneous database
1143 connections by using this framework.
1145 Currently the libdbi driver in Bacula project only supports the same drivers
1146 natively coded in Bacula. However the libdbi project has support for many
1147 others database engines. You can view the list at
1148 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1149 supported by Bacula, however, they must be tested properly by the Bacula team.
1151 Some of benefits of using libdbi are:
1153 \item The possibility to use proprietary databases engines in which your
1154 proprietary licenses prevent the Bacula team from developing the driver.
1155 \item The possibility to use the drivers written for the libdbi project.
1156 \item The possibility to use other database engines without recompiling Bacula
1157 to use them. Just change one line in bacula-dir.conf
1158 \item Abstract Database access, this is, unique point to code and profiling
1159 catalog database access.
1162 The following drivers have been tested:
1164 \item PostgreSQL, with and without batch insert
1165 \item Mysql, with and without batch insert
1170 In the future, we will test and approve to use others databases engines
1171 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1173 To compile Bacula to support libdbi we need to configure the code with the
1174 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1175 [database] is the database engine to be used with Bacula (of course we can
1176 change the driver in file bacula-dir.conf, see below). We must configure the
1177 access port of the database engine with the option --with-db-port, because the
1178 libdbi framework doesn't know the default access port of each database.
1180 The next phase is checking (or configuring) the bacula-dir.conf, example:
1184 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1185 dbname = regress; user = regress; password = ""
1189 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1190 mysql database. Currently the drivers supported by Bacula are: postgresql,
1191 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1193 The following limitations apply when Bacula is set to use the libdbi framework:
1194 - Not tested on the Win32 platform
1195 - A little performance is lost if comparing with native database driver.
1196 The reason is bound with the database driver provided by libdbi and the
1197 simple fact that one more layer of code was added.
1199 It is important to remember, when compiling Bacula with libdbi, the
1200 following packages are needed:
1202 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1203 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1206 You can download them and compile them on your system or install the packages
1207 from your OS distribution.
1209 \section{Console Command Additions and Enhancements}
1210 \index[general]{Console Additions}
1212 \subsection{Display Autochanger Content}
1213 \index[general]{StatusSlots}
1215 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1216 autochanger content.
1220 Slot | Volume Name | Status | Media Type | Pool |
1221 ------+---------------+----------+-------------------+------------|
1222 1 | 00001 | Append | DiskChangerMedia | Default |
1223 2 | 00002 | Append | DiskChangerMedia | Default |
1224 3*| 00003 | Append | DiskChangerMedia | Scratch |
1229 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1230 {\bf update slots} command to synchronize autochanger content with your
1233 \subsection{list joblog job=xxx or jobid=nnn}
1234 \index[general]{list joblog}
1235 A new list command has been added that allows you to list the contents
1236 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1237 or for a particular JobId. The {\bf llist} command will include a line with
1238 the time and date of the entry.
1240 Note for the catalog to have Job Log entries, you must have a directive
1247 In your Director's {\bf Messages} resource.
1249 \subsection{Use separator for multiple commands}
1250 \index[general]{Command Separator}
1251 When using bconsole with readline, you can set the command separator with
1252 \textbf{@separator} command to one
1253 of those characters to write commands who require multiple input in one line.
1255 !$%&'()*+,-/:;<>?[]^`{|}~
1258 \subsection{Deleting Volumes}
1259 The delete volume bconsole command has been modified to
1260 require an asterisk (*) in front of a MediaId otherwise the
1261 value you enter is a taken to be a Volume name. This is so that
1262 users may delete numeric Volume names. The previous Bacula versions
1263 assumed that all input that started with a number was a MediaId.
1265 This new behavior is indicated in the prompt if you read it
1268 \section{Bare Metal Recovery}
1269 The old bare metal recovery project is essentially dead. One
1270 of the main features of it was that it would build a recovery
1271 CD based on the kernel on your system. The problem was that
1272 every distribution has a different boot procedure and different
1273 scripts, and worse yet, the boot procedures and scripts change
1274 from one distribution to another. This meant that maintaining
1275 (keeping up with the changes) the rescue CD was too much work.
1277 To replace it, a new bare metal recovery USB boot stick has been developed
1278 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1279 boot from a USB key.
1283 \item Recovery can be done from within graphical environment.
1284 \item Recovery can be done in a shell.
1285 \item Ubuntu boots on a large number of Linux systems.
1286 \item The process of updating the system and adding new
1287 packages is not too difficult.
1288 \item The USB key can easily be upgraded to newer Ubuntu versions.
1289 \item The USB key has writable partitions for modifications to
1290 the OS and for modification to your home directory.
1291 \item You can add new files/directories to the USB key very easily.
1292 \item You can save the environment from multiple machines on
1294 \item Bacula Systems is funding its ongoing development.
1297 The disadvantages are:
1299 \item The USB key is usable but currently under development.
1300 \item Not everyone may be familiar with Ubuntu (no worse
1302 \item Some older OSes cannot be booted from USB. This can
1303 be resolved by first booting a Ubuntu LiveCD then plugging
1305 \item Currently the documentation is sketchy and not yet added
1306 to the main manual. See below ...
1309 The documentation and the code can be found in the {\bf rescue} package
1310 in the directory {\bf linux/usb}.
1312 \section{Miscellaneous}
1313 \index[general]{Misc New Features}
1315 \subsection{Allow Mixed Priority = \lt{}yes|no\gt{}}
1316 \index[general]{Allow Mixed Priority}
1317 This directive is only implemented in version 2.5 and later. When
1318 set to {\bf yes} (default {\bf no}), this job may run even if lower
1319 priority jobs are already running. This means a high priority job
1320 will not have to wait for other jobs to finish before starting.
1321 The scheduler will only mix priorities when all running jobs have
1324 Note that only higher priority jobs will start early. Suppose the
1325 director will allow two concurrent jobs, and that two jobs with
1326 priority 10 are running, with two more in the queue. If a job with
1327 priority 5 is added to the queue, it will be run as soon as one of
1328 the running jobs finishes. However, new priority 10 jobs will not
1329 be run until the priority 5 job has finished.
1331 \subsection{Bootstrap File Directive -- FileRegex}
1332 \index[general]{Bootstrap File Directive}
1333 {\bf FileRegex} is a new command that can be added to the bootstrap
1334 (.bsr) file. The value is a regular expression. When specified, only
1335 matching filenames will be restored.
1337 During a restore, if all File records are pruned from the catalog
1338 for a Job, normally Bacula can restore only all files saved. That
1339 is there is no way using the catalog to select individual files.
1340 With this new feature, Bacula will ask if you want to specify a Regex
1341 expression for extracting only a part of the full backup.
1344 Building directory tree for JobId(s) 1,3 ...
1345 There were no files inserted into the tree, so file selection
1346 is not possible.Most likely your retention policy pruned the files
1348 Do you want to restore all the files? (yes|no): no
1350 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1351 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1354 \subsection{Bootstrap File Optimization Changes}
1355 In order to permit proper seeking on disk files, we have extended the bootstrap
1356 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1357 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1358 address range and end address range respectively. These two directives replace
1359 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1360 VolEndBlock} directives. Bootstrap files containing the old directives will
1361 still work, but will not properly take advantage of proper disk seeking, and
1362 may read completely to the end of a disk volume during a restore. With the new
1363 format (automatically generated by the new Director), restores will seek
1364 properly and stop reading the volume when all the files have been restored.
1366 \subsection{Solaris ZFS/NFSv4 ACLs}
1367 This is an upgrade of the previous Solaris ACL backup code
1368 to the new library format, which will backup both the old
1369 POSIX(UFS) ACLs as well as the ZFS ACLs.
1371 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1372 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1373 be used to transfer from UFS to ZFS filesystems.
1376 \subsection{Virtual Tape Emulation}
1377 \index[general]{Virtual Tape Emulation}
1378 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1379 the tape code but actually reading and writing to a disk file. Used with the
1380 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1381 and 700 slots. This feature is most useful in testing. It is enabled
1382 by using {\bf Device Type = vtape} in the Storage daemon's Device
1383 directive. This feature is only implemented on Linux machines and should not be
1384 used for production.
1386 \subsection{Bat Enhancements}
1387 \index[general]{Bat Enhancements}
1388 Bat (the Bacula Administration Tool) GUI program has been significantly
1389 enhanced and stabilized. In particular, there are new table based status
1390 commands; it can now be easily localized using Qt4 Linguist.
1392 The Bat communications protocol has been significantly enhanced to improve
1393 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1394 the Director you are using otherwise the communications protocol will not
1397 \subsection{RunScript Enhancements}
1398 \index[general]{RunScript Enhancements}
1399 The {\bf RunScript} resource has been enhanced to permit multiple
1400 commands per RunScript. Simply specify multiple {\bf Command} directives
1407 Command = "/bin/echo test"
1408 Command = "/bin/echo an other test"
1409 Command = "/bin/echo 3 commands in the same runscript"
1416 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1417 implemented, which runs the command after the Volume Shadow Copy has been made.
1419 Console commands can be specified within a RunScript by using:
1420 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1421 carefully tested and debugged and is known to easily crash the Director.
1422 We would appreciate feedback. Due to the recursive nature of this command, we
1423 may remove it before the final release.
1425 \subsection{Status Enhancements}
1426 \index[general]{Status Enhancements}
1427 The bconsole {\bf status dir} output has been enhanced to indicate
1428 Storage daemon job spooling and despooling activity.
1430 \subsection{Connect Timeout}
1431 \index[general]{Connect Timeout}
1432 The default connect timeout to the File
1433 daemon has been set to 3 minutes. Previously it was 30 minutes.
1435 \subsection{ftruncate for NFS Volumes}
1436 \index[general]{ftruncate for NFS Volumes}
1437 If you write to a Volume mounted by NFS (say on a local file server),
1438 in previous Bacula versions, when the Volume was recycled, it was not
1439 properly truncated because NFS does not implement ftruncate (file
1440 truncate). This is now corrected in the new version because we have
1441 written code (actually a kind user) that deletes and recreates the Volume,
1442 thus accomplishing the same thing as a truncate.
1444 \subsection{Support for Ubuntu}
1445 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1446 version of Linux, and thus now provides correct autostart routines.
1447 Since Ubuntu officially supports Bacula, you can also obtain any
1448 recent release of Bacula from the Ubuntu repositories.
1450 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1451 \index[general]{Recycle Pool}
1452 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1453 be placed (moved) when it is recycled. Without this directive, a Volume will
1454 remain in the same pool when it is recycled. With this directive, it can be
1455 moved automatically to any existing pool during a recycle. This directive is
1456 probably most useful when defined in the Scratch pool, so that volumes will
1457 be recycled back into the Scratch pool.
1459 \subsection{FD Version}
1460 \index[general]{FD Version}
1461 The File daemon to Director protocol now includes a version
1462 number, which although there is no visible change for users,
1463 will help us in future versions automatically determine
1464 if a File daemon is not compatible.
1466 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1467 \index[general]{Max Run Sched Time}
1468 The time specifies the maximum allowed time that a job may run, counted from
1469 when the job was scheduled. This can be useful to prevent jobs from running
1470 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1473 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1474 \index[general]{Max Wait Time}
1475 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1476 of checking the maximum allowed time that a job may block for a resource,
1477 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1478 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1479 their job depending on the level. Now, they have to use
1480 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1481 directives are now deprecated.
1483 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1484 \index[general]{Incremental Max Wait Time}
1485 \index[general]{Differential Max Wait Time}
1487 These directives have been deprecated in favor of
1488 \texttt{Incremental|Differential Max Run Time}.
1490 \subsection{Max Run Time directives}
1491 \index[general]{Max Run Time directives}
1492 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1493 maximum allowed time that a job can run depending on the level.
1495 \addcontentsline{lof}{figure}{Job time control directives}
1496 \includegraphics{\idir different_time.eps}
1498 \subsection{Statistics Enhancements}
1499 \index[general]{Statistics Enhancements}
1500 If you (or probably your boss) want to have statistics on your backups to
1501 provide some \textit{Service Level Agreement} indicators, you could use a few
1502 SQL queries on the Job table to report how many:
1506 \item jobs have been successful
1507 \item files have been backed up
1511 However, these statistics are accurate only if your job retention is greater
1512 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1513 be able to use them.
1515 Now, you can use the \textbf{update stats [days=num]} console command to fill
1516 the JobHistory table with new Job records. If you want to be sure to take in
1517 account only \textbf{good jobs}, ie if one of your important job has failed but
1518 you have fixed the problem and restarted it on time, you probably want to
1519 delete the first \textit{bad} job record and keep only the successful one. For
1520 that simply let your staff do the job, and update JobHistory table after two or
1521 three days depending on your organization using the \textbf{[days=num]} option.
1523 These statistics records aren't used for restoring, but mainly for
1524 capacity planning, billings, etc.
1526 The Bweb interface provides a statistics module that can use this feature. You
1527 can also use tools like Talend or extract information by yourself.
1529 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1530 the length of time that Bacula will keep statistics job records in the Catalog
1531 database after the Job End time. (In \texttt{JobHistory} table) When this time
1532 period expires, and if user runs \texttt{prune stats} command, Bacula will
1533 prune (remove) Job records that are older than the specified period.
1535 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1536 job to maintain statistics.
1539 Name = BackupCatalog
1542 Console = "update stats days=3"
1543 Console = "prune stats yes"
1550 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1551 \index[general]{ScratchPool}
1552 This directive permits to specify a specific \textsl{Scratch} pool for the
1553 current pool. This is useful when using multiple storage sharing the same
1554 mediatype or when you want to dedicate volumes to a particular set of pool.
1556 \subsection{Enhanced Attribute Despooling}
1557 \index[general]{Attribute Despooling}
1558 If the storage daemon and the Director are on the same machine, the spool file
1559 that contains attributes is read directly by the Director instead of being
1560 transmitted across the network. That should reduce load and speedup insertion.
1562 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1563 \index[general]{SpoolSize}
1564 A new Job directive permits to specify the spool size per job. This is used
1565 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1567 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1568 \index[general]{MaxConsoleConnections}
1569 A new director directive permits to specify the maximum number of Console
1570 Connections that could run concurrently. The default is set to 20, but you may
1571 set it to a larger number.
1573 \subsection{VerId = \lt{}string\gt{}}
1574 \index[general]{VerId}
1575 A new director directive permits to specify a personnal identifier that will be
1576 displayed in the \texttt{version} command.
1578 \subsection{dbcheck enhancements}
1579 \index[general]{dbcheck enhancements}
1580 If you are using Mysql, dbcheck will now ask you if you want to create
1581 temporary indexes to speed up orphaned Path and Filename elimination.
1583 A new \texttt{-B} option allows you to print catalog information in a simple
1584 text based format. This is useful to backup it in a secure way.
1599 You can now specify the database connection port in the command line.
1601 \subsection{{-}{-}docdir configure option}
1602 \index[general]{{-}{-}docdir configure option}
1603 You can use {-}{-}docdir= on the ./configure command to
1604 specify the directory where you want Bacula to install the
1605 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
1606 {\bf /usr/share/doc/bacula}.
1608 \subsection{{-}{-}htmldir configure option}
1609 \index[general]{{-}{-}htmldir configure option}
1610 You can use {-}{-}htmldir= on the ./configure command to
1611 specify the directory where you want Bacula to install the bat html help
1612 files. The default is {\bf /usr/share/doc/bacula/html}
1614 \subsection{{-}{-}with-plugindir configure option}
1615 \index[general]{{-}{-}plugindir configure option}
1616 You can use {-}{-}plugindir= on the ./configure command to
1617 specify the directory where you want Bacula to install
1618 the plugins (currently only bpipe-fd). The default is