1 \chapter{New Features in 7.0.0}
2 This chapter presents the new features that have been added to the next
3 Community version of Bacula that is not yet released.
5 \section{New Features in 7.0.0}
7 \subsection{Storage daemon to Storage daemon}
8 Bacula version 7.0 permits SD to SD transfer of Copy and Migration
9 Jobs. This permits what is commonly referred to as replication or
10 off-site transfer of Bacula backups. It occurs automatically, if
11 the source SD and destination SD of a Copy or Migration job are
12 different. The following picture shows how this works.
14 \includegraphics[width=0.8\linewidth]{sd-to-sd}
16 \subsection{SD Calls Client}
17 If the {\bf SD Calls Client} directive is set to true in a Client resource
18 any Backup, Restore, Verify, Copy, or Migration Job where the client
19 is involved, the client will wait for the Storage daemon to contact it.
20 By default this directive is set to false, and the Client will call
21 the Storage daemon. This directive can be useful if your Storage daemon
22 is behind a firewall that permits outgoing connections but not incoming
23 one. The following picture shows the communications connection paths in
26 \includegraphics[width=0.8\linewidth]{sd-calls-client}
28 \subsection{Next Pool}
29 In previous versions of Bacula the Next Pool directive could be
30 specified in the Pool resource for use with Migration and Copy Jobs.
31 The Next Pool concept has been
32 extended in Bacula version 7.0.0 to allow you to specify the
33 Next Pool directive in the Job resource as well. If specified in
34 the Job resource, it will override any value specified in the Pool
37 In addition to being permitted in the Job resource, the
38 {\bf nextpool=xxx) specification can be specified as a run
39 override in the {\bf run} directive of a Schedule resource.
40 Any {\bf nextpool} specification in a {\bf run}
41 directive will override any other specification in either
44 In general, more information is displayed in the Job log
45 on exactly which Next Pool specification is ultimately used.
47 \subsection{status schedule}
48 A new status command option called {\bf scheduled} has been implemented
49 in bconsole. By default it will display 20 lines of the next scheduled
50 jobs. For example, with the default bacula-dir.conf configuration file,
51 a bconsole command {\bf status scheduled} produces:
55 Level Type Pri Scheduled Job Name Schedule
56 ======================================================================
57 Differential Backup 10 Sun 30-Mar 23:05 BackupClient1 WeeklyCycle
58 Incremental Backup 10 Mon 24-Mar 23:05 BackupClient1 WeeklyCycle
59 Incremental Backup 10 Tue 25-Mar 23:05 BackupClient1 WeeklyCycle
60 Incremental Backup 10 Wed 26-Mar 23:05 BackupClient1 WeeklyCycle
61 Incremental Backup 10 Thu 27-Mar 23:05 BackupClient1 WeeklyCycle
62 Incremental Backup 10 Fri 28-Mar 23:05 BackupClient1 WeeklyCycle
63 Incremental Backup 10 Sat 29-Mar 23:05 BackupClient1 WeeklyCycle
64 Incremental Backup 10 Mon 31-Mar 23:05 BackupClient1 WeeklyCycle
65 Incremental Backup 10 Tue 01-Apr 23:05 BackupClient1 WeeklyCycle
66 Incremental Backup 10 Wed 02-Apr 23:05 BackupClient1 WeeklyCycle
67 Full Backup 11 Mon 24-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
68 Full Backup 11 Tue 25-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
69 Full Backup 11 Wed 26-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
70 Full Backup 11 Thu 27-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
71 Full Backup 11 Fri 28-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
72 Full Backup 11 Sat 29-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
73 Full Backup 11 Sun 30-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
74 Full Backup 11 Mon 31-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
75 Full Backup 11 Tue 01-Apr 23:10 BackupCatalog WeeklyCycleAfterBackup
76 Full Backup 11 Wed 02-Apr 23:10 BackupCatalog WeeklyCycleAfterBackup
80 Note, the output is listed by the Jobs found, and is not sorted
83 This command has a number of options, most of which act as filters:
85 \item {\bf days=nn} This specifies the number of days to list. The default is
86 10 but can be set from 0 to 500.
87 \item {\bf limit=nn} This specifies the limit to the number of lines to print.
88 The default is 100 but can be any number in the range 0 to 2000.
89 \item {\bf time="YYYY-MM-DD HH:MM:SS"} Sets the start time for listing the
90 scheduled jobs. The default is to use the current time. Note, the
91 time value must be specified inside double quotes and must be in
92 the exact form shown above.
93 \item {\bf schedule=schedule-name} This option restricts the output to
95 \item {\bf job=job-name} This option restricts the output to the specified
99 \subsection{Data Encryption Cipher Configuration}
100 Bacula version 7.0 and later now allows to configure the data
101 encryption cipher and the digest algorithm. The cipher was forced to AES
103 and it is now possible to choose between the following ciphers:
106 \item AES128 (default)
112 The digest algorithm was set to SHA1 or SHA256 depending on the local
114 options. We advise you to not modify the PkiDigest default setting. Please,
115 refer to OpenSSL documentation to know about pro and cons on these options.
124 \subsection{New Truncate Command}
125 We have added a new truncate command to bconsole, which
126 will truncate a Volume if the Volume is purged and if
127 the Volume is also marked {\bf Action On Purge = Truncate}.
128 This feature was originally added in Bacula version 5.0.1,
129 but the mechanism for actually doing the truncate required
130 the user to enter a command such as:
133 purge volume action=truncate storage=File pool=Default
136 The above command is now simplified to be:
139 truncate storage=File pool=Default
142 \subsection{New Resume Command}
143 This command does exactly the same thing as a
144 {\bf restart} command but for some users the
145 name may be more logical since in general the
146 {\bf restart} command is used to resume running
147 a Job that was incompleted.
149 \subsection{Migration/Copy/VirtualFull Performance Enhancements}
150 The Bacula Storage daemon now permits multiple jobs to simultaneously read
151 the same disk Volume, which gives substantial performance enhancements when
152 running Migration, Copy, or VirtualFull jobs that read disk Volumes. Our
153 testing shows that when running multiple simultaneous jobs, the jobs can
154 finish up to ten times faster with this version of Bacula. This is
155 built-in to the Storage daemon, so it happens automatically and
158 \subsection{VirtualFull Backup Consolidation Enhancements}
159 By default Bacula selects jobs automatically for a VirtualFull,
160 however, you may want to create the Virtual backup based on a
161 particular backup (point in time) that exists.
163 For example, if you have the following backup Jobs in your catalog:
165 +-------+---------+-------+----------+----------+-----------+
166 | JobId | Name | Level | JobFiles | JobBytes | JobStatus |
167 +-------+---------+-------+----------+----------+-----------+
168 | 1 | Vbackup | F | 1754 | 50118554 | T |
169 | 2 | Vbackup | I | 1 | 4 | T |
170 | 3 | Vbackup | I | 1 | 4 | T |
171 | 4 | Vbackup | D | 2 | 8 | T |
172 | 5 | Vbackup | I | 1 | 6 | T |
173 | 6 | Vbackup | I | 10 | 60 | T |
174 | 7 | Vbackup | I | 11 | 65 | T |
175 | 8 | Save | F | 1758 | 50118564 | T |
176 +-------+---------+-------+----------+----------+-----------+
179 and you want to consolidate only the first 3 jobs and create a
180 virtual backup equivalent to Job 1 + Job 2 + Job 3, you will use
181 \texttt{jobid=3} in the \texttt{run} command, then Bacula will select the
182 previous Full backup, the previous Differential (if any) and all subsequent
186 run job=Vbackup jobid=3 level=VirtualFull
189 If you want to consolidate a specific job list, you must specify the exact
190 list of jobs to merge in the run command line. For example, to consolidate
191 the last Differential and all subsequent Incremental, you will use
192 \texttt{jobid=4,5,6,7} or \texttt{jobid=4-7} on the run command line. As one
193 of the Job in the list is a Differential backup, Bacula will set the new job
194 level to Differential. If the list is composed only with Incremental jobs,
195 the new job will have a level set to Incremental.
198 run job=Vbackup jobid=4-7 level=VirtualFull
201 When using this feature, Bacula will automatically discard jobs that are
202 not related to the current Job. For example, specifying
203 \texttt{jobid=7,8}, Bacula will discard JobId 8 because it is not
204 part of the same backup Job.
206 We do not recommend it, but really want to consolidate jobs that have
207 different names (so probably different clients, filesets, etc...), you must
208 use \texttt{alljobid=} keyword instead of \texttt{jobid=}.
211 run job=Vbackup alljobid=1-3,6-8 level=VirtualFull
215 \subsection{FD Storage Address}
217 When the Director is behind a NAT, in a WAN area, to connect to
219 the StorageDaemon, the Director uses an ``external'' ip address,
220 and the FileDaemon should use an ``internal'' IP address to contact the
223 The normal way to handle this situation is to use a canonical name such as
224 ``storage-server'' that will be resolved on the Director side as the WAN
225 address and on the Client side as the LAN address. This is now possible to
226 configure this parameter using the new directive \texttt{FDStorageAddress} in
227 the Storage or Client resource.
230 \includegraphics[width=0.8\linewidth]{BackupOverWan1}
231 \label{fig:fdstorageaddress}
237 FD Storage Address = 10.0.0.1
243 % # or in the Client resouce
250 FD Storage Address = 10.0.0.1
256 Note that using the Client \texttt{FDStorageAddress} directive will not allow
257 to use multiple Storage Daemon, all Backup or Restore requests will be sent to
258 the specified \texttt{FDStorageAddress}.
260 \subsection{Job Bandwidth Limitation}
262 The new {\bf Job Bandwidth Limitation} directive may be added to the File
263 daemon's and/or Director's configuration to limit the bandwidth used by a
264 Job on a Client. It can be set in the File daemon's conf file for all Jobs
265 run in that File daemon, or it can be set for each Job in the Director's
266 conf file. The speed is always specified in bytes per second.
272 Working Directory = /some/path
273 Pid Directory = /some/path
275 Maximum Bandwidth Per Job = 5Mb/s
279 The above example would cause any jobs running with the FileDaemon to not
280 exceed 5 megabytes per second of throughput when sending data to the
281 Storage Daemon. Note, the speed is always specified in bytes per second
282 (not in bits per second), and the case (upper/lower) of the specification
283 characters is ignored (i.e. 1MB/s = 1Mb/s).
285 You may specify the following speed parameter modifiers:
286 k/s (1,000 bytes per second), kb/s (1,024 bytes per second),
287 m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second).
293 FileSet = FS_localhost
296 Maximum Bandwidth = 5Mb/s
301 The above example would cause Job \texttt{localhost-data} to not exceed 5MB/s
302 of throughput when sending data from the File daemon to the Storage daemon.
304 A new console command \texttt{setbandwidth} permits to set dynamically the
305 maximum throughput of a running Job or for future jobs of a Client.
308 * setbandwidth limit=1000 jobid=10
311 Please note that the value specified for the \texttt{limit} command
312 line parameter is always in units of 1024 bytes (i.e. the number
313 is multiplied by 1024 to give the number of bytes per second). As
314 a consequence, the above limit of 1000 will be interpreted as a
315 limit of 1000 * 1024 = 1,024,000 bytes per second.
318 This project was funded by Bacula Systems.
321 \subsection{Maximum Concurrent Read Jobs}
322 This is a new directive that can be used in the {\bf bacula-dir.conf} file
323 in the Storage resource. The main purpose is to limit the number
324 of concurrent Copy, Migration, and VirtualFull jobs so that
325 they don't monopolize all the Storage drives causing a deadlock situation
326 where all the drives are allocated for reading but none remain for
327 writing. This deadlock situation can occur when running multiple
328 simultaneous Copy, Migration, and VirtualFull jobs.
331 The default value is set to 0 (zero), which means there is no
332 limit on the number of read jobs. Note, limiting the read jobs
333 does not apply to Restore jobs, which are normally started by
334 hand. A reasonable value for this directive is one half the number
335 of drives that the Storage resource has rounded down. Doing so,
336 will leave the same number of drives for writing and will generally
337 avoid over committing drives and a deadlock.
340 \subsection{Director job Codes in Message Resource Commands}
341 Before submitting the specified mail command to the operating system, Bacula
342 performs character substitution like in Runscript commands. Bacula will now
343 perform also specific Director character substitution.
346 The code for this feature was contributed by Bastian Friedrich.
348 \subsection{Additions to RunScript variables}
349 The following variables are now available in runscripts:
351 \item current PID using \%P
352 \item if the job is a clone job using \%C
356 RunAfterJob = "/bin/echo Pid=%P isCloned=%C"
360 \subsection{Read Only Storage Devices}
361 This version of Bacula permits defining a Storage deamon device
362 to be read-only. That is if the {\bf ReadOnly} directive is specified and
363 enabled, the drive can only be used for read operations.
364 The the {\bf ReadOnly} directive can be defined in any bacula-sd.conf
365 Device resource, and is most useful to reserve one or more
366 drives for restores. An example is:
372 \subsection{New Prune ``Expired'' Volume Command}
373 It is now possible to prune all volumes
374 (from a pool, or globally) that are ``expired''. This option can be
375 scheduled after or before the backup of the Catalog and can be
376 combined with the Truncate On Purge option. The Expired Prune option can
377 be used instead of the \texttt{manual\_prune.pl} script.
380 * prune expired volumes
382 * prune expired volumes pool=FullPool
385 To schedule this option automatically, it can be added to the BackupCatalog job
393 Console = "prune expired volume yes"
399 \subsection{Hardlink Performance Enhancements}
400 If you use a program such as Cyrus IMAP that creates very large numbers
401 of hardlinks, the time to build the interactive restore tree can be
402 excessively long. This version of Bacula has a new feature that
403 automatically keeps the hardlinks associated with the restore tree
404 in memory, which consumes a bit more memory but vastly speeds up
405 building the tree. If the memory usage is too big for your system, you
406 can reduce the amount of memory used during the restore command by
407 adding the option {\bf optimizespeed=false} on the bconsole run
410 This feature was developed by Josip Almasi, and enhanced to be runtime
411 dynamic by Kern Sibbald.
413 \subsection{Multiple Console Directors}
414 Support for multiple bconsole and bat Directors in the bconsole.conf and
415 bat.conf files has been implemented and/or improved.
417 \subsection{Restricted Consoles}
418 Better support for Restricted consoles has been implement for bconsole and
421 \subsection{Configuration Files}
422 In previous versions of Bacula the configuration files for each component
423 were limited to a maximum of 499 bytes per configuration file line. This
424 version of Bacula permits unlimited input line lengths. This can be
425 especially useful for specifying more complicated Migration/Copy SQL
426 statements and in creating long restricted console ACL lists.
428 \subsection{Maximum Spawned Jobs}
429 The Job resource now permits specifing a number of {\bf Maximum Spawn
430 Jobs}. The default is 300. This directive can be useful if you have
431 big hardware and you do a lot of Migration/Copy jobs which start
432 at the same time. In prior versions of Bacula, Migration/Copy
433 was limited to spawning a maximum of 100 jobs at a time.
435 \subsection{Progress Meter}
436 The new File daemon has been enhanced to send its progress (files
437 processed and bytes written) to the Director every 30 seconds. These
438 figures can then be displayed with a bconsole {\bf status dir}
441 \subsection{Scheduling a 6th Week}
442 Prior version of Bacula permits specifying 1st through 5th week of
443 a month (first through fifth) as a keyword on the {\bf run}
444 directive of a Schedule resource. This version of Bacula also permits
445 specifying the 6th week of a month with the keyword {\bf sixth} or
448 \subsection{Secheduling the Last Day of a Month}
449 This version of Bacula now premits specifying the {\bf lastday}
450 keyword in the {\bf run} directive of a Schedule resource.
451 If {\bf lastday} is specified, it will apply only to those months
452 specified on the {\bf run} directive. Note: by default all months
455 \subsection{Improvements to Cancel and Restart bconsole Commands}
456 The Restart bconsole command now allow selection of either
457 canceled or failed jobs to be restarted. In addition both the
458 {\bf cancel} and {\bf restart} bconsole commands permit entering
459 a number of JobIds separated by commas or a range of JobIds indicated
460 by a dash between the begin and end range (e.g. 3-10). Finally the
461 two commands also allow one to enter the special keyword {\bf all}
462 to select all the appropriate Jobs.
464 \subsection{bconsole Performance Improvements}
465 In previous versions of Bacula certain bconsole commands could wait a long
466 time due to catalog lock contention. This was especially noticable
467 when a large number of jobs were running and putting their attributes
468 into the catalog. This version uses a separate catalog connection that
469 should significantly enhance performance.
474 \subsection*{New Debug Options}
476 In Bacula Enterprise version 8.0 and later, we introduced new options to
477 the \texttt{setdebug} command.
481 If the \texttt{options} parameter is set, the following arguments can be
482 used to control debug functions.
485 \item [0] clear debug flags
486 \item [i] Turn off, ignore bwrite() errors on restore on File Daemon
487 \item [d] Turn off decomp of BackupRead() streams on File Daemon
488 \item [t] Turn on timestamp in traces
489 \item [T] Turn off timestamp in traces
490 \item [c] Truncate trace file if trace file is activated
491 \item [l] Turn on recoding events on P() and V()
492 \item [p] Turn on the display of the event ring when doing a bactrace
497 The following command will truncate the trace file and will turn on timestamps
501 * setdebug level=10 trace=1 options=ct fd
506 It is now possible to use \textsl{class} of debug messages called \texttt{tags}
507 to control the debug output of Bacula daemons.
510 \item [all] Display all debug messages
511 \item [bvfs] Display BVFS debug messages
512 \item [sql] Display SQL related debug messages
513 \item [memory] Display memory and poolmem allocation messages
514 \item [scheduler] Display scheduler related debug messages
518 * setdebug level=10 tags=bvfs,sql,memory
519 * setdebug level=10 tags=!bvfs
521 # bacula-dir -t -d 200,bvfs,sql
524 The \texttt{tags} option is composed of a list of tags, tags are separated by
525 ``,'' or ``+'' or ``-'' or ``!''. To disable a specific tag, use ``-'' or ``!''
526 in front of the tag. Note that more tags will come in future versions.
528 %\LTXtable{\linewidth}{table_debugtags}
531 \chapter{New Features in 5.2.13}
532 This chapter presents the new features that have been added to the current
533 Community version of Bacula that is now released.
535 \subsection{Additions to RunScript variables}
536 You can have access to Director name using \%D in your runscript
540 RunAfterJob = "/bin/echo Director=%D
543 \section{New Features in 5.2.1}
544 This chapter presents the new features were added in the
545 Community release version 5.2.1.
547 There are additional features (plugins) available in the Enterprise version
548 that are described in another chapter. A subscription to Bacula Systems
549 is required for the Enterprise version.
551 \subsection{LZO Compression}
553 LZO compression has been to the File daemon. From the user's point of view,
554 it works like the GZIP compression (just replace {\bf compression=GZIP} with
555 {\bf compression=LZO}).
560 Options {compression=LZO }
566 LZO provides a much faster compression and decompression speed but lower
567 compression ratio than GZIP. It is a good option when you backup to disk. For
568 tape, the hardware compression is almost always a better option.
570 LZO is a good alternative for GZIP1 when you don't want to slow down your
571 backup. With a modern CPU it should be able to run almost as fast as:
574 \item your client can read data from disk. Unless you have very fast disks like
575 SSD or large/fast RAID array.
576 \item the data transfers between the file daemon and the storage daemon even on
580 Note, Bacula uses compression level LZO1X-1.
583 The code for this feature was contributed by Laurent Papier.
585 \subsection{New Tray Monitor}
587 Since the old integrated Windows tray monitor doesn't work with
588 recent Windows versions, we have written a new Qt Tray Monitor that is available
589 for both Linux and Windows. In addition to all the previous features,
590 this new version allows you to run Backups from
591 the tray monitor menu.
595 \includegraphics[width=0.8\linewidth]{tray-monitor}
596 \label{fig:traymonitor}
597 \caption{New tray monitor}
602 \includegraphics[width=0.8\linewidth]{tray-monitor1}
603 \label{fig:traymonitor1}
604 \caption{Run a Job through the new tray monitor}
608 To be able to run a job from the tray monitor, you need to
609 allow specific commands in the Director monitor console:
614 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
615 ClientACL = *all* # you can restrict to a specific host
627 This project was funded by Bacula Systems and is available with Bacula
628 the Enterprise Edition and the Community Edition.
630 \subsection{Purge Migration Job}
632 The new {\bf Purge Migration Job} directive may be added to the Migration
633 Job definition in the Director's configuration file. When it is enabled
634 the Job that was migrated during a migration will be purged at
635 the end of the migration job.
643 Client = localhost-fd
646 Storage = DiskChanger
649 Selection Pattern = ".*Save"
651 Purge Migration Job = yes
657 This project was submitted by Dunlap Blake; testing and documentation was funded
660 \subsection{Changes in Bvfs (Bacula Virtual FileSystem)}
662 Bat has now a bRestore panel that uses Bvfs to display files and
667 \includegraphics[width=0.8\linewidth]{bat-brestore}
668 \label{fig:batbrestore}
669 \caption{Bat Brestore Panel}
672 the Bvfs module works correctly with BaseJobs, Copy and Migration jobs.
675 This project was funded by Bacula Systems.
677 \subsubsection*{General notes}
680 \item All fields are separated by a tab
681 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
682 records in very big directories
683 \item All operations (except cache creation) are designed to run instantly
684 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
685 can contribute new faster SQL queries we will be happy, else don't complain
687 \item The cache creation is dependent of the number of directories. As Bvfs
688 shares information across jobs, the first creation can be slow
689 \item All fields are separated by a tab
690 \item Due to potential encoding problem, it's advised to always use pathid in
694 \subsubsection*{Get dependent jobs from a given JobId}
696 Bvfs allows you to query the catalog against any combination of jobs. You
697 can combine all Jobs and all FileSet for a Client in a single session.
699 To get all JobId needed to restore a particular job, you can use the
700 \texttt{.bvfs\_get\_jobids} command.
703 .bvfs_get_jobids jobid=num [all]
707 .bvfs_get_jobids jobid=10
709 .bvfs_get_jobids jobid=10 all
713 In this example, a normal restore will need to use JobIds 1,2,5,10 to
714 compute a complete restore of the system.
716 With the \texttt{all} option, the Director will use all defined FileSet for
719 \subsubsection*{Generating Bvfs cache}
721 The \texttt{.bvfs\_update} command computes the directory cache for jobs
722 specified in argument, or for all jobs if unspecified.
725 .bvfs_update [jobid=numlist]
730 .bvfs_update jobid=1,2,3
733 You can run the cache update process in a RunScript after the catalog backup.
735 \subsubsection*{Get all versions of a specific file}
737 Bvfs allows you to find all versions of a specific file for a given Client with
738 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
739 function uses only PathId and FilenameId. The jobid argument is mandatory but
743 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
744 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
745 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
752 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
753 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
756 \subsubsection*{List directories}
758 Bvfs allows you to list directories in a specific path.
760 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
761 PathId FilenameId FileId JobId LStat Path
762 PathId FilenameId FileId JobId LStat Path
763 PathId FilenameId FileId JobId LStat Path
767 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
768 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
769 listed is a directory.
772 .bvfs_lsdirs pathid=4 jobid=1,11,12
773 4 0 0 0 A A A A A A A A A A A A A A .
774 5 0 0 0 A A A A A A A A A A A A A A ..
775 3 0 0 0 A A A A A A A A A A A A A A regress/
778 In this example, to list directories present in \texttt{regress/}, you can use
780 .bvfs_lsdirs pathid=3 jobid=1,11,12
781 3 0 0 0 A A A A A A A A A A A A A A .
782 4 0 0 0 A A A A A A A A A A A A A A ..
783 2 0 0 0 A A A A A A A A A A A A A A tmp/
786 \subsubsection*{List files}
788 Bvfs allows you to list files in a specific path.
790 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
791 PathId FilenameId FileId JobId LStat Path
792 PathId FilenameId FileId JobId LStat Path
793 PathId FilenameId FileId JobId LStat Path
797 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
798 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
802 .bvfs_lsfiles pathid=4 jobid=1,11,12
803 4 0 0 0 A A A A A A A A A A A A A A .
804 5 0 0 0 A A A A A A A A A A A A A A ..
805 1 0 0 0 A A A A A A A A A A A A A A regress/
808 In this example, to list files present in \texttt{regress/}, you can use
810 .bvfs_lsfiles pathid=1 jobid=1,11,12
811 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
812 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
813 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
814 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
815 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
818 \subsubsection*{Restore set of files}
820 Bvfs allows you to create a SQL table that contains files that you want to
821 restore. This table can be provided to a restore command with the file option.
824 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
826 restore file=?b2num ...
829 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
830 select all files. This query could be time consuming.
832 \texttt{hardlink} list is always composed of a series of two numbers (jobid,
833 fileindex). This information can be found in the LinkFI field of the LStat
836 The \texttt{path} argument represents the name of the table that Bvfs will
837 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
838 b2 and followed by digits).
843 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
847 \subsubsection*{Cleanup after Restore}
849 To drop the table used by the restore command, you can use the
850 \texttt{.bvfs\_cleanup} command.
853 .bvfs_cleanup path=b20001
856 \subsubsection*{Clearing the BVFS Cache}
858 To clear the BVFS cache, you can use the \texttt{.bvfs\_clear\_cache} command.
861 .bvfs_clear_cache yes
865 \subsection{Changes in the Pruning Algorithm}
867 We rewrote the job pruning algorithm in this version. Previously, in some users
868 reported that the pruning process at the end of jobs was very long. It should
869 not be longer the case. Now, Bacula won't prune automatically a Job if this
870 particular Job is needed to restore data. Example:
874 JobId: 2 Level: Incremental
875 JobId: 3 Level: Incremental
876 JobId: 4 Level: Differential
877 .. Other incrementals up to now
880 In this example, if the Job Retention defined in the Pool or in the Client
881 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
882 detect that JobId 1 and 4 are essential to restore data at the current state
883 and will prune only JobId 2 and 3.
885 \texttt{Important}, this change affect only the automatic pruning step after a
886 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
887 \texttt{VolumeRetention} period, important jobs can be pruned.
889 \subsection{Ability to Verify any specified Job}
890 You now have the ability to tell Bacula which Job should verify instead of
891 automatically verify just the last one.
893 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
895 To verify a given job, just specify the Job jobid in argument when starting the
898 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
900 JobName: VerifyVolume
901 Level: VolumeToCatalog
904 Pool: Default (From Job resource)
905 Storage: File (From Job resource)
906 Verify Job: VerifyVol.2010-09-08_14.17.17_03
907 Verify List: /tmp/regress/working/VerifyVol.bsr
908 When: 2010-09-08 14:17:31
910 OK to run? (yes/mod/no):
914 This project was funded by Bacula Systems and is available with Bacula
915 Enterprise Edition and Community Edition.
917 \subsection{Additions to RunScript variables}
918 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
919 command. The Client address is now available through \%h.
922 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
925 %\subsection{Changes in drivetype.exe}
927 %Now the \texttt{drivetype.exe} program allows you to list all local hard
928 %drives. It can help to build dynamic FileSet on Windows.
931 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
935 \subsection{Additions to the Plugin API}
936 The bfuncs structure has been extended to include a number of
939 \subsubsection{bfuncs}
940 The bFuncs structure defines the callback entry points within Bacula
941 that the plugin can use register events, get Bacula values, set
942 Bacula values, and send messages to the Job output or debug output.
944 The exact definition as of this writing is:
946 typedef struct s_baculaFuncs {
949 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
950 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
951 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
952 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
953 int type, utime_t mtime, const char *fmt, ...);
954 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
955 int level, const char *fmt, ...);
956 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
958 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
960 /* New functions follow */
961 bRC (*AddExclude)(bpContext *ctx, const char *file);
962 bRC (*AddInclude)(bpContext *ctx, const char *file);
963 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
964 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
965 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
966 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
972 \item [AddExclude] can be called to exclude a file. The file
973 string passed may include wildcards that will be interpreted by
974 the {\bf fnmatch} subroutine. This function can be called
975 multiple times, and each time the file specified will be added
976 to the list of files to be excluded. Note, this function only
977 permits adding excludes of specific file or directory names,
978 or files matched by the rather simple fnmatch mechanism.
979 See below for information on doing wild-card and regex excludes.
981 \item [NewPreInclude] can be called to create a new Include block. This
982 block will be added after the current defined Include block. This
983 function can be called multiple times, but each time, it will create
984 a new Include section (not normally needed). This function should
985 be called only if you want to add an entirely new Include block.
987 \item [NewInclude] can be called to create a new Include block. This
988 block will be added before any user defined Include blocks. This
989 function can be called multiple times, but each time, it will create
990 a new Include section (not normally needed). This function should
991 be called only if you want to add an entirely new Include block.
993 \item [AddInclude] can be called to add new files/directories to
994 be included. They are added to the current Include block. If
995 NewInclude has not been included, the current Include block is
996 the last one that the user created. This function
997 should be used only if you want to add totally new files/directories
998 to be included in the backup.
1000 \item [NewOptions] adds a new Options block to the current Include
1001 in front of any other Options blocks. This permits the plugin to
1002 add exclude directives (wild-cards and regexes) in front of the
1003 user Options, and thus prevent certain files from being backed up.
1004 This can be useful if the plugin backs up files, and they should
1005 not be also backed up by the main Bacula code. This function
1006 may be called multiple times, and each time, it creates a new
1007 prepended Options block. Note: normally you want to call this
1008 entry point prior to calling AddOptions, AddRegex, or AddWild.
1010 \item [AddOptions] allows the plugin it set options in
1011 the current Options block, which is normally created with the
1012 NewOptions call just prior to adding Include Options.
1013 The permitted options are passed as a character string, where
1014 each character has a specific meaning as defined below:
1017 \item [a] always replace files (default).
1018 \item [e] exclude rather than include.
1019 \item [h] no recursion into subdirectories.
1020 \item [H] do not handle hard links.
1021 \item [i] ignore case in wildcard and regex matches.
1022 \item [M] compute an MD5 sum.
1023 \item [p] use a portable data format on Windows (not recommended).
1024 \item [R] backup resource forks and Findr Info.
1025 \item [r] read from a fifo
1026 \item [S1] compute an SHA1 sum.
1027 \item [S2] compute an SHA256 sum.
1028 \item [S3] comput an SHA512 sum.
1029 \item [s] handle sparse files.
1030 \item [m] use st\_mtime only for file differences.
1031 \item [k] restore the st\_atime after accessing a file.
1032 \item [A] enable ACL backup.
1033 \item [Vxxx:] specify verify options. Must terminate with :
1034 \item [Cxxx:] specify accurate options. Must terminate with :
1035 \item [Jxxx:] specify base job Options. Must terminate with :
1036 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
1038 \item [Zn] specify gzip compression level n.
1039 \item [K] do not use st\_atime in backup decision.
1040 \item [c] check if file changed during backup.
1041 \item [N] honor no dump flag.
1042 \item [X] enable backup of extended attributes.
1045 \item [AddRegex] adds a regex expression to the current Options block.
1046 The following options are permitted:
1048 \item [ ] (a blank) regex applies to whole path and filename.
1049 \item [F] regex applies only to the filename (directory or path stripped).
1050 \item [D] regex applies only to the directory (path) part of the name.
1053 \item [AddWild] adds a wildcard expression to the current Options block.
1054 The following options are permitted:
1056 \item [ ] (a blank) regex applies to whole path and filename.
1057 \item [F] regex applies only to the filename (directory or path stripped).
1058 \item [D] regex applies only to the directory (path) part of the name.
1061 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
1062 that can use Accurate code to compare the file information in argument with
1063 the previous file information. The \texttt{delta\_seq} attribute of the
1064 \texttt{save\_pkt} will be updated, and the call will return
1065 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
1070 \subsubsection{Bacula events}
1071 The list of events has been extended to include:
1077 bEventStartBackupJob = 3,
1078 bEventEndBackupJob = 4,
1079 bEventStartRestoreJob = 5,
1080 bEventEndRestoreJob = 6,
1081 bEventStartVerifyJob = 7,
1082 bEventEndVerifyJob = 8,
1083 bEventBackupCommand = 9,
1084 bEventRestoreCommand = 10,
1089 bEventCancelCommand = 13,
1090 bEventVssBackupAddComponents = 14,
1091 bEventVssRestoreLoadComponentMetadata = 15,
1092 bEventVssRestoreSetComponentsSelected = 16,
1093 bEventRestoreObject = 17,
1094 bEventEndFileSet = 18,
1095 bEventPluginCommand = 19,
1096 bEventVssBeforeCloseRestore = 20,
1097 bEventVssPrepareSnapshot = 21
1103 \item [bEventCancelCommand] is called whenever the currently
1104 running Job is canceled */
1106 \item [bEventVssBackupAddComponents]
1108 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
1109 provides a char[27] table where the plugin can add Windows drives that will
1110 be used during the Job. You need to add them without duplicates, and you can
1111 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
1115 \subsection{ACL enhancements}
1117 The following enhancements are made to the Bacula Filed with regards to
1118 Access Control Lists (ACLs)
1121 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
1122 POSIX and NFSv4 ACLs.
1123 \item Added support for new acl types on FreeBSD 8.1 and later which supports
1124 POSIX and NFSv4 ACLs.
1125 \item Some generic cleanups for internal ACL handling.
1126 \item Fix for acl storage on OSX
1127 \item Cleanup of configure checks for ACL detection, now configure only
1128 tests for a certain interface type based on the operating system
1129 this should give less false positives on detection. Also when ACLs
1130 are detected no other acl checks are performed anymore.
1134 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
1135 and is available with Bacula Enterprise Edition and Community Edition.
1137 \subsection{XATTR enhancements}
1139 The following enhancements are made to the Bacula Filed with regards to
1140 Extended Attributes (XATTRs)
1143 \item Added support for IRIX extended attributes using the attr\_get interface.
1144 \item Added support for Tru64 (OSF1) extended attributes using the
1145 getproplist interface.
1146 \item Added support for AIX extended attributes available in AIX 6.x
1147 and higher using the listea/getea/setea interface.
1148 \item Added some debugging to generic xattr code so it easier to
1150 \item Cleanup of configure checks for XATTR detection, now configure only
1151 tests for a certain interface type based on the operating system
1152 this should give less false positives on detection. Also when xattrs
1153 are detected no other xattr checks are performed anymore.
1157 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
1158 and is available with Bacula Enterprise Edition and Community Edition.
1160 \subsection{Class Based Database Backend Drivers}
1162 The main Bacula Director code is independent of the SQL backend
1163 in version 5.2.0 and greater. This means that the Bacula Director can be
1164 packaged by itself, then each of the different SQL backends supported can
1165 be packaged separately. It is possible to build all the DB backends at the
1166 same time by including multiple database options at the same time.
1168 ./configure can be run with multiple database configure options.
1175 Order of testing for databases is:
1182 Each configured backend generates a file named:
1183 \verb+libbaccats-<sql_backend_name>-<version>.so+
1184 A dummy catalog library is created named libbaccats-version.so
1186 At configure time the first detected backend is used as the so called
1187 default backend and at install time the dummy
1188 \verb+libbaccats-<version>.so+ is replaced with the default backend type.
1190 If you configure all three backends you get three backend libraries and the
1191 postgresql gets installed as the default.
1193 When you want to switch to another database, first save any old catalog you
1194 may have then you can copy one of the three backend libraries over the
1195 \verb+libbaccats-<version>.so+ e.g.
1197 An actual command, depending on your Bacula version might be:
1199 cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
1202 where the \verb+5.2.2+ must be replaced by the Bacula release
1205 Then you must update the default backend in the following files:
1208 create_bacula_database
1209 drop_bacula_database
1211 grant_bacula_privileges
1214 update_bacula_tables
1217 And re-run all the above scripts. Please note, this means
1218 you will have a new empty database and if you had a previous
1219 one it will be lost.
1221 All current database backend drivers for catalog information are rewritten
1222 to use a set of multi inherited C++ classes which abstract the specific
1223 database specific internals and make sure we have a more stable generic
1224 interface with the rest of SQL code. From now on there is a strict
1225 boundary between the SQL code and the low-level database functions. This
1226 new interface should also make it easier to add a new backend for a
1227 currently unsupported database. As part of the rewrite the SQLite 2 code
1228 was removed (e.g. only SQLite 3 is now supported). An extra bonus of the
1229 new code is that you can configure multiple backends in the configure and
1230 build all backends in one compile session and select the correct database
1231 backend at install time. This should make it a lot easier for packages
1237 We also added cursor support for PostgreSQL backend, this improves memory
1238 usage for large installation.
1241 This project was implemented by Planets Communications B.V. and ELM
1242 Consultancy B.V. and Bacula Systems and is available with both the Bacula
1243 Enterprise Edition and the Community Edition.
1245 \subsection{Hash List Enhancements}
1247 The htable hash table class has been extended with extra hash functions for
1248 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
1249 Also the hash table initialization routines have been enhanced with
1250 support for passing a hint as to the number of initial pages to use
1251 for the size of the hash table. Until now the hash table always used
1252 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
1253 cache have been rewritten to use the new htable class with a small memory
1257 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
1258 and Bacula Systems and is available with Bacula Enterprise Edition and
1263 %%% =====================================================================
1268 \section{Release Version 5.0.3}
1270 There are no new features in version 5.0.2. This version simply fixes a
1271 number of bugs found in version 5.0.1 during the ongoing development
1274 \section{Release Version 5.0.2}
1276 There are no new features in version 5.0.2. This version simply fixes a
1277 number of bugs found in version 5.0.1 during the ongoing development
1283 \section{New Features in 5.0.1}
1285 This chapter presents the new features that are in the released Bacula version
1286 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
1287 the ongoing development process.
1289 \subsection{Truncate Volume after Purge}
1290 \label{sec:actiononpurge}
1292 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
1293 the volume when it is purged with the new command \texttt{purge volume
1294 action}. It is useful to prevent disk based volumes from consuming too much
1300 Action On Purge = Truncate
1305 As usual you can also set this property with the \texttt{update volume} command
1307 *update volume=xxx ActionOnPurge=Truncate
1308 *update volume=xxx actiononpurge=None
1311 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
1312 following command in interactive mode or in a RunScript as shown after:
1314 *purge volume action=truncate storage=File allpools
1315 # or by default, action=all
1316 *purge volume action storage=File pool=Default
1319 This is possible to specify the volume name, the media type, the pool, the
1320 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
1321 idle when you decide to run this command.
1325 Name = CatalogBackup
1330 Console = "purge volume action=all allpools storage=File"
1335 \textbf{Important note}: This feature doesn't work as
1336 expected in version 5.0.0. Please do not use it before version 5.0.1.
1338 \subsection{Allow Higher Duplicates}
1339 This directive did not work correctly and has been depreciated
1340 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
1341 file as it will be removed in a future release.
1343 \subsection{Cancel Lower Level Duplicates}
1344 This directive was added in Bacula version 5.0.1. It compares the
1345 level of a new backup job to old jobs of the same name, if any,
1346 and will kill the job which has a lower level than the other one.
1347 If the levels are the same (i.e. both are Full backups), then
1348 nothing is done and the other Cancel XXX Duplicate directives
1351 \section{New Features in 5.0.0}
1353 \subsection{Maximum Concurrent Jobs for Devices}
1354 \label{sec:maximumconcurrentjobdevice}
1356 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
1357 Daemon configuration permits setting the maximum number of Jobs that can
1358 run concurrently on a specified Device. Using this directive, it is
1359 possible to have different Jobs using multiple drives, because when the
1360 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
1361 Jobs on any other available compatible drive. This facilitates writing to
1362 multiple drives with multiple Jobs that all use the same Pool.
1364 This project was funded by Bacula Systems.
1366 \subsection{Restore from Multiple Storage Daemons}
1367 \index[general]{Restore}
1369 Previously, you were able to restore from multiple devices in a single Storage
1370 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
1371 example, if your full backup runs on a Storage Daemon with an autochanger, and
1372 your incremental jobs use another Storage Daemon with lots of disks, Bacula
1373 will switch automatically from one Storage Daemon to an other within the same
1376 You must upgrade your File Daemon to version 3.1.3 or greater to use this
1379 This project was funded by Bacula Systems with the help of Equiinet.
1381 \subsection{File Deduplication using Base Jobs}
1382 A base job is sort of like a Full save except that you will want the FileSet to
1383 contain only files that are unlikely to change in the future (i.e. a snapshot
1384 of most of your system after installing it). After the base job has been run,
1385 when you are doing a Full save, you specify one or more Base jobs to be used.
1386 All files that have been backed up in the Base job/jobs but not modified will
1387 then be excluded from the backup. During a restore, the Base jobs will be
1388 automatically pulled in where necessary.
1390 This is something none of the competition does, as far as we know (except
1391 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
1392 win for the user, it makes Bacula stand out as offering a unique optimization
1393 that immediately saves time and money. Basically, imagine that you have 100
1394 nearly identical Windows or Linux machine containing the OS and user files.
1395 Now for the OS part, a Base job will be backed up once, and rather than making
1396 100 copies of the OS, there will be only one. If one or more of the systems
1397 have some files updated, no problem, they will be automatically restored.
1399 See the \ilink{Base Job Chapter}{basejobs} for more information.
1401 This project was funded by Bacula Systems.
1403 \subsection{AllowCompression = \lt{}yes\vb{}no\gt{}}
1404 \index[dir]{AllowCompression}
1406 This new directive may be added to Storage resource within the Director's
1407 configuration to allow users to selectively disable the client compression for
1408 any job which writes to this storage resource.
1414 Address = ultrium-tape
1415 Password = storage_password # Password for Storage Daemon
1418 AllowCompression = No # Tape drive has hardware compression
1421 The above example would cause any jobs running with the UltriumTape storage
1422 resource to run without compression from the client file daemons. This
1423 effectively overrides any compression settings defined at the FileSet level.
1425 This feature is probably most useful if you have a tape drive which supports
1426 hardware compression. By setting the \texttt{AllowCompression = No} directive
1427 for your tape drive storage resource, you can avoid additional load on the file
1428 daemon and possibly speed up tape backups.
1430 This project was funded by Collaborative Fusion, Inc.
1432 \subsection{Accurate Fileset Options}
1433 \label{sec:accuratefileset}
1435 In previous versions, the accurate code used the file creation and modification
1436 times to determine if a file was modified or not. Now you can specify which
1437 attributes to use (time, size, checksum, permission, owner, group, \dots),
1438 similar to the Verify options.
1454 \item {\bf i} compare the inodes
1455 \item {\bf p} compare the permission bits
1456 \item {\bf n} compare the number of links
1457 \item {\bf u} compare the user id
1458 \item {\bf g} compare the group id
1459 \item {\bf s} compare the size
1460 \item {\bf a} compare the access time
1461 \item {\bf m} compare the modification time (st\_mtime)
1462 \item {\bf c} compare the change time (st\_ctime)
1463 \item {\bf d} report file size decreases
1464 \item {\bf 5} compare the MD5 signature
1465 \item {\bf 1} compare the SHA1 signature
1468 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
1469 the File Daemon will have to read all files even if they normally would not
1470 be saved. This increases the I/O load, but also the accuracy of the
1471 deduplication. By default, Bacula will check modification/creation time
1474 This project was funded by Bacula Systems.
1476 \subsection{Tab-completion for Bconsole}
1477 \label{sec:tabcompletion}
1479 If you build \texttt{bconsole} with readline support, you will be able to use
1480 the new auto-completion mode. This mode supports all commands, gives help
1481 inside command, and lists resources when required. It works also in the restore
1484 To use this feature, you should have readline development package loaded on
1485 your system, and use the following option in configure.
1487 ./configure --with-readline=/usr/include/readline --disable-conio ...
1490 The new bconsole won't be able to tab-complete with older directors.
1492 This project was funded by Bacula Systems.
1494 \subsection{Pool File and Job Retention}
1495 \label{sec:poolfilejobretention}
1497 We added two new Pool directives, \texttt{FileRetention} and
1498 \texttt{JobRetention}, that take precedence over Client directives of the same
1499 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
1500 example, you can decide to increase Retention times for Archive or OffSite Pool.
1502 It seems obvious to us, but apparently not to some users, that given the
1503 definition above that the Pool File and Job Retention periods is a global
1504 override for the normal Client based pruning, which means that when the
1505 Job is pruned, the pruning will apply globally to that particular Job.
1507 Currently, there is a bug in the implementation that causes any Pool
1508 retention periods specified to apply to {\bf all} Pools for that
1509 particular Client. Thus we suggest that you avoid using these two
1510 directives until this implementation problem is corrected.
1512 \subsection{Read-only File Daemon using capabilities}
1513 \label{sec:fdreadonly}
1514 This feature implements support of keeping \textbf{ReadAll} capabilities after
1515 UID/GID switch, this allows FD to keep root read but drop write permission.
1517 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
1518 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
1521 root@localhost:~# bacula-fd -k -u nobody -g nobody
1524 The code for this feature was contributed by our friends at AltLinux.
1526 \subsection{Bvfs API}
1529 To help developers of restore GUI interfaces, we have added new \textsl{dot
1530 commands} that permit browsing the catalog in a very simple way.
1533 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
1534 the Bvfs cache in the catalog. You need to run it before any access to the
1537 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
1538 will list all directories in the specified \texttt{path} or
1539 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
1540 encoding of path/filenames.
1542 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
1543 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
1544 \texttt{pathid} avoids problems with character encoding.
1547 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
1548 data that will be displayed.
1551 * .bvfs_update jobid=1,2
1553 * .bvfs_lsdir path=/ jobid=1,2
1556 This project was funded by Bacula Systems.
1558 \subsection{Testing your Tape Drive}
1559 \label{sec:btapespeed}
1561 To determine the best configuration of your tape drive, you can run the new
1562 \texttt{speed} command available in the \texttt{btape} program.
1564 This command can have the following arguments:
1566 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
1567 (between 1 and 5GB). This counter is in GB.
1568 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
1569 of data should be greater than your memory ($file\_size*nb\_file$).
1570 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
1572 \item[\texttt{skip\_random}] This flag permits to skip tests with random
1574 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
1575 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
1580 *speed file_size=3 skip_raw
1581 btape.c:1078 Test with zero data and bacula block structure.
1582 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1583 ++++++++++++++++++++++++++++++++++++++++++
1584 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1585 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
1587 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
1589 btape.c:1090 Test with random data, should give the minimum throughput.
1590 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1591 +++++++++++++++++++++++++++++++++++++++++++
1592 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1593 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
1594 +++++++++++++++++++++++++++++++++++++++++++
1596 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
1600 When using compression, the random test will give your the minimum throughput
1601 of your drive . The test using constant string will give you the maximum speed
1602 of your hardware chain. (CPU, memory, SCSI card, cable, drive, tape).
1604 You can change the block size in the Storage Daemon configuration file.
1606 \subsection{New {\bf Block Checksum} Device Directive}
1607 You may now turn off the Block Checksum (CRC32) code
1608 that Bacula uses when writing blocks to a Volume. This is
1615 doing so can reduce the Storage daemon CPU usage slightly. It
1616 will also permit Bacula to read a Volume that has corrupted data.
1618 The default is {\bf yes} -- i.e. the checksum is computed on write
1619 and checked on read.
1621 We do not recommend to turn this off particularly on older tape
1622 drives or for disk Volumes where doing so may allow corrupted data
1625 \subsection{New Bat Features}
1627 Those new features were funded by Bacula Systems.
1629 \subsubsection{Media List View}
1631 By clicking on ``Media'', you can see the list of all your volumes. You will be
1632 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1633 in the table. The old ``Media'' view is now known as ``Pool''.
1634 \begin{figure}[htbp]
1636 \includegraphics[width=0.8\linewidth]{bat-mediaview}
1637 \label{fig:mediaview}
1641 \subsubsection{Media Information View}
1643 By double-clicking on a volume (on the Media list, in the Autochanger content
1644 or in the Job information panel), you can access a detailed overview of your
1645 Volume. (cf figure \vref{fig:mediainfo}.)
1646 \begin{figure}[htbp]
1648 \includegraphics[width=0.8\linewidth]{bat11}
1649 \caption{Media information}
1650 \label{fig:mediainfo}
1653 \subsubsection{Job Information View}
1655 By double-clicking on a Job record (on the Job run list or in the Media
1656 information panel), you can access a detailed overview of your Job. (cf
1657 figure \vref{fig:jobinfo}.)
1658 \begin{figure}[htbp]
1660 \includegraphics[width=0.8\linewidth]{bat12}
1661 \caption{Job information}
1665 \subsubsection{Autochanger Content View}
1667 By double-clicking on a Storage record (on the Storage list panel), you can
1668 access a detailed overview of your Autochanger. (cf figure \vref{fig:jobinfo}.)
1669 \begin{figure}[htbp]
1671 \includegraphics[width=0.8\linewidth]{bat13}
1672 \caption{Autochanger content}
1673 \label{fig:achcontent}
1676 To use this feature, you need to use the latest mtx-changer script
1677 version. (With new \texttt{listall} and \texttt{transfer} commands)
1679 \subsection{Bat on Windows}
1680 We have ported {\bf bat} to Windows and it is now installed
1681 by default when the installer is run. It works quite well
1682 on Win32, but has not had a lot of testing there, so your
1683 feedback would be welcome. Unfortunately, even though it is
1684 installed by default, it does not yet work on 64 bit Windows
1687 \subsection{New Win32 Installer}
1688 The Win32 installer has been modified in several very important
1691 \item You must deinstall any current version of the
1692 Win32 File daemon before upgrading to the new one.
1693 If you forget to do so, the new installation will fail.
1694 To correct this failure, you must manually shutdown
1695 and deinstall the old File daemon.
1696 \item All files (other than menu links) are installed
1697 in {\bf c:/Program Files/Bacula}.
1698 \item The installer no longer sets this
1699 file to require administrator privileges by default. If you want
1700 to do so, please do it manually using the {\bf cacls} program.
1703 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1705 \item The server daemons (Director and Storage daemon) are
1706 no longer included in the Windows installer. If you want the
1707 Windows servers, you will either need to build them yourself (note
1708 they have not been ported to 64 bits), or you can contact
1709 Bacula Systems about this.
1712 \subsection{Win64 Installer}
1713 We have corrected a number of problems that required manual
1714 editing of the conf files. In most cases, it should now
1715 install and work. {\bf bat} is by default installed in
1716 {\bf c:/Program Files/Bacula/bin32} rather than
1717 {\bf c:/Program Files/Bacula} as is the case with the 32
1718 bit Windows installer.
1720 \subsection{Linux Bare Metal Recovery USB Key}
1721 We have made a number of significant improvements in the
1722 Bare Metal Recovery USB key. Please see the README files
1723 it the {\bf rescue} release for more details.
1725 We are working on an equivalent USB key for Windows bare
1726 metal recovery, but it will take some time to develop it (best
1727 estimate 3Q2010 or 4Q2010)
1730 \subsection{bconsole Timeout Option}
1731 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1732 for commands. This is useful with GUI programs that use {\bf bconsole}
1733 to interface to the Director.
1735 \subsection{Important Changes}
1736 \label{sec:importantchanges}
1739 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1740 to the same Pool. The Storage daemon ensures that you do not read and
1741 write to the same Volume.
1742 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1744 \item Virtually all the features of {\bf mtx-changer} have
1745 now been parametrized, which allows you to configure
1746 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1747 that contains variables that you can set to configure mtx-changer.
1748 This configuration file will not be overwritten during upgrades.
1749 We encourage you to submit any changes
1750 that are made to mtx-changer and to parametrize it all in
1751 mtx-changer.conf so that all configuration will be done by
1752 changing only mtx-changer.conf.
1753 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1754 and \texttt{transfer}. Please configure them as appropriate
1755 in mtx-changer.conf.
1756 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1757 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1758 password. If you want to use the new script, you will need to
1759 manually change the \texttt{BackupCatalog} Job definition.
1760 \item The \texttt{bconsole} \texttt{help} command now accepts
1761 an argument, which if provided produces information on that
1762 command (ex: \texttt{help run}).
1766 \subsubsection*{Truncate volume after purge}
1768 Note that the Truncate Volume after purge feature doesn't work as expected
1769 in 5.0.0 version. Please, don't use it before version 5.0.1.
1771 \subsubsection{Custom Catalog queries}
1773 If you wish to add specialized commands that list the contents of the catalog,
1774 you can do so by adding them to the \texttt{query.sql} file. This
1775 \texttt{query.sql} file is now empty by default. The file
1776 \texttt{examples/sample-query.sql} has an a number of sample commands
1777 you might find useful.
1779 \subsubsection{Deprecated parts}
1781 The following items have been \textbf{deprecated} for a long time, and are now
1782 removed from the code.
1785 \item Support for SQLite 2
1788 \subsection{Misc Changes}
1789 \label{sec:miscchanges}
1792 \item Updated Nagios check\_bacula
1793 \item Updated man files
1794 \item Added OSX package generation script in platforms/darwin
1795 \item Added Spanish and Ukrainian Bacula translations
1796 \item Enable/disable command shows only Jobs that can change
1797 \item Added \texttt{show disabled} command to show disabled Jobs
1798 \item Many ACL improvements
1799 \item Added Level to FD status Job output
1800 \item Begin Ingres DB driver (not yet working)
1801 \item Split RedHat spec files into bacula, bat, mtx, and docs
1802 \item Reorganized the manuals (fewer separate manuals)
1803 \item Added lock/unlock order protection in lock manager
1804 \item Allow 64 bit sizes for a number of variables
1805 \item Fixed several deadlocks or potential race conditions in the SD
1808 \chapter{Released Version 3.0.3 and 3.0.3a}
1810 There are no new features in version 3.0.3. This version simply fixes a
1811 number of bugs found in version 3.0.2 during the ongoing development
1814 \section{New Features in Released Version 3.0.2}
1816 This chapter presents the new features added to the
1817 Released Bacula Version 3.0.2.
1819 \subsection{Full Restore from a Given JobId}
1820 \index[general]{Restore menu}
1822 This feature allows selecting a single JobId and having Bacula
1823 automatically select all the other jobs that comprise a full backup up to
1824 and including the selected date (through JobId).
1826 Assume we start with the following jobs:
1828 +-------+--------------+---------------------+-------+----------+------------+
1829 | jobid | client | starttime | level | jobfiles | jobbytes |
1830 +-------+--------------+---------------------+-------+----------+------------
1831 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1832 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1833 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1834 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1835 +-------+--------------+---------------------+-------+----------+------------+
1838 Below is an example of this new feature (which is number 12 in the
1843 To select the JobIds, you have the following choices:
1844 1: List last 20 Jobs run
1845 2: List Jobs where a given File is saved
1847 12: Select full restore to a specified Job date
1850 Select item: (1-13): 12
1851 Enter JobId to get the state to restore: 5
1852 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1853 You have selected the following JobIds: 1,3,5
1855 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1856 1,444 files inserted into the tree.
1859 This project was funded by Bacula Systems.
1861 \subsection{Source Address}
1862 \index[general]{Source Address}
1864 A feature has been added which allows the administrator to specify the address
1865 from which the Director and File daemons will establish connections. This
1866 may be used to simplify system configuration overhead when working in complex
1867 networks utilizing multi-homing and policy-routing.
1869 To accomplish this, two new configuration directives have been implemented:
1872 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1876 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1880 Simply adding specific host routes on the OS
1881 would have an undesirable side-effect: any
1882 application trying to contact the destination host would be forced to use the
1883 more specific route possibly diverting management traffic onto a backup VLAN.
1884 Instead of adding host routes for each client connected to a multi-homed backup
1885 server (for example where there are management and backup VLANs), one can
1886 use the new directives to specify a specific source address at the application
1889 Additionally, this allows the simplification and abstraction of firewall rules
1890 when dealing with a Hot-Standby director or storage daemon configuration. The
1891 Hot-standby pair may share a CARP address, which connections must be sourced
1892 from, while system services listen and act from the unique interface addresses.
1894 This project was funded by Collaborative Fusion, Inc.
1896 \subsection{Show volume availability when doing restore}
1898 When doing a restore the selection dialog ends by displaying this
1902 The job will require the following
1903 Volume(s) Storage(s) SD Device(s)
1904 ===========================================================================
1905 *000741L3 LTO-4 LTO3
1906 *000866L3 LTO-4 LTO3
1907 *000765L3 LTO-4 LTO3
1908 *000764L3 LTO-4 LTO3
1909 *000756L3 LTO-4 LTO3
1910 *001759L3 LTO-4 LTO3
1911 *001763L3 LTO-4 LTO3
1915 Volumes marked with ``*'' are online (in the autochanger).
1918 This should help speed up large restores by minimizing the time spent
1919 waiting for the operator to discover that he must change tapes in the library.
1921 This project was funded by Bacula Systems.
1923 \subsection{Accurate estimate command}
1925 The \texttt{estimate} command can now use the accurate code to detect changes
1926 and give a better estimation.
1928 You can set the accurate behavior on the command line by using
1929 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1932 * estimate listing accurate=yes level=incremental job=BackupJob
1935 This project was funded by Bacula Systems.
1937 \section{New Features in 3.0.0}
1938 \label{NewFeaturesChapter}
1939 \index[general]{New Features}
1941 This chapter presents the new features added to the development 2.5.x
1942 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1944 \subsection{Accurate Backup}
1945 \index[general]{Accurate Backup}
1947 As with most other backup programs, by default Bacula decides what files to
1948 backup for Incremental and Differential backup by comparing the change
1949 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1950 backup completed. If one of those two times is later than the last backup
1951 time, then the file will be backed up. This does not, however, permit tracking
1952 what files have been deleted and will miss any file with an old time that may
1953 have been restored to or moved onto the client filesystem.
1955 \subsubsection{Accurate = \lt{}yes\vb{}no\gt{}}
1956 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1957 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1958 backup, there is no difference, but for {\bf Differential} and {\bf
1959 Incremental} backups, the Director will send a list of all previous files
1960 backed up, and the File daemon will use that list to determine if any new files
1961 have been added or or moved and if any files have been deleted. This allows
1962 Bacula to make an accurate backup of your system to that point in time so that
1963 if you do a restore, it will restore your system exactly.
1966 about using Accurate backup is that it requires more resources (CPU and memory)
1967 on both the Director and the Client machines to create the list of previous
1968 files backed up, to send that list to the File daemon, for the File daemon to
1969 keep the list (possibly very big) in memory, and for the File daemon to do
1970 comparisons between every file in the FileSet and the list. In particular,
1971 if your client has lots of files (more than a few million), you will need
1972 lots of memory on the client machine.
1974 Accurate must not be enabled when backing up with a plugin that is not
1975 specially designed to work with Accurate. If you enable it, your restores
1976 will probably not work correctly.
1978 This project was funded by Bacula Systems.
1982 \subsection{Copy Jobs}
1983 \index[general]{Copy Jobs}
1985 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1986 existing Migration feature with the exception that the Job that is copied is
1987 left unchanged. This essentially creates two identical copies of the same
1988 backup. However, the copy is treated as a copy rather than a backup job, and
1989 hence is not directly available for restore. The {\bf restore} command lists
1990 copy jobs and allows selection of copies by using \texttt{jobid=}
1991 option. If the keyword {\bf copies} is present on the command line, Bacula will
1992 display the list of all copies for selected jobs.
1997 These JobIds have copies as follows:
1998 +-------+------------------------------------+-----------+------------------+
1999 | JobId | Job | CopyJobId | MediaType |
2000 +-------+------------------------------------+-----------+------------------+
2001 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
2002 +-------+------------------------------------+-----------+------------------+
2003 +-------+-------+----------+----------+---------------------+------------------+
2004 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
2005 +-------+-------+----------+----------+---------------------+------------------+
2006 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
2007 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
2008 +-------+-------+----------+----------+---------------------+------------------+
2009 You have selected the following JobIds: 19,2
2011 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
2012 5,611 files inserted into the tree.
2017 The Copy Job runs without using the File daemon by copying the data from the
2018 old backup Volume to a different Volume in a different Pool. See the Migration
2019 documentation for additional details. For copy Jobs there is a new selection
2020 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
2021 not already copied to another Pool.
2023 As with Migration, the Client, Volume, Job, or SQL query, are
2024 other possible ways of selecting the Jobs to be copied. Selection
2025 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
2026 work, but are probably more suited for Migration Jobs.
2028 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
2029 it will promote the Copy to a \textsl{real} backup job and will make it available for
2030 automatic restore. If more than one Copy is available, it will promote the copy
2031 with the smallest JobId.
2033 A nice solution which can be built with the new Copy feature is often
2034 called disk-to-disk-to-tape backup (DTDTT). A sample config could
2035 look something like the one below:
2039 Name = FullBackupsVirtualPool
2041 Purge Oldest Volume = Yes
2043 NextPool = FullBackupsTapePool
2047 Name = FullBackupsTapePool
2051 Volume Retention = 365 days
2052 Storage = superloader
2056 # Fake fileset for copy jobs
2068 # Fake client for copy jobs
2078 # Default template for a CopyDiskToTape Job
2081 Name = CopyDiskToTape
2083 Messages = StandardCopy
2086 Selection Type = PoolUncopiedJobs
2087 Maximum Concurrent Jobs = 10
2089 Allow Duplicate Jobs = Yes
2090 Cancel Queued Duplicates = No
2091 Cancel Running Duplicates = No
2096 Name = DaySchedule7:00
2097 Run = Level=Full daily at 7:00
2101 Name = CopyDiskToTapeFullBackups
2103 Schedule = DaySchedule7:00
2104 Pool = FullBackupsVirtualPool
2105 JobDefs = CopyDiskToTape
2109 The example above had 2 pool which are copied using the PoolUncopiedJobs
2110 selection criteria. Normal Full backups go to the Virtual pool and are copied
2111 to the Tape pool the next morning.
2113 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
2118 +-------+------------------------------------+-----------+------------------+
2119 | JobId | Job | CopyJobId | MediaType |
2120 +-------+------------------------------------+-----------+------------------+
2121 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
2122 +-------+------------------------------------+-----------+------------------+
2125 \subsection{ACL Updates}
2126 \index[general]{ACL Updates}
2127 The whole ACL code had been overhauled and in this version each platforms has
2128 different streams for each type of acl available on such an platform. As ACLs
2129 between platforms tend to be not that portable (most implement POSIX acls but
2130 some use an other draft or a completely different format) we currently only
2131 allow certain platform specific ACL streams to be decoded and restored on the
2132 same platform that they were created on. The old code allowed to restore ACL
2133 cross platform but the comments already mention that not being to wise. For
2134 backward compatibility the new code will accept the two old ACL streams and
2135 handle those with the platform specific handler. But for all new backups it
2136 will save the ACLs using the new streams.
2138 Currently the following platforms support ACLs:
2142 \item {\bf Darwin/OSX}
2151 Currently we support the following ACL types (these ACL streams use a reserved
2152 part of the stream numbers):
2155 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
2157 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
2158 string representation from acl\_to\_text (POSIX acl)
2159 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
2160 string representation from acl\_to\_text (POSIX acl) for default acls.
2161 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
2162 string representation from acl\_to\_text (POSIX acl) for access acls.
2163 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
2164 string representation from acltostr (POSIX acl)
2165 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
2166 representation from acl\_to\_text (POSIX acl) for default acls.
2167 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
2168 representation from acl\_to\_text (POSIX acl) for access acls.
2169 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
2170 string representation from acl\_to\_text (POSIX acl) for default acls.
2171 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
2172 representation from acl\_to\_text (POSIX acl) for access acls.
2173 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
2174 string representation from acl\_to\_text (POSIX acl) for default acls.
2175 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
2176 string representation from acl\_to\_text (POSIX acl) for default acls.
2177 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
2178 representation from acl\_to\_text (POSIX acl) for access acls.
2179 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
2180 string representation from acltotext or acl\_totext (POSIX acl)
2181 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
2182 representation from from acl\_totext (NFSv4 or ZFS acl)
2185 In future versions we might support conversion functions from one type of acl
2186 into an other for types that are either the same or easily convertible. For now
2187 the streams are separate and restoring them on a platform that doesn't
2188 recognize them will give you a warning.
2190 \subsection{Extended Attributes}
2191 \index[general]{Extended Attributes}
2192 Something that was on the project list for some time is now implemented for
2193 platforms that support a similar kind of interface. Its the support for backup
2194 and restore of so called extended attributes. As extended attributes are so
2195 platform specific these attributes are saved in separate streams for each
2196 platform. Restores of the extended attributes can only be performed on the
2197 same platform the backup was done. There is support for all types of extended
2198 attributes, but restoring from one type of filesystem onto an other type of
2199 filesystem on the same platform may lead to surprises. As extended attributes
2200 can contain any type of data they are stored as a series of so called
2201 value-pairs. This data must be seen as mostly binary and is stored as such.
2202 As security labels from selinux are also extended attributes this option also
2203 stores those labels and no specific code is enabled for handling selinux
2206 Currently the following platforms support extended attributes:
2208 \item {\bf Darwin/OSX}
2214 On Linux acls are also extended attributes, as such when you enable ACLs on a
2215 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
2216 and not the same extended attribute.
2218 To enable the backup of extended attributes please add the following to your
2233 \subsection{Shared objects}
2234 \index[general]{Shared objects}
2235 A default build of Bacula will now create the libraries as shared objects
2236 (.so) rather than static libraries as was previously the case.
2237 The shared libraries are built using {\bf libtool} so it should be quite
2240 An important advantage of using shared objects is that on a machine with the
2241 Directory, File daemon, the Storage daemon, and a console, you will have only
2242 one copy of the code in memory rather than four copies. Also the total size of
2243 the binary release is smaller since the library code appears only once rather
2244 than once for every program that uses it; this results in significant reduction
2245 in the size of the binaries particularly for the utility tools.
2247 In order for the system loader to find the shared objects when loading the
2248 Bacula binaries, the Bacula shared objects must either be in a shared object
2249 directory known to the loader (typically /usr/lib) or they must be in the
2250 directory that may be specified on the {\bf ./configure} line using the {\bf
2251 {-}{-}libdir} option as:
2254 ./configure --libdir=/full-path/dir
2257 the default is /usr/lib. If {-}{-}libdir is specified, there should be
2258 no need to modify your loader configuration provided that
2259 the shared objects are installed in that directory (Bacula
2260 does this with the make install command). The shared objects
2261 that Bacula references are:
2270 These files are symbolically linked to the real shared object file,
2271 which has a version number to permit running multiple versions of
2272 the libraries if desired (not normally the case).
2274 If you have problems with libtool or you wish to use the old
2275 way of building static libraries, or you want to build a static
2276 version of Bacula you may disable
2277 libtool on the configure command line with:
2280 ./configure --disable-libtool
2284 \subsection{Building Static versions of Bacula}
2285 \index[general]{Static linking}
2286 In order to build static versions of Bacula, in addition
2287 to configuration options that were needed you now must
2288 also add --disable-libtool. Example
2291 ./configure --enable-static-client-only --disable-libtool
2295 \subsection{Virtual Backup (Vbackup)}
2296 \index[general]{Virtual Backup}
2297 \index[general]{Vbackup}
2299 Bacula's virtual backup feature is often called Synthetic Backup or
2300 Consolidation in other backup products. It permits you to consolidate the
2301 previous Full backup plus the most recent Differential backup and any
2302 subsequent Incremental backups into a new Full backup. This new Full
2303 backup will then be considered as the most recent Full for any future
2304 Incremental or Differential backups. The VirtualFull backup is
2305 accomplished without contacting the client by reading the previous backup
2306 data and writing it to a volume in a different pool.
2308 In some respects the Vbackup feature works similar to a Migration job, in
2309 that Bacula normally reads the data from the pool specified in the
2310 Job resource, and writes it to the {\bf Next Pool} specified in the
2311 Job resource. Note, this means that usually the output from the Virtual
2312 Backup is written into a different pool from where your prior backups
2313 are saved. Doing it this way guarantees that you will not get a deadlock
2314 situation attempting to read and write to the same volume in the Storage
2315 daemon. If you then want to do subsequent backups, you may need to
2316 move the Virtual Full Volume back to your normal backup pool.
2317 Alternatively, you can set your {\bf Next Pool} to point to the current
2318 pool. This will cause Bacula to read and write to Volumes in the
2319 current pool. In general, this will work, because Bacula will
2320 not allow reading and writing on the same Volume. In any case, once
2321 a VirtualFull has been created, and a restore is done involving the
2322 most current Full, it will read the Volume or Volumes by the VirtualFull
2323 regardless of in which Pool the Volume is found.
2325 The Vbackup is enabled on a Job by Job in the Job resource by specifying
2326 a level of {\bf VirtualFull}.
2328 A typical Job resource definition might look like the following:
2335 FileSet = "Full Set"
2342 # Default pool definition
2346 Recycle = yes # Automatically recycle Volumes
2347 AutoPrune = yes # Prune expired volumes
2348 Volume Retention = 365d # one year
2356 Recycle = yes # Automatically recycle Volumes
2357 AutoPrune = yes # Prune expired volumes
2358 Volume Retention = 365d # one year
2359 Storage = DiskChanger
2362 # Definition of file storage device
2367 Device = FileStorage
2369 Maximum Concurrent Jobs = 5
2372 # Definition of DDS Virtual tape disk storage device
2375 Address = localhost # N.B. Use a fully qualified name here
2377 Device = DiskChanger
2378 Media Type = DiskChangerMedia
2379 Maximum Concurrent Jobs = 4
2384 Then in bconsole or via a Run schedule, you would run the job as:
2387 run job=MyBackup level=Full
2388 run job=MyBackup level=Incremental
2389 run job=MyBackup level=Differential
2390 run job=MyBackup level=Incremental
2391 run job=MyBackup level=Incremental
2394 So providing there were changes between each of those jobs, you would end up
2395 with a Full backup, a Differential, which includes the first Incremental
2396 backup, then two Incremental backups. All the above jobs would be written to
2397 the {\bf Default} pool.
2399 To consolidate those backups into a new Full backup, you would run the
2403 run job=MyBackup level=VirtualFull
2406 And it would produce a new Full backup without using the client, and the output
2407 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
2409 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
2412 Note, the Start and End time of the Virtual Full backup is set to the
2413 values for the last job included in the Virtual Full (in the above example,
2414 it is an Increment). This is so that if another incremental is done, which
2415 will be based on the Virtual Full, it will backup all files from the
2416 last Job included in the Virtual Full rather than from the time the Virtual
2417 Full was actually run.
2421 \subsection{Catalog Format}
2422 \index[general]{Catalog Format}
2423 Bacula 3.0 comes with some changes to the catalog format. The upgrade
2424 operation will convert the FileId field of the File table from 32 bits (max 4
2425 billion table entries) to 64 bits (very large number of items). The
2426 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
2427 your catalog during the conversion. Also you won't be able to run jobs during
2428 this conversion period. For example, a 3 million file catalog will take 2
2429 minutes to upgrade on a normal machine. Please don't forget to make a valid
2430 backup of your database before executing the upgrade script. See the
2431 ReleaseNotes for additional details.
2433 \subsection{64 bit Windows Client}
2434 \index[general]{Win64 Client}
2435 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
2436 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
2437 As a consequence, we are also releasing a 64 bit version of the Bacula
2438 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
2439 These binaries should only be installed on 64 bit Windows operating systems.
2440 What is important is not your hardware but whether or not you have
2441 a 64 bit version of the Windows OS.
2443 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
2445 \item Before installing the Win64 Bacula Client, you must totally
2446 deinstall any prior 2.4.x Client installation using the
2447 Bacula deinstallation (see the menu item). You may want
2448 to save your .conf files first.
2449 \item Only the Client (File daemon) is ported to Win64, the Director
2450 and the Storage daemon are not in the 64 bit Windows installer.
2451 \item bwx-console is not yet ported.
2452 \item bconsole is ported but it has not been tested.
2453 \item The documentation is not included in the installer.
2454 \item Due to Vista security restrictions imposed on a default installation
2455 of Vista, before upgrading the Client, you must manually stop
2456 any prior version of Bacula from running, otherwise the install
2458 \item Due to Vista security restrictions imposed on a default installation
2459 of Vista, attempting to edit the conf files via the menu items
2460 will fail. You must directly edit the files with appropriate
2461 permissions. Generally double clicking on the appropriate .conf
2462 file will work providing you have sufficient permissions.
2463 \item All Bacula files are now installed in
2464 {\bf C:/Program Files/Bacula} except the main menu items,
2465 which are installed as before. This vastly simplifies the installation.
2466 \item If you are running on a foreign language version of Windows, most
2467 likely {\bf C:/Program Files} does not exist, so you should use the
2468 Custom installation and enter an appropriate location to install
2470 \item The 3.0.0 Win32 Client continues to install files in the locations used
2471 by prior versions. For the next version we will convert it to use
2472 the same installation conventions as the Win64 version.
2475 This project was funded by Bacula Systems.
2478 \subsection{Duplicate Job Control}
2479 \index[general]{Duplicate Jobs}
2480 The new version of Bacula provides four new directives that
2481 give additional control over what Bacula does if duplicate jobs
2482 are started. A duplicate job in the sense we use it here means
2483 a second or subsequent job with the same name starts. This
2484 happens most frequently when the first job runs longer than expected because no
2485 tapes are available.
2487 The four directives each take as an argument a {\bf yes} or {\bf no} value and
2488 are specified in the Job resource.
2492 \subsubsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
2493 \index[general]{Allow Duplicate Jobs}
2494 If this directive is set to {\bf yes}, duplicate jobs will be run. If
2495 the directive is set to {\bf no} (default) then only one job of a given name
2496 may run at one time, and the action that Bacula takes to ensure only
2497 one job runs is determined by the other directives (see below).
2499 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
2500 are present and none of the three directives given below permit
2501 Canceling a job, then the current job (the second one started)
2504 \subsubsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
2505 \index[general]{Allow Higher Duplicates}
2506 This directive was in version 5.0.0, but does not work as
2507 expected. If used, it should always be set to no. In later versions
2508 of Bacula the directive is disabled (disregarded).
2510 \subsubsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
2511 \index[general]{Cancel Running Duplicates}
2512 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
2513 if this directive is set to {\bf yes} any job that is already running
2514 will be canceled. The default is {\bf no}.
2516 \subsubsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
2517 \index[general]{Cancel Queued Duplicates}
2518 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
2519 if this directive is set to {\bf yes} any job that is
2520 already queued to run but not yet running will be canceled.
2521 The default is {\bf no}.
2524 \subsection{TLS Authentication}
2525 \index[general]{TLS Authentication}
2526 In Bacula version 2.5.x and later, in addition to the normal Bacula
2527 CRAM-MD5 authentication that is used to authenticate each Bacula
2528 connection, you can specify that you want TLS Authentication as well,
2529 which will provide more secure authentication.
2531 This new feature uses Bacula's existing TLS code (normally used for
2532 communications encryption) to do authentication. To use it, you must
2533 specify all the TLS directives normally used to enable communications
2534 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
2537 \subsubsection{TLS Authenticate = yes}
2539 TLS Authenticate = yes
2542 in the main daemon configuration resource (Director for the Director,
2543 Client for the File daemon, and Storage for the Storage daemon).
2545 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
2546 authentication, Bacula will also do TLS authentication, then TLS
2547 encryption will be turned off, and the rest of the communication between
2548 the two Bacula daemons will be done without encryption.
2550 If you want to encrypt communications data, use the normal TLS directives
2551 but do not turn on {\bf TLS Authenticate}.
2553 \subsection{bextract non-portable Win32 data}
2554 \index[general]{bextract handles Win32 non-portable data}
2555 {\bf bextract} has been enhanced to be able to restore
2556 non-portable Win32 data to any OS. Previous versions were
2557 unable to restore non-portable Win32 data to machines that
2558 did not have the Win32 BackupRead and BackupWrite API calls.
2560 \subsection{State File updated at Job Termination}
2561 \index[general]{State File}
2562 In previous versions of Bacula, the state file, which provides a
2563 summary of previous jobs run in the {\bf status} command output was
2564 updated only when Bacula terminated, thus if the daemon crashed, the
2565 state file might not contain all the run data. This version of
2566 the Bacula daemons updates the state file on each job termination.
2568 \subsection{MaxFullInterval = \lt{}time-interval\gt{}}
2569 \index[general]{MaxFullInterval}
2570 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
2571 can be used to specify the maximum time interval between {\bf Full} backup
2572 jobs. When a job starts, if the time since the last Full backup is
2573 greater than the specified interval, and the job would normally be an
2574 {\bf Incremental} or {\bf Differential}, it will be automatically
2575 upgraded to a {\bf Full} backup.
2577 \subsection{MaxDiffInterval = \lt{}time-interval\gt{}}
2578 \index[general]{MaxDiffInterval}
2579 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
2580 can be used to specify the maximum time interval between {\bf Differential} backup
2581 jobs. When a job starts, if the time since the last Differential backup is
2582 greater than the specified interval, and the job would normally be an
2583 {\bf Incremental}, it will be automatically
2584 upgraded to a {\bf Differential} backup.
2586 \subsection{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
2587 \index[general]{MaxDiffInterval}
2588 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
2589 by the user, and when it is set it is an indication to backup programs
2590 to not backup that particular file. This version of Bacula contains a
2591 new Options directive within a FileSet resource, which instructs Bacula to
2592 obey this flag. The new directive is:
2595 Honor No Dump Flag = yes\vb{}no
2598 The default value is {\bf no}.
2601 \subsection{Exclude Dir Containing = \lt{}filename-string\gt{}}
2602 \index[general]{IgnoreDir}
2603 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
2604 can be added to the Include section of the FileSet resource. If the specified
2605 filename ({\bf filename-string}) is found on the Client in any directory to be
2606 backed up, the whole directory will be ignored (not backed up). For example:
2609 # List of files to be backed up
2617 Exclude Dir Containing = .excludeme
2622 But in /home, there may be hundreds of directories of users and some
2623 people want to indicate that they don't want to have certain
2624 directories backed up. For example, with the above FileSet, if
2625 the user or sysadmin creates a file named {\bf .excludeme} in
2626 specific directories, such as
2629 /home/user/www/cache/.excludeme
2630 /home/user/temp/.excludeme
2633 then Bacula will not backup the two directories named:
2636 /home/user/www/cache
2640 NOTE: subdirectories will not be backed up. That is, the directive
2641 applies to the two directories in question and any children (be they
2642 files, directories, etc).
2645 \subsection{Bacula Plugins}
2646 \index[general]{Plugin}
2647 Support for shared object plugins has been implemented in the Linux, Unix
2648 and Win32 File daemons. The API will be documented separately in
2649 the Developer's Guide or in a new document. For the moment, there is
2650 a single plugin named {\bf bpipe} that allows an external program to
2651 get control to backup and restore a file.
2653 Plugins are also planned (partially implemented) in the Director and the
2656 \subsubsection{Plugin Directory}
2657 \index[general]{Plugin Directory}
2658 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2659 be added to the daemon definition resource. The directory takes a quoted
2660 string argument, which is the name of the directory in which the daemon can
2661 find the Bacula plugins. If this directive is not specified, Bacula will not
2662 load any plugins. Since each plugin has a distinctive name, all the daemons
2663 can share the same plugin directory.
2665 \subsubsection{Plugin Options}
2666 \index[general]{Plugin Options}
2667 The {\bf Plugin Options} directive takes a quoted string
2668 argument (after the equal sign) and may be specified in the
2669 Job resource. The options specified will be passed to all plugins
2670 when they are run. This each plugin must know what it is looking
2671 for. The value defined in the Job resource can be modified
2672 by the user when he runs a Job via the {\bf bconsole} command line
2675 Note: this directive may be specified, and there is code to modify
2676 the string in the run command, but the plugin options are not yet passed to
2677 the plugin (i.e. not fully implemented).
2679 \subsubsection{Plugin Options ACL}
2680 \index[general]{Plugin Options ACL}
2681 The {\bf Plugin Options ACL} directive may be specified in the
2682 Director's Console resource. It functions as all the other ACL commands
2683 do by permitting users running restricted consoles to specify a
2684 {\bf Plugin Options} that overrides the one specified in the Job
2685 definition. Without this directive restricted consoles may not modify
2688 \subsubsection{Plugin = \lt{}plugin-command-string\gt{}}
2689 \index[general]{Plugin}
2690 The {\bf Plugin} directive is specified in the Include section of
2691 a FileSet resource where you put your {\bf File = xxx} directives.
2702 Plugin = "bpipe:..."
2707 In the above example, when the File daemon is processing the directives
2708 in the Include section, it will first backup all the files in {\bf /home}
2709 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2710 the Plugin Directory. The syntax and semantics of the Plugin directive
2711 require the first part of the string up to the colon (:) to be the name
2712 of the plugin. Everything after the first colon is ignored by the File daemon but
2713 is passed to the plugin. Thus the plugin writer may define the meaning of the
2714 rest of the string as he wishes.
2716 Please see the next section for information about the {\bf bpipe} Bacula
2719 \subsection{The bpipe Plugin}
2720 \index[general]{The bpipe Plugin}
2721 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2722 the Bacula source distribution. When the plugin is compiled and linking into
2723 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2724 Please note that this is a very simple plugin that was written for
2725 demonstration and test purposes. It is and can be used in production, but
2726 that was never really intended.
2728 The purpose of the plugin is to provide an interface to any system program for
2729 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2730 the Include section of your Job's FileSet resource. The full syntax of the
2731 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2732 to specify the sytax as it wishes) is:
2735 Plugin = "<field1>:<field2>:<field3>:<field4>"
2740 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2741 stripped off, so in this case, we would put {\bf bpipe} in this field.
2743 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2744 pseudo path and filename under which the backup will be saved. This pseudo
2745 path and filename will be seen by the user in the restore file tree.
2746 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2747 backed up by the plugin will be put under that "pseudo" path and filename.
2748 You must be careful to choose a naming convention that is unique to avoid
2749 a conflict with a path and filename that actually exists on your system.
2751 \item {\bf field3} for the {\bf bpipe} plugin
2752 specifies the "reader" program that is called by the plugin during
2753 backup to read the data. {\bf bpipe} will call this program by doing a
2756 \item {\bf field4} for the {\bf bpipe} plugin
2757 specifies the "writer" program that is called by the plugin during
2758 restore to write the data back to the filesystem.
2761 Please note that for two items above describing the "reader" and "writer"
2762 fields, these programs are "executed" by Bacula, which
2763 means there is no shell interpretation of any command line arguments
2764 you might use. If you want to use shell characters (redirection of input
2765 or output, ...), then we recommend that you put your command or commands
2766 in a shell script and execute the script. In addition if you backup a
2767 file with the reader program, when running the writer program during
2768 the restore, Bacula will not automatically create the path to the file.
2769 Either the path must exist, or you must explicitly do so with your command
2770 or in a shell script.
2772 Putting it all together, the full plugin directive line might look
2776 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2777 --opt --databases bacula:mysql"
2780 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2781 would be written on a single line.
2783 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2784 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2785 program {\bf mysqldump -f --opt --database bacula} to read the data during
2786 backup. The mysqldump command outputs all the data for the database named
2787 {\bf bacula}, which will be read by the plugin and stored in the backup.
2788 During restore, the data that was backed up will be sent to the program
2789 specified in the last field, which in this case is {\bf mysql}. When
2790 {\bf mysql} is called, it will read the data sent to it by the plugn
2791 then write it back to the same database from which it came ({\bf bacula}
2794 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2795 the data from a specified program to Bacula for backup, and then from Bacula to
2796 a specified program for restore.
2798 By using different command lines to {\bf bpipe},
2799 you can backup any kind of data (ASCII or binary) depending
2800 on the program called.
2802 \subsection{Microsoft Exchange Server 2003/2007 Plugin}
2803 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2804 \subsubsection{Background}
2805 The Exchange plugin was made possible by a funded development project
2806 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2807 The code for the plugin was written by James Harper, and the Bacula core
2808 code by Kern Sibbald. All the code for this funded development has become
2809 part of the Bacula project. Thanks to everyone who made it happen.
2811 \subsubsection{Concepts}
2812 Although it is possible to backup Exchange using Bacula VSS the Exchange
2813 plugin adds a good deal of functionality, because while Bacula VSS
2814 completes a full backup (snapshot) of Exchange, it does
2815 not support Incremental or Differential backups, restoring is more
2816 complicated, and a single database restore is not possible.
2818 Microsoft Exchange organises its storage into Storage Groups with
2819 Databases inside them. A default installation of Exchange will have a
2820 single Storage Group called 'First Storage Group', with two Databases
2821 inside it, "Mailbox Store (SERVER NAME)" and
2822 "Public Folder Store (SERVER NAME)",
2823 which hold user email and public folders respectively.
2825 In the default configuration, Exchange logs everything that happens to
2826 log files, such that if you have a backup, and all the log files since,
2827 you can restore to the present time. Each Storage Group has its own set
2828 of log files and operates independently of any other Storage Groups. At
2829 the Storage Group level, the logging can be turned off by enabling a
2830 function called "Enable circular logging". At this time the Exchange
2831 plugin will not function if this option is enabled.
2833 The plugin allows backing up of entire storage groups, and the restoring
2834 of entire storage groups or individual databases. Backing up and
2835 restoring at the individual mailbox or email item is not supported but
2836 can be simulated by use of the "Recovery" Storage Group (see below).
2838 \subsubsection{Installing}
2839 The Exchange plugin requires a DLL that is shipped with Microsoft
2840 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2841 correctly the Exchange plugin should find this automatically and run
2842 without any additional installation.
2844 If the DLL can not be found automatically it will need to be copied into
2845 the Bacula installation
2846 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2847 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2848 default Exchange installation.
2850 \subsubsection{Backing Up}
2851 To back up an Exchange server the Fileset definition must contain at
2852 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2853 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2854 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2855 up files are prefixed with something that isn't going to share a name
2856 with something outside the plugin, and the 'Microsoft Information Store'
2857 bit is required also. It is also possible to add the name of a storage
2858 group to the "Plugin =" line, eg \\
2859 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2860 if you want only a single storage group backed up.
2862 Additionally, you can suffix the 'Plugin =' directive with
2863 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2864 database at the end of a full backup.
2866 An Incremental or Differential backup will backup only the database logs
2867 for each Storage Group by inspecting the "modified date" on each
2868 physical log file. Because of the way the Exchange API works, the last
2869 logfile backed up on each backup will always be backed up by the next
2870 Incremental or Differential backup too. This adds 5MB to each
2871 Incremental or Differential backup size but otherwise does not cause any
2874 By default, a normal VSS fileset containing all the drive letters will
2875 also back up the Exchange databases using VSS. This will interfere with
2876 the plugin and Exchange's shared ideas of when the last full backup was
2877 done, and may also truncate log files incorrectly. It is important,
2878 therefore, that the Exchange database files be excluded from the backup,
2879 although the folders the files are in should be included, or they will
2880 have to be recreated manually if a bare metal restore is done.
2885 File = C:/Program Files/Exchsrvr/mdbdata
2886 Plugin = "exchange:..."
2889 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2890 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2891 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2892 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2893 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2894 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2895 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2900 The advantage of excluding the above files is that you can significantly
2901 reduce the size of your backup since all the important Exchange files
2902 will be properly saved by the Plugin.
2905 \subsubsection{Restoring}
2906 The restore operation is much the same as a normal Bacula restore, with
2907 the following provisos:
2910 \item The {\bf Where} restore option must not be specified
2911 \item Each Database directory must be marked as a whole. You cannot just
2912 select (say) the .edb file and not the others.
2913 \item If a Storage Group is restored, the directory of the Storage Group
2915 \item It is possible to restore only a subset of the available log files,
2916 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2917 if a log file is missing from the sequence of log files
2918 \item Each database to be restored must be dismounted and marked as "Can be
2919 overwritten by restore"
2920 \item If an entire Storage Group is to be restored (eg all databases and
2921 logs in the Storage Group), then it is best to manually delete the
2922 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2923 as Exchange can get confused by stray log files lying around.
2926 \subsubsection{Restoring to the Recovery Storage Group}
2927 The concept of the Recovery Storage Group is well documented by
2929 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2930 but to briefly summarize...
2932 Microsoft Exchange allows the creation of an additional Storage Group
2933 called the Recovery Storage Group, which is used to restore an older
2934 copy of a database (e.g. before a mailbox was deleted) into without
2935 messing with the current live data. This is required as the Standard and
2936 Small Business Server versions of Exchange can not ordinarily have more
2937 than one Storage Group.
2939 To create the Recovery Storage Group, drill down to the Server in Exchange
2940 System Manager, right click, and select
2941 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2942 locations and click OK. On the Recovery Storage Group, right click and
2943 select {\bf "Add Database to Recover..."} and select the database you will
2946 Restore only the single database nominated as the database in the
2947 Recovery Storage Group. Exchange will redirect the restore to the
2948 Recovery Storage Group automatically.
2949 Then run the restore.
2951 \subsubsection{Restoring on Microsoft Server 2007}
2952 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2953 2007, and hence you use a new procedure for recovering a single mail box.
2954 This procedure is documented by Microsoft at:
2955 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2956 and involves using the {\bf Restore-Mailbox} and {\bf
2957 Get-Mailbox Statistics} shell commands.
2959 \subsubsection{Caveats}
2960 This plugin is still being developed, so you should consider it
2961 currently in BETA test, and thus use in a production environment
2962 should be done only after very careful testing.
2964 When doing a full backup, the Exchange database logs are truncated by
2965 Exchange as soon as the plugin has completed the backup. If the data
2966 never makes it to the backup medium (eg because of spooling) then the
2967 logs will still be truncated, but they will also not have been backed
2968 up. A solution to this is being worked on. You will have to schedule a
2969 new Full backup to ensure that your next backups will be usable.
2971 The "Enable Circular Logging" option cannot be enabled or the plugin
2974 Exchange insists that a successful Full backup must have taken place if
2975 an Incremental or Differential backup is desired, and the plugin will
2976 fail if this is not the case. If a restore is done, Exchange will
2977 require that a Full backup be done before an Incremental or Differential
2980 The plugin will most likely not work well if another backup application
2981 (eg NTBACKUP) is backing up the Exchange database, especially if the
2982 other backup application is truncating the log files.
2984 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2985 we recommend either carefully testing or that you avoid this option for
2988 The Exchange plugin is not called during processing the bconsole {\bf
2989 estimate} command, and so anything that would be backed up by the plugin
2990 will not be added to the estimate total that is displayed.
2993 \subsection{libdbi Framework}
2994 \index[general]{libdbi Framework}
2995 As a general guideline, Bacula has support for a few catalog database drivers
2996 (MySQL, PostgreSQL, SQLite)
2997 coded natively by the Bacula team. With the libdbi implementation, which is a
2998 Bacula driver that uses libdbi to access the catalog, we have an open field to
2999 use many different kinds database engines following the needs of users.
3001 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
3002 implements a database-independent abstraction layer in C, similar to the
3003 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
3004 leverage the power of multiple databases and multiple simultaneous database
3005 connections by using this framework.
3007 Currently the libdbi driver in Bacula project only supports the same drivers
3008 natively coded in Bacula. However the libdbi project has support for many
3009 others database engines. You can view the list at
3010 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
3011 supported by Bacula, however, they must be tested properly by the Bacula team.
3013 Some of benefits of using libdbi are:
3015 \item The possibility to use proprietary databases engines in which your
3016 proprietary licenses prevent the Bacula team from developing the driver.
3017 \item The possibility to use the drivers written for the libdbi project.
3018 \item The possibility to use other database engines without recompiling Bacula
3019 to use them. Just change one line in bacula-dir.conf
3020 \item Abstract Database access, this is, unique point to code and profiling
3021 catalog database access.
3024 The following drivers have been tested:
3026 \item PostgreSQL, with and without batch insert
3027 \item Mysql, with and without batch insert
3032 In the future, we will test and approve to use others databases engines
3033 (proprietary or not) like DB2, Oracle, Microsoft SQL.
3035 To compile Bacula to support libdbi we need to configure the code with the
3036 --with-dbi and --with-dbi-driver=[database] ./configure options, where
3037 [database] is the database engine to be used with Bacula (of course we can
3038 change the driver in file bacula-dir.conf, see below). We must configure the
3039 access port of the database engine with the option --with-db-port, because the
3040 libdbi framework doesn't know the default access port of each database.
3042 The next phase is checking (or configuring) the bacula-dir.conf, example:
3046 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
3047 dbname = regress; user = regress; password = ""
3051 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
3052 mysql database. Currently the drivers supported by Bacula are: postgresql,
3053 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
3055 The following limitations apply when Bacula is set to use the libdbi framework:
3056 - Not tested on the Win32 platform
3057 - A little performance is lost if comparing with native database driver.
3058 The reason is bound with the database driver provided by libdbi and the
3059 simple fact that one more layer of code was added.
3061 It is important to remember, when compiling Bacula with libdbi, the
3062 following packages are needed:
3064 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
3065 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
3068 You can download them and compile them on your system or install the packages
3069 from your OS distribution.
3071 \subsection{Console Command Additions and Enhancements}
3072 \index[general]{Console Additions}
3074 \subsubsection{Display Autochanger Content}
3075 \index[general]{StatusSlots}
3077 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
3078 autochanger content.
3082 Slot | Volume Name | Status | Media Type | Pool |
3083 ------+---------------+----------+-------------------+------------|
3084 1 | 00001 | Append | DiskChangerMedia | Default |
3085 2 | 00002 | Append | DiskChangerMedia | Default |
3086 3*| 00003 | Append | DiskChangerMedia | Scratch |
3091 If you an asterisk ({\bf *}) appears after the slot number, you must run an
3092 {\bf update slots} command to synchronize autochanger content with your
3095 \subsubsection{list joblog job=xxx or jobid=nnn}
3096 \index[general]{list joblog}
3097 A new list command has been added that allows you to list the contents
3098 of the Job Log stored in the catalog for either a Job Name (fully qualified)
3099 or for a particular JobId. The {\bf llist} command will include a line with
3100 the time and date of the entry.
3102 Note for the catalog to have Job Log entries, you must have a directive
3109 In your Director's {\bf Messages} resource.
3111 \subsubsection{Use separator for multiple commands}
3112 \index[general]{Command Separator}
3113 When using bconsole with readline, you can set the command separator with
3114 \textbf{@separator} command to one
3115 of those characters to write commands who require multiple input in one line.
3117 !$%&'()*+,-/:;<>?[]^`{|}~
3120 \subsubsection{Deleting Volumes}
3121 The delete volume bconsole command has been modified to
3122 require an asterisk (*) in front of a MediaId otherwise the
3123 value you enter is a taken to be a Volume name. This is so that
3124 users may delete numeric Volume names. The previous Bacula versions
3125 assumed that all input that started with a number was a MediaId.
3127 This new behavior is indicated in the prompt if you read it
3130 \subsection{Bare Metal Recovery}
3131 The old bare metal recovery project is essentially dead. One
3132 of the main features of it was that it would build a recovery
3133 CD based on the kernel on your system. The problem was that
3134 every distribution has a different boot procedure and different
3135 scripts, and worse yet, the boot procedures and scripts change
3136 from one distribution to another. This meant that maintaining
3137 (keeping up with the changes) the rescue CD was too much work.
3139 To replace it, a new bare metal recovery USB boot stick has been developed
3140 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
3141 boot from a USB key.
3145 \item Recovery can be done from within graphical environment.
3146 \item Recovery can be done in a shell.
3147 \item Ubuntu boots on a large number of Linux systems.
3148 \item The process of updating the system and adding new
3149 packages is not too difficult.
3150 \item The USB key can easily be upgraded to newer Ubuntu versions.
3151 \item The USB key has writable partitions for modifications to
3152 the OS and for modification to your home directory.
3153 \item You can add new files/directories to the USB key very easily.
3154 \item You can save the environment from multiple machines on
3156 \item Bacula Systems is funding its ongoing development.
3159 The disadvantages are:
3161 \item The USB key is usable but currently under development.
3162 \item Not everyone may be familiar with Ubuntu (no worse
3164 \item Some older OSes cannot be booted from USB. This can
3165 be resolved by first booting a Ubuntu LiveCD then plugging
3167 \item Currently the documentation is sketchy and not yet added
3168 to the main manual. See below ...
3171 The documentation and the code can be found in the {\bf rescue} package
3172 in the directory {\bf linux/usb}.
3174 \subsection{Miscellaneous}
3175 \index[general]{Misc New Features}
3177 \subsubsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
3178 \index[general]{Allow Mixed Priority}
3179 This directive is only implemented in version 2.5 and later. When
3180 set to {\bf yes} (default {\bf no}), this job may run even if lower
3181 priority jobs are already running. This means a high priority job
3182 will not have to wait for other jobs to finish before starting.
3183 The scheduler will only mix priorities when all running jobs have
3186 Note that only higher priority jobs will start early. Suppose the
3187 director will allow two concurrent jobs, and that two jobs with
3188 priority 10 are running, with two more in the queue. If a job with
3189 priority 5 is added to the queue, it will be run as soon as one of
3190 the running jobs finishes. However, new priority 10 jobs will not
3191 be run until the priority 5 job has finished.
3193 \subsubsection{Bootstrap File Directive -- FileRegex}
3194 \index[general]{Bootstrap File Directive}
3195 {\bf FileRegex} is a new command that can be added to the bootstrap
3196 (.bsr) file. The value is a regular expression. When specified, only
3197 matching filenames will be restored.
3199 During a restore, if all File records are pruned from the catalog
3200 for a Job, normally Bacula can restore only all files saved. That
3201 is there is no way using the catalog to select individual files.
3202 With this new feature, Bacula will ask if you want to specify a Regex
3203 expression for extracting only a part of the full backup.
3206 Building directory tree for JobId(s) 1,3 ...
3207 There were no files inserted into the tree, so file selection
3208 is not possible.Most likely your retention policy pruned the files
3210 Do you want to restore all the files? (yes\vb{}no): no
3212 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
3213 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
3216 \subsubsection{Bootstrap File Optimization Changes}
3217 In order to permit proper seeking on disk files, we have extended the bootstrap
3218 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
3219 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
3220 address range and end address range respectively. These two directives replace
3221 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
3222 VolEndBlock} directives. Bootstrap files containing the old directives will
3223 still work, but will not properly take advantage of proper disk seeking, and
3224 may read completely to the end of a disk volume during a restore. With the new
3225 format (automatically generated by the new Director), restores will seek
3226 properly and stop reading the volume when all the files have been restored.
3228 \subsubsection{Solaris ZFS/NFSv4 ACLs}
3229 This is an upgrade of the previous Solaris ACL backup code
3230 to the new library format, which will backup both the old
3231 POSIX(UFS) ACLs as well as the ZFS ACLs.
3233 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
3234 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
3235 be used to transfer from UFS to ZFS filesystems.
3238 \subsubsection{Virtual Tape Emulation}
3239 \index[general]{Virtual Tape Emulation}
3240 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
3241 the tape code but actually reading and writing to a disk file. Used with the
3242 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
3243 and 700 slots. This feature is most useful in testing. It is enabled
3244 by using {\bf Device Type = vtape} in the Storage daemon's Device
3245 directive. This feature is only implemented on Linux machines and should not be
3246 used for production.
3248 \subsubsection{Bat Enhancements}
3249 \index[general]{Bat Enhancements}
3250 Bat (the Bacula Administration Tool) GUI program has been significantly
3251 enhanced and stabilized. In particular, there are new table based status
3252 commands; it can now be easily localized using Qt4 Linguist.
3254 The Bat communications protocol has been significantly enhanced to improve
3255 GUI handling. Note, you {\bf must} use a the bat that is distributed with
3256 the Director you are using otherwise the communications protocol will not
3259 \subsubsection{RunScript Enhancements}
3260 \index[general]{RunScript Enhancements}
3261 The {\bf RunScript} resource has been enhanced to permit multiple
3262 commands per RunScript. Simply specify multiple {\bf Command} directives
3269 Command = "/bin/echo test"
3270 Command = "/bin/echo an other test"
3271 Command = "/bin/echo 3 commands in the same runscript"
3278 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
3279 implemented, which runs the command after the Volume Shadow Copy has been made.
3281 Console commands can be specified within a RunScript by using:
3282 {\bf Console = \lt{}command\gt{}}, however, this command has not been
3283 carefully tested and debugged and is known to easily crash the Director.
3284 We would appreciate feedback. Due to the recursive nature of this command, we
3285 may remove it before the final release.
3287 \subsubsection{Status Enhancements}
3288 \index[general]{Status Enhancements}
3289 The bconsole {\bf status dir} output has been enhanced to indicate
3290 Storage daemon job spooling and despooling activity.
3292 \subsubsection{Connect Timeout}
3293 \index[general]{Connect Timeout}
3294 The default connect timeout to the File
3295 daemon has been set to 3 minutes. Previously it was 30 minutes.
3297 \subsubsection{ftruncate for NFS Volumes}
3298 \index[general]{ftruncate for NFS Volumes}
3299 If you write to a Volume mounted by NFS (say on a local file server),
3300 in previous Bacula versions, when the Volume was recycled, it was not
3301 properly truncated because NFS does not implement ftruncate (file
3302 truncate). This is now corrected in the new version because we have
3303 written code (actually a kind user) that deletes and recreates the Volume,
3304 thus accomplishing the same thing as a truncate.
3306 \subsubsection{Support for Ubuntu}
3307 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
3308 version of Linux, and thus now provides correct autostart routines.
3309 Since Ubuntu officially supports Bacula, you can also obtain any
3310 recent release of Bacula from the Ubuntu repositories.
3312 \subsubsection{Recycle Pool = \lt{}pool-name\gt{}}
3313 \index[general]{Recycle Pool}
3314 The new \textbf{RecyclePool} directive defines to which pool the Volume will
3315 be placed (moved) when it is recycled. Without this directive, a Volume will
3316 remain in the same pool when it is recycled. With this directive, it can be
3317 moved automatically to any existing pool during a recycle. This directive is
3318 probably most useful when defined in the Scratch pool, so that volumes will
3319 be recycled back into the Scratch pool.
3321 \subsubsection{FD Version}
3322 \index[general]{FD Version}
3323 The File daemon to Director protocol now includes a version
3324 number, which although there is no visible change for users,
3325 will help us in future versions automatically determine
3326 if a File daemon is not compatible.
3328 \subsubsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
3329 \index[general]{Max Run Sched Time}
3330 The time specifies the maximum allowed time that a job may run, counted from
3331 when the job was scheduled. This can be useful to prevent jobs from running
3332 during working hours. We can see it like \texttt{Max Start Delay + Max Run
3335 \subsubsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
3336 \index[general]{Max Wait Time}
3337 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
3338 of checking the maximum allowed time that a job may block for a resource,
3339 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
3340 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
3341 their job depending on the level. Now, they have to use
3342 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
3343 directives are now deprecated.
3345 \subsubsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
3346 \index[general]{Incremental Max Wait Time}
3347 \index[general]{Differential Max Wait Time}
3349 These directives have been deprecated in favor of
3350 \texttt{Incremental|Differential Max Run Time}.
3352 \subsubsection{Max Run Time directives}
3353 \index[general]{Max Run Time directives}
3354 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
3355 maximum allowed time that a job can run depending on the level.
3357 \addcontentsline{lof}{figure}{Job time control directives}
3359 \includegraphics[width=\linewidth]{different_time}
3362 \subsubsection{Statistics Enhancements}
3363 \index[general]{Statistics Enhancements}
3364 If you (or probably your boss) want to have statistics on your backups to
3365 provide some \textit{Service Level Agreement} indicators, you could use a few
3366 SQL queries on the Job table to report how many:
3370 \item jobs have been successful
3371 \item files have been backed up
3375 However, these statistics are accurate only if your job retention is greater
3376 than your statistics period. Ie, if jobs are purged from the catalog, you won't
3377 be able to use them.
3379 Now, you can use the \textbf{update stats [days=num]} console command to fill
3380 the JobHistory table with new Job records. If you want to be sure to take in
3381 account only \textbf{good jobs}, ie if one of your important job has failed but
3382 you have fixed the problem and restarted it on time, you probably want to
3383 delete the first \textit{bad} job record and keep only the successful one. For
3384 that simply let your staff do the job, and update JobHistory table after two or
3385 three days depending on your organization using the \textbf{[days=num]} option.
3387 These statistics records aren't used for restoring, but mainly for
3388 capacity planning, billings, etc.
3390 The Bweb interface provides a statistics module that can use this feature. You
3391 can also use tools like Talend or extract information by yourself.
3393 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
3394 the length of time that Bacula will keep statistics job records in the Catalog
3395 database after the Job End time. (In \texttt{JobHistory} table) When this time
3396 period expires, and if user runs \texttt{prune stats} command, Bacula will
3397 prune (remove) Job records that are older than the specified period.
3399 You can use the following Job resource in your nightly \textbf{BackupCatalog}
3400 job to maintain statistics.
3403 Name = BackupCatalog
3406 Console = "update stats days=3"
3407 Console = "prune stats yes"
3414 \subsubsection{ScratchPool = \lt{}pool-resource-name\gt{}}
3415 \index[general]{ScratchPool}
3416 This directive permits to specify a specific \textsl{Scratch} pool for the
3417 current pool. This is useful when using multiple storage sharing the same
3418 mediatype or when you want to dedicate volumes to a particular set of pool.
3420 \subsubsection{Enhanced Attribute Despooling}
3421 \index[general]{Attribute Despooling}
3422 If the storage daemon and the Director are on the same machine, the spool file
3423 that contains attributes is read directly by the Director instead of being
3424 transmitted across the network. That should reduce load and speedup insertion.
3426 \subsubsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
3427 \index[general]{SpoolSize}
3428 A new Job directive permits to specify the spool size per job. This is used
3429 in advanced job tunning. {\bf SpoolSize={\it bytes}}
3431 \subsubsection{MaximumConsoleConnections = \lt{}number\gt{}}
3432 \index[general]{MaximumConsoleConnections}
3433 A new director directive permits to specify the maximum number of Console
3434 Connections that could run concurrently. The default is set to 20, but you may
3435 set it to a larger number.
3437 \subsubsection{VerId = \lt{}string\gt{}}
3438 \index[general]{VerId}
3439 A new director directive permits to specify a personnal identifier that will be
3440 displayed in the \texttt{version} command.
3442 \subsubsection{dbcheck enhancements}
3443 \index[general]{dbcheck enhancements}
3444 If you are using Mysql, dbcheck will now ask you if you want to create
3445 temporary indexes to speed up orphaned Path and Filename elimination.
3447 A new \texttt{-B} option allows you to print catalog information in a simple
3448 text based format. This is useful to backup it in a secure way.
3463 You can now specify the database connection port in the command line.
3465 \subsubsection{{-}{-}docdir configure option}
3466 \index[general]{{-}{-}docdir configure option}
3467 You can use {-}{-}docdir= on the ./configure command to
3468 specify the directory where you want Bacula to install the
3469 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
3470 {\bf /usr/share/doc/bacula}.
3472 \subsubsection{{-}{-}htmldir configure option}
3473 \index[general]{{-}{-}htmldir configure option}
3474 You can use {-}{-}htmldir= on the ./configure command to
3475 specify the directory where you want Bacula to install the bat html help
3476 files. The default is {\bf /usr/share/doc/bacula/html}
3478 \subsubsection{{-}{-}with-plugindir configure option}
3479 \index[general]{{-}{-}plugindir configure option}
3480 You can use {-}{-}plugindir= on the ./configure command to
3481 specify the directory where you want Bacula to install
3482 the plugins (currently only bpipe-fd). The default is