5 \chapter{New Features in 3.0.3}
6 \label{NewFeaturesChapter}
8 This chapter presents the new features added to the development 3.0.3
9 versions to be released as Bacula version 3.0.3 sometime in 2009.
11 \section{Restore from multiple Storage Daemon}
12 \index[general]{Restore}
14 Previously, you were able to restore from multiple devices in a single Storage
15 Daemon. Now, Bacula is able to restore from multiple Storage Daemon. For
16 example, if your full backup runs on a Storage Daemon with an autochanger, and
17 your incremental jobs use an other Storage Daemon with lots of disks, Bacula
18 will switch automatically from a Storage Daemon to an other in the same Restore
21 You need to upgrade your File Daemon to use this feature.
23 This project was funded by Bacula Systems with the help of Equiinet.
25 \section{File deduplication using Base jobs}
27 A base job is sort of like a Full save except that you will want the FileSet to
28 contain only files that are unlikely to change in the future (i.e. a snapshot
29 of most of your system after installing it). After the base job has been run,
30 when you are doing a Full save, you specify one or more Base jobs to be used.
31 All files that have been backed up in the Base job/jobs but not modified will
32 then be excluded from the backup. During a restore, the Base jobs will be
33 automatically pulled in where necessary.
35 This is something none of the competition does, as far as we know (except
36 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
37 win for the user, it makes Bacula stand out as offering a unique optimization
38 that immediately saves time and money. Basically, imagine that you have 100
39 nearly identical Windows or Linux machine containing the OS and user files.
40 Now for the OS part, a Base job will be backed up once, and rather than making
41 100 copies of the OS, there will be only one. If one or more of the systems
42 have some files updated, no problem, they will be automatically restored.
44 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
45 files that will be used during Full backup as base.
56 Base = BackupZog4, BackupLinux
62 In this example, the job \texttt{BackupZog4} will use the most recent version
63 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
64 jobs. Base jobs should have run with \texttt{level=Base} to be used.
66 By default, Bacula will compare permissions bits, user and group fields,
67 modification time, size and the checksum of the file to choose between the
68 current backup and the BaseJob file list. You can change this behavior with the
69 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
70 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
87 This project was funded by Bacula Systems.
92 To help developers in restore GUI interfaces, we have added new \textsl{dot
93 commands} that permit to browse the catalog in a very simple way.
96 \item \texttt{.update [jobid=x,y,z]} This command is required to update the
97 Bvfs cache in the catalog. You need to run it before any access to the Bvfs
99 \item \texttt{.lsdirs jobid=x,y,z path=/path | pathid=101} This command will
100 list all directories in the specified \texttt{path} or \texttt{pathid}. Using
101 \texttt{pathid} avoids problems with caracters encoding.
102 \item \texttt{.lsfiles jobid=x,y,z path=/path | pathid=101} This command will
103 list all files in the specified \texttt{path} or \texttt{pathid}. Using
104 \texttt{pathid} avoids problems with caracters encoding.
107 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
108 data that will be displayed.
113 * .lsdir path=/ jobid=1,2
116 \section{Bat new features}
118 \subsection{Media information view}
120 When double-clicking on a volume (on the Media list, in the Autochanger content
121 or in the Job information panel), you can access to a detailed overview of your
122 volume. (cf \ref{fig:mediainfo}.)
125 \includegraphics[width=13cm]{\idir bat11.eps}
126 \caption{Media information}
127 \label{fig:mediainfo}
130 \subsection{Job information view}
132 When double-clicking on a Job record (on the Job run list or in the Media
133 information panel), you can access to a detailed overview of your Job. (cf
137 \includegraphics[width=13cm]{\idir bat12.eps}
138 \caption{Job information}
142 \subsection{Autochanger content view}
144 When double-clicking on a Storage record (on the Storage list panel), you can
145 access to a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
148 \includegraphics[width=13cm]{\idir bat13.eps}
149 \caption{Autochanger content}
150 \label{fig:achcontent}
153 \chapter{New Features in 3.0.2}
155 This chapter presents the new features added to the development 3.0.2
156 versions to be released as Bacula version 3.0.2 in july 2009.
158 \section{Full restore from a given JobId}
159 \index[general]{Restore menu}
161 This feature allows selecting a JobId and having Bacula automatically select all
162 other jobs that comprise a full backup up to and including the selected JobId.
164 Assume we start with the following jobs:
166 +-------+--------------+---------------------+-------+----------+------------+
167 | jobid | client | starttime | level | jobfiles | jobbytes |
168 +-------+--------------+---------------------+-------+----------+------------
169 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
170 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
171 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
172 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
173 +-------+--------------+---------------------+-------+----------+------------+
176 Below is an example of selecting this new feature (which is number 12 in the
181 To select the JobIds, you have the following choices:
182 1: List last 20 Jobs run
183 2: List Jobs where a given File is saved
185 12: Select full restore to a specified JobId
188 Select item: (1-13): 12
189 Enter JobId to restore: 5
190 You have selected the following JobIds: 1,3,5
192 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
193 1,444 files inserted into the tree.
196 This project was funded by Bacula Systems.
198 \section{Source Address}
199 \index[general]{Source Address}
201 A feature has been added which allows the administrator to specify the address
202 from which the director and file daemons will attempt connections from. This
203 may be used to simplify system configuration overhead when working in complex
204 networks utilizing multi-homing and policy-routing.
206 To accomplish this, two new configuration directives have been implemented:
209 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
213 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
217 Simply adding specific host routes would have an undesirable side-effect: any
218 application trying to contact the destination host would be forced to use the
219 more specific route, possibly diverting management traffic onto a backup VLAN.
220 Instead of adding host routes for each client connected to a multi-homed backup
221 server (for example where there are management and backup VLANs), one can
222 use the new directives to specify a specific source address at the application
225 Additionally, this allows the simplification and abstraction of firewall rules
226 when dealing with a Hot-Standby director or storage daemon configuration. The
227 Hot-standby pair may share a CARP address, which connections must be sourced
228 from, while system services listen and act from the unique interface addresses.
230 This project was funded by Collaborative Fusion, Inc.
232 \section{Show volume availability when doing restore}
234 When doing a restore the restore selection dialog ends by displaying this
238 The job will require the following
239 Volume(s) Storage(s) SD Device(s)
240 ===========================================================================
251 Volumes marked with ``*'' are online.
254 This should help getting large restores through minimizing the time spent
255 waiting for operator to drop by and change tapes in the library.
257 This project was funded by Bacula Systems.
259 \section{Accurate estimate command}
261 The \texttt{estimate} command can now use the accurate code to detect changes
262 and give a better estimation.
264 You can set the accurate behavior on command line using
265 \texttt{accurate=yes/no} or use the Job setting as default value.
268 * estimate listing accurate=yes level=incremental job=BackupJob
271 This project was funded by Bacula Systems.
273 \chapter{New Features in 3.0.0}
274 \label{NewFeaturesChapter}
275 \index[general]{New Features}
277 This chapter presents the new features added to the development 2.5.x
278 versions to be released as Bacula version 3.0.0 sometime in April 2009.
280 \section{Accurate Backup}
281 \index[general]{Accurate Backup}
283 As with most other backup programs, by default Bacula decides what files to
284 backup for Incremental and Differental backup by comparing the change
285 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
286 backup completed. If one of those two times is later than the last backup
287 time, then the file will be backed up. This does not, however, permit tracking
288 what files have been deleted and will miss any file with an old time that may
289 have been restored to or moved onto the client filesystem.
291 \subsection{Accurate = \lt{}yes|no\gt{}}
292 If the {\bf Accurate = \lt{}yes|no\gt{}} directive is enabled (default no) in
293 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
294 backup, there is no difference, but for {\bf Differential} and {\bf
295 Incremental} backups, the Director will send a list of all previous files
296 backed up, and the File daemon will use that list to determine if any new files
297 have been added or or moved and if any files have been deleted. This allows
298 Bacula to make an accurate backup of your system to that point in time so that
299 if you do a restore, it will restore your system exactly.
302 about using Accurate backup is that it requires more resources (CPU and memory)
303 on both the Director and the Client machines to create the list of previous
304 files backed up, to send that list to the File daemon, for the File daemon to
305 keep the list (possibly very big) in memory, and for the File daemon to do
306 comparisons between every file in the FileSet and the list. In particular,
307 if your client has lots of files (more than a few million), you will need
308 lots of memory on the client machine.
310 Accurate must not be enabled when backing up with a plugin that is not
311 specially designed to work with Accurate. If you enable it, your restores
312 will probably not work correctly.
314 This project was funded by Bacula Systems.
319 \index[general]{Copy Jobs}
321 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
322 existing Migration feature with the exception that the Job that is copied is
323 left unchanged. This essentially creates two identical copies of the same
324 backup. However, the copy is treated as a copy rather than a backup job, and
325 hence is not directly available for restore. The {\bf restore} command lists
326 copy jobs and allows selection of copies by using \texttt{jobid=}
327 option. If the keyword {\bf copies} is present on the command line, Bacula will
328 display the list of all copies for selected jobs.
333 These JobIds have copies as follows:
334 +-------+------------------------------------+-----------+------------------+
335 | JobId | Job | CopyJobId | MediaType |
336 +-------+------------------------------------+-----------+------------------+
337 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
338 +-------+------------------------------------+-----------+------------------+
339 +-------+-------+----------+----------+---------------------+------------------+
340 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
341 +-------+-------+----------+----------+---------------------+------------------+
342 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
343 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
344 +-------+-------+----------+----------+---------------------+------------------+
345 You have selected the following JobIds: 19,2
347 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
348 5,611 files inserted into the tree.
353 The Copy Job runs without using the File daemon by copying the data from the
354 old backup Volume to a different Volume in a different Pool. See the Migration
355 documentation for additional details. For copy Jobs there is a new selection
356 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
357 not already copied to another Pool.
359 As with Migration, the Client, Volume, Job, or SQL query, are
360 other possible ways of selecting the Jobs to be copied. Selection
361 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
362 work, but are probably more suited for Migration Jobs.
364 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
365 it will promote the Copy to a \textsl{real} backup job and will make it available for
366 automatic restore. If more than one Copy is available, it will promote the copy
367 with the smallest JobId.
369 A nice solution which can be built with the new Copy feature is often
370 called disk-to-disk-to-tape backup (DTDTT). A sample config could
371 look something like the one below:
375 Name = FullBackupsVirtualPool
377 Purge Oldest Volume = Yes
379 NextPool = FullBackupsTapePool
383 Name = FullBackupsTapePool
387 Volume Retention = 365 days
388 Storage = superloader
392 # Fake fileset for copy jobs
404 # Fake client for copy jobs
414 # Default template for a CopyDiskToTape Job
417 Name = CopyDiskToTape
419 Messages = StandardCopy
422 Selection Type = PoolUncopiedJobs
423 Maximum Concurrent Jobs = 10
425 Allow Duplicate Jobs = Yes
426 Allow Higher Duplicates = No
427 Cancel Queued Duplicates = No
428 Cancel Running Duplicates = No
433 Name = DaySchedule7:00
434 Run = Level=Full daily at 7:00
438 Name = CopyDiskToTapeFullBackups
440 Schedule = DaySchedule7:00
441 Pool = FullBackupsVirtualPool
442 JobDefs = CopyDiskToTape
446 The example above had 2 pool which are copied using the PoolUncopiedJobs
447 selection criteria. Normal Full backups go to the Virtual pool and are copied
448 to the Tape pool the next morning.
450 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
455 +-------+------------------------------------+-----------+------------------+
456 | JobId | Job | CopyJobId | MediaType |
457 +-------+------------------------------------+-----------+------------------+
458 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
459 +-------+------------------------------------+-----------+------------------+
462 \section{ACL Updates}
463 \index[general]{ACL Updates}
464 The whole ACL code had been overhauled and in this version each platforms has
465 different streams for each type of acl available on such an platform. As ACLs
466 between platforms tend to be not that portable (most implement POSIX acls but
467 some use an other draft or a completely different format) we currently only
468 allow certain platform specific ACL streams to be decoded and restored on the
469 same platform that they were created on. The old code allowed to restore ACL
470 cross platform but the comments already mention that not being to wise. For
471 backward compatability the new code will accept the two old ACL streams and
472 handle those with the platform specific handler. But for all new backups it
473 will save the ACLs using the new streams.
475 Currently the following platforms support ACLs:
479 \item {\bf Darwin/OSX}
488 Currently we support the following ACL types (these ACL streams use a reserved
489 part of the stream numbers):
492 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
494 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
495 string representation from acl\_to\_text (POSIX acl)
496 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
497 string representation from acl\_to\_text (POSIX acl) for default acls.
498 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
499 string representation from acl\_to\_text (POSIX acl) for access acls.
500 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
501 string representation from acltostr (POSIX acl)
502 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
503 representation from acl\_to\_text (POSIX acl) for default acls.
504 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
505 representation from acl\_to\_text (POSIX acl) for access acls.
506 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
507 string representation from acl\_to\_text (POSIX acl) for default acls.
508 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
509 representation from acl\_to\_text (POSIX acl) for access acls.
510 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
511 string representation from acl\_to\_text (POSIX acl) for default acls.
512 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
513 string representation from acl\_to\_text (POSIX acl) for default acls.
514 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
515 representation from acl\_to\_text (POSIX acl) for access acls.
516 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
517 string representation from acltotext or acl\_totext (POSIX acl)
518 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
519 representation from from acl\_totext (NFSv4 or ZFS acl)
522 In future versions we might support conversion functions from one type of acl
523 into an other for types that are either the same or easily convertable. For now
524 the streams are seperate and restoring them on a platform that doesn't
525 recognize them will give you a warning.
527 \section{Extended Attributes}
528 \index[general]{Extended Attributes}
529 Something that was on the project list for some time is now implemented for
530 platforms that support a similar kind of interface. Its the support for backup
531 and restore of so called extended attributes. As extended attributes are so
532 platform specific these attributes are saved in seperate streams for each
533 platform. Restores of the extended attributes can only be performed on the
534 same platform the backup was done. There is support for all types of extended
535 attributes, but restoring from one type of filesystem onto an other type of
536 filesystem on the same platform may lead to supprises. As extended attributes
537 can contain any type of data they are stored as a series of so called
538 value-pairs. This data must be seen as mostly binary and is stored as such.
539 As security labels from selinux are also extended attributes this option also
540 stores those labels and no specific code is enabled for handling selinux
543 Currently the following platforms support extended attributes:
545 \item {\bf Darwin/OSX}
551 On linux acls are also extended attributes, as such when you enable ACLs on a
552 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
553 and not the same exteneded attribute.
555 To enable the backup of extended attributes please add the following to your
570 \section{Shared objects}
571 \index[general]{Shared objects}
572 A default build of Bacula will now create the libraries as shared objects
573 (.so) rather than static libraries as was previously the case.
574 The shared libraries are built using {\bf libtool} so it should be quite
577 An important advantage of using shared objects is that on a machine with the
578 Directory, File daemon, the Storage daemon, and a console, you will have only
579 one copy of the code in memory rather than four copies. Also the total size of
580 the binary release is smaller since the library code appears only once rather
581 than once for every program that uses it; this results in significant reduction
582 in the size of the binaries particularly for the utility tools.
584 In order for the system loader to find the shared objects when loading the
585 Bacula binaries, the Bacula shared objects must either be in a shared object
586 directory known to the loader (typically /usr/lib) or they must be in the
587 directory that may be specified on the {\bf ./configure} line using the {\bf
588 {-}{-}libdir} option as:
591 ./configure --libdir=/full-path/dir
594 the default is /usr/lib. If {-}{-}libdir is specified, there should be
595 no need to modify your loader configuration provided that
596 the shared objects are installed in that directory (Bacula
597 does this with the make install command). The shared objects
598 that Bacula references are:
607 These files are symbolically linked to the real shared object file,
608 which has a version number to permit running multiple versions of
609 the libraries if desired (not normally the case).
611 If you have problems with libtool or you wish to use the old
612 way of building static libraries, or you want to build a static
613 version of Bacula you may disable
614 libtool on the configure command line with:
617 ./configure --disable-libtool
621 \section{Building Static versions of Bacula}
622 \index[general]{Static linking}
623 In order to build static versions of Bacula, in addition
624 to configuration options that were needed you now must
625 also add --disable-libtool. Example
628 ./configure --enable-static-client-only --disable-libtool
632 \section{Virtual Backup (Vbackup)}
633 \index[general]{Virtual Backup}
634 \index[general]{Vbackup}
636 Bacula's virtual backup feature is often called Synthetic Backup or
637 Consolidation in other backup products. It permits you to consolidate the
638 previous Full backup plus the most recent Differential backup and any
639 subsequent Incremental backups into a new Full backup. This new Full
640 backup will then be considered as the most recent Full for any future
641 Incremental or Differential backups. The VirtualFull backup is
642 accomplished without contacting the client by reading the previous backup
643 data and writing it to a volume in a different pool.
645 In some respects the Vbackup feature works similar to a Migration job, in
646 that Bacula normally reads the data from the pool specified in the
647 Job resource, and writes it to the {\bf Next Pool} specified in the
648 Job resource. Note, this means that usually the output from the Virtual
649 Backup is written into a different pool from where your prior backups
650 are saved. Doing it this way guarantees that you will not get a deadlock
651 situation attempting to read and write to the same volume in the Storage
652 daemon. If you then want to do subsequent backups, you may need to
653 move the Virtual Full Volume back to your normal backup pool.
654 Alternatively, you can set your {\bf Next Pool} to point to the current
655 pool. This will cause Bacula to read and write to Volumes in the
656 current pool. In general, this will work, because Bacula will
657 not allow reading and writing on the same Volume. In any case, once
658 a VirtualFull has been created, and a restore is done involving the
659 most current Full, it will read the Volume or Volumes by the VirtualFull
660 regardless of in which Pool the Volume is found.
662 The Vbackup is enabled on a Job by Job in the Job resource by specifying
663 a level of {\bf VirtualFull}.
665 A typical Job resource definition might look like the following:
679 # Default pool definition
683 Recycle = yes # Automatically recycle Volumes
684 AutoPrune = yes # Prune expired volumes
685 Volume Retention = 365d # one year
693 Recycle = yes # Automatically recycle Volumes
694 AutoPrune = yes # Prune expired volumes
695 Volume Retention = 365d # one year
696 Storage = DiskChanger
699 # Definition of file storage device
706 Maximum Concurrent Jobs = 5
709 # Definition of DDS Virtual tape disk storage device
712 Address = localhost # N.B. Use a fully qualified name here
715 Media Type = DiskChangerMedia
716 Maximum Concurrent Jobs = 4
721 Then in bconsole or via a Run schedule, you would run the job as:
724 run job=MyBackup level=Full
725 run job=MyBackup level=Incremental
726 run job=MyBackup level=Differential
727 run job=MyBackup level=Incremental
728 run job=MyBackup level=Incremental
731 So providing there were changes between each of those jobs, you would end up
732 with a Full backup, a Differential, which includes the first Incremental
733 backup, then two Incremental backups. All the above jobs would be written to
734 the {\bf Default} pool.
736 To consolidate those backups into a new Full backup, you would run the
740 run job=MyBackup level=VirtualFull
743 And it would produce a new Full backup without using the client, and the output
744 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
746 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
749 Note, the Start and End time of the Virtual Full backup is set to the
750 values for the last job included in the Virtual Full (in the above example,
751 it is an Increment). This is so that if another incremental is done, which
752 will be based on the Virtual Full, it will backup all files from the
753 last Job included in the Virtual Full rather than from the time the Virtual
754 Full was actually run.
758 \section{Catalog Format}
759 \index[general]{Catalog Format}
760 Bacula 3.0 comes with some changes to the catalog format. The upgrade
761 operation will convert the FileId field of the File table from 32 bits (max 4
762 billion table entries) to 64 bits (very large number of items). The
763 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
764 your catalog during the conversion. Also you won't be able to run jobs during
765 this conversion period. For example, a 3 million file catalog will take 2
766 minutes to upgrade on a normal machine. Please don't forget to make a valid
767 backup of your database before executing the upgrade script. See the
768 ReleaseNotes for additional details.
770 \section{64 bit Windows Client}
771 \index[general]{Win64 Client}
772 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
773 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
774 As a consequence, we are also releasing a 64 bit version of the Bacula
775 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
776 These binaries should only be installed on 64 bit Windows operating systems.
777 What is important is not your hardware but whether or not you have
778 a 64 bit version of the Windows OS.
780 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
782 \item Before installing the Win64 Bacula Client, you must totally
783 deinstall any prior 2.4.x Client installation using the
784 Bacula deinstallation (see the menu item). You may want
785 to save your .conf files first.
786 \item Only the Client (File daemon) is ported to Win64, the Director
787 and the Storage daemon are not in the 64 bit Windows installer.
788 \item bwx-console is not yet ported.
789 \item bconsole is ported but it has not been tested.
790 \item The documentation is not included in the installer.
791 \item Due to Vista security restrictions imposed on a default installation
792 of Vista, before upgrading the Client, you must manually stop
793 any prior version of Bacula from running, otherwise the install
795 \item Due to Vista security restrictions imposed on a default installation
796 of Vista, attempting to edit the conf files via the menu items
797 will fail. You must directly edit the files with appropriate
798 permissions. Generally double clicking on the appropriate .conf
799 file will work providing you have sufficient permissions.
800 \item All Bacula files are now installed in
801 {\bf C:/Program Files/Bacula} except the main menu items,
802 which are installed as before. This vastly simplifies the installation.
803 \item If you are running on a foreign language version of Windows, most
804 likely {\bf C:/Program Files} does not exist, so you should use the
805 Custom installation and enter an appropriate location to install
807 \item The 3.0.0 Win32 Client continues to install files in the locations used
808 by prior versions. For the next version we will convert it to use
809 the same installation conventions as the Win64 version.
812 This project was funded by Bacula Systems.
815 \section{Duplicate Job Control}
816 \index[general]{Duplicate Jobs}
817 The new version of Bacula provides four new directives that
818 give additional control over what Bacula does if duplicate jobs
819 are started. A duplicate job in the sense we use it here means
820 a second or subsequent job with the same name starts. This
821 happens most frequently when the first job runs longer than expected because no
824 The four directives each take as an argument a {\bf yes} or {\bf no} value and
825 are specified in the Job resource.
829 \subsection{Allow Duplicate Jobs = \lt{}yes|no\gt{}}
830 \index[general]{Allow Duplicate Jobs}
831 If this directive is enabled duplicate jobs will be run. If
832 the directive is set to {\bf no} (default) then only one job of a given name
833 may run at one time, and the action that Bacula takes to ensure only
834 one job runs is determined by the other directives (see below).
836 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
837 are present and none of the three directives given below permit
838 cancelling a job, then the current job (the second one started)
842 \subsection{Allow Higher Duplicates = \lt{}yes|no\gt{}}
843 \index[general]{Allow Higher Duplicates}
844 If this directive is set to {\bf yes} (default) the job with a higher
845 priority (lower priority number) will be permitted to run, and
846 the current job will be cancelled. If the
847 priorities of the two jobs are the same, the outcome is determined by
848 other directives (see below).
850 \subsection{Cancel Queued Duplicates = \lt{}yes|no\gt{}}
851 \index[general]{Cancel Queued Duplicates}
852 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
853 if this directive is set to {\bf yes} any job that is
854 already queued to run but not yet running will be canceled.
855 The default is {\bf no}.
857 \subsection{Cancel Running Duplicates = \lt{}yes|no\gt{}}
858 \index[general]{Cancel Running Duplicates}
859 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
860 if this directive is set to {\bf yes} any job that is already running
861 will be canceled. The default is {\bf no}.
864 \section{TLS Authentication}
865 \index[general]{TLS Authentication}
866 In Bacula version 2.5.x and later, in addition to the normal Bacula
867 CRAM-MD5 authentication that is used to authenticate each Bacula
868 connection, you can specify that you want TLS Authentication as well,
869 which will provide more secure authentication.
871 This new feature uses Bacula's existing TLS code (normally used for
872 communications encryption) to do authentication. To use it, you must
873 specify all the TLS directives normally used to enable communications
874 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
877 \subsection{TLS Authenticate = yes}
879 TLS Authenticate = yes
882 in the main daemon configuration resource (Director for the Director,
883 Client for the File daemon, and Storage for the Storage daemon).
885 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
886 authentication, Bacula will also do TLS authentication, then TLS
887 encryption will be turned off, and the rest of the communication between
888 the two Bacula daemons will be done without encryption.
890 If you want to encrypt communications data, use the normal TLS directives
891 but do not turn on {\bf TLS Authenticate}.
893 \section{bextract non-portable Win32 data}
894 \index[general]{bextract handles Win32 non-portable data}
895 {\bf bextract} has been enhanced to be able to restore
896 non-portable Win32 data to any OS. Previous versions were
897 unable to restore non-portable Win32 data to machines that
898 did not have the Win32 BackupRead and BackupWrite API calls.
900 \section{State File updated at Job Termination}
901 \index[general]{State File}
902 In previous versions of Bacula, the state file, which provides a
903 summary of previous jobs run in the {\bf status} command output was
904 updated only when Bacula terminated, thus if the daemon crashed, the
905 state file might not contain all the run data. This version of
906 the Bacula daemons updates the state file on each job termination.
908 \section{MaxFullInterval = \lt{}time-interval\gt{}}
909 \index[general]{MaxFullInterval}
910 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
911 can be used to specify the maximum time interval between {\bf Full} backup
912 jobs. When a job starts, if the time since the last Full backup is
913 greater than the specified interval, and the job would normally be an
914 {\bf Incremental} or {\bf Differential}, it will be automatically
915 upgraded to a {\bf Full} backup.
917 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
918 \index[general]{MaxDiffInterval}
919 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
920 can be used to specify the maximum time interval between {\bf Differential} backup
921 jobs. When a job starts, if the time since the last Differential backup is
922 greater than the specified interval, and the job would normally be an
923 {\bf Incremental}, it will be automatically
924 upgraded to a {\bf Differential} backup.
926 \section{Honor No Dump Flag = \lt{}yes|no\gt{}}
927 \index[general]{MaxDiffInterval}
928 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
929 by the user, and when it is set it is an indication to backup programs
930 to not backup that particular file. This version of Bacula contains a
931 new Options directive within a FileSet resource, which instructs Bacula to
932 obey this flag. The new directive is:
935 Honor No Dump Flag = yes|no
938 The default value is {\bf no}.
941 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
942 \index[general]{IgnoreDir}
943 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
944 can be added to the Include section of the FileSet resource. If the specified
945 filename ({\bf filename-string}) is found on the Client in any directory to be
946 backed up, the whole directory will be ignored (not backed up). For example:
949 # List of files to be backed up
957 Exclude Dir Containing = .excludeme
962 But in /home, there may be hundreds of directories of users and some
963 people want to indicate that they don't want to have certain
964 directories backed up. For example, with the above FileSet, if
965 the user or sysadmin creates a file named {\bf .excludeme} in
966 specific directories, such as
969 /home/user/www/cache/.excludeme
970 /home/user/temp/.excludeme
973 then Bacula will not backup the two directories named:
980 NOTE: subdirectories will not be backed up. That is, the directive
981 applies to the two directories in question and any children (be they
982 files, directories, etc).
985 \section{Bacula Plugins}
986 \index[general]{Plugin}
987 Support for shared object plugins has been implemented in the Linux, Unix
988 and Win32 File daemons. The API will be documented separately in
989 the Developer's Guide or in a new document. For the moment, there is
990 a single plugin named {\bf bpipe} that allows an external program to
991 get control to backup and restore a file.
993 Plugins are also planned (partially implemented) in the Director and the
996 \subsection{Plugin Directory}
997 \index[general]{Plugin Directory}
998 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
999 be added to the daemon definition resource. The directory takes a quoted
1000 string argument, which is the name of the directory in which the daemon can
1001 find the Bacula plugins. If this directive is not specified, Bacula will not
1002 load any plugins. Since each plugin has a distinctive name, all the daemons
1003 can share the same plugin directory.
1005 \subsection{Plugin Options}
1006 \index[general]{Plugin Options}
1007 The {\bf Plugin Options} directive takes a quoted string
1008 arguement (after the equal sign) and may be specified in the
1009 Job resource. The options specified will be passed to all plugins
1010 when they are run. This each plugin must know what it is looking
1011 for. The value defined in the Job resource can be modified
1012 by the user when he runs a Job via the {\bf bconsole} command line
1015 Note: this directive may be specified, and there is code to modify
1016 the string in the run command, but the plugin options are not yet passed to
1017 the plugin (i.e. not fully implemented).
1019 \subsection{Plugin Options ACL}
1020 \index[general]{Plugin Options ACL}
1021 The {\bf Plugin Options ACL} directive may be specified in the
1022 Director's Console resource. It functions as all the other ACL commands
1023 do by permitting users running restricted consoles to specify a
1024 {\bf Plugin Options} that overrides the one specified in the Job
1025 definition. Without this directive restricted consoles may not modify
1028 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1029 \index[general]{Plugin}
1030 The {\bf Plugin} directive is specified in the Include section of
1031 a FileSet resource where you put your {\bf File = xxx} directives.
1042 Plugin = "bpipe:..."
1047 In the above example, when the File daemon is processing the directives
1048 in the Include section, it will first backup all the files in {\bf /home}
1049 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1050 the Plugin Directory. The syntax and semantics of the Plugin directive
1051 require the first part of the string up to the colon (:) to be the name
1052 of the plugin. Everything after the first colon is ignored by the File daemon but
1053 is passed to the plugin. Thus the plugin writer may define the meaning of the
1054 rest of the string as he wishes.
1056 Please see the next section for information about the {\bf bpipe} Bacula
1059 \section{The bpipe Plugin}
1060 \index[general]{The bpipe Plugin}
1061 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1062 the Bacula source distribution. When the plugin is compiled and linking into
1063 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1065 The purpose of the plugin is to provide an interface to any system program for
1066 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1067 the Include section of your Job's FileSet resource. The full syntax of the
1068 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1069 to specify the sytax as it wishes) is:
1072 Plugin = "<field1>:<field2>:<field3>:<field4>"
1077 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1078 stripped off, so in this case, we would put {\bf bpipe} in this field.
1080 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1081 pseudo path and filename under which the backup will be saved. This pseudo
1082 path and filename will be seen by the user in the restore file tree.
1083 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1084 backed up by the plugin will be put under that "pseudo" path and filename.
1085 You must be careful to choose a naming convention that is unique to avoid
1086 a conflict with a path and filename that actually exists on your system.
1088 \item {\bf field3} for the {\bf bpipe} plugin
1089 specifies the "reader" program that is called by the plugin during
1090 backup to read the data. {\bf bpipe} will call this program by doing a
1093 \item {\bf field4} for the {\bf bpipe} plugin
1094 specifies the "writer" program that is called by the plugin during
1095 restore to write the data back to the filesystem.
1098 Putting it all together, the full plugin directive line might look
1102 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1103 --opt --databases bacula:mysql"
1106 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1107 would be written on a single line.
1109 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1110 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1111 program {\bf mysqldump -f --opt --database bacula} to read the data during
1112 backup. The mysqldump command outputs all the data for the database named
1113 {\bf bacula}, which will be read by the plugin and stored in the backup.
1114 During restore, the data that was backed up will be sent to the program
1115 specified in the last field, which in this case is {\bf mysql}. When
1116 {\bf mysql} is called, it will read the data sent to it by the plugn
1117 then write it back to the same database from which it came ({\bf bacula}
1120 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1121 the data from a specified program to Bacula for backup, and then from Bacula to
1122 a specified program for restore.
1124 By using different command lines to {\bf bpipe},
1125 you can backup any kind of data (ASCII or binary) depending
1126 on the program called.
1128 \section{Microsoft Exchange Server 2003/2007 Plugin}
1129 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1130 \subsection{Background}
1131 The Exchange plugin was made possible by a funded development project
1132 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1133 The code for the plugin was written by James Harper, and the Bacula core
1134 code by Kern Sibbald. All the code for this funded development has become
1135 part of the Bacula project. Thanks to everyone who made it happen.
1137 \subsection{Concepts}
1138 Although it is possible to backup Exchange using Bacula VSS the Exchange
1139 plugin adds a good deal of functionality, because while Bacula VSS
1140 completes a full backup (snapshot) of Exchange, it does
1141 not support Incremental or Differential backups, restoring is more
1142 complicated, and a single database restore is not possible.
1144 Microsoft Exchange organises its storage into Storage Groups with
1145 Databases inside them. A default installation of Exchange will have a
1146 single Storage Group called 'First Storage Group', with two Databases
1147 inside it, "Mailbox Store (SERVER NAME)" and
1148 "Public Folder Store (SERVER NAME)",
1149 which hold user email and public folders respectively.
1151 In the default configuration, Exchange logs everything that happens to
1152 log files, such that if you have a backup, and all the log files since,
1153 you can restore to the present time. Each Storage Group has its own set
1154 of log files and operates independently of any other Storage Groups. At
1155 the Storage Group level, the logging can be turned off by enabling a
1156 function called "Enable circular logging". At this time the Exchange
1157 plugin will not function if this option is enabled.
1159 The plugin allows backing up of entire storage groups, and the restoring
1160 of entire storage groups or individual databases. Backing up and
1161 restoring at the individual mailbox or email item is not supported but
1162 can be simulated by use of the "Recovery" Storage Group (see below).
1164 \subsection{Installing}
1165 The Exchange plugin requires a DLL that is shipped with Microsoft
1166 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1167 correctly the Exchange plugin should find this automatically and run
1168 without any additional installation.
1170 If the DLL can not be found automatically it will need to be copied into
1171 the Bacula installation
1172 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1173 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1174 default Exchange installation.
1176 \subsection{Backup up}
1177 To back up an Exchange server the Fileset definition must contain at
1178 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1179 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1180 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1181 up files are prefixed with something that isn't going to share a name
1182 with something outside the plugin, and the 'Microsoft Information Store'
1183 bit is required also. It is also possible to add the name of a storage
1184 group to the "Plugin =" line, eg \\
1185 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1186 if you want only a single storage group backed up.
1188 Additionally, you can suffix the 'Plugin =' directive with
1189 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1190 database at the end of a full backup.
1192 An Incremental or Differential backup will backup only the database logs
1193 for each Storage Group by inspecting the "modified date" on each
1194 physical log file. Because of the way the Exchange API works, the last
1195 logfile backed up on each backup will always be backed up by the next
1196 Incremental or Differential backup too. This adds 5MB to each
1197 Incremental or Differential backup size but otherwise does not cause any
1200 By default, a normal VSS fileset containing all the drive letters will
1201 also back up the Exchange databases using VSS. This will interfere with
1202 the plugin and Exchange's shared ideas of when the last full backup was
1203 done, and may also truncate log files incorrectly. It is important,
1204 therefore, that the Exchange database files be excluded from the backup,
1205 although the folders the files are in should be included, or they will
1206 have to be recreated manually if a baremetal restore is done.
1211 File = C:/Program Files/Exchsrvr/mdbdata
1212 Plugin = "exchange:..."
1215 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1216 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1217 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1218 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1219 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1220 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1221 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1226 The advantage of excluding the above files is that you can significantly
1227 reduce the size of your backup since all the important Exchange files
1228 will be properly saved by the Plugin.
1231 \subsection{Restoring}
1232 The restore operation is much the same as a normal Bacula restore, with
1233 the following provisos:
1236 \item The {\bf Where} restore option must not be specified
1237 \item Each Database directory must be marked as a whole. You cannot just
1238 select (say) the .edb file and not the others.
1239 \item If a Storage Group is restored, the directory of the Storage Group
1241 \item It is possible to restore only a subset of the available log files,
1242 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1243 if a log file is missing from the sequence of log files
1244 \item Each database to be restored must be dismounted and marked as "Can be
1245 overwritten by restore"
1246 \item If an entire Storage Group is to be restored (eg all databases and
1247 logs in the Storage Group), then it is best to manually delete the
1248 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1249 as Exchange can get confused by stray log files lying around.
1252 \subsection{Restoring to the Recovery Storage Group}
1253 The concept of the Recovery Storage Group is well documented by
1255 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1256 but to briefly summarize...
1258 Microsoft Exchange allows the creation of an additional Storage Group
1259 called the Recovery Storage Group, which is used to restore an older
1260 copy of a database (e.g. before a mailbox was deleted) into without
1261 messing with the current live data. This is required as the Standard and
1262 Small Business Server versions of Exchange can not ordinarily have more
1263 than one Storage Group.
1265 To create the Recovery Storage Group, drill down to the Server in Exchange
1266 System Manager, right click, and select
1267 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1268 locations and click OK. On the Recovery Storage Group, right click and
1269 select {\bf "Add Database to Recover..."} and select the database you will
1272 Restore only the single database nominated as the database in the
1273 Recovery Storage Group. Exchange will redirect the restore to the
1274 Recovery Storage Group automatically.
1275 Then run the restore.
1277 \subsection{Restoring on Microsoft Server 2007}
1278 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1279 2007, and henc you use a new proceedure for recovering a single mail box.
1280 This procedure is ducomented by Microsoft at:
1281 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1282 and involves using the {\bf Restore-Mailbox} and {\bf
1283 Get-MailboxStatistics} shell commands.
1285 \subsection{Caveats}
1286 This plugin is still being developed, so you should consider it
1287 currently in BETA test, and thus use in a production environment
1288 should be done only after very careful testing.
1290 When doing a full backup, the Exchange database logs are truncated by
1291 Exchange as soon as the plugin has completed the backup. If the data
1292 never makes it to the backup medium (eg because of spooling) then the
1293 logs will still be truncated, but they will also not have been backed
1294 up. A solution to this is being worked on. You will have to schedule a
1295 new Full backup to ensure that your next backups will be usable.
1297 The "Enable Circular Logging" option cannot be enabled or the plugin
1300 Exchange insists that a successful Full backup must have taken place if
1301 an Incremental or Differential backup is desired, and the plugin will
1302 fail if this is not the case. If a restore is done, Exchange will
1303 require that a Full backup be done before an Incremental or Differential
1306 The plugin will most likely not work well if another backup application
1307 (eg NTBACKUP) is backing up the Exchange database, especially if the
1308 other backup application is truncating the log files.
1310 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1311 we recommend either carefully testing or that you avoid this option for
1314 The Exchange plugin is not called during processing the bconsole {\bf
1315 estimate} command, and so anything that would be backed up by the plugin
1316 will not be added to the estimate total that is displayed.
1319 \section{libdbi Framework}
1320 \index[general]{libdbi Framework}
1321 As a general guideline, Bacula has support for a few catalog database drivers
1322 (MySQL, PostgreSQL, SQLite)
1323 coded natively by the Bacula team. With the libdbi implementation, which is a
1324 Bacula driver that uses libdbi to access the catalog, we have an open field to
1325 use many different kinds database engines following the needs of users.
1327 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1328 implements a database-independent abstraction layer in C, similar to the
1329 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1330 leverage the power of multiple databases and multiple simultaneous database
1331 connections by using this framework.
1333 Currently the libdbi driver in Bacula project only supports the same drivers
1334 natively coded in Bacula. However the libdbi project has support for many
1335 others database engines. You can view the list at
1336 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1337 supported by Bacula, however, they must be tested properly by the Bacula team.
1339 Some of benefits of using libdbi are:
1341 \item The possibility to use proprietary databases engines in which your
1342 proprietary licenses prevent the Bacula team from developing the driver.
1343 \item The possibility to use the drivers written for the libdbi project.
1344 \item The possibility to use other database engines without recompiling Bacula
1345 to use them. Just change one line in bacula-dir.conf
1346 \item Abstract Database access, this is, unique point to code and profiling
1347 catalog database access.
1350 The following drivers have been tested:
1352 \item PostgreSQL, with and without batch insert
1353 \item Mysql, with and without batch insert
1358 In the future, we will test and approve to use others databases engines
1359 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1361 To compile Bacula to support libdbi we need to configure the code with the
1362 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1363 [database] is the database engine to be used with Bacula (of course we can
1364 change the driver in file bacula-dir.conf, see below). We must configure the
1365 access port of the database engine with the option --with-db-port, because the
1366 libdbi framework doesn't know the default access port of each database.
1368 The next phase is checking (or configuring) the bacula-dir.conf, example:
1372 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1373 dbname = regress; user = regress; password = ""
1377 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1378 mysql database. Currently the drivers supported by Bacula are: postgresql,
1379 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1381 The following limitations apply when Bacula is set to use the libdbi framework:
1382 - Not tested on the Win32 platform
1383 - A little performance is lost if comparing with native database driver.
1384 The reason is bound with the database driver provided by libdbi and the
1385 simple fact that one more layer of code was added.
1387 It is important to remember, when compiling Bacula with libdbi, the
1388 following packages are needed:
1390 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1391 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1394 You can download them and compile them on your system or install the packages
1395 from your OS distribution.
1397 \section{Console Command Additions and Enhancements}
1398 \index[general]{Console Additions}
1400 \subsection{Display Autochanger Content}
1401 \index[general]{StatusSlots}
1403 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1404 autochanger content.
1408 Slot | Volume Name | Status | Media Type | Pool |
1409 ------+---------------+----------+-------------------+------------|
1410 1 | 00001 | Append | DiskChangerMedia | Default |
1411 2 | 00002 | Append | DiskChangerMedia | Default |
1412 3*| 00003 | Append | DiskChangerMedia | Scratch |
1417 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1418 {\bf update slots} command to synchronize autochanger content with your
1421 \subsection{list joblog job=xxx or jobid=nnn}
1422 \index[general]{list joblog}
1423 A new list command has been added that allows you to list the contents
1424 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1425 or for a particular JobId. The {\bf llist} command will include a line with
1426 the time and date of the entry.
1428 Note for the catalog to have Job Log entries, you must have a directive
1435 In your Director's {\bf Messages} resource.
1437 \subsection{Use separator for multiple commands}
1438 \index[general]{Command Separator}
1439 When using bconsole with readline, you can set the command separator with
1440 \textbf{@separator} command to one
1441 of those characters to write commands who require multiple input in one line.
1443 !$%&'()*+,-/:;<>?[]^`{|}~
1446 \subsection{Deleting Volumes}
1447 The delete volume bconsole command has been modified to
1448 require an asterisk (*) in front of a MediaId otherwise the
1449 value you enter is a taken to be a Volume name. This is so that
1450 users may delete numeric Volume names. The previous Bacula versions
1451 assumed that all input that started with a number was a MediaId.
1453 This new behavior is indicated in the prompt if you read it
1456 \section{Bare Metal Recovery}
1457 The old bare metal recovery project is essentially dead. One
1458 of the main features of it was that it would build a recovery
1459 CD based on the kernel on your system. The problem was that
1460 every distribution has a different boot procedure and different
1461 scripts, and worse yet, the boot procedures and scripts change
1462 from one distribution to another. This meant that maintaining
1463 (keeping up with the changes) the rescue CD was too much work.
1465 To replace it, a new bare metal recovery USB boot stick has been developed
1466 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1467 boot from a USB key.
1471 \item Recovery can be done from within graphical environment.
1472 \item Recovery can be done in a shell.
1473 \item Ubuntu boots on a large number of Linux systems.
1474 \item The process of updating the system and adding new
1475 packages is not too difficult.
1476 \item The USB key can easily be upgraded to newer Ubuntu versions.
1477 \item The USB key has writable partitions for modifications to
1478 the OS and for modification to your home directory.
1479 \item You can add new files/directories to the USB key very easily.
1480 \item You can save the environment from multiple machines on
1482 \item Bacula Systems is funding its ongoing development.
1485 The disadvantages are:
1487 \item The USB key is usable but currently under development.
1488 \item Not everyone may be familiar with Ubuntu (no worse
1490 \item Some older OSes cannot be booted from USB. This can
1491 be resolved by first booting a Ubuntu LiveCD then plugging
1493 \item Currently the documentation is sketchy and not yet added
1494 to the main manual. See below ...
1497 The documentation and the code can be found in the {\bf rescue} package
1498 in the directory {\bf linux/usb}.
1500 \section{Miscellaneous}
1501 \index[general]{Misc New Features}
1503 \subsection{Allow Mixed Priority = \lt{}yes|no\gt{}}
1504 \index[general]{Allow Mixed Priority}
1505 This directive is only implemented in version 2.5 and later. When
1506 set to {\bf yes} (default {\bf no}), this job may run even if lower
1507 priority jobs are already running. This means a high priority job
1508 will not have to wait for other jobs to finish before starting.
1509 The scheduler will only mix priorities when all running jobs have
1512 Note that only higher priority jobs will start early. Suppose the
1513 director will allow two concurrent jobs, and that two jobs with
1514 priority 10 are running, with two more in the queue. If a job with
1515 priority 5 is added to the queue, it will be run as soon as one of
1516 the running jobs finishes. However, new priority 10 jobs will not
1517 be run until the priority 5 job has finished.
1519 \subsection{Bootstrap File Directive -- FileRegex}
1520 \index[general]{Bootstrap File Directive}
1521 {\bf FileRegex} is a new command that can be added to the bootstrap
1522 (.bsr) file. The value is a regular expression. When specified, only
1523 matching filenames will be restored.
1525 During a restore, if all File records are pruned from the catalog
1526 for a Job, normally Bacula can restore only all files saved. That
1527 is there is no way using the catalog to select individual files.
1528 With this new feature, Bacula will ask if you want to specify a Regex
1529 expression for extracting only a part of the full backup.
1532 Building directory tree for JobId(s) 1,3 ...
1533 There were no files inserted into the tree, so file selection
1534 is not possible.Most likely your retention policy pruned the files
1536 Do you want to restore all the files? (yes|no): no
1538 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1539 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1542 \subsection{Bootstrap File Optimization Changes}
1543 In order to permit proper seeking on disk files, we have extended the bootstrap
1544 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1545 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1546 address range and end address range respectively. These two directives replace
1547 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1548 VolEndBlock} directives. Bootstrap files containing the old directives will
1549 still work, but will not properly take advantage of proper disk seeking, and
1550 may read completely to the end of a disk volume during a restore. With the new
1551 format (automatically generated by the new Director), restores will seek
1552 properly and stop reading the volume when all the files have been restored.
1554 \subsection{Solaris ZFS/NFSv4 ACLs}
1555 This is an upgrade of the previous Solaris ACL backup code
1556 to the new library format, which will backup both the old
1557 POSIX(UFS) ACLs as well as the ZFS ACLs.
1559 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1560 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1561 be used to transfer from UFS to ZFS filesystems.
1564 \subsection{Virtual Tape Emulation}
1565 \index[general]{Virtual Tape Emulation}
1566 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1567 the tape code but actually reading and writing to a disk file. Used with the
1568 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1569 and 700 slots. This feature is most useful in testing. It is enabled
1570 by using {\bf Device Type = vtape} in the Storage daemon's Device
1571 directive. This feature is only implemented on Linux machines and should not be
1572 used for production.
1574 \subsection{Bat Enhancements}
1575 \index[general]{Bat Enhancements}
1576 Bat (the Bacula Administration Tool) GUI program has been significantly
1577 enhanced and stabilized. In particular, there are new table based status
1578 commands; it can now be easily localized using Qt4 Linguist.
1580 The Bat communications protocol has been significantly enhanced to improve
1581 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1582 the Director you are using otherwise the communications protocol will not
1585 \subsection{RunScript Enhancements}
1586 \index[general]{RunScript Enhancements}
1587 The {\bf RunScript} resource has been enhanced to permit multiple
1588 commands per RunScript. Simply specify multiple {\bf Command} directives
1595 Command = "/bin/echo test"
1596 Command = "/bin/echo an other test"
1597 Command = "/bin/echo 3 commands in the same runscript"
1604 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1605 implemented, which runs the command after the Volume Shadow Copy has been made.
1607 Console commands can be specified within a RunScript by using:
1608 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1609 carefully tested and debugged and is known to easily crash the Director.
1610 We would appreciate feedback. Due to the recursive nature of this command, we
1611 may remove it before the final release.
1613 \subsection{Status Enhancements}
1614 \index[general]{Status Enhancements}
1615 The bconsole {\bf status dir} output has been enhanced to indicate
1616 Storage daemon job spooling and despooling activity.
1618 \subsection{Connect Timeout}
1619 \index[general]{Connect Timeout}
1620 The default connect timeout to the File
1621 daemon has been set to 3 minutes. Previously it was 30 minutes.
1623 \subsection{ftruncate for NFS Volumes}
1624 \index[general]{ftruncate for NFS Volumes}
1625 If you write to a Volume mounted by NFS (say on a local file server),
1626 in previous Bacula versions, when the Volume was recycled, it was not
1627 properly truncated because NFS does not implement ftruncate (file
1628 truncate). This is now corrected in the new version because we have
1629 written code (actually a kind user) that deletes and recreates the Volume,
1630 thus accomplishing the same thing as a truncate.
1632 \subsection{Support for Ubuntu}
1633 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1634 version of Linux, and thus now provides correct autostart routines.
1635 Since Ubuntu officially supports Bacula, you can also obtain any
1636 recent release of Bacula from the Ubuntu repositories.
1638 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1639 \index[general]{Recycle Pool}
1640 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1641 be placed (moved) when it is recycled. Without this directive, a Volume will
1642 remain in the same pool when it is recycled. With this directive, it can be
1643 moved automatically to any existing pool during a recycle. This directive is
1644 probably most useful when defined in the Scratch pool, so that volumes will
1645 be recycled back into the Scratch pool.
1647 \subsection{FD Version}
1648 \index[general]{FD Version}
1649 The File daemon to Director protocol now includes a version
1650 number, which although there is no visible change for users,
1651 will help us in future versions automatically determine
1652 if a File daemon is not compatible.
1654 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1655 \index[general]{Max Run Sched Time}
1656 The time specifies the maximum allowed time that a job may run, counted from
1657 when the job was scheduled. This can be useful to prevent jobs from running
1658 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1661 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1662 \index[general]{Max Wait Time}
1663 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1664 of checking the maximum allowed time that a job may block for a resource,
1665 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1666 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1667 their job depending on the level. Now, they have to use
1668 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
1669 directives are now deprecated.
1671 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1672 \index[general]{Incremental Max Wait Time}
1673 \index[general]{Differential Max Wait Time}
1675 These directives have been deprecated in favor of
1676 \texttt{Incremental|Differential Max Run Time}.
1678 \subsection{Max Run Time directives}
1679 \index[general]{Max Run Time directives}
1680 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1681 maximum allowed time that a job can run depending on the level.
1683 \addcontentsline{lof}{figure}{Job time control directives}
1684 \includegraphics{\idir different_time.eps}
1686 \subsection{Statistics Enhancements}
1687 \index[general]{Statistics Enhancements}
1688 If you (or probably your boss) want to have statistics on your backups to
1689 provide some \textit{Service Level Agreement} indicators, you could use a few
1690 SQL queries on the Job table to report how many:
1694 \item jobs have been successful
1695 \item files have been backed up
1699 However, these statistics are accurate only if your job retention is greater
1700 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1701 be able to use them.
1703 Now, you can use the \textbf{update stats [days=num]} console command to fill
1704 the JobHistory table with new Job records. If you want to be sure to take in
1705 account only \textbf{good jobs}, ie if one of your important job has failed but
1706 you have fixed the problem and restarted it on time, you probably want to
1707 delete the first \textit{bad} job record and keep only the successful one. For
1708 that simply let your staff do the job, and update JobHistory table after two or
1709 three days depending on your organization using the \textbf{[days=num]} option.
1711 These statistics records aren't used for restoring, but mainly for
1712 capacity planning, billings, etc.
1714 The Bweb interface provides a statistics module that can use this feature. You
1715 can also use tools like Talend or extract information by yourself.
1717 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1718 the length of time that Bacula will keep statistics job records in the Catalog
1719 database after the Job End time. (In \texttt{JobHistory} table) When this time
1720 period expires, and if user runs \texttt{prune stats} command, Bacula will
1721 prune (remove) Job records that are older than the specified period.
1723 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1724 job to maintain statistics.
1727 Name = BackupCatalog
1730 Console = "update stats days=3"
1731 Console = "prune stats yes"
1738 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1739 \index[general]{ScratchPool}
1740 This directive permits to specify a specific \textsl{Scratch} pool for the
1741 current pool. This is useful when using multiple storage sharing the same
1742 mediatype or when you want to dedicate volumes to a particular set of pool.
1744 \subsection{Enhanced Attribute Despooling}
1745 \index[general]{Attribute Despooling}
1746 If the storage daemon and the Director are on the same machine, the spool file
1747 that contains attributes is read directly by the Director instead of being
1748 transmitted across the network. That should reduce load and speedup insertion.
1750 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1751 \index[general]{SpoolSize}
1752 A new Job directive permits to specify the spool size per job. This is used
1753 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1755 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1756 \index[general]{MaxConsoleConnections}
1757 A new director directive permits to specify the maximum number of Console
1758 Connections that could run concurrently. The default is set to 20, but you may
1759 set it to a larger number.
1761 \subsection{VerId = \lt{}string\gt{}}
1762 \index[general]{VerId}
1763 A new director directive permits to specify a personnal identifier that will be
1764 displayed in the \texttt{version} command.
1766 \subsection{dbcheck enhancements}
1767 \index[general]{dbcheck enhancements}
1768 If you are using Mysql, dbcheck will now ask you if you want to create
1769 temporary indexes to speed up orphaned Path and Filename elimination.
1771 A new \texttt{-B} option allows you to print catalog information in a simple
1772 text based format. This is useful to backup it in a secure way.
1787 You can now specify the database connection port in the command line.
1789 \subsection{{-}{-}docdir configure option}
1790 \index[general]{{-}{-}docdir configure option}
1791 You can use {-}{-}docdir= on the ./configure command to
1792 specify the directory where you want Bacula to install the
1793 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
1794 {\bf /usr/share/doc/bacula}.
1796 \subsection{{-}{-}htmldir configure option}
1797 \index[general]{{-}{-}htmldir configure option}
1798 You can use {-}{-}htmldir= on the ./configure command to
1799 specify the directory where you want Bacula to install the bat html help
1800 files. The default is {\bf /usr/share/doc/bacula/html}
1802 \subsection{{-}{-}with-plugindir configure option}
1803 \index[general]{{-}{-}plugindir configure option}
1804 You can use {-}{-}plugindir= on the ./configure command to
1805 specify the directory where you want Bacula to install
1806 the plugins (currently only bpipe-fd). The default is