1 \chapter{New Features in 5.0.0}
2 \label{NewFeaturesChapter}
4 This chapter presents the new features that are in the
5 released Bacula version 5.0.0.
7 \section{Maximum Concurent Jobs for Devices}
8 \label{sec:maximumconcurentjobdevice}
10 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
11 Daemon configuration permits setting the maximum number of Jobs that can
12 run concurrently on a specified Device. Using this directive, it is
13 possible to have different Jobs using multiple drives, because when the
14 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
15 Jobs on any other available compatible drive. This facilitates writing to
16 multiple drives with multiple Jobs that all use the same Pool.
18 This project was funded by Bacula Systems.
20 \section{Restore from Multiple Storage Daemons}
21 \index[general]{Restore}
23 Previously, you were able to restore from multiple devices in a single Storage
24 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
25 example, if your full backup runs on a Storage Daemon with an autochanger, and
26 your incremental jobs use another Storage Daemon with lots of disks, Bacula
27 will switch automatically from one Storage Daemon to an other within the same
30 You must upgrade your File Daemon to version 3.1.3 or greater to use this
33 This project was funded by Bacula Systems with the help of Equiinet.
35 \section{File Deduplication using Base Jobs}
36 A base job is sort of like a Full save except that you will want the FileSet to
37 contain only files that are unlikely to change in the future (i.e. a snapshot
38 of most of your system after installing it). After the base job has been run,
39 when you are doing a Full save, you specify one or more Base jobs to be used.
40 All files that have been backed up in the Base job/jobs but not modified will
41 then be excluded from the backup. During a restore, the Base jobs will be
42 automatically pulled in where necessary.
44 This is something none of the competition does, as far as we know (except
45 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
46 win for the user, it makes Bacula stand out as offering a unique optimization
47 that immediately saves time and money. Basically, imagine that you have 100
48 nearly identical Windows or Linux machine containing the OS and user files.
49 Now for the OS part, a Base job will be backed up once, and rather than making
50 100 copies of the OS, there will be only one. If one or more of the systems
51 have some files updated, no problem, they will be automatically restored.
53 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
54 files that will be used during Full backup as base.
65 Base = BackupZog4, BackupLinux
71 In this example, the job \texttt{BackupZog4} will use the most recent version
72 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
73 jobs. Base jobs should have run with \texttt{level=Base} to be used.
75 By default, Bacula will compare permissions bits, user and group fields,
76 modification time, size and the checksum of the file to choose between the
77 current backup and the BaseJob file list. You can change this behavior with the
78 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
79 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
95 \textbf{Important note}: The current implementation doesn't permit to scan
96 volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
98 This project was funded by Bacula Systems.
100 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
101 \index[dir]{AllowCompression}
103 This new directive may be added to Storage resource within the Director's
104 configuration to allow users to selectively disable the client compression for
105 any job which writes to this storage resource.
111 Address = ultrium-tape
112 Password = storage_password # Password for Storage Daemon
115 AllowCompression = No # Tape drive has hardware compression
118 The above example would cause any jobs running with the UltriumTape storage
119 resource to run without compression from the client file daemons. This
120 effectively overrides any compression settings defined at the FileSet level.
122 This feature is probably most useful if you have a tape drive which supports
123 hardware compression. By setting the \texttt{AllowCompression = No} directive
124 for your tape drive storage resource, you can avoid additional load on the file
125 daemon and possibly speed up tape backups.
127 This project was funded by Collaborative Fusion, Inc.
129 \section{Accurate Fileset Options}
130 \label{sec:accuratefileset}
132 In previous versions, the accurate code used the file creation and modification
133 times to determine if a file was modified or not. Now you can specify which
134 attributes to use (time, size, checksum, permission, owner, group, \dots),
135 similar to the Verify options.
151 \item {\bf i} compare the inodes
152 \item {\bf p} compare the permission bits
153 \item {\bf n} compare the number of links
154 \item {\bf u} compare the user id
155 \item {\bf g} compare the group id
156 \item {\bf s} compare the size
157 \item {\bf a} compare the access time
158 \item {\bf m} compare the modification time (st\_mtime)
159 \item {\bf c} compare the change time (st\_ctime)
160 \item {\bf d} report file size decreases
161 \item {\bf 5} compare the MD5 signature
162 \item {\bf 1} compare the SHA1 signature
165 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
166 the File Daemon will have to read all files even if they normally would not
167 be saved. This increases the I/O load, but also the accuracy of the
168 deduplication. By default, Bacula will check modification/creation time
171 This project was funded by Bacula Systems.
173 \section{Tab-completion for Bconsole}
174 \label{sec:tabcompletion}
176 If you build \texttt{bconsole} with readline support, you will be able to use
177 the new auto-completion mode. This mode supports all commands, gives help
178 inside command, and lists resources when required. It works also in the restore
181 To use this feature, you should have readline development package loaded on
182 your system, and use the following option in configure.
184 ./configure --with-readline=/usr/include/readline --disable-conio ...
187 The new bconsole won't be able to tab-complete with older directors.
189 This project was funded by Bacula Systems.
191 \section{Pool File and Job retention}
192 \label{sec:poolfilejobretention}
195 We added two new Pool directives, \texttt{FileRetention} and
196 \texttt{JobRetention}, that take precedence over Client directives of the same
197 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
198 example, you can decide to increase Retention times for Archive or OffSite Pool.
200 \section{Read-only File Daemon using capabilities}
201 \label{sec:fdreadonly}
202 This feature implements support of keeping \textbf{ReadAll} capabilities after
203 UID/GID switch, this allows FD to keep root read but drop write permission.
205 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
206 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
209 root@localhost:~# bacula-fd -k -u nobody -g nobody
212 The code for this feature was contributed by AltLinux.
217 To help developers of restore GUI interfaces, we have added new \textsl{dot
218 commands} that permit browsing the catalog in a very simple way.
221 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
222 the Bvfs cache in the catalog. You need to run it before any access to the
225 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
226 will list all directories in the specified \texttt{path} or
227 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
228 encoding of path/filenames.
230 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
231 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
232 \texttt{pathid} avoids problems with character encoding.
235 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
236 data that will be displayed.
239 * .bvfs_update jobid=1,2
241 * .bvfs_lsdir path=/ jobid=1,2
244 This project was funded by Bacula Systems.
246 \section{Testing your Tape Drive}
247 \label{sec:btapespeed}
249 To determine the best configuration of your tape drive, you can run the new
250 \texttt{speed} command available in the \texttt{btape} program.
252 This command can have the following arguments:
254 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
255 (between 1 and 5GB). This counter is in GB.
256 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
257 of data should be greater than your memory ($file\_size*nb\_file$).
258 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
260 \item[\texttt{skip\_random}] This flag permits to skip tests with random
262 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
263 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
268 *speed file_size=3 skip_raw
269 btape.c:1078 Test with zero data and bacula block structure.
270 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
271 ++++++++++++++++++++++++++++++++++++++++++
272 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
273 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
275 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
277 btape.c:1090 Test with random data, should give the minimum throughput.
278 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
279 +++++++++++++++++++++++++++++++++++++++++++
280 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
281 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
282 +++++++++++++++++++++++++++++++++++++++++++
284 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
288 When using compression, the random test will give your the minimum throughput
289 of your drive . The test using constant string will give you the maximum speed
290 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
292 You can change the block size in the Storage Daemon configuration file.
294 \section{New {\bf Block Checksum} Device Directive}
295 You may now turn off the Block Checksum (CRC32) code
296 that Bacula uses when writing blocks to a Volume. This is
303 doing so can reduce the Storage daemon CPU usage slightly. It
304 will also permit Bacula to read a Volume that has corrupted data.
306 The default is {\bf yes} -- i.e. the checksum is computed on write
309 We do not recommend to turn this off particularly on older tape
310 drives or for disk Volumes where doing so may allow corrupted data
313 \section{New Bat Features}
315 Those new features were funded by Bacula Systems.
317 \subsection{Media List View}
319 By clicking on ``Media'', you can see the list of all your volumes. You will be
320 able to filter by Pool, Media Type, Location,\dots And sort the result directly
321 in the table. The old ``Media'' view is now known as ``Pool''.
324 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
325 \label{fig:mediaview}
329 \subsection{Media Information View}
331 By double-clicking on a volume (on the Media list, in the Autochanger content
332 or in the Job information panel), you can access a detailed overview of your
333 Volume. (cf \ref{fig:mediainfo}.)
336 \includegraphics[width=13cm]{\idir bat11.eps}
337 \caption{Media information}
338 \label{fig:mediainfo}
341 \subsection{Job Information View}
343 By double-clicking on a Job record (on the Job run list or in the Media
344 information panel), you can access a detailed overview of your Job. (cf
348 \includegraphics[width=13cm]{\idir bat12.eps}
349 \caption{Job information}
353 \subsection{Autochanger Content View}
355 By double-clicking on a Storage record (on the Storage list panel), you can
356 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
359 \includegraphics[width=13cm]{\idir bat13.eps}
360 \caption{Autochanger content}
361 \label{fig:achcontent}
364 To use this feature, you need to use the latest mtx-changer script
365 version. (With new \texttt{listall} and \texttt{transfer} commands)
367 \section{Bat on Windows}
368 We have ported {\bf bat} to Windows and it is now installed
369 by default when the installer is run. It works quite well
370 on Win32, but has not had a lot of testing there, so your
371 feedback would be welcome. Unfortunately, eventhough it is
372 installed by default, it does not yet work on 64 bit Windows
375 \section{New Win32 Installer}
376 The Win32 installer has been modified in several very important
379 \item You must deinstall any current version of the
380 Win32 File daemon before upgrading to the new one.
381 If you forget to do so, the new installation will fail.
382 To correct this failure, you must manually shutdown
383 and deinstall the old File daemon.
384 \item All files (other than menu links) are installed
385 in {\bf c:/Program Files/Bacula}.
386 \item The installer no longer sets this
387 file to require administrator privileges by default. If you want
388 to do so, please do it manually using the {\bf cacls} program.
391 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
393 \item The server daemons (Director and Storage daemon) are
394 no longer included in the Windows installer. If you want the
395 Windows servers, you will either need to build them yourself (note
396 they have not been ported to 64 bits), or you can contact
397 Bacula Systems about this.
400 \section{Win64 Installer}
401 We have corrected a number of problems that required manual
402 editing of the conf files. In most cases, it should now
403 install and work. {\bf bat} is by default installed in
404 {\bf c:/Program Files/Bacula/bin32} rather than
405 {\bf c:/Program Files/Bacula} as is the case with the 32
406 bit Windows installer.
408 \section{Bare Metal Recovery USB Key}
409 We have made a number of significant improvements in the
410 Bare Metal Recovery USB key. Please see the README files
411 it the {\bf rescue} release for more details.
415 \section{bconsole Timeout Option}
416 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
417 for commands. This is useful with GUI programs that use {\bf bconsole}
418 to interface to the Director.
420 \section{Important Changes}
421 \label{sec:importantchanges}
424 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
425 to the same Pool. The Storage daemon ensures that you do not read and
426 write to the same Volume.
427 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
429 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
430 and \texttt{transfer}. Be sure to apply any custom changes on to the
431 mtx-changer script, or better yet, use mtx-changer.conf to configure
433 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
434 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
435 password. If you want to use the new script, you will need to
436 manually change the \texttt{BackupCatalog} Job definition.
437 \item The \texttt{bconsole} \texttt{help} command now accepts
438 an argument, which if provided produces information on that
439 command (ex: \texttt{help run}).
442 \subsubsection*{Truncate volume after purge}
443 \label{sec:actiononpurge}
445 This feature doesn't work as expected in version 5.0.0. Please do not use it
446 before version 5.0.1.
448 %The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
449 %the volume when it is purged. It is useful to prevent disk based volumes from
450 %consuming too much space.
455 % Action On Purge = Truncate
460 \subsection{Custom Catalog queries}
462 If you wish to add specialized commands that list the contents of the catalog,
463 you can do so by adding them to the \texttt{query.sql} file. This
464 \texttt{query.sql} file is now empty by default. The file
465 \texttt{examples/sample-query.sql} has an a number of sample commands
466 you might find useful.
468 \subsection{Deprecated parts}
470 The following items have been \textbf{deprecated} for a long time, and are now
471 removed from the code.
474 \item Support for SQLite 2
477 \section{Misc Changes}
478 \label{sec:miscchanges}
481 \item Updated Nagios check\_bacula
482 \item Updated man files
483 \item Added OSX package generation script in platforms/darwin
484 \item Added Spanish and Ukrainian Bacula translations
485 \item Enable/disable command shows only Jobs that can change
486 \item Added \texttt{show disabled} command to show disabled Jobs
487 \item Many ACL improvements
488 \item Added Level to FD status Job output
489 \item Begin Ingres DB driver (not yet working)
490 \item Split RedHat spec files into bacula, bat, mtx, and docs
491 \item Reorganized the manuals (fewer separate manuals)
492 \item Added lock/unlock order protection in lock manager
493 \item Allow 64 bit sizes for a number of variables
494 \item Fixed several deadlocks or potential race conditions in the SD
497 \chapter{Released Version 3.0.3 and 3.0.3a}
499 There are no new features in version 3.0.3. This version simply fixes a
500 number of bugs found in version 3.0.2 during the onging development
503 \chapter{New Features in Released Version 3.0.2}
505 This chapter presents the new features added to the
506 Released Bacula Version 3.0.2.
508 \section{Full Restore from a Given JobId}
509 \index[general]{Restore menu}
511 This feature allows selecting a single JobId and having Bacula
512 automatically select all the other jobs that comprise a full backup up to
513 and including the selected date (through JobId).
515 Assume we start with the following jobs:
517 +-------+--------------+---------------------+-------+----------+------------+
518 | jobid | client | starttime | level | jobfiles | jobbytes |
519 +-------+--------------+---------------------+-------+----------+------------
520 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
521 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
522 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
523 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
524 +-------+--------------+---------------------+-------+----------+------------+
527 Below is an example of this new feature (which is number 12 in the
532 To select the JobIds, you have the following choices:
533 1: List last 20 Jobs run
534 2: List Jobs where a given File is saved
536 12: Select full restore to a specified Job date
539 Select item: (1-13): 12
540 Enter JobId to get the state to restore: 5
541 Selecting jobs to build the Full state at 2009-07-15 11:45:45
542 You have selected the following JobIds: 1,3,5
544 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
545 1,444 files inserted into the tree.
548 This project was funded by Bacula Systems.
550 \section{Source Address}
551 \index[general]{Source Address}
553 A feature has been added which allows the administrator to specify the address
554 from which the Director and File daemons will establish connections. This
555 may be used to simplify system configuration overhead when working in complex
556 networks utilizing multi-homing and policy-routing.
558 To accomplish this, two new configuration directives have been implemented:
561 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
565 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
569 Simply adding specific host routes on the OS
570 would have an undesirable side-effect: any
571 application trying to contact the destination host would be forced to use the
572 more specific route possibly diverting management traffic onto a backup VLAN.
573 Instead of adding host routes for each client connected to a multi-homed backup
574 server (for example where there are management and backup VLANs), one can
575 use the new directives to specify a specific source address at the application
578 Additionally, this allows the simplification and abstraction of firewall rules
579 when dealing with a Hot-Standby director or storage daemon configuration. The
580 Hot-standby pair may share a CARP address, which connections must be sourced
581 from, while system services listen and act from the unique interface addresses.
583 This project was funded by Collaborative Fusion, Inc.
585 \section{Show volume availability when doing restore}
587 When doing a restore the selection dialog ends by displaying this
591 The job will require the following
592 Volume(s) Storage(s) SD Device(s)
593 ===========================================================================
604 Volumes marked with ``*'' are online (in the autochanger).
607 This should help speed up large restores by minimizing the time spent
608 waiting for the operator to discover that he must change tapes in the library.
610 This project was funded by Bacula Systems.
612 \section{Accurate estimate command}
614 The \texttt{estimate} command can now use the accurate code to detect changes
615 and give a better estimation.
617 You can set the accurate behavior on the command line by using
618 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
621 * estimate listing accurate=yes level=incremental job=BackupJob
624 This project was funded by Bacula Systems.
626 \chapter{New Features in 3.0.0}
627 \label{NewFeaturesChapter}
628 \index[general]{New Features}
630 This chapter presents the new features added to the development 2.5.x
631 versions to be released as Bacula version 3.0.0 sometime in April 2009.
633 \section{Accurate Backup}
634 \index[general]{Accurate Backup}
636 As with most other backup programs, by default Bacula decides what files to
637 backup for Incremental and Differental backup by comparing the change
638 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
639 backup completed. If one of those two times is later than the last backup
640 time, then the file will be backed up. This does not, however, permit tracking
641 what files have been deleted and will miss any file with an old time that may
642 have been restored to or moved onto the client filesystem.
644 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
645 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
646 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
647 backup, there is no difference, but for {\bf Differential} and {\bf
648 Incremental} backups, the Director will send a list of all previous files
649 backed up, and the File daemon will use that list to determine if any new files
650 have been added or or moved and if any files have been deleted. This allows
651 Bacula to make an accurate backup of your system to that point in time so that
652 if you do a restore, it will restore your system exactly.
655 about using Accurate backup is that it requires more resources (CPU and memory)
656 on both the Director and the Client machines to create the list of previous
657 files backed up, to send that list to the File daemon, for the File daemon to
658 keep the list (possibly very big) in memory, and for the File daemon to do
659 comparisons between every file in the FileSet and the list. In particular,
660 if your client has lots of files (more than a few million), you will need
661 lots of memory on the client machine.
663 Accurate must not be enabled when backing up with a plugin that is not
664 specially designed to work with Accurate. If you enable it, your restores
665 will probably not work correctly.
667 This project was funded by Bacula Systems.
672 \index[general]{Copy Jobs}
674 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
675 existing Migration feature with the exception that the Job that is copied is
676 left unchanged. This essentially creates two identical copies of the same
677 backup. However, the copy is treated as a copy rather than a backup job, and
678 hence is not directly available for restore. The {\bf restore} command lists
679 copy jobs and allows selection of copies by using \texttt{jobid=}
680 option. If the keyword {\bf copies} is present on the command line, Bacula will
681 display the list of all copies for selected jobs.
686 These JobIds have copies as follows:
687 +-------+------------------------------------+-----------+------------------+
688 | JobId | Job | CopyJobId | MediaType |
689 +-------+------------------------------------+-----------+------------------+
690 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
691 +-------+------------------------------------+-----------+------------------+
692 +-------+-------+----------+----------+---------------------+------------------+
693 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
694 +-------+-------+----------+----------+---------------------+------------------+
695 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
696 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
697 +-------+-------+----------+----------+---------------------+------------------+
698 You have selected the following JobIds: 19,2
700 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
701 5,611 files inserted into the tree.
706 The Copy Job runs without using the File daemon by copying the data from the
707 old backup Volume to a different Volume in a different Pool. See the Migration
708 documentation for additional details. For copy Jobs there is a new selection
709 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
710 not already copied to another Pool.
712 As with Migration, the Client, Volume, Job, or SQL query, are
713 other possible ways of selecting the Jobs to be copied. Selection
714 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
715 work, but are probably more suited for Migration Jobs.
717 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
718 it will promote the Copy to a \textsl{real} backup job and will make it available for
719 automatic restore. If more than one Copy is available, it will promote the copy
720 with the smallest JobId.
722 A nice solution which can be built with the new Copy feature is often
723 called disk-to-disk-to-tape backup (DTDTT). A sample config could
724 look something like the one below:
728 Name = FullBackupsVirtualPool
730 Purge Oldest Volume = Yes
732 NextPool = FullBackupsTapePool
736 Name = FullBackupsTapePool
740 Volume Retention = 365 days
741 Storage = superloader
745 # Fake fileset for copy jobs
757 # Fake client for copy jobs
767 # Default template for a CopyDiskToTape Job
770 Name = CopyDiskToTape
772 Messages = StandardCopy
775 Selection Type = PoolUncopiedJobs
776 Maximum Concurrent Jobs = 10
778 Allow Duplicate Jobs = Yes
779 Allow Higher Duplicates = No
780 Cancel Queued Duplicates = No
781 Cancel Running Duplicates = No
786 Name = DaySchedule7:00
787 Run = Level=Full daily at 7:00
791 Name = CopyDiskToTapeFullBackups
793 Schedule = DaySchedule7:00
794 Pool = FullBackupsVirtualPool
795 JobDefs = CopyDiskToTape
799 The example above had 2 pool which are copied using the PoolUncopiedJobs
800 selection criteria. Normal Full backups go to the Virtual pool and are copied
801 to the Tape pool the next morning.
803 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
808 +-------+------------------------------------+-----------+------------------+
809 | JobId | Job | CopyJobId | MediaType |
810 +-------+------------------------------------+-----------+------------------+
811 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
812 +-------+------------------------------------+-----------+------------------+
815 \section{ACL Updates}
816 \index[general]{ACL Updates}
817 The whole ACL code had been overhauled and in this version each platforms has
818 different streams for each type of acl available on such an platform. As ACLs
819 between platforms tend to be not that portable (most implement POSIX acls but
820 some use an other draft or a completely different format) we currently only
821 allow certain platform specific ACL streams to be decoded and restored on the
822 same platform that they were created on. The old code allowed to restore ACL
823 cross platform but the comments already mention that not being to wise. For
824 backward compatability the new code will accept the two old ACL streams and
825 handle those with the platform specific handler. But for all new backups it
826 will save the ACLs using the new streams.
828 Currently the following platforms support ACLs:
832 \item {\bf Darwin/OSX}
841 Currently we support the following ACL types (these ACL streams use a reserved
842 part of the stream numbers):
845 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
847 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
848 string representation from acl\_to\_text (POSIX acl)
849 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
850 string representation from acl\_to\_text (POSIX acl) for default acls.
851 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
852 string representation from acl\_to\_text (POSIX acl) for access acls.
853 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
854 string representation from acltostr (POSIX acl)
855 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
856 representation from acl\_to\_text (POSIX acl) for default acls.
857 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
858 representation from acl\_to\_text (POSIX acl) for access acls.
859 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
860 string representation from acl\_to\_text (POSIX acl) for default acls.
861 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
862 representation from acl\_to\_text (POSIX acl) for access acls.
863 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
864 string representation from acl\_to\_text (POSIX acl) for default acls.
865 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
866 string representation from acl\_to\_text (POSIX acl) for default acls.
867 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
868 representation from acl\_to\_text (POSIX acl) for access acls.
869 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
870 string representation from acltotext or acl\_totext (POSIX acl)
871 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
872 representation from from acl\_totext (NFSv4 or ZFS acl)
875 In future versions we might support conversion functions from one type of acl
876 into an other for types that are either the same or easily convertable. For now
877 the streams are seperate and restoring them on a platform that doesn't
878 recognize them will give you a warning.
880 \section{Extended Attributes}
881 \index[general]{Extended Attributes}
882 Something that was on the project list for some time is now implemented for
883 platforms that support a similar kind of interface. Its the support for backup
884 and restore of so called extended attributes. As extended attributes are so
885 platform specific these attributes are saved in seperate streams for each
886 platform. Restores of the extended attributes can only be performed on the
887 same platform the backup was done. There is support for all types of extended
888 attributes, but restoring from one type of filesystem onto an other type of
889 filesystem on the same platform may lead to supprises. As extended attributes
890 can contain any type of data they are stored as a series of so called
891 value-pairs. This data must be seen as mostly binary and is stored as such.
892 As security labels from selinux are also extended attributes this option also
893 stores those labels and no specific code is enabled for handling selinux
896 Currently the following platforms support extended attributes:
898 \item {\bf Darwin/OSX}
904 On linux acls are also extended attributes, as such when you enable ACLs on a
905 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
906 and not the same exteneded attribute.
908 To enable the backup of extended attributes please add the following to your
923 \section{Shared objects}
924 \index[general]{Shared objects}
925 A default build of Bacula will now create the libraries as shared objects
926 (.so) rather than static libraries as was previously the case.
927 The shared libraries are built using {\bf libtool} so it should be quite
930 An important advantage of using shared objects is that on a machine with the
931 Directory, File daemon, the Storage daemon, and a console, you will have only
932 one copy of the code in memory rather than four copies. Also the total size of
933 the binary release is smaller since the library code appears only once rather
934 than once for every program that uses it; this results in significant reduction
935 in the size of the binaries particularly for the utility tools.
937 In order for the system loader to find the shared objects when loading the
938 Bacula binaries, the Bacula shared objects must either be in a shared object
939 directory known to the loader (typically /usr/lib) or they must be in the
940 directory that may be specified on the {\bf ./configure} line using the {\bf
941 {-}{-}libdir} option as:
944 ./configure --libdir=/full-path/dir
947 the default is /usr/lib. If {-}{-}libdir is specified, there should be
948 no need to modify your loader configuration provided that
949 the shared objects are installed in that directory (Bacula
950 does this with the make install command). The shared objects
951 that Bacula references are:
960 These files are symbolically linked to the real shared object file,
961 which has a version number to permit running multiple versions of
962 the libraries if desired (not normally the case).
964 If you have problems with libtool or you wish to use the old
965 way of building static libraries, or you want to build a static
966 version of Bacula you may disable
967 libtool on the configure command line with:
970 ./configure --disable-libtool
974 \section{Building Static versions of Bacula}
975 \index[general]{Static linking}
976 In order to build static versions of Bacula, in addition
977 to configuration options that were needed you now must
978 also add --disable-libtool. Example
981 ./configure --enable-static-client-only --disable-libtool
985 \section{Virtual Backup (Vbackup)}
986 \index[general]{Virtual Backup}
987 \index[general]{Vbackup}
989 Bacula's virtual backup feature is often called Synthetic Backup or
990 Consolidation in other backup products. It permits you to consolidate the
991 previous Full backup plus the most recent Differential backup and any
992 subsequent Incremental backups into a new Full backup. This new Full
993 backup will then be considered as the most recent Full for any future
994 Incremental or Differential backups. The VirtualFull backup is
995 accomplished without contacting the client by reading the previous backup
996 data and writing it to a volume in a different pool.
998 In some respects the Vbackup feature works similar to a Migration job, in
999 that Bacula normally reads the data from the pool specified in the
1000 Job resource, and writes it to the {\bf Next Pool} specified in the
1001 Job resource. Note, this means that usually the output from the Virtual
1002 Backup is written into a different pool from where your prior backups
1003 are saved. Doing it this way guarantees that you will not get a deadlock
1004 situation attempting to read and write to the same volume in the Storage
1005 daemon. If you then want to do subsequent backups, you may need to
1006 move the Virtual Full Volume back to your normal backup pool.
1007 Alternatively, you can set your {\bf Next Pool} to point to the current
1008 pool. This will cause Bacula to read and write to Volumes in the
1009 current pool. In general, this will work, because Bacula will
1010 not allow reading and writing on the same Volume. In any case, once
1011 a VirtualFull has been created, and a restore is done involving the
1012 most current Full, it will read the Volume or Volumes by the VirtualFull
1013 regardless of in which Pool the Volume is found.
1015 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1016 a level of {\bf VirtualFull}.
1018 A typical Job resource definition might look like the following:
1025 FileSet = "Full Set"
1032 # Default pool definition
1036 Recycle = yes # Automatically recycle Volumes
1037 AutoPrune = yes # Prune expired volumes
1038 Volume Retention = 365d # one year
1046 Recycle = yes # Automatically recycle Volumes
1047 AutoPrune = yes # Prune expired volumes
1048 Volume Retention = 365d # one year
1049 Storage = DiskChanger
1052 # Definition of file storage device
1057 Device = FileStorage
1059 Maximum Concurrent Jobs = 5
1062 # Definition of DDS Virtual tape disk storage device
1065 Address = localhost # N.B. Use a fully qualified name here
1067 Device = DiskChanger
1068 Media Type = DiskChangerMedia
1069 Maximum Concurrent Jobs = 4
1074 Then in bconsole or via a Run schedule, you would run the job as:
1077 run job=MyBackup level=Full
1078 run job=MyBackup level=Incremental
1079 run job=MyBackup level=Differential
1080 run job=MyBackup level=Incremental
1081 run job=MyBackup level=Incremental
1084 So providing there were changes between each of those jobs, you would end up
1085 with a Full backup, a Differential, which includes the first Incremental
1086 backup, then two Incremental backups. All the above jobs would be written to
1087 the {\bf Default} pool.
1089 To consolidate those backups into a new Full backup, you would run the
1093 run job=MyBackup level=VirtualFull
1096 And it would produce a new Full backup without using the client, and the output
1097 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1099 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1102 Note, the Start and End time of the Virtual Full backup is set to the
1103 values for the last job included in the Virtual Full (in the above example,
1104 it is an Increment). This is so that if another incremental is done, which
1105 will be based on the Virtual Full, it will backup all files from the
1106 last Job included in the Virtual Full rather than from the time the Virtual
1107 Full was actually run.
1111 \section{Catalog Format}
1112 \index[general]{Catalog Format}
1113 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1114 operation will convert the FileId field of the File table from 32 bits (max 4
1115 billion table entries) to 64 bits (very large number of items). The
1116 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1117 your catalog during the conversion. Also you won't be able to run jobs during
1118 this conversion period. For example, a 3 million file catalog will take 2
1119 minutes to upgrade on a normal machine. Please don't forget to make a valid
1120 backup of your database before executing the upgrade script. See the
1121 ReleaseNotes for additional details.
1123 \section{64 bit Windows Client}
1124 \index[general]{Win64 Client}
1125 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1126 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1127 As a consequence, we are also releasing a 64 bit version of the Bacula
1128 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1129 These binaries should only be installed on 64 bit Windows operating systems.
1130 What is important is not your hardware but whether or not you have
1131 a 64 bit version of the Windows OS.
1133 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1135 \item Before installing the Win64 Bacula Client, you must totally
1136 deinstall any prior 2.4.x Client installation using the
1137 Bacula deinstallation (see the menu item). You may want
1138 to save your .conf files first.
1139 \item Only the Client (File daemon) is ported to Win64, the Director
1140 and the Storage daemon are not in the 64 bit Windows installer.
1141 \item bwx-console is not yet ported.
1142 \item bconsole is ported but it has not been tested.
1143 \item The documentation is not included in the installer.
1144 \item Due to Vista security restrictions imposed on a default installation
1145 of Vista, before upgrading the Client, you must manually stop
1146 any prior version of Bacula from running, otherwise the install
1148 \item Due to Vista security restrictions imposed on a default installation
1149 of Vista, attempting to edit the conf files via the menu items
1150 will fail. You must directly edit the files with appropriate
1151 permissions. Generally double clicking on the appropriate .conf
1152 file will work providing you have sufficient permissions.
1153 \item All Bacula files are now installed in
1154 {\bf C:/Program Files/Bacula} except the main menu items,
1155 which are installed as before. This vastly simplifies the installation.
1156 \item If you are running on a foreign language version of Windows, most
1157 likely {\bf C:/Program Files} does not exist, so you should use the
1158 Custom installation and enter an appropriate location to install
1160 \item The 3.0.0 Win32 Client continues to install files in the locations used
1161 by prior versions. For the next version we will convert it to use
1162 the same installation conventions as the Win64 version.
1165 This project was funded by Bacula Systems.
1168 \section{Duplicate Job Control}
1169 \index[general]{Duplicate Jobs}
1170 The new version of Bacula provides four new directives that
1171 give additional control over what Bacula does if duplicate jobs
1172 are started. A duplicate job in the sense we use it here means
1173 a second or subsequent job with the same name starts. This
1174 happens most frequently when the first job runs longer than expected because no
1175 tapes are available.
1177 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1178 are specified in the Job resource.
1182 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1183 \index[general]{Allow Duplicate Jobs}
1184 If this directive is enabled duplicate jobs will be run. If
1185 the directive is set to {\bf no} (default) then only one job of a given name
1186 may run at one time, and the action that Bacula takes to ensure only
1187 one job runs is determined by the other directives (see below).
1189 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1190 are present and none of the three directives given below permit
1191 cancelling a job, then the current job (the second one started)
1195 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1196 \index[general]{Allow Higher Duplicates}
1197 If this directive is set to {\bf yes} (default) the job with a higher
1198 priority (lower priority number) will be permitted to run, and
1199 the current job will be cancelled. If the
1200 priorities of the two jobs are the same, the outcome is determined by
1201 other directives (see below).
1203 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1204 \index[general]{Cancel Queued Duplicates}
1205 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1206 if this directive is set to {\bf yes} any job that is
1207 already queued to run but not yet running will be canceled.
1208 The default is {\bf no}.
1210 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1211 \index[general]{Cancel Running Duplicates}
1212 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1213 if this directive is set to {\bf yes} any job that is already running
1214 will be canceled. The default is {\bf no}.
1217 \section{TLS Authentication}
1218 \index[general]{TLS Authentication}
1219 In Bacula version 2.5.x and later, in addition to the normal Bacula
1220 CRAM-MD5 authentication that is used to authenticate each Bacula
1221 connection, you can specify that you want TLS Authentication as well,
1222 which will provide more secure authentication.
1224 This new feature uses Bacula's existing TLS code (normally used for
1225 communications encryption) to do authentication. To use it, you must
1226 specify all the TLS directives normally used to enable communications
1227 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1230 \subsection{TLS Authenticate = yes}
1232 TLS Authenticate = yes
1235 in the main daemon configuration resource (Director for the Director,
1236 Client for the File daemon, and Storage for the Storage daemon).
1238 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1239 authentication, Bacula will also do TLS authentication, then TLS
1240 encryption will be turned off, and the rest of the communication between
1241 the two Bacula daemons will be done without encryption.
1243 If you want to encrypt communications data, use the normal TLS directives
1244 but do not turn on {\bf TLS Authenticate}.
1246 \section{bextract non-portable Win32 data}
1247 \index[general]{bextract handles Win32 non-portable data}
1248 {\bf bextract} has been enhanced to be able to restore
1249 non-portable Win32 data to any OS. Previous versions were
1250 unable to restore non-portable Win32 data to machines that
1251 did not have the Win32 BackupRead and BackupWrite API calls.
1253 \section{State File updated at Job Termination}
1254 \index[general]{State File}
1255 In previous versions of Bacula, the state file, which provides a
1256 summary of previous jobs run in the {\bf status} command output was
1257 updated only when Bacula terminated, thus if the daemon crashed, the
1258 state file might not contain all the run data. This version of
1259 the Bacula daemons updates the state file on each job termination.
1261 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1262 \index[general]{MaxFullInterval}
1263 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1264 can be used to specify the maximum time interval between {\bf Full} backup
1265 jobs. When a job starts, if the time since the last Full backup is
1266 greater than the specified interval, and the job would normally be an
1267 {\bf Incremental} or {\bf Differential}, it will be automatically
1268 upgraded to a {\bf Full} backup.
1270 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1271 \index[general]{MaxDiffInterval}
1272 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1273 can be used to specify the maximum time interval between {\bf Differential} backup
1274 jobs. When a job starts, if the time since the last Differential backup is
1275 greater than the specified interval, and the job would normally be an
1276 {\bf Incremental}, it will be automatically
1277 upgraded to a {\bf Differential} backup.
1279 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1280 \index[general]{MaxDiffInterval}
1281 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1282 by the user, and when it is set it is an indication to backup programs
1283 to not backup that particular file. This version of Bacula contains a
1284 new Options directive within a FileSet resource, which instructs Bacula to
1285 obey this flag. The new directive is:
1288 Honor No Dump Flag = yes\vb{}no
1291 The default value is {\bf no}.
1294 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1295 \index[general]{IgnoreDir}
1296 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1297 can be added to the Include section of the FileSet resource. If the specified
1298 filename ({\bf filename-string}) is found on the Client in any directory to be
1299 backed up, the whole directory will be ignored (not backed up). For example:
1302 # List of files to be backed up
1310 Exclude Dir Containing = .excludeme
1315 But in /home, there may be hundreds of directories of users and some
1316 people want to indicate that they don't want to have certain
1317 directories backed up. For example, with the above FileSet, if
1318 the user or sysadmin creates a file named {\bf .excludeme} in
1319 specific directories, such as
1322 /home/user/www/cache/.excludeme
1323 /home/user/temp/.excludeme
1326 then Bacula will not backup the two directories named:
1329 /home/user/www/cache
1333 NOTE: subdirectories will not be backed up. That is, the directive
1334 applies to the two directories in question and any children (be they
1335 files, directories, etc).
1338 \section{Bacula Plugins}
1339 \index[general]{Plugin}
1340 Support for shared object plugins has been implemented in the Linux, Unix
1341 and Win32 File daemons. The API will be documented separately in
1342 the Developer's Guide or in a new document. For the moment, there is
1343 a single plugin named {\bf bpipe} that allows an external program to
1344 get control to backup and restore a file.
1346 Plugins are also planned (partially implemented) in the Director and the
1349 \subsection{Plugin Directory}
1350 \index[general]{Plugin Directory}
1351 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1352 be added to the daemon definition resource. The directory takes a quoted
1353 string argument, which is the name of the directory in which the daemon can
1354 find the Bacula plugins. If this directive is not specified, Bacula will not
1355 load any plugins. Since each plugin has a distinctive name, all the daemons
1356 can share the same plugin directory.
1358 \subsection{Plugin Options}
1359 \index[general]{Plugin Options}
1360 The {\bf Plugin Options} directive takes a quoted string
1361 arguement (after the equal sign) and may be specified in the
1362 Job resource. The options specified will be passed to all plugins
1363 when they are run. This each plugin must know what it is looking
1364 for. The value defined in the Job resource can be modified
1365 by the user when he runs a Job via the {\bf bconsole} command line
1368 Note: this directive may be specified, and there is code to modify
1369 the string in the run command, but the plugin options are not yet passed to
1370 the plugin (i.e. not fully implemented).
1372 \subsection{Plugin Options ACL}
1373 \index[general]{Plugin Options ACL}
1374 The {\bf Plugin Options ACL} directive may be specified in the
1375 Director's Console resource. It functions as all the other ACL commands
1376 do by permitting users running restricted consoles to specify a
1377 {\bf Plugin Options} that overrides the one specified in the Job
1378 definition. Without this directive restricted consoles may not modify
1381 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1382 \index[general]{Plugin}
1383 The {\bf Plugin} directive is specified in the Include section of
1384 a FileSet resource where you put your {\bf File = xxx} directives.
1395 Plugin = "bpipe:..."
1400 In the above example, when the File daemon is processing the directives
1401 in the Include section, it will first backup all the files in {\bf /home}
1402 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1403 the Plugin Directory. The syntax and semantics of the Plugin directive
1404 require the first part of the string up to the colon (:) to be the name
1405 of the plugin. Everything after the first colon is ignored by the File daemon but
1406 is passed to the plugin. Thus the plugin writer may define the meaning of the
1407 rest of the string as he wishes.
1409 Please see the next section for information about the {\bf bpipe} Bacula
1412 \section{The bpipe Plugin}
1413 \index[general]{The bpipe Plugin}
1414 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1415 the Bacula source distribution. When the plugin is compiled and linking into
1416 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1418 The purpose of the plugin is to provide an interface to any system program for
1419 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1420 the Include section of your Job's FileSet resource. The full syntax of the
1421 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1422 to specify the sytax as it wishes) is:
1425 Plugin = "<field1>:<field2>:<field3>:<field4>"
1430 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1431 stripped off, so in this case, we would put {\bf bpipe} in this field.
1433 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1434 pseudo path and filename under which the backup will be saved. This pseudo
1435 path and filename will be seen by the user in the restore file tree.
1436 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1437 backed up by the plugin will be put under that "pseudo" path and filename.
1438 You must be careful to choose a naming convention that is unique to avoid
1439 a conflict with a path and filename that actually exists on your system.
1441 \item {\bf field3} for the {\bf bpipe} plugin
1442 specifies the "reader" program that is called by the plugin during
1443 backup to read the data. {\bf bpipe} will call this program by doing a
1446 \item {\bf field4} for the {\bf bpipe} plugin
1447 specifies the "writer" program that is called by the plugin during
1448 restore to write the data back to the filesystem.
1451 Putting it all together, the full plugin directive line might look
1455 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1456 --opt --databases bacula:mysql"
1459 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1460 would be written on a single line.
1462 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1463 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1464 program {\bf mysqldump -f --opt --database bacula} to read the data during
1465 backup. The mysqldump command outputs all the data for the database named
1466 {\bf bacula}, which will be read by the plugin and stored in the backup.
1467 During restore, the data that was backed up will be sent to the program
1468 specified in the last field, which in this case is {\bf mysql}. When
1469 {\bf mysql} is called, it will read the data sent to it by the plugn
1470 then write it back to the same database from which it came ({\bf bacula}
1473 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1474 the data from a specified program to Bacula for backup, and then from Bacula to
1475 a specified program for restore.
1477 By using different command lines to {\bf bpipe},
1478 you can backup any kind of data (ASCII or binary) depending
1479 on the program called.
1481 \section{Microsoft Exchange Server 2003/2007 Plugin}
1482 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1483 \subsection{Background}
1484 The Exchange plugin was made possible by a funded development project
1485 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1486 The code for the plugin was written by James Harper, and the Bacula core
1487 code by Kern Sibbald. All the code for this funded development has become
1488 part of the Bacula project. Thanks to everyone who made it happen.
1490 \subsection{Concepts}
1491 Although it is possible to backup Exchange using Bacula VSS the Exchange
1492 plugin adds a good deal of functionality, because while Bacula VSS
1493 completes a full backup (snapshot) of Exchange, it does
1494 not support Incremental or Differential backups, restoring is more
1495 complicated, and a single database restore is not possible.
1497 Microsoft Exchange organises its storage into Storage Groups with
1498 Databases inside them. A default installation of Exchange will have a
1499 single Storage Group called 'First Storage Group', with two Databases
1500 inside it, "Mailbox Store (SERVER NAME)" and
1501 "Public Folder Store (SERVER NAME)",
1502 which hold user email and public folders respectively.
1504 In the default configuration, Exchange logs everything that happens to
1505 log files, such that if you have a backup, and all the log files since,
1506 you can restore to the present time. Each Storage Group has its own set
1507 of log files and operates independently of any other Storage Groups. At
1508 the Storage Group level, the logging can be turned off by enabling a
1509 function called "Enable circular logging". At this time the Exchange
1510 plugin will not function if this option is enabled.
1512 The plugin allows backing up of entire storage groups, and the restoring
1513 of entire storage groups or individual databases. Backing up and
1514 restoring at the individual mailbox or email item is not supported but
1515 can be simulated by use of the "Recovery" Storage Group (see below).
1517 \subsection{Installing}
1518 The Exchange plugin requires a DLL that is shipped with Microsoft
1519 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1520 correctly the Exchange plugin should find this automatically and run
1521 without any additional installation.
1523 If the DLL can not be found automatically it will need to be copied into
1524 the Bacula installation
1525 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1526 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1527 default Exchange installation.
1529 \subsection{Backing Up}
1530 To back up an Exchange server the Fileset definition must contain at
1531 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1532 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1533 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1534 up files are prefixed with something that isn't going to share a name
1535 with something outside the plugin, and the 'Microsoft Information Store'
1536 bit is required also. It is also possible to add the name of a storage
1537 group to the "Plugin =" line, eg \\
1538 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1539 if you want only a single storage group backed up.
1541 Additionally, you can suffix the 'Plugin =' directive with
1542 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1543 database at the end of a full backup.
1545 An Incremental or Differential backup will backup only the database logs
1546 for each Storage Group by inspecting the "modified date" on each
1547 physical log file. Because of the way the Exchange API works, the last
1548 logfile backed up on each backup will always be backed up by the next
1549 Incremental or Differential backup too. This adds 5MB to each
1550 Incremental or Differential backup size but otherwise does not cause any
1553 By default, a normal VSS fileset containing all the drive letters will
1554 also back up the Exchange databases using VSS. This will interfere with
1555 the plugin and Exchange's shared ideas of when the last full backup was
1556 done, and may also truncate log files incorrectly. It is important,
1557 therefore, that the Exchange database files be excluded from the backup,
1558 although the folders the files are in should be included, or they will
1559 have to be recreated manually if a baremetal restore is done.
1564 File = C:/Program Files/Exchsrvr/mdbdata
1565 Plugin = "exchange:..."
1568 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1569 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1570 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1571 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1572 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1573 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1574 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1579 The advantage of excluding the above files is that you can significantly
1580 reduce the size of your backup since all the important Exchange files
1581 will be properly saved by the Plugin.
1584 \subsection{Restoring}
1585 The restore operation is much the same as a normal Bacula restore, with
1586 the following provisos:
1589 \item The {\bf Where} restore option must not be specified
1590 \item Each Database directory must be marked as a whole. You cannot just
1591 select (say) the .edb file and not the others.
1592 \item If a Storage Group is restored, the directory of the Storage Group
1594 \item It is possible to restore only a subset of the available log files,
1595 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1596 if a log file is missing from the sequence of log files
1597 \item Each database to be restored must be dismounted and marked as "Can be
1598 overwritten by restore"
1599 \item If an entire Storage Group is to be restored (eg all databases and
1600 logs in the Storage Group), then it is best to manually delete the
1601 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1602 as Exchange can get confused by stray log files lying around.
1605 \subsection{Restoring to the Recovery Storage Group}
1606 The concept of the Recovery Storage Group is well documented by
1608 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1609 but to briefly summarize...
1611 Microsoft Exchange allows the creation of an additional Storage Group
1612 called the Recovery Storage Group, which is used to restore an older
1613 copy of a database (e.g. before a mailbox was deleted) into without
1614 messing with the current live data. This is required as the Standard and
1615 Small Business Server versions of Exchange can not ordinarily have more
1616 than one Storage Group.
1618 To create the Recovery Storage Group, drill down to the Server in Exchange
1619 System Manager, right click, and select
1620 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1621 locations and click OK. On the Recovery Storage Group, right click and
1622 select {\bf "Add Database to Recover..."} and select the database you will
1625 Restore only the single database nominated as the database in the
1626 Recovery Storage Group. Exchange will redirect the restore to the
1627 Recovery Storage Group automatically.
1628 Then run the restore.
1630 \subsection{Restoring on Microsoft Server 2007}
1631 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1632 2007, and henc you use a new proceedure for recovering a single mail box.
1633 This procedure is ducomented by Microsoft at:
1634 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1635 and involves using the {\bf Restore-Mailbox} and {\bf
1636 Get-MailboxStatistics} shell commands.
1638 \subsection{Caveats}
1639 This plugin is still being developed, so you should consider it
1640 currently in BETA test, and thus use in a production environment
1641 should be done only after very careful testing.
1643 When doing a full backup, the Exchange database logs are truncated by
1644 Exchange as soon as the plugin has completed the backup. If the data
1645 never makes it to the backup medium (eg because of spooling) then the
1646 logs will still be truncated, but they will also not have been backed
1647 up. A solution to this is being worked on. You will have to schedule a
1648 new Full backup to ensure that your next backups will be usable.
1650 The "Enable Circular Logging" option cannot be enabled or the plugin
1653 Exchange insists that a successful Full backup must have taken place if
1654 an Incremental or Differential backup is desired, and the plugin will
1655 fail if this is not the case. If a restore is done, Exchange will
1656 require that a Full backup be done before an Incremental or Differential
1659 The plugin will most likely not work well if another backup application
1660 (eg NTBACKUP) is backing up the Exchange database, especially if the
1661 other backup application is truncating the log files.
1663 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1664 we recommend either carefully testing or that you avoid this option for
1667 The Exchange plugin is not called during processing the bconsole {\bf
1668 estimate} command, and so anything that would be backed up by the plugin
1669 will not be added to the estimate total that is displayed.
1672 \section{libdbi Framework}
1673 \index[general]{libdbi Framework}
1674 As a general guideline, Bacula has support for a few catalog database drivers
1675 (MySQL, PostgreSQL, SQLite)
1676 coded natively by the Bacula team. With the libdbi implementation, which is a
1677 Bacula driver that uses libdbi to access the catalog, we have an open field to
1678 use many different kinds database engines following the needs of users.
1680 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1681 implements a database-independent abstraction layer in C, similar to the
1682 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1683 leverage the power of multiple databases and multiple simultaneous database
1684 connections by using this framework.
1686 Currently the libdbi driver in Bacula project only supports the same drivers
1687 natively coded in Bacula. However the libdbi project has support for many
1688 others database engines. You can view the list at
1689 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1690 supported by Bacula, however, they must be tested properly by the Bacula team.
1692 Some of benefits of using libdbi are:
1694 \item The possibility to use proprietary databases engines in which your
1695 proprietary licenses prevent the Bacula team from developing the driver.
1696 \item The possibility to use the drivers written for the libdbi project.
1697 \item The possibility to use other database engines without recompiling Bacula
1698 to use them. Just change one line in bacula-dir.conf
1699 \item Abstract Database access, this is, unique point to code and profiling
1700 catalog database access.
1703 The following drivers have been tested:
1705 \item PostgreSQL, with and without batch insert
1706 \item Mysql, with and without batch insert
1711 In the future, we will test and approve to use others databases engines
1712 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1714 To compile Bacula to support libdbi we need to configure the code with the
1715 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1716 [database] is the database engine to be used with Bacula (of course we can
1717 change the driver in file bacula-dir.conf, see below). We must configure the
1718 access port of the database engine with the option --with-db-port, because the
1719 libdbi framework doesn't know the default access port of each database.
1721 The next phase is checking (or configuring) the bacula-dir.conf, example:
1725 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1726 dbname = regress; user = regress; password = ""
1730 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1731 mysql database. Currently the drivers supported by Bacula are: postgresql,
1732 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1734 The following limitations apply when Bacula is set to use the libdbi framework:
1735 - Not tested on the Win32 platform
1736 - A little performance is lost if comparing with native database driver.
1737 The reason is bound with the database driver provided by libdbi and the
1738 simple fact that one more layer of code was added.
1740 It is important to remember, when compiling Bacula with libdbi, the
1741 following packages are needed:
1743 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1744 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1747 You can download them and compile them on your system or install the packages
1748 from your OS distribution.
1750 \section{Console Command Additions and Enhancements}
1751 \index[general]{Console Additions}
1753 \subsection{Display Autochanger Content}
1754 \index[general]{StatusSlots}
1756 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1757 autochanger content.
1761 Slot | Volume Name | Status | Media Type | Pool |
1762 ------+---------------+----------+-------------------+------------|
1763 1 | 00001 | Append | DiskChangerMedia | Default |
1764 2 | 00002 | Append | DiskChangerMedia | Default |
1765 3*| 00003 | Append | DiskChangerMedia | Scratch |
1770 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1771 {\bf update slots} command to synchronize autochanger content with your
1774 \subsection{list joblog job=xxx or jobid=nnn}
1775 \index[general]{list joblog}
1776 A new list command has been added that allows you to list the contents
1777 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1778 or for a particular JobId. The {\bf llist} command will include a line with
1779 the time and date of the entry.
1781 Note for the catalog to have Job Log entries, you must have a directive
1788 In your Director's {\bf Messages} resource.
1790 \subsection{Use separator for multiple commands}
1791 \index[general]{Command Separator}
1792 When using bconsole with readline, you can set the command separator with
1793 \textbf{@separator} command to one
1794 of those characters to write commands who require multiple input in one line.
1796 !$%&'()*+,-/:;<>?[]^`{|}~
1799 \subsection{Deleting Volumes}
1800 The delete volume bconsole command has been modified to
1801 require an asterisk (*) in front of a MediaId otherwise the
1802 value you enter is a taken to be a Volume name. This is so that
1803 users may delete numeric Volume names. The previous Bacula versions
1804 assumed that all input that started with a number was a MediaId.
1806 This new behavior is indicated in the prompt if you read it
1809 \section{Bare Metal Recovery}
1810 The old bare metal recovery project is essentially dead. One
1811 of the main features of it was that it would build a recovery
1812 CD based on the kernel on your system. The problem was that
1813 every distribution has a different boot procedure and different
1814 scripts, and worse yet, the boot procedures and scripts change
1815 from one distribution to another. This meant that maintaining
1816 (keeping up with the changes) the rescue CD was too much work.
1818 To replace it, a new bare metal recovery USB boot stick has been developed
1819 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1820 boot from a USB key.
1824 \item Recovery can be done from within graphical environment.
1825 \item Recovery can be done in a shell.
1826 \item Ubuntu boots on a large number of Linux systems.
1827 \item The process of updating the system and adding new
1828 packages is not too difficult.
1829 \item The USB key can easily be upgraded to newer Ubuntu versions.
1830 \item The USB key has writable partitions for modifications to
1831 the OS and for modification to your home directory.
1832 \item You can add new files/directories to the USB key very easily.
1833 \item You can save the environment from multiple machines on
1835 \item Bacula Systems is funding its ongoing development.
1838 The disadvantages are:
1840 \item The USB key is usable but currently under development.
1841 \item Not everyone may be familiar with Ubuntu (no worse
1843 \item Some older OSes cannot be booted from USB. This can
1844 be resolved by first booting a Ubuntu LiveCD then plugging
1846 \item Currently the documentation is sketchy and not yet added
1847 to the main manual. See below ...
1850 The documentation and the code can be found in the {\bf rescue} package
1851 in the directory {\bf linux/usb}.
1853 \section{Miscellaneous}
1854 \index[general]{Misc New Features}
1856 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
1857 \index[general]{Allow Mixed Priority}
1858 This directive is only implemented in version 2.5 and later. When
1859 set to {\bf yes} (default {\bf no}), this job may run even if lower
1860 priority jobs are already running. This means a high priority job
1861 will not have to wait for other jobs to finish before starting.
1862 The scheduler will only mix priorities when all running jobs have
1865 Note that only higher priority jobs will start early. Suppose the
1866 director will allow two concurrent jobs, and that two jobs with
1867 priority 10 are running, with two more in the queue. If a job with
1868 priority 5 is added to the queue, it will be run as soon as one of
1869 the running jobs finishes. However, new priority 10 jobs will not
1870 be run until the priority 5 job has finished.
1872 \subsection{Bootstrap File Directive -- FileRegex}
1873 \index[general]{Bootstrap File Directive}
1874 {\bf FileRegex} is a new command that can be added to the bootstrap
1875 (.bsr) file. The value is a regular expression. When specified, only
1876 matching filenames will be restored.
1878 During a restore, if all File records are pruned from the catalog
1879 for a Job, normally Bacula can restore only all files saved. That
1880 is there is no way using the catalog to select individual files.
1881 With this new feature, Bacula will ask if you want to specify a Regex
1882 expression for extracting only a part of the full backup.
1885 Building directory tree for JobId(s) 1,3 ...
1886 There were no files inserted into the tree, so file selection
1887 is not possible.Most likely your retention policy pruned the files
1889 Do you want to restore all the files? (yes\vb{}no): no
1891 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1892 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1895 \subsection{Bootstrap File Optimization Changes}
1896 In order to permit proper seeking on disk files, we have extended the bootstrap
1897 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1898 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1899 address range and end address range respectively. These two directives replace
1900 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1901 VolEndBlock} directives. Bootstrap files containing the old directives will
1902 still work, but will not properly take advantage of proper disk seeking, and
1903 may read completely to the end of a disk volume during a restore. With the new
1904 format (automatically generated by the new Director), restores will seek
1905 properly and stop reading the volume when all the files have been restored.
1907 \subsection{Solaris ZFS/NFSv4 ACLs}
1908 This is an upgrade of the previous Solaris ACL backup code
1909 to the new library format, which will backup both the old
1910 POSIX(UFS) ACLs as well as the ZFS ACLs.
1912 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1913 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1914 be used to transfer from UFS to ZFS filesystems.
1917 \subsection{Virtual Tape Emulation}
1918 \index[general]{Virtual Tape Emulation}
1919 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1920 the tape code but actually reading and writing to a disk file. Used with the
1921 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1922 and 700 slots. This feature is most useful in testing. It is enabled
1923 by using {\bf Device Type = vtape} in the Storage daemon's Device
1924 directive. This feature is only implemented on Linux machines and should not be
1925 used for production.
1927 \subsection{Bat Enhancements}
1928 \index[general]{Bat Enhancements}
1929 Bat (the Bacula Administration Tool) GUI program has been significantly
1930 enhanced and stabilized. In particular, there are new table based status
1931 commands; it can now be easily localized using Qt4 Linguist.
1933 The Bat communications protocol has been significantly enhanced to improve
1934 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1935 the Director you are using otherwise the communications protocol will not
1938 \subsection{RunScript Enhancements}
1939 \index[general]{RunScript Enhancements}
1940 The {\bf RunScript} resource has been enhanced to permit multiple
1941 commands per RunScript. Simply specify multiple {\bf Command} directives
1948 Command = "/bin/echo test"
1949 Command = "/bin/echo an other test"
1950 Command = "/bin/echo 3 commands in the same runscript"
1957 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1958 implemented, which runs the command after the Volume Shadow Copy has been made.
1960 Console commands can be specified within a RunScript by using:
1961 {\bf Console = \lt{}command\gt{}}, however, this command has not been
1962 carefully tested and debugged and is known to easily crash the Director.
1963 We would appreciate feedback. Due to the recursive nature of this command, we
1964 may remove it before the final release.
1966 \subsection{Status Enhancements}
1967 \index[general]{Status Enhancements}
1968 The bconsole {\bf status dir} output has been enhanced to indicate
1969 Storage daemon job spooling and despooling activity.
1971 \subsection{Connect Timeout}
1972 \index[general]{Connect Timeout}
1973 The default connect timeout to the File
1974 daemon has been set to 3 minutes. Previously it was 30 minutes.
1976 \subsection{ftruncate for NFS Volumes}
1977 \index[general]{ftruncate for NFS Volumes}
1978 If you write to a Volume mounted by NFS (say on a local file server),
1979 in previous Bacula versions, when the Volume was recycled, it was not
1980 properly truncated because NFS does not implement ftruncate (file
1981 truncate). This is now corrected in the new version because we have
1982 written code (actually a kind user) that deletes and recreates the Volume,
1983 thus accomplishing the same thing as a truncate.
1985 \subsection{Support for Ubuntu}
1986 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1987 version of Linux, and thus now provides correct autostart routines.
1988 Since Ubuntu officially supports Bacula, you can also obtain any
1989 recent release of Bacula from the Ubuntu repositories.
1991 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1992 \index[general]{Recycle Pool}
1993 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1994 be placed (moved) when it is recycled. Without this directive, a Volume will
1995 remain in the same pool when it is recycled. With this directive, it can be
1996 moved automatically to any existing pool during a recycle. This directive is
1997 probably most useful when defined in the Scratch pool, so that volumes will
1998 be recycled back into the Scratch pool.
2000 \subsection{FD Version}
2001 \index[general]{FD Version}
2002 The File daemon to Director protocol now includes a version
2003 number, which although there is no visible change for users,
2004 will help us in future versions automatically determine
2005 if a File daemon is not compatible.
2007 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2008 \index[general]{Max Run Sched Time}
2009 The time specifies the maximum allowed time that a job may run, counted from
2010 when the job was scheduled. This can be useful to prevent jobs from running
2011 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2014 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2015 \index[general]{Max Wait Time}
2016 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2017 of checking the maximum allowed time that a job may block for a resource,
2018 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2019 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2020 their job depending on the level. Now, they have to use
2021 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2022 directives are now deprecated.
2024 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2025 \index[general]{Incremental Max Wait Time}
2026 \index[general]{Differential Max Wait Time}
2028 These directives have been deprecated in favor of
2029 \texttt{Incremental|Differential Max Run Time}.
2031 \subsection{Max Run Time directives}
2032 \index[general]{Max Run Time directives}
2033 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2034 maximum allowed time that a job can run depending on the level.
2036 \addcontentsline{lof}{figure}{Job time control directives}
2037 \includegraphics{\idir different_time.eps}
2039 \subsection{Statistics Enhancements}
2040 \index[general]{Statistics Enhancements}
2041 If you (or probably your boss) want to have statistics on your backups to
2042 provide some \textit{Service Level Agreement} indicators, you could use a few
2043 SQL queries on the Job table to report how many:
2047 \item jobs have been successful
2048 \item files have been backed up
2052 However, these statistics are accurate only if your job retention is greater
2053 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2054 be able to use them.
2056 Now, you can use the \textbf{update stats [days=num]} console command to fill
2057 the JobHistory table with new Job records. If you want to be sure to take in
2058 account only \textbf{good jobs}, ie if one of your important job has failed but
2059 you have fixed the problem and restarted it on time, you probably want to
2060 delete the first \textit{bad} job record and keep only the successful one. For
2061 that simply let your staff do the job, and update JobHistory table after two or
2062 three days depending on your organization using the \textbf{[days=num]} option.
2064 These statistics records aren't used for restoring, but mainly for
2065 capacity planning, billings, etc.
2067 The Bweb interface provides a statistics module that can use this feature. You
2068 can also use tools like Talend or extract information by yourself.
2070 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2071 the length of time that Bacula will keep statistics job records in the Catalog
2072 database after the Job End time. (In \texttt{JobHistory} table) When this time
2073 period expires, and if user runs \texttt{prune stats} command, Bacula will
2074 prune (remove) Job records that are older than the specified period.
2076 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2077 job to maintain statistics.
2080 Name = BackupCatalog
2083 Console = "update stats days=3"
2084 Console = "prune stats yes"
2091 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2092 \index[general]{ScratchPool}
2093 This directive permits to specify a specific \textsl{Scratch} pool for the
2094 current pool. This is useful when using multiple storage sharing the same
2095 mediatype or when you want to dedicate volumes to a particular set of pool.
2097 \subsection{Enhanced Attribute Despooling}
2098 \index[general]{Attribute Despooling}
2099 If the storage daemon and the Director are on the same machine, the spool file
2100 that contains attributes is read directly by the Director instead of being
2101 transmitted across the network. That should reduce load and speedup insertion.
2103 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2104 \index[general]{SpoolSize}
2105 A new Job directive permits to specify the spool size per job. This is used
2106 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2108 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
2109 \index[general]{MaxConsoleConnections}
2110 A new director directive permits to specify the maximum number of Console
2111 Connections that could run concurrently. The default is set to 20, but you may
2112 set it to a larger number.
2114 \subsection{VerId = \lt{}string\gt{}}
2115 \index[general]{VerId}
2116 A new director directive permits to specify a personnal identifier that will be
2117 displayed in the \texttt{version} command.
2119 \subsection{dbcheck enhancements}
2120 \index[general]{dbcheck enhancements}
2121 If you are using Mysql, dbcheck will now ask you if you want to create
2122 temporary indexes to speed up orphaned Path and Filename elimination.
2124 A new \texttt{-B} option allows you to print catalog information in a simple
2125 text based format. This is useful to backup it in a secure way.
2140 You can now specify the database connection port in the command line.
2142 \subsection{{-}{-}docdir configure option}
2143 \index[general]{{-}{-}docdir configure option}
2144 You can use {-}{-}docdir= on the ./configure command to
2145 specify the directory where you want Bacula to install the
2146 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2147 {\bf /usr/share/doc/bacula}.
2149 \subsection{{-}{-}htmldir configure option}
2150 \index[general]{{-}{-}htmldir configure option}
2151 You can use {-}{-}htmldir= on the ./configure command to
2152 specify the directory where you want Bacula to install the bat html help
2153 files. The default is {\bf /usr/share/doc/bacula/html}
2155 \subsection{{-}{-}with-plugindir configure option}
2156 \index[general]{{-}{-}plugindir configure option}
2157 You can use {-}{-}plugindir= on the ./configure command to
2158 specify the directory where you want Bacula to install
2159 the plugins (currently only bpipe-fd). The default is