1 \chapter{Release Version 5.0.2}
3 There are no new features in version 5.0.2. This version simply fixes a
4 number of bugs found in version 5.0.1 during the onging development
7 \chapter{New Features in 5.0.1}
9 This chapter presents the new features that are in the released Bacula version
10 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
11 the onging development process.
13 \section{Truncate Volume after Purge}
14 \label{sec:actiononpurge}
16 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
17 the volume when it is purged with the new command \texttt{purge volume
18 action}. It is useful to prevent disk based volumes from consuming too much
24 Action On Purge = Truncate
29 As usual you can also set this property with the \texttt{update volume} command
31 *update volume=xxx ActionOnPurge=Truncate
32 *update volume=xxx actiononpurge=None
35 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
36 following command in interactive mode or in a RunScript as shown after:
38 *purge volume action=truncate storage=File allpools
39 # or by default, action=all
40 *purge volume action storage=File pool=Default
43 This is possible to specify the volume name, the media type, the pool, the
44 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
45 idle when you decide to run this command.
54 Console = "purge volume action=all allpools storage=File"
59 \textbf{Important note}: This feature doesn't work as
60 expected in version 5.0.0. Please do not use it before version 5.0.1.
62 \section{Allow Higher Duplicates}
63 This directive did not work correctly and has been depreciated
64 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
65 file as it will be removed in a future rlease.
67 \section{Cancel Lower Level Duplicates}
68 This directive was added in Bacula version 5.0.1. It compares the
69 level of a new backup job to old jobs of the same name, if any,
70 and will kill the job which has a lower level than the other one.
71 If the levels are the same (i.e. both are Full backups), then
72 nothing is done and the other Cancel XXX Duplicate directives
75 \chapter{New Features in 5.0.0}
77 \section{Maximum Concurent Jobs for Devices}
78 \label{sec:maximumconcurentjobdevice}
80 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
81 Daemon configuration permits setting the maximum number of Jobs that can
82 run concurrently on a specified Device. Using this directive, it is
83 possible to have different Jobs using multiple drives, because when the
84 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
85 Jobs on any other available compatible drive. This facilitates writing to
86 multiple drives with multiple Jobs that all use the same Pool.
88 This project was funded by Bacula Systems.
90 \section{Restore from Multiple Storage Daemons}
91 \index[general]{Restore}
93 Previously, you were able to restore from multiple devices in a single Storage
94 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
95 example, if your full backup runs on a Storage Daemon with an autochanger, and
96 your incremental jobs use another Storage Daemon with lots of disks, Bacula
97 will switch automatically from one Storage Daemon to an other within the same
100 You must upgrade your File Daemon to version 3.1.3 or greater to use this
103 This project was funded by Bacula Systems with the help of Equiinet.
105 \section{File Deduplication using Base Jobs}
106 A base job is sort of like a Full save except that you will want the FileSet to
107 contain only files that are unlikely to change in the future (i.e. a snapshot
108 of most of your system after installing it). After the base job has been run,
109 when you are doing a Full save, you specify one or more Base jobs to be used.
110 All files that have been backed up in the Base job/jobs but not modified will
111 then be excluded from the backup. During a restore, the Base jobs will be
112 automatically pulled in where necessary.
114 This is something none of the competition does, as far as we know (except
115 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
116 win for the user, it makes Bacula stand out as offering a unique optimization
117 that immediately saves time and money. Basically, imagine that you have 100
118 nearly identical Windows or Linux machine containing the OS and user files.
119 Now for the OS part, a Base job will be backed up once, and rather than making
120 100 copies of the OS, there will be only one. If one or more of the systems
121 have some files updated, no problem, they will be automatically restored.
123 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
124 files that will be used during Full backup as base.
135 Base = BackupZog4, BackupLinux
141 In this example, the job \texttt{BackupZog4} will use the most recent version
142 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
143 jobs. Base jobs should have run with \texttt{level=Base} to be used.
145 By default, Bacula will compare permissions bits, user and group fields,
146 modification time, size and the checksum of the file to choose between the
147 current backup and the BaseJob file list. You can change this behavior with the
148 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
149 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
165 \textbf{Important note}: The current implementation doesn't permit to scan
166 volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
168 This project was funded by Bacula Systems.
170 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
171 \index[dir]{AllowCompression}
173 This new directive may be added to Storage resource within the Director's
174 configuration to allow users to selectively disable the client compression for
175 any job which writes to this storage resource.
181 Address = ultrium-tape
182 Password = storage_password # Password for Storage Daemon
185 AllowCompression = No # Tape drive has hardware compression
188 The above example would cause any jobs running with the UltriumTape storage
189 resource to run without compression from the client file daemons. This
190 effectively overrides any compression settings defined at the FileSet level.
192 This feature is probably most useful if you have a tape drive which supports
193 hardware compression. By setting the \texttt{AllowCompression = No} directive
194 for your tape drive storage resource, you can avoid additional load on the file
195 daemon and possibly speed up tape backups.
197 This project was funded by Collaborative Fusion, Inc.
199 \section{Accurate Fileset Options}
200 \label{sec:accuratefileset}
202 In previous versions, the accurate code used the file creation and modification
203 times to determine if a file was modified or not. Now you can specify which
204 attributes to use (time, size, checksum, permission, owner, group, \dots),
205 similar to the Verify options.
221 \item {\bf i} compare the inodes
222 \item {\bf p} compare the permission bits
223 \item {\bf n} compare the number of links
224 \item {\bf u} compare the user id
225 \item {\bf g} compare the group id
226 \item {\bf s} compare the size
227 \item {\bf a} compare the access time
228 \item {\bf m} compare the modification time (st\_mtime)
229 \item {\bf c} compare the change time (st\_ctime)
230 \item {\bf d} report file size decreases
231 \item {\bf 5} compare the MD5 signature
232 \item {\bf 1} compare the SHA1 signature
235 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
236 the File Daemon will have to read all files even if they normally would not
237 be saved. This increases the I/O load, but also the accuracy of the
238 deduplication. By default, Bacula will check modification/creation time
241 This project was funded by Bacula Systems.
243 \section{Tab-completion for Bconsole}
244 \label{sec:tabcompletion}
246 If you build \texttt{bconsole} with readline support, you will be able to use
247 the new auto-completion mode. This mode supports all commands, gives help
248 inside command, and lists resources when required. It works also in the restore
251 To use this feature, you should have readline development package loaded on
252 your system, and use the following option in configure.
254 ./configure --with-readline=/usr/include/readline --disable-conio ...
257 The new bconsole won't be able to tab-complete with older directors.
259 This project was funded by Bacula Systems.
261 \section{Pool File and Job retention}
262 \label{sec:poolfilejobretention}
265 We added two new Pool directives, \texttt{FileRetention} and
266 \texttt{JobRetention}, that take precedence over Client directives of the same
267 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
268 example, you can decide to increase Retention times for Archive or OffSite Pool.
270 \section{Read-only File Daemon using capabilities}
271 \label{sec:fdreadonly}
272 This feature implements support of keeping \textbf{ReadAll} capabilities after
273 UID/GID switch, this allows FD to keep root read but drop write permission.
275 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
276 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
279 root@localhost:~# bacula-fd -k -u nobody -g nobody
282 The code for this feature was contributed by our friends at AltLinux.
287 To help developers of restore GUI interfaces, we have added new \textsl{dot
288 commands} that permit browsing the catalog in a very simple way.
291 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
292 the Bvfs cache in the catalog. You need to run it before any access to the
295 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
296 will list all directories in the specified \texttt{path} or
297 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
298 encoding of path/filenames.
300 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
301 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
302 \texttt{pathid} avoids problems with character encoding.
305 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
306 data that will be displayed.
309 * .bvfs_update jobid=1,2
311 * .bvfs_lsdir path=/ jobid=1,2
314 This project was funded by Bacula Systems.
316 \section{Testing your Tape Drive}
317 \label{sec:btapespeed}
319 To determine the best configuration of your tape drive, you can run the new
320 \texttt{speed} command available in the \texttt{btape} program.
322 This command can have the following arguments:
324 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
325 (between 1 and 5GB). This counter is in GB.
326 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
327 of data should be greater than your memory ($file\_size*nb\_file$).
328 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
330 \item[\texttt{skip\_random}] This flag permits to skip tests with random
332 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
333 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
338 *speed file_size=3 skip_raw
339 btape.c:1078 Test with zero data and bacula block structure.
340 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
341 ++++++++++++++++++++++++++++++++++++++++++
342 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
343 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
345 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
347 btape.c:1090 Test with random data, should give the minimum throughput.
348 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
349 +++++++++++++++++++++++++++++++++++++++++++
350 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
351 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
352 +++++++++++++++++++++++++++++++++++++++++++
354 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
358 When using compression, the random test will give your the minimum throughput
359 of your drive . The test using constant string will give you the maximum speed
360 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
362 You can change the block size in the Storage Daemon configuration file.
364 \section{New {\bf Block Checksum} Device Directive}
365 You may now turn off the Block Checksum (CRC32) code
366 that Bacula uses when writing blocks to a Volume. This is
373 doing so can reduce the Storage daemon CPU usage slightly. It
374 will also permit Bacula to read a Volume that has corrupted data.
376 The default is {\bf yes} -- i.e. the checksum is computed on write
379 We do not recommend to turn this off particularly on older tape
380 drives or for disk Volumes where doing so may allow corrupted data
383 \section{New Bat Features}
385 Those new features were funded by Bacula Systems.
387 \subsection{Media List View}
389 By clicking on ``Media'', you can see the list of all your volumes. You will be
390 able to filter by Pool, Media Type, Location,\dots And sort the result directly
391 in the table. The old ``Media'' view is now known as ``Pool''.
394 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
395 \label{fig:mediaview}
399 \subsection{Media Information View}
401 By double-clicking on a volume (on the Media list, in the Autochanger content
402 or in the Job information panel), you can access a detailed overview of your
403 Volume. (cf \ref{fig:mediainfo}.)
406 \includegraphics[width=13cm]{\idir bat11.eps}
407 \caption{Media information}
408 \label{fig:mediainfo}
411 \subsection{Job Information View}
413 By double-clicking on a Job record (on the Job run list or in the Media
414 information panel), you can access a detailed overview of your Job. (cf
418 \includegraphics[width=13cm]{\idir bat12.eps}
419 \caption{Job information}
423 \subsection{Autochanger Content View}
425 By double-clicking on a Storage record (on the Storage list panel), you can
426 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
429 \includegraphics[width=13cm]{\idir bat13.eps}
430 \caption{Autochanger content}
431 \label{fig:achcontent}
434 To use this feature, you need to use the latest mtx-changer script
435 version. (With new \texttt{listall} and \texttt{transfer} commands)
437 \section{Bat on Windows}
438 We have ported {\bf bat} to Windows and it is now installed
439 by default when the installer is run. It works quite well
440 on Win32, but has not had a lot of testing there, so your
441 feedback would be welcome. Unfortunately, eventhough it is
442 installed by default, it does not yet work on 64 bit Windows
445 \section{New Win32 Installer}
446 The Win32 installer has been modified in several very important
449 \item You must deinstall any current version of the
450 Win32 File daemon before upgrading to the new one.
451 If you forget to do so, the new installation will fail.
452 To correct this failure, you must manually shutdown
453 and deinstall the old File daemon.
454 \item All files (other than menu links) are installed
455 in {\bf c:/Program Files/Bacula}.
456 \item The installer no longer sets this
457 file to require administrator privileges by default. If you want
458 to do so, please do it manually using the {\bf cacls} program.
461 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
463 \item The server daemons (Director and Storage daemon) are
464 no longer included in the Windows installer. If you want the
465 Windows servers, you will either need to build them yourself (note
466 they have not been ported to 64 bits), or you can contact
467 Bacula Systems about this.
470 \section{Win64 Installer}
471 We have corrected a number of problems that required manual
472 editing of the conf files. In most cases, it should now
473 install and work. {\bf bat} is by default installed in
474 {\bf c:/Program Files/Bacula/bin32} rather than
475 {\bf c:/Program Files/Bacula} as is the case with the 32
476 bit Windows installer.
478 \section{Linux Bare Metal Recovery USB Key}
479 We have made a number of significant improvements in the
480 Bare Metal Recovery USB key. Please see the README files
481 it the {\bf rescue} release for more details.
483 We are working on an equivalent USB key for Windows bare
484 metal recovery, but it will take some time to develop it (best
485 estimate 3Q2010 or 4Q2010)
488 \section{bconsole Timeout Option}
489 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
490 for commands. This is useful with GUI programs that use {\bf bconsole}
491 to interface to the Director.
493 \section{Important Changes}
494 \label{sec:importantchanges}
497 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
498 to the same Pool. The Storage daemon ensures that you do not read and
499 write to the same Volume.
500 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
502 \item Virtually all the features of {\bf mtx-changer} have
503 now been parameterized, which allows you to configure
504 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
505 that contains variables that you can set to configure mtx-changer.
506 This configuration file will not be overwritten during upgrades.
507 We encourage you to submit any changes
508 that are made to mtx-changer and to parameterize it all in
509 mtx-changer.conf so that all configuration will be done by
510 changing only mtx-changer.conf.
511 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
512 and \texttt{transfer}. Please configure them as appropriate
514 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
515 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
516 password. If you want to use the new script, you will need to
517 manually change the \texttt{BackupCatalog} Job definition.
518 \item The \texttt{bconsole} \texttt{help} command now accepts
519 an argument, which if provided produces information on that
520 command (ex: \texttt{help run}).
524 \subsubsection*{Truncate volume after purge}
526 Note that the Truncate Volume after purge feature doesn't work as expected
527 in 5.0.0 version. Please, don't use it before version 5.0.1.
529 \subsection{Custom Catalog queries}
531 If you wish to add specialized commands that list the contents of the catalog,
532 you can do so by adding them to the \texttt{query.sql} file. This
533 \texttt{query.sql} file is now empty by default. The file
534 \texttt{examples/sample-query.sql} has an a number of sample commands
535 you might find useful.
537 \subsection{Deprecated parts}
539 The following items have been \textbf{deprecated} for a long time, and are now
540 removed from the code.
543 \item Support for SQLite 2
546 \section{Misc Changes}
547 \label{sec:miscchanges}
550 \item Updated Nagios check\_bacula
551 \item Updated man files
552 \item Added OSX package generation script in platforms/darwin
553 \item Added Spanish and Ukrainian Bacula translations
554 \item Enable/disable command shows only Jobs that can change
555 \item Added \texttt{show disabled} command to show disabled Jobs
556 \item Many ACL improvements
557 \item Added Level to FD status Job output
558 \item Begin Ingres DB driver (not yet working)
559 \item Split RedHat spec files into bacula, bat, mtx, and docs
560 \item Reorganized the manuals (fewer separate manuals)
561 \item Added lock/unlock order protection in lock manager
562 \item Allow 64 bit sizes for a number of variables
563 \item Fixed several deadlocks or potential race conditions in the SD
566 \chapter{Released Version 3.0.3 and 3.0.3a}
568 There are no new features in version 3.0.3. This version simply fixes a
569 number of bugs found in version 3.0.2 during the onging development
572 \chapter{New Features in Released Version 3.0.2}
574 This chapter presents the new features added to the
575 Released Bacula Version 3.0.2.
577 \section{Full Restore from a Given JobId}
578 \index[general]{Restore menu}
580 This feature allows selecting a single JobId and having Bacula
581 automatically select all the other jobs that comprise a full backup up to
582 and including the selected date (through JobId).
584 Assume we start with the following jobs:
586 +-------+--------------+---------------------+-------+----------+------------+
587 | jobid | client | starttime | level | jobfiles | jobbytes |
588 +-------+--------------+---------------------+-------+----------+------------
589 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
590 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
591 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
592 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
593 +-------+--------------+---------------------+-------+----------+------------+
596 Below is an example of this new feature (which is number 12 in the
601 To select the JobIds, you have the following choices:
602 1: List last 20 Jobs run
603 2: List Jobs where a given File is saved
605 12: Select full restore to a specified Job date
608 Select item: (1-13): 12
609 Enter JobId to get the state to restore: 5
610 Selecting jobs to build the Full state at 2009-07-15 11:45:45
611 You have selected the following JobIds: 1,3,5
613 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
614 1,444 files inserted into the tree.
617 This project was funded by Bacula Systems.
619 \section{Source Address}
620 \index[general]{Source Address}
622 A feature has been added which allows the administrator to specify the address
623 from which the Director and File daemons will establish connections. This
624 may be used to simplify system configuration overhead when working in complex
625 networks utilizing multi-homing and policy-routing.
627 To accomplish this, two new configuration directives have been implemented:
630 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
634 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
638 Simply adding specific host routes on the OS
639 would have an undesirable side-effect: any
640 application trying to contact the destination host would be forced to use the
641 more specific route possibly diverting management traffic onto a backup VLAN.
642 Instead of adding host routes for each client connected to a multi-homed backup
643 server (for example where there are management and backup VLANs), one can
644 use the new directives to specify a specific source address at the application
647 Additionally, this allows the simplification and abstraction of firewall rules
648 when dealing with a Hot-Standby director or storage daemon configuration. The
649 Hot-standby pair may share a CARP address, which connections must be sourced
650 from, while system services listen and act from the unique interface addresses.
652 This project was funded by Collaborative Fusion, Inc.
654 \section{Show volume availability when doing restore}
656 When doing a restore the selection dialog ends by displaying this
660 The job will require the following
661 Volume(s) Storage(s) SD Device(s)
662 ===========================================================================
673 Volumes marked with ``*'' are online (in the autochanger).
676 This should help speed up large restores by minimizing the time spent
677 waiting for the operator to discover that he must change tapes in the library.
679 This project was funded by Bacula Systems.
681 \section{Accurate estimate command}
683 The \texttt{estimate} command can now use the accurate code to detect changes
684 and give a better estimation.
686 You can set the accurate behavior on the command line by using
687 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
690 * estimate listing accurate=yes level=incremental job=BackupJob
693 This project was funded by Bacula Systems.
695 \chapter{New Features in 3.0.0}
696 \label{NewFeaturesChapter}
697 \index[general]{New Features}
699 This chapter presents the new features added to the development 2.5.x
700 versions to be released as Bacula version 3.0.0 sometime in April 2009.
702 \section{Accurate Backup}
703 \index[general]{Accurate Backup}
705 As with most other backup programs, by default Bacula decides what files to
706 backup for Incremental and Differental backup by comparing the change
707 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
708 backup completed. If one of those two times is later than the last backup
709 time, then the file will be backed up. This does not, however, permit tracking
710 what files have been deleted and will miss any file with an old time that may
711 have been restored to or moved onto the client filesystem.
713 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
714 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
715 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
716 backup, there is no difference, but for {\bf Differential} and {\bf
717 Incremental} backups, the Director will send a list of all previous files
718 backed up, and the File daemon will use that list to determine if any new files
719 have been added or or moved and if any files have been deleted. This allows
720 Bacula to make an accurate backup of your system to that point in time so that
721 if you do a restore, it will restore your system exactly.
724 about using Accurate backup is that it requires more resources (CPU and memory)
725 on both the Director and the Client machines to create the list of previous
726 files backed up, to send that list to the File daemon, for the File daemon to
727 keep the list (possibly very big) in memory, and for the File daemon to do
728 comparisons between every file in the FileSet and the list. In particular,
729 if your client has lots of files (more than a few million), you will need
730 lots of memory on the client machine.
732 Accurate must not be enabled when backing up with a plugin that is not
733 specially designed to work with Accurate. If you enable it, your restores
734 will probably not work correctly.
736 This project was funded by Bacula Systems.
741 \index[general]{Copy Jobs}
743 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
744 existing Migration feature with the exception that the Job that is copied is
745 left unchanged. This essentially creates two identical copies of the same
746 backup. However, the copy is treated as a copy rather than a backup job, and
747 hence is not directly available for restore. The {\bf restore} command lists
748 copy jobs and allows selection of copies by using \texttt{jobid=}
749 option. If the keyword {\bf copies} is present on the command line, Bacula will
750 display the list of all copies for selected jobs.
755 These JobIds have copies as follows:
756 +-------+------------------------------------+-----------+------------------+
757 | JobId | Job | CopyJobId | MediaType |
758 +-------+------------------------------------+-----------+------------------+
759 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
760 +-------+------------------------------------+-----------+------------------+
761 +-------+-------+----------+----------+---------------------+------------------+
762 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
763 +-------+-------+----------+----------+---------------------+------------------+
764 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
765 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
766 +-------+-------+----------+----------+---------------------+------------------+
767 You have selected the following JobIds: 19,2
769 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
770 5,611 files inserted into the tree.
775 The Copy Job runs without using the File daemon by copying the data from the
776 old backup Volume to a different Volume in a different Pool. See the Migration
777 documentation for additional details. For copy Jobs there is a new selection
778 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
779 not already copied to another Pool.
781 As with Migration, the Client, Volume, Job, or SQL query, are
782 other possible ways of selecting the Jobs to be copied. Selection
783 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
784 work, but are probably more suited for Migration Jobs.
786 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
787 it will promote the Copy to a \textsl{real} backup job and will make it available for
788 automatic restore. If more than one Copy is available, it will promote the copy
789 with the smallest JobId.
791 A nice solution which can be built with the new Copy feature is often
792 called disk-to-disk-to-tape backup (DTDTT). A sample config could
793 look something like the one below:
797 Name = FullBackupsVirtualPool
799 Purge Oldest Volume = Yes
801 NextPool = FullBackupsTapePool
805 Name = FullBackupsTapePool
809 Volume Retention = 365 days
810 Storage = superloader
814 # Fake fileset for copy jobs
826 # Fake client for copy jobs
836 # Default template for a CopyDiskToTape Job
839 Name = CopyDiskToTape
841 Messages = StandardCopy
844 Selection Type = PoolUncopiedJobs
845 Maximum Concurrent Jobs = 10
847 Allow Duplicate Jobs = Yes
848 Cancel Queued Duplicates = No
849 Cancel Running Duplicates = No
854 Name = DaySchedule7:00
855 Run = Level=Full daily at 7:00
859 Name = CopyDiskToTapeFullBackups
861 Schedule = DaySchedule7:00
862 Pool = FullBackupsVirtualPool
863 JobDefs = CopyDiskToTape
867 The example above had 2 pool which are copied using the PoolUncopiedJobs
868 selection criteria. Normal Full backups go to the Virtual pool and are copied
869 to the Tape pool the next morning.
871 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
876 +-------+------------------------------------+-----------+------------------+
877 | JobId | Job | CopyJobId | MediaType |
878 +-------+------------------------------------+-----------+------------------+
879 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
880 +-------+------------------------------------+-----------+------------------+
883 \section{ACL Updates}
884 \index[general]{ACL Updates}
885 The whole ACL code had been overhauled and in this version each platforms has
886 different streams for each type of acl available on such an platform. As ACLs
887 between platforms tend to be not that portable (most implement POSIX acls but
888 some use an other draft or a completely different format) we currently only
889 allow certain platform specific ACL streams to be decoded and restored on the
890 same platform that they were created on. The old code allowed to restore ACL
891 cross platform but the comments already mention that not being to wise. For
892 backward compatability the new code will accept the two old ACL streams and
893 handle those with the platform specific handler. But for all new backups it
894 will save the ACLs using the new streams.
896 Currently the following platforms support ACLs:
900 \item {\bf Darwin/OSX}
909 Currently we support the following ACL types (these ACL streams use a reserved
910 part of the stream numbers):
913 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
915 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
916 string representation from acl\_to\_text (POSIX acl)
917 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
918 string representation from acl\_to\_text (POSIX acl) for default acls.
919 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
920 string representation from acl\_to\_text (POSIX acl) for access acls.
921 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
922 string representation from acltostr (POSIX acl)
923 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
924 representation from acl\_to\_text (POSIX acl) for default acls.
925 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
926 representation from acl\_to\_text (POSIX acl) for access acls.
927 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
928 string representation from acl\_to\_text (POSIX acl) for default acls.
929 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
930 representation from acl\_to\_text (POSIX acl) for access acls.
931 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
932 string representation from acl\_to\_text (POSIX acl) for default acls.
933 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
934 string representation from acl\_to\_text (POSIX acl) for default acls.
935 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
936 representation from acl\_to\_text (POSIX acl) for access acls.
937 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
938 string representation from acltotext or acl\_totext (POSIX acl)
939 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
940 representation from from acl\_totext (NFSv4 or ZFS acl)
943 In future versions we might support conversion functions from one type of acl
944 into an other for types that are either the same or easily convertable. For now
945 the streams are seperate and restoring them on a platform that doesn't
946 recognize them will give you a warning.
948 \section{Extended Attributes}
949 \index[general]{Extended Attributes}
950 Something that was on the project list for some time is now implemented for
951 platforms that support a similar kind of interface. Its the support for backup
952 and restore of so called extended attributes. As extended attributes are so
953 platform specific these attributes are saved in seperate streams for each
954 platform. Restores of the extended attributes can only be performed on the
955 same platform the backup was done. There is support for all types of extended
956 attributes, but restoring from one type of filesystem onto an other type of
957 filesystem on the same platform may lead to supprises. As extended attributes
958 can contain any type of data they are stored as a series of so called
959 value-pairs. This data must be seen as mostly binary and is stored as such.
960 As security labels from selinux are also extended attributes this option also
961 stores those labels and no specific code is enabled for handling selinux
964 Currently the following platforms support extended attributes:
966 \item {\bf Darwin/OSX}
972 On linux acls are also extended attributes, as such when you enable ACLs on a
973 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
974 and not the same exteneded attribute.
976 To enable the backup of extended attributes please add the following to your
991 \section{Shared objects}
992 \index[general]{Shared objects}
993 A default build of Bacula will now create the libraries as shared objects
994 (.so) rather than static libraries as was previously the case.
995 The shared libraries are built using {\bf libtool} so it should be quite
998 An important advantage of using shared objects is that on a machine with the
999 Directory, File daemon, the Storage daemon, and a console, you will have only
1000 one copy of the code in memory rather than four copies. Also the total size of
1001 the binary release is smaller since the library code appears only once rather
1002 than once for every program that uses it; this results in significant reduction
1003 in the size of the binaries particularly for the utility tools.
1005 In order for the system loader to find the shared objects when loading the
1006 Bacula binaries, the Bacula shared objects must either be in a shared object
1007 directory known to the loader (typically /usr/lib) or they must be in the
1008 directory that may be specified on the {\bf ./configure} line using the {\bf
1009 {-}{-}libdir} option as:
1012 ./configure --libdir=/full-path/dir
1015 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1016 no need to modify your loader configuration provided that
1017 the shared objects are installed in that directory (Bacula
1018 does this with the make install command). The shared objects
1019 that Bacula references are:
1028 These files are symbolically linked to the real shared object file,
1029 which has a version number to permit running multiple versions of
1030 the libraries if desired (not normally the case).
1032 If you have problems with libtool or you wish to use the old
1033 way of building static libraries, or you want to build a static
1034 version of Bacula you may disable
1035 libtool on the configure command line with:
1038 ./configure --disable-libtool
1042 \section{Building Static versions of Bacula}
1043 \index[general]{Static linking}
1044 In order to build static versions of Bacula, in addition
1045 to configuration options that were needed you now must
1046 also add --disable-libtool. Example
1049 ./configure --enable-static-client-only --disable-libtool
1053 \section{Virtual Backup (Vbackup)}
1054 \index[general]{Virtual Backup}
1055 \index[general]{Vbackup}
1057 Bacula's virtual backup feature is often called Synthetic Backup or
1058 Consolidation in other backup products. It permits you to consolidate the
1059 previous Full backup plus the most recent Differential backup and any
1060 subsequent Incremental backups into a new Full backup. This new Full
1061 backup will then be considered as the most recent Full for any future
1062 Incremental or Differential backups. The VirtualFull backup is
1063 accomplished without contacting the client by reading the previous backup
1064 data and writing it to a volume in a different pool.
1066 In some respects the Vbackup feature works similar to a Migration job, in
1067 that Bacula normally reads the data from the pool specified in the
1068 Job resource, and writes it to the {\bf Next Pool} specified in the
1069 Job resource. Note, this means that usually the output from the Virtual
1070 Backup is written into a different pool from where your prior backups
1071 are saved. Doing it this way guarantees that you will not get a deadlock
1072 situation attempting to read and write to the same volume in the Storage
1073 daemon. If you then want to do subsequent backups, you may need to
1074 move the Virtual Full Volume back to your normal backup pool.
1075 Alternatively, you can set your {\bf Next Pool} to point to the current
1076 pool. This will cause Bacula to read and write to Volumes in the
1077 current pool. In general, this will work, because Bacula will
1078 not allow reading and writing on the same Volume. In any case, once
1079 a VirtualFull has been created, and a restore is done involving the
1080 most current Full, it will read the Volume or Volumes by the VirtualFull
1081 regardless of in which Pool the Volume is found.
1083 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1084 a level of {\bf VirtualFull}.
1086 A typical Job resource definition might look like the following:
1093 FileSet = "Full Set"
1100 # Default pool definition
1104 Recycle = yes # Automatically recycle Volumes
1105 AutoPrune = yes # Prune expired volumes
1106 Volume Retention = 365d # one year
1114 Recycle = yes # Automatically recycle Volumes
1115 AutoPrune = yes # Prune expired volumes
1116 Volume Retention = 365d # one year
1117 Storage = DiskChanger
1120 # Definition of file storage device
1125 Device = FileStorage
1127 Maximum Concurrent Jobs = 5
1130 # Definition of DDS Virtual tape disk storage device
1133 Address = localhost # N.B. Use a fully qualified name here
1135 Device = DiskChanger
1136 Media Type = DiskChangerMedia
1137 Maximum Concurrent Jobs = 4
1142 Then in bconsole or via a Run schedule, you would run the job as:
1145 run job=MyBackup level=Full
1146 run job=MyBackup level=Incremental
1147 run job=MyBackup level=Differential
1148 run job=MyBackup level=Incremental
1149 run job=MyBackup level=Incremental
1152 So providing there were changes between each of those jobs, you would end up
1153 with a Full backup, a Differential, which includes the first Incremental
1154 backup, then two Incremental backups. All the above jobs would be written to
1155 the {\bf Default} pool.
1157 To consolidate those backups into a new Full backup, you would run the
1161 run job=MyBackup level=VirtualFull
1164 And it would produce a new Full backup without using the client, and the output
1165 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1167 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1170 Note, the Start and End time of the Virtual Full backup is set to the
1171 values for the last job included in the Virtual Full (in the above example,
1172 it is an Increment). This is so that if another incremental is done, which
1173 will be based on the Virtual Full, it will backup all files from the
1174 last Job included in the Virtual Full rather than from the time the Virtual
1175 Full was actually run.
1179 \section{Catalog Format}
1180 \index[general]{Catalog Format}
1181 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1182 operation will convert the FileId field of the File table from 32 bits (max 4
1183 billion table entries) to 64 bits (very large number of items). The
1184 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1185 your catalog during the conversion. Also you won't be able to run jobs during
1186 this conversion period. For example, a 3 million file catalog will take 2
1187 minutes to upgrade on a normal machine. Please don't forget to make a valid
1188 backup of your database before executing the upgrade script. See the
1189 ReleaseNotes for additional details.
1191 \section{64 bit Windows Client}
1192 \index[general]{Win64 Client}
1193 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1194 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1195 As a consequence, we are also releasing a 64 bit version of the Bacula
1196 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1197 These binaries should only be installed on 64 bit Windows operating systems.
1198 What is important is not your hardware but whether or not you have
1199 a 64 bit version of the Windows OS.
1201 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1203 \item Before installing the Win64 Bacula Client, you must totally
1204 deinstall any prior 2.4.x Client installation using the
1205 Bacula deinstallation (see the menu item). You may want
1206 to save your .conf files first.
1207 \item Only the Client (File daemon) is ported to Win64, the Director
1208 and the Storage daemon are not in the 64 bit Windows installer.
1209 \item bwx-console is not yet ported.
1210 \item bconsole is ported but it has not been tested.
1211 \item The documentation is not included in the installer.
1212 \item Due to Vista security restrictions imposed on a default installation
1213 of Vista, before upgrading the Client, you must manually stop
1214 any prior version of Bacula from running, otherwise the install
1216 \item Due to Vista security restrictions imposed on a default installation
1217 of Vista, attempting to edit the conf files via the menu items
1218 will fail. You must directly edit the files with appropriate
1219 permissions. Generally double clicking on the appropriate .conf
1220 file will work providing you have sufficient permissions.
1221 \item All Bacula files are now installed in
1222 {\bf C:/Program Files/Bacula} except the main menu items,
1223 which are installed as before. This vastly simplifies the installation.
1224 \item If you are running on a foreign language version of Windows, most
1225 likely {\bf C:/Program Files} does not exist, so you should use the
1226 Custom installation and enter an appropriate location to install
1228 \item The 3.0.0 Win32 Client continues to install files in the locations used
1229 by prior versions. For the next version we will convert it to use
1230 the same installation conventions as the Win64 version.
1233 This project was funded by Bacula Systems.
1236 \section{Duplicate Job Control}
1237 \index[general]{Duplicate Jobs}
1238 The new version of Bacula provides four new directives that
1239 give additional control over what Bacula does if duplicate jobs
1240 are started. A duplicate job in the sense we use it here means
1241 a second or subsequent job with the same name starts. This
1242 happens most frequently when the first job runs longer than expected because no
1243 tapes are available.
1245 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1246 are specified in the Job resource.
1250 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1251 \index[general]{Allow Duplicate Jobs}
1252 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1253 the directive is set to {\bf no} (default) then only one job of a given name
1254 may run at one time, and the action that Bacula takes to ensure only
1255 one job runs is determined by the other directives (see below).
1257 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1258 are present and none of the three directives given below permit
1259 cancelling a job, then the current job (the second one started)
1262 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1263 \index[general]{Allow Higher Duplicates}
1264 This directive was in version 5.0.0, but does not work as
1265 expected. If used, it should always be set to no. In later versions
1266 of Bacula the directive is disabled (disregarded).
1268 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1269 \index[general]{Cancel Running 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 already running
1272 will be canceled. The default is {\bf no}.
1274 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1275 \index[general]{Cancel Queued Duplicates}
1276 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1277 if this directive is set to {\bf yes} any job that is
1278 already queued to run but not yet running will be canceled.
1279 The default is {\bf no}.
1282 \section{TLS Authentication}
1283 \index[general]{TLS Authentication}
1284 In Bacula version 2.5.x and later, in addition to the normal Bacula
1285 CRAM-MD5 authentication that is used to authenticate each Bacula
1286 connection, you can specify that you want TLS Authentication as well,
1287 which will provide more secure authentication.
1289 This new feature uses Bacula's existing TLS code (normally used for
1290 communications encryption) to do authentication. To use it, you must
1291 specify all the TLS directives normally used to enable communications
1292 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1295 \subsection{TLS Authenticate = yes}
1297 TLS Authenticate = yes
1300 in the main daemon configuration resource (Director for the Director,
1301 Client for the File daemon, and Storage for the Storage daemon).
1303 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1304 authentication, Bacula will also do TLS authentication, then TLS
1305 encryption will be turned off, and the rest of the communication between
1306 the two Bacula daemons will be done without encryption.
1308 If you want to encrypt communications data, use the normal TLS directives
1309 but do not turn on {\bf TLS Authenticate}.
1311 \section{bextract non-portable Win32 data}
1312 \index[general]{bextract handles Win32 non-portable data}
1313 {\bf bextract} has been enhanced to be able to restore
1314 non-portable Win32 data to any OS. Previous versions were
1315 unable to restore non-portable Win32 data to machines that
1316 did not have the Win32 BackupRead and BackupWrite API calls.
1318 \section{State File updated at Job Termination}
1319 \index[general]{State File}
1320 In previous versions of Bacula, the state file, which provides a
1321 summary of previous jobs run in the {\bf status} command output was
1322 updated only when Bacula terminated, thus if the daemon crashed, the
1323 state file might not contain all the run data. This version of
1324 the Bacula daemons updates the state file on each job termination.
1326 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1327 \index[general]{MaxFullInterval}
1328 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1329 can be used to specify the maximum time interval between {\bf Full} backup
1330 jobs. When a job starts, if the time since the last Full backup is
1331 greater than the specified interval, and the job would normally be an
1332 {\bf Incremental} or {\bf Differential}, it will be automatically
1333 upgraded to a {\bf Full} backup.
1335 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1336 \index[general]{MaxDiffInterval}
1337 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1338 can be used to specify the maximum time interval between {\bf Differential} backup
1339 jobs. When a job starts, if the time since the last Differential backup is
1340 greater than the specified interval, and the job would normally be an
1341 {\bf Incremental}, it will be automatically
1342 upgraded to a {\bf Differential} backup.
1344 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1345 \index[general]{MaxDiffInterval}
1346 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1347 by the user, and when it is set it is an indication to backup programs
1348 to not backup that particular file. This version of Bacula contains a
1349 new Options directive within a FileSet resource, which instructs Bacula to
1350 obey this flag. The new directive is:
1353 Honor No Dump Flag = yes\vb{}no
1356 The default value is {\bf no}.
1359 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1360 \index[general]{IgnoreDir}
1361 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1362 can be added to the Include section of the FileSet resource. If the specified
1363 filename ({\bf filename-string}) is found on the Client in any directory to be
1364 backed up, the whole directory will be ignored (not backed up). For example:
1367 # List of files to be backed up
1375 Exclude Dir Containing = .excludeme
1380 But in /home, there may be hundreds of directories of users and some
1381 people want to indicate that they don't want to have certain
1382 directories backed up. For example, with the above FileSet, if
1383 the user or sysadmin creates a file named {\bf .excludeme} in
1384 specific directories, such as
1387 /home/user/www/cache/.excludeme
1388 /home/user/temp/.excludeme
1391 then Bacula will not backup the two directories named:
1394 /home/user/www/cache
1398 NOTE: subdirectories will not be backed up. That is, the directive
1399 applies to the two directories in question and any children (be they
1400 files, directories, etc).
1403 \section{Bacula Plugins}
1404 \index[general]{Plugin}
1405 Support for shared object plugins has been implemented in the Linux, Unix
1406 and Win32 File daemons. The API will be documented separately in
1407 the Developer's Guide or in a new document. For the moment, there is
1408 a single plugin named {\bf bpipe} that allows an external program to
1409 get control to backup and restore a file.
1411 Plugins are also planned (partially implemented) in the Director and the
1414 \subsection{Plugin Directory}
1415 \index[general]{Plugin Directory}
1416 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1417 be added to the daemon definition resource. The directory takes a quoted
1418 string argument, which is the name of the directory in which the daemon can
1419 find the Bacula plugins. If this directive is not specified, Bacula will not
1420 load any plugins. Since each plugin has a distinctive name, all the daemons
1421 can share the same plugin directory.
1423 \subsection{Plugin Options}
1424 \index[general]{Plugin Options}
1425 The {\bf Plugin Options} directive takes a quoted string
1426 arguement (after the equal sign) and may be specified in the
1427 Job resource. The options specified will be passed to all plugins
1428 when they are run. This each plugin must know what it is looking
1429 for. The value defined in the Job resource can be modified
1430 by the user when he runs a Job via the {\bf bconsole} command line
1433 Note: this directive may be specified, and there is code to modify
1434 the string in the run command, but the plugin options are not yet passed to
1435 the plugin (i.e. not fully implemented).
1437 \subsection{Plugin Options ACL}
1438 \index[general]{Plugin Options ACL}
1439 The {\bf Plugin Options ACL} directive may be specified in the
1440 Director's Console resource. It functions as all the other ACL commands
1441 do by permitting users running restricted consoles to specify a
1442 {\bf Plugin Options} that overrides the one specified in the Job
1443 definition. Without this directive restricted consoles may not modify
1446 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1447 \index[general]{Plugin}
1448 The {\bf Plugin} directive is specified in the Include section of
1449 a FileSet resource where you put your {\bf File = xxx} directives.
1460 Plugin = "bpipe:..."
1465 In the above example, when the File daemon is processing the directives
1466 in the Include section, it will first backup all the files in {\bf /home}
1467 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1468 the Plugin Directory. The syntax and semantics of the Plugin directive
1469 require the first part of the string up to the colon (:) to be the name
1470 of the plugin. Everything after the first colon is ignored by the File daemon but
1471 is passed to the plugin. Thus the plugin writer may define the meaning of the
1472 rest of the string as he wishes.
1474 Please see the next section for information about the {\bf bpipe} Bacula
1477 \section{The bpipe Plugin}
1478 \index[general]{The bpipe Plugin}
1479 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1480 the Bacula source distribution. When the plugin is compiled and linking into
1481 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1482 Please note that this is a very simple plugin that was written for
1483 demonstration and test purposes. It is and can be used in production, but
1484 that was never really intended.
1486 The purpose of the plugin is to provide an interface to any system program for
1487 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1488 the Include section of your Job's FileSet resource. The full syntax of the
1489 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1490 to specify the sytax as it wishes) is:
1493 Plugin = "<field1>:<field2>:<field3>:<field4>"
1498 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1499 stripped off, so in this case, we would put {\bf bpipe} in this field.
1501 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1502 pseudo path and filename under which the backup will be saved. This pseudo
1503 path and filename will be seen by the user in the restore file tree.
1504 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1505 backed up by the plugin will be put under that "pseudo" path and filename.
1506 You must be careful to choose a naming convention that is unique to avoid
1507 a conflict with a path and filename that actually exists on your system.
1509 \item {\bf field3} for the {\bf bpipe} plugin
1510 specifies the "reader" program that is called by the plugin during
1511 backup to read the data. {\bf bpipe} will call this program by doing a
1514 \item {\bf field4} for the {\bf bpipe} plugin
1515 specifies the "writer" program that is called by the plugin during
1516 restore to write the data back to the filesystem.
1519 Please note that for two items above describing the "reader" and "writer"
1520 fields, these programs are "executed" by Bacula, which
1521 means there is no shell interpretation of any command line arguments
1522 you might use. If you want to use shell characters (redirection of input
1523 or output, ...), then we recommend that you put your command or commands
1524 in a shell script and execute the script. In addition if you backup a
1525 file with the reader program, when running the writer program during
1526 the restore, Bacula will not automatically create the path to the file.
1527 Either the path must exist, or you must explicitly do so with your command
1528 or in a shell script.
1530 Putting it all together, the full plugin directive line might look
1534 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
1535 --opt --databases bacula:mysql"
1538 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1539 would be written on a single line.
1541 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1542 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
1543 program {\bf mysqldump -f --opt --database bacula} to read the data during
1544 backup. The mysqldump command outputs all the data for the database named
1545 {\bf bacula}, which will be read by the plugin and stored in the backup.
1546 During restore, the data that was backed up will be sent to the program
1547 specified in the last field, which in this case is {\bf mysql}. When
1548 {\bf mysql} is called, it will read the data sent to it by the plugn
1549 then write it back to the same database from which it came ({\bf bacula}
1552 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
1553 the data from a specified program to Bacula for backup, and then from Bacula to
1554 a specified program for restore.
1556 By using different command lines to {\bf bpipe},
1557 you can backup any kind of data (ASCII or binary) depending
1558 on the program called.
1560 \section{Microsoft Exchange Server 2003/2007 Plugin}
1561 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1562 \subsection{Background}
1563 The Exchange plugin was made possible by a funded development project
1564 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1565 The code for the plugin was written by James Harper, and the Bacula core
1566 code by Kern Sibbald. All the code for this funded development has become
1567 part of the Bacula project. Thanks to everyone who made it happen.
1569 \subsection{Concepts}
1570 Although it is possible to backup Exchange using Bacula VSS the Exchange
1571 plugin adds a good deal of functionality, because while Bacula VSS
1572 completes a full backup (snapshot) of Exchange, it does
1573 not support Incremental or Differential backups, restoring is more
1574 complicated, and a single database restore is not possible.
1576 Microsoft Exchange organises its storage into Storage Groups with
1577 Databases inside them. A default installation of Exchange will have a
1578 single Storage Group called 'First Storage Group', with two Databases
1579 inside it, "Mailbox Store (SERVER NAME)" and
1580 "Public Folder Store (SERVER NAME)",
1581 which hold user email and public folders respectively.
1583 In the default configuration, Exchange logs everything that happens to
1584 log files, such that if you have a backup, and all the log files since,
1585 you can restore to the present time. Each Storage Group has its own set
1586 of log files and operates independently of any other Storage Groups. At
1587 the Storage Group level, the logging can be turned off by enabling a
1588 function called "Enable circular logging". At this time the Exchange
1589 plugin will not function if this option is enabled.
1591 The plugin allows backing up of entire storage groups, and the restoring
1592 of entire storage groups or individual databases. Backing up and
1593 restoring at the individual mailbox or email item is not supported but
1594 can be simulated by use of the "Recovery" Storage Group (see below).
1596 \subsection{Installing}
1597 The Exchange plugin requires a DLL that is shipped with Microsoft
1598 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1599 correctly the Exchange plugin should find this automatically and run
1600 without any additional installation.
1602 If the DLL can not be found automatically it will need to be copied into
1603 the Bacula installation
1604 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1605 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1606 default Exchange installation.
1608 \subsection{Backing Up}
1609 To back up an Exchange server the Fileset definition must contain at
1610 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1611 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1612 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1613 up files are prefixed with something that isn't going to share a name
1614 with something outside the plugin, and the 'Microsoft Information Store'
1615 bit is required also. It is also possible to add the name of a storage
1616 group to the "Plugin =" line, eg \\
1617 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1618 if you want only a single storage group backed up.
1620 Additionally, you can suffix the 'Plugin =' directive with
1621 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1622 database at the end of a full backup.
1624 An Incremental or Differential backup will backup only the database logs
1625 for each Storage Group by inspecting the "modified date" on each
1626 physical log file. Because of the way the Exchange API works, the last
1627 logfile backed up on each backup will always be backed up by the next
1628 Incremental or Differential backup too. This adds 5MB to each
1629 Incremental or Differential backup size but otherwise does not cause any
1632 By default, a normal VSS fileset containing all the drive letters will
1633 also back up the Exchange databases using VSS. This will interfere with
1634 the plugin and Exchange's shared ideas of when the last full backup was
1635 done, and may also truncate log files incorrectly. It is important,
1636 therefore, that the Exchange database files be excluded from the backup,
1637 although the folders the files are in should be included, or they will
1638 have to be recreated manually if a baremetal restore is done.
1643 File = C:/Program Files/Exchsrvr/mdbdata
1644 Plugin = "exchange:..."
1647 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1648 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1649 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1650 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1651 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1652 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1653 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1658 The advantage of excluding the above files is that you can significantly
1659 reduce the size of your backup since all the important Exchange files
1660 will be properly saved by the Plugin.
1663 \subsection{Restoring}
1664 The restore operation is much the same as a normal Bacula restore, with
1665 the following provisos:
1668 \item The {\bf Where} restore option must not be specified
1669 \item Each Database directory must be marked as a whole. You cannot just
1670 select (say) the .edb file and not the others.
1671 \item If a Storage Group is restored, the directory of the Storage Group
1673 \item It is possible to restore only a subset of the available log files,
1674 but they {\bf must} be contiguous. Exchange will fail to restore correctly
1675 if a log file is missing from the sequence of log files
1676 \item Each database to be restored must be dismounted and marked as "Can be
1677 overwritten by restore"
1678 \item If an entire Storage Group is to be restored (eg all databases and
1679 logs in the Storage Group), then it is best to manually delete the
1680 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1681 as Exchange can get confused by stray log files lying around.
1684 \subsection{Restoring to the Recovery Storage Group}
1685 The concept of the Recovery Storage Group is well documented by
1687 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
1688 but to briefly summarize...
1690 Microsoft Exchange allows the creation of an additional Storage Group
1691 called the Recovery Storage Group, which is used to restore an older
1692 copy of a database (e.g. before a mailbox was deleted) into without
1693 messing with the current live data. This is required as the Standard and
1694 Small Business Server versions of Exchange can not ordinarily have more
1695 than one Storage Group.
1697 To create the Recovery Storage Group, drill down to the Server in Exchange
1698 System Manager, right click, and select
1699 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
1700 locations and click OK. On the Recovery Storage Group, right click and
1701 select {\bf "Add Database to Recover..."} and select the database you will
1704 Restore only the single database nominated as the database in the
1705 Recovery Storage Group. Exchange will redirect the restore to the
1706 Recovery Storage Group automatically.
1707 Then run the restore.
1709 \subsection{Restoring on Microsoft Server 2007}
1710 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1711 2007, and henc you use a new proceedure for recovering a single mail box.
1712 This procedure is ducomented by Microsoft at:
1713 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1714 and involves using the {\bf Restore-Mailbox} and {\bf
1715 Get-MailboxStatistics} shell commands.
1717 \subsection{Caveats}
1718 This plugin is still being developed, so you should consider it
1719 currently in BETA test, and thus use in a production environment
1720 should be done only after very careful testing.
1722 When doing a full backup, the Exchange database logs are truncated by
1723 Exchange as soon as the plugin has completed the backup. If the data
1724 never makes it to the backup medium (eg because of spooling) then the
1725 logs will still be truncated, but they will also not have been backed
1726 up. A solution to this is being worked on. You will have to schedule a
1727 new Full backup to ensure that your next backups will be usable.
1729 The "Enable Circular Logging" option cannot be enabled or the plugin
1732 Exchange insists that a successful Full backup must have taken place if
1733 an Incremental or Differential backup is desired, and the plugin will
1734 fail if this is not the case. If a restore is done, Exchange will
1735 require that a Full backup be done before an Incremental or Differential
1738 The plugin will most likely not work well if another backup application
1739 (eg NTBACKUP) is backing up the Exchange database, especially if the
1740 other backup application is truncating the log files.
1742 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1743 we recommend either carefully testing or that you avoid this option for
1746 The Exchange plugin is not called during processing the bconsole {\bf
1747 estimate} command, and so anything that would be backed up by the plugin
1748 will not be added to the estimate total that is displayed.
1751 \section{libdbi Framework}
1752 \index[general]{libdbi Framework}
1753 As a general guideline, Bacula has support for a few catalog database drivers
1754 (MySQL, PostgreSQL, SQLite)
1755 coded natively by the Bacula team. With the libdbi implementation, which is a
1756 Bacula driver that uses libdbi to access the catalog, we have an open field to
1757 use many different kinds database engines following the needs of users.
1759 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1760 implements a database-independent abstraction layer in C, similar to the
1761 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1762 leverage the power of multiple databases and multiple simultaneous database
1763 connections by using this framework.
1765 Currently the libdbi driver in Bacula project only supports the same drivers
1766 natively coded in Bacula. However the libdbi project has support for many
1767 others database engines. You can view the list at
1768 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1769 supported by Bacula, however, they must be tested properly by the Bacula team.
1771 Some of benefits of using libdbi are:
1773 \item The possibility to use proprietary databases engines in which your
1774 proprietary licenses prevent the Bacula team from developing the driver.
1775 \item The possibility to use the drivers written for the libdbi project.
1776 \item The possibility to use other database engines without recompiling Bacula
1777 to use them. Just change one line in bacula-dir.conf
1778 \item Abstract Database access, this is, unique point to code and profiling
1779 catalog database access.
1782 The following drivers have been tested:
1784 \item PostgreSQL, with and without batch insert
1785 \item Mysql, with and without batch insert
1790 In the future, we will test and approve to use others databases engines
1791 (proprietary or not) like DB2, Oracle, Microsoft SQL.
1793 To compile Bacula to support libdbi we need to configure the code with the
1794 --with-dbi and --with-dbi-driver=[database] ./configure options, where
1795 [database] is the database engine to be used with Bacula (of course we can
1796 change the driver in file bacula-dir.conf, see below). We must configure the
1797 access port of the database engine with the option --with-db-port, because the
1798 libdbi framework doesn't know the default access port of each database.
1800 The next phase is checking (or configuring) the bacula-dir.conf, example:
1804 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1805 dbname = regress; user = regress; password = ""
1809 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1810 mysql database. Currently the drivers supported by Bacula are: postgresql,
1811 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1813 The following limitations apply when Bacula is set to use the libdbi framework:
1814 - Not tested on the Win32 platform
1815 - A little performance is lost if comparing with native database driver.
1816 The reason is bound with the database driver provided by libdbi and the
1817 simple fact that one more layer of code was added.
1819 It is important to remember, when compiling Bacula with libdbi, the
1820 following packages are needed:
1822 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1823 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1826 You can download them and compile them on your system or install the packages
1827 from your OS distribution.
1829 \section{Console Command Additions and Enhancements}
1830 \index[general]{Console Additions}
1832 \subsection{Display Autochanger Content}
1833 \index[general]{StatusSlots}
1835 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1836 autochanger content.
1840 Slot | Volume Name | Status | Media Type | Pool |
1841 ------+---------------+----------+-------------------+------------|
1842 1 | 00001 | Append | DiskChangerMedia | Default |
1843 2 | 00002 | Append | DiskChangerMedia | Default |
1844 3*| 00003 | Append | DiskChangerMedia | Scratch |
1849 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1850 {\bf update slots} command to synchronize autochanger content with your
1853 \subsection{list joblog job=xxx or jobid=nnn}
1854 \index[general]{list joblog}
1855 A new list command has been added that allows you to list the contents
1856 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1857 or for a particular JobId. The {\bf llist} command will include a line with
1858 the time and date of the entry.
1860 Note for the catalog to have Job Log entries, you must have a directive
1867 In your Director's {\bf Messages} resource.
1869 \subsection{Use separator for multiple commands}
1870 \index[general]{Command Separator}
1871 When using bconsole with readline, you can set the command separator with
1872 \textbf{@separator} command to one
1873 of those characters to write commands who require multiple input in one line.
1875 !$%&'()*+,-/:;<>?[]^`{|}~
1878 \subsection{Deleting Volumes}
1879 The delete volume bconsole command has been modified to
1880 require an asterisk (*) in front of a MediaId otherwise the
1881 value you enter is a taken to be a Volume name. This is so that
1882 users may delete numeric Volume names. The previous Bacula versions
1883 assumed that all input that started with a number was a MediaId.
1885 This new behavior is indicated in the prompt if you read it
1888 \section{Bare Metal Recovery}
1889 The old bare metal recovery project is essentially dead. One
1890 of the main features of it was that it would build a recovery
1891 CD based on the kernel on your system. The problem was that
1892 every distribution has a different boot procedure and different
1893 scripts, and worse yet, the boot procedures and scripts change
1894 from one distribution to another. This meant that maintaining
1895 (keeping up with the changes) the rescue CD was too much work.
1897 To replace it, a new bare metal recovery USB boot stick has been developed
1898 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
1899 boot from a USB key.
1903 \item Recovery can be done from within graphical environment.
1904 \item Recovery can be done in a shell.
1905 \item Ubuntu boots on a large number of Linux systems.
1906 \item The process of updating the system and adding new
1907 packages is not too difficult.
1908 \item The USB key can easily be upgraded to newer Ubuntu versions.
1909 \item The USB key has writable partitions for modifications to
1910 the OS and for modification to your home directory.
1911 \item You can add new files/directories to the USB key very easily.
1912 \item You can save the environment from multiple machines on
1914 \item Bacula Systems is funding its ongoing development.
1917 The disadvantages are:
1919 \item The USB key is usable but currently under development.
1920 \item Not everyone may be familiar with Ubuntu (no worse
1922 \item Some older OSes cannot be booted from USB. This can
1923 be resolved by first booting a Ubuntu LiveCD then plugging
1925 \item Currently the documentation is sketchy and not yet added
1926 to the main manual. See below ...
1929 The documentation and the code can be found in the {\bf rescue} package
1930 in the directory {\bf linux/usb}.
1932 \section{Miscellaneous}
1933 \index[general]{Misc New Features}
1935 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
1936 \index[general]{Allow Mixed Priority}
1937 This directive is only implemented in version 2.5 and later. When
1938 set to {\bf yes} (default {\bf no}), this job may run even if lower
1939 priority jobs are already running. This means a high priority job
1940 will not have to wait for other jobs to finish before starting.
1941 The scheduler will only mix priorities when all running jobs have
1944 Note that only higher priority jobs will start early. Suppose the
1945 director will allow two concurrent jobs, and that two jobs with
1946 priority 10 are running, with two more in the queue. If a job with
1947 priority 5 is added to the queue, it will be run as soon as one of
1948 the running jobs finishes. However, new priority 10 jobs will not
1949 be run until the priority 5 job has finished.
1951 \subsection{Bootstrap File Directive -- FileRegex}
1952 \index[general]{Bootstrap File Directive}
1953 {\bf FileRegex} is a new command that can be added to the bootstrap
1954 (.bsr) file. The value is a regular expression. When specified, only
1955 matching filenames will be restored.
1957 During a restore, if all File records are pruned from the catalog
1958 for a Job, normally Bacula can restore only all files saved. That
1959 is there is no way using the catalog to select individual files.
1960 With this new feature, Bacula will ask if you want to specify a Regex
1961 expression for extracting only a part of the full backup.
1964 Building directory tree for JobId(s) 1,3 ...
1965 There were no files inserted into the tree, so file selection
1966 is not possible.Most likely your retention policy pruned the files
1968 Do you want to restore all the files? (yes\vb{}no): no
1970 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1971 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1974 \subsection{Bootstrap File Optimization Changes}
1975 In order to permit proper seeking on disk files, we have extended the bootstrap
1976 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1977 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1978 address range and end address range respectively. These two directives replace
1979 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1980 VolEndBlock} directives. Bootstrap files containing the old directives will
1981 still work, but will not properly take advantage of proper disk seeking, and
1982 may read completely to the end of a disk volume during a restore. With the new
1983 format (automatically generated by the new Director), restores will seek
1984 properly and stop reading the volume when all the files have been restored.
1986 \subsection{Solaris ZFS/NFSv4 ACLs}
1987 This is an upgrade of the previous Solaris ACL backup code
1988 to the new library format, which will backup both the old
1989 POSIX(UFS) ACLs as well as the ZFS ACLs.
1991 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1992 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1993 be used to transfer from UFS to ZFS filesystems.
1996 \subsection{Virtual Tape Emulation}
1997 \index[general]{Virtual Tape Emulation}
1998 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1999 the tape code but actually reading and writing to a disk file. Used with the
2000 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2001 and 700 slots. This feature is most useful in testing. It is enabled
2002 by using {\bf Device Type = vtape} in the Storage daemon's Device
2003 directive. This feature is only implemented on Linux machines and should not be
2004 used for production.
2006 \subsection{Bat Enhancements}
2007 \index[general]{Bat Enhancements}
2008 Bat (the Bacula Administration Tool) GUI program has been significantly
2009 enhanced and stabilized. In particular, there are new table based status
2010 commands; it can now be easily localized using Qt4 Linguist.
2012 The Bat communications protocol has been significantly enhanced to improve
2013 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2014 the Director you are using otherwise the communications protocol will not
2017 \subsection{RunScript Enhancements}
2018 \index[general]{RunScript Enhancements}
2019 The {\bf RunScript} resource has been enhanced to permit multiple
2020 commands per RunScript. Simply specify multiple {\bf Command} directives
2027 Command = "/bin/echo test"
2028 Command = "/bin/echo an other test"
2029 Command = "/bin/echo 3 commands in the same runscript"
2036 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2037 implemented, which runs the command after the Volume Shadow Copy has been made.
2039 Console commands can be specified within a RunScript by using:
2040 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2041 carefully tested and debugged and is known to easily crash the Director.
2042 We would appreciate feedback. Due to the recursive nature of this command, we
2043 may remove it before the final release.
2045 \subsection{Status Enhancements}
2046 \index[general]{Status Enhancements}
2047 The bconsole {\bf status dir} output has been enhanced to indicate
2048 Storage daemon job spooling and despooling activity.
2050 \subsection{Connect Timeout}
2051 \index[general]{Connect Timeout}
2052 The default connect timeout to the File
2053 daemon has been set to 3 minutes. Previously it was 30 minutes.
2055 \subsection{ftruncate for NFS Volumes}
2056 \index[general]{ftruncate for NFS Volumes}
2057 If you write to a Volume mounted by NFS (say on a local file server),
2058 in previous Bacula versions, when the Volume was recycled, it was not
2059 properly truncated because NFS does not implement ftruncate (file
2060 truncate). This is now corrected in the new version because we have
2061 written code (actually a kind user) that deletes and recreates the Volume,
2062 thus accomplishing the same thing as a truncate.
2064 \subsection{Support for Ubuntu}
2065 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2066 version of Linux, and thus now provides correct autostart routines.
2067 Since Ubuntu officially supports Bacula, you can also obtain any
2068 recent release of Bacula from the Ubuntu repositories.
2070 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2071 \index[general]{Recycle Pool}
2072 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2073 be placed (moved) when it is recycled. Without this directive, a Volume will
2074 remain in the same pool when it is recycled. With this directive, it can be
2075 moved automatically to any existing pool during a recycle. This directive is
2076 probably most useful when defined in the Scratch pool, so that volumes will
2077 be recycled back into the Scratch pool.
2079 \subsection{FD Version}
2080 \index[general]{FD Version}
2081 The File daemon to Director protocol now includes a version
2082 number, which although there is no visible change for users,
2083 will help us in future versions automatically determine
2084 if a File daemon is not compatible.
2086 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2087 \index[general]{Max Run Sched Time}
2088 The time specifies the maximum allowed time that a job may run, counted from
2089 when the job was scheduled. This can be useful to prevent jobs from running
2090 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2093 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2094 \index[general]{Max Wait Time}
2095 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2096 of checking the maximum allowed time that a job may block for a resource,
2097 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2098 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2099 their job depending on the level. Now, they have to use
2100 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2101 directives are now deprecated.
2103 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2104 \index[general]{Incremental Max Wait Time}
2105 \index[general]{Differential Max Wait Time}
2107 These directives have been deprecated in favor of
2108 \texttt{Incremental|Differential Max Run Time}.
2110 \subsection{Max Run Time directives}
2111 \index[general]{Max Run Time directives}
2112 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2113 maximum allowed time that a job can run depending on the level.
2115 \begin{figure}[htbp]
2117 \includegraphics[width=13cm]{\idir different_time.eps}
2118 \caption{Job time control directives}
2121 \subsection{Statistics Enhancements}
2122 \index[general]{Statistics Enhancements}
2123 If you (or probably your boss) want to have statistics on your backups to
2124 provide some \textit{Service Level Agreement} indicators, you could use a few
2125 SQL queries on the Job table to report how many:
2129 \item jobs have been successful
2130 \item files have been backed up
2134 However, these statistics are accurate only if your job retention is greater
2135 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2136 be able to use them.
2138 Now, you can use the \textbf{update stats [days=num]} console command to fill
2139 the JobHistory table with new Job records. If you want to be sure to take in
2140 account only \textbf{good jobs}, ie if one of your important job has failed but
2141 you have fixed the problem and restarted it on time, you probably want to
2142 delete the first \textit{bad} job record and keep only the successful one. For
2143 that simply let your staff do the job, and update JobHistory table after two or
2144 three days depending on your organization using the \textbf{[days=num]} option.
2146 These statistics records aren't used for restoring, but mainly for
2147 capacity planning, billings, etc.
2149 The Bweb interface provides a statistics module that can use this feature. You
2150 can also use tools like Talend or extract information by yourself.
2152 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2153 the length of time that Bacula will keep statistics job records in the Catalog
2154 database after the Job End time. (In \texttt{JobHistory} table) When this time
2155 period expires, and if user runs \texttt{prune stats} command, Bacula will
2156 prune (remove) Job records that are older than the specified period.
2158 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2159 job to maintain statistics.
2162 Name = BackupCatalog
2165 Console = "update stats days=3"
2166 Console = "prune stats yes"
2173 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2174 \index[general]{ScratchPool}
2175 This directive permits to specify a specific \textsl{Scratch} pool for the
2176 current pool. This is useful when using multiple storage sharing the same
2177 mediatype or when you want to dedicate volumes to a particular set of pool.
2179 \subsection{Enhanced Attribute Despooling}
2180 \index[general]{Attribute Despooling}
2181 If the storage daemon and the Director are on the same machine, the spool file
2182 that contains attributes is read directly by the Director instead of being
2183 transmitted across the network. That should reduce load and speedup insertion.
2185 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2186 \index[general]{SpoolSize}
2187 A new Job directive permits to specify the spool size per job. This is used
2188 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2190 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2191 \index[general]{MaximumConsoleConnections}
2192 A new director directive permits to specify the maximum number of Console
2193 Connections that could run concurrently. The default is set to 20, but you may
2194 set it to a larger number.
2196 \subsection{VerId = \lt{}string\gt{}}
2197 \index[general]{VerId}
2198 A new director directive permits to specify a personnal identifier that will be
2199 displayed in the \texttt{version} command.
2201 \subsection{dbcheck enhancements}
2202 \index[general]{dbcheck enhancements}
2203 If you are using Mysql, dbcheck will now ask you if you want to create
2204 temporary indexes to speed up orphaned Path and Filename elimination.
2206 A new \texttt{-B} option allows you to print catalog information in a simple
2207 text based format. This is useful to backup it in a secure way.
2222 You can now specify the database connection port in the command line.
2224 \subsection{{-}{-}docdir configure option}
2225 \index[general]{{-}{-}docdir configure option}
2226 You can use {-}{-}docdir= on the ./configure command to
2227 specify the directory where you want Bacula to install the
2228 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2229 {\bf /usr/share/doc/bacula}.
2231 \subsection{{-}{-}htmldir configure option}
2232 \index[general]{{-}{-}htmldir configure option}
2233 You can use {-}{-}htmldir= on the ./configure command to
2234 specify the directory where you want Bacula to install the bat html help
2235 files. The default is {\bf /usr/share/doc/bacula/html}
2237 \subsection{{-}{-}with-plugindir configure option}
2238 \index[general]{{-}{-}plugindir configure option}
2239 You can use {-}{-}plugindir= on the ./configure command to
2240 specify the directory where you want Bacula to install
2241 the plugins (currently only bpipe-fd). The default is