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 \chapter{New Features in 3.0.0}
45 \label{NewFeaturesChapter}
46 \index[general]{New Features}
48 This chapter presents the new features added to the development 2.5.x
49 versions to be released as Bacula version 3.0.0 sometime in April 2009.
51 \section{Accurate Backup}
52 \index[general]{Accurate Backup}
54 As with most other backup programs, by default Bacula decides what files to
55 backup for Incremental and Differental backup by comparing the change
56 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
57 backup completed. If one of those two times is later than the last backup
58 time, then the file will be backed up. This does not, however, permit tracking
59 what files have been deleted and will miss any file with an old time that may
60 have been restored to or moved onto the client filesystem.
62 \subsection{Accurate = \lt{}yes|no\gt{}}
63 If the {\bf Accurate = \lt{}yes|no\gt{}} directive is enabled (default no) in
64 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
65 backup, there is no difference, but for {\bf Differential} and {\bf
66 Incremental} backups, the Director will send a list of all previous files
67 backed up, and the File daemon will use that list to determine if any new files
68 have been added or or moved and if any files have been deleted. This allows
69 Bacula to make an accurate backup of your system to that point in time so that
70 if you do a restore, it will restore your system exactly.
73 about using Accurate backup is that it requires more resources (CPU and memory)
74 on both the Director and the Client machines to create the list of previous
75 files backed up, to send that list to the File daemon, for the File daemon to
76 keep the list (possibly very big) in memory, and for the File daemon to do
77 comparisons between every file in the FileSet and the list. In particular,
78 if your client has lots of files (more than a few million), you will need
79 lots of memory on the client machine.
81 Accurate must not be enabled when backing up with a plugin that is not
82 specially designed to work with Accurate. If you enable it, your restores
83 will probably not work correctly.
85 This project was funded by Bacula Systems.
90 \index[general]{Copy Jobs}
92 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
93 existing Migration feature with the exception that the Job that is copied is
94 left unchanged. This essentially creates two identical copies of the same
95 backup. However, the copy is treated as a copy rather than a backup job, and
96 hence is not directly available for restore. The {\bf restore} command lists
97 copy jobs and allows selection of copies by using \texttt{jobid=}
98 option. If the keyword {\bf copies} is present on the command line, Bacula will
99 display the list of all copies for selected jobs.
104 These JobIds have copies as follows:
105 +-------+------------------------------------+-----------+------------------+
106 | JobId | Job | CopyJobId | MediaType |
107 +-------+------------------------------------+-----------+------------------+
108 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
109 +-------+------------------------------------+-----------+------------------+
110 +-------+-------+----------+----------+---------------------+------------------+
111 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
112 +-------+-------+----------+----------+---------------------+------------------+
113 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
114 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
115 +-------+-------+----------+----------+---------------------+------------------+
116 You have selected the following JobIds: 19,2
118 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
119 5,611 files inserted into the tree.
124 The Copy Job runs without using the File daemon by copying the data from the
125 old backup Volume to a different Volume in a different Pool. See the Migration
126 documentation for additional details. For copy Jobs there is a new selection
127 criterium named PoolUncopiedJobs which copies all jobs from a pool to an other
128 pool which were not copied before. Next to that the client, volume, job or sql
129 query are possible ways of selecting jobs which should be copied. Selection
130 types like smallestvolume, oldestvolume, pooloccupancy and pooltime are
131 probably more suited for migration jobs only. But we could imagine some people
132 have a valid use for those kind of copy jobs too.
134 If bacula founds a copy when a job record is purged (deleted) from the catalog,
135 it will promote the copy as \textsl{real} backup and will make it available for
136 automatic restore. If more than one copy is available, it will promote the copy
137 with the smallest jobid.
139 A nice solution which can be build with the new copy jobs is what is
140 called the disk-to-disk-to-tape backup (DTDTT). A sample config could
141 look somethings like the one below:
145 Name = FullBackupsVirtualPool
147 Purge Oldest Volume = Yes
149 NextPool = FullBackupsTapePool
153 Name = FullBackupsTapePool
157 Volume Retention = 365 days
158 Storage = superloader
162 # Fake fileset for copy jobs
174 # Fake client for copy jobs
184 # Default template for a CopyDiskToTape Job
187 Name = CopyDiskToTape
189 Messages = StandardCopy
192 Selection Type = PoolUncopiedJobs
193 Maximum Concurrent Jobs = 10
195 Allow Duplicate Jobs = Yes
196 Allow Higher Duplicates = No
197 Cancel Queued Duplicates = No
198 Cancel Running Duplicates = No
203 Name = DaySchedule7:00
204 Run = Level=Full daily at 7:00
208 Name = CopyDiskToTapeFullBackups
210 Schedule = DaySchedule7:00
211 Pool = FullBackupsVirtualPool
212 JobDefs = CopyDiskToTape
216 The example above had 2 pool which are copied using the PoolUncopiedJobs
217 selection criteria. Normal Full backups go to the Virtual pool and are copied
218 to the Tape pool the next morning.
220 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
225 +-------+------------------------------------+-----------+------------------+
226 | JobId | Job | CopyJobId | MediaType |
227 +-------+------------------------------------+-----------+------------------+
228 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
229 +-------+------------------------------------+-----------+------------------+
232 \section{ACL Updates}
233 \index[general]{ACL Updates}
234 The whole ACL code had been overhauled and in this version each platforms has
235 different streams for each type of acl available on such an platform. As ACLs
236 between platforms tend to be not that portable (most implement POSIX acls but
237 some use an other draft or a completely different format) we currently only
238 allow certain platform specific ACL streams to be decoded and restored on the
239 same platform that they were created on. The old code allowed to restore ACL
240 cross platform but the comments already mention that not being to wise. For
241 backward compatability the new code will accept the two old ACL streams and
242 handle those with the platform specific handler. But for all new backups it
243 will save the ACLs using the new streams.
245 Currently the following platforms support ACLs:
249 \item {\bf Darwin/OSX}
258 Currently we support the following ACL types (these ACL streams use a reserved
259 part of the stream numbers):
262 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
264 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
265 string representation from acl\_to\_text (POSIX acl)
266 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
267 string representation from acl\_to\_text (POSIX acl) for default acls.
268 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
269 string representation from acl\_to\_text (POSIX acl) for access acls.
270 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
271 string representation from acltostr (POSIX acl)
272 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
273 representation from acl\_to\_text (POSIX acl) for default acls.
274 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
275 representation from acl\_to\_text (POSIX acl) for access acls.
276 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
277 string representation from acl\_to\_text (POSIX acl) for default acls.
278 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
279 representation from acl\_to\_text (POSIX acl) for access acls.
280 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
281 string representation from acl\_to\_text (POSIX acl) for default acls.
282 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
283 string representation from acl\_to\_text (POSIX acl) for default acls.
284 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
285 representation from acl\_to\_text (POSIX acl) for access acls.
286 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
287 string representation from acltotext or acl\_totext (POSIX acl)
288 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
289 representation from from acl\_totext (NFSv4 or ZFS acl)
292 In future versions we might support conversion functions from one type of acl
293 into an other for types that are either the same or easily convertable. For now
294 the streams are seperate and restoring them on a platform that doesn't
295 recognize them will give you a warning.
297 \section{Extended Attributes}
298 \index[general]{Extended Attributes}
299 Something that was on the project list for some time is now implemented for
300 platforms that support a similar kind of interface. Its the support for backup
301 and restore of so called extended attributes. As extended attributes are so
302 platform specific these attributes are saved in seperate streams for each
303 platform. Restores of the extended attributes can only be performed on the
304 same platform the backup was done. There is support for all types of extended
305 attributes, but restoring from one type of filesystem onto an other type of
306 filesystem on the same platform may lead to supprises. As extended attributes
307 can contain any type of data they are stored as a series of so called
308 value-pairs. This data must be seen as mostly binary and is stored as such.
309 As security labels from selinux are also extended attributes this option also
310 stores those labels and no specific code is enabled for handling selinux
313 Currently the following platforms support extended attributes:
315 \item {\bf Darwin/OSX}
321 On linux acls are also extended attributes, as such when you enable ACLs on a
322 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
323 and not the same exteneded attribute.
325 To enable the backup of extended attributes please add the following to your
340 \section{Shared objects}
341 \index[general]{Shared objects}
342 A default build of Bacula will now create the libraries as shared objects
343 (.so) rather than static libraries as was previously the case.
344 The shared libraries are built using {\bf libtool} so it should be quite
347 An important advantage of using shared objects is that on a machine with the
348 Directory, File daemon, the Storage daemon, and a console, you will have only
349 one copy of the code in memory rather than four copies. Also the total size of
350 the binary release is smaller since the library code appears only once rather
351 than once for every program that uses it; this results in significant reduction
352 in the size of the binaries particularly for the utility tools.
354 In order for the system loader to find the shared objects when loading the
355 Bacula binaries, the Bacula shared objects must either be in a shared object
356 directory known to the loader (typically /usr/lib) or they must be in the
357 directory that may be specified on the {\bf ./configure} line using the {\bf
358 {-}{-}libdir} option as:
361 ./configure --libdir=/full-path/dir
364 the default is /usr/lib. If {-}{-}libdir is specified, there should be
365 no need to modify your loader configuration provided that
366 the shared objects are installed in that directory (Bacula
367 does this with the make install command). The shared objects
368 that Bacula references are:
377 These files are symbolically linked to the real shared object file,
378 which has a version number to permit running multiple versions of
379 the libraries if desired (not normally the case).
381 If you have problems with libtool or you wish to use the old
382 way of building static libraries, or you want to build a static
383 version of Bacula you may disable
384 libtool on the configure command line with:
387 ./configure --disable-libtool
391 \section{Building Static versions of Bacula}
392 \index[general]{Static linking}
393 In order to build static versions of Bacula, in addition
394 to configuration options that were needed you now must
395 also add --disable-libtool. Example
398 ./configure --enable-static-client-only --disable-libtool
402 \section{Virtual Backup (Vbackup)}
403 \index[general]{Virtual Backup}
404 \index[general]{Vbackup}
406 Bacula's virtual backup feature is often called Synthetic Backup or
407 Consolidation in other backup products. It permits you to consolidate the
408 previous Full backup plus the most recent Differential backup and any
409 subsequent Incremental backups into a new Full backup. This new Full
410 backup will then be considered as the most recent Full for any future
411 Incremental or Differential backups. The VirtualFull backup is
412 accomplished without contacting the client by reading the previous backup
413 data and writing it to a volume in a different pool.
415 In some respects the Vbackup feature works similar to a Migration job, in
416 that Bacula normally reads the data from the pool specified in the
417 Job resource, and writes it to the {\bf Next Pool} specified in the
418 Job resource. Note, this means that usually the output from the Virtual
419 Backup is written into a different pool from where your prior backups
420 are saved. Doing it this way guarantees that you will not get a deadlock
421 situation attempting to read and write to the same volume in the Storage
422 daemon. If you then want to do subsequent backups, you may need to
423 move the Virtual Full Volume back to your normal backup pool.
424 Alternatively, you can set your {\bf Next Pool} to point to the current
425 pool. This will cause Bacula to read and write to Volumes in the
426 current pool. In general, this will work, because Bacula will
427 not allow reading and writing on the same Volume. In any case, once
428 a VirtualFull has been created, and a restore is done involving the
429 most current Full, it will read the Volume or Volumes by the VirtualFull
430 regardless of in which Pool the Volume is found.
432 The Vbackup is enabled on a Job by Job in the Job resource by specifying
433 a level of {\bf VirtualFull}.
435 A typical Job resource definition might look like the following:
449 # Default pool definition
453 Recycle = yes # Automatically recycle Volumes
454 AutoPrune = yes # Prune expired volumes
455 Volume Retention = 365d # one year
463 Recycle = yes # Automatically recycle Volumes
464 AutoPrune = yes # Prune expired volumes
465 Volume Retention = 365d # one year
466 Storage = DiskChanger
469 # Definition of file storage device
476 Maximum Concurrent Jobs = 5
479 # Definition of DDS Virtual tape disk storage device
482 Address = localhost # N.B. Use a fully qualified name here
485 Media Type = DiskChangerMedia
486 Maximum Concurrent Jobs = 4
491 Then in bconsole or via a Run schedule, you would run the job as:
494 run job=MyBackup level=Full
495 run job=MyBackup level=Incremental
496 run job=MyBackup level=Differential
497 run job=MyBackup level=Incremental
498 run job=MyBackup level=Incremental
501 So providing there were changes between each of those jobs, you would end up
502 with a Full backup, a Differential, which includes the first Incremental
503 backup, then two Incremental backups. All the above jobs would be written to
504 the {\bf Default} pool.
506 To consolidate those backups into a new Full backup, you would run the
510 run job=MyBackup level=VirtualFull
513 And it would produce a new Full backup without using the client, and the output
514 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
516 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
519 Note, the Start and End time of the Virtual Full backup is set to the
520 values for the last job included in the Virtual Full (in the above example,
521 it is an Increment). This is so that if another incremental is done, which
522 will be based on the Virtual Full, it will backup all files from the
523 last Job included in the Virtual Full rather than from the time the Virtual
524 Full was actually run.
528 \section{Catalog Format}
529 \index[general]{Catalog Format}
530 Bacula 3.0 comes with some changes to the catalog format. The upgrade
531 operation will convert the FileId field of the File table from 32 bits (max 4
532 billion table entries) to 64 bits (very large number of items). The
533 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
534 your catalog during the conversion. Also you won't be able to run jobs during
535 this conversion period. For example, a 3 million file catalog will take 2
536 minutes to upgrade on a normal machine. Please don't forget to make a valid
537 backup of your database before executing the upgrade script. See the
538 ReleaseNotes for additional details.
540 \section{64 bit Windows Client}
541 \index[general]{Win64 Client}
542 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
543 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
544 As a consequence, we are also releasing a 64 bit version of the Bacula
545 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
546 These binaries should only be installed on 64 bit Windows operating systems.
547 What is important is not your hardware but whether or not you have
548 a 64 bit version of the Windows OS.
550 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
552 \item Before installing the Win64 Bacula Client, you must totally
553 deinstall any prior 2.4.x Client installation using the
554 Bacula deinstallation (see the menu item). You may want
555 to save your .conf files first.
556 \item Only the Client (File daemon) is ported to Win64, the Director
557 and the Storage daemon are not in the 64 bit Windows installer.
558 \item bwx-console is not yet ported.
559 \item bconsole is ported but it has not been tested.
560 \item The documentation is not included in the installer.
561 \item Due to Vista security restrictions imposed on a default installation
562 of Vista, before upgrading the Client, you must manually stop
563 any prior version of Bacula from running, otherwise the install
565 \item Due to Vista security restrictions imposed on a default installation
566 of Vista, attempting to edit the conf files via the menu items
567 will fail. You must directly edit the files with appropriate
568 permissions. Generally double clicking on the appropriate .conf
569 file will work providing you have sufficient permissions.
570 \item All Bacula files are now installed in
571 {\bf C:/Program Files/Bacula} except the main menu items,
572 which are installed as before. This vastly simplifies the installation.
573 \item If you are running on a foreign language version of Windows, most
574 likely {\bf C:/Program Files} does not exist, so you should use the
575 Custom installation and enter an appropriate location to install
577 \item The 3.0.0 Win32 Client continues to install files in the locations used
578 by prior versions. For the next version we will convert it to use
579 the same installation conventions as the Win64 version.
582 This project was funded by Bacula Systems.
585 \section{Duplicate Job Control}
586 \index[general]{Duplicate Jobs}
587 The new version of Bacula provides four new directives that
588 give additional control over what Bacula does if duplicate jobs
589 are started. A duplicate job in the sense we use it here means
590 a second or subsequent job with the same name starts. This
591 happens most frequently when the first job runs longer than expected because no
594 The four directives each take as an argument a {\bf yes} or {\bf no} value and
595 are specified in the Job resource.
599 \subsection{Allow Duplicate Jobs = \lt{}yes|no\gt{}}
600 \index[general]{Allow Duplicate Jobs}
601 If this directive is enabled duplicate jobs will be run. If
602 the directive is set to {\bf no} (default) then only one job of a given name
603 may run at one time, and the action that Bacula takes to ensure only
604 one job runs is determined by the other directives (see below).
606 \subsection{Allow Higher Duplicates = \lt{}yes|no\gt{}}
607 \index[general]{Allow Higher Duplicates}
608 If this directive is set to {\bf yes} (default) the job with a higher
609 priority (lower priority number) will be permitted to run. If the
610 priorities of the two jobs are the same, the outcome is determined by
611 other directives (see below).
613 \subsection{Cancel Queued Duplicates = \lt{}yes|no\gt{}}
614 \index[general]{Cancel Queued Duplicates}
615 If this directive is set to {\bf yes} (default) any job that is
616 already queued to run but not yet running will be canceled.
618 \subsection{Cancel Running Duplicates = \lt{}yes|no\gt{}}
619 \index[general]{Cancel Running Duplicates}
620 If this directive is set to {\bf yes} any job that is already running
621 will be canceled. The default is {\bf no}.
624 \section{TLS Authentication}
625 \index[general]{TLS Authentication}
626 In Bacula version 2.5.x and later, in addition to the normal Bacula
627 CRAM-MD5 authentication that is used to authenticate each Bacula
628 connection, you can specify that you want TLS Authentication as well,
629 which will provide more secure authentication.
631 This new feature uses Bacula's existing TLS code (normally used for
632 communications encryption) to do authentication. To use it, you must
633 specify all the TLS directives normally used to enable communications
634 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
637 \subsection{TLS Authenticate = yes}
639 TLS Authenticate = yes
642 in the main daemon configuration resource (Director for the Director,
643 Client for the File daemon, and Storage for the Storage daemon).
645 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
646 authentication, Bacula will also do TLS authentication, then TLS
647 encryption will be turned off, and the rest of the communication between
648 the two Bacula daemons will be done without encryption.
650 If you want to encrypt communications data, use the normal TLS directives
651 but do not turn on {\bf TLS Authenticate}.
653 \section{bextract non-portable Win32 data}
654 \index[general]{bextract handles Win32 non-portable data}
655 {\bf bextract} has been enhanced to be able to restore
656 non-portable Win32 data to any OS. Previous versions were
657 unable to restore non-portable Win32 data to machines that
658 did not have the Win32 BackupRead and BackupWrite API calls.
660 \section{State File updated at Job Termination}
661 \index[general]{State File}
662 In previous versions of Bacula, the state file, which provides a
663 summary of previous jobs run in the {\bf status} command output was
664 updated only when Bacula terminated, thus if the daemon crashed, the
665 state file might not contain all the run data. This version of
666 the Bacula daemons updates the state file on each job termination.
668 \section{MaxFullInterval = \lt{}time-interval\gt{}}
669 \index[general]{MaxFullInterval}
670 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
671 can be used to specify the maximum time interval between {\bf Full} backup
672 jobs. When a job starts, if the time since the last Full backup is
673 greater than the specified interval, and the job would normally be an
674 {\bf Incremental} or {\bf Differential}, it will be automatically
675 upgraded to a {\bf Full} backup.
677 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
678 \index[general]{MaxDiffInterval}
679 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
680 can be used to specify the maximum time interval between {\bf Differential} backup
681 jobs. When a job starts, if the time since the last Differential backup is
682 greater than the specified interval, and the job would normally be an
683 {\bf Incremental}, it will be automatically
684 upgraded to a {\bf Differential} backup.
686 \section{Honor No Dump Flag = \lt{}yes|no\gt{}}
687 \index[general]{MaxDiffInterval}
688 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
689 by the user, and when it is set it is an indication to backup programs
690 to not backup that particular file. This version of Bacula contains a
691 new Options directive within a FileSet resource, which instructs Bacula to
692 obey this flag. The new directive is:
695 Honor No Dump Flag = yes|no
698 The default value is {\bf no}.
701 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
702 \index[general]{IgnoreDir}
703 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
704 can be added to the Include section of the FileSet resource. If the specified
705 filename ({\bf filename-string}) is found on the Client in any directory to be
706 backed up, the whole directory will be ignored (not backed up). For example:
709 # List of files to be backed up
717 Exclude Dir Containing = .excludeme
722 But in /home, there may be hundreds of directories of users and some
723 people want to indicate that they don't want to have certain
724 directories backed up. For example, with the above FileSet, if
725 the user or sysadmin creates a file named {\bf .excludeme} in
726 specific directories, such as
729 /home/user/www/cache/.excludeme
730 /home/user/temp/.excludeme
733 then Bacula will not backup the two directories named:
740 NOTE: subdirectories will not be backed up. That is, the directive
741 applies to the two directories in question and any children (be they
742 files, directories, etc).
745 \section{Bacula Plugins}
746 \index[general]{Plugin}
747 Support for shared object plugins has been implemented in the Linux, Unix
748 and Win32 File daemons. The API will be documented separately in
749 the Developer's Guide or in a new document. For the moment, there is
750 a single plugin named {\bf bpipe} that allows an external program to
751 get control to backup and restore a file.
753 Plugins are also planned (partially implemented) in the Director and the
756 \subsection{Plugin Directory}
757 \index[general]{Plugin Directory}
758 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
759 be added to the daemon definition resource. The directory takes a quoted
760 string argument, which is the name of the directory in which the daemon can
761 find the Bacula plugins. If this directive is not specified, Bacula will not
762 load any plugins. Since each plugin has a distinctive name, all the daemons
763 can share the same plugin directory.
765 \subsection{Plugin Options}
766 \index[general]{Plugin Options}
767 The {\bf Plugin Options} directive takes a quoted string
768 arguement (after the equal sign) and may be specified in the
769 Job resource. The options specified will be passed to all plugins
770 when they are run. This each plugin must know what it is looking
771 for. The value defined in the Job resource can be modified
772 by the user when he runs a Job via the {\bf bconsole} command line
775 Note: this directive may be specified, and there is code to modify
776 the string in the run command, but the plugin options are not yet passed to
777 the plugin (i.e. not fully implemented).
779 \subsection{Plugin Options ACL}
780 \index[general]{Plugin Options ACL}
781 The {\bf Plugin Options ACL} directive may be specified in the
782 Director's Console resource. It functions as all the other ACL commands
783 do by permitting users running restricted consoles to specify a
784 {\bf Plugin Options} that overrides the one specified in the Job
785 definition. Without this directive restricted consoles may not modify
788 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
789 \index[general]{Plugin}
790 The {\bf Plugin} directive is specified in the Include section of
791 a FileSet resource where you put your {\bf File = xxx} directives.
807 In the above example, when the File daemon is processing the directives
808 in the Include section, it will first backup all the files in {\bf /home}
809 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
810 the Plugin Directory. The syntax and semantics of the Plugin directive
811 require the first part of the string up to the colon (:) to be the name
812 of the plugin. Everything after the first colon is ignored by the File daemon but
813 is passed to the plugin. Thus the plugin writer may define the meaning of the
814 rest of the string as he wishes.
816 Please see the next section for information about the {\bf bpipe} Bacula
819 \section{The bpipe Plugin}
820 \index[general]{The bpipe Plugin}
821 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
822 the Bacula source distribution. When the plugin is compiled and linking into
823 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
825 The purpose of the plugin is to provide an interface to any system program for
826 backup and restore. As specified above the {\bf bpipe} plugin is specified in
827 the Include section of your Job's FileSet resource. The full syntax of the
828 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
829 to specify the sytax as it wishes) is:
832 Plugin = "<field1>:<field2>:<field3>:<field4>"
837 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
838 stripped off, so in this case, we would put {\bf bpipe} in this field.
840 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
841 pseudo path and filename under which the backup will be saved. This pseudo
842 path and filename will be seen by the user in the restore file tree.
843 For example, if the value is {\bf /MYSQL/regress.sql}, the data
844 backed up by the plugin will be put under that "pseudo" path and filename.
845 You must be careful to choose a naming convention that is unique to avoid
846 a conflict with a path and filename that actually exists on your system.
848 \item {\bf field3} for the {\bf bpipe} plugin
849 specifies the "reader" program that is called by the plugin during
850 backup to read the data. {\bf bpipe} will call this program by doing a
853 \item {\bf field4} for the {\bf bpipe} plugin
854 specifies the "writer" program that is called by the plugin during
855 restore to write the data back to the filesystem.
858 Putting it all together, the full plugin directive line might look
862 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
863 --opt --databases bacula:mysql"
866 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
867 would be written on a single line.
869 This causes the File daemon to call the {\bf bpipe} plugin, which will write
870 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
871 program {\bf mysqldump -f --opt --database bacula} to read the data during
872 backup. The mysqldump command outputs all the data for the database named
873 {\bf bacula}, which will be read by the plugin and stored in the backup.
874 During restore, the data that was backed up will be sent to the program
875 specified in the last field, which in this case is {\bf mysql}. When
876 {\bf mysql} is called, it will read the data sent to it by the plugn
877 then write it back to the same database from which it came ({\bf bacula}
880 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
881 the data from a specified program to Bacula for backup, and then from Bacula to
882 a specified program for restore.
884 By using different command lines to {\bf bpipe},
885 you can backup any kind of data (ASCII or binary) depending
886 on the program called.
888 \section{Microsoft Exchange Server 2003/2007 Plugin}
889 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
890 \subsection{Background}
891 The Exchange plugin was made possible by a funded development project
892 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
893 The code for the plugin was written by James Harper, and the Bacula core
894 code by Kern Sibbald. All the code for this funded development has become
895 part of the Bacula project. Thanks to everyone who made it happen.
897 \subsection{Concepts}
898 Although it is possible to backup Exchange using Bacula VSS the Exchange
899 plugin adds a good deal of functionality, because while Bacula VSS
900 completes a full backup (snapshot) of Exchange, it does
901 not support Incremental or Differential backups, restoring is more
902 complicated, and a single database restore is not possible.
904 Microsoft Exchange organises its storage into Storage Groups with
905 Databases inside them. A default installation of Exchange will have a
906 single Storage Group called 'First Storage Group', with two Databases
907 inside it, "Mailbox Store (SERVER NAME)" and
908 "Public Folder Store (SERVER NAME)",
909 which hold user email and public folders respectively.
911 In the default configuration, Exchange logs everything that happens to
912 log files, such that if you have a backup, and all the log files since,
913 you can restore to the present time. Each Storage Group has its own set
914 of log files and operates independently of any other Storage Groups. At
915 the Storage Group level, the logging can be turned off by enabling a
916 function called "Enable circular logging". At this time the Exchange
917 plugin will not function if this option is enabled.
919 The plugin allows backing up of entire storage groups, and the restoring
920 of entire storage groups or individual databases. Backing up and
921 restoring at the individual mailbox or email item is not supported but
922 can be simulated by use of the "Recovery" Storage Group (see below).
924 \subsection{Installing}
925 The Exchange plugin requires a DLL that is shipped with Microsoft
926 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
927 correctly the Exchange plugin should find this automatically and run
928 without any additional installation.
930 If the DLL can not be found automatically it will need to be copied into
931 the Bacula installation
932 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
933 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
934 default Exchange installation.
936 \subsection{Backup up}
937 To back up an Exchange server the Fileset definition must contain at
938 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
939 the backup to work correctly. The 'exchange:' bit tells Bacula to look
940 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
941 up files are prefixed with something that isn't going to share a name
942 with something outside the plugin, and the 'Microsoft Information Store'
943 bit is required also. It is also possible to add the name of a storage
944 group to the "Plugin =" line, eg \\
945 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
946 if you want only a single storage group backed up.
948 Additionally, you can suffix the 'Plugin =' directive with
949 ":notrunconfull" which will tell the plugin not to truncate the Exchange
950 database at the end of a full backup.
952 An Incremental or Differential backup will backup only the database logs
953 for each Storage Group by inspecting the "modified date" on each
954 physical log file. Because of the way the Exchange API works, the last
955 logfile backed up on each backup will always be backed up by the next
956 Incremental or Differential backup too. This adds 5MB to each
957 Incremental or Differential backup size but otherwise does not cause any
960 By default, a normal VSS fileset containing all the drive letters will
961 also back up the Exchange databases using VSS. This will interfere with
962 the plugin and Exchange's shared ideas of when the last full backup was
963 done, and may also truncate log files incorrectly. It is important,
964 therefore, that the Exchange database files be excluded from the backup,
965 although the folders the files are in should be included, or they will
966 have to be recreated manually if a baremetal restore is done.
971 File = C:/Program Files/Exchsrvr/mdbdata
972 Plugin = "exchange:..."
975 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
976 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
977 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
978 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
979 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
980 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
981 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
986 The advantage of excluding the above files is that you can significantly
987 reduce the size of your backup since all the important Exchange files
988 will be properly saved by the Plugin.
991 \subsection{Restoring}
992 The restore operation is much the same as a normal Bacula restore, with
993 the following provisos:
996 \item The {\bf Where} restore option must not be specified
997 \item Each Database directory must be marked as a whole. You cannot just
998 select (say) the .edb file and not the others.
999 \item If a Storage Group is restored, the directory of the Storage Group
1001 \item It is possible to restore only a subset of the available log files,
1002 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1003 if a log file is missing from the sequence of log files
1004 \item Each database to be restored must be dismounted and marked as "Can be
1005 overwritten by restore"
1006 \item If an entire Storage Group is to be restored (eg all databases and
1007 logs in the Storage Group), then it is best to manually delete the
1008 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1009 as Exchange can get confused by stray log files lying around.
1012 \subsection{Restoring to the Recovery Storage Group}
1013 The concept of the Recovery Storage Group is well documented by
1015 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1016 but to briefly summarize...
1018 Microsoft Exchange allows the creation of an additional Storage Group
1019 called the Recovery Storage Group, which is used to restore an older
1020 copy of a database (e.g. before a mailbox was deleted) into without
1021 messing with the current live data. This is required as the Standard and
1022 Small Business Server versions of Exchange can not ordinarily have more
1023 than one Storage Group.
1025 To create the Recovery Storage Group, drill down to the Server in Exchange
1026 System Manager, right click, and select
1027 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1028 locations and click OK. On the Recovery Storage Group, right click and
1029 select {\bf "Add Database to Recover..."} and select the database you will
1032 Restore only the single database nominated as the database in the
1033 Recovery Storage Group. Exchange will redirect the restore to the
1034 Recovery Storage Group automatically.
1035 Then run the restore.
1037 \subsection{Restoring on Microsoft Server 2007}
1038 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1039 2007, and henc you use a new proceedure for recovering a single mail box.
1040 This procedure is ducomented by Microsoft at:
1041 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1042 and involves using the {\bf Restore-Mailbox} and {\bf
1043 Get-MailboxStatistics} shell commands.
1045 \subsection{Caveats}
1046 This plugin is still being developed, so you should consider it
1047 currently in BETA test, and thus use in a production environment
1048 should be done only after very careful testing.
1050 When doing a full backup, the Exchange database logs are truncated by
1051 Exchange as soon as the plugin has completed the backup. If the data
1052 never makes it to the backup medium (eg because of spooling) then the
1053 logs will still be truncated, but they will also not have been backed
1054 up. A solution to this is being worked on. You will have to schedule a
1055 new Full backup to ensure that your next backups will be usable.
1057 The "Enable Circular Logging" option cannot be enabled or the plugin
1060 Exchange insists that a successful Full backup must have taken place if
1061 an Incremental or Differential backup is desired, and the plugin will
1062 fail if this is not the case. If a restore is done, Exchange will
1063 require that a Full backup be done before an Incremental or Differential
1066 The plugin will most likely not work well if another backup application
1067 (eg NTBACKUP) is backing up the Exchange database, especially if the
1068 other backup application is truncating the log files.
1070 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1071 we recommend either carefully testing or that you avoid this option for
1074 The Exchange plugin is not called during processing the bconsole {\bf
1075 estimate} command, and so anything that would be backed up by the plugin
1076 will not be added to the estimate total that is displayed.
1079 \section{libdbi Framework}
1080 \index[general]{libdbi Framework}
1081 As a general guideline, Bacula has support for a few catalog database drivers
1082 (MySQL, PostgreSQL, SQLite)
1083 coded natively by the Bacula team. With the libdbi implementation, which is a
1084 Bacula driver that uses libdbi to access the catalog, we have an open field to
1085 use many different kinds database engines following the needs of users.
1087 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1088 implements a database-independent abstraction layer in C, similar to the
1089 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1090 leverage the power of multiple databases and multiple simultaneous database
1091 connections by using this framework.
1093 Currently the libdbi driver in Bacula project only supports the same drivers
1094 natively coded in Bacula. However the libdbi project has support for many
1095 others database engines. You can view the list at
1096 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1097 supported by Bacula, however, they must be tested properly by the Bacula team.
1099 Some of benefits of using libdbi are:
1101 \item The possibility to use proprietary databases engines in which your
1102 proprietary licenses prevent the Bacula team from developing the driver.
1103 \item The possibility to use the drivers written for the libdbi project.
1104 \item The possibility to use other database engines without recompiling Bacula
1105 to use them. Just change one line in bacula-dir.conf
1106 \item Abstract Database access, this is, unique point to code and profiling
1107 catalog database access.
1110 The following drivers have been tested:
1112 \item PostgreSQL, with and without batch insert
1113 \item Mysql, with and without batch insert
1118 In the future, we will test and approve to use others databases engines
1119 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1121 To compile Bacula to support libdbi we need to configure the code with the
1122 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1123 [database] is the database engine to be used with Bacula (of course we can
1124 change the driver in file bacula-dir.conf, see below). We must configure the
1125 access port of the database engine with the option --with-db-port, because the
1126 libdbi framework doesn't know the default access port of each database.
1128 The next phase is checking (or configuring) the bacula-dir.conf, example:
1132 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1133 dbname = regress; user = regress; password = ""
1137 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1138 mysql database. Currently the drivers supported by Bacula are: postgresql,
1139 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1141 The following limitations apply when Bacula is set to use the libdbi framework:
1142 - Not tested on the Win32 platform
1143 - A little performance is lost if comparing with native database driver.
1144 The reason is bound with the database driver provided by libdbi and the
1145 simple fact that one more layer of code was added.
1147 It is important to remember, when compiling Bacula with libdbi, the
1148 following packages are needed:
1150 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1151 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1154 You can download them and compile them on your system or install the packages
1155 from your OS distribution.
1157 \section{Console Command Additions and Enhancements}
1158 \index[general]{Console Additions}
1160 \subsection{Display Autochanger Content}
1161 \index[general]{StatusSlots}
1163 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1164 autochanger content.
1168 Slot | Volume Name | Status | Media Type | Pool |
1169 ------+---------------+----------+-------------------+------------|
1170 1 | 00001 | Append | DiskChangerMedia | Default |
1171 2 | 00002 | Append | DiskChangerMedia | Default |
1172 3*| 00003 | Append | DiskChangerMedia | Scratch |
1177 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1178 {\bf update slots} command to synchronize autochanger content with your
1181 \subsection{list joblog job=xxx or jobid=nnn}
1182 \index[general]{list joblog}
1183 A new list command has been added that allows you to list the contents
1184 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1185 or for a particular JobId. The {\bf llist} command will include a line with
1186 the time and date of the entry.
1188 Note for the catalog to have Job Log entries, you must have a directive
1195 In your Director's {\bf Messages} resource.
1197 \subsection{Use separator for multiple commands}
1198 \index[general]{Command Separator}
1199 When using bconsole with readline, you can set the command separator with
1200 \textbf{@separator} command to one
1201 of those characters to write commands who require multiple input in one line.
1203 !$%&'()*+,-/:;<>?[]^`{|}~
1206 \subsection{Deleting Volumes}
1207 The delete volume bconsole command has been modified to
1208 require an asterisk (*) in front of a MediaId otherwise the
1209 value you enter is a taken to be a Volume name. This is so that
1210 users may delete numeric Volume names. The previous Bacula versions
1211 assumed that all input that started with a number was a MediaId.
1213 This new behavior is indicated in the prompt if you read it
1216 \section{Bare Metal Recovery}
1217 The old bare metal recovery project is essentially dead. One
1218 of the main features of it was that it would build a recovery
1219 CD based on the kernel on your system. The problem was that
1220 every distribution has a different boot procedure and different
1221 scripts, and worse yet, the boot procedures and scripts change
1222 from one distribution to another. This meant that maintaining
1223 (keeping up with the changes) the rescue CD was too much work.
1225 To replace it, a new bare metal recovery USB boot stick has been developed
1226 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1227 boot from a USB key.
1231 \item Recovery can be done from within graphical environment.
1232 \item Recovery can be done in a shell.
1233 \item Ubuntu boots on a large number of Linux systems.
1234 \item The process of updating the system and adding new
1235 packages is not too difficult.
1236 \item The USB key can easily be upgraded to newer Ubuntu versions.
1237 \item The USB key has writable partitions for modifications to
1238 the OS and for modification to your home directory.
1239 \item You can add new files/directories to the USB key very easily.
1240 \item You can save the environment from multiple machines on
1242 \item Bacula Systems is funding its ongoing development.
1245 The disadvantages are:
1247 \item The USB key is usable but currently under development.
1248 \item Not everyone may be familiar with Ubuntu (no worse
1250 \item Some older OSes cannot be booted from USB. This can
1251 be resolved by first booting a Ubuntu LiveCD then plugging
1253 \item Currently the documentation is sketchy and not yet added
1254 to the main manual. See below ...
1257 The documentation and the code can be found in the {\bf rescue} package
1258 in the directory {\bf linux/usb}.
1260 \section{Miscellaneous}
1261 \index[general]{Misc New Features}
1263 \subsection{Allow Mixed Priority = \lt{}yes|no\gt{}}
1264 \index[general]{Allow Mixed Priority}
1265 This directive is only implemented in version 2.5 and later. When
1266 set to {\bf yes} (default {\bf no}), this job may run even if lower
1267 priority jobs are already running. This means a high priority job
1268 will not have to wait for other jobs to finish before starting.
1269 The scheduler will only mix priorities when all running jobs have
1272 Note that only higher priority jobs will start early. Suppose the
1273 director will allow two concurrent jobs, and that two jobs with
1274 priority 10 are running, with two more in the queue. If a job with
1275 priority 5 is added to the queue, it will be run as soon as one of
1276 the running jobs finishes. However, new priority 10 jobs will not
1277 be run until the priority 5 job has finished.
1279 \subsection{Bootstrap File Directive -- FileRegex}
1280 \index[general]{Bootstrap File Directive}
1281 {\bf FileRegex} is a new command that can be added to the bootstrap
1282 (.bsr) file. The value is a regular expression. When specified, only
1283 matching filenames will be restored.
1285 During a restore, if all File records are pruned from the catalog
1286 for a Job, normally Bacula can restore only all files saved. That
1287 is there is no way using the catalog to select individual files.
1288 With this new feature, Bacula will ask if you want to specify a Regex
1289 expression for extracting only a part of the full backup.
1292 Building directory tree for JobId(s) 1,3 ...
1293 There were no files inserted into the tree, so file selection
1294 is not possible.Most likely your retention policy pruned the files
1296 Do you want to restore all the files? (yes|no): no
1298 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1299 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1302 \subsection{Bootstrap File Optimization Changes}
1303 In order to permit proper seeking on disk files, we have extended the bootstrap
1304 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1305 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1306 address range and end address range respectively. These two directives replace
1307 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1308 VolEndBlock} directives. Bootstrap files containing the old directives will
1309 still work, but will not properly take advantage of proper disk seeking, and
1310 may read completely to the end of a disk volume during a restore. With the new
1311 format (automatically generated by the new Director), restores will seek
1312 properly and stop reading the volume when all the files have been restored.
1314 \subsection{Solaris ZFS/NFSv4 ACLs}
1315 This is an upgrade of the previous Solaris ACL backup code
1316 to the new library format, which will backup both the old
1317 POSIX(UFS) ACLs as well as the ZFS ACLs.
1319 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1320 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1321 be used to transfer from UFS to ZFS filesystems.
1324 \subsection{Virtual Tape Emulation}
1325 \index[general]{Virtual Tape Emulation}
1326 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1327 the tape code but actually reading and writing to a disk file. Used with the
1328 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1329 and 700 slots. This feature is most useful in testing. It is enabled
1330 by using {\bf Device Type = vtape} in the Storage daemon's Device
1331 directive. This feature is only implemented on Linux machines and should not be
1332 used for production.
1334 \subsection{Bat Enhancements}
1335 \index[general]{Bat Enhancements}
1336 Bat (the Bacula Administration Tool) GUI program has been significantly
1337 enhanced and stabilized. In particular, there are new table based status
1338 commands; it can now be easily localized using Qt4 Linguist.
1340 The Bat communications protocol has been significantly enhanced to improve
1341 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1342 the Director you are using otherwise the communications protocol will not
1345 \subsection{RunScript Enhancements}
1346 \index[general]{RunScript Enhancements}
1347 The {\bf RunScript} resource has been enhanced to permit multiple
1348 commands per RunScript. Simply specify multiple {\bf Command} directives
1355 Command = "/bin/echo test"
1356 Command = "/bin/echo an other test"
1357 Command = "/bin/echo 3 commands in the same runscript"
1364 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1365 implemented, which runs the command after the Volume Shadow Copy has been made.
1367 Console commands can be specified within a RunScript by using:
1368 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1369 carefully tested and debugged and is known to easily crash the Director.
1370 We would appreciate feedback. Due to the recursive nature of this command, we
1371 may remove it before the final release.
1373 \subsection{Status Enhancements}
1374 \index[general]{Status Enhancements}
1375 The bconsole {\bf status dir} output has been enhanced to indicate
1376 Storage daemon job spooling and despooling activity.
1378 \subsection{Connect Timeout}
1379 \index[general]{Connect Timeout}
1380 The default connect timeout to the File
1381 daemon has been set to 3 minutes. Previously it was 30 minutes.
1383 \subsection{ftruncate for NFS Volumes}
1384 \index[general]{ftruncate for NFS Volumes}
1385 If you write to a Volume mounted by NFS (say on a local file server),
1386 in previous Bacula versions, when the Volume was recycled, it was not
1387 properly truncated because NFS does not implement ftruncate (file
1388 truncate). This is now corrected in the new version because we have
1389 written code (actually a kind user) that deletes and recreates the Volume,
1390 thus accomplishing the same thing as a truncate.
1392 \subsection{Support for Ubuntu}
1393 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1394 version of Linux, and thus now provides correct autostart routines.
1395 Since Ubuntu officially supports Bacula, you can also obtain any
1396 recent release of Bacula from the Ubuntu repositories.
1398 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1399 \index[general]{Recycle Pool}
1400 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1401 be placed (moved) when it is recycled. Without this directive, a Volume will
1402 remain in the same pool when it is recycled. With this directive, it can be
1403 moved automatically to any existing pool during a recycle. This directive is
1404 probably most useful when defined in the Scratch pool, so that volumes will
1405 be recycled back into the Scratch pool.
1407 \subsection{FD Version}
1408 \index[general]{FD Version}
1409 The File daemon to Director protocol now includes a version
1410 number, which although there is no visible change for users,
1411 will help us in future versions automatically determine
1412 if a File daemon is not compatible.
1414 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1415 \index[general]{Max Run Sched Time}
1416 The time specifies the maximum allowed time that a job may run, counted from
1417 when the job was scheduled. This can be useful to prevent jobs from running
1418 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1421 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1422 \index[general]{Max Wait Time}
1423 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1424 of checking the maximum allowed time that a job may block for a resource,
1425 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1426 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1427 their job depending on the level. Now, they have to use
1428 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1429 directives are now deprecated.
1431 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1432 \index[general]{Incremental Max Wait Time}
1433 \index[general]{Differential Max Wait Time}
1435 These directives have been deprecated in favor of
1436 \texttt{Incremental|Differential Max Run Time}.
1438 \subsection{Max Run Time directives}
1439 \index[general]{Max Run Time directives}
1440 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1441 maximum allowed time that a job can run depending on the level.
1443 \addcontentsline{lof}{figure}{Job time control directives}
1444 \includegraphics{\idir different_time.eps}
1446 \subsection{Statistics Enhancements}
1447 \index[general]{Statistics Enhancements}
1448 If you (or probably your boss) want to have statistics on your backups to
1449 provide some \textit{Service Level Agreement} indicators, you could use a few
1450 SQL queries on the Job table to report how many:
1454 \item jobs have been successful
1455 \item files have been backed up
1459 However, these statistics are accurate only if your job retention is greater
1460 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1461 be able to use them.
1463 Now, you can use the \textbf{update stats [days=num]} console command to fill
1464 the JobHistory table with new Job records. If you want to be sure to take in
1465 account only \textbf{good jobs}, ie if one of your important job has failed but
1466 you have fixed the problem and restarted it on time, you probably want to
1467 delete the first \textit{bad} job record and keep only the successful one. For
1468 that simply let your staff do the job, and update JobHistory table after two or
1469 three days depending on your organization using the \textbf{[days=num]} option.
1471 These statistics records aren't used for restoring, but mainly for
1472 capacity planning, billings, etc.
1474 The Bweb interface provides a statistics module that can use this feature. You
1475 can also use tools like Talend or extract information by yourself.
1477 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1478 the length of time that Bacula will keep statistics job records in the Catalog
1479 database after the Job End time. (In \texttt{JobHistory} table) When this time
1480 period expires, and if user runs \texttt{prune stats} command, Bacula will
1481 prune (remove) Job records that are older than the specified period.
1483 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1484 job to maintain statistics.
1487 Name = BackupCatalog
1490 Console = "update stats days=3"
1491 Console = "prune stats yes"
1498 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1499 \index[general]{ScratchPool}
1500 This directive permits to specify a specific \textsl{Scratch} pool for the
1501 current pool. This is useful when using multiple storage sharing the same
1502 mediatype or when you want to dedicate volumes to a particular set of pool.
1504 \subsection{Enhanced Attribute Despooling}
1505 \index[general]{Attribute Despooling}
1506 If the storage daemon and the Director are on the same machine, the spool file
1507 that contains attributes is read directly by the Director instead of being
1508 transmitted across the network. That should reduce load and speedup insertion.
1510 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1511 \index[general]{SpoolSize}
1512 A new Job directive permits to specify the spool size per job. This is used
1513 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1515 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1516 \index[general]{MaxConsoleConnections}
1517 A new director directive permits to specify the maximum number of Console
1518 Connections that could run concurrently. The default is set to 20, but you may
1519 set it to a larger number.
1521 \subsection{VerId = \lt{}string\gt{}}
1522 \index[general]{VerId}
1523 A new director directive permits to specify a personnal identifier that will be
1524 displayed in the \texttt{version} command.
1526 \subsection{dbcheck enhancements}
1527 \index[general]{dbcheck enhancements}
1528 If you are using Mysql, dbcheck will now ask you if you want to create
1529 temporary indexes to speed up orphaned Path and Filename elimination.
1531 A new \texttt{-B} option allows you to print catalog information in a simple
1532 text based format. This is useful to backup it in a secure way.
1547 You can now specify the database connection port in the command line.
1549 \subsection{{-}{-}docdir configure option}
1550 \index[general]{{-}{-}docdir configure option}
1551 You can use {-}{-}docdir= on the ./configure command to
1552 specify the directory where you want Bacula to install the
1553 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
1554 {\bf /usr/share/doc/bacula}.
1556 \subsection{{-}{-}htmldir configure option}
1557 \index[general]{{-}{-}htmldir configure option}
1558 You can use {-}{-}htmldir= on the ./configure command to
1559 specify the directory where you want Bacula to install the bat html help
1560 files. The default is {\bf /usr/share/doc/bacula/html}
1562 \subsection{{-}{-}with-plugindir configure option}
1563 \index[general]{{-}{-}plugindir configure option}
1564 You can use {-}{-}plugindir= on the ./configure command to
1565 specify the directory where you want Bacula to install
1566 the plugins (currently only bpipe-fd). The default is