5 \chapter{New Features in 3.0.2}
7 This chapter presents the new features added to the development 3.0.2
8 versions to be released as Bacula version 3.0.2 sometime in 2009.
10 \section{Source Address}
11 \index[general]{Source Address}
13 A feature has been added which allows the administrator to specify the address
14 from which the director and file daemons will attempt connections from. This
15 may be used to simplify system configuration overhead when working in complex
16 networks utilizing multi-homing and policy-routing.
18 To accomplish this, two new configuration directives have been implemented:
21 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
25 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
29 Simply adding specific host routes would have an undesirable side-effect: any
30 application trying to contact the destination host would be forced to use the
31 more specific route, possibly diverting management traffic onto a backup VLAN.
32 Instead of adding host routes for each client connected to a multi-homed backup
33 server (for example where there are management and backup VLANs), one can
34 use the new directives to specify a specific source address at the application
37 Additionally, this allows the simplification and abstraction of firewall rules
38 when dealing with a Hot-Standby director or storage daemon configuration. The
39 Hot-standby pair may share a CARP address, which connections must be sourced
40 from, while system services listen and act from the unique interface addresses.
42 This project was funded by Collaborative Fusion, Inc.
44 \section{Show volume availability when doing restore}
46 When doing a restore the restore selection dialog ends by displaying this
50 The job will require the following
51 Volume(s) Storage(s) SD Device(s)
52 ===========================================================================
63 Volumes marked with ``*'' are online.
66 This should help getting large restores through minimizing the time spent
67 waiting for operator to drop by and change tapes in the library.
69 This project was funded by Bacula Systems.
71 \chapter{New Features in 3.0.0}
72 \label{NewFeaturesChapter}
73 \index[general]{New Features}
75 This chapter presents the new features added to the development 2.5.x
76 versions to be released as Bacula version 3.0.0 sometime in April 2009.
78 \section{Accurate Backup}
79 \index[general]{Accurate Backup}
81 As with most other backup programs, by default Bacula decides what files to
82 backup for Incremental and Differental backup by comparing the change
83 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
84 backup completed. If one of those two times is later than the last backup
85 time, then the file will be backed up. This does not, however, permit tracking
86 what files have been deleted and will miss any file with an old time that may
87 have been restored to or moved onto the client filesystem.
89 \subsection{Accurate = \lt{}yes|no\gt{}}
90 If the {\bf Accurate = \lt{}yes|no\gt{}} directive is enabled (default no) in
91 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
92 backup, there is no difference, but for {\bf Differential} and {\bf
93 Incremental} backups, the Director will send a list of all previous files
94 backed up, and the File daemon will use that list to determine if any new files
95 have been added or or moved and if any files have been deleted. This allows
96 Bacula to make an accurate backup of your system to that point in time so that
97 if you do a restore, it will restore your system exactly.
100 about using Accurate backup is that it requires more resources (CPU and memory)
101 on both the Director and the Client machines to create the list of previous
102 files backed up, to send that list to the File daemon, for the File daemon to
103 keep the list (possibly very big) in memory, and for the File daemon to do
104 comparisons between every file in the FileSet and the list. In particular,
105 if your client has lots of files (more than a few million), you will need
106 lots of memory on the client machine.
108 Accurate must not be enabled when backing up with a plugin that is not
109 specially designed to work with Accurate. If you enable it, your restores
110 will probably not work correctly.
112 This project was funded by Bacula Systems.
117 \index[general]{Copy Jobs}
119 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
120 existing Migration feature with the exception that the Job that is copied is
121 left unchanged. This essentially creates two identical copies of the same
122 backup. However, the copy is treated as a copy rather than a backup job, and
123 hence is not directly available for restore. The {\bf restore} command lists
124 copy jobs and allows selection of copies by using \texttt{jobid=}
125 option. If the keyword {\bf copies} is present on the command line, Bacula will
126 display the list of all copies for selected jobs.
131 These JobIds have copies as follows:
132 +-------+------------------------------------+-----------+------------------+
133 | JobId | Job | CopyJobId | MediaType |
134 +-------+------------------------------------+-----------+------------------+
135 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
136 +-------+------------------------------------+-----------+------------------+
137 +-------+-------+----------+----------+---------------------+------------------+
138 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
139 +-------+-------+----------+----------+---------------------+------------------+
140 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
141 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
142 +-------+-------+----------+----------+---------------------+------------------+
143 You have selected the following JobIds: 19,2
145 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
146 5,611 files inserted into the tree.
151 The Copy Job runs without using the File daemon by copying the data from the
152 old backup Volume to a different Volume in a different Pool. See the Migration
153 documentation for additional details. For copy Jobs there is a new selection
154 criterium named PoolUncopiedJobs which copies all jobs from a pool to an other
155 pool which were not copied before. Next to that the client, volume, job or sql
156 query are possible ways of selecting jobs which should be copied. Selection
157 types like smallestvolume, oldestvolume, pooloccupancy and pooltime are
158 probably more suited for migration jobs only. But we could imagine some people
159 have a valid use for those kind of copy jobs too.
161 If bacula founds a copy when a job record is purged (deleted) from the catalog,
162 it will promote the copy as \textsl{real} backup and will make it available for
163 automatic restore. If more than one copy is available, it will promote the copy
164 with the smallest jobid.
166 A nice solution which can be build with the new copy jobs is what is
167 called the disk-to-disk-to-tape backup (DTDTT). A sample config could
168 look somethings like the one below:
172 Name = FullBackupsVirtualPool
174 Purge Oldest Volume = Yes
176 NextPool = FullBackupsTapePool
180 Name = FullBackupsTapePool
184 Volume Retention = 365 days
185 Storage = superloader
189 # Fake fileset for copy jobs
201 # Fake client for copy jobs
211 # Default template for a CopyDiskToTape Job
214 Name = CopyDiskToTape
216 Messages = StandardCopy
219 Selection Type = PoolUncopiedJobs
220 Maximum Concurrent Jobs = 10
222 Allow Duplicate Jobs = Yes
223 Allow Higher Duplicates = No
224 Cancel Queued Duplicates = No
225 Cancel Running Duplicates = No
230 Name = DaySchedule7:00
231 Run = Level=Full daily at 7:00
235 Name = CopyDiskToTapeFullBackups
237 Schedule = DaySchedule7:00
238 Pool = FullBackupsVirtualPool
239 JobDefs = CopyDiskToTape
243 The example above had 2 pool which are copied using the PoolUncopiedJobs
244 selection criteria. Normal Full backups go to the Virtual pool and are copied
245 to the Tape pool the next morning.
247 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
252 +-------+------------------------------------+-----------+------------------+
253 | JobId | Job | CopyJobId | MediaType |
254 +-------+------------------------------------+-----------+------------------+
255 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
256 +-------+------------------------------------+-----------+------------------+
259 \section{ACL Updates}
260 \index[general]{ACL Updates}
261 The whole ACL code had been overhauled and in this version each platforms has
262 different streams for each type of acl available on such an platform. As ACLs
263 between platforms tend to be not that portable (most implement POSIX acls but
264 some use an other draft or a completely different format) we currently only
265 allow certain platform specific ACL streams to be decoded and restored on the
266 same platform that they were created on. The old code allowed to restore ACL
267 cross platform but the comments already mention that not being to wise. For
268 backward compatability the new code will accept the two old ACL streams and
269 handle those with the platform specific handler. But for all new backups it
270 will save the ACLs using the new streams.
272 Currently the following platforms support ACLs:
276 \item {\bf Darwin/OSX}
285 Currently we support the following ACL types (these ACL streams use a reserved
286 part of the stream numbers):
289 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
291 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
292 string representation from acl\_to\_text (POSIX acl)
293 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
294 string representation from acl\_to\_text (POSIX acl) for default acls.
295 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
296 string representation from acl\_to\_text (POSIX acl) for access acls.
297 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
298 string representation from acltostr (POSIX acl)
299 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
300 representation from acl\_to\_text (POSIX acl) for default acls.
301 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
302 representation from acl\_to\_text (POSIX acl) for access acls.
303 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
304 string representation from acl\_to\_text (POSIX acl) for default acls.
305 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
306 representation from acl\_to\_text (POSIX acl) for access acls.
307 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
308 string representation from acl\_to\_text (POSIX acl) for default acls.
309 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
310 string representation from acl\_to\_text (POSIX acl) for default acls.
311 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
312 representation from acl\_to\_text (POSIX acl) for access acls.
313 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
314 string representation from acltotext or acl\_totext (POSIX acl)
315 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
316 representation from from acl\_totext (NFSv4 or ZFS acl)
319 In future versions we might support conversion functions from one type of acl
320 into an other for types that are either the same or easily convertable. For now
321 the streams are seperate and restoring them on a platform that doesn't
322 recognize them will give you a warning.
324 \section{Extended Attributes}
325 \index[general]{Extended Attributes}
326 Something that was on the project list for some time is now implemented for
327 platforms that support a similar kind of interface. Its the support for backup
328 and restore of so called extended attributes. As extended attributes are so
329 platform specific these attributes are saved in seperate streams for each
330 platform. Restores of the extended attributes can only be performed on the
331 same platform the backup was done. There is support for all types of extended
332 attributes, but restoring from one type of filesystem onto an other type of
333 filesystem on the same platform may lead to supprises. As extended attributes
334 can contain any type of data they are stored as a series of so called
335 value-pairs. This data must be seen as mostly binary and is stored as such.
336 As security labels from selinux are also extended attributes this option also
337 stores those labels and no specific code is enabled for handling selinux
340 Currently the following platforms support extended attributes:
342 \item {\bf Darwin/OSX}
348 On linux acls are also extended attributes, as such when you enable ACLs on a
349 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
350 and not the same exteneded attribute.
352 To enable the backup of extended attributes please add the following to your
367 \section{Shared objects}
368 \index[general]{Shared objects}
369 A default build of Bacula will now create the libraries as shared objects
370 (.so) rather than static libraries as was previously the case.
371 The shared libraries are built using {\bf libtool} so it should be quite
374 An important advantage of using shared objects is that on a machine with the
375 Directory, File daemon, the Storage daemon, and a console, you will have only
376 one copy of the code in memory rather than four copies. Also the total size of
377 the binary release is smaller since the library code appears only once rather
378 than once for every program that uses it; this results in significant reduction
379 in the size of the binaries particularly for the utility tools.
381 In order for the system loader to find the shared objects when loading the
382 Bacula binaries, the Bacula shared objects must either be in a shared object
383 directory known to the loader (typically /usr/lib) or they must be in the
384 directory that may be specified on the {\bf ./configure} line using the {\bf
385 {-}{-}libdir} option as:
388 ./configure --libdir=/full-path/dir
391 the default is /usr/lib. If {-}{-}libdir is specified, there should be
392 no need to modify your loader configuration provided that
393 the shared objects are installed in that directory (Bacula
394 does this with the make install command). The shared objects
395 that Bacula references are:
404 These files are symbolically linked to the real shared object file,
405 which has a version number to permit running multiple versions of
406 the libraries if desired (not normally the case).
408 If you have problems with libtool or you wish to use the old
409 way of building static libraries, or you want to build a static
410 version of Bacula you may disable
411 libtool on the configure command line with:
414 ./configure --disable-libtool
418 \section{Building Static versions of Bacula}
419 \index[general]{Static linking}
420 In order to build static versions of Bacula, in addition
421 to configuration options that were needed you now must
422 also add --disable-libtool. Example
425 ./configure --enable-static-client-only --disable-libtool
429 \section{Virtual Backup (Vbackup)}
430 \index[general]{Virtual Backup}
431 \index[general]{Vbackup}
433 Bacula's virtual backup feature is often called Synthetic Backup or
434 Consolidation in other backup products. It permits you to consolidate the
435 previous Full backup plus the most recent Differential backup and any
436 subsequent Incremental backups into a new Full backup. This new Full
437 backup will then be considered as the most recent Full for any future
438 Incremental or Differential backups. The VirtualFull backup is
439 accomplished without contacting the client by reading the previous backup
440 data and writing it to a volume in a different pool.
442 In some respects the Vbackup feature works similar to a Migration job, in
443 that Bacula normally reads the data from the pool specified in the
444 Job resource, and writes it to the {\bf Next Pool} specified in the
445 Job resource. Note, this means that usually the output from the Virtual
446 Backup is written into a different pool from where your prior backups
447 are saved. Doing it this way guarantees that you will not get a deadlock
448 situation attempting to read and write to the same volume in the Storage
449 daemon. If you then want to do subsequent backups, you may need to
450 move the Virtual Full Volume back to your normal backup pool.
451 Alternatively, you can set your {\bf Next Pool} to point to the current
452 pool. This will cause Bacula to read and write to Volumes in the
453 current pool. In general, this will work, because Bacula will
454 not allow reading and writing on the same Volume. In any case, once
455 a VirtualFull has been created, and a restore is done involving the
456 most current Full, it will read the Volume or Volumes by the VirtualFull
457 regardless of in which Pool the Volume is found.
459 The Vbackup is enabled on a Job by Job in the Job resource by specifying
460 a level of {\bf VirtualFull}.
462 A typical Job resource definition might look like the following:
476 # Default pool definition
480 Recycle = yes # Automatically recycle Volumes
481 AutoPrune = yes # Prune expired volumes
482 Volume Retention = 365d # one year
490 Recycle = yes # Automatically recycle Volumes
491 AutoPrune = yes # Prune expired volumes
492 Volume Retention = 365d # one year
493 Storage = DiskChanger
496 # Definition of file storage device
503 Maximum Concurrent Jobs = 5
506 # Definition of DDS Virtual tape disk storage device
509 Address = localhost # N.B. Use a fully qualified name here
512 Media Type = DiskChangerMedia
513 Maximum Concurrent Jobs = 4
518 Then in bconsole or via a Run schedule, you would run the job as:
521 run job=MyBackup level=Full
522 run job=MyBackup level=Incremental
523 run job=MyBackup level=Differential
524 run job=MyBackup level=Incremental
525 run job=MyBackup level=Incremental
528 So providing there were changes between each of those jobs, you would end up
529 with a Full backup, a Differential, which includes the first Incremental
530 backup, then two Incremental backups. All the above jobs would be written to
531 the {\bf Default} pool.
533 To consolidate those backups into a new Full backup, you would run the
537 run job=MyBackup level=VirtualFull
540 And it would produce a new Full backup without using the client, and the output
541 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
543 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
546 Note, the Start and End time of the Virtual Full backup is set to the
547 values for the last job included in the Virtual Full (in the above example,
548 it is an Increment). This is so that if another incremental is done, which
549 will be based on the Virtual Full, it will backup all files from the
550 last Job included in the Virtual Full rather than from the time the Virtual
551 Full was actually run.
555 \section{Catalog Format}
556 \index[general]{Catalog Format}
557 Bacula 3.0 comes with some changes to the catalog format. The upgrade
558 operation will convert the FileId field of the File table from 32 bits (max 4
559 billion table entries) to 64 bits (very large number of items). The
560 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
561 your catalog during the conversion. Also you won't be able to run jobs during
562 this conversion period. For example, a 3 million file catalog will take 2
563 minutes to upgrade on a normal machine. Please don't forget to make a valid
564 backup of your database before executing the upgrade script. See the
565 ReleaseNotes for additional details.
567 \section{64 bit Windows Client}
568 \index[general]{Win64 Client}
569 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
570 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
571 As a consequence, we are also releasing a 64 bit version of the Bacula
572 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
573 These binaries should only be installed on 64 bit Windows operating systems.
574 What is important is not your hardware but whether or not you have
575 a 64 bit version of the Windows OS.
577 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
579 \item Before installing the Win64 Bacula Client, you must totally
580 deinstall any prior 2.4.x Client installation using the
581 Bacula deinstallation (see the menu item). You may want
582 to save your .conf files first.
583 \item Only the Client (File daemon) is ported to Win64, the Director
584 and the Storage daemon are not in the 64 bit Windows installer.
585 \item bwx-console is not yet ported.
586 \item bconsole is ported but it has not been tested.
587 \item The documentation is not included in the installer.
588 \item Due to Vista security restrictions imposed on a default installation
589 of Vista, before upgrading the Client, you must manually stop
590 any prior version of Bacula from running, otherwise the install
592 \item Due to Vista security restrictions imposed on a default installation
593 of Vista, attempting to edit the conf files via the menu items
594 will fail. You must directly edit the files with appropriate
595 permissions. Generally double clicking on the appropriate .conf
596 file will work providing you have sufficient permissions.
597 \item All Bacula files are now installed in
598 {\bf C:/Program Files/Bacula} except the main menu items,
599 which are installed as before. This vastly simplifies the installation.
600 \item If you are running on a foreign language version of Windows, most
601 likely {\bf C:/Program Files} does not exist, so you should use the
602 Custom installation and enter an appropriate location to install
604 \item The 3.0.0 Win32 Client continues to install files in the locations used
605 by prior versions. For the next version we will convert it to use
606 the same installation conventions as the Win64 version.
609 This project was funded by Bacula Systems.
612 \section{Duplicate Job Control}
613 \index[general]{Duplicate Jobs}
614 The new version of Bacula provides four new directives that
615 give additional control over what Bacula does if duplicate jobs
616 are started. A duplicate job in the sense we use it here means
617 a second or subsequent job with the same name starts. This
618 happens most frequently when the first job runs longer than expected because no
621 The four directives each take as an argument a {\bf yes} or {\bf no} value and
622 are specified in the Job resource.
626 \subsection{Allow Duplicate Jobs = \lt{}yes|no\gt{}}
627 \index[general]{Allow Duplicate Jobs}
628 If this directive is enabled duplicate jobs will be run. If
629 the directive is set to {\bf no} (default) then only one job of a given name
630 may run at one time, and the action that Bacula takes to ensure only
631 one job runs is determined by the other directives (see below).
633 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
634 are present and none of the three directives given below permit
635 cancelling a job, then the current job (the second one started)
639 \subsection{Allow Higher Duplicates = \lt{}yes|no\gt{}}
640 \index[general]{Allow Higher Duplicates}
641 If this directive is set to {\bf yes} (default) the job with a higher
642 priority (lower priority number) will be permitted to run, and
643 the current job will be cancelled. If the
644 priorities of the two jobs are the same, the outcome is determined by
645 other directives (see below).
647 \subsection{Cancel Queued Duplicates = \lt{}yes|no\gt{}}
648 \index[general]{Cancel Queued Duplicates}
649 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
650 if this directive is set to {\bf yes} any job that is
651 already queued to run but not yet running will be canceled.
652 The default is {\bf no}.
654 \subsection{Cancel Running Duplicates = \lt{}yes|no\gt{}}
655 \index[general]{Cancel Running Duplicates}
656 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
657 if this directive is set to {\bf yes} any job that is already running
658 will be canceled. The default is {\bf no}.
661 \section{TLS Authentication}
662 \index[general]{TLS Authentication}
663 In Bacula version 2.5.x and later, in addition to the normal Bacula
664 CRAM-MD5 authentication that is used to authenticate each Bacula
665 connection, you can specify that you want TLS Authentication as well,
666 which will provide more secure authentication.
668 This new feature uses Bacula's existing TLS code (normally used for
669 communications encryption) to do authentication. To use it, you must
670 specify all the TLS directives normally used to enable communications
671 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
674 \subsection{TLS Authenticate = yes}
676 TLS Authenticate = yes
679 in the main daemon configuration resource (Director for the Director,
680 Client for the File daemon, and Storage for the Storage daemon).
682 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
683 authentication, Bacula will also do TLS authentication, then TLS
684 encryption will be turned off, and the rest of the communication between
685 the two Bacula daemons will be done without encryption.
687 If you want to encrypt communications data, use the normal TLS directives
688 but do not turn on {\bf TLS Authenticate}.
690 \section{bextract non-portable Win32 data}
691 \index[general]{bextract handles Win32 non-portable data}
692 {\bf bextract} has been enhanced to be able to restore
693 non-portable Win32 data to any OS. Previous versions were
694 unable to restore non-portable Win32 data to machines that
695 did not have the Win32 BackupRead and BackupWrite API calls.
697 \section{State File updated at Job Termination}
698 \index[general]{State File}
699 In previous versions of Bacula, the state file, which provides a
700 summary of previous jobs run in the {\bf status} command output was
701 updated only when Bacula terminated, thus if the daemon crashed, the
702 state file might not contain all the run data. This version of
703 the Bacula daemons updates the state file on each job termination.
705 \section{MaxFullInterval = \lt{}time-interval\gt{}}
706 \index[general]{MaxFullInterval}
707 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
708 can be used to specify the maximum time interval between {\bf Full} backup
709 jobs. When a job starts, if the time since the last Full backup is
710 greater than the specified interval, and the job would normally be an
711 {\bf Incremental} or {\bf Differential}, it will be automatically
712 upgraded to a {\bf Full} backup.
714 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
715 \index[general]{MaxDiffInterval}
716 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
717 can be used to specify the maximum time interval between {\bf Differential} backup
718 jobs. When a job starts, if the time since the last Differential backup is
719 greater than the specified interval, and the job would normally be an
720 {\bf Incremental}, it will be automatically
721 upgraded to a {\bf Differential} backup.
723 \section{Honor No Dump Flag = \lt{}yes|no\gt{}}
724 \index[general]{MaxDiffInterval}
725 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
726 by the user, and when it is set it is an indication to backup programs
727 to not backup that particular file. This version of Bacula contains a
728 new Options directive within a FileSet resource, which instructs Bacula to
729 obey this flag. The new directive is:
732 Honor No Dump Flag = yes|no
735 The default value is {\bf no}.
738 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
739 \index[general]{IgnoreDir}
740 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
741 can be added to the Include section of the FileSet resource. If the specified
742 filename ({\bf filename-string}) is found on the Client in any directory to be
743 backed up, the whole directory will be ignored (not backed up). For example:
746 # List of files to be backed up
754 Exclude Dir Containing = .excludeme
759 But in /home, there may be hundreds of directories of users and some
760 people want to indicate that they don't want to have certain
761 directories backed up. For example, with the above FileSet, if
762 the user or sysadmin creates a file named {\bf .excludeme} in
763 specific directories, such as
766 /home/user/www/cache/.excludeme
767 /home/user/temp/.excludeme
770 then Bacula will not backup the two directories named:
777 NOTE: subdirectories will not be backed up. That is, the directive
778 applies to the two directories in question and any children (be they
779 files, directories, etc).
782 \section{Bacula Plugins}
783 \index[general]{Plugin}
784 Support for shared object plugins has been implemented in the Linux, Unix
785 and Win32 File daemons. The API will be documented separately in
786 the Developer's Guide or in a new document. For the moment, there is
787 a single plugin named {\bf bpipe} that allows an external program to
788 get control to backup and restore a file.
790 Plugins are also planned (partially implemented) in the Director and the
793 \subsection{Plugin Directory}
794 \index[general]{Plugin Directory}
795 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
796 be added to the daemon definition resource. The directory takes a quoted
797 string argument, which is the name of the directory in which the daemon can
798 find the Bacula plugins. If this directive is not specified, Bacula will not
799 load any plugins. Since each plugin has a distinctive name, all the daemons
800 can share the same plugin directory.
802 \subsection{Plugin Options}
803 \index[general]{Plugin Options}
804 The {\bf Plugin Options} directive takes a quoted string
805 arguement (after the equal sign) and may be specified in the
806 Job resource. The options specified will be passed to all plugins
807 when they are run. This each plugin must know what it is looking
808 for. The value defined in the Job resource can be modified
809 by the user when he runs a Job via the {\bf bconsole} command line
812 Note: this directive may be specified, and there is code to modify
813 the string in the run command, but the plugin options are not yet passed to
814 the plugin (i.e. not fully implemented).
816 \subsection{Plugin Options ACL}
817 \index[general]{Plugin Options ACL}
818 The {\bf Plugin Options ACL} directive may be specified in the
819 Director's Console resource. It functions as all the other ACL commands
820 do by permitting users running restricted consoles to specify a
821 {\bf Plugin Options} that overrides the one specified in the Job
822 definition. Without this directive restricted consoles may not modify
825 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
826 \index[general]{Plugin}
827 The {\bf Plugin} directive is specified in the Include section of
828 a FileSet resource where you put your {\bf File = xxx} directives.
844 In the above example, when the File daemon is processing the directives
845 in the Include section, it will first backup all the files in {\bf /home}
846 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
847 the Plugin Directory. The syntax and semantics of the Plugin directive
848 require the first part of the string up to the colon (:) to be the name
849 of the plugin. Everything after the first colon is ignored by the File daemon but
850 is passed to the plugin. Thus the plugin writer may define the meaning of the
851 rest of the string as he wishes.
853 Please see the next section for information about the {\bf bpipe} Bacula
856 \section{The bpipe Plugin}
857 \index[general]{The bpipe Plugin}
858 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
859 the Bacula source distribution. When the plugin is compiled and linking into
860 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
862 The purpose of the plugin is to provide an interface to any system program for
863 backup and restore. As specified above the {\bf bpipe} plugin is specified in
864 the Include section of your Job's FileSet resource. The full syntax of the
865 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
866 to specify the sytax as it wishes) is:
869 Plugin = "<field1>:<field2>:<field3>:<field4>"
874 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
875 stripped off, so in this case, we would put {\bf bpipe} in this field.
877 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
878 pseudo path and filename under which the backup will be saved. This pseudo
879 path and filename will be seen by the user in the restore file tree.
880 For example, if the value is {\bf /MYSQL/regress.sql}, the data
881 backed up by the plugin will be put under that "pseudo" path and filename.
882 You must be careful to choose a naming convention that is unique to avoid
883 a conflict with a path and filename that actually exists on your system.
885 \item {\bf field3} for the {\bf bpipe} plugin
886 specifies the "reader" program that is called by the plugin during
887 backup to read the data. {\bf bpipe} will call this program by doing a
890 \item {\bf field4} for the {\bf bpipe} plugin
891 specifies the "writer" program that is called by the plugin during
892 restore to write the data back to the filesystem.
895 Putting it all together, the full plugin directive line might look
899 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
900 --opt --databases bacula:mysql"
903 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
904 would be written on a single line.
906 This causes the File daemon to call the {\bf bpipe} plugin, which will write
907 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
908 program {\bf mysqldump -f --opt --database bacula} to read the data during
909 backup. The mysqldump command outputs all the data for the database named
910 {\bf bacula}, which will be read by the plugin and stored in the backup.
911 During restore, the data that was backed up will be sent to the program
912 specified in the last field, which in this case is {\bf mysql}. When
913 {\bf mysql} is called, it will read the data sent to it by the plugn
914 then write it back to the same database from which it came ({\bf bacula}
917 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
918 the data from a specified program to Bacula for backup, and then from Bacula to
919 a specified program for restore.
921 By using different command lines to {\bf bpipe},
922 you can backup any kind of data (ASCII or binary) depending
923 on the program called.
925 \section{Microsoft Exchange Server 2003/2007 Plugin}
926 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
927 \subsection{Background}
928 The Exchange plugin was made possible by a funded development project
929 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
930 The code for the plugin was written by James Harper, and the Bacula core
931 code by Kern Sibbald. All the code for this funded development has become
932 part of the Bacula project. Thanks to everyone who made it happen.
934 \subsection{Concepts}
935 Although it is possible to backup Exchange using Bacula VSS the Exchange
936 plugin adds a good deal of functionality, because while Bacula VSS
937 completes a full backup (snapshot) of Exchange, it does
938 not support Incremental or Differential backups, restoring is more
939 complicated, and a single database restore is not possible.
941 Microsoft Exchange organises its storage into Storage Groups with
942 Databases inside them. A default installation of Exchange will have a
943 single Storage Group called 'First Storage Group', with two Databases
944 inside it, "Mailbox Store (SERVER NAME)" and
945 "Public Folder Store (SERVER NAME)",
946 which hold user email and public folders respectively.
948 In the default configuration, Exchange logs everything that happens to
949 log files, such that if you have a backup, and all the log files since,
950 you can restore to the present time. Each Storage Group has its own set
951 of log files and operates independently of any other Storage Groups. At
952 the Storage Group level, the logging can be turned off by enabling a
953 function called "Enable circular logging". At this time the Exchange
954 plugin will not function if this option is enabled.
956 The plugin allows backing up of entire storage groups, and the restoring
957 of entire storage groups or individual databases. Backing up and
958 restoring at the individual mailbox or email item is not supported but
959 can be simulated by use of the "Recovery" Storage Group (see below).
961 \subsection{Installing}
962 The Exchange plugin requires a DLL that is shipped with Microsoft
963 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
964 correctly the Exchange plugin should find this automatically and run
965 without any additional installation.
967 If the DLL can not be found automatically it will need to be copied into
968 the Bacula installation
969 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
970 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
971 default Exchange installation.
973 \subsection{Backup up}
974 To back up an Exchange server the Fileset definition must contain at
975 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
976 the backup to work correctly. The 'exchange:' bit tells Bacula to look
977 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
978 up files are prefixed with something that isn't going to share a name
979 with something outside the plugin, and the 'Microsoft Information Store'
980 bit is required also. It is also possible to add the name of a storage
981 group to the "Plugin =" line, eg \\
982 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
983 if you want only a single storage group backed up.
985 Additionally, you can suffix the 'Plugin =' directive with
986 ":notrunconfull" which will tell the plugin not to truncate the Exchange
987 database at the end of a full backup.
989 An Incremental or Differential backup will backup only the database logs
990 for each Storage Group by inspecting the "modified date" on each
991 physical log file. Because of the way the Exchange API works, the last
992 logfile backed up on each backup will always be backed up by the next
993 Incremental or Differential backup too. This adds 5MB to each
994 Incremental or Differential backup size but otherwise does not cause any
997 By default, a normal VSS fileset containing all the drive letters will
998 also back up the Exchange databases using VSS. This will interfere with
999 the plugin and Exchange's shared ideas of when the last full backup was
1000 done, and may also truncate log files incorrectly. It is important,
1001 therefore, that the Exchange database files be excluded from the backup,
1002 although the folders the files are in should be included, or they will
1003 have to be recreated manually if a baremetal restore is done.
1008 File = C:/Program Files/Exchsrvr/mdbdata
1009 Plugin = "exchange:..."
1012 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1013 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1014 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1015 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1016 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1017 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1018 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1023 The advantage of excluding the above files is that you can significantly
1024 reduce the size of your backup since all the important Exchange files
1025 will be properly saved by the Plugin.
1028 \subsection{Restoring}
1029 The restore operation is much the same as a normal Bacula restore, with
1030 the following provisos:
1033 \item The {\bf Where} restore option must not be specified
1034 \item Each Database directory must be marked as a whole. You cannot just
1035 select (say) the .edb file and not the others.
1036 \item If a Storage Group is restored, the directory of the Storage Group
1038 \item It is possible to restore only a subset of the available log files,
1039 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1040 if a log file is missing from the sequence of log files
1041 \item Each database to be restored must be dismounted and marked as "Can be
1042 overwritten by restore"
1043 \item If an entire Storage Group is to be restored (eg all databases and
1044 logs in the Storage Group), then it is best to manually delete the
1045 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1046 as Exchange can get confused by stray log files lying around.
1049 \subsection{Restoring to the Recovery Storage Group}
1050 The concept of the Recovery Storage Group is well documented by
1052 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1053 but to briefly summarize...
1055 Microsoft Exchange allows the creation of an additional Storage Group
1056 called the Recovery Storage Group, which is used to restore an older
1057 copy of a database (e.g. before a mailbox was deleted) into without
1058 messing with the current live data. This is required as the Standard and
1059 Small Business Server versions of Exchange can not ordinarily have more
1060 than one Storage Group.
1062 To create the Recovery Storage Group, drill down to the Server in Exchange
1063 System Manager, right click, and select
1064 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1065 locations and click OK. On the Recovery Storage Group, right click and
1066 select {\bf "Add Database to Recover..."} and select the database you will
1069 Restore only the single database nominated as the database in the
1070 Recovery Storage Group. Exchange will redirect the restore to the
1071 Recovery Storage Group automatically.
1072 Then run the restore.
1074 \subsection{Restoring on Microsoft Server 2007}
1075 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1076 2007, and henc you use a new proceedure for recovering a single mail box.
1077 This procedure is ducomented by Microsoft at:
1078 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1079 and involves using the {\bf Restore-Mailbox} and {\bf
1080 Get-MailboxStatistics} shell commands.
1082 \subsection{Caveats}
1083 This plugin is still being developed, so you should consider it
1084 currently in BETA test, and thus use in a production environment
1085 should be done only after very careful testing.
1087 When doing a full backup, the Exchange database logs are truncated by
1088 Exchange as soon as the plugin has completed the backup. If the data
1089 never makes it to the backup medium (eg because of spooling) then the
1090 logs will still be truncated, but they will also not have been backed
1091 up. A solution to this is being worked on. You will have to schedule a
1092 new Full backup to ensure that your next backups will be usable.
1094 The "Enable Circular Logging" option cannot be enabled or the plugin
1097 Exchange insists that a successful Full backup must have taken place if
1098 an Incremental or Differential backup is desired, and the plugin will
1099 fail if this is not the case. If a restore is done, Exchange will
1100 require that a Full backup be done before an Incremental or Differential
1103 The plugin will most likely not work well if another backup application
1104 (eg NTBACKUP) is backing up the Exchange database, especially if the
1105 other backup application is truncating the log files.
1107 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1108 we recommend either carefully testing or that you avoid this option for
1111 The Exchange plugin is not called during processing the bconsole {\bf
1112 estimate} command, and so anything that would be backed up by the plugin
1113 will not be added to the estimate total that is displayed.
1116 \section{libdbi Framework}
1117 \index[general]{libdbi Framework}
1118 As a general guideline, Bacula has support for a few catalog database drivers
1119 (MySQL, PostgreSQL, SQLite)
1120 coded natively by the Bacula team. With the libdbi implementation, which is a
1121 Bacula driver that uses libdbi to access the catalog, we have an open field to
1122 use many different kinds database engines following the needs of users.
1124 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1125 implements a database-independent abstraction layer in C, similar to the
1126 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1127 leverage the power of multiple databases and multiple simultaneous database
1128 connections by using this framework.
1130 Currently the libdbi driver in Bacula project only supports the same drivers
1131 natively coded in Bacula. However the libdbi project has support for many
1132 others database engines. You can view the list at
1133 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1134 supported by Bacula, however, they must be tested properly by the Bacula team.
1136 Some of benefits of using libdbi are:
1138 \item The possibility to use proprietary databases engines in which your
1139 proprietary licenses prevent the Bacula team from developing the driver.
1140 \item The possibility to use the drivers written for the libdbi project.
1141 \item The possibility to use other database engines without recompiling Bacula
1142 to use them. Just change one line in bacula-dir.conf
1143 \item Abstract Database access, this is, unique point to code and profiling
1144 catalog database access.
1147 The following drivers have been tested:
1149 \item PostgreSQL, with and without batch insert
1150 \item Mysql, with and without batch insert
1155 In the future, we will test and approve to use others databases engines
1156 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1158 To compile Bacula to support libdbi we need to configure the code with the
1159 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1160 [database] is the database engine to be used with Bacula (of course we can
1161 change the driver in file bacula-dir.conf, see below). We must configure the
1162 access port of the database engine with the option --with-db-port, because the
1163 libdbi framework doesn't know the default access port of each database.
1165 The next phase is checking (or configuring) the bacula-dir.conf, example:
1169 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1170 dbname = regress; user = regress; password = ""
1174 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1175 mysql database. Currently the drivers supported by Bacula are: postgresql,
1176 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1178 The following limitations apply when Bacula is set to use the libdbi framework:
1179 - Not tested on the Win32 platform
1180 - A little performance is lost if comparing with native database driver.
1181 The reason is bound with the database driver provided by libdbi and the
1182 simple fact that one more layer of code was added.
1184 It is important to remember, when compiling Bacula with libdbi, the
1185 following packages are needed:
1187 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1188 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1191 You can download them and compile them on your system or install the packages
1192 from your OS distribution.
1194 \section{Console Command Additions and Enhancements}
1195 \index[general]{Console Additions}
1197 \subsection{Display Autochanger Content}
1198 \index[general]{StatusSlots}
1200 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1201 autochanger content.
1205 Slot | Volume Name | Status | Media Type | Pool |
1206 ------+---------------+----------+-------------------+------------|
1207 1 | 00001 | Append | DiskChangerMedia | Default |
1208 2 | 00002 | Append | DiskChangerMedia | Default |
1209 3*| 00003 | Append | DiskChangerMedia | Scratch |
1214 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1215 {\bf update slots} command to synchronize autochanger content with your
1218 \subsection{list joblog job=xxx or jobid=nnn}
1219 \index[general]{list joblog}
1220 A new list command has been added that allows you to list the contents
1221 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1222 or for a particular JobId. The {\bf llist} command will include a line with
1223 the time and date of the entry.
1225 Note for the catalog to have Job Log entries, you must have a directive
1232 In your Director's {\bf Messages} resource.
1234 \subsection{Use separator for multiple commands}
1235 \index[general]{Command Separator}
1236 When using bconsole with readline, you can set the command separator with
1237 \textbf{@separator} command to one
1238 of those characters to write commands who require multiple input in one line.
1240 !$%&'()*+,-/:;<>?[]^`{|}~
1243 \subsection{Deleting Volumes}
1244 The delete volume bconsole command has been modified to
1245 require an asterisk (*) in front of a MediaId otherwise the
1246 value you enter is a taken to be a Volume name. This is so that
1247 users may delete numeric Volume names. The previous Bacula versions
1248 assumed that all input that started with a number was a MediaId.
1250 This new behavior is indicated in the prompt if you read it
1253 \section{Bare Metal Recovery}
1254 The old bare metal recovery project is essentially dead. One
1255 of the main features of it was that it would build a recovery
1256 CD based on the kernel on your system. The problem was that
1257 every distribution has a different boot procedure and different
1258 scripts, and worse yet, the boot procedures and scripts change
1259 from one distribution to another. This meant that maintaining
1260 (keeping up with the changes) the rescue CD was too much work.
1262 To replace it, a new bare metal recovery USB boot stick has been developed
1263 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1264 boot from a USB key.
1268 \item Recovery can be done from within graphical environment.
1269 \item Recovery can be done in a shell.
1270 \item Ubuntu boots on a large number of Linux systems.
1271 \item The process of updating the system and adding new
1272 packages is not too difficult.
1273 \item The USB key can easily be upgraded to newer Ubuntu versions.
1274 \item The USB key has writable partitions for modifications to
1275 the OS and for modification to your home directory.
1276 \item You can add new files/directories to the USB key very easily.
1277 \item You can save the environment from multiple machines on
1279 \item Bacula Systems is funding its ongoing development.
1282 The disadvantages are:
1284 \item The USB key is usable but currently under development.
1285 \item Not everyone may be familiar with Ubuntu (no worse
1287 \item Some older OSes cannot be booted from USB. This can
1288 be resolved by first booting a Ubuntu LiveCD then plugging
1290 \item Currently the documentation is sketchy and not yet added
1291 to the main manual. See below ...
1294 The documentation and the code can be found in the {\bf rescue} package
1295 in the directory {\bf linux/usb}.
1297 \section{Miscellaneous}
1298 \index[general]{Misc New Features}
1300 \subsection{Allow Mixed Priority = \lt{}yes|no\gt{}}
1301 \index[general]{Allow Mixed Priority}
1302 This directive is only implemented in version 2.5 and later. When
1303 set to {\bf yes} (default {\bf no}), this job may run even if lower
1304 priority jobs are already running. This means a high priority job
1305 will not have to wait for other jobs to finish before starting.
1306 The scheduler will only mix priorities when all running jobs have
1309 Note that only higher priority jobs will start early. Suppose the
1310 director will allow two concurrent jobs, and that two jobs with
1311 priority 10 are running, with two more in the queue. If a job with
1312 priority 5 is added to the queue, it will be run as soon as one of
1313 the running jobs finishes. However, new priority 10 jobs will not
1314 be run until the priority 5 job has finished.
1316 \subsection{Bootstrap File Directive -- FileRegex}
1317 \index[general]{Bootstrap File Directive}
1318 {\bf FileRegex} is a new command that can be added to the bootstrap
1319 (.bsr) file. The value is a regular expression. When specified, only
1320 matching filenames will be restored.
1322 During a restore, if all File records are pruned from the catalog
1323 for a Job, normally Bacula can restore only all files saved. That
1324 is there is no way using the catalog to select individual files.
1325 With this new feature, Bacula will ask if you want to specify a Regex
1326 expression for extracting only a part of the full backup.
1329 Building directory tree for JobId(s) 1,3 ...
1330 There were no files inserted into the tree, so file selection
1331 is not possible.Most likely your retention policy pruned the files
1333 Do you want to restore all the files? (yes|no): no
1335 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1336 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1339 \subsection{Bootstrap File Optimization Changes}
1340 In order to permit proper seeking on disk files, we have extended the bootstrap
1341 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1342 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1343 address range and end address range respectively. These two directives replace
1344 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1345 VolEndBlock} directives. Bootstrap files containing the old directives will
1346 still work, but will not properly take advantage of proper disk seeking, and
1347 may read completely to the end of a disk volume during a restore. With the new
1348 format (automatically generated by the new Director), restores will seek
1349 properly and stop reading the volume when all the files have been restored.
1351 \subsection{Solaris ZFS/NFSv4 ACLs}
1352 This is an upgrade of the previous Solaris ACL backup code
1353 to the new library format, which will backup both the old
1354 POSIX(UFS) ACLs as well as the ZFS ACLs.
1356 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1357 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1358 be used to transfer from UFS to ZFS filesystems.
1361 \subsection{Virtual Tape Emulation}
1362 \index[general]{Virtual Tape Emulation}
1363 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1364 the tape code but actually reading and writing to a disk file. Used with the
1365 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1366 and 700 slots. This feature is most useful in testing. It is enabled
1367 by using {\bf Device Type = vtape} in the Storage daemon's Device
1368 directive. This feature is only implemented on Linux machines and should not be
1369 used for production.
1371 \subsection{Bat Enhancements}
1372 \index[general]{Bat Enhancements}
1373 Bat (the Bacula Administration Tool) GUI program has been significantly
1374 enhanced and stabilized. In particular, there are new table based status
1375 commands; it can now be easily localized using Qt4 Linguist.
1377 The Bat communications protocol has been significantly enhanced to improve
1378 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1379 the Director you are using otherwise the communications protocol will not
1382 \subsection{RunScript Enhancements}
1383 \index[general]{RunScript Enhancements}
1384 The {\bf RunScript} resource has been enhanced to permit multiple
1385 commands per RunScript. Simply specify multiple {\bf Command} directives
1392 Command = "/bin/echo test"
1393 Command = "/bin/echo an other test"
1394 Command = "/bin/echo 3 commands in the same runscript"
1401 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1402 implemented, which runs the command after the Volume Shadow Copy has been made.
1404 Console commands can be specified within a RunScript by using:
1405 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1406 carefully tested and debugged and is known to easily crash the Director.
1407 We would appreciate feedback. Due to the recursive nature of this command, we
1408 may remove it before the final release.
1410 \subsection{Status Enhancements}
1411 \index[general]{Status Enhancements}
1412 The bconsole {\bf status dir} output has been enhanced to indicate
1413 Storage daemon job spooling and despooling activity.
1415 \subsection{Connect Timeout}
1416 \index[general]{Connect Timeout}
1417 The default connect timeout to the File
1418 daemon has been set to 3 minutes. Previously it was 30 minutes.
1420 \subsection{ftruncate for NFS Volumes}
1421 \index[general]{ftruncate for NFS Volumes}
1422 If you write to a Volume mounted by NFS (say on a local file server),
1423 in previous Bacula versions, when the Volume was recycled, it was not
1424 properly truncated because NFS does not implement ftruncate (file
1425 truncate). This is now corrected in the new version because we have
1426 written code (actually a kind user) that deletes and recreates the Volume,
1427 thus accomplishing the same thing as a truncate.
1429 \subsection{Support for Ubuntu}
1430 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1431 version of Linux, and thus now provides correct autostart routines.
1432 Since Ubuntu officially supports Bacula, you can also obtain any
1433 recent release of Bacula from the Ubuntu repositories.
1435 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1436 \index[general]{Recycle Pool}
1437 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1438 be placed (moved) when it is recycled. Without this directive, a Volume will
1439 remain in the same pool when it is recycled. With this directive, it can be
1440 moved automatically to any existing pool during a recycle. This directive is
1441 probably most useful when defined in the Scratch pool, so that volumes will
1442 be recycled back into the Scratch pool.
1444 \subsection{FD Version}
1445 \index[general]{FD Version}
1446 The File daemon to Director protocol now includes a version
1447 number, which although there is no visible change for users,
1448 will help us in future versions automatically determine
1449 if a File daemon is not compatible.
1451 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1452 \index[general]{Max Run Sched Time}
1453 The time specifies the maximum allowed time that a job may run, counted from
1454 when the job was scheduled. This can be useful to prevent jobs from running
1455 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1458 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1459 \index[general]{Max Wait Time}
1460 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1461 of checking the maximum allowed time that a job may block for a resource,
1462 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1463 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1464 their job depending on the level. Now, they have to use
1465 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1466 directives are now deprecated.
1468 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1469 \index[general]{Incremental Max Wait Time}
1470 \index[general]{Differential Max Wait Time}
1472 These directives have been deprecated in favor of
1473 \texttt{Incremental|Differential Max Run Time}.
1475 \subsection{Max Run Time directives}
1476 \index[general]{Max Run Time directives}
1477 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1478 maximum allowed time that a job can run depending on the level.
1480 \addcontentsline{lof}{figure}{Job time control directives}
1481 \includegraphics{\idir different_time.eps}
1483 \subsection{Statistics Enhancements}
1484 \index[general]{Statistics Enhancements}
1485 If you (or probably your boss) want to have statistics on your backups to
1486 provide some \textit{Service Level Agreement} indicators, you could use a few
1487 SQL queries on the Job table to report how many:
1491 \item jobs have been successful
1492 \item files have been backed up
1496 However, these statistics are accurate only if your job retention is greater
1497 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1498 be able to use them.
1500 Now, you can use the \textbf{update stats [days=num]} console command to fill
1501 the JobHistory table with new Job records. If you want to be sure to take in
1502 account only \textbf{good jobs}, ie if one of your important job has failed but
1503 you have fixed the problem and restarted it on time, you probably want to
1504 delete the first \textit{bad} job record and keep only the successful one. For
1505 that simply let your staff do the job, and update JobHistory table after two or
1506 three days depending on your organization using the \textbf{[days=num]} option.
1508 These statistics records aren't used for restoring, but mainly for
1509 capacity planning, billings, etc.
1511 The Bweb interface provides a statistics module that can use this feature. You
1512 can also use tools like Talend or extract information by yourself.
1514 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1515 the length of time that Bacula will keep statistics job records in the Catalog
1516 database after the Job End time. (In \texttt{JobHistory} table) When this time
1517 period expires, and if user runs \texttt{prune stats} command, Bacula will
1518 prune (remove) Job records that are older than the specified period.
1520 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1521 job to maintain statistics.
1524 Name = BackupCatalog
1527 Console = "update stats days=3"
1528 Console = "prune stats yes"
1535 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1536 \index[general]{ScratchPool}
1537 This directive permits to specify a specific \textsl{Scratch} pool for the
1538 current pool. This is useful when using multiple storage sharing the same
1539 mediatype or when you want to dedicate volumes to a particular set of pool.
1541 \subsection{Enhanced Attribute Despooling}
1542 \index[general]{Attribute Despooling}
1543 If the storage daemon and the Director are on the same machine, the spool file
1544 that contains attributes is read directly by the Director instead of being
1545 transmitted across the network. That should reduce load and speedup insertion.
1547 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1548 \index[general]{SpoolSize}
1549 A new Job directive permits to specify the spool size per job. This is used
1550 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1552 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1553 \index[general]{MaxConsoleConnections}
1554 A new director directive permits to specify the maximum number of Console
1555 Connections that could run concurrently. The default is set to 20, but you may
1556 set it to a larger number.
1558 \subsection{VerId = \lt{}string\gt{}}
1559 \index[general]{VerId}
1560 A new director directive permits to specify a personnal identifier that will be
1561 displayed in the \texttt{version} command.
1563 \subsection{dbcheck enhancements}
1564 \index[general]{dbcheck enhancements}
1565 If you are using Mysql, dbcheck will now ask you if you want to create
1566 temporary indexes to speed up orphaned Path and Filename elimination.
1568 A new \texttt{-B} option allows you to print catalog information in a simple
1569 text based format. This is useful to backup it in a secure way.
1584 You can now specify the database connection port in the command line.
1586 \subsection{{-}{-}docdir configure option}
1587 \index[general]{{-}{-}docdir configure option}
1588 You can use {-}{-}docdir= on the ./configure command to
1589 specify the directory where you want Bacula to install the
1590 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
1591 {\bf /usr/share/doc/bacula}.
1593 \subsection{{-}{-}htmldir configure option}
1594 \index[general]{{-}{-}htmldir configure option}
1595 You can use {-}{-}htmldir= on the ./configure command to
1596 specify the directory where you want Bacula to install the bat html help
1597 files. The default is {\bf /usr/share/doc/bacula/html}
1599 \subsection{{-}{-}with-plugindir configure option}
1600 \index[general]{{-}{-}plugindir configure option}
1601 You can use {-}{-}plugindir= on the ./configure command to
1602 specify the directory where you want Bacula to install
1603 the plugins (currently only bpipe-fd). The default is