5 \chapter{New Features in 3.0.2}
6 \label{NewFeaturesChapter}
8 This chapter presents the new features added to the development 3.0.2
9 versions to be released as Bacula version 3.0.2 sometime in 2009.
11 \section{Full restore from a given JobId}
12 \index[general]{Restore menu}
14 This feature allows selecting a JobId and having Bacula automatically select all
15 other jobs that comprise a full backup up to and including the selected JobId.
17 Assume we start with the following jobs:
19 +-------+--------------+---------------------+-------+----------+------------+
20 | jobid | client | starttime | level | jobfiles | jobbytes |
21 +-------+--------------+---------------------+-------+----------+------------
22 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
23 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
24 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
25 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
26 +-------+--------------+---------------------+-------+----------+------------+
29 Below is an example of selecting this new feature (which is number 12 in the menu).
33 To select the JobIds, you have the following choices:
34 1: List last 20 Jobs run
35 2: List Jobs where a given File is saved
37 12: Select full restore to a specified JobId
40 Select item: (1-13): 12
41 Enter JobId to restore: 5
42 You have selected the following JobIds: 1,3,5
44 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
45 1,444 files inserted into the tree.
48 This project was funded by Bacula Systems.
50 \section{Source Address}
51 \index[general]{Source Address}
53 A feature has been added which allows the administrator to specify the address
54 from which the director and file daemons will attempt connections from. This
55 may be used to simplify system configuration overhead when working in complex
56 networks utilizing multi-homing and policy-routing.
58 To accomplish this, two new configuration directives have been implemented:
61 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
65 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
69 Simply adding specific host routes would have an undesirable side-effect: any
70 application trying to contact the destination host would be forced to use the
71 more specific route, possibly diverting management traffic onto a backup VLAN.
72 Instead of adding host routes for each client connected to a multi-homed backup
73 server (for example where there are management and backup VLANs), one can
74 use the new directives to specify a specific source address at the application
77 Additionally, this allows the simplification and abstraction of firewall rules
78 when dealing with a Hot-Standby director or storage daemon configuration. The
79 Hot-standby pair may share a CARP address, which connections must be sourced
80 from, while system services listen and act from the unique interface addresses.
82 This project was funded by Collaborative Fusion, Inc.
84 \section{Show volume availability when doing restore}
86 When doing a restore the restore selection dialog ends by displaying this
90 The job will require the following
91 Volume(s) Storage(s) SD Device(s)
92 ===========================================================================
103 Volumes marked with ``*'' are online.
106 This should help getting large restores through minimizing the time spent
107 waiting for operator to drop by and change tapes in the library.
109 This project was funded by Bacula Systems.
111 \section{Accurate estimate command}
113 The \texttt{estimate} command can now use the accurate code to detect changes
114 and give a better estimation.
116 You can set the accurate behavior on command line using
117 \texttt{accurate=yes/no} or use the Job setting as default value.
120 * estimate listing accurate=yes level=incremental job=BackupJob
123 This project was funded by Bacula Systems.
125 \chapter{New Features in 3.0.0}
126 \label{NewFeaturesChapter}
127 \index[general]{New Features}
129 This chapter presents the new features added to the development 2.5.x
130 versions to be released as Bacula version 3.0.0 sometime in April 2009.
132 \section{Accurate Backup}
133 \index[general]{Accurate Backup}
135 As with most other backup programs, by default Bacula decides what files to
136 backup for Incremental and Differental backup by comparing the change
137 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
138 backup completed. If one of those two times is later than the last backup
139 time, then the file will be backed up. This does not, however, permit tracking
140 what files have been deleted and will miss any file with an old time that may
141 have been restored to or moved onto the client filesystem.
143 \subsection{Accurate = \lt{}yes|no\gt{}}
144 If the {\bf Accurate = \lt{}yes|no\gt{}} directive is enabled (default no) in
145 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
146 backup, there is no difference, but for {\bf Differential} and {\bf
147 Incremental} backups, the Director will send a list of all previous files
148 backed up, and the File daemon will use that list to determine if any new files
149 have been added or or moved and if any files have been deleted. This allows
150 Bacula to make an accurate backup of your system to that point in time so that
151 if you do a restore, it will restore your system exactly.
154 about using Accurate backup is that it requires more resources (CPU and memory)
155 on both the Director and the Client machines to create the list of previous
156 files backed up, to send that list to the File daemon, for the File daemon to
157 keep the list (possibly very big) in memory, and for the File daemon to do
158 comparisons between every file in the FileSet and the list. In particular,
159 if your client has lots of files (more than a few million), you will need
160 lots of memory on the client machine.
162 Accurate must not be enabled when backing up with a plugin that is not
163 specially designed to work with Accurate. If you enable it, your restores
164 will probably not work correctly.
166 This project was funded by Bacula Systems.
171 \index[general]{Copy Jobs}
173 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
174 existing Migration feature with the exception that the Job that is copied is
175 left unchanged. This essentially creates two identical copies of the same
176 backup. However, the copy is treated as a copy rather than a backup job, and
177 hence is not directly available for restore. The {\bf restore} command lists
178 copy jobs and allows selection of copies by using \texttt{jobid=}
179 option. If the keyword {\bf copies} is present on the command line, Bacula will
180 display the list of all copies for selected jobs.
185 These JobIds have copies as follows:
186 +-------+------------------------------------+-----------+------------------+
187 | JobId | Job | CopyJobId | MediaType |
188 +-------+------------------------------------+-----------+------------------+
189 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
190 +-------+------------------------------------+-----------+------------------+
191 +-------+-------+----------+----------+---------------------+------------------+
192 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
193 +-------+-------+----------+----------+---------------------+------------------+
194 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
195 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
196 +-------+-------+----------+----------+---------------------+------------------+
197 You have selected the following JobIds: 19,2
199 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
200 5,611 files inserted into the tree.
205 The Copy Job runs without using the File daemon by copying the data from the
206 old backup Volume to a different Volume in a different Pool. See the Migration
207 documentation for additional details. For copy Jobs there is a new selection
208 criterium named PoolUncopiedJobs which copies all jobs from a pool to an other
209 pool which were not copied before. Next to that the client, volume, job or sql
210 query are possible ways of selecting jobs which should be copied. Selection
211 types like smallestvolume, oldestvolume, pooloccupancy and pooltime are
212 probably more suited for migration jobs only. But we could imagine some people
213 have a valid use for those kind of copy jobs too.
215 If bacula founds a copy when a job record is purged (deleted) from the catalog,
216 it will promote the copy as \textsl{real} backup and will make it available for
217 automatic restore. If more than one copy is available, it will promote the copy
218 with the smallest jobid.
220 A nice solution which can be build with the new copy jobs is what is
221 called the disk-to-disk-to-tape backup (DTDTT). A sample config could
222 look somethings like the one below:
226 Name = FullBackupsVirtualPool
228 Purge Oldest Volume = Yes
230 NextPool = FullBackupsTapePool
234 Name = FullBackupsTapePool
238 Volume Retention = 365 days
239 Storage = superloader
243 # Fake fileset for copy jobs
255 # Fake client for copy jobs
265 # Default template for a CopyDiskToTape Job
268 Name = CopyDiskToTape
270 Messages = StandardCopy
273 Selection Type = PoolUncopiedJobs
274 Maximum Concurrent Jobs = 10
276 Allow Duplicate Jobs = Yes
277 Allow Higher Duplicates = No
278 Cancel Queued Duplicates = No
279 Cancel Running Duplicates = No
284 Name = DaySchedule7:00
285 Run = Level=Full daily at 7:00
289 Name = CopyDiskToTapeFullBackups
291 Schedule = DaySchedule7:00
292 Pool = FullBackupsVirtualPool
293 JobDefs = CopyDiskToTape
297 The example above had 2 pool which are copied using the PoolUncopiedJobs
298 selection criteria. Normal Full backups go to the Virtual pool and are copied
299 to the Tape pool the next morning.
301 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
306 +-------+------------------------------------+-----------+------------------+
307 | JobId | Job | CopyJobId | MediaType |
308 +-------+------------------------------------+-----------+------------------+
309 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
310 +-------+------------------------------------+-----------+------------------+
313 \section{ACL Updates}
314 \index[general]{ACL Updates}
315 The whole ACL code had been overhauled and in this version each platforms has
316 different streams for each type of acl available on such an platform. As ACLs
317 between platforms tend to be not that portable (most implement POSIX acls but
318 some use an other draft or a completely different format) we currently only
319 allow certain platform specific ACL streams to be decoded and restored on the
320 same platform that they were created on. The old code allowed to restore ACL
321 cross platform but the comments already mention that not being to wise. For
322 backward compatability the new code will accept the two old ACL streams and
323 handle those with the platform specific handler. But for all new backups it
324 will save the ACLs using the new streams.
326 Currently the following platforms support ACLs:
330 \item {\bf Darwin/OSX}
339 Currently we support the following ACL types (these ACL streams use a reserved
340 part of the stream numbers):
343 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
345 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
346 string representation from acl\_to\_text (POSIX acl)
347 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
348 string representation from acl\_to\_text (POSIX acl) for default acls.
349 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
350 string representation from acl\_to\_text (POSIX acl) for access acls.
351 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
352 string representation from acltostr (POSIX acl)
353 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
354 representation from acl\_to\_text (POSIX acl) for default acls.
355 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
356 representation from acl\_to\_text (POSIX acl) for access acls.
357 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
358 string representation from acl\_to\_text (POSIX acl) for default acls.
359 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
360 representation from acl\_to\_text (POSIX acl) for access acls.
361 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
362 string representation from acl\_to\_text (POSIX acl) for default acls.
363 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
364 string representation from acl\_to\_text (POSIX acl) for default acls.
365 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
366 representation from acl\_to\_text (POSIX acl) for access acls.
367 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
368 string representation from acltotext or acl\_totext (POSIX acl)
369 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
370 representation from from acl\_totext (NFSv4 or ZFS acl)
373 In future versions we might support conversion functions from one type of acl
374 into an other for types that are either the same or easily convertable. For now
375 the streams are seperate and restoring them on a platform that doesn't
376 recognize them will give you a warning.
378 \section{Extended Attributes}
379 \index[general]{Extended Attributes}
380 Something that was on the project list for some time is now implemented for
381 platforms that support a similar kind of interface. Its the support for backup
382 and restore of so called extended attributes. As extended attributes are so
383 platform specific these attributes are saved in seperate streams for each
384 platform. Restores of the extended attributes can only be performed on the
385 same platform the backup was done. There is support for all types of extended
386 attributes, but restoring from one type of filesystem onto an other type of
387 filesystem on the same platform may lead to supprises. As extended attributes
388 can contain any type of data they are stored as a series of so called
389 value-pairs. This data must be seen as mostly binary and is stored as such.
390 As security labels from selinux are also extended attributes this option also
391 stores those labels and no specific code is enabled for handling selinux
394 Currently the following platforms support extended attributes:
396 \item {\bf Darwin/OSX}
402 On linux acls are also extended attributes, as such when you enable ACLs on a
403 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
404 and not the same exteneded attribute.
406 To enable the backup of extended attributes please add the following to your
421 \section{Shared objects}
422 \index[general]{Shared objects}
423 A default build of Bacula will now create the libraries as shared objects
424 (.so) rather than static libraries as was previously the case.
425 The shared libraries are built using {\bf libtool} so it should be quite
428 An important advantage of using shared objects is that on a machine with the
429 Directory, File daemon, the Storage daemon, and a console, you will have only
430 one copy of the code in memory rather than four copies. Also the total size of
431 the binary release is smaller since the library code appears only once rather
432 than once for every program that uses it; this results in significant reduction
433 in the size of the binaries particularly for the utility tools.
435 In order for the system loader to find the shared objects when loading the
436 Bacula binaries, the Bacula shared objects must either be in a shared object
437 directory known to the loader (typically /usr/lib) or they must be in the
438 directory that may be specified on the {\bf ./configure} line using the {\bf
439 {-}{-}libdir} option as:
442 ./configure --libdir=/full-path/dir
445 the default is /usr/lib. If {-}{-}libdir is specified, there should be
446 no need to modify your loader configuration provided that
447 the shared objects are installed in that directory (Bacula
448 does this with the make install command). The shared objects
449 that Bacula references are:
458 These files are symbolically linked to the real shared object file,
459 which has a version number to permit running multiple versions of
460 the libraries if desired (not normally the case).
462 If you have problems with libtool or you wish to use the old
463 way of building static libraries, or you want to build a static
464 version of Bacula you may disable
465 libtool on the configure command line with:
468 ./configure --disable-libtool
472 \section{Building Static versions of Bacula}
473 \index[general]{Static linking}
474 In order to build static versions of Bacula, in addition
475 to configuration options that were needed you now must
476 also add --disable-libtool. Example
479 ./configure --enable-static-client-only --disable-libtool
483 \section{Virtual Backup (Vbackup)}
484 \index[general]{Virtual Backup}
485 \index[general]{Vbackup}
487 Bacula's virtual backup feature is often called Synthetic Backup or
488 Consolidation in other backup products. It permits you to consolidate the
489 previous Full backup plus the most recent Differential backup and any
490 subsequent Incremental backups into a new Full backup. This new Full
491 backup will then be considered as the most recent Full for any future
492 Incremental or Differential backups. The VirtualFull backup is
493 accomplished without contacting the client by reading the previous backup
494 data and writing it to a volume in a different pool.
496 In some respects the Vbackup feature works similar to a Migration job, in
497 that Bacula normally reads the data from the pool specified in the
498 Job resource, and writes it to the {\bf Next Pool} specified in the
499 Job resource. Note, this means that usually the output from the Virtual
500 Backup is written into a different pool from where your prior backups
501 are saved. Doing it this way guarantees that you will not get a deadlock
502 situation attempting to read and write to the same volume in the Storage
503 daemon. If you then want to do subsequent backups, you may need to
504 move the Virtual Full Volume back to your normal backup pool.
505 Alternatively, you can set your {\bf Next Pool} to point to the current
506 pool. This will cause Bacula to read and write to Volumes in the
507 current pool. In general, this will work, because Bacula will
508 not allow reading and writing on the same Volume. In any case, once
509 a VirtualFull has been created, and a restore is done involving the
510 most current Full, it will read the Volume or Volumes by the VirtualFull
511 regardless of in which Pool the Volume is found.
513 The Vbackup is enabled on a Job by Job in the Job resource by specifying
514 a level of {\bf VirtualFull}.
516 A typical Job resource definition might look like the following:
530 # Default pool definition
534 Recycle = yes # Automatically recycle Volumes
535 AutoPrune = yes # Prune expired volumes
536 Volume Retention = 365d # one year
544 Recycle = yes # Automatically recycle Volumes
545 AutoPrune = yes # Prune expired volumes
546 Volume Retention = 365d # one year
547 Storage = DiskChanger
550 # Definition of file storage device
557 Maximum Concurrent Jobs = 5
560 # Definition of DDS Virtual tape disk storage device
563 Address = localhost # N.B. Use a fully qualified name here
566 Media Type = DiskChangerMedia
567 Maximum Concurrent Jobs = 4
572 Then in bconsole or via a Run schedule, you would run the job as:
575 run job=MyBackup level=Full
576 run job=MyBackup level=Incremental
577 run job=MyBackup level=Differential
578 run job=MyBackup level=Incremental
579 run job=MyBackup level=Incremental
582 So providing there were changes between each of those jobs, you would end up
583 with a Full backup, a Differential, which includes the first Incremental
584 backup, then two Incremental backups. All the above jobs would be written to
585 the {\bf Default} pool.
587 To consolidate those backups into a new Full backup, you would run the
591 run job=MyBackup level=VirtualFull
594 And it would produce a new Full backup without using the client, and the output
595 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
597 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
600 Note, the Start and End time of the Virtual Full backup is set to the
601 values for the last job included in the Virtual Full (in the above example,
602 it is an Increment). This is so that if another incremental is done, which
603 will be based on the Virtual Full, it will backup all files from the
604 last Job included in the Virtual Full rather than from the time the Virtual
605 Full was actually run.
609 \section{Catalog Format}
610 \index[general]{Catalog Format}
611 Bacula 3.0 comes with some changes to the catalog format. The upgrade
612 operation will convert the FileId field of the File table from 32 bits (max 4
613 billion table entries) to 64 bits (very large number of items). The
614 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
615 your catalog during the conversion. Also you won't be able to run jobs during
616 this conversion period. For example, a 3 million file catalog will take 2
617 minutes to upgrade on a normal machine. Please don't forget to make a valid
618 backup of your database before executing the upgrade script. See the
619 ReleaseNotes for additional details.
621 \section{64 bit Windows Client}
622 \index[general]{Win64 Client}
623 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
624 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
625 As a consequence, we are also releasing a 64 bit version of the Bacula
626 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
627 These binaries should only be installed on 64 bit Windows operating systems.
628 What is important is not your hardware but whether or not you have
629 a 64 bit version of the Windows OS.
631 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
633 \item Before installing the Win64 Bacula Client, you must totally
634 deinstall any prior 2.4.x Client installation using the
635 Bacula deinstallation (see the menu item). You may want
636 to save your .conf files first.
637 \item Only the Client (File daemon) is ported to Win64, the Director
638 and the Storage daemon are not in the 64 bit Windows installer.
639 \item bwx-console is not yet ported.
640 \item bconsole is ported but it has not been tested.
641 \item The documentation is not included in the installer.
642 \item Due to Vista security restrictions imposed on a default installation
643 of Vista, before upgrading the Client, you must manually stop
644 any prior version of Bacula from running, otherwise the install
646 \item Due to Vista security restrictions imposed on a default installation
647 of Vista, attempting to edit the conf files via the menu items
648 will fail. You must directly edit the files with appropriate
649 permissions. Generally double clicking on the appropriate .conf
650 file will work providing you have sufficient permissions.
651 \item All Bacula files are now installed in
652 {\bf C:/Program Files/Bacula} except the main menu items,
653 which are installed as before. This vastly simplifies the installation.
654 \item If you are running on a foreign language version of Windows, most
655 likely {\bf C:/Program Files} does not exist, so you should use the
656 Custom installation and enter an appropriate location to install
658 \item The 3.0.0 Win32 Client continues to install files in the locations used
659 by prior versions. For the next version we will convert it to use
660 the same installation conventions as the Win64 version.
663 This project was funded by Bacula Systems.
666 \section{Duplicate Job Control}
667 \index[general]{Duplicate Jobs}
668 The new version of Bacula provides four new directives that
669 give additional control over what Bacula does if duplicate jobs
670 are started. A duplicate job in the sense we use it here means
671 a second or subsequent job with the same name starts. This
672 happens most frequently when the first job runs longer than expected because no
675 The four directives each take as an argument a {\bf yes} or {\bf no} value and
676 are specified in the Job resource.
680 \subsection{Allow Duplicate Jobs = \lt{}yes|no\gt{}}
681 \index[general]{Allow Duplicate Jobs}
682 If this directive is enabled duplicate jobs will be run. If
683 the directive is set to {\bf no} (default) then only one job of a given name
684 may run at one time, and the action that Bacula takes to ensure only
685 one job runs is determined by the other directives (see below).
687 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
688 are present and none of the three directives given below permit
689 cancelling a job, then the current job (the second one started)
693 \subsection{Allow Higher Duplicates = \lt{}yes|no\gt{}}
694 \index[general]{Allow Higher Duplicates}
695 If this directive is set to {\bf yes} (default) the job with a higher
696 priority (lower priority number) will be permitted to run, and
697 the current job will be cancelled. If the
698 priorities of the two jobs are the same, the outcome is determined by
699 other directives (see below).
701 \subsection{Cancel Queued Duplicates = \lt{}yes|no\gt{}}
702 \index[general]{Cancel Queued Duplicates}
703 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
704 if this directive is set to {\bf yes} any job that is
705 already queued to run but not yet running will be canceled.
706 The default is {\bf no}.
708 \subsection{Cancel Running Duplicates = \lt{}yes|no\gt{}}
709 \index[general]{Cancel Running Duplicates}
710 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
711 if this directive is set to {\bf yes} any job that is already running
712 will be canceled. The default is {\bf no}.
715 \section{TLS Authentication}
716 \index[general]{TLS Authentication}
717 In Bacula version 2.5.x and later, in addition to the normal Bacula
718 CRAM-MD5 authentication that is used to authenticate each Bacula
719 connection, you can specify that you want TLS Authentication as well,
720 which will provide more secure authentication.
722 This new feature uses Bacula's existing TLS code (normally used for
723 communications encryption) to do authentication. To use it, you must
724 specify all the TLS directives normally used to enable communications
725 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
728 \subsection{TLS Authenticate = yes}
730 TLS Authenticate = yes
733 in the main daemon configuration resource (Director for the Director,
734 Client for the File daemon, and Storage for the Storage daemon).
736 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
737 authentication, Bacula will also do TLS authentication, then TLS
738 encryption will be turned off, and the rest of the communication between
739 the two Bacula daemons will be done without encryption.
741 If you want to encrypt communications data, use the normal TLS directives
742 but do not turn on {\bf TLS Authenticate}.
744 \section{bextract non-portable Win32 data}
745 \index[general]{bextract handles Win32 non-portable data}
746 {\bf bextract} has been enhanced to be able to restore
747 non-portable Win32 data to any OS. Previous versions were
748 unable to restore non-portable Win32 data to machines that
749 did not have the Win32 BackupRead and BackupWrite API calls.
751 \section{State File updated at Job Termination}
752 \index[general]{State File}
753 In previous versions of Bacula, the state file, which provides a
754 summary of previous jobs run in the {\bf status} command output was
755 updated only when Bacula terminated, thus if the daemon crashed, the
756 state file might not contain all the run data. This version of
757 the Bacula daemons updates the state file on each job termination.
759 \section{MaxFullInterval = \lt{}time-interval\gt{}}
760 \index[general]{MaxFullInterval}
761 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
762 can be used to specify the maximum time interval between {\bf Full} backup
763 jobs. When a job starts, if the time since the last Full backup is
764 greater than the specified interval, and the job would normally be an
765 {\bf Incremental} or {\bf Differential}, it will be automatically
766 upgraded to a {\bf Full} backup.
768 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
769 \index[general]{MaxDiffInterval}
770 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
771 can be used to specify the maximum time interval between {\bf Differential} backup
772 jobs. When a job starts, if the time since the last Differential backup is
773 greater than the specified interval, and the job would normally be an
774 {\bf Incremental}, it will be automatically
775 upgraded to a {\bf Differential} backup.
777 \section{Honor No Dump Flag = \lt{}yes|no\gt{}}
778 \index[general]{MaxDiffInterval}
779 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
780 by the user, and when it is set it is an indication to backup programs
781 to not backup that particular file. This version of Bacula contains a
782 new Options directive within a FileSet resource, which instructs Bacula to
783 obey this flag. The new directive is:
786 Honor No Dump Flag = yes|no
789 The default value is {\bf no}.
792 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
793 \index[general]{IgnoreDir}
794 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
795 can be added to the Include section of the FileSet resource. If the specified
796 filename ({\bf filename-string}) is found on the Client in any directory to be
797 backed up, the whole directory will be ignored (not backed up). For example:
800 # List of files to be backed up
808 Exclude Dir Containing = .excludeme
813 But in /home, there may be hundreds of directories of users and some
814 people want to indicate that they don't want to have certain
815 directories backed up. For example, with the above FileSet, if
816 the user or sysadmin creates a file named {\bf .excludeme} in
817 specific directories, such as
820 /home/user/www/cache/.excludeme
821 /home/user/temp/.excludeme
824 then Bacula will not backup the two directories named:
831 NOTE: subdirectories will not be backed up. That is, the directive
832 applies to the two directories in question and any children (be they
833 files, directories, etc).
836 \section{Bacula Plugins}
837 \index[general]{Plugin}
838 Support for shared object plugins has been implemented in the Linux, Unix
839 and Win32 File daemons. The API will be documented separately in
840 the Developer's Guide or in a new document. For the moment, there is
841 a single plugin named {\bf bpipe} that allows an external program to
842 get control to backup and restore a file.
844 Plugins are also planned (partially implemented) in the Director and the
847 \subsection{Plugin Directory}
848 \index[general]{Plugin Directory}
849 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
850 be added to the daemon definition resource. The directory takes a quoted
851 string argument, which is the name of the directory in which the daemon can
852 find the Bacula plugins. If this directive is not specified, Bacula will not
853 load any plugins. Since each plugin has a distinctive name, all the daemons
854 can share the same plugin directory.
856 \subsection{Plugin Options}
857 \index[general]{Plugin Options}
858 The {\bf Plugin Options} directive takes a quoted string
859 arguement (after the equal sign) and may be specified in the
860 Job resource. The options specified will be passed to all plugins
861 when they are run. This each plugin must know what it is looking
862 for. The value defined in the Job resource can be modified
863 by the user when he runs a Job via the {\bf bconsole} command line
866 Note: this directive may be specified, and there is code to modify
867 the string in the run command, but the plugin options are not yet passed to
868 the plugin (i.e. not fully implemented).
870 \subsection{Plugin Options ACL}
871 \index[general]{Plugin Options ACL}
872 The {\bf Plugin Options ACL} directive may be specified in the
873 Director's Console resource. It functions as all the other ACL commands
874 do by permitting users running restricted consoles to specify a
875 {\bf Plugin Options} that overrides the one specified in the Job
876 definition. Without this directive restricted consoles may not modify
879 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
880 \index[general]{Plugin}
881 The {\bf Plugin} directive is specified in the Include section of
882 a FileSet resource where you put your {\bf File = xxx} directives.
898 In the above example, when the File daemon is processing the directives
899 in the Include section, it will first backup all the files in {\bf /home}
900 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
901 the Plugin Directory. The syntax and semantics of the Plugin directive
902 require the first part of the string up to the colon (:) to be the name
903 of the plugin. Everything after the first colon is ignored by the File daemon but
904 is passed to the plugin. Thus the plugin writer may define the meaning of the
905 rest of the string as he wishes.
907 Please see the next section for information about the {\bf bpipe} Bacula
910 \section{The bpipe Plugin}
911 \index[general]{The bpipe Plugin}
912 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
913 the Bacula source distribution. When the plugin is compiled and linking into
914 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
916 The purpose of the plugin is to provide an interface to any system program for
917 backup and restore. As specified above the {\bf bpipe} plugin is specified in
918 the Include section of your Job's FileSet resource. The full syntax of the
919 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
920 to specify the sytax as it wishes) is:
923 Plugin = "<field1>:<field2>:<field3>:<field4>"
928 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
929 stripped off, so in this case, we would put {\bf bpipe} in this field.
931 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
932 pseudo path and filename under which the backup will be saved. This pseudo
933 path and filename will be seen by the user in the restore file tree.
934 For example, if the value is {\bf /MYSQL/regress.sql}, the data
935 backed up by the plugin will be put under that "pseudo" path and filename.
936 You must be careful to choose a naming convention that is unique to avoid
937 a conflict with a path and filename that actually exists on your system.
939 \item {\bf field3} for the {\bf bpipe} plugin
940 specifies the "reader" program that is called by the plugin during
941 backup to read the data. {\bf bpipe} will call this program by doing a
944 \item {\bf field4} for the {\bf bpipe} plugin
945 specifies the "writer" program that is called by the plugin during
946 restore to write the data back to the filesystem.
949 Putting it all together, the full plugin directive line might look
953 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
954 --opt --databases bacula:mysql"
957 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
958 would be written on a single line.
960 This causes the File daemon to call the {\bf bpipe} plugin, which will write
961 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
962 program {\bf mysqldump -f --opt --database bacula} to read the data during
963 backup. The mysqldump command outputs all the data for the database named
964 {\bf bacula}, which will be read by the plugin and stored in the backup.
965 During restore, the data that was backed up will be sent to the program
966 specified in the last field, which in this case is {\bf mysql}. When
967 {\bf mysql} is called, it will read the data sent to it by the plugn
968 then write it back to the same database from which it came ({\bf bacula}
971 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
972 the data from a specified program to Bacula for backup, and then from Bacula to
973 a specified program for restore.
975 By using different command lines to {\bf bpipe},
976 you can backup any kind of data (ASCII or binary) depending
977 on the program called.
979 \section{Microsoft Exchange Server 2003/2007 Plugin}
980 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
981 \subsection{Background}
982 The Exchange plugin was made possible by a funded development project
983 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
984 The code for the plugin was written by James Harper, and the Bacula core
985 code by Kern Sibbald. All the code for this funded development has become
986 part of the Bacula project. Thanks to everyone who made it happen.
988 \subsection{Concepts}
989 Although it is possible to backup Exchange using Bacula VSS the Exchange
990 plugin adds a good deal of functionality, because while Bacula VSS
991 completes a full backup (snapshot) of Exchange, it does
992 not support Incremental or Differential backups, restoring is more
993 complicated, and a single database restore is not possible.
995 Microsoft Exchange organises its storage into Storage Groups with
996 Databases inside them. A default installation of Exchange will have a
997 single Storage Group called 'First Storage Group', with two Databases
998 inside it, "Mailbox Store (SERVER NAME)" and
999 "Public Folder Store (SERVER NAME)",
1000 which hold user email and public folders respectively.
1002 In the default configuration, Exchange logs everything that happens to
1003 log files, such that if you have a backup, and all the log files since,
1004 you can restore to the present time. Each Storage Group has its own set
1005 of log files and operates independently of any other Storage Groups. At
1006 the Storage Group level, the logging can be turned off by enabling a
1007 function called "Enable circular logging". At this time the Exchange
1008 plugin will not function if this option is enabled.
1010 The plugin allows backing up of entire storage groups, and the restoring
1011 of entire storage groups or individual databases. Backing up and
1012 restoring at the individual mailbox or email item is not supported but
1013 can be simulated by use of the "Recovery" Storage Group (see below).
1015 \subsection{Installing}
1016 The Exchange plugin requires a DLL that is shipped with Microsoft
1017 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1018 correctly the Exchange plugin should find this automatically and run
1019 without any additional installation.
1021 If the DLL can not be found automatically it will need to be copied into
1022 the Bacula installation
1023 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1024 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1025 default Exchange installation.
1027 \subsection{Backup up}
1028 To back up an Exchange server the Fileset definition must contain at
1029 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1030 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1031 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1032 up files are prefixed with something that isn't going to share a name
1033 with something outside the plugin, and the 'Microsoft Information Store'
1034 bit is required also. It is also possible to add the name of a storage
1035 group to the "Plugin =" line, eg \\
1036 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1037 if you want only a single storage group backed up.
1039 Additionally, you can suffix the 'Plugin =' directive with
1040 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1041 database at the end of a full backup.
1043 An Incremental or Differential backup will backup only the database logs
1044 for each Storage Group by inspecting the "modified date" on each
1045 physical log file. Because of the way the Exchange API works, the last
1046 logfile backed up on each backup will always be backed up by the next
1047 Incremental or Differential backup too. This adds 5MB to each
1048 Incremental or Differential backup size but otherwise does not cause any
1051 By default, a normal VSS fileset containing all the drive letters will
1052 also back up the Exchange databases using VSS. This will interfere with
1053 the plugin and Exchange's shared ideas of when the last full backup was
1054 done, and may also truncate log files incorrectly. It is important,
1055 therefore, that the Exchange database files be excluded from the backup,
1056 although the folders the files are in should be included, or they will
1057 have to be recreated manually if a baremetal restore is done.
1062 File = C:/Program Files/Exchsrvr/mdbdata
1063 Plugin = "exchange:..."
1066 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1067 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1068 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1069 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1070 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1071 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1072 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1077 The advantage of excluding the above files is that you can significantly
1078 reduce the size of your backup since all the important Exchange files
1079 will be properly saved by the Plugin.
1082 \subsection{Restoring}
1083 The restore operation is much the same as a normal Bacula restore, with
1084 the following provisos:
1087 \item The {\bf Where} restore option must not be specified
1088 \item Each Database directory must be marked as a whole. You cannot just
1089 select (say) the .edb file and not the others.
1090 \item If a Storage Group is restored, the directory of the Storage Group
1092 \item It is possible to restore only a subset of the available log files,
1093 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1094 if a log file is missing from the sequence of log files
1095 \item Each database to be restored must be dismounted and marked as "Can be
1096 overwritten by restore"
1097 \item If an entire Storage Group is to be restored (eg all databases and
1098 logs in the Storage Group), then it is best to manually delete the
1099 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1100 as Exchange can get confused by stray log files lying around.
1103 \subsection{Restoring to the Recovery Storage Group}
1104 The concept of the Recovery Storage Group is well documented by
1106 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1107 but to briefly summarize...
1109 Microsoft Exchange allows the creation of an additional Storage Group
1110 called the Recovery Storage Group, which is used to restore an older
1111 copy of a database (e.g. before a mailbox was deleted) into without
1112 messing with the current live data. This is required as the Standard and
1113 Small Business Server versions of Exchange can not ordinarily have more
1114 than one Storage Group.
1116 To create the Recovery Storage Group, drill down to the Server in Exchange
1117 System Manager, right click, and select
1118 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1119 locations and click OK. On the Recovery Storage Group, right click and
1120 select {\bf "Add Database to Recover..."} and select the database you will
1123 Restore only the single database nominated as the database in the
1124 Recovery Storage Group. Exchange will redirect the restore to the
1125 Recovery Storage Group automatically.
1126 Then run the restore.
1128 \subsection{Restoring on Microsoft Server 2007}
1129 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1130 2007, and henc you use a new proceedure for recovering a single mail box.
1131 This procedure is ducomented by Microsoft at:
1132 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1133 and involves using the {\bf Restore-Mailbox} and {\bf
1134 Get-MailboxStatistics} shell commands.
1136 \subsection{Caveats}
1137 This plugin is still being developed, so you should consider it
1138 currently in BETA test, and thus use in a production environment
1139 should be done only after very careful testing.
1141 When doing a full backup, the Exchange database logs are truncated by
1142 Exchange as soon as the plugin has completed the backup. If the data
1143 never makes it to the backup medium (eg because of spooling) then the
1144 logs will still be truncated, but they will also not have been backed
1145 up. A solution to this is being worked on. You will have to schedule a
1146 new Full backup to ensure that your next backups will be usable.
1148 The "Enable Circular Logging" option cannot be enabled or the plugin
1151 Exchange insists that a successful Full backup must have taken place if
1152 an Incremental or Differential backup is desired, and the plugin will
1153 fail if this is not the case. If a restore is done, Exchange will
1154 require that a Full backup be done before an Incremental or Differential
1157 The plugin will most likely not work well if another backup application
1158 (eg NTBACKUP) is backing up the Exchange database, especially if the
1159 other backup application is truncating the log files.
1161 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1162 we recommend either carefully testing or that you avoid this option for
1165 The Exchange plugin is not called during processing the bconsole {\bf
1166 estimate} command, and so anything that would be backed up by the plugin
1167 will not be added to the estimate total that is displayed.
1170 \section{libdbi Framework}
1171 \index[general]{libdbi Framework}
1172 As a general guideline, Bacula has support for a few catalog database drivers
1173 (MySQL, PostgreSQL, SQLite)
1174 coded natively by the Bacula team. With the libdbi implementation, which is a
1175 Bacula driver that uses libdbi to access the catalog, we have an open field to
1176 use many different kinds database engines following the needs of users.
1178 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1179 implements a database-independent abstraction layer in C, similar to the
1180 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1181 leverage the power of multiple databases and multiple simultaneous database
1182 connections by using this framework.
1184 Currently the libdbi driver in Bacula project only supports the same drivers
1185 natively coded in Bacula. However the libdbi project has support for many
1186 others database engines. You can view the list at
1187 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1188 supported by Bacula, however, they must be tested properly by the Bacula team.
1190 Some of benefits of using libdbi are:
1192 \item The possibility to use proprietary databases engines in which your
1193 proprietary licenses prevent the Bacula team from developing the driver.
1194 \item The possibility to use the drivers written for the libdbi project.
1195 \item The possibility to use other database engines without recompiling Bacula
1196 to use them. Just change one line in bacula-dir.conf
1197 \item Abstract Database access, this is, unique point to code and profiling
1198 catalog database access.
1201 The following drivers have been tested:
1203 \item PostgreSQL, with and without batch insert
1204 \item Mysql, with and without batch insert
1209 In the future, we will test and approve to use others databases engines
1210 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1212 To compile Bacula to support libdbi we need to configure the code with the
1213 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1214 [database] is the database engine to be used with Bacula (of course we can
1215 change the driver in file bacula-dir.conf, see below). We must configure the
1216 access port of the database engine with the option --with-db-port, because the
1217 libdbi framework doesn't know the default access port of each database.
1219 The next phase is checking (or configuring) the bacula-dir.conf, example:
1223 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1224 dbname = regress; user = regress; password = ""
1228 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1229 mysql database. Currently the drivers supported by Bacula are: postgresql,
1230 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1232 The following limitations apply when Bacula is set to use the libdbi framework:
1233 - Not tested on the Win32 platform
1234 - A little performance is lost if comparing with native database driver.
1235 The reason is bound with the database driver provided by libdbi and the
1236 simple fact that one more layer of code was added.
1238 It is important to remember, when compiling Bacula with libdbi, the
1239 following packages are needed:
1241 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1242 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1245 You can download them and compile them on your system or install the packages
1246 from your OS distribution.
1248 \section{Console Command Additions and Enhancements}
1249 \index[general]{Console Additions}
1251 \subsection{Display Autochanger Content}
1252 \index[general]{StatusSlots}
1254 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1255 autochanger content.
1259 Slot | Volume Name | Status | Media Type | Pool |
1260 ------+---------------+----------+-------------------+------------|
1261 1 | 00001 | Append | DiskChangerMedia | Default |
1262 2 | 00002 | Append | DiskChangerMedia | Default |
1263 3*| 00003 | Append | DiskChangerMedia | Scratch |
1268 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1269 {\bf update slots} command to synchronize autochanger content with your
1272 \subsection{list joblog job=xxx or jobid=nnn}
1273 \index[general]{list joblog}
1274 A new list command has been added that allows you to list the contents
1275 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1276 or for a particular JobId. The {\bf llist} command will include a line with
1277 the time and date of the entry.
1279 Note for the catalog to have Job Log entries, you must have a directive
1286 In your Director's {\bf Messages} resource.
1288 \subsection{Use separator for multiple commands}
1289 \index[general]{Command Separator}
1290 When using bconsole with readline, you can set the command separator with
1291 \textbf{@separator} command to one
1292 of those characters to write commands who require multiple input in one line.
1294 !$%&'()*+,-/:;<>?[]^`{|}~
1297 \subsection{Deleting Volumes}
1298 The delete volume bconsole command has been modified to
1299 require an asterisk (*) in front of a MediaId otherwise the
1300 value you enter is a taken to be a Volume name. This is so that
1301 users may delete numeric Volume names. The previous Bacula versions
1302 assumed that all input that started with a number was a MediaId.
1304 This new behavior is indicated in the prompt if you read it
1307 \section{Bare Metal Recovery}
1308 The old bare metal recovery project is essentially dead. One
1309 of the main features of it was that it would build a recovery
1310 CD based on the kernel on your system. The problem was that
1311 every distribution has a different boot procedure and different
1312 scripts, and worse yet, the boot procedures and scripts change
1313 from one distribution to another. This meant that maintaining
1314 (keeping up with the changes) the rescue CD was too much work.
1316 To replace it, a new bare metal recovery USB boot stick has been developed
1317 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1318 boot from a USB key.
1322 \item Recovery can be done from within graphical environment.
1323 \item Recovery can be done in a shell.
1324 \item Ubuntu boots on a large number of Linux systems.
1325 \item The process of updating the system and adding new
1326 packages is not too difficult.
1327 \item The USB key can easily be upgraded to newer Ubuntu versions.
1328 \item The USB key has writable partitions for modifications to
1329 the OS and for modification to your home directory.
1330 \item You can add new files/directories to the USB key very easily.
1331 \item You can save the environment from multiple machines on
1333 \item Bacula Systems is funding its ongoing development.
1336 The disadvantages are:
1338 \item The USB key is usable but currently under development.
1339 \item Not everyone may be familiar with Ubuntu (no worse
1341 \item Some older OSes cannot be booted from USB. This can
1342 be resolved by first booting a Ubuntu LiveCD then plugging
1344 \item Currently the documentation is sketchy and not yet added
1345 to the main manual. See below ...
1348 The documentation and the code can be found in the {\bf rescue} package
1349 in the directory {\bf linux/usb}.
1351 \section{Miscellaneous}
1352 \index[general]{Misc New Features}
1354 \subsection{Allow Mixed Priority = \lt{}yes|no\gt{}}
1355 \index[general]{Allow Mixed Priority}
1356 This directive is only implemented in version 2.5 and later. When
1357 set to {\bf yes} (default {\bf no}), this job may run even if lower
1358 priority jobs are already running. This means a high priority job
1359 will not have to wait for other jobs to finish before starting.
1360 The scheduler will only mix priorities when all running jobs have
1363 Note that only higher priority jobs will start early. Suppose the
1364 director will allow two concurrent jobs, and that two jobs with
1365 priority 10 are running, with two more in the queue. If a job with
1366 priority 5 is added to the queue, it will be run as soon as one of
1367 the running jobs finishes. However, new priority 10 jobs will not
1368 be run until the priority 5 job has finished.
1370 \subsection{Bootstrap File Directive -- FileRegex}
1371 \index[general]{Bootstrap File Directive}
1372 {\bf FileRegex} is a new command that can be added to the bootstrap
1373 (.bsr) file. The value is a regular expression. When specified, only
1374 matching filenames will be restored.
1376 During a restore, if all File records are pruned from the catalog
1377 for a Job, normally Bacula can restore only all files saved. That
1378 is there is no way using the catalog to select individual files.
1379 With this new feature, Bacula will ask if you want to specify a Regex
1380 expression for extracting only a part of the full backup.
1383 Building directory tree for JobId(s) 1,3 ...
1384 There were no files inserted into the tree, so file selection
1385 is not possible.Most likely your retention policy pruned the files
1387 Do you want to restore all the files? (yes|no): no
1389 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1390 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1393 \subsection{Bootstrap File Optimization Changes}
1394 In order to permit proper seeking on disk files, we have extended the bootstrap
1395 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1396 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1397 address range and end address range respectively. These two directives replace
1398 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1399 VolEndBlock} directives. Bootstrap files containing the old directives will
1400 still work, but will not properly take advantage of proper disk seeking, and
1401 may read completely to the end of a disk volume during a restore. With the new
1402 format (automatically generated by the new Director), restores will seek
1403 properly and stop reading the volume when all the files have been restored.
1405 \subsection{Solaris ZFS/NFSv4 ACLs}
1406 This is an upgrade of the previous Solaris ACL backup code
1407 to the new library format, which will backup both the old
1408 POSIX(UFS) ACLs as well as the ZFS ACLs.
1410 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1411 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1412 be used to transfer from UFS to ZFS filesystems.
1415 \subsection{Virtual Tape Emulation}
1416 \index[general]{Virtual Tape Emulation}
1417 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1418 the tape code but actually reading and writing to a disk file. Used with the
1419 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1420 and 700 slots. This feature is most useful in testing. It is enabled
1421 by using {\bf Device Type = vtape} in the Storage daemon's Device
1422 directive. This feature is only implemented on Linux machines and should not be
1423 used for production.
1425 \subsection{Bat Enhancements}
1426 \index[general]{Bat Enhancements}
1427 Bat (the Bacula Administration Tool) GUI program has been significantly
1428 enhanced and stabilized. In particular, there are new table based status
1429 commands; it can now be easily localized using Qt4 Linguist.
1431 The Bat communications protocol has been significantly enhanced to improve
1432 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1433 the Director you are using otherwise the communications protocol will not
1436 \subsection{RunScript Enhancements}
1437 \index[general]{RunScript Enhancements}
1438 The {\bf RunScript} resource has been enhanced to permit multiple
1439 commands per RunScript. Simply specify multiple {\bf Command} directives
1446 Command = "/bin/echo test"
1447 Command = "/bin/echo an other test"
1448 Command = "/bin/echo 3 commands in the same runscript"
1455 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1456 implemented, which runs the command after the Volume Shadow Copy has been made.
1458 Console commands can be specified within a RunScript by using:
1459 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1460 carefully tested and debugged and is known to easily crash the Director.
1461 We would appreciate feedback. Due to the recursive nature of this command, we
1462 may remove it before the final release.
1464 \subsection{Status Enhancements}
1465 \index[general]{Status Enhancements}
1466 The bconsole {\bf status dir} output has been enhanced to indicate
1467 Storage daemon job spooling and despooling activity.
1469 \subsection{Connect Timeout}
1470 \index[general]{Connect Timeout}
1471 The default connect timeout to the File
1472 daemon has been set to 3 minutes. Previously it was 30 minutes.
1474 \subsection{ftruncate for NFS Volumes}
1475 \index[general]{ftruncate for NFS Volumes}
1476 If you write to a Volume mounted by NFS (say on a local file server),
1477 in previous Bacula versions, when the Volume was recycled, it was not
1478 properly truncated because NFS does not implement ftruncate (file
1479 truncate). This is now corrected in the new version because we have
1480 written code (actually a kind user) that deletes and recreates the Volume,
1481 thus accomplishing the same thing as a truncate.
1483 \subsection{Support for Ubuntu}
1484 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1485 version of Linux, and thus now provides correct autostart routines.
1486 Since Ubuntu officially supports Bacula, you can also obtain any
1487 recent release of Bacula from the Ubuntu repositories.
1489 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1490 \index[general]{Recycle Pool}
1491 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1492 be placed (moved) when it is recycled. Without this directive, a Volume will
1493 remain in the same pool when it is recycled. With this directive, it can be
1494 moved automatically to any existing pool during a recycle. This directive is
1495 probably most useful when defined in the Scratch pool, so that volumes will
1496 be recycled back into the Scratch pool.
1498 \subsection{FD Version}
1499 \index[general]{FD Version}
1500 The File daemon to Director protocol now includes a version
1501 number, which although there is no visible change for users,
1502 will help us in future versions automatically determine
1503 if a File daemon is not compatible.
1505 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1506 \index[general]{Max Run Sched Time}
1507 The time specifies the maximum allowed time that a job may run, counted from
1508 when the job was scheduled. This can be useful to prevent jobs from running
1509 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1512 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1513 \index[general]{Max Wait Time}
1514 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1515 of checking the maximum allowed time that a job may block for a resource,
1516 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1517 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1518 their job depending on the level. Now, they have to use
1519 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1520 directives are now deprecated.
1522 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1523 \index[general]{Incremental Max Wait Time}
1524 \index[general]{Differential Max Wait Time}
1526 These directives have been deprecated in favor of
1527 \texttt{Incremental|Differential Max Run Time}.
1529 \subsection{Max Run Time directives}
1530 \index[general]{Max Run Time directives}
1531 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1532 maximum allowed time that a job can run depending on the level.
1534 \addcontentsline{lof}{figure}{Job time control directives}
1535 \includegraphics{\idir different_time.eps}
1537 \subsection{Statistics Enhancements}
1538 \index[general]{Statistics Enhancements}
1539 If you (or probably your boss) want to have statistics on your backups to
1540 provide some \textit{Service Level Agreement} indicators, you could use a few
1541 SQL queries on the Job table to report how many:
1545 \item jobs have been successful
1546 \item files have been backed up
1550 However, these statistics are accurate only if your job retention is greater
1551 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1552 be able to use them.
1554 Now, you can use the \textbf{update stats [days=num]} console command to fill
1555 the JobHistory table with new Job records. If you want to be sure to take in
1556 account only \textbf{good jobs}, ie if one of your important job has failed but
1557 you have fixed the problem and restarted it on time, you probably want to
1558 delete the first \textit{bad} job record and keep only the successful one. For
1559 that simply let your staff do the job, and update JobHistory table after two or
1560 three days depending on your organization using the \textbf{[days=num]} option.
1562 These statistics records aren't used for restoring, but mainly for
1563 capacity planning, billings, etc.
1565 The Bweb interface provides a statistics module that can use this feature. You
1566 can also use tools like Talend or extract information by yourself.
1568 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1569 the length of time that Bacula will keep statistics job records in the Catalog
1570 database after the Job End time. (In \texttt{JobHistory} table) When this time
1571 period expires, and if user runs \texttt{prune stats} command, Bacula will
1572 prune (remove) Job records that are older than the specified period.
1574 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1575 job to maintain statistics.
1578 Name = BackupCatalog
1581 Console = "update stats days=3"
1582 Console = "prune stats yes"
1589 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1590 \index[general]{ScratchPool}
1591 This directive permits to specify a specific \textsl{Scratch} pool for the
1592 current pool. This is useful when using multiple storage sharing the same
1593 mediatype or when you want to dedicate volumes to a particular set of pool.
1595 \subsection{Enhanced Attribute Despooling}
1596 \index[general]{Attribute Despooling}
1597 If the storage daemon and the Director are on the same machine, the spool file
1598 that contains attributes is read directly by the Director instead of being
1599 transmitted across the network. That should reduce load and speedup insertion.
1601 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1602 \index[general]{SpoolSize}
1603 A new Job directive permits to specify the spool size per job. This is used
1604 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1606 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1607 \index[general]{MaxConsoleConnections}
1608 A new director directive permits to specify the maximum number of Console
1609 Connections that could run concurrently. The default is set to 20, but you may
1610 set it to a larger number.
1612 \subsection{VerId = \lt{}string\gt{}}
1613 \index[general]{VerId}
1614 A new director directive permits to specify a personnal identifier that will be
1615 displayed in the \texttt{version} command.
1617 \subsection{dbcheck enhancements}
1618 \index[general]{dbcheck enhancements}
1619 If you are using Mysql, dbcheck will now ask you if you want to create
1620 temporary indexes to speed up orphaned Path and Filename elimination.
1622 A new \texttt{-B} option allows you to print catalog information in a simple
1623 text based format. This is useful to backup it in a secure way.
1638 You can now specify the database connection port in the command line.
1640 \subsection{{-}{-}docdir configure option}
1641 \index[general]{{-}{-}docdir configure option}
1642 You can use {-}{-}docdir= on the ./configure command to
1643 specify the directory where you want Bacula to install the
1644 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
1645 {\bf /usr/share/doc/bacula}.
1647 \subsection{{-}{-}htmldir configure option}
1648 \index[general]{{-}{-}htmldir configure option}
1649 You can use {-}{-}htmldir= on the ./configure command to
1650 specify the directory where you want Bacula to install the bat html help
1651 files. The default is {\bf /usr/share/doc/bacula/html}
1653 \subsection{{-}{-}with-plugindir configure option}
1654 \index[general]{{-}{-}plugindir configure option}
1655 You can use {-}{-}plugindir= on the ./configure command to
1656 specify the directory where you want Bacula to install
1657 the plugins (currently only bpipe-fd). The default is