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 \section{Allow Higher Duplicates}
57 This directive did not work correctly and has been depreciated
58 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
59 file as it will be removed in a future rlease.
61 \section{Cancel Lower Level Duplicates}
62 This directive was added in Bacula version 5.0.1. It compares the
63 level of a new backup job to old jobs of the same name, if any,
64 and will kill the job which has a lower level than the other one.
65 If the levels are the same (i.e. both are Full backups), then
66 nothing is done and the other Cancel XXX Duplicate directives
69 \chapter{New Features in 5.0.0}
71 \section{Maximum Concurent Jobs for Devices}
72 \label{sec:maximumconcurentjobdevice}
74 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
75 Daemon configuration permits setting the maximum number of Jobs that can
76 run concurrently on a specified Device. Using this directive, it is
77 possible to have different Jobs using multiple drives, because when the
78 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
79 Jobs on any other available compatible drive. This facilitates writing to
80 multiple drives with multiple Jobs that all use the same Pool.
82 This project was funded by Bacula Systems.
84 \section{Restore from Multiple Storage Daemons}
85 \index[general]{Restore}
87 Previously, you were able to restore from multiple devices in a single Storage
88 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
89 example, if your full backup runs on a Storage Daemon with an autochanger, and
90 your incremental jobs use another Storage Daemon with lots of disks, Bacula
91 will switch automatically from one Storage Daemon to an other within the same
94 You must upgrade your File Daemon to version 3.1.3 or greater to use this
97 This project was funded by Bacula Systems with the help of Equiinet.
99 \section{File Deduplication using Base Jobs}
100 A base job is sort of like a Full save except that you will want the FileSet to
101 contain only files that are unlikely to change in the future (i.e. a snapshot
102 of most of your system after installing it). After the base job has been run,
103 when you are doing a Full save, you specify one or more Base jobs to be used.
104 All files that have been backed up in the Base job/jobs but not modified will
105 then be excluded from the backup. During a restore, the Base jobs will be
106 automatically pulled in where necessary.
108 This is something none of the competition does, as far as we know (except
109 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
110 win for the user, it makes Bacula stand out as offering a unique optimization
111 that immediately saves time and money. Basically, imagine that you have 100
112 nearly identical Windows or Linux machine containing the OS and user files.
113 Now for the OS part, a Base job will be backed up once, and rather than making
114 100 copies of the OS, there will be only one. If one or more of the systems
115 have some files updated, no problem, they will be automatically restored.
117 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
118 files that will be used during Full backup as base.
129 Base = BackupZog4, BackupLinux
135 In this example, the job \texttt{BackupZog4} will use the most recent version
136 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
137 jobs. Base jobs should have run with \texttt{level=Base} to be used.
139 By default, Bacula will compare permissions bits, user and group fields,
140 modification time, size and the checksum of the file to choose between the
141 current backup and the BaseJob file list. You can change this behavior with the
142 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
143 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
159 \textbf{Important note}: The current implementation doesn't permit to scan
160 volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
162 This project was funded by Bacula Systems.
164 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
165 \index[dir]{AllowCompression}
167 This new directive may be added to Storage resource within the Director's
168 configuration to allow users to selectively disable the client compression for
169 any job which writes to this storage resource.
175 Address = ultrium-tape
176 Password = storage_password # Password for Storage Daemon
179 AllowCompression = No # Tape drive has hardware compression
182 The above example would cause any jobs running with the UltriumTape storage
183 resource to run without compression from the client file daemons. This
184 effectively overrides any compression settings defined at the FileSet level.
186 This feature is probably most useful if you have a tape drive which supports
187 hardware compression. By setting the \texttt{AllowCompression = No} directive
188 for your tape drive storage resource, you can avoid additional load on the file
189 daemon and possibly speed up tape backups.
191 This project was funded by Collaborative Fusion, Inc.
193 \section{Accurate Fileset Options}
194 \label{sec:accuratefileset}
196 In previous versions, the accurate code used the file creation and modification
197 times to determine if a file was modified or not. Now you can specify which
198 attributes to use (time, size, checksum, permission, owner, group, \dots),
199 similar to the Verify options.
215 \item {\bf i} compare the inodes
216 \item {\bf p} compare the permission bits
217 \item {\bf n} compare the number of links
218 \item {\bf u} compare the user id
219 \item {\bf g} compare the group id
220 \item {\bf s} compare the size
221 \item {\bf a} compare the access time
222 \item {\bf m} compare the modification time (st\_mtime)
223 \item {\bf c} compare the change time (st\_ctime)
224 \item {\bf d} report file size decreases
225 \item {\bf 5} compare the MD5 signature
226 \item {\bf 1} compare the SHA1 signature
229 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
230 the File Daemon will have to read all files even if they normally would not
231 be saved. This increases the I/O load, but also the accuracy of the
232 deduplication. By default, Bacula will check modification/creation time
235 This project was funded by Bacula Systems.
237 \section{Tab-completion for Bconsole}
238 \label{sec:tabcompletion}
240 If you build \texttt{bconsole} with readline support, you will be able to use
241 the new auto-completion mode. This mode supports all commands, gives help
242 inside command, and lists resources when required. It works also in the restore
245 To use this feature, you should have readline development package loaded on
246 your system, and use the following option in configure.
248 ./configure --with-readline=/usr/include/readline --disable-conio ...
251 The new bconsole won't be able to tab-complete with older directors.
253 This project was funded by Bacula Systems.
255 \section{Pool File and Job retention}
256 \label{sec:poolfilejobretention}
259 We added two new Pool directives, \texttt{FileRetention} and
260 \texttt{JobRetention}, that take precedence over Client directives of the same
261 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
262 example, you can decide to increase Retention times for Archive or OffSite Pool.
264 \section{Read-only File Daemon using capabilities}
265 \label{sec:fdreadonly}
266 This feature implements support of keeping \textbf{ReadAll} capabilities after
267 UID/GID switch, this allows FD to keep root read but drop write permission.
269 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
270 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
273 root@localhost:~# bacula-fd -k -u nobody -g nobody
276 The code for this feature was contributed by our friends at AltLinux.
281 To help developers of restore GUI interfaces, we have added new \textsl{dot
282 commands} that permit browsing the catalog in a very simple way.
285 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
286 the Bvfs cache in the catalog. You need to run it before any access to the
289 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
290 will list all directories in the specified \texttt{path} or
291 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
292 encoding of path/filenames.
294 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
295 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
296 \texttt{pathid} avoids problems with character encoding.
299 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
300 data that will be displayed.
303 * .bvfs_update jobid=1,2
305 * .bvfs_lsdir path=/ jobid=1,2
308 This project was funded by Bacula Systems.
310 \section{Testing your Tape Drive}
311 \label{sec:btapespeed}
313 To determine the best configuration of your tape drive, you can run the new
314 \texttt{speed} command available in the \texttt{btape} program.
316 This command can have the following arguments:
318 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
319 (between 1 and 5GB). This counter is in GB.
320 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
321 of data should be greater than your memory ($file\_size*nb\_file$).
322 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
324 \item[\texttt{skip\_random}] This flag permits to skip tests with random
326 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
327 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
332 *speed file_size=3 skip_raw
333 btape.c:1078 Test with zero data and bacula block structure.
334 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
335 ++++++++++++++++++++++++++++++++++++++++++
336 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
337 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
339 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
341 btape.c:1090 Test with random data, should give the minimum throughput.
342 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
343 +++++++++++++++++++++++++++++++++++++++++++
344 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
345 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
346 +++++++++++++++++++++++++++++++++++++++++++
348 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
352 When using compression, the random test will give your the minimum throughput
353 of your drive . The test using constant string will give you the maximum speed
354 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
356 You can change the block size in the Storage Daemon configuration file.
358 \section{New {\bf Block Checksum} Device Directive}
359 You may now turn off the Block Checksum (CRC32) code
360 that Bacula uses when writing blocks to a Volume. This is
367 doing so can reduce the Storage daemon CPU usage slightly. It
368 will also permit Bacula to read a Volume that has corrupted data.
370 The default is {\bf yes} -- i.e. the checksum is computed on write
373 We do not recommend to turn this off particularly on older tape
374 drives or for disk Volumes where doing so may allow corrupted data
377 \section{New Bat Features}
379 Those new features were funded by Bacula Systems.
381 \subsection{Media List View}
383 By clicking on ``Media'', you can see the list of all your volumes. You will be
384 able to filter by Pool, Media Type, Location,\dots And sort the result directly
385 in the table. The old ``Media'' view is now known as ``Pool''.
388 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
389 \label{fig:mediaview}
393 \subsection{Media Information View}
395 By double-clicking on a volume (on the Media list, in the Autochanger content
396 or in the Job information panel), you can access a detailed overview of your
397 Volume. (cf \ref{fig:mediainfo}.)
400 \includegraphics[width=13cm]{\idir bat11.eps}
401 \caption{Media information}
402 \label{fig:mediainfo}
405 \subsection{Job Information View}
407 By double-clicking on a Job record (on the Job run list or in the Media
408 information panel), you can access a detailed overview of your Job. (cf
412 \includegraphics[width=13cm]{\idir bat12.eps}
413 \caption{Job information}
417 \subsection{Autochanger Content View}
419 By double-clicking on a Storage record (on the Storage list panel), you can
420 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
423 \includegraphics[width=13cm]{\idir bat13.eps}
424 \caption{Autochanger content}
425 \label{fig:achcontent}
428 To use this feature, you need to use the latest mtx-changer script
429 version. (With new \texttt{listall} and \texttt{transfer} commands)
431 \section{Bat on Windows}
432 We have ported {\bf bat} to Windows and it is now installed
433 by default when the installer is run. It works quite well
434 on Win32, but has not had a lot of testing there, so your
435 feedback would be welcome. Unfortunately, eventhough it is
436 installed by default, it does not yet work on 64 bit Windows
439 \section{New Win32 Installer}
440 The Win32 installer has been modified in several very important
443 \item You must deinstall any current version of the
444 Win32 File daemon before upgrading to the new one.
445 If you forget to do so, the new installation will fail.
446 To correct this failure, you must manually shutdown
447 and deinstall the old File daemon.
448 \item All files (other than menu links) are installed
449 in {\bf c:/Program Files/Bacula}.
450 \item The installer no longer sets this
451 file to require administrator privileges by default. If you want
452 to do so, please do it manually using the {\bf cacls} program.
455 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
457 \item The server daemons (Director and Storage daemon) are
458 no longer included in the Windows installer. If you want the
459 Windows servers, you will either need to build them yourself (note
460 they have not been ported to 64 bits), or you can contact
461 Bacula Systems about this.
464 \section{Win64 Installer}
465 We have corrected a number of problems that required manual
466 editing of the conf files. In most cases, it should now
467 install and work. {\bf bat} is by default installed in
468 {\bf c:/Program Files/Bacula/bin32} rather than
469 {\bf c:/Program Files/Bacula} as is the case with the 32
470 bit Windows installer.
472 \section{Linux Bare Metal Recovery USB Key}
473 We have made a number of significant improvements in the
474 Bare Metal Recovery USB key. Please see the README files
475 it the {\bf rescue} release for more details.
477 We are working on an equivalent USB key for Windows bare
478 metal recovery, but it will take some time to develop it (best
479 estimate 3Q2010 or 4Q2010)
482 \section{bconsole Timeout Option}
483 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
484 for commands. This is useful with GUI programs that use {\bf bconsole}
485 to interface to the Director.
487 \section{Important Changes}
488 \label{sec:importantchanges}
491 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
492 to the same Pool. The Storage daemon ensures that you do not read and
493 write to the same Volume.
494 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
496 \item Virtually all the features of {\bf mtx-changer} have
497 now been parameterized, which allows you to configure
498 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
499 that contains variables that you can set to configure mtx-changer.
500 This configuration file will not be overwritten during upgrades.
501 We encourage you to submit any changes
502 that are made to mtx-changer and to parameterize it all in
503 mtx-changer.conf so that all configuration will be done by
504 changing only mtx-changer.conf.
505 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
506 and \texttt{transfer}. Please configure them as appropriate
508 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
509 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
510 password. If you want to use the new script, you will need to
511 manually change the \texttt{BackupCatalog} Job definition.
512 \item The \texttt{bconsole} \texttt{help} command now accepts
513 an argument, which if provided produces information on that
514 command (ex: \texttt{help run}).
518 \subsubsection*{Truncate volume after purge}
520 Note that the Truncate Volume after purge feature doesn't work as expected
521 in 5.0.0 version. Please, don't use it before version 5.0.1.
523 \subsection{Custom Catalog queries}
525 If you wish to add specialized commands that list the contents of the catalog,
526 you can do so by adding them to the \texttt{query.sql} file. This
527 \texttt{query.sql} file is now empty by default. The file
528 \texttt{examples/sample-query.sql} has an a number of sample commands
529 you might find useful.
531 \subsection{Deprecated parts}
533 The following items have been \textbf{deprecated} for a long time, and are now
534 removed from the code.
537 \item Support for SQLite 2
540 \section{Misc Changes}
541 \label{sec:miscchanges}
544 \item Updated Nagios check\_bacula
545 \item Updated man files
546 \item Added OSX package generation script in platforms/darwin
547 \item Added Spanish and Ukrainian Bacula translations
548 \item Enable/disable command shows only Jobs that can change
549 \item Added \texttt{show disabled} command to show disabled Jobs
550 \item Many ACL improvements
551 \item Added Level to FD status Job output
552 \item Begin Ingres DB driver (not yet working)
553 \item Split RedHat spec files into bacula, bat, mtx, and docs
554 \item Reorganized the manuals (fewer separate manuals)
555 \item Added lock/unlock order protection in lock manager
556 \item Allow 64 bit sizes for a number of variables
557 \item Fixed several deadlocks or potential race conditions in the SD
560 \chapter{Released Version 3.0.3 and 3.0.3a}
562 There are no new features in version 3.0.3. This version simply fixes a
563 number of bugs found in version 3.0.2 during the onging development
566 \chapter{New Features in Released Version 3.0.2}
568 This chapter presents the new features added to the
569 Released Bacula Version 3.0.2.
571 \section{Full Restore from a Given JobId}
572 \index[general]{Restore menu}
574 This feature allows selecting a single JobId and having Bacula
575 automatically select all the other jobs that comprise a full backup up to
576 and including the selected date (through JobId).
578 Assume we start with the following jobs:
580 +-------+--------------+---------------------+-------+----------+------------+
581 | jobid | client | starttime | level | jobfiles | jobbytes |
582 +-------+--------------+---------------------+-------+----------+------------
583 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
584 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
585 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
586 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
587 +-------+--------------+---------------------+-------+----------+------------+
590 Below is an example of this new feature (which is number 12 in the
595 To select the JobIds, you have the following choices:
596 1: List last 20 Jobs run
597 2: List Jobs where a given File is saved
599 12: Select full restore to a specified Job date
602 Select item: (1-13): 12
603 Enter JobId to get the state to restore: 5
604 Selecting jobs to build the Full state at 2009-07-15 11:45:45
605 You have selected the following JobIds: 1,3,5
607 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
608 1,444 files inserted into the tree.
611 This project was funded by Bacula Systems.
613 \section{Source Address}
614 \index[general]{Source Address}
616 A feature has been added which allows the administrator to specify the address
617 from which the Director and File daemons will establish connections. This
618 may be used to simplify system configuration overhead when working in complex
619 networks utilizing multi-homing and policy-routing.
621 To accomplish this, two new configuration directives have been implemented:
624 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
628 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
632 Simply adding specific host routes on the OS
633 would have an undesirable side-effect: any
634 application trying to contact the destination host would be forced to use the
635 more specific route possibly diverting management traffic onto a backup VLAN.
636 Instead of adding host routes for each client connected to a multi-homed backup
637 server (for example where there are management and backup VLANs), one can
638 use the new directives to specify a specific source address at the application
641 Additionally, this allows the simplification and abstraction of firewall rules
642 when dealing with a Hot-Standby director or storage daemon configuration. The
643 Hot-standby pair may share a CARP address, which connections must be sourced
644 from, while system services listen and act from the unique interface addresses.
646 This project was funded by Collaborative Fusion, Inc.
648 \section{Show volume availability when doing restore}
650 When doing a restore the selection dialog ends by displaying this
654 The job will require the following
655 Volume(s) Storage(s) SD Device(s)
656 ===========================================================================
667 Volumes marked with ``*'' are online (in the autochanger).
670 This should help speed up large restores by minimizing the time spent
671 waiting for the operator to discover that he must change tapes in the library.
673 This project was funded by Bacula Systems.
675 \section{Accurate estimate command}
677 The \texttt{estimate} command can now use the accurate code to detect changes
678 and give a better estimation.
680 You can set the accurate behavior on the command line by using
681 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
684 * estimate listing accurate=yes level=incremental job=BackupJob
687 This project was funded by Bacula Systems.
689 \chapter{New Features in 3.0.0}
690 \label{NewFeaturesChapter}
691 \index[general]{New Features}
693 This chapter presents the new features added to the development 2.5.x
694 versions to be released as Bacula version 3.0.0 sometime in April 2009.
696 \section{Accurate Backup}
697 \index[general]{Accurate Backup}
699 As with most other backup programs, by default Bacula decides what files to
700 backup for Incremental and Differental backup by comparing the change
701 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
702 backup completed. If one of those two times is later than the last backup
703 time, then the file will be backed up. This does not, however, permit tracking
704 what files have been deleted and will miss any file with an old time that may
705 have been restored to or moved onto the client filesystem.
707 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
708 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
709 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
710 backup, there is no difference, but for {\bf Differential} and {\bf
711 Incremental} backups, the Director will send a list of all previous files
712 backed up, and the File daemon will use that list to determine if any new files
713 have been added or or moved and if any files have been deleted. This allows
714 Bacula to make an accurate backup of your system to that point in time so that
715 if you do a restore, it will restore your system exactly.
718 about using Accurate backup is that it requires more resources (CPU and memory)
719 on both the Director and the Client machines to create the list of previous
720 files backed up, to send that list to the File daemon, for the File daemon to
721 keep the list (possibly very big) in memory, and for the File daemon to do
722 comparisons between every file in the FileSet and the list. In particular,
723 if your client has lots of files (more than a few million), you will need
724 lots of memory on the client machine.
726 Accurate must not be enabled when backing up with a plugin that is not
727 specially designed to work with Accurate. If you enable it, your restores
728 will probably not work correctly.
730 This project was funded by Bacula Systems.
735 \index[general]{Copy Jobs}
737 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
738 existing Migration feature with the exception that the Job that is copied is
739 left unchanged. This essentially creates two identical copies of the same
740 backup. However, the copy is treated as a copy rather than a backup job, and
741 hence is not directly available for restore. The {\bf restore} command lists
742 copy jobs and allows selection of copies by using \texttt{jobid=}
743 option. If the keyword {\bf copies} is present on the command line, Bacula will
744 display the list of all copies for selected jobs.
749 These JobIds have copies as follows:
750 +-------+------------------------------------+-----------+------------------+
751 | JobId | Job | CopyJobId | MediaType |
752 +-------+------------------------------------+-----------+------------------+
753 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
754 +-------+------------------------------------+-----------+------------------+
755 +-------+-------+----------+----------+---------------------+------------------+
756 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
757 +-------+-------+----------+----------+---------------------+------------------+
758 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
759 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
760 +-------+-------+----------+----------+---------------------+------------------+
761 You have selected the following JobIds: 19,2
763 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
764 5,611 files inserted into the tree.
769 The Copy Job runs without using the File daemon by copying the data from the
770 old backup Volume to a different Volume in a different Pool. See the Migration
771 documentation for additional details. For copy Jobs there is a new selection
772 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
773 not already copied to another Pool.
775 As with Migration, the Client, Volume, Job, or SQL query, are
776 other possible ways of selecting the Jobs to be copied. Selection
777 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
778 work, but are probably more suited for Migration Jobs.
780 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
781 it will promote the Copy to a \textsl{real} backup job and will make it available for
782 automatic restore. If more than one Copy is available, it will promote the copy
783 with the smallest JobId.
785 A nice solution which can be built with the new Copy feature is often
786 called disk-to-disk-to-tape backup (DTDTT). A sample config could
787 look something like the one below:
791 Name = FullBackupsVirtualPool
793 Purge Oldest Volume = Yes
795 NextPool = FullBackupsTapePool
799 Name = FullBackupsTapePool
803 Volume Retention = 365 days
804 Storage = superloader
808 # Fake fileset for copy jobs
820 # Fake client for copy jobs
830 # Default template for a CopyDiskToTape Job
833 Name = CopyDiskToTape
835 Messages = StandardCopy
838 Selection Type = PoolUncopiedJobs
839 Maximum Concurrent Jobs = 10
841 Allow Duplicate Jobs = Yes
842 Cancel Queued Duplicates = No
843 Cancel Running Duplicates = No
848 Name = DaySchedule7:00
849 Run = Level=Full daily at 7:00
853 Name = CopyDiskToTapeFullBackups
855 Schedule = DaySchedule7:00
856 Pool = FullBackupsVirtualPool
857 JobDefs = CopyDiskToTape
861 The example above had 2 pool which are copied using the PoolUncopiedJobs
862 selection criteria. Normal Full backups go to the Virtual pool and are copied
863 to the Tape pool the next morning.
865 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
870 +-------+------------------------------------+-----------+------------------+
871 | JobId | Job | CopyJobId | MediaType |
872 +-------+------------------------------------+-----------+------------------+
873 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
874 +-------+------------------------------------+-----------+------------------+
877 \section{ACL Updates}
878 \index[general]{ACL Updates}
879 The whole ACL code had been overhauled and in this version each platforms has
880 different streams for each type of acl available on such an platform. As ACLs
881 between platforms tend to be not that portable (most implement POSIX acls but
882 some use an other draft or a completely different format) we currently only
883 allow certain platform specific ACL streams to be decoded and restored on the
884 same platform that they were created on. The old code allowed to restore ACL
885 cross platform but the comments already mention that not being to wise. For
886 backward compatability the new code will accept the two old ACL streams and
887 handle those with the platform specific handler. But for all new backups it
888 will save the ACLs using the new streams.
890 Currently the following platforms support ACLs:
894 \item {\bf Darwin/OSX}
903 Currently we support the following ACL types (these ACL streams use a reserved
904 part of the stream numbers):
907 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
909 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
910 string representation from acl\_to\_text (POSIX acl)
911 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
912 string representation from acl\_to\_text (POSIX acl) for default acls.
913 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
914 string representation from acl\_to\_text (POSIX acl) for access acls.
915 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
916 string representation from acltostr (POSIX acl)
917 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
918 representation from acl\_to\_text (POSIX acl) for default acls.
919 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
920 representation from acl\_to\_text (POSIX acl) for access acls.
921 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
922 string representation from acl\_to\_text (POSIX acl) for default acls.
923 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
924 representation from acl\_to\_text (POSIX acl) for access acls.
925 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
926 string representation from acl\_to\_text (POSIX acl) for default acls.
927 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
928 string representation from acl\_to\_text (POSIX acl) for default acls.
929 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
930 representation from acl\_to\_text (POSIX acl) for access acls.
931 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
932 string representation from acltotext or acl\_totext (POSIX acl)
933 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
934 representation from from acl\_totext (NFSv4 or ZFS acl)
937 In future versions we might support conversion functions from one type of acl
938 into an other for types that are either the same or easily convertable. For now
939 the streams are seperate and restoring them on a platform that doesn't
940 recognize them will give you a warning.
942 \section{Extended Attributes}
943 \index[general]{Extended Attributes}
944 Something that was on the project list for some time is now implemented for
945 platforms that support a similar kind of interface. Its the support for backup
946 and restore of so called extended attributes. As extended attributes are so
947 platform specific these attributes are saved in seperate streams for each
948 platform. Restores of the extended attributes can only be performed on the
949 same platform the backup was done. There is support for all types of extended
950 attributes, but restoring from one type of filesystem onto an other type of
951 filesystem on the same platform may lead to supprises. As extended attributes
952 can contain any type of data they are stored as a series of so called
953 value-pairs. This data must be seen as mostly binary and is stored as such.
954 As security labels from selinux are also extended attributes this option also
955 stores those labels and no specific code is enabled for handling selinux
958 Currently the following platforms support extended attributes:
960 \item {\bf Darwin/OSX}
966 On linux acls are also extended attributes, as such when you enable ACLs on a
967 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
968 and not the same exteneded attribute.
970 To enable the backup of extended attributes please add the following to your
985 \section{Shared objects}
986 \index[general]{Shared objects}
987 A default build of Bacula will now create the libraries as shared objects
988 (.so) rather than static libraries as was previously the case.
989 The shared libraries are built using {\bf libtool} so it should be quite
992 An important advantage of using shared objects is that on a machine with the
993 Directory, File daemon, the Storage daemon, and a console, you will have only
994 one copy of the code in memory rather than four copies. Also the total size of
995 the binary release is smaller since the library code appears only once rather
996 than once for every program that uses it; this results in significant reduction
997 in the size of the binaries particularly for the utility tools.
999 In order for the system loader to find the shared objects when loading the
1000 Bacula binaries, the Bacula shared objects must either be in a shared object
1001 directory known to the loader (typically /usr/lib) or they must be in the
1002 directory that may be specified on the {\bf ./configure} line using the {\bf
1003 {-}{-}libdir} option as:
1006 ./configure --libdir=/full-path/dir
1009 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1010 no need to modify your loader configuration provided that
1011 the shared objects are installed in that directory (Bacula
1012 does this with the make install command). The shared objects
1013 that Bacula references are:
1022 These files are symbolically linked to the real shared object file,
1023 which has a version number to permit running multiple versions of
1024 the libraries if desired (not normally the case).
1026 If you have problems with libtool or you wish to use the old
1027 way of building static libraries, or you want to build a static
1028 version of Bacula you may disable
1029 libtool on the configure command line with:
1032 ./configure --disable-libtool
1036 \section{Building Static versions of Bacula}
1037 \index[general]{Static linking}
1038 In order to build static versions of Bacula, in addition
1039 to configuration options that were needed you now must
1040 also add --disable-libtool. Example
1043 ./configure --enable-static-client-only --disable-libtool
1047 \section{Virtual Backup (Vbackup)}
1048 \index[general]{Virtual Backup}
1049 \index[general]{Vbackup}
1051 Bacula's virtual backup feature is often called Synthetic Backup or
1052 Consolidation in other backup products. It permits you to consolidate the
1053 previous Full backup plus the most recent Differential backup and any
1054 subsequent Incremental backups into a new Full backup. This new Full
1055 backup will then be considered as the most recent Full for any future
1056 Incremental or Differential backups. The VirtualFull backup is
1057 accomplished without contacting the client by reading the previous backup
1058 data and writing it to a volume in a different pool.
1060 In some respects the Vbackup feature works similar to a Migration job, in
1061 that Bacula normally reads the data from the pool specified in the
1062 Job resource, and writes it to the {\bf Next Pool} specified in the
1063 Job resource. Note, this means that usually the output from the Virtual
1064 Backup is written into a different pool from where your prior backups
1065 are saved. Doing it this way guarantees that you will not get a deadlock
1066 situation attempting to read and write to the same volume in the Storage
1067 daemon. If you then want to do subsequent backups, you may need to
1068 move the Virtual Full Volume back to your normal backup pool.
1069 Alternatively, you can set your {\bf Next Pool} to point to the current
1070 pool. This will cause Bacula to read and write to Volumes in the
1071 current pool. In general, this will work, because Bacula will
1072 not allow reading and writing on the same Volume. In any case, once
1073 a VirtualFull has been created, and a restore is done involving the
1074 most current Full, it will read the Volume or Volumes by the VirtualFull
1075 regardless of in which Pool the Volume is found.
1077 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1078 a level of {\bf VirtualFull}.
1080 A typical Job resource definition might look like the following:
1087 FileSet = "Full Set"
1094 # Default pool definition
1098 Recycle = yes # Automatically recycle Volumes
1099 AutoPrune = yes # Prune expired volumes
1100 Volume Retention = 365d # one year
1108 Recycle = yes # Automatically recycle Volumes
1109 AutoPrune = yes # Prune expired volumes
1110 Volume Retention = 365d # one year
1111 Storage = DiskChanger
1114 # Definition of file storage device
1119 Device = FileStorage
1121 Maximum Concurrent Jobs = 5
1124 # Definition of DDS Virtual tape disk storage device
1127 Address = localhost # N.B. Use a fully qualified name here
1129 Device = DiskChanger
1130 Media Type = DiskChangerMedia
1131 Maximum Concurrent Jobs = 4
1136 Then in bconsole or via a Run schedule, you would run the job as:
1139 run job=MyBackup level=Full
1140 run job=MyBackup level=Incremental
1141 run job=MyBackup level=Differential
1142 run job=MyBackup level=Incremental
1143 run job=MyBackup level=Incremental
1146 So providing there were changes between each of those jobs, you would end up
1147 with a Full backup, a Differential, which includes the first Incremental
1148 backup, then two Incremental backups. All the above jobs would be written to
1149 the {\bf Default} pool.
1151 To consolidate those backups into a new Full backup, you would run the
1155 run job=MyBackup level=VirtualFull
1158 And it would produce a new Full backup without using the client, and the output
1159 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1161 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1164 Note, the Start and End time of the Virtual Full backup is set to the
1165 values for the last job included in the Virtual Full (in the above example,
1166 it is an Increment). This is so that if another incremental is done, which
1167 will be based on the Virtual Full, it will backup all files from the
1168 last Job included in the Virtual Full rather than from the time the Virtual
1169 Full was actually run.
1173 \section{Catalog Format}
1174 \index[general]{Catalog Format}
1175 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1176 operation will convert the FileId field of the File table from 32 bits (max 4
1177 billion table entries) to 64 bits (very large number of items). The
1178 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1179 your catalog during the conversion. Also you won't be able to run jobs during
1180 this conversion period. For example, a 3 million file catalog will take 2
1181 minutes to upgrade on a normal machine. Please don't forget to make a valid
1182 backup of your database before executing the upgrade script. See the
1183 ReleaseNotes for additional details.
1185 \section{64 bit Windows Client}
1186 \index[general]{Win64 Client}
1187 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1188 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1189 As a consequence, we are also releasing a 64 bit version of the Bacula
1190 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1191 These binaries should only be installed on 64 bit Windows operating systems.
1192 What is important is not your hardware but whether or not you have
1193 a 64 bit version of the Windows OS.
1195 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1197 \item Before installing the Win64 Bacula Client, you must totally
1198 deinstall any prior 2.4.x Client installation using the
1199 Bacula deinstallation (see the menu item). You may want
1200 to save your .conf files first.
1201 \item Only the Client (File daemon) is ported to Win64, the Director
1202 and the Storage daemon are not in the 64 bit Windows installer.
1203 \item bwx-console is not yet ported.
1204 \item bconsole is ported but it has not been tested.
1205 \item The documentation is not included in the installer.
1206 \item Due to Vista security restrictions imposed on a default installation
1207 of Vista, before upgrading the Client, you must manually stop
1208 any prior version of Bacula from running, otherwise the install
1210 \item Due to Vista security restrictions imposed on a default installation
1211 of Vista, attempting to edit the conf files via the menu items
1212 will fail. You must directly edit the files with appropriate
1213 permissions. Generally double clicking on the appropriate .conf
1214 file will work providing you have sufficient permissions.
1215 \item All Bacula files are now installed in
1216 {\bf C:/Program Files/Bacula} except the main menu items,
1217 which are installed as before. This vastly simplifies the installation.
1218 \item If you are running on a foreign language version of Windows, most
1219 likely {\bf C:/Program Files} does not exist, so you should use the
1220 Custom installation and enter an appropriate location to install
1222 \item The 3.0.0 Win32 Client continues to install files in the locations used
1223 by prior versions. For the next version we will convert it to use
1224 the same installation conventions as the Win64 version.
1227 This project was funded by Bacula Systems.
1230 \section{Duplicate Job Control}
1231 \index[general]{Duplicate Jobs}
1232 The new version of Bacula provides four new directives that
1233 give additional control over what Bacula does if duplicate jobs
1234 are started. A duplicate job in the sense we use it here means
1235 a second or subsequent job with the same name starts. This
1236 happens most frequently when the first job runs longer than expected because no
1237 tapes are available.
1239 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1240 are specified in the Job resource.
1244 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1245 \index[general]{Allow Duplicate Jobs}
1246 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1247 the directive is set to {\bf no} (default) then only one job of a given name
1248 may run at one time, and the action that Bacula takes to ensure only
1249 one job runs is determined by the other directives (see below).
1251 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1252 are present and none of the three directives given below permit
1253 cancelling a job, then the current job (the second one started)
1256 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1257 \index[general]{Allow Higher Duplicates}
1258 This directive was in version 5.0.0, but does not work as
1259 expected. If used, it should always be set to no. In later versions
1260 of Bacula the directive is disabled (disregarded).
1262 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1263 \index[general]{Cancel Running Duplicates}
1264 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1265 if this directive is set to {\bf yes} any job that is already running
1266 will be canceled. The default is {\bf no}.
1268 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1269 \index[general]{Cancel Queued Duplicates}
1270 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1271 if this directive is set to {\bf yes} any job that is
1272 already queued to run but not yet running will be canceled.
1273 The default is {\bf no}.
1276 \section{TLS Authentication}
1277 \index[general]{TLS Authentication}
1278 In Bacula version 2.5.x and later, in addition to the normal Bacula
1279 CRAM-MD5 authentication that is used to authenticate each Bacula
1280 connection, you can specify that you want TLS Authentication as well,
1281 which will provide more secure authentication.
1283 This new feature uses Bacula's existing TLS code (normally used for
1284 communications encryption) to do authentication. To use it, you must
1285 specify all the TLS directives normally used to enable communications
1286 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1289 \subsection{TLS Authenticate = yes}
1291 TLS Authenticate = yes
1294 in the main daemon configuration resource (Director for the Director,
1295 Client for the File daemon, and Storage for the Storage daemon).
1297 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1298 authentication, Bacula will also do TLS authentication, then TLS
1299 encryption will be turned off, and the rest of the communication between
1300 the two Bacula daemons will be done without encryption.
1302 If you want to encrypt communications data, use the normal TLS directives
1303 but do not turn on {\bf TLS Authenticate}.
1305 \section{bextract non-portable Win32 data}
1306 \index[general]{bextract handles Win32 non-portable data}
1307 {\bf bextract} has been enhanced to be able to restore
1308 non-portable Win32 data to any OS. Previous versions were
1309 unable to restore non-portable Win32 data to machines that
1310 did not have the Win32 BackupRead and BackupWrite API calls.
1312 \section{State File updated at Job Termination}
1313 \index[general]{State File}
1314 In previous versions of Bacula, the state file, which provides a
1315 summary of previous jobs run in the {\bf status} command output was
1316 updated only when Bacula terminated, thus if the daemon crashed, the
1317 state file might not contain all the run data. This version of
1318 the Bacula daemons updates the state file on each job termination.
1320 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1321 \index[general]{MaxFullInterval}
1322 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1323 can be used to specify the maximum time interval between {\bf Full} backup
1324 jobs. When a job starts, if the time since the last Full backup is
1325 greater than the specified interval, and the job would normally be an
1326 {\bf Incremental} or {\bf Differential}, it will be automatically
1327 upgraded to a {\bf Full} backup.
1329 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1330 \index[general]{MaxDiffInterval}
1331 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1332 can be used to specify the maximum time interval between {\bf Differential} backup
1333 jobs. When a job starts, if the time since the last Differential backup is
1334 greater than the specified interval, and the job would normally be an
1335 {\bf Incremental}, it will be automatically
1336 upgraded to a {\bf Differential} backup.
1338 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1339 \index[general]{MaxDiffInterval}
1340 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1341 by the user, and when it is set it is an indication to backup programs
1342 to not backup that particular file. This version of Bacula contains a
1343 new Options directive within a FileSet resource, which instructs Bacula to
1344 obey this flag. The new directive is:
1347 Honor No Dump Flag = yes\vb{}no
1350 The default value is {\bf no}.
1353 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1354 \index[general]{IgnoreDir}
1355 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1356 can be added to the Include section of the FileSet resource. If the specified
1357 filename ({\bf filename-string}) is found on the Client in any directory to be
1358 backed up, the whole directory will be ignored (not backed up). For example:
1361 # List of files to be backed up
1369 Exclude Dir Containing = .excludeme
1374 But in /home, there may be hundreds of directories of users and some
1375 people want to indicate that they don't want to have certain
1376 directories backed up. For example, with the above FileSet, if
1377 the user or sysadmin creates a file named {\bf .excludeme} in
1378 specific directories, such as
1381 /home/user/www/cache/.excludeme
1382 /home/user/temp/.excludeme
1385 then Bacula will not backup the two directories named:
1388 /home/user/www/cache
1392 NOTE: subdirectories will not be backed up. That is, the directive
1393 applies to the two directories in question and any children (be they
1394 files, directories, etc).
1397 \section{Bacula Plugins}
1398 \index[general]{Plugin}
1399 Support for shared object plugins has been implemented in the Linux, Unix
1400 and Win32 File daemons. The API will be documented separately in
1401 the Developer's Guide or in a new document. For the moment, there is
1402 a single plugin named {\bf bpipe} that allows an external program to
1403 get control to backup and restore a file.
1405 Plugins are also planned (partially implemented) in the Director and the
1408 \subsection{Plugin Directory}
1409 \index[general]{Plugin Directory}
1410 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1411 be added to the daemon definition resource. The directory takes a quoted
1412 string argument, which is the name of the directory in which the daemon can
1413 find the Bacula plugins. If this directive is not specified, Bacula will not
1414 load any plugins. Since each plugin has a distinctive name, all the daemons
1415 can share the same plugin directory.
1417 \subsection{Plugin Options}
1418 \index[general]{Plugin Options}
1419 The {\bf Plugin Options} directive takes a quoted string
1420 arguement (after the equal sign) and may be specified in the
1421 Job resource. The options specified will be passed to all plugins
1422 when they are run. This each plugin must know what it is looking
1423 for. The value defined in the Job resource can be modified
1424 by the user when he runs a Job via the {\bf bconsole} command line
1427 Note: this directive may be specified, and there is code to modify
1428 the string in the run command, but the plugin options are not yet passed to
1429 the plugin (i.e. not fully implemented).
1431 \subsection{Plugin Options ACL}
1432 \index[general]{Plugin Options ACL}
1433 The {\bf Plugin Options ACL} directive may be specified in the
1434 Director's Console resource. It functions as all the other ACL commands
1435 do by permitting users running restricted consoles to specify a
1436 {\bf Plugin Options} that overrides the one specified in the Job
1437 definition. Without this directive restricted consoles may not modify
1440 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1441 \index[general]{Plugin}
1442 The {\bf Plugin} directive is specified in the Include section of
1443 a FileSet resource where you put your {\bf File = xxx} directives.
1454 Plugin = "bpipe:..."
1459 In the above example, when the File daemon is processing the directives
1460 in the Include section, it will first backup all the files in {\bf /home}
1461 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1462 the Plugin Directory. The syntax and semantics of the Plugin directive
1463 require the first part of the string up to the colon (:) to be the name
1464 of the plugin. Everything after the first colon is ignored by the File daemon but
1465 is passed to the plugin. Thus the plugin writer may define the meaning of the
1466 rest of the string as he wishes.
1468 Please see the next section for information about the {\bf bpipe} Bacula
1471 \section{The bpipe Plugin}
1472 \index[general]{The bpipe Plugin}
1473 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1474 the Bacula source distribution. When the plugin is compiled and linking into
1475 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1477 The purpose of the plugin is to provide an interface to any system program for
1478 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1479 the Include section of your Job's FileSet resource. The full syntax of the
1480 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1481 to specify the sytax as it wishes) is:
1484 Plugin = "<field1>:<field2>:<field3>:<field4>"
1489 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1490 stripped off, so in this case, we would put {\bf bpipe} in this field.
1492 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1493 pseudo path and filename under which the backup will be saved. This pseudo
1494 path and filename will be seen by the user in the restore file tree.
1495 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1496 backed up by the plugin will be put under that "pseudo" path and filename.
1497 You must be careful to choose a naming convention that is unique to avoid
1498 a conflict with a path and filename that actually exists on your system.
1500 \item {\bf field3} for the {\bf bpipe} plugin
1501 specifies the "reader" program that is called by the plugin during
1502 backup to read the data. {\bf bpipe} will call this program by doing a
1505 \item {\bf field4} for the {\bf bpipe} plugin
1506 specifies the "writer" program that is called by the plugin during
1507 restore to write the data back to the filesystem.
1510 Putting it all together, the full plugin directive line might look
1514 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1515 --opt --databases bacula:mysql"
1518 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1519 would be written on a single line.
1521 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1522 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1523 program {\bf mysqldump -f --opt --database bacula} to read the data during
1524 backup. The mysqldump command outputs all the data for the database named
1525 {\bf bacula}, which will be read by the plugin and stored in the backup.
1526 During restore, the data that was backed up will be sent to the program
1527 specified in the last field, which in this case is {\bf mysql}. When
1528 {\bf mysql} is called, it will read the data sent to it by the plugn
1529 then write it back to the same database from which it came ({\bf bacula}
1532 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1533 the data from a specified program to Bacula for backup, and then from Bacula to
1534 a specified program for restore.
1536 By using different command lines to {\bf bpipe},
1537 you can backup any kind of data (ASCII or binary) depending
1538 on the program called.
1540 \section{Microsoft Exchange Server 2003/2007 Plugin}
1541 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1542 \subsection{Background}
1543 The Exchange plugin was made possible by a funded development project
1544 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1545 The code for the plugin was written by James Harper, and the Bacula core
1546 code by Kern Sibbald. All the code for this funded development has become
1547 part of the Bacula project. Thanks to everyone who made it happen.
1549 \subsection{Concepts}
1550 Although it is possible to backup Exchange using Bacula VSS the Exchange
1551 plugin adds a good deal of functionality, because while Bacula VSS
1552 completes a full backup (snapshot) of Exchange, it does
1553 not support Incremental or Differential backups, restoring is more
1554 complicated, and a single database restore is not possible.
1556 Microsoft Exchange organises its storage into Storage Groups with
1557 Databases inside them. A default installation of Exchange will have a
1558 single Storage Group called 'First Storage Group', with two Databases
1559 inside it, "Mailbox Store (SERVER NAME)" and
1560 "Public Folder Store (SERVER NAME)",
1561 which hold user email and public folders respectively.
1563 In the default configuration, Exchange logs everything that happens to
1564 log files, such that if you have a backup, and all the log files since,
1565 you can restore to the present time. Each Storage Group has its own set
1566 of log files and operates independently of any other Storage Groups. At
1567 the Storage Group level, the logging can be turned off by enabling a
1568 function called "Enable circular logging". At this time the Exchange
1569 plugin will not function if this option is enabled.
1571 The plugin allows backing up of entire storage groups, and the restoring
1572 of entire storage groups or individual databases. Backing up and
1573 restoring at the individual mailbox or email item is not supported but
1574 can be simulated by use of the "Recovery" Storage Group (see below).
1576 \subsection{Installing}
1577 The Exchange plugin requires a DLL that is shipped with Microsoft
1578 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1579 correctly the Exchange plugin should find this automatically and run
1580 without any additional installation.
1582 If the DLL can not be found automatically it will need to be copied into
1583 the Bacula installation
1584 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1585 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1586 default Exchange installation.
1588 \subsection{Backing Up}
1589 To back up an Exchange server the Fileset definition must contain at
1590 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1591 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1592 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1593 up files are prefixed with something that isn't going to share a name
1594 with something outside the plugin, and the 'Microsoft Information Store'
1595 bit is required also. It is also possible to add the name of a storage
1596 group to the "Plugin =" line, eg \\
1597 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1598 if you want only a single storage group backed up.
1600 Additionally, you can suffix the 'Plugin =' directive with
1601 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1602 database at the end of a full backup.
1604 An Incremental or Differential backup will backup only the database logs
1605 for each Storage Group by inspecting the "modified date" on each
1606 physical log file. Because of the way the Exchange API works, the last
1607 logfile backed up on each backup will always be backed up by the next
1608 Incremental or Differential backup too. This adds 5MB to each
1609 Incremental or Differential backup size but otherwise does not cause any
1612 By default, a normal VSS fileset containing all the drive letters will
1613 also back up the Exchange databases using VSS. This will interfere with
1614 the plugin and Exchange's shared ideas of when the last full backup was
1615 done, and may also truncate log files incorrectly. It is important,
1616 therefore, that the Exchange database files be excluded from the backup,
1617 although the folders the files are in should be included, or they will
1618 have to be recreated manually if a baremetal restore is done.
1623 File = C:/Program Files/Exchsrvr/mdbdata
1624 Plugin = "exchange:..."
1627 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1628 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1629 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1630 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1631 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1632 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1633 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1638 The advantage of excluding the above files is that you can significantly
1639 reduce the size of your backup since all the important Exchange files
1640 will be properly saved by the Plugin.
1643 \subsection{Restoring}
1644 The restore operation is much the same as a normal Bacula restore, with
1645 the following provisos:
1648 \item The {\bf Where} restore option must not be specified
1649 \item Each Database directory must be marked as a whole. You cannot just
1650 select (say) the .edb file and not the others.
1651 \item If a Storage Group is restored, the directory of the Storage Group
1653 \item It is possible to restore only a subset of the available log files,
1654 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1655 if a log file is missing from the sequence of log files
1656 \item Each database to be restored must be dismounted and marked as "Can be
1657 overwritten by restore"
1658 \item If an entire Storage Group is to be restored (eg all databases and
1659 logs in the Storage Group), then it is best to manually delete the
1660 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1661 as Exchange can get confused by stray log files lying around.
1664 \subsection{Restoring to the Recovery Storage Group}
1665 The concept of the Recovery Storage Group is well documented by
1667 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1668 but to briefly summarize...
1670 Microsoft Exchange allows the creation of an additional Storage Group
1671 called the Recovery Storage Group, which is used to restore an older
1672 copy of a database (e.g. before a mailbox was deleted) into without
1673 messing with the current live data. This is required as the Standard and
1674 Small Business Server versions of Exchange can not ordinarily have more
1675 than one Storage Group.
1677 To create the Recovery Storage Group, drill down to the Server in Exchange
1678 System Manager, right click, and select
1679 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1680 locations and click OK. On the Recovery Storage Group, right click and
1681 select {\bf "Add Database to Recover..."} and select the database you will
1684 Restore only the single database nominated as the database in the
1685 Recovery Storage Group. Exchange will redirect the restore to the
1686 Recovery Storage Group automatically.
1687 Then run the restore.
1689 \subsection{Restoring on Microsoft Server 2007}
1690 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1691 2007, and henc you use a new proceedure for recovering a single mail box.
1692 This procedure is ducomented by Microsoft at:
1693 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1694 and involves using the {\bf Restore-Mailbox} and {\bf
1695 Get-MailboxStatistics} shell commands.
1697 \subsection{Caveats}
1698 This plugin is still being developed, so you should consider it
1699 currently in BETA test, and thus use in a production environment
1700 should be done only after very careful testing.
1702 When doing a full backup, the Exchange database logs are truncated by
1703 Exchange as soon as the plugin has completed the backup. If the data
1704 never makes it to the backup medium (eg because of spooling) then the
1705 logs will still be truncated, but they will also not have been backed
1706 up. A solution to this is being worked on. You will have to schedule a
1707 new Full backup to ensure that your next backups will be usable.
1709 The "Enable Circular Logging" option cannot be enabled or the plugin
1712 Exchange insists that a successful Full backup must have taken place if
1713 an Incremental or Differential backup is desired, and the plugin will
1714 fail if this is not the case. If a restore is done, Exchange will
1715 require that a Full backup be done before an Incremental or Differential
1718 The plugin will most likely not work well if another backup application
1719 (eg NTBACKUP) is backing up the Exchange database, especially if the
1720 other backup application is truncating the log files.
1722 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1723 we recommend either carefully testing or that you avoid this option for
1726 The Exchange plugin is not called during processing the bconsole {\bf
1727 estimate} command, and so anything that would be backed up by the plugin
1728 will not be added to the estimate total that is displayed.
1731 \section{libdbi Framework}
1732 \index[general]{libdbi Framework}
1733 As a general guideline, Bacula has support for a few catalog database drivers
1734 (MySQL, PostgreSQL, SQLite)
1735 coded natively by the Bacula team. With the libdbi implementation, which is a
1736 Bacula driver that uses libdbi to access the catalog, we have an open field to
1737 use many different kinds database engines following the needs of users.
1739 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1740 implements a database-independent abstraction layer in C, similar to the
1741 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1742 leverage the power of multiple databases and multiple simultaneous database
1743 connections by using this framework.
1745 Currently the libdbi driver in Bacula project only supports the same drivers
1746 natively coded in Bacula. However the libdbi project has support for many
1747 others database engines. You can view the list at
1748 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1749 supported by Bacula, however, they must be tested properly by the Bacula team.
1751 Some of benefits of using libdbi are:
1753 \item The possibility to use proprietary databases engines in which your
1754 proprietary licenses prevent the Bacula team from developing the driver.
1755 \item The possibility to use the drivers written for the libdbi project.
1756 \item The possibility to use other database engines without recompiling Bacula
1757 to use them. Just change one line in bacula-dir.conf
1758 \item Abstract Database access, this is, unique point to code and profiling
1759 catalog database access.
1762 The following drivers have been tested:
1764 \item PostgreSQL, with and without batch insert
1765 \item Mysql, with and without batch insert
1770 In the future, we will test and approve to use others databases engines
1771 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1773 To compile Bacula to support libdbi we need to configure the code with the
1774 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1775 [database] is the database engine to be used with Bacula (of course we can
1776 change the driver in file bacula-dir.conf, see below). We must configure the
1777 access port of the database engine with the option --with-db-port, because the
1778 libdbi framework doesn't know the default access port of each database.
1780 The next phase is checking (or configuring) the bacula-dir.conf, example:
1784 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1785 dbname = regress; user = regress; password = ""
1789 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1790 mysql database. Currently the drivers supported by Bacula are: postgresql,
1791 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1793 The following limitations apply when Bacula is set to use the libdbi framework:
1794 - Not tested on the Win32 platform
1795 - A little performance is lost if comparing with native database driver.
1796 The reason is bound with the database driver provided by libdbi and the
1797 simple fact that one more layer of code was added.
1799 It is important to remember, when compiling Bacula with libdbi, the
1800 following packages are needed:
1802 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1803 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1806 You can download them and compile them on your system or install the packages
1807 from your OS distribution.
1809 \section{Console Command Additions and Enhancements}
1810 \index[general]{Console Additions}
1812 \subsection{Display Autochanger Content}
1813 \index[general]{StatusSlots}
1815 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1816 autochanger content.
1820 Slot | Volume Name | Status | Media Type | Pool |
1821 ------+---------------+----------+-------------------+------------|
1822 1 | 00001 | Append | DiskChangerMedia | Default |
1823 2 | 00002 | Append | DiskChangerMedia | Default |
1824 3*| 00003 | Append | DiskChangerMedia | Scratch |
1829 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1830 {\bf update slots} command to synchronize autochanger content with your
1833 \subsection{list joblog job=xxx or jobid=nnn}
1834 \index[general]{list joblog}
1835 A new list command has been added that allows you to list the contents
1836 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1837 or for a particular JobId. The {\bf llist} command will include a line with
1838 the time and date of the entry.
1840 Note for the catalog to have Job Log entries, you must have a directive
1847 In your Director's {\bf Messages} resource.
1849 \subsection{Use separator for multiple commands}
1850 \index[general]{Command Separator}
1851 When using bconsole with readline, you can set the command separator with
1852 \textbf{@separator} command to one
1853 of those characters to write commands who require multiple input in one line.
1855 !$%&'()*+,-/:;<>?[]^`{|}~
1858 \subsection{Deleting Volumes}
1859 The delete volume bconsole command has been modified to
1860 require an asterisk (*) in front of a MediaId otherwise the
1861 value you enter is a taken to be a Volume name. This is so that
1862 users may delete numeric Volume names. The previous Bacula versions
1863 assumed that all input that started with a number was a MediaId.
1865 This new behavior is indicated in the prompt if you read it
1868 \section{Bare Metal Recovery}
1869 The old bare metal recovery project is essentially dead. One
1870 of the main features of it was that it would build a recovery
1871 CD based on the kernel on your system. The problem was that
1872 every distribution has a different boot procedure and different
1873 scripts, and worse yet, the boot procedures and scripts change
1874 from one distribution to another. This meant that maintaining
1875 (keeping up with the changes) the rescue CD was too much work.
1877 To replace it, a new bare metal recovery USB boot stick has been developed
1878 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1879 boot from a USB key.
1883 \item Recovery can be done from within graphical environment.
1884 \item Recovery can be done in a shell.
1885 \item Ubuntu boots on a large number of Linux systems.
1886 \item The process of updating the system and adding new
1887 packages is not too difficult.
1888 \item The USB key can easily be upgraded to newer Ubuntu versions.
1889 \item The USB key has writable partitions for modifications to
1890 the OS and for modification to your home directory.
1891 \item You can add new files/directories to the USB key very easily.
1892 \item You can save the environment from multiple machines on
1894 \item Bacula Systems is funding its ongoing development.
1897 The disadvantages are:
1899 \item The USB key is usable but currently under development.
1900 \item Not everyone may be familiar with Ubuntu (no worse
1902 \item Some older OSes cannot be booted from USB. This can
1903 be resolved by first booting a Ubuntu LiveCD then plugging
1905 \item Currently the documentation is sketchy and not yet added
1906 to the main manual. See below ...
1909 The documentation and the code can be found in the {\bf rescue} package
1910 in the directory {\bf linux/usb}.
1912 \section{Miscellaneous}
1913 \index[general]{Misc New Features}
1915 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
1916 \index[general]{Allow Mixed Priority}
1917 This directive is only implemented in version 2.5 and later. When
1918 set to {\bf yes} (default {\bf no}), this job may run even if lower
1919 priority jobs are already running. This means a high priority job
1920 will not have to wait for other jobs to finish before starting.
1921 The scheduler will only mix priorities when all running jobs have
1924 Note that only higher priority jobs will start early. Suppose the
1925 director will allow two concurrent jobs, and that two jobs with
1926 priority 10 are running, with two more in the queue. If a job with
1927 priority 5 is added to the queue, it will be run as soon as one of
1928 the running jobs finishes. However, new priority 10 jobs will not
1929 be run until the priority 5 job has finished.
1931 \subsection{Bootstrap File Directive -- FileRegex}
1932 \index[general]{Bootstrap File Directive}
1933 {\bf FileRegex} is a new command that can be added to the bootstrap
1934 (.bsr) file. The value is a regular expression. When specified, only
1935 matching filenames will be restored.
1937 During a restore, if all File records are pruned from the catalog
1938 for a Job, normally Bacula can restore only all files saved. That
1939 is there is no way using the catalog to select individual files.
1940 With this new feature, Bacula will ask if you want to specify a Regex
1941 expression for extracting only a part of the full backup.
1944 Building directory tree for JobId(s) 1,3 ...
1945 There were no files inserted into the tree, so file selection
1946 is not possible.Most likely your retention policy pruned the files
1948 Do you want to restore all the files? (yes\vb{}no): no
1950 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1951 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1954 \subsection{Bootstrap File Optimization Changes}
1955 In order to permit proper seeking on disk files, we have extended the bootstrap
1956 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1957 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1958 address range and end address range respectively. These two directives replace
1959 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1960 VolEndBlock} directives. Bootstrap files containing the old directives will
1961 still work, but will not properly take advantage of proper disk seeking, and
1962 may read completely to the end of a disk volume during a restore. With the new
1963 format (automatically generated by the new Director), restores will seek
1964 properly and stop reading the volume when all the files have been restored.
1966 \subsection{Solaris ZFS/NFSv4 ACLs}
1967 This is an upgrade of the previous Solaris ACL backup code
1968 to the new library format, which will backup both the old
1969 POSIX(UFS) ACLs as well as the ZFS ACLs.
1971 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1972 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1973 be used to transfer from UFS to ZFS filesystems.
1976 \subsection{Virtual Tape Emulation}
1977 \index[general]{Virtual Tape Emulation}
1978 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1979 the tape code but actually reading and writing to a disk file. Used with the
1980 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1981 and 700 slots. This feature is most useful in testing. It is enabled
1982 by using {\bf Device Type = vtape} in the Storage daemon's Device
1983 directive. This feature is only implemented on Linux machines and should not be
1984 used for production.
1986 \subsection{Bat Enhancements}
1987 \index[general]{Bat Enhancements}
1988 Bat (the Bacula Administration Tool) GUI program has been significantly
1989 enhanced and stabilized. In particular, there are new table based status
1990 commands; it can now be easily localized using Qt4 Linguist.
1992 The Bat communications protocol has been significantly enhanced to improve
1993 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1994 the Director you are using otherwise the communications protocol will not
1997 \subsection{RunScript Enhancements}
1998 \index[general]{RunScript Enhancements}
1999 The {\bf RunScript} resource has been enhanced to permit multiple
2000 commands per RunScript. Simply specify multiple {\bf Command} directives
2007 Command = "/bin/echo test"
2008 Command = "/bin/echo an other test"
2009 Command = "/bin/echo 3 commands in the same runscript"
2016 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2017 implemented, which runs the command after the Volume Shadow Copy has been made.
2019 Console commands can be specified within a RunScript by using:
2020 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2021 carefully tested and debugged and is known to easily crash the Director.
2022 We would appreciate feedback. Due to the recursive nature of this command, we
2023 may remove it before the final release.
2025 \subsection{Status Enhancements}
2026 \index[general]{Status Enhancements}
2027 The bconsole {\bf status dir} output has been enhanced to indicate
2028 Storage daemon job spooling and despooling activity.
2030 \subsection{Connect Timeout}
2031 \index[general]{Connect Timeout}
2032 The default connect timeout to the File
2033 daemon has been set to 3 minutes. Previously it was 30 minutes.
2035 \subsection{ftruncate for NFS Volumes}
2036 \index[general]{ftruncate for NFS Volumes}
2037 If you write to a Volume mounted by NFS (say on a local file server),
2038 in previous Bacula versions, when the Volume was recycled, it was not
2039 properly truncated because NFS does not implement ftruncate (file
2040 truncate). This is now corrected in the new version because we have
2041 written code (actually a kind user) that deletes and recreates the Volume,
2042 thus accomplishing the same thing as a truncate.
2044 \subsection{Support for Ubuntu}
2045 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2046 version of Linux, and thus now provides correct autostart routines.
2047 Since Ubuntu officially supports Bacula, you can also obtain any
2048 recent release of Bacula from the Ubuntu repositories.
2050 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2051 \index[general]{Recycle Pool}
2052 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2053 be placed (moved) when it is recycled. Without this directive, a Volume will
2054 remain in the same pool when it is recycled. With this directive, it can be
2055 moved automatically to any existing pool during a recycle. This directive is
2056 probably most useful when defined in the Scratch pool, so that volumes will
2057 be recycled back into the Scratch pool.
2059 \subsection{FD Version}
2060 \index[general]{FD Version}
2061 The File daemon to Director protocol now includes a version
2062 number, which although there is no visible change for users,
2063 will help us in future versions automatically determine
2064 if a File daemon is not compatible.
2066 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2067 \index[general]{Max Run Sched Time}
2068 The time specifies the maximum allowed time that a job may run, counted from
2069 when the job was scheduled. This can be useful to prevent jobs from running
2070 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2073 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2074 \index[general]{Max Wait Time}
2075 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2076 of checking the maximum allowed time that a job may block for a resource,
2077 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2078 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2079 their job depending on the level. Now, they have to use
2080 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2081 directives are now deprecated.
2083 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2084 \index[general]{Incremental Max Wait Time}
2085 \index[general]{Differential Max Wait Time}
2087 These directives have been deprecated in favor of
2088 \texttt{Incremental|Differential Max Run Time}.
2090 \subsection{Max Run Time directives}
2091 \index[general]{Max Run Time directives}
2092 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2093 maximum allowed time that a job can run depending on the level.
2095 \addcontentsline{lof}{figure}{Job time control directives}
2096 \includegraphics{\idir different_time.eps}
2098 \subsection{Statistics Enhancements}
2099 \index[general]{Statistics Enhancements}
2100 If you (or probably your boss) want to have statistics on your backups to
2101 provide some \textit{Service Level Agreement} indicators, you could use a few
2102 SQL queries on the Job table to report how many:
2106 \item jobs have been successful
2107 \item files have been backed up
2111 However, these statistics are accurate only if your job retention is greater
2112 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2113 be able to use them.
2115 Now, you can use the \textbf{update stats [days=num]} console command to fill
2116 the JobHistory table with new Job records. If you want to be sure to take in
2117 account only \textbf{good jobs}, ie if one of your important job has failed but
2118 you have fixed the problem and restarted it on time, you probably want to
2119 delete the first \textit{bad} job record and keep only the successful one. For
2120 that simply let your staff do the job, and update JobHistory table after two or
2121 three days depending on your organization using the \textbf{[days=num]} option.
2123 These statistics records aren't used for restoring, but mainly for
2124 capacity planning, billings, etc.
2126 The Bweb interface provides a statistics module that can use this feature. You
2127 can also use tools like Talend or extract information by yourself.
2129 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2130 the length of time that Bacula will keep statistics job records in the Catalog
2131 database after the Job End time. (In \texttt{JobHistory} table) When this time
2132 period expires, and if user runs \texttt{prune stats} command, Bacula will
2133 prune (remove) Job records that are older than the specified period.
2135 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2136 job to maintain statistics.
2139 Name = BackupCatalog
2142 Console = "update stats days=3"
2143 Console = "prune stats yes"
2150 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2151 \index[general]{ScratchPool}
2152 This directive permits to specify a specific \textsl{Scratch} pool for the
2153 current pool. This is useful when using multiple storage sharing the same
2154 mediatype or when you want to dedicate volumes to a particular set of pool.
2156 \subsection{Enhanced Attribute Despooling}
2157 \index[general]{Attribute Despooling}
2158 If the storage daemon and the Director are on the same machine, the spool file
2159 that contains attributes is read directly by the Director instead of being
2160 transmitted across the network. That should reduce load and speedup insertion.
2162 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2163 \index[general]{SpoolSize}
2164 A new Job directive permits to specify the spool size per job. This is used
2165 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2167 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2168 \index[general]{MaximumConsoleConnections}
2169 A new director directive permits to specify the maximum number of Console
2170 Connections that could run concurrently. The default is set to 20, but you may
2171 set it to a larger number.
2173 \subsection{VerId = \lt{}string\gt{}}
2174 \index[general]{VerId}
2175 A new director directive permits to specify a personnal identifier that will be
2176 displayed in the \texttt{version} command.
2178 \subsection{dbcheck enhancements}
2179 \index[general]{dbcheck enhancements}
2180 If you are using Mysql, dbcheck will now ask you if you want to create
2181 temporary indexes to speed up orphaned Path and Filename elimination.
2183 A new \texttt{-B} option allows you to print catalog information in a simple
2184 text based format. This is useful to backup it in a secure way.
2199 You can now specify the database connection port in the command line.
2201 \subsection{{-}{-}docdir configure option}
2202 \index[general]{{-}{-}docdir configure option}
2203 You can use {-}{-}docdir= on the ./configure command to
2204 specify the directory where you want Bacula to install the
2205 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2206 {\bf /usr/share/doc/bacula}.
2208 \subsection{{-}{-}htmldir configure option}
2209 \index[general]{{-}{-}htmldir configure option}
2210 You can use {-}{-}htmldir= on the ./configure command to
2211 specify the directory where you want Bacula to install the bat html help
2212 files. The default is {\bf /usr/share/doc/bacula/html}
2214 \subsection{{-}{-}with-plugindir configure option}
2215 \index[general]{{-}{-}plugindir configure option}
2216 You can use {-}{-}plugindir= on the ./configure command to
2217 specify the directory where you want Bacula to install
2218 the plugins (currently only bpipe-fd). The default is