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