1 \chapter{New Features in 5.0.1}
3 This chapter presents the new features that are in the released Bacula version
4 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
5 the onging development process.
7 \section{Truncate volume after purge}
8 \label{sec:actiononpurge}
10 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
11 the volume when it is purged with the new command \texttt{purge volume
12 action}.It is useful to prevent disk based volumes from consuming too much
18 Action On Purge = Truncate
23 As usual You can also set this property with the \texttt{update volume} command
25 *update volume=xxx actiononpurge=Truncate
26 *update volume=xxx actiononpurge=None
29 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
30 following command in interactive mode or in a RunScript as shown after:
32 *purge volume action=truncate storage=File allpools
33 # or by default, action=all
34 *purge volume action storage=File pool=Default
37 This is possible to specify the volume name, the media type, the pool, the
38 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
39 idle when you decide to run this command.
48 Console = "purge volume action=all allpools storage=File"
53 \textbf{Important note}: This feature doesn't work as
54 expected in version 5.0.0. Please do not use it before version 5.0.1.
56 \chapter{New Features in 5.0.0}
58 \section{Maximum Concurent Jobs for Devices}
59 \label{sec:maximumconcurentjobdevice}
61 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
62 Daemon configuration permits setting the maximum number of Jobs that can
63 run concurrently on a specified Device. Using this directive, it is
64 possible to have different Jobs using multiple drives, because when the
65 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
66 Jobs on any other available compatible drive. This facilitates writing to
67 multiple drives with multiple Jobs that all use the same Pool.
69 This project was funded by Bacula Systems.
71 \section{Restore from Multiple Storage Daemons}
72 \index[general]{Restore}
74 Previously, you were able to restore from multiple devices in a single Storage
75 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
76 example, if your full backup runs on a Storage Daemon with an autochanger, and
77 your incremental jobs use another Storage Daemon with lots of disks, Bacula
78 will switch automatically from one Storage Daemon to an other within the same
81 You must upgrade your File Daemon to version 3.1.3 or greater to use this
84 This project was funded by Bacula Systems with the help of Equiinet.
86 \section{File Deduplication using Base Jobs}
87 A base job is sort of like a Full save except that you will want the FileSet to
88 contain only files that are unlikely to change in the future (i.e. a snapshot
89 of most of your system after installing it). After the base job has been run,
90 when you are doing a Full save, you specify one or more Base jobs to be used.
91 All files that have been backed up in the Base job/jobs but not modified will
92 then be excluded from the backup. During a restore, the Base jobs will be
93 automatically pulled in where necessary.
95 This is something none of the competition does, as far as we know (except
96 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
97 win for the user, it makes Bacula stand out as offering a unique optimization
98 that immediately saves time and money. Basically, imagine that you have 100
99 nearly identical Windows or Linux machine containing the OS and user files.
100 Now for the OS part, a Base job will be backed up once, and rather than making
101 100 copies of the OS, there will be only one. If one or more of the systems
102 have some files updated, no problem, they will be automatically restored.
104 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
105 files that will be used during Full backup as base.
116 Base = BackupZog4, BackupLinux
122 In this example, the job \texttt{BackupZog4} will use the most recent version
123 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
124 jobs. Base jobs should have run with \texttt{level=Base} to be used.
126 By default, Bacula will compare permissions bits, user and group fields,
127 modification time, size and the checksum of the file to choose between the
128 current backup and the BaseJob file list. You can change this behavior with the
129 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
130 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
146 \textbf{Important note}: The current implementation doesn't permit to scan
147 volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
149 This project was funded by Bacula Systems.
151 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
152 \index[dir]{AllowCompression}
154 This new directive may be added to Storage resource within the Director's
155 configuration to allow users to selectively disable the client compression for
156 any job which writes to this storage resource.
162 Address = ultrium-tape
163 Password = storage_password # Password for Storage Daemon
166 AllowCompression = No # Tape drive has hardware compression
169 The above example would cause any jobs running with the UltriumTape storage
170 resource to run without compression from the client file daemons. This
171 effectively overrides any compression settings defined at the FileSet level.
173 This feature is probably most useful if you have a tape drive which supports
174 hardware compression. By setting the \texttt{AllowCompression = No} directive
175 for your tape drive storage resource, you can avoid additional load on the file
176 daemon and possibly speed up tape backups.
178 This project was funded by Collaborative Fusion, Inc.
180 \section{Accurate Fileset Options}
181 \label{sec:accuratefileset}
183 In previous versions, the accurate code used the file creation and modification
184 times to determine if a file was modified or not. Now you can specify which
185 attributes to use (time, size, checksum, permission, owner, group, \dots),
186 similar to the Verify options.
202 \item {\bf i} compare the inodes
203 \item {\bf p} compare the permission bits
204 \item {\bf n} compare the number of links
205 \item {\bf u} compare the user id
206 \item {\bf g} compare the group id
207 \item {\bf s} compare the size
208 \item {\bf a} compare the access time
209 \item {\bf m} compare the modification time (st\_mtime)
210 \item {\bf c} compare the change time (st\_ctime)
211 \item {\bf d} report file size decreases
212 \item {\bf 5} compare the MD5 signature
213 \item {\bf 1} compare the SHA1 signature
216 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
217 the File Daemon will have to read all files even if they normally would not
218 be saved. This increases the I/O load, but also the accuracy of the
219 deduplication. By default, Bacula will check modification/creation time
222 This project was funded by Bacula Systems.
224 \section{Tab-completion for Bconsole}
225 \label{sec:tabcompletion}
227 If you build \texttt{bconsole} with readline support, you will be able to use
228 the new auto-completion mode. This mode supports all commands, gives help
229 inside command, and lists resources when required. It works also in the restore
232 To use this feature, you should have readline development package loaded on
233 your system, and use the following option in configure.
235 ./configure --with-readline=/usr/include/readline --disable-conio ...
238 The new bconsole won't be able to tab-complete with older directors.
240 This project was funded by Bacula Systems.
242 \section{Pool File and Job retention}
243 \label{sec:poolfilejobretention}
246 We added two new Pool directives, \texttt{FileRetention} and
247 \texttt{JobRetention}, that take precedence over Client directives of the same
248 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
249 example, you can decide to increase Retention times for Archive or OffSite Pool.
251 \section{Read-only File Daemon using capabilities}
252 \label{sec:fdreadonly}
253 This feature implements support of keeping \textbf{ReadAll} capabilities after
254 UID/GID switch, this allows FD to keep root read but drop write permission.
256 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
257 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
260 root@localhost:~# bacula-fd -k -u nobody -g nobody
263 The code for this feature was contributed by AltLinux.
268 To help developers of restore GUI interfaces, we have added new \textsl{dot
269 commands} that permit browsing the catalog in a very simple way.
272 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
273 the Bvfs cache in the catalog. You need to run it before any access to the
276 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
277 will list all directories in the specified \texttt{path} or
278 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
279 encoding of path/filenames.
281 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
282 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
283 \texttt{pathid} avoids problems with character encoding.
286 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
287 data that will be displayed.
290 * .bvfs_update jobid=1,2
292 * .bvfs_lsdir path=/ jobid=1,2
295 This project was funded by Bacula Systems.
297 \section{Testing your Tape Drive}
298 \label{sec:btapespeed}
300 To determine the best configuration of your tape drive, you can run the new
301 \texttt{speed} command available in the \texttt{btape} program.
303 This command can have the following arguments:
305 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
306 (between 1 and 5GB). This counter is in GB.
307 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
308 of data should be greater than your memory ($file\_size*nb\_file$).
309 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
311 \item[\texttt{skip\_random}] This flag permits to skip tests with random
313 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
314 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
319 *speed file_size=3 skip_raw
320 btape.c:1078 Test with zero data and bacula block structure.
321 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
322 ++++++++++++++++++++++++++++++++++++++++++
323 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
324 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
326 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
328 btape.c:1090 Test with random data, should give the minimum throughput.
329 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
330 +++++++++++++++++++++++++++++++++++++++++++
331 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
332 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
333 +++++++++++++++++++++++++++++++++++++++++++
335 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
339 When using compression, the random test will give your the minimum throughput
340 of your drive . The test using constant string will give you the maximum speed
341 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
343 You can change the block size in the Storage Daemon configuration file.
345 \section{New {\bf Block Checksum} Device Directive}
346 You may now turn off the Block Checksum (CRC32) code
347 that Bacula uses when writing blocks to a Volume. This is
354 doing so can reduce the Storage daemon CPU usage slightly. It
355 will also permit Bacula to read a Volume that has corrupted data.
357 The default is {\bf yes} -- i.e. the checksum is computed on write
360 We do not recommend to turn this off particularly on older tape
361 drives or for disk Volumes where doing so may allow corrupted data
364 \section{New Bat Features}
366 Those new features were funded by Bacula Systems.
368 \subsection{Media List View}
370 By clicking on ``Media'', you can see the list of all your volumes. You will be
371 able to filter by Pool, Media Type, Location,\dots And sort the result directly
372 in the table. The old ``Media'' view is now known as ``Pool''.
375 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
376 \label{fig:mediaview}
380 \subsection{Media Information View}
382 By double-clicking on a volume (on the Media list, in the Autochanger content
383 or in the Job information panel), you can access a detailed overview of your
384 Volume. (cf \ref{fig:mediainfo}.)
387 \includegraphics[width=13cm]{\idir bat11.eps}
388 \caption{Media information}
389 \label{fig:mediainfo}
392 \subsection{Job Information View}
394 By double-clicking on a Job record (on the Job run list or in the Media
395 information panel), you can access a detailed overview of your Job. (cf
399 \includegraphics[width=13cm]{\idir bat12.eps}
400 \caption{Job information}
404 \subsection{Autochanger Content View}
406 By double-clicking on a Storage record (on the Storage list panel), you can
407 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
410 \includegraphics[width=13cm]{\idir bat13.eps}
411 \caption{Autochanger content}
412 \label{fig:achcontent}
415 To use this feature, you need to use the latest mtx-changer script
416 version. (With new \texttt{listall} and \texttt{transfer} commands)
418 \section{Bat on Windows}
419 We have ported {\bf bat} to Windows and it is now installed
420 by default when the installer is run. It works quite well
421 on Win32, but has not had a lot of testing there, so your
422 feedback would be welcome. Unfortunately, eventhough it is
423 installed by default, it does not yet work on 64 bit Windows
426 \section{New Win32 Installer}
427 The Win32 installer has been modified in several very important
430 \item You must deinstall any current version of the
431 Win32 File daemon before upgrading to the new one.
432 If you forget to do so, the new installation will fail.
433 To correct this failure, you must manually shutdown
434 and deinstall the old File daemon.
435 \item All files (other than menu links) are installed
436 in {\bf c:/Program Files/Bacula}.
437 \item The installer no longer sets this
438 file to require administrator privileges by default. If you want
439 to do so, please do it manually using the {\bf cacls} program.
442 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
444 \item The server daemons (Director and Storage daemon) are
445 no longer included in the Windows installer. If you want the
446 Windows servers, you will either need to build them yourself (note
447 they have not been ported to 64 bits), or you can contact
448 Bacula Systems about this.
451 \section{Win64 Installer}
452 We have corrected a number of problems that required manual
453 editing of the conf files. In most cases, it should now
454 install and work. {\bf bat} is by default installed in
455 {\bf c:/Program Files/Bacula/bin32} rather than
456 {\bf c:/Program Files/Bacula} as is the case with the 32
457 bit Windows installer.
459 \section{Bare Metal Recovery USB Key}
460 We have made a number of significant improvements in the
461 Bare Metal Recovery USB key. Please see the README files
462 it the {\bf rescue} release for more details.
466 \section{bconsole Timeout Option}
467 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
468 for commands. This is useful with GUI programs that use {\bf bconsole}
469 to interface to the Director.
471 \section{Important Changes}
472 \label{sec:importantchanges}
475 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
476 to the same Pool. The Storage daemon ensures that you do not read and
477 write to the same Volume.
478 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
480 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
481 and \texttt{transfer}. Be sure to apply any custom changes on to the
482 mtx-changer script, or better yet, use mtx-changer.conf to configure
484 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
485 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
486 password. If you want to use the new script, you will need to
487 manually change the \texttt{BackupCatalog} Job definition.
488 \item The \texttt{bconsole} \texttt{help} command now accepts
489 an argument, which if provided produces information on that
490 command (ex: \texttt{help run}).
494 \subsubsection*{Truncate volume after purge}
496 Note that the Truncate Volume after purge feature doesn't work as expected
497 in 5.0.0 version. Please, don't use it before version 5.0.1.
499 \subsection{Custom Catalog queries}
501 If you wish to add specialized commands that list the contents of the catalog,
502 you can do so by adding them to the \texttt{query.sql} file. This
503 \texttt{query.sql} file is now empty by default. The file
504 \texttt{examples/sample-query.sql} has an a number of sample commands
505 you might find useful.
507 \subsection{Deprecated parts}
509 The following items have been \textbf{deprecated} for a long time, and are now
510 removed from the code.
513 \item Support for SQLite 2
516 \section{Misc Changes}
517 \label{sec:miscchanges}
520 \item Updated Nagios check\_bacula
521 \item Updated man files
522 \item Added OSX package generation script in platforms/darwin
523 \item Added Spanish and Ukrainian Bacula translations
524 \item Enable/disable command shows only Jobs that can change
525 \item Added \texttt{show disabled} command to show disabled Jobs
526 \item Many ACL improvements
527 \item Added Level to FD status Job output
528 \item Begin Ingres DB driver (not yet working)
529 \item Split RedHat spec files into bacula, bat, mtx, and docs
530 \item Reorganized the manuals (fewer separate manuals)
531 \item Added lock/unlock order protection in lock manager
532 \item Allow 64 bit sizes for a number of variables
533 \item Fixed several deadlocks or potential race conditions in the SD
536 \chapter{Released Version 3.0.3 and 3.0.3a}
538 There are no new features in version 3.0.3. This version simply fixes a
539 number of bugs found in version 3.0.2 during the onging development
542 \chapter{New Features in Released Version 3.0.2}
544 This chapter presents the new features added to the
545 Released Bacula Version 3.0.2.
547 \section{Full Restore from a Given JobId}
548 \index[general]{Restore menu}
550 This feature allows selecting a single JobId and having Bacula
551 automatically select all the other jobs that comprise a full backup up to
552 and including the selected date (through JobId).
554 Assume we start with the following jobs:
556 +-------+--------------+---------------------+-------+----------+------------+
557 | jobid | client | starttime | level | jobfiles | jobbytes |
558 +-------+--------------+---------------------+-------+----------+------------
559 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
560 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
561 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
562 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
563 +-------+--------------+---------------------+-------+----------+------------+
566 Below is an example of this new feature (which is number 12 in the
571 To select the JobIds, you have the following choices:
572 1: List last 20 Jobs run
573 2: List Jobs where a given File is saved
575 12: Select full restore to a specified Job date
578 Select item: (1-13): 12
579 Enter JobId to get the state to restore: 5
580 Selecting jobs to build the Full state at 2009-07-15 11:45:45
581 You have selected the following JobIds: 1,3,5
583 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
584 1,444 files inserted into the tree.
587 This project was funded by Bacula Systems.
589 \section{Source Address}
590 \index[general]{Source Address}
592 A feature has been added which allows the administrator to specify the address
593 from which the Director and File daemons will establish connections. This
594 may be used to simplify system configuration overhead when working in complex
595 networks utilizing multi-homing and policy-routing.
597 To accomplish this, two new configuration directives have been implemented:
600 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
604 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
608 Simply adding specific host routes on the OS
609 would have an undesirable side-effect: any
610 application trying to contact the destination host would be forced to use the
611 more specific route possibly diverting management traffic onto a backup VLAN.
612 Instead of adding host routes for each client connected to a multi-homed backup
613 server (for example where there are management and backup VLANs), one can
614 use the new directives to specify a specific source address at the application
617 Additionally, this allows the simplification and abstraction of firewall rules
618 when dealing with a Hot-Standby director or storage daemon configuration. The
619 Hot-standby pair may share a CARP address, which connections must be sourced
620 from, while system services listen and act from the unique interface addresses.
622 This project was funded by Collaborative Fusion, Inc.
624 \section{Show volume availability when doing restore}
626 When doing a restore the selection dialog ends by displaying this
630 The job will require the following
631 Volume(s) Storage(s) SD Device(s)
632 ===========================================================================
643 Volumes marked with ``*'' are online (in the autochanger).
646 This should help speed up large restores by minimizing the time spent
647 waiting for the operator to discover that he must change tapes in the library.
649 This project was funded by Bacula Systems.
651 \section{Accurate estimate command}
653 The \texttt{estimate} command can now use the accurate code to detect changes
654 and give a better estimation.
656 You can set the accurate behavior on the command line by using
657 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
660 * estimate listing accurate=yes level=incremental job=BackupJob
663 This project was funded by Bacula Systems.
665 \chapter{New Features in 3.0.0}
666 \label{NewFeaturesChapter}
667 \index[general]{New Features}
669 This chapter presents the new features added to the development 2.5.x
670 versions to be released as Bacula version 3.0.0 sometime in April 2009.
672 \section{Accurate Backup}
673 \index[general]{Accurate Backup}
675 As with most other backup programs, by default Bacula decides what files to
676 backup for Incremental and Differental backup by comparing the change
677 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
678 backup completed. If one of those two times is later than the last backup
679 time, then the file will be backed up. This does not, however, permit tracking
680 what files have been deleted and will miss any file with an old time that may
681 have been restored to or moved onto the client filesystem.
683 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
684 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
685 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
686 backup, there is no difference, but for {\bf Differential} and {\bf
687 Incremental} backups, the Director will send a list of all previous files
688 backed up, and the File daemon will use that list to determine if any new files
689 have been added or or moved and if any files have been deleted. This allows
690 Bacula to make an accurate backup of your system to that point in time so that
691 if you do a restore, it will restore your system exactly.
694 about using Accurate backup is that it requires more resources (CPU and memory)
695 on both the Director and the Client machines to create the list of previous
696 files backed up, to send that list to the File daemon, for the File daemon to
697 keep the list (possibly very big) in memory, and for the File daemon to do
698 comparisons between every file in the FileSet and the list. In particular,
699 if your client has lots of files (more than a few million), you will need
700 lots of memory on the client machine.
702 Accurate must not be enabled when backing up with a plugin that is not
703 specially designed to work with Accurate. If you enable it, your restores
704 will probably not work correctly.
706 This project was funded by Bacula Systems.
711 \index[general]{Copy Jobs}
713 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
714 existing Migration feature with the exception that the Job that is copied is
715 left unchanged. This essentially creates two identical copies of the same
716 backup. However, the copy is treated as a copy rather than a backup job, and
717 hence is not directly available for restore. The {\bf restore} command lists
718 copy jobs and allows selection of copies by using \texttt{jobid=}
719 option. If the keyword {\bf copies} is present on the command line, Bacula will
720 display the list of all copies for selected jobs.
725 These JobIds have copies as follows:
726 +-------+------------------------------------+-----------+------------------+
727 | JobId | Job | CopyJobId | MediaType |
728 +-------+------------------------------------+-----------+------------------+
729 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
730 +-------+------------------------------------+-----------+------------------+
731 +-------+-------+----------+----------+---------------------+------------------+
732 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
733 +-------+-------+----------+----------+---------------------+------------------+
734 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
735 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
736 +-------+-------+----------+----------+---------------------+------------------+
737 You have selected the following JobIds: 19,2
739 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
740 5,611 files inserted into the tree.
745 The Copy Job runs without using the File daemon by copying the data from the
746 old backup Volume to a different Volume in a different Pool. See the Migration
747 documentation for additional details. For copy Jobs there is a new selection
748 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
749 not already copied to another Pool.
751 As with Migration, the Client, Volume, Job, or SQL query, are
752 other possible ways of selecting the Jobs to be copied. Selection
753 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
754 work, but are probably more suited for Migration Jobs.
756 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
757 it will promote the Copy to a \textsl{real} backup job and will make it available for
758 automatic restore. If more than one Copy is available, it will promote the copy
759 with the smallest JobId.
761 A nice solution which can be built with the new Copy feature is often
762 called disk-to-disk-to-tape backup (DTDTT). A sample config could
763 look something like the one below:
767 Name = FullBackupsVirtualPool
769 Purge Oldest Volume = Yes
771 NextPool = FullBackupsTapePool
775 Name = FullBackupsTapePool
779 Volume Retention = 365 days
780 Storage = superloader
784 # Fake fileset for copy jobs
796 # Fake client for copy jobs
806 # Default template for a CopyDiskToTape Job
809 Name = CopyDiskToTape
811 Messages = StandardCopy
814 Selection Type = PoolUncopiedJobs
815 Maximum Concurrent Jobs = 10
817 Allow Duplicate Jobs = Yes
818 Allow Higher Duplicates = No
819 Cancel Queued Duplicates = No
820 Cancel Running Duplicates = No
825 Name = DaySchedule7:00
826 Run = Level=Full daily at 7:00
830 Name = CopyDiskToTapeFullBackups
832 Schedule = DaySchedule7:00
833 Pool = FullBackupsVirtualPool
834 JobDefs = CopyDiskToTape
838 The example above had 2 pool which are copied using the PoolUncopiedJobs
839 selection criteria. Normal Full backups go to the Virtual pool and are copied
840 to the Tape pool the next morning.
842 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
847 +-------+------------------------------------+-----------+------------------+
848 | JobId | Job | CopyJobId | MediaType |
849 +-------+------------------------------------+-----------+------------------+
850 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
851 +-------+------------------------------------+-----------+------------------+
854 \section{ACL Updates}
855 \index[general]{ACL Updates}
856 The whole ACL code had been overhauled and in this version each platforms has
857 different streams for each type of acl available on such an platform. As ACLs
858 between platforms tend to be not that portable (most implement POSIX acls but
859 some use an other draft or a completely different format) we currently only
860 allow certain platform specific ACL streams to be decoded and restored on the
861 same platform that they were created on. The old code allowed to restore ACL
862 cross platform but the comments already mention that not being to wise. For
863 backward compatability the new code will accept the two old ACL streams and
864 handle those with the platform specific handler. But for all new backups it
865 will save the ACLs using the new streams.
867 Currently the following platforms support ACLs:
871 \item {\bf Darwin/OSX}
880 Currently we support the following ACL types (these ACL streams use a reserved
881 part of the stream numbers):
884 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
886 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
887 string representation from acl\_to\_text (POSIX acl)
888 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
889 string representation from acl\_to\_text (POSIX acl) for default acls.
890 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
891 string representation from acl\_to\_text (POSIX acl) for access acls.
892 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
893 string representation from acltostr (POSIX acl)
894 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
895 representation from acl\_to\_text (POSIX acl) for default acls.
896 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
897 representation from acl\_to\_text (POSIX acl) for access acls.
898 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
899 string representation from acl\_to\_text (POSIX acl) for default acls.
900 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
901 representation from acl\_to\_text (POSIX acl) for access acls.
902 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
903 string representation from acl\_to\_text (POSIX acl) for default acls.
904 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
905 string representation from acl\_to\_text (POSIX acl) for default acls.
906 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
907 representation from acl\_to\_text (POSIX acl) for access acls.
908 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
909 string representation from acltotext or acl\_totext (POSIX acl)
910 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
911 representation from from acl\_totext (NFSv4 or ZFS acl)
914 In future versions we might support conversion functions from one type of acl
915 into an other for types that are either the same or easily convertable. For now
916 the streams are seperate and restoring them on a platform that doesn't
917 recognize them will give you a warning.
919 \section{Extended Attributes}
920 \index[general]{Extended Attributes}
921 Something that was on the project list for some time is now implemented for
922 platforms that support a similar kind of interface. Its the support for backup
923 and restore of so called extended attributes. As extended attributes are so
924 platform specific these attributes are saved in seperate streams for each
925 platform. Restores of the extended attributes can only be performed on the
926 same platform the backup was done. There is support for all types of extended
927 attributes, but restoring from one type of filesystem onto an other type of
928 filesystem on the same platform may lead to supprises. As extended attributes
929 can contain any type of data they are stored as a series of so called
930 value-pairs. This data must be seen as mostly binary and is stored as such.
931 As security labels from selinux are also extended attributes this option also
932 stores those labels and no specific code is enabled for handling selinux
935 Currently the following platforms support extended attributes:
937 \item {\bf Darwin/OSX}
943 On linux acls are also extended attributes, as such when you enable ACLs on a
944 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
945 and not the same exteneded attribute.
947 To enable the backup of extended attributes please add the following to your
962 \section{Shared objects}
963 \index[general]{Shared objects}
964 A default build of Bacula will now create the libraries as shared objects
965 (.so) rather than static libraries as was previously the case.
966 The shared libraries are built using {\bf libtool} so it should be quite
969 An important advantage of using shared objects is that on a machine with the
970 Directory, File daemon, the Storage daemon, and a console, you will have only
971 one copy of the code in memory rather than four copies. Also the total size of
972 the binary release is smaller since the library code appears only once rather
973 than once for every program that uses it; this results in significant reduction
974 in the size of the binaries particularly for the utility tools.
976 In order for the system loader to find the shared objects when loading the
977 Bacula binaries, the Bacula shared objects must either be in a shared object
978 directory known to the loader (typically /usr/lib) or they must be in the
979 directory that may be specified on the {\bf ./configure} line using the {\bf
980 {-}{-}libdir} option as:
983 ./configure --libdir=/full-path/dir
986 the default is /usr/lib. If {-}{-}libdir is specified, there should be
987 no need to modify your loader configuration provided that
988 the shared objects are installed in that directory (Bacula
989 does this with the make install command). The shared objects
990 that Bacula references are:
999 These files are symbolically linked to the real shared object file,
1000 which has a version number to permit running multiple versions of
1001 the libraries if desired (not normally the case).
1003 If you have problems with libtool or you wish to use the old
1004 way of building static libraries, or you want to build a static
1005 version of Bacula you may disable
1006 libtool on the configure command line with:
1009 ./configure --disable-libtool
1013 \section{Building Static versions of Bacula}
1014 \index[general]{Static linking}
1015 In order to build static versions of Bacula, in addition
1016 to configuration options that were needed you now must
1017 also add --disable-libtool. Example
1020 ./configure --enable-static-client-only --disable-libtool
1024 \section{Virtual Backup (Vbackup)}
1025 \index[general]{Virtual Backup}
1026 \index[general]{Vbackup}
1028 Bacula's virtual backup feature is often called Synthetic Backup or
1029 Consolidation in other backup products. It permits you to consolidate the
1030 previous Full backup plus the most recent Differential backup and any
1031 subsequent Incremental backups into a new Full backup. This new Full
1032 backup will then be considered as the most recent Full for any future
1033 Incremental or Differential backups. The VirtualFull backup is
1034 accomplished without contacting the client by reading the previous backup
1035 data and writing it to a volume in a different pool.
1037 In some respects the Vbackup feature works similar to a Migration job, in
1038 that Bacula normally reads the data from the pool specified in the
1039 Job resource, and writes it to the {\bf Next Pool} specified in the
1040 Job resource. Note, this means that usually the output from the Virtual
1041 Backup is written into a different pool from where your prior backups
1042 are saved. Doing it this way guarantees that you will not get a deadlock
1043 situation attempting to read and write to the same volume in the Storage
1044 daemon. If you then want to do subsequent backups, you may need to
1045 move the Virtual Full Volume back to your normal backup pool.
1046 Alternatively, you can set your {\bf Next Pool} to point to the current
1047 pool. This will cause Bacula to read and write to Volumes in the
1048 current pool. In general, this will work, because Bacula will
1049 not allow reading and writing on the same Volume. In any case, once
1050 a VirtualFull has been created, and a restore is done involving the
1051 most current Full, it will read the Volume or Volumes by the VirtualFull
1052 regardless of in which Pool the Volume is found.
1054 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1055 a level of {\bf VirtualFull}.
1057 A typical Job resource definition might look like the following:
1064 FileSet = "Full Set"
1071 # Default pool definition
1075 Recycle = yes # Automatically recycle Volumes
1076 AutoPrune = yes # Prune expired volumes
1077 Volume Retention = 365d # one year
1085 Recycle = yes # Automatically recycle Volumes
1086 AutoPrune = yes # Prune expired volumes
1087 Volume Retention = 365d # one year
1088 Storage = DiskChanger
1091 # Definition of file storage device
1096 Device = FileStorage
1098 Maximum Concurrent Jobs = 5
1101 # Definition of DDS Virtual tape disk storage device
1104 Address = localhost # N.B. Use a fully qualified name here
1106 Device = DiskChanger
1107 Media Type = DiskChangerMedia
1108 Maximum Concurrent Jobs = 4
1113 Then in bconsole or via a Run schedule, you would run the job as:
1116 run job=MyBackup level=Full
1117 run job=MyBackup level=Incremental
1118 run job=MyBackup level=Differential
1119 run job=MyBackup level=Incremental
1120 run job=MyBackup level=Incremental
1123 So providing there were changes between each of those jobs, you would end up
1124 with a Full backup, a Differential, which includes the first Incremental
1125 backup, then two Incremental backups. All the above jobs would be written to
1126 the {\bf Default} pool.
1128 To consolidate those backups into a new Full backup, you would run the
1132 run job=MyBackup level=VirtualFull
1135 And it would produce a new Full backup without using the client, and the output
1136 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1138 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1141 Note, the Start and End time of the Virtual Full backup is set to the
1142 values for the last job included in the Virtual Full (in the above example,
1143 it is an Increment). This is so that if another incremental is done, which
1144 will be based on the Virtual Full, it will backup all files from the
1145 last Job included in the Virtual Full rather than from the time the Virtual
1146 Full was actually run.
1150 \section{Catalog Format}
1151 \index[general]{Catalog Format}
1152 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1153 operation will convert the FileId field of the File table from 32 bits (max 4
1154 billion table entries) to 64 bits (very large number of items). The
1155 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1156 your catalog during the conversion. Also you won't be able to run jobs during
1157 this conversion period. For example, a 3 million file catalog will take 2
1158 minutes to upgrade on a normal machine. Please don't forget to make a valid
1159 backup of your database before executing the upgrade script. See the
1160 ReleaseNotes for additional details.
1162 \section{64 bit Windows Client}
1163 \index[general]{Win64 Client}
1164 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1165 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1166 As a consequence, we are also releasing a 64 bit version of the Bacula
1167 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1168 These binaries should only be installed on 64 bit Windows operating systems.
1169 What is important is not your hardware but whether or not you have
1170 a 64 bit version of the Windows OS.
1172 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1174 \item Before installing the Win64 Bacula Client, you must totally
1175 deinstall any prior 2.4.x Client installation using the
1176 Bacula deinstallation (see the menu item). You may want
1177 to save your .conf files first.
1178 \item Only the Client (File daemon) is ported to Win64, the Director
1179 and the Storage daemon are not in the 64 bit Windows installer.
1180 \item bwx-console is not yet ported.
1181 \item bconsole is ported but it has not been tested.
1182 \item The documentation is not included in the installer.
1183 \item Due to Vista security restrictions imposed on a default installation
1184 of Vista, before upgrading the Client, you must manually stop
1185 any prior version of Bacula from running, otherwise the install
1187 \item Due to Vista security restrictions imposed on a default installation
1188 of Vista, attempting to edit the conf files via the menu items
1189 will fail. You must directly edit the files with appropriate
1190 permissions. Generally double clicking on the appropriate .conf
1191 file will work providing you have sufficient permissions.
1192 \item All Bacula files are now installed in
1193 {\bf C:/Program Files/Bacula} except the main menu items,
1194 which are installed as before. This vastly simplifies the installation.
1195 \item If you are running on a foreign language version of Windows, most
1196 likely {\bf C:/Program Files} does not exist, so you should use the
1197 Custom installation and enter an appropriate location to install
1199 \item The 3.0.0 Win32 Client continues to install files in the locations used
1200 by prior versions. For the next version we will convert it to use
1201 the same installation conventions as the Win64 version.
1204 This project was funded by Bacula Systems.
1207 \section{Duplicate Job Control}
1208 \index[general]{Duplicate Jobs}
1209 The new version of Bacula provides four new directives that
1210 give additional control over what Bacula does if duplicate jobs
1211 are started. A duplicate job in the sense we use it here means
1212 a second or subsequent job with the same name starts. This
1213 happens most frequently when the first job runs longer than expected because no
1214 tapes are available.
1216 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1217 are specified in the Job resource.
1221 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1222 \index[general]{Allow Duplicate Jobs}
1223 If this directive is enabled duplicate jobs will be run. If
1224 the directive is set to {\bf no} (default) then only one job of a given name
1225 may run at one time, and the action that Bacula takes to ensure only
1226 one job runs is determined by the other directives (see below).
1228 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1229 are present and none of the three directives given below permit
1230 cancelling a job, then the current job (the second one started)
1234 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1235 \index[general]{Allow Higher Duplicates}
1236 If this directive is set to {\bf yes} (default) the job with a higher
1237 priority (lower priority number) will be permitted to run, and
1238 the current job will be cancelled. If the
1239 priorities of the two jobs are the same, the outcome is determined by
1240 other directives (see below).
1242 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1243 \index[general]{Cancel Queued Duplicates}
1244 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1245 if this directive is set to {\bf yes} any job that is
1246 already queued to run but not yet running will be canceled.
1247 The default is {\bf no}.
1249 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1250 \index[general]{Cancel Running Duplicates}
1251 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1252 if this directive is set to {\bf yes} any job that is already running
1253 will be canceled. The default is {\bf no}.
1256 \section{TLS Authentication}
1257 \index[general]{TLS Authentication}
1258 In Bacula version 2.5.x and later, in addition to the normal Bacula
1259 CRAM-MD5 authentication that is used to authenticate each Bacula
1260 connection, you can specify that you want TLS Authentication as well,
1261 which will provide more secure authentication.
1263 This new feature uses Bacula's existing TLS code (normally used for
1264 communications encryption) to do authentication. To use it, you must
1265 specify all the TLS directives normally used to enable communications
1266 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1269 \subsection{TLS Authenticate = yes}
1271 TLS Authenticate = yes
1274 in the main daemon configuration resource (Director for the Director,
1275 Client for the File daemon, and Storage for the Storage daemon).
1277 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1278 authentication, Bacula will also do TLS authentication, then TLS
1279 encryption will be turned off, and the rest of the communication between
1280 the two Bacula daemons will be done without encryption.
1282 If you want to encrypt communications data, use the normal TLS directives
1283 but do not turn on {\bf TLS Authenticate}.
1285 \section{bextract non-portable Win32 data}
1286 \index[general]{bextract handles Win32 non-portable data}
1287 {\bf bextract} has been enhanced to be able to restore
1288 non-portable Win32 data to any OS. Previous versions were
1289 unable to restore non-portable Win32 data to machines that
1290 did not have the Win32 BackupRead and BackupWrite API calls.
1292 \section{State File updated at Job Termination}
1293 \index[general]{State File}
1294 In previous versions of Bacula, the state file, which provides a
1295 summary of previous jobs run in the {\bf status} command output was
1296 updated only when Bacula terminated, thus if the daemon crashed, the
1297 state file might not contain all the run data. This version of
1298 the Bacula daemons updates the state file on each job termination.
1300 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1301 \index[general]{MaxFullInterval}
1302 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1303 can be used to specify the maximum time interval between {\bf Full} backup
1304 jobs. When a job starts, if the time since the last Full backup is
1305 greater than the specified interval, and the job would normally be an
1306 {\bf Incremental} or {\bf Differential}, it will be automatically
1307 upgraded to a {\bf Full} backup.
1309 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1310 \index[general]{MaxDiffInterval}
1311 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1312 can be used to specify the maximum time interval between {\bf Differential} backup
1313 jobs. When a job starts, if the time since the last Differential backup is
1314 greater than the specified interval, and the job would normally be an
1315 {\bf Incremental}, it will be automatically
1316 upgraded to a {\bf Differential} backup.
1318 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1319 \index[general]{MaxDiffInterval}
1320 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1321 by the user, and when it is set it is an indication to backup programs
1322 to not backup that particular file. This version of Bacula contains a
1323 new Options directive within a FileSet resource, which instructs Bacula to
1324 obey this flag. The new directive is:
1327 Honor No Dump Flag = yes\vb{}no
1330 The default value is {\bf no}.
1333 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1334 \index[general]{IgnoreDir}
1335 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1336 can be added to the Include section of the FileSet resource. If the specified
1337 filename ({\bf filename-string}) is found on the Client in any directory to be
1338 backed up, the whole directory will be ignored (not backed up). For example:
1341 # List of files to be backed up
1349 Exclude Dir Containing = .excludeme
1354 But in /home, there may be hundreds of directories of users and some
1355 people want to indicate that they don't want to have certain
1356 directories backed up. For example, with the above FileSet, if
1357 the user or sysadmin creates a file named {\bf .excludeme} in
1358 specific directories, such as
1361 /home/user/www/cache/.excludeme
1362 /home/user/temp/.excludeme
1365 then Bacula will not backup the two directories named:
1368 /home/user/www/cache
1372 NOTE: subdirectories will not be backed up. That is, the directive
1373 applies to the two directories in question and any children (be they
1374 files, directories, etc).
1377 \section{Bacula Plugins}
1378 \index[general]{Plugin}
1379 Support for shared object plugins has been implemented in the Linux, Unix
1380 and Win32 File daemons. The API will be documented separately in
1381 the Developer's Guide or in a new document. For the moment, there is
1382 a single plugin named {\bf bpipe} that allows an external program to
1383 get control to backup and restore a file.
1385 Plugins are also planned (partially implemented) in the Director and the
1388 \subsection{Plugin Directory}
1389 \index[general]{Plugin Directory}
1390 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1391 be added to the daemon definition resource. The directory takes a quoted
1392 string argument, which is the name of the directory in which the daemon can
1393 find the Bacula plugins. If this directive is not specified, Bacula will not
1394 load any plugins. Since each plugin has a distinctive name, all the daemons
1395 can share the same plugin directory.
1397 \subsection{Plugin Options}
1398 \index[general]{Plugin Options}
1399 The {\bf Plugin Options} directive takes a quoted string
1400 arguement (after the equal sign) and may be specified in the
1401 Job resource. The options specified will be passed to all plugins
1402 when they are run. This each plugin must know what it is looking
1403 for. The value defined in the Job resource can be modified
1404 by the user when he runs a Job via the {\bf bconsole} command line
1407 Note: this directive may be specified, and there is code to modify
1408 the string in the run command, but the plugin options are not yet passed to
1409 the plugin (i.e. not fully implemented).
1411 \subsection{Plugin Options ACL}
1412 \index[general]{Plugin Options ACL}
1413 The {\bf Plugin Options ACL} directive may be specified in the
1414 Director's Console resource. It functions as all the other ACL commands
1415 do by permitting users running restricted consoles to specify a
1416 {\bf Plugin Options} that overrides the one specified in the Job
1417 definition. Without this directive restricted consoles may not modify
1420 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1421 \index[general]{Plugin}
1422 The {\bf Plugin} directive is specified in the Include section of
1423 a FileSet resource where you put your {\bf File = xxx} directives.
1434 Plugin = "bpipe:..."
1439 In the above example, when the File daemon is processing the directives
1440 in the Include section, it will first backup all the files in {\bf /home}
1441 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1442 the Plugin Directory. The syntax and semantics of the Plugin directive
1443 require the first part of the string up to the colon (:) to be the name
1444 of the plugin. Everything after the first colon is ignored by the File daemon but
1445 is passed to the plugin. Thus the plugin writer may define the meaning of the
1446 rest of the string as he wishes.
1448 Please see the next section for information about the {\bf bpipe} Bacula
1451 \section{The bpipe Plugin}
1452 \index[general]{The bpipe Plugin}
1453 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1454 the Bacula source distribution. When the plugin is compiled and linking into
1455 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1457 The purpose of the plugin is to provide an interface to any system program for
1458 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1459 the Include section of your Job's FileSet resource. The full syntax of the
1460 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1461 to specify the sytax as it wishes) is:
1464 Plugin = "<field1>:<field2>:<field3>:<field4>"
1469 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1470 stripped off, so in this case, we would put {\bf bpipe} in this field.
1472 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1473 pseudo path and filename under which the backup will be saved. This pseudo
1474 path and filename will be seen by the user in the restore file tree.
1475 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1476 backed up by the plugin will be put under that "pseudo" path and filename.
1477 You must be careful to choose a naming convention that is unique to avoid
1478 a conflict with a path and filename that actually exists on your system.
1480 \item {\bf field3} for the {\bf bpipe} plugin
1481 specifies the "reader" program that is called by the plugin during
1482 backup to read the data. {\bf bpipe} will call this program by doing a
1485 \item {\bf field4} for the {\bf bpipe} plugin
1486 specifies the "writer" program that is called by the plugin during
1487 restore to write the data back to the filesystem.
1490 Putting it all together, the full plugin directive line might look
1494 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1495 --opt --databases bacula:mysql"
1498 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1499 would be written on a single line.
1501 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1502 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1503 program {\bf mysqldump -f --opt --database bacula} to read the data during
1504 backup. The mysqldump command outputs all the data for the database named
1505 {\bf bacula}, which will be read by the plugin and stored in the backup.
1506 During restore, the data that was backed up will be sent to the program
1507 specified in the last field, which in this case is {\bf mysql}. When
1508 {\bf mysql} is called, it will read the data sent to it by the plugn
1509 then write it back to the same database from which it came ({\bf bacula}
1512 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1513 the data from a specified program to Bacula for backup, and then from Bacula to
1514 a specified program for restore.
1516 By using different command lines to {\bf bpipe},
1517 you can backup any kind of data (ASCII or binary) depending
1518 on the program called.
1520 \section{Microsoft Exchange Server 2003/2007 Plugin}
1521 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1522 \subsection{Background}
1523 The Exchange plugin was made possible by a funded development project
1524 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1525 The code for the plugin was written by James Harper, and the Bacula core
1526 code by Kern Sibbald. All the code for this funded development has become
1527 part of the Bacula project. Thanks to everyone who made it happen.
1529 \subsection{Concepts}
1530 Although it is possible to backup Exchange using Bacula VSS the Exchange
1531 plugin adds a good deal of functionality, because while Bacula VSS
1532 completes a full backup (snapshot) of Exchange, it does
1533 not support Incremental or Differential backups, restoring is more
1534 complicated, and a single database restore is not possible.
1536 Microsoft Exchange organises its storage into Storage Groups with
1537 Databases inside them. A default installation of Exchange will have a
1538 single Storage Group called 'First Storage Group', with two Databases
1539 inside it, "Mailbox Store (SERVER NAME)" and
1540 "Public Folder Store (SERVER NAME)",
1541 which hold user email and public folders respectively.
1543 In the default configuration, Exchange logs everything that happens to
1544 log files, such that if you have a backup, and all the log files since,
1545 you can restore to the present time. Each Storage Group has its own set
1546 of log files and operates independently of any other Storage Groups. At
1547 the Storage Group level, the logging can be turned off by enabling a
1548 function called "Enable circular logging". At this time the Exchange
1549 plugin will not function if this option is enabled.
1551 The plugin allows backing up of entire storage groups, and the restoring
1552 of entire storage groups or individual databases. Backing up and
1553 restoring at the individual mailbox or email item is not supported but
1554 can be simulated by use of the "Recovery" Storage Group (see below).
1556 \subsection{Installing}
1557 The Exchange plugin requires a DLL that is shipped with Microsoft
1558 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1559 correctly the Exchange plugin should find this automatically and run
1560 without any additional installation.
1562 If the DLL can not be found automatically it will need to be copied into
1563 the Bacula installation
1564 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1565 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1566 default Exchange installation.
1568 \subsection{Backing Up}
1569 To back up an Exchange server the Fileset definition must contain at
1570 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1571 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1572 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1573 up files are prefixed with something that isn't going to share a name
1574 with something outside the plugin, and the 'Microsoft Information Store'
1575 bit is required also. It is also possible to add the name of a storage
1576 group to the "Plugin =" line, eg \\
1577 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1578 if you want only a single storage group backed up.
1580 Additionally, you can suffix the 'Plugin =' directive with
1581 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1582 database at the end of a full backup.
1584 An Incremental or Differential backup will backup only the database logs
1585 for each Storage Group by inspecting the "modified date" on each
1586 physical log file. Because of the way the Exchange API works, the last
1587 logfile backed up on each backup will always be backed up by the next
1588 Incremental or Differential backup too. This adds 5MB to each
1589 Incremental or Differential backup size but otherwise does not cause any
1592 By default, a normal VSS fileset containing all the drive letters will
1593 also back up the Exchange databases using VSS. This will interfere with
1594 the plugin and Exchange's shared ideas of when the last full backup was
1595 done, and may also truncate log files incorrectly. It is important,
1596 therefore, that the Exchange database files be excluded from the backup,
1597 although the folders the files are in should be included, or they will
1598 have to be recreated manually if a baremetal restore is done.
1603 File = C:/Program Files/Exchsrvr/mdbdata
1604 Plugin = "exchange:..."
1607 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1608 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1609 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1610 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1611 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1612 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1613 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1618 The advantage of excluding the above files is that you can significantly
1619 reduce the size of your backup since all the important Exchange files
1620 will be properly saved by the Plugin.
1623 \subsection{Restoring}
1624 The restore operation is much the same as a normal Bacula restore, with
1625 the following provisos:
1628 \item The {\bf Where} restore option must not be specified
1629 \item Each Database directory must be marked as a whole. You cannot just
1630 select (say) the .edb file and not the others.
1631 \item If a Storage Group is restored, the directory of the Storage Group
1633 \item It is possible to restore only a subset of the available log files,
1634 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1635 if a log file is missing from the sequence of log files
1636 \item Each database to be restored must be dismounted and marked as "Can be
1637 overwritten by restore"
1638 \item If an entire Storage Group is to be restored (eg all databases and
1639 logs in the Storage Group), then it is best to manually delete the
1640 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1641 as Exchange can get confused by stray log files lying around.
1644 \subsection{Restoring to the Recovery Storage Group}
1645 The concept of the Recovery Storage Group is well documented by
1647 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1648 but to briefly summarize...
1650 Microsoft Exchange allows the creation of an additional Storage Group
1651 called the Recovery Storage Group, which is used to restore an older
1652 copy of a database (e.g. before a mailbox was deleted) into without
1653 messing with the current live data. This is required as the Standard and
1654 Small Business Server versions of Exchange can not ordinarily have more
1655 than one Storage Group.
1657 To create the Recovery Storage Group, drill down to the Server in Exchange
1658 System Manager, right click, and select
1659 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1660 locations and click OK. On the Recovery Storage Group, right click and
1661 select {\bf "Add Database to Recover..."} and select the database you will
1664 Restore only the single database nominated as the database in the
1665 Recovery Storage Group. Exchange will redirect the restore to the
1666 Recovery Storage Group automatically.
1667 Then run the restore.
1669 \subsection{Restoring on Microsoft Server 2007}
1670 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1671 2007, and henc you use a new proceedure for recovering a single mail box.
1672 This procedure is ducomented by Microsoft at:
1673 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1674 and involves using the {\bf Restore-Mailbox} and {\bf
1675 Get-MailboxStatistics} shell commands.
1677 \subsection{Caveats}
1678 This plugin is still being developed, so you should consider it
1679 currently in BETA test, and thus use in a production environment
1680 should be done only after very careful testing.
1682 When doing a full backup, the Exchange database logs are truncated by
1683 Exchange as soon as the plugin has completed the backup. If the data
1684 never makes it to the backup medium (eg because of spooling) then the
1685 logs will still be truncated, but they will also not have been backed
1686 up. A solution to this is being worked on. You will have to schedule a
1687 new Full backup to ensure that your next backups will be usable.
1689 The "Enable Circular Logging" option cannot be enabled or the plugin
1692 Exchange insists that a successful Full backup must have taken place if
1693 an Incremental or Differential backup is desired, and the plugin will
1694 fail if this is not the case. If a restore is done, Exchange will
1695 require that a Full backup be done before an Incremental or Differential
1698 The plugin will most likely not work well if another backup application
1699 (eg NTBACKUP) is backing up the Exchange database, especially if the
1700 other backup application is truncating the log files.
1702 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1703 we recommend either carefully testing or that you avoid this option for
1706 The Exchange plugin is not called during processing the bconsole {\bf
1707 estimate} command, and so anything that would be backed up by the plugin
1708 will not be added to the estimate total that is displayed.
1711 \section{libdbi Framework}
1712 \index[general]{libdbi Framework}
1713 As a general guideline, Bacula has support for a few catalog database drivers
1714 (MySQL, PostgreSQL, SQLite)
1715 coded natively by the Bacula team. With the libdbi implementation, which is a
1716 Bacula driver that uses libdbi to access the catalog, we have an open field to
1717 use many different kinds database engines following the needs of users.
1719 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1720 implements a database-independent abstraction layer in C, similar to the
1721 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1722 leverage the power of multiple databases and multiple simultaneous database
1723 connections by using this framework.
1725 Currently the libdbi driver in Bacula project only supports the same drivers
1726 natively coded in Bacula. However the libdbi project has support for many
1727 others database engines. You can view the list at
1728 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1729 supported by Bacula, however, they must be tested properly by the Bacula team.
1731 Some of benefits of using libdbi are:
1733 \item The possibility to use proprietary databases engines in which your
1734 proprietary licenses prevent the Bacula team from developing the driver.
1735 \item The possibility to use the drivers written for the libdbi project.
1736 \item The possibility to use other database engines without recompiling Bacula
1737 to use them. Just change one line in bacula-dir.conf
1738 \item Abstract Database access, this is, unique point to code and profiling
1739 catalog database access.
1742 The following drivers have been tested:
1744 \item PostgreSQL, with and without batch insert
1745 \item Mysql, with and without batch insert
1750 In the future, we will test and approve to use others databases engines
1751 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1753 To compile Bacula to support libdbi we need to configure the code with the
1754 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1755 [database] is the database engine to be used with Bacula (of course we can
1756 change the driver in file bacula-dir.conf, see below). We must configure the
1757 access port of the database engine with the option --with-db-port, because the
1758 libdbi framework doesn't know the default access port of each database.
1760 The next phase is checking (or configuring) the bacula-dir.conf, example:
1764 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1765 dbname = regress; user = regress; password = ""
1769 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1770 mysql database. Currently the drivers supported by Bacula are: postgresql,
1771 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1773 The following limitations apply when Bacula is set to use the libdbi framework:
1774 - Not tested on the Win32 platform
1775 - A little performance is lost if comparing with native database driver.
1776 The reason is bound with the database driver provided by libdbi and the
1777 simple fact that one more layer of code was added.
1779 It is important to remember, when compiling Bacula with libdbi, the
1780 following packages are needed:
1782 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1783 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1786 You can download them and compile them on your system or install the packages
1787 from your OS distribution.
1789 \section{Console Command Additions and Enhancements}
1790 \index[general]{Console Additions}
1792 \subsection{Display Autochanger Content}
1793 \index[general]{StatusSlots}
1795 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1796 autochanger content.
1800 Slot | Volume Name | Status | Media Type | Pool |
1801 ------+---------------+----------+-------------------+------------|
1802 1 | 00001 | Append | DiskChangerMedia | Default |
1803 2 | 00002 | Append | DiskChangerMedia | Default |
1804 3*| 00003 | Append | DiskChangerMedia | Scratch |
1809 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1810 {\bf update slots} command to synchronize autochanger content with your
1813 \subsection{list joblog job=xxx or jobid=nnn}
1814 \index[general]{list joblog}
1815 A new list command has been added that allows you to list the contents
1816 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1817 or for a particular JobId. The {\bf llist} command will include a line with
1818 the time and date of the entry.
1820 Note for the catalog to have Job Log entries, you must have a directive
1827 In your Director's {\bf Messages} resource.
1829 \subsection{Use separator for multiple commands}
1830 \index[general]{Command Separator}
1831 When using bconsole with readline, you can set the command separator with
1832 \textbf{@separator} command to one
1833 of those characters to write commands who require multiple input in one line.
1835 !$%&'()*+,-/:;<>?[]^`{|}~
1838 \subsection{Deleting Volumes}
1839 The delete volume bconsole command has been modified to
1840 require an asterisk (*) in front of a MediaId otherwise the
1841 value you enter is a taken to be a Volume name. This is so that
1842 users may delete numeric Volume names. The previous Bacula versions
1843 assumed that all input that started with a number was a MediaId.
1845 This new behavior is indicated in the prompt if you read it
1848 \section{Bare Metal Recovery}
1849 The old bare metal recovery project is essentially dead. One
1850 of the main features of it was that it would build a recovery
1851 CD based on the kernel on your system. The problem was that
1852 every distribution has a different boot procedure and different
1853 scripts, and worse yet, the boot procedures and scripts change
1854 from one distribution to another. This meant that maintaining
1855 (keeping up with the changes) the rescue CD was too much work.
1857 To replace it, a new bare metal recovery USB boot stick has been developed
1858 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1859 boot from a USB key.
1863 \item Recovery can be done from within graphical environment.
1864 \item Recovery can be done in a shell.
1865 \item Ubuntu boots on a large number of Linux systems.
1866 \item The process of updating the system and adding new
1867 packages is not too difficult.
1868 \item The USB key can easily be upgraded to newer Ubuntu versions.
1869 \item The USB key has writable partitions for modifications to
1870 the OS and for modification to your home directory.
1871 \item You can add new files/directories to the USB key very easily.
1872 \item You can save the environment from multiple machines on
1874 \item Bacula Systems is funding its ongoing development.
1877 The disadvantages are:
1879 \item The USB key is usable but currently under development.
1880 \item Not everyone may be familiar with Ubuntu (no worse
1882 \item Some older OSes cannot be booted from USB. This can
1883 be resolved by first booting a Ubuntu LiveCD then plugging
1885 \item Currently the documentation is sketchy and not yet added
1886 to the main manual. See below ...
1889 The documentation and the code can be found in the {\bf rescue} package
1890 in the directory {\bf linux/usb}.
1892 \section{Miscellaneous}
1893 \index[general]{Misc New Features}
1895 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
1896 \index[general]{Allow Mixed Priority}
1897 This directive is only implemented in version 2.5 and later. When
1898 set to {\bf yes} (default {\bf no}), this job may run even if lower
1899 priority jobs are already running. This means a high priority job
1900 will not have to wait for other jobs to finish before starting.
1901 The scheduler will only mix priorities when all running jobs have
1904 Note that only higher priority jobs will start early. Suppose the
1905 director will allow two concurrent jobs, and that two jobs with
1906 priority 10 are running, with two more in the queue. If a job with
1907 priority 5 is added to the queue, it will be run as soon as one of
1908 the running jobs finishes. However, new priority 10 jobs will not
1909 be run until the priority 5 job has finished.
1911 \subsection{Bootstrap File Directive -- FileRegex}
1912 \index[general]{Bootstrap File Directive}
1913 {\bf FileRegex} is a new command that can be added to the bootstrap
1914 (.bsr) file. The value is a regular expression. When specified, only
1915 matching filenames will be restored.
1917 During a restore, if all File records are pruned from the catalog
1918 for a Job, normally Bacula can restore only all files saved. That
1919 is there is no way using the catalog to select individual files.
1920 With this new feature, Bacula will ask if you want to specify a Regex
1921 expression for extracting only a part of the full backup.
1924 Building directory tree for JobId(s) 1,3 ...
1925 There were no files inserted into the tree, so file selection
1926 is not possible.Most likely your retention policy pruned the files
1928 Do you want to restore all the files? (yes\vb{}no): no
1930 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1931 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1934 \subsection{Bootstrap File Optimization Changes}
1935 In order to permit proper seeking on disk files, we have extended the bootstrap
1936 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1937 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1938 address range and end address range respectively. These two directives replace
1939 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1940 VolEndBlock} directives. Bootstrap files containing the old directives will
1941 still work, but will not properly take advantage of proper disk seeking, and
1942 may read completely to the end of a disk volume during a restore. With the new
1943 format (automatically generated by the new Director), restores will seek
1944 properly and stop reading the volume when all the files have been restored.
1946 \subsection{Solaris ZFS/NFSv4 ACLs}
1947 This is an upgrade of the previous Solaris ACL backup code
1948 to the new library format, which will backup both the old
1949 POSIX(UFS) ACLs as well as the ZFS ACLs.
1951 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1952 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1953 be used to transfer from UFS to ZFS filesystems.
1956 \subsection{Virtual Tape Emulation}
1957 \index[general]{Virtual Tape Emulation}
1958 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1959 the tape code but actually reading and writing to a disk file. Used with the
1960 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1961 and 700 slots. This feature is most useful in testing. It is enabled
1962 by using {\bf Device Type = vtape} in the Storage daemon's Device
1963 directive. This feature is only implemented on Linux machines and should not be
1964 used for production.
1966 \subsection{Bat Enhancements}
1967 \index[general]{Bat Enhancements}
1968 Bat (the Bacula Administration Tool) GUI program has been significantly
1969 enhanced and stabilized. In particular, there are new table based status
1970 commands; it can now be easily localized using Qt4 Linguist.
1972 The Bat communications protocol has been significantly enhanced to improve
1973 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1974 the Director you are using otherwise the communications protocol will not
1977 \subsection{RunScript Enhancements}
1978 \index[general]{RunScript Enhancements}
1979 The {\bf RunScript} resource has been enhanced to permit multiple
1980 commands per RunScript. Simply specify multiple {\bf Command} directives
1987 Command = "/bin/echo test"
1988 Command = "/bin/echo an other test"
1989 Command = "/bin/echo 3 commands in the same runscript"
1996 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1997 implemented, which runs the command after the Volume Shadow Copy has been made.
1999 Console commands can be specified within a RunScript by using:
2000 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2001 carefully tested and debugged and is known to easily crash the Director.
2002 We would appreciate feedback. Due to the recursive nature of this command, we
2003 may remove it before the final release.
2005 \subsection{Status Enhancements}
2006 \index[general]{Status Enhancements}
2007 The bconsole {\bf status dir} output has been enhanced to indicate
2008 Storage daemon job spooling and despooling activity.
2010 \subsection{Connect Timeout}
2011 \index[general]{Connect Timeout}
2012 The default connect timeout to the File
2013 daemon has been set to 3 minutes. Previously it was 30 minutes.
2015 \subsection{ftruncate for NFS Volumes}
2016 \index[general]{ftruncate for NFS Volumes}
2017 If you write to a Volume mounted by NFS (say on a local file server),
2018 in previous Bacula versions, when the Volume was recycled, it was not
2019 properly truncated because NFS does not implement ftruncate (file
2020 truncate). This is now corrected in the new version because we have
2021 written code (actually a kind user) that deletes and recreates the Volume,
2022 thus accomplishing the same thing as a truncate.
2024 \subsection{Support for Ubuntu}
2025 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2026 version of Linux, and thus now provides correct autostart routines.
2027 Since Ubuntu officially supports Bacula, you can also obtain any
2028 recent release of Bacula from the Ubuntu repositories.
2030 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2031 \index[general]{Recycle Pool}
2032 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2033 be placed (moved) when it is recycled. Without this directive, a Volume will
2034 remain in the same pool when it is recycled. With this directive, it can be
2035 moved automatically to any existing pool during a recycle. This directive is
2036 probably most useful when defined in the Scratch pool, so that volumes will
2037 be recycled back into the Scratch pool.
2039 \subsection{FD Version}
2040 \index[general]{FD Version}
2041 The File daemon to Director protocol now includes a version
2042 number, which although there is no visible change for users,
2043 will help us in future versions automatically determine
2044 if a File daemon is not compatible.
2046 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2047 \index[general]{Max Run Sched Time}
2048 The time specifies the maximum allowed time that a job may run, counted from
2049 when the job was scheduled. This can be useful to prevent jobs from running
2050 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2053 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2054 \index[general]{Max Wait Time}
2055 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2056 of checking the maximum allowed time that a job may block for a resource,
2057 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2058 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2059 their job depending on the level. Now, they have to use
2060 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2061 directives are now deprecated.
2063 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2064 \index[general]{Incremental Max Wait Time}
2065 \index[general]{Differential Max Wait Time}
2067 These directives have been deprecated in favor of
2068 \texttt{Incremental|Differential Max Run Time}.
2070 \subsection{Max Run Time directives}
2071 \index[general]{Max Run Time directives}
2072 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2073 maximum allowed time that a job can run depending on the level.
2075 \addcontentsline{lof}{figure}{Job time control directives}
2076 \includegraphics{\idir different_time.eps}
2078 \subsection{Statistics Enhancements}
2079 \index[general]{Statistics Enhancements}
2080 If you (or probably your boss) want to have statistics on your backups to
2081 provide some \textit{Service Level Agreement} indicators, you could use a few
2082 SQL queries on the Job table to report how many:
2086 \item jobs have been successful
2087 \item files have been backed up
2091 However, these statistics are accurate only if your job retention is greater
2092 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2093 be able to use them.
2095 Now, you can use the \textbf{update stats [days=num]} console command to fill
2096 the JobHistory table with new Job records. If you want to be sure to take in
2097 account only \textbf{good jobs}, ie if one of your important job has failed but
2098 you have fixed the problem and restarted it on time, you probably want to
2099 delete the first \textit{bad} job record and keep only the successful one. For
2100 that simply let your staff do the job, and update JobHistory table after two or
2101 three days depending on your organization using the \textbf{[days=num]} option.
2103 These statistics records aren't used for restoring, but mainly for
2104 capacity planning, billings, etc.
2106 The Bweb interface provides a statistics module that can use this feature. You
2107 can also use tools like Talend or extract information by yourself.
2109 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2110 the length of time that Bacula will keep statistics job records in the Catalog
2111 database after the Job End time. (In \texttt{JobHistory} table) When this time
2112 period expires, and if user runs \texttt{prune stats} command, Bacula will
2113 prune (remove) Job records that are older than the specified period.
2115 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2116 job to maintain statistics.
2119 Name = BackupCatalog
2122 Console = "update stats days=3"
2123 Console = "prune stats yes"
2130 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2131 \index[general]{ScratchPool}
2132 This directive permits to specify a specific \textsl{Scratch} pool for the
2133 current pool. This is useful when using multiple storage sharing the same
2134 mediatype or when you want to dedicate volumes to a particular set of pool.
2136 \subsection{Enhanced Attribute Despooling}
2137 \index[general]{Attribute Despooling}
2138 If the storage daemon and the Director are on the same machine, the spool file
2139 that contains attributes is read directly by the Director instead of being
2140 transmitted across the network. That should reduce load and speedup insertion.
2142 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2143 \index[general]{SpoolSize}
2144 A new Job directive permits to specify the spool size per job. This is used
2145 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2147 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
2148 \index[general]{MaxConsoleConnections}
2149 A new director directive permits to specify the maximum number of Console
2150 Connections that could run concurrently. The default is set to 20, but you may
2151 set it to a larger number.
2153 \subsection{VerId = \lt{}string\gt{}}
2154 \index[general]{VerId}
2155 A new director directive permits to specify a personnal identifier that will be
2156 displayed in the \texttt{version} command.
2158 \subsection{dbcheck enhancements}
2159 \index[general]{dbcheck enhancements}
2160 If you are using Mysql, dbcheck will now ask you if you want to create
2161 temporary indexes to speed up orphaned Path and Filename elimination.
2163 A new \texttt{-B} option allows you to print catalog information in a simple
2164 text based format. This is useful to backup it in a secure way.
2179 You can now specify the database connection port in the command line.
2181 \subsection{{-}{-}docdir configure option}
2182 \index[general]{{-}{-}docdir configure option}
2183 You can use {-}{-}docdir= on the ./configure command to
2184 specify the directory where you want Bacula to install the
2185 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2186 {\bf /usr/share/doc/bacula}.
2188 \subsection{{-}{-}htmldir configure option}
2189 \index[general]{{-}{-}htmldir configure option}
2190 You can use {-}{-}htmldir= on the ./configure command to
2191 specify the directory where you want Bacula to install the bat html help
2192 files. The default is {\bf /usr/share/doc/bacula/html}
2194 \subsection{{-}{-}with-plugindir configure option}
2195 \index[general]{{-}{-}plugindir configure option}
2196 You can use {-}{-}plugindir= on the ./configure command to
2197 specify the directory where you want Bacula to install
2198 the plugins (currently only bpipe-fd). The default is