1 \chapter{New Features in 7.0.0}
2 This chapter presents the new features that have been added to
3 the various versions of Bacula.
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 storage}
48 The bconsole {\bf status storage} has been modified to attempt to eliminate
49 duplicate storage resources and only show one that references any given
50 storage daemon. This might be confusing at first, but tends to make a
51 much more compact list of storage resource from which to select if there
52 are multiple storage devices in the same storage daemon.
54 If you want the old behavior (always display all storage resources) simply
55 add the keyword {\bf select} to the command -- i.e. use
56 {\bf status select storage}.
62 \subsection{status schedule}
63 A new status command option called {\bf scheduled} has been implemented
64 in bconsole. By default it will display 20 lines of the next scheduled
65 jobs. For example, with the default bacula-dir.conf configuration file,
66 a bconsole command {\bf status scheduled} produces:
70 Level Type Pri Scheduled Job Name Schedule
71 ======================================================================
72 Differential Backup 10 Sun 30-Mar 23:05 BackupClient1 WeeklyCycle
73 Incremental Backup 10 Mon 24-Mar 23:05 BackupClient1 WeeklyCycle
74 Incremental Backup 10 Tue 25-Mar 23:05 BackupClient1 WeeklyCycle
76 Full Backup 11 Mon 24-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
77 Full Backup 11 Wed 26-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
82 Note, the output is listed by the Jobs found, and is not sorted
86 This command has a number of options, most of which act as filters:
88 \item {\bf days=nn} This specifies the number of days to list. The default is
89 10 but can be set from 0 to 500.
90 \item {\bf limit=nn} This specifies the limit to the number of lines to print.
91 The default is 100 but can be any number in the range 0 to 2000.
92 \item {\bf time="YYYY-MM-DD HH:MM:SS"} Sets the start time for listing the
93 scheduled jobs. The default is to use the current time. Note, the
94 time value must be specified inside double quotes and must be in
95 the exact form shown above.
96 \item {\bf schedule=schedule-name} This option restricts the output to
98 \item {\bf job=job-name} This option restricts the output to the specified
102 \subsection{Data Encryption Cipher Configuration}
103 Bacula version 7.0 and later now allows to configure the data
104 encryption cipher and the digest algorithm. The cipher was forced to AES
105 128, and it is now possible to choose between the following ciphers:
108 \item AES128 (default)
114 The digest algorithm was set to SHA1 or SHA256 depending on the local
116 options. We advise you to not modify the PkiDigest default setting. Please,
117 refer to OpenSSL documentation to know about pro and cons on these options.
126 \subsection{New Truncate Command}
127 We have added a new truncate command to bconsole, which
128 will truncate a Volume if the Volume is purged and if
129 the Volume is also marked {\bf Action On Purge = Truncate}.
130 This feature was originally added in Bacula version 5.0.1,
131 but the mechanism for actually doing the truncate required
132 the user to enter a command such as:
135 purge volume action=truncate storage=File pool=Default
138 The above command is now simplified to be:
141 truncate storage=File pool=Default
144 \subsection{Migration/Copy/VirtualFull Performance Enhancements}
145 The Bacula Storage daemon now permits multiple jobs to simultaneously read
146 the same disk Volume, which gives substantial performance enhancements when
147 running Migration, Copy, or VirtualFull jobs that read disk Volumes. Our
148 testing shows that when running multiple simultaneous jobs, the jobs can
149 finish up to ten times faster with this version of Bacula. This is
150 built-in to the Storage daemon, so it happens automatically and
153 \subsection{VirtualFull Backup Consolidation Enhancements}
154 By default Bacula selects jobs automatically for a VirtualFull,
155 however, you may want to create the Virtual backup based on a
156 particular backup (point in time) that exists.
158 For example, if you have the following backup Jobs in your catalog:
160 +-------+---------+-------+----------+----------+-----------+
161 | JobId | Name | Level | JobFiles | JobBytes | JobStatus |
162 +-------+---------+-------+----------+----------+-----------+
163 | 1 | Vbackup | F | 1754 | 50118554 | T |
164 | 2 | Vbackup | I | 1 | 4 | T |
165 | 3 | Vbackup | I | 1 | 4 | T |
166 | 4 | Vbackup | D | 2 | 8 | T |
167 | 5 | Vbackup | I | 1 | 6 | T |
168 | 6 | Vbackup | I | 10 | 60 | T |
169 | 7 | Vbackup | I | 11 | 65 | T |
170 | 8 | Save | F | 1758 | 50118564 | T |
171 +-------+---------+-------+----------+----------+-----------+
174 and you want to consolidate only the first 3 jobs and create a
175 virtual backup equivalent to Job 1 + Job 2 + Job 3, you will use
176 \texttt{jobid=3} in the \texttt{run} command, then Bacula will select the
177 previous Full backup, the previous Differential (if any) and all subsequent
181 run job=Vbackup jobid=3 level=VirtualFull
184 If you want to consolidate a specific job list, you must specify the exact
185 list of jobs to merge in the run command line. For example, to consolidate
186 the last Differential and all subsequent Incremental, you will use
187 \texttt{jobid=4,5,6,7} or \texttt{jobid=4-7} on the run command line. As one
188 of the Job in the list is a Differential backup, Bacula will set the new job
189 level to Differential. If the list is composed only with Incremental jobs,
190 the new job will have a level set to Incremental.
193 run job=Vbackup jobid=4-7 level=VirtualFull
196 When using this feature, Bacula will automatically discard jobs that are
197 not related to the current Job. For example, specifying
198 \texttt{jobid=7,8}, Bacula will discard JobId 8 because it is not
199 part of the same backup Job.
201 We do not recommend it, but really want to consolidate jobs that have
202 different names (so probably different clients, filesets, etc...), you must
203 use \texttt{alljobid=} keyword instead of \texttt{jobid=}.
206 run job=Vbackup alljobid=1-3,6-8 level=VirtualFull
210 \subsection{FD Storage Address}
212 When the Director is behind a NAT, in a WAN area, to connect to
214 the StorageDaemon, the Director uses an ``external'' ip address,
215 and the FileDaemon should use an ``internal'' IP address to contact the
218 The normal way to handle this situation is to use a canonical name such as
219 ``storage-server'' that will be resolved on the Director side as the WAN
220 address and on the Client side as the LAN address. This is now possible to
221 configure this parameter using the new directive \texttt{FDStorageAddress} in
222 the Storage or Client resource.
225 \includegraphics[width=0.8\linewidth]{BackupOverWan1}
226 \label{fig:fdstorageaddress}
232 FD Storage Address = 10.0.0.1
238 % # or in the Client resouce
245 FD Storage Address = 10.0.0.1
251 Note that using the Client \texttt{FDStorageAddress} directive will not allow
252 to use multiple Storage Daemon, all Backup or Restore requests will be sent to
253 the specified \texttt{FDStorageAddress}.
255 \subsection{Job Bandwidth Limitation}
257 The new {\bf Job Bandwidth Limitation} directive may be added to the File
258 daemon's and/or Director's configuration to limit the bandwidth used by a
259 Job on a Client. It can be set in the File daemon's conf file for all Jobs
260 run in that File daemon, or it can be set for each Job in the Director's
261 conf file. The speed is always specified in bytes per second.
267 Working Directory = /some/path
268 Pid Directory = /some/path
270 Maximum Bandwidth Per Job = 5Mb/s
274 The above example would cause any jobs running with the FileDaemon to not
275 exceed 5 megabytes per second of throughput when sending data to the
276 Storage Daemon. Note, the speed is always specified in bytes per second
277 (not in bits per second), and the case (upper/lower) of the specification
278 characters is ignored (i.e. 1MB/s = 1Mb/s).
280 You may specify the following speed parameter modifiers:
281 k/s (1,000 bytes per second), kb/s (1,024 bytes per second),
282 m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second).
288 FileSet = FS_localhost
291 Maximum Bandwidth = 5Mb/s
296 The above example would cause Job \texttt{localhost-data} to not exceed 5MB/s
297 of throughput when sending data from the File daemon to the Storage daemon.
299 A new console command \texttt{setbandwidth} permits to set dynamically the
300 maximum throughput of a running Job or for future jobs of a Client.
303 * setbandwidth limit=1000 jobid=10
306 Please note that the value specified for the \texttt{limit} command
307 line parameter is always in units of 1024 bytes (i.e. the number
308 is multiplied by 1024 to give the number of bytes per second). As
309 a consequence, the above limit of 1000 will be interpreted as a
310 limit of 1000 * 1024 = 1,024,000 bytes per second.
313 This project was funded by Bacula Systems.
316 \subsection{Maximum Concurrent Read Jobs}
317 This is a new directive that can be used in the {\bf bacula-dir.conf} file
318 in the Storage resource. The main purpose is to limit the number
319 of concurrent Copy, Migration, and VirtualFull jobs so that
320 they don't monopolize all the Storage drives causing a deadlock situation
321 where all the drives are allocated for reading but none remain for
322 writing. This deadlock situation can occur when running multiple
323 simultaneous Copy, Migration, and VirtualFull jobs.
326 The default value is set to 0 (zero), which means there is no
327 limit on the number of read jobs. Note, limiting the read jobs
328 does not apply to Restore jobs, which are normally started by
329 hand. A reasonable value for this directive is one half the number
330 of drives that the Storage resource has rounded down. Doing so,
331 will leave the same number of drives for writing and will generally
332 avoid over committing drives and a deadlock.
335 \subsection{Director job Codes in Message Resource Commands}
336 Before submitting the specified mail command to the operating system, Bacula
337 performs character substitution like in Runscript commands. Bacula will now
338 perform also specific Director character substitution.
341 The code for this feature was contributed by Bastian Friedrich.
343 \subsection{Additions to RunScript variables}
344 The following variables are now available in runscripts:
346 \item current PID using \%P
347 \item if the job is a clone job using \%C
351 RunAfterJob = "/bin/echo Pid=%P isCloned=%C"
355 \subsection{Read Only Storage Devices}
356 This version of Bacula permits defining a Storage daemon device
357 to be read-only. That is if the {\bf ReadOnly} directive is specified and
358 enabled, the drive can only be used for read operations.
359 The the {\bf ReadOnly} directive can be defined in any bacula-sd.conf
360 Device resource, and is most useful to reserve one or more
361 drives for restores. An example is:
367 \subsection{New Prune ``Expired'' Volume Command}
368 It is now possible to prune all volumes
369 (from a pool, or globally) that are ``expired''. This option can be
370 scheduled after or before the backup of the Catalog and can be
371 combined with the Truncate On Purge option. The Expired Prune option can
372 be used instead of the \texttt{manual\_prune.pl} script.
375 * prune expired volumes
377 * prune expired volumes pool=FullPool
380 To schedule this option automatically, it can be added to the BackupCatalog job
388 Console = "prune expired volume yes"
394 \subsection{Hardlink Performance Enhancements}
395 If you use a program such as Cyrus IMAP that creates very large numbers
396 of hardlinks, the time to build the interactive restore tree can be
397 excessively long. This version of Bacula has a new feature that
398 automatically keeps the hardlinks associated with the restore tree
399 in memory, which consumes a bit more memory but vastly speeds up
400 building the tree. If the memory usage is too big for your system, you
401 can reduce the amount of memory used during the restore command by
402 adding the option {\bf optimizespeed=false} on the bconsole run
405 This feature was developed by Josip Almasi, and enhanced to be runtime
406 dynamic by Kern Sibbald.
408 \subsection{DisableCommand Directive}
409 There is a new Directive named {\bf Disable Command} that
410 can be put in the File daemon Client or Director resource.
411 If it is in the Client, it applies globally, otherwise the
412 directive applies only to the Director in which it is found.
413 The Disable Command adds security to your File daemon by
414 disabling certain commands. The commands that can be
440 On or more of these command keywords can be placed in quotes and separated
441 by spaces on the Disable Command directive line. Note: the commands must
442 be written exactly as they appear above.
444 \subsection{Multiple Console Directors}
445 Support for multiple bconsole and bat Directors in the bconsole.conf and
446 bat.conf files has been implemented and/or improved.
448 \subsection{Restricted Consoles}
449 Better support for Restricted consoles has been implement for bconsole and
452 \subsection{Configuration Files}
453 In previous versions of Bacula the configuration files for each component
454 were limited to a maximum of 499 bytes per configuration file line. This
455 version of Bacula permits unlimited input line lengths. This can be
456 especially useful for specifying more complicated Migration/Copy SQL
457 statements and in creating long restricted console ACL lists.
459 \subsection{Maximum Spawned Jobs}
460 The Job resource now permits specifying a number of {\bf Maximum Spawn
461 Jobs}. The default is 300. This directive can be useful if you have
462 big hardware and you do a lot of Migration/Copy jobs which start
463 at the same time. In prior versions of Bacula, Migration/Copy
464 was limited to spawning a maximum of 100 jobs at a time.
466 \subsection{Progress Meter}
467 The new File daemon has been enhanced to send its progress (files
468 processed and bytes written) to the Director every 30 seconds. These
469 figures can then be displayed with a bconsole {\bf status dir}
472 \subsection{Scheduling a 6th Week}
473 Prior version of Bacula permits specifying 1st through 5th week of
474 a month (first through fifth) as a keyword on the {\bf run}
475 directive of a Schedule resource. This version of Bacula also permits
476 specifying the 6th week of a month with the keyword {\bf sixth} or
479 \subsection{Scheduling the Last Day of a Month}
480 This version of Bacula now permits specifying the {\bf lastday}
481 keyword in the {\bf run} directive of a Schedule resource.
482 If {\bf lastday} is specified, it will apply only to those months
483 specified on the {\bf run} directive. Note: by default all months
486 \subsection{Improvements to Cancel and Restart bconsole Commands}
487 The Restart bconsole command now allow selection of either
488 canceled or failed jobs to be restarted. In addition both the
489 {\bf cancel} and {\bf restart} bconsole commands permit entering
490 a number of JobIds separated by commas or a range of JobIds indicated
491 by a dash between the begin and end range (e.g. 3-10). Finally the
492 two commands also allow one to enter the special keyword {\bf all}
493 to select all the appropriate Jobs.
495 \subsection{bconsole Performance Improvements}
496 In previous versions of Bacula certain bconsole commands could wait a long
497 time due to catalog lock contention. This was especially noticeable
498 when a large number of jobs were running and putting their attributes
499 into the catalog. This version uses a separate catalog connection that
500 should significantly enhance performance.
502 \subsection{New .bvfs\_decode\_lstat Command}
503 There is a new bconsole command, which is
504 {\bf .bvfs\_decode\_lstat} it requires one argument, which
505 is {\bf lstat="lstat value to decode"}. An example command
506 in bconsole and the output might be:
510 .bvfs_decode_lstat lstat="A A EHt B A A A JP BAA B BTL/A7 BTL/A7 BTL/A7 A A C"
528 \subsection*{New Debug Options}
530 In Bacula Enterprise version 8.0 and later, we introduced new options to
531 the \texttt{setdebug} command.
535 If the \texttt{options} parameter is set, the following arguments can be
536 used to control debug functions.
539 \item [0] clear debug flags
540 \item [i] Turn off, ignore bwrite() errors on restore on File Daemon
541 \item [d] Turn off decomp of BackupRead() streams on File Daemon
542 \item [t] Turn on timestamp in traces
543 \item [T] Turn off timestamp in traces
544 \item [c] Truncate trace file if trace file is activated
545 \item [l] Turn on recoding events on P() and V()
546 \item [p] Turn on the display of the event ring when doing a bactrace
551 The following command will truncate the trace file and will turn on timestamps
555 * setdebug level=10 trace=1 options=ct fd
560 It is now possible to use \textsl{class} of debug messages called \texttt{tags}
561 to control the debug output of Bacula daemons.
564 \item [all] Display all debug messages
565 \item [bvfs] Display BVFS debug messages
566 \item [sql] Display SQL related debug messages
567 \item [memory] Display memory and poolmem allocation messages
568 \item [scheduler] Display scheduler related debug messages
572 * setdebug level=10 tags=bvfs,sql,memory
573 * setdebug level=10 tags=!bvfs
575 # bacula-dir -t -d 200,bvfs,sql
578 The \texttt{tags} option is composed of a list of tags, tags are separated by
579 ``,'' or ``+'' or ``-'' or ``!''. To disable a specific tag, use ``-'' or ``!''
580 in front of the tag. Note that more tags will come in future versions.
582 %\LTXtable{\linewidth}{table_debugtags}
585 \chapter{New Features in 5.2.13}
586 This chapter presents the new features that have been added to the current
587 Community version of Bacula that is now released.
589 \subsection{Additions to RunScript variables}
590 You can have access to Director name using \%D in your runscript
594 RunAfterJob = "/bin/echo Director=%D
597 \section{New Features in 5.2.1}
598 This chapter presents the new features were added in the
599 Community release version 5.2.1.
601 There are additional features (plugins) available in the Enterprise version
602 that are described in another chapter. A subscription to Bacula Systems
603 is required for the Enterprise version.
605 \subsection{LZO Compression}
607 LZO compression has been to the File daemon. From the user's point of view,
608 it works like the GZIP compression (just replace {\bf compression=GZIP} with
609 {\bf compression=LZO}).
614 Options {compression=LZO }
620 LZO provides a much faster compression and decompression speed but lower
621 compression ratio than GZIP. It is a good option when you backup to disk. For
622 tape, the hardware compression is almost always a better option.
624 LZO is a good alternative for GZIP1 when you don't want to slow down your
625 backup. With a modern CPU it should be able to run almost as fast as:
628 \item your client can read data from disk. Unless you have very fast disks like
629 SSD or large/fast RAID array.
630 \item the data transfers between the file daemon and the storage daemon even on
634 Note, Bacula uses compression level LZO1X-1.
637 The code for this feature was contributed by Laurent Papier.
639 \subsection{New Tray Monitor}
641 Since the old integrated Windows tray monitor doesn't work with
642 recent Windows versions, we have written a new Qt Tray Monitor that is available
643 for both Linux and Windows. In addition to all the previous features,
644 this new version allows you to run Backups from
645 the tray monitor menu.
649 \includegraphics[width=0.8\linewidth]{tray-monitor}
650 \label{fig:traymonitor}
651 \caption{New tray monitor}
656 \includegraphics[width=0.8\linewidth]{tray-monitor1}
657 \label{fig:traymonitor1}
658 \caption{Run a Job through the new tray monitor}
662 To be able to run a job from the tray monitor, you need to
663 allow specific commands in the Director monitor console:
668 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
669 ClientACL = *all* # you can restrict to a specific host
681 This project was funded by Bacula Systems and is available with Bacula
682 the Enterprise Edition and the Community Edition.
684 \subsection{Purge Migration Job}
686 The new {\bf Purge Migration Job} directive may be added to the Migration
687 Job definition in the Director's configuration file. When it is enabled
688 the Job that was migrated during a migration will be purged at
689 the end of the migration job.
697 Client = localhost-fd
700 Storage = DiskChanger
703 Selection Pattern = ".*Save"
705 Purge Migration Job = yes
711 This project was submitted by Dunlap Blake; testing and documentation was funded
714 \subsection{Changes in Bvfs (Bacula Virtual FileSystem)}
716 Bat has now a bRestore panel that uses Bvfs to display files and
721 \includegraphics[width=0.8\linewidth]{bat-brestore}
722 \label{fig:batbrestore}
723 \caption{Bat Brestore Panel}
726 the Bvfs module works correctly with BaseJobs, Copy and Migration jobs.
729 This project was funded by Bacula Systems.
731 \subsubsection*{General notes}
734 \item All fields are separated by a tab
735 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
736 records in very big directories
737 \item All operations (except cache creation) are designed to run instantly
738 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
739 can contribute new faster SQL queries we will be happy, else don't complain
741 \item The cache creation is dependent of the number of directories. As Bvfs
742 shares information across jobs, the first creation can be slow
743 \item All fields are separated by a tab
744 \item Due to potential encoding problem, it's advised to always use pathid in
748 \subsubsection*{Get dependent jobs from a given JobId}
750 Bvfs allows you to query the catalog against any combination of jobs. You
751 can combine all Jobs and all FileSet for a Client in a single session.
753 To get all JobId needed to restore a particular job, you can use the
754 \texttt{.bvfs\_get\_jobids} command.
757 .bvfs_get_jobids jobid=num [all]
761 .bvfs_get_jobids jobid=10
763 .bvfs_get_jobids jobid=10 all
767 In this example, a normal restore will need to use JobIds 1,2,5,10 to
768 compute a complete restore of the system.
770 With the \texttt{all} option, the Director will use all defined FileSet for
773 \subsubsection*{Generating Bvfs cache}
775 The \texttt{.bvfs\_update} command computes the directory cache for jobs
776 specified in argument, or for all jobs if unspecified.
779 .bvfs_update [jobid=numlist]
784 .bvfs_update jobid=1,2,3
787 You can run the cache update process in a RunScript after the catalog backup.
789 \subsubsection*{Get all versions of a specific file}
791 Bvfs allows you to find all versions of a specific file for a given Client with
792 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
793 function uses only PathId and FilenameId. The jobid argument is mandatory but
797 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
798 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
799 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
806 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
807 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
810 \subsubsection*{List directories}
812 Bvfs allows you to list directories in a specific path.
814 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
815 PathId FilenameId FileId JobId LStat Path
816 PathId FilenameId FileId JobId LStat Path
817 PathId FilenameId FileId JobId LStat Path
821 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
822 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
823 listed is a directory.
826 .bvfs_lsdirs pathid=4 jobid=1,11,12
827 4 0 0 0 A A A A A A A A A A A A A A .
828 5 0 0 0 A A A A A A A A A A A A A A ..
829 3 0 0 0 A A A A A A A A A A A A A A regress/
832 In this example, to list directories present in \texttt{regress/}, you can use
834 .bvfs_lsdirs pathid=3 jobid=1,11,12
835 3 0 0 0 A A A A A A A A A A A A A A .
836 4 0 0 0 A A A A A A A A A A A A A A ..
837 2 0 0 0 A A A A A A A A A A A A A A tmp/
840 \subsubsection*{List files}
842 Bvfs allows you to list files in a specific path.
844 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
845 PathId FilenameId FileId JobId LStat Path
846 PathId FilenameId FileId JobId LStat Path
847 PathId FilenameId FileId JobId LStat Path
851 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
852 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
856 .bvfs_lsfiles pathid=4 jobid=1,11,12
857 4 0 0 0 A A A A A A A A A A A A A A .
858 5 0 0 0 A A A A A A A A A A A A A A ..
859 1 0 0 0 A A A A A A A A A A A A A A regress/
862 In this example, to list files present in \texttt{regress/}, you can use
864 .bvfs_lsfiles pathid=1 jobid=1,11,12
865 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
866 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
867 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
868 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
869 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
872 \subsubsection*{Restore set of files}
874 Bvfs allows you to create a SQL table that contains files that you want to
875 restore. This table can be provided to a restore command with the file option.
878 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
880 restore file=?b2num ...
883 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
884 select all files. This query could be time consuming.
886 \texttt{hardlink} list is always composed of a series of two numbers (jobid,
887 fileindex). This information can be found in the LinkFI field of the LStat
890 The \texttt{path} argument represents the name of the table that Bvfs will
891 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
892 b2 and followed by digits).
897 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
901 \subsubsection*{Cleanup after Restore}
903 To drop the table used by the restore command, you can use the
904 \texttt{.bvfs\_cleanup} command.
907 .bvfs_cleanup path=b20001
910 \subsubsection*{Clearing the BVFS Cache}
912 To clear the BVFS cache, you can use the \texttt{.bvfs\_clear\_cache} command.
915 .bvfs_clear_cache yes
919 \subsection{Changes in the Pruning Algorithm}
921 We rewrote the job pruning algorithm in this version. Previously, in some users
922 reported that the pruning process at the end of jobs was very long. It should
923 not be longer the case. Now, Bacula won't prune automatically a Job if this
924 particular Job is needed to restore data. Example:
928 JobId: 2 Level: Incremental
929 JobId: 3 Level: Incremental
930 JobId: 4 Level: Differential
931 .. Other incrementals up to now
934 In this example, if the Job Retention defined in the Pool or in the Client
935 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
936 detect that JobId 1 and 4 are essential to restore data at the current state
937 and will prune only JobId 2 and 3.
939 \texttt{Important}, this change affect only the automatic pruning step after a
940 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
941 \texttt{VolumeRetention} period, important jobs can be pruned.
943 \subsection{Ability to Verify any specified Job}
944 You now have the ability to tell Bacula which Job should verify instead of
945 automatically verify just the last one.
947 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
949 To verify a given job, just specify the Job jobid in argument when starting the
952 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
954 JobName: VerifyVolume
955 Level: VolumeToCatalog
958 Pool: Default (From Job resource)
959 Storage: File (From Job resource)
960 Verify Job: VerifyVol.2010-09-08_14.17.17_03
961 Verify List: /tmp/regress/working/VerifyVol.bsr
962 When: 2010-09-08 14:17:31
964 OK to run? (yes/mod/no):
968 This project was funded by Bacula Systems and is available with Bacula
969 Enterprise Edition and Community Edition.
971 \subsection{Additions to RunScript variables}
972 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
973 command. The Client address is now available through \%h.
976 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
979 %\subsection{Changes in drivetype.exe}
981 %Now the \texttt{drivetype.exe} program allows you to list all local hard
982 %drives. It can help to build dynamic FileSet on Windows.
985 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
989 \subsection{Additions to the Plugin API}
990 The bfuncs structure has been extended to include a number of
993 \subsubsection{bfuncs}
994 The bFuncs structure defines the callback entry points within Bacula
995 that the plugin can use register events, get Bacula values, set
996 Bacula values, and send messages to the Job output or debug output.
998 The exact definition as of this writing is:
1000 typedef struct s_baculaFuncs {
1003 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
1004 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
1005 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
1006 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
1007 int type, utime_t mtime, const char *fmt, ...);
1008 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
1009 int level, const char *fmt, ...);
1010 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
1012 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
1014 /* New functions follow */
1015 bRC (*AddExclude)(bpContext *ctx, const char *file);
1016 bRC (*AddInclude)(bpContext *ctx, const char *file);
1017 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
1018 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
1019 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
1020 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
1026 \item [AddExclude] can be called to exclude a file. The file
1027 string passed may include wildcards that will be interpreted by
1028 the {\bf fnmatch} subroutine. This function can be called
1029 multiple times, and each time the file specified will be added
1030 to the list of files to be excluded. Note, this function only
1031 permits adding excludes of specific file or directory names,
1032 or files matched by the rather simple fnmatch mechanism.
1033 See below for information on doing wild-card and regex excludes.
1035 \item [NewPreInclude] can be called to create a new Include block. This
1036 block will be added after the current defined Include block. This
1037 function can be called multiple times, but each time, it will create
1038 a new Include section (not normally needed). This function should
1039 be called only if you want to add an entirely new Include block.
1041 \item [NewInclude] can be called to create a new Include block. This
1042 block will be added before any user defined Include blocks. This
1043 function can be called multiple times, but each time, it will create
1044 a new Include section (not normally needed). This function should
1045 be called only if you want to add an entirely new Include block.
1047 \item [AddInclude] can be called to add new files/directories to
1048 be included. They are added to the current Include block. If
1049 NewInclude has not been included, the current Include block is
1050 the last one that the user created. This function
1051 should be used only if you want to add totally new files/directories
1052 to be included in the backup.
1054 \item [NewOptions] adds a new Options block to the current Include
1055 in front of any other Options blocks. This permits the plugin to
1056 add exclude directives (wild-cards and regexes) in front of the
1057 user Options, and thus prevent certain files from being backed up.
1058 This can be useful if the plugin backs up files, and they should
1059 not be also backed up by the main Bacula code. This function
1060 may be called multiple times, and each time, it creates a new
1061 prepended Options block. Note: normally you want to call this
1062 entry point prior to calling AddOptions, AddRegex, or AddWild.
1064 \item [AddOptions] allows the plugin it set options in
1065 the current Options block, which is normally created with the
1066 NewOptions call just prior to adding Include Options.
1067 The permitted options are passed as a character string, where
1068 each character has a specific meaning as defined below:
1071 \item [a] always replace files (default).
1072 \item [e] exclude rather than include.
1073 \item [h] no recursion into subdirectories.
1074 \item [H] do not handle hard links.
1075 \item [i] ignore case in wildcard and regex matches.
1076 \item [M] compute an MD5 sum.
1077 \item [p] use a portable data format on Windows (not recommended).
1078 \item [R] backup resource forks and Findr Info.
1079 \item [r] read from a fifo
1080 \item [S1] compute an SHA1 sum.
1081 \item [S2] compute an SHA256 sum.
1082 \item [S3] comput an SHA512 sum.
1083 \item [s] handle sparse files.
1084 \item [m] use st\_mtime only for file differences.
1085 \item [k] restore the st\_atime after accessing a file.
1086 \item [A] enable ACL backup.
1087 \item [Vxxx:] specify verify options. Must terminate with :
1088 \item [Cxxx:] specify accurate options. Must terminate with :
1089 \item [Jxxx:] specify base job Options. Must terminate with :
1090 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
1092 \item [Zn] specify gzip compression level n.
1093 \item [K] do not use st\_atime in backup decision.
1094 \item [c] check if file changed during backup.
1095 \item [N] honor no dump flag.
1096 \item [X] enable backup of extended attributes.
1099 \item [AddRegex] adds a regex expression to the current Options block.
1100 The following options are permitted:
1102 \item [ ] (a blank) regex applies to whole path and filename.
1103 \item [F] regex applies only to the filename (directory or path stripped).
1104 \item [D] regex applies only to the directory (path) part of the name.
1107 \item [AddWild] adds a wildcard expression to the current Options block.
1108 The following options are permitted:
1110 \item [ ] (a blank) regex applies to whole path and filename.
1111 \item [F] regex applies only to the filename (directory or path stripped).
1112 \item [D] regex applies only to the directory (path) part of the name.
1115 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
1116 that can use Accurate code to compare the file information in argument with
1117 the previous file information. The \texttt{delta\_seq} attribute of the
1118 \texttt{save\_pkt} will be updated, and the call will return
1119 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
1124 \subsubsection{Bacula events}
1125 The list of events has been extended to include:
1131 bEventStartBackupJob = 3,
1132 bEventEndBackupJob = 4,
1133 bEventStartRestoreJob = 5,
1134 bEventEndRestoreJob = 6,
1135 bEventStartVerifyJob = 7,
1136 bEventEndVerifyJob = 8,
1137 bEventBackupCommand = 9,
1138 bEventRestoreCommand = 10,
1143 bEventCancelCommand = 13,
1144 bEventVssBackupAddComponents = 14,
1145 bEventVssRestoreLoadComponentMetadata = 15,
1146 bEventVssRestoreSetComponentsSelected = 16,
1147 bEventRestoreObject = 17,
1148 bEventEndFileSet = 18,
1149 bEventPluginCommand = 19,
1150 bEventVssBeforeCloseRestore = 20,
1151 bEventVssPrepareSnapshot = 21
1157 \item [bEventCancelCommand] is called whenever the currently
1158 running Job is canceled */
1160 \item [bEventVssBackupAddComponents]
1162 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
1163 provides a char[27] table where the plugin can add Windows drives that will
1164 be used during the Job. You need to add them without duplicates, and you can
1165 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
1169 \subsection{ACL enhancements}
1171 The following enhancements are made to the Bacula Filed with regards to
1172 Access Control Lists (ACLs)
1175 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
1176 POSIX and NFSv4 ACLs.
1177 \item Added support for new acl types on FreeBSD 8.1 and later which supports
1178 POSIX and NFSv4 ACLs.
1179 \item Some generic cleanups for internal ACL handling.
1180 \item Fix for acl storage on OSX
1181 \item Cleanup of configure checks for ACL detection, now configure only
1182 tests for a certain interface type based on the operating system
1183 this should give less false positives on detection. Also when ACLs
1184 are detected no other acl checks are performed anymore.
1188 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
1189 and is available with Bacula Enterprise Edition and Community Edition.
1191 \subsection{XATTR enhancements}
1193 The following enhancements are made to the Bacula Filed with regards to
1194 Extended Attributes (XATTRs)
1197 \item Added support for IRIX extended attributes using the attr\_get interface.
1198 \item Added support for Tru64 (OSF1) extended attributes using the
1199 getproplist interface.
1200 \item Added support for AIX extended attributes available in AIX 6.x
1201 and higher using the listea/getea/setea interface.
1202 \item Added some debugging to generic xattr code so it easier to
1204 \item Cleanup of configure checks for XATTR detection, now configure only
1205 tests for a certain interface type based on the operating system
1206 this should give less false positives on detection. Also when xattrs
1207 are detected no other xattr checks are performed anymore.
1211 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
1212 and is available with Bacula Enterprise Edition and Community Edition.
1214 \subsection{Class Based Database Backend Drivers}
1216 The main Bacula Director code is independent of the SQL backend
1217 in version 5.2.0 and greater. This means that the Bacula Director can be
1218 packaged by itself, then each of the different SQL backends supported can
1219 be packaged separately. It is possible to build all the DB backends at the
1220 same time by including multiple database options at the same time.
1222 ./configure can be run with multiple database configure options.
1229 Order of testing for databases is:
1236 Each configured backend generates a file named:
1237 \verb+libbaccats-<sql_backend_name>-<version>.so+
1238 A dummy catalog library is created named libbaccats-version.so
1240 At configure time the first detected backend is used as the so called
1241 default backend and at install time the dummy
1242 \verb+libbaccats-<version>.so+ is replaced with the default backend type.
1244 If you configure all three backends you get three backend libraries and the
1245 postgresql gets installed as the default.
1247 When you want to switch to another database, first save any old catalog you
1248 may have then you can copy one of the three backend libraries over the
1249 \verb+libbaccats-<version>.so+ e.g.
1251 An actual command, depending on your Bacula version might be:
1253 cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
1256 where the \verb+5.2.2+ must be replaced by the Bacula release
1259 Then you must update the default backend in the following files:
1262 create_bacula_database
1263 drop_bacula_database
1265 grant_bacula_privileges
1268 update_bacula_tables
1271 And re-run all the above scripts. Please note, this means
1272 you will have a new empty database and if you had a previous
1273 one it will be lost.
1275 All current database backend drivers for catalog information are rewritten
1276 to use a set of multi inherited C++ classes which abstract the specific
1277 database specific internals and make sure we have a more stable generic
1278 interface with the rest of SQL code. From now on there is a strict
1279 boundary between the SQL code and the low-level database functions. This
1280 new interface should also make it easier to add a new backend for a
1281 currently unsupported database. As part of the rewrite the SQLite 2 code
1282 was removed (e.g. only SQLite 3 is now supported). An extra bonus of the
1283 new code is that you can configure multiple backends in the configure and
1284 build all backends in one compile session and select the correct database
1285 backend at install time. This should make it a lot easier for packages
1291 We also added cursor support for PostgreSQL backend, this improves memory
1292 usage for large installation.
1295 This project was implemented by Planets Communications B.V. and ELM
1296 Consultancy B.V. and Bacula Systems and is available with both the Bacula
1297 Enterprise Edition and the Community Edition.
1299 \subsection{Hash List Enhancements}
1301 The htable hash table class has been extended with extra hash functions for
1302 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
1303 Also the hash table initialization routines have been enhanced with
1304 support for passing a hint as to the number of initial pages to use
1305 for the size of the hash table. Until now the hash table always used
1306 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
1307 cache have been rewritten to use the new htable class with a small memory
1311 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
1312 and Bacula Systems and is available with Bacula Enterprise Edition and
1317 %%% =====================================================================
1322 \section{Release Version 5.0.3}
1324 There are no new features in version 5.0.2. This version simply fixes a
1325 number of bugs found in version 5.0.1 during the ongoing development
1328 \section{Release Version 5.0.2}
1330 There are no new features in version 5.0.2. This version simply fixes a
1331 number of bugs found in version 5.0.1 during the ongoing development
1337 \section{New Features in 5.0.1}
1339 This chapter presents the new features that are in the released Bacula version
1340 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
1341 the ongoing development process.
1343 \subsection{Truncate Volume after Purge}
1344 \label{sec:actiononpurge}
1346 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
1347 the volume when it is purged with the new command \texttt{purge volume
1348 action}. It is useful to prevent disk based volumes from consuming too much
1354 Action On Purge = Truncate
1359 As usual you can also set this property with the \texttt{update volume} command
1361 *update volume=xxx ActionOnPurge=Truncate
1362 *update volume=xxx actiononpurge=None
1365 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
1366 following command in interactive mode or in a RunScript as shown after:
1368 *purge volume action=truncate storage=File allpools
1369 # or by default, action=all
1370 *purge volume action storage=File pool=Default
1373 This is possible to specify the volume name, the media type, the pool, the
1374 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
1375 idle when you decide to run this command.
1379 Name = CatalogBackup
1384 Console = "purge volume action=all allpools storage=File"
1389 \textbf{Important note}: This feature doesn't work as
1390 expected in version 5.0.0. Please do not use it before version 5.0.1.
1392 \subsection{Allow Higher Duplicates}
1393 This directive did not work correctly and has been depreciated
1394 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
1395 file as it will be removed in a future release.
1397 \subsection{Cancel Lower Level Duplicates}
1398 This directive was added in Bacula version 5.0.1. It compares the
1399 level of a new backup job to old jobs of the same name, if any,
1400 and will kill the job which has a lower level than the other one.
1401 If the levels are the same (i.e. both are Full backups), then
1402 nothing is done and the other Cancel XXX Duplicate directives
1405 \section{New Features in 5.0.0}
1407 \subsection{Maximum Concurrent Jobs for Devices}
1408 \label{sec:maximumconcurrentjobdevice}
1410 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
1411 Daemon configuration permits setting the maximum number of Jobs that can
1412 run concurrently on a specified Device. Using this directive, it is
1413 possible to have different Jobs using multiple drives, because when the
1414 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
1415 Jobs on any other available compatible drive. This facilitates writing to
1416 multiple drives with multiple Jobs that all use the same Pool.
1418 This project was funded by Bacula Systems.
1420 \subsection{Restore from Multiple Storage Daemons}
1421 \index[general]{Restore}
1423 Previously, you were able to restore from multiple devices in a single Storage
1424 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
1425 example, if your full backup runs on a Storage Daemon with an autochanger, and
1426 your incremental jobs use another Storage Daemon with lots of disks, Bacula
1427 will switch automatically from one Storage Daemon to an other within the same
1430 You must upgrade your File Daemon to version 3.1.3 or greater to use this
1433 This project was funded by Bacula Systems with the help of Equiinet.
1435 \subsection{File Deduplication using Base Jobs}
1436 A base job is sort of like a Full save except that you will want the FileSet to
1437 contain only files that are unlikely to change in the future (i.e. a snapshot
1438 of most of your system after installing it). After the base job has been run,
1439 when you are doing a Full save, you specify one or more Base jobs to be used.
1440 All files that have been backed up in the Base job/jobs but not modified will
1441 then be excluded from the backup. During a restore, the Base jobs will be
1442 automatically pulled in where necessary.
1444 This is something none of the competition does, as far as we know (except
1445 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
1446 win for the user, it makes Bacula stand out as offering a unique optimization
1447 that immediately saves time and money. Basically, imagine that you have 100
1448 nearly identical Windows or Linux machine containing the OS and user files.
1449 Now for the OS part, a Base job will be backed up once, and rather than making
1450 100 copies of the OS, there will be only one. If one or more of the systems
1451 have some files updated, no problem, they will be automatically restored.
1453 See the \ilink{Base Job Chapter}{basejobs} for more information.
1455 This project was funded by Bacula Systems.
1457 \subsection{AllowCompression = \lt{}yes\vb{}no\gt{}}
1458 \index[dir]{AllowCompression}
1460 This new directive may be added to Storage resource within the Director's
1461 configuration to allow users to selectively disable the client compression for
1462 any job which writes to this storage resource.
1468 Address = ultrium-tape
1469 Password = storage_password # Password for Storage Daemon
1472 AllowCompression = No # Tape drive has hardware compression
1475 The above example would cause any jobs running with the UltriumTape storage
1476 resource to run without compression from the client file daemons. This
1477 effectively overrides any compression settings defined at the FileSet level.
1479 This feature is probably most useful if you have a tape drive which supports
1480 hardware compression. By setting the \texttt{AllowCompression = No} directive
1481 for your tape drive storage resource, you can avoid additional load on the file
1482 daemon and possibly speed up tape backups.
1484 This project was funded by Collaborative Fusion, Inc.
1486 \subsection{Accurate Fileset Options}
1487 \label{sec:accuratefileset}
1489 In previous versions, the accurate code used the file creation and modification
1490 times to determine if a file was modified or not. Now you can specify which
1491 attributes to use (time, size, checksum, permission, owner, group, \dots),
1492 similar to the Verify options.
1508 \item {\bf i} compare the inodes
1509 \item {\bf p} compare the permission bits
1510 \item {\bf n} compare the number of links
1511 \item {\bf u} compare the user id
1512 \item {\bf g} compare the group id
1513 \item {\bf s} compare the size
1514 \item {\bf a} compare the access time
1515 \item {\bf m} compare the modification time (st\_mtime)
1516 \item {\bf c} compare the change time (st\_ctime)
1517 \item {\bf d} report file size decreases
1518 \item {\bf 5} compare the MD5 signature
1519 \item {\bf 1} compare the SHA1 signature
1522 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
1523 the File Daemon will have to read all files even if they normally would not
1524 be saved. This increases the I/O load, but also the accuracy of the
1525 deduplication. By default, Bacula will check modification/creation time
1528 This project was funded by Bacula Systems.
1530 \subsection{Tab-completion for Bconsole}
1531 \label{sec:tabcompletion}
1533 If you build \texttt{bconsole} with readline support, you will be able to use
1534 the new auto-completion mode. This mode supports all commands, gives help
1535 inside command, and lists resources when required. It works also in the restore
1538 To use this feature, you should have readline development package loaded on
1539 your system, and use the following option in configure.
1541 ./configure --with-readline=/usr/include/readline --disable-conio ...
1544 The new bconsole won't be able to tab-complete with older directors.
1546 This project was funded by Bacula Systems.
1548 \subsection{Pool File and Job Retention}
1549 \label{sec:poolfilejobretention}
1551 We added two new Pool directives, \texttt{FileRetention} and
1552 \texttt{JobRetention}, that take precedence over Client directives of the same
1553 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
1554 example, you can decide to increase Retention times for Archive or OffSite Pool.
1556 It seems obvious to us, but apparently not to some users, that given the
1557 definition above that the Pool File and Job Retention periods is a global
1558 override for the normal Client based pruning, which means that when the
1559 Job is pruned, the pruning will apply globally to that particular Job.
1561 Currently, there is a bug in the implementation that causes any Pool
1562 retention periods specified to apply to {\bf all} Pools for that
1563 particular Client. Thus we suggest that you avoid using these two
1564 directives until this implementation problem is corrected.
1566 \subsection{Read-only File Daemon using capabilities}
1567 \label{sec:fdreadonly}
1568 This feature implements support of keeping \textbf{ReadAll} capabilities after
1569 UID/GID switch, this allows FD to keep root read but drop write permission.
1571 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
1572 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
1575 root@localhost:~# bacula-fd -k -u nobody -g nobody
1578 The code for this feature was contributed by our friends at AltLinux.
1580 \subsection{Bvfs API}
1583 To help developers of restore GUI interfaces, we have added new \textsl{dot
1584 commands} that permit browsing the catalog in a very simple way.
1587 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
1588 the Bvfs cache in the catalog. You need to run it before any access to the
1591 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
1592 will list all directories in the specified \texttt{path} or
1593 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
1594 encoding of path/filenames.
1596 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
1597 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
1598 \texttt{pathid} avoids problems with character encoding.
1601 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
1602 data that will be displayed.
1605 * .bvfs_update jobid=1,2
1607 * .bvfs_lsdir path=/ jobid=1,2
1610 This project was funded by Bacula Systems.
1612 \subsection{Testing your Tape Drive}
1613 \label{sec:btapespeed}
1615 To determine the best configuration of your tape drive, you can run the new
1616 \texttt{speed} command available in the \texttt{btape} program.
1618 This command can have the following arguments:
1620 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
1621 (between 1 and 5GB). This counter is in GB.
1622 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
1623 of data should be greater than your memory ($file\_size*nb\_file$).
1624 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
1626 \item[\texttt{skip\_random}] This flag permits to skip tests with random
1628 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
1629 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
1634 *speed file_size=3 skip_raw
1635 btape.c:1078 Test with zero data and bacula block structure.
1636 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1637 ++++++++++++++++++++++++++++++++++++++++++
1638 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1639 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
1641 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
1643 btape.c:1090 Test with random data, should give the minimum throughput.
1644 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1645 +++++++++++++++++++++++++++++++++++++++++++
1646 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1647 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
1648 +++++++++++++++++++++++++++++++++++++++++++
1650 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
1654 When using compression, the random test will give your the minimum throughput
1655 of your drive . The test using constant string will give you the maximum speed
1656 of your hardware chain. (CPU, memory, SCSI card, cable, drive, tape).
1658 You can change the block size in the Storage Daemon configuration file.
1660 \subsection{New {\bf Block Checksum} Device Directive}
1661 You may now turn off the Block Checksum (CRC32) code
1662 that Bacula uses when writing blocks to a Volume. This is
1669 doing so can reduce the Storage daemon CPU usage slightly. It
1670 will also permit Bacula to read a Volume that has corrupted data.
1672 The default is {\bf yes} -- i.e. the checksum is computed on write
1673 and checked on read.
1675 We do not recommend to turn this off particularly on older tape
1676 drives or for disk Volumes where doing so may allow corrupted data
1679 \subsection{New Bat Features}
1681 Those new features were funded by Bacula Systems.
1683 \subsubsection{Media List View}
1685 By clicking on ``Media'', you can see the list of all your volumes. You will be
1686 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1687 in the table. The old ``Media'' view is now known as ``Pool''.
1688 \begin{figure}[htbp]
1690 \includegraphics[width=0.8\linewidth]{bat-mediaview}
1691 \label{fig:mediaview}
1695 \subsubsection{Media Information View}
1697 By double-clicking on a volume (on the Media list, in the Autochanger content
1698 or in the Job information panel), you can access a detailed overview of your
1699 Volume. (cf figure \vref{fig:mediainfo}.)
1700 \begin{figure}[htbp]
1702 \includegraphics[width=0.8\linewidth]{bat11}
1703 \caption{Media information}
1704 \label{fig:mediainfo}
1707 \subsubsection{Job Information View}
1709 By double-clicking on a Job record (on the Job run list or in the Media
1710 information panel), you can access a detailed overview of your Job. (cf
1711 figure \vref{fig:jobinfo}.)
1712 \begin{figure}[htbp]
1714 \includegraphics[width=0.8\linewidth]{bat12}
1715 \caption{Job information}
1719 \subsubsection{Autochanger Content View}
1721 By double-clicking on a Storage record (on the Storage list panel), you can
1722 access a detailed overview of your Autochanger. (cf figure \vref{fig:jobinfo}.)
1723 \begin{figure}[htbp]
1725 \includegraphics[width=0.8\linewidth]{bat13}
1726 \caption{Autochanger content}
1727 \label{fig:achcontent}
1730 To use this feature, you need to use the latest mtx-changer script
1731 version. (With new \texttt{listall} and \texttt{transfer} commands)
1733 \subsection{Bat on Windows}
1734 We have ported {\bf bat} to Windows and it is now installed
1735 by default when the installer is run. It works quite well
1736 on Win32, but has not had a lot of testing there, so your
1737 feedback would be welcome. Unfortunately, even though it is
1738 installed by default, it does not yet work on 64 bit Windows
1741 \subsection{New Win32 Installer}
1742 The Win32 installer has been modified in several very important
1745 \item You must deinstall any current version of the
1746 Win32 File daemon before upgrading to the new one.
1747 If you forget to do so, the new installation will fail.
1748 To correct this failure, you must manually shutdown
1749 and deinstall the old File daemon.
1750 \item All files (other than menu links) are installed
1751 in {\bf c:/Program Files/Bacula}.
1752 \item The installer no longer sets this
1753 file to require administrator privileges by default. If you want
1754 to do so, please do it manually using the {\bf cacls} program.
1757 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1759 \item The server daemons (Director and Storage daemon) are
1760 no longer included in the Windows installer. If you want the
1761 Windows servers, you will either need to build them yourself (note
1762 they have not been ported to 64 bits), or you can contact
1763 Bacula Systems about this.
1766 \subsection{Win64 Installer}
1767 We have corrected a number of problems that required manual
1768 editing of the conf files. In most cases, it should now
1769 install and work. {\bf bat} is by default installed in
1770 {\bf c:/Program Files/Bacula/bin32} rather than
1771 {\bf c:/Program Files/Bacula} as is the case with the 32
1772 bit Windows installer.
1774 \subsection{Linux Bare Metal Recovery USB Key}
1775 We have made a number of significant improvements in the
1776 Bare Metal Recovery USB key. Please see the README files
1777 it the {\bf rescue} release for more details.
1779 We are working on an equivalent USB key for Windows bare
1780 metal recovery, but it will take some time to develop it (best
1781 estimate 3Q2010 or 4Q2010)
1784 \subsection{bconsole Timeout Option}
1785 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1786 for commands. This is useful with GUI programs that use {\bf bconsole}
1787 to interface to the Director.
1789 \subsection{Important Changes}
1790 \label{sec:importantchanges}
1793 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1794 to the same Pool. The Storage daemon ensures that you do not read and
1795 write to the same Volume.
1796 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1798 \item Virtually all the features of {\bf mtx-changer} have
1799 now been parametrized, which allows you to configure
1800 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1801 that contains variables that you can set to configure mtx-changer.
1802 This configuration file will not be overwritten during upgrades.
1803 We encourage you to submit any changes
1804 that are made to mtx-changer and to parametrize it all in
1805 mtx-changer.conf so that all configuration will be done by
1806 changing only mtx-changer.conf.
1807 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1808 and \texttt{transfer}. Please configure them as appropriate
1809 in mtx-changer.conf.
1810 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1811 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1812 password. If you want to use the new script, you will need to
1813 manually change the \texttt{BackupCatalog} Job definition.
1814 \item The \texttt{bconsole} \texttt{help} command now accepts
1815 an argument, which if provided produces information on that
1816 command (ex: \texttt{help run}).
1820 \subsubsection*{Truncate volume after purge}
1822 Note that the Truncate Volume after purge feature doesn't work as expected
1823 in 5.0.0 version. Please, don't use it before version 5.0.1.
1825 \subsubsection{Custom Catalog queries}
1827 If you wish to add specialized commands that list the contents of the catalog,
1828 you can do so by adding them to the \texttt{query.sql} file. This
1829 \texttt{query.sql} file is now empty by default. The file
1830 \texttt{examples/sample-query.sql} has an a number of sample commands
1831 you might find useful.
1833 \subsubsection{Deprecated parts}
1835 The following items have been \textbf{deprecated} for a long time, and are now
1836 removed from the code.
1839 \item Support for SQLite 2
1842 \subsection{Misc Changes}
1843 \label{sec:miscchanges}
1846 \item Updated Nagios check\_bacula
1847 \item Updated man files
1848 \item Added OSX package generation script in platforms/darwin
1849 \item Added Spanish and Ukrainian Bacula translations
1850 \item Enable/disable command shows only Jobs that can change
1851 \item Added \texttt{show disabled} command to show disabled Jobs
1852 \item Many ACL improvements
1853 \item Added Level to FD status Job output
1854 \item Begin Ingres DB driver (not yet working)
1855 \item Split RedHat spec files into bacula, bat, mtx, and docs
1856 \item Reorganized the manuals (fewer separate manuals)
1857 \item Added lock/unlock order protection in lock manager
1858 \item Allow 64 bit sizes for a number of variables
1859 \item Fixed several deadlocks or potential race conditions in the SD
1862 \chapter{Released Version 3.0.3 and 3.0.3a}
1864 There are no new features in version 3.0.3. This version simply fixes a
1865 number of bugs found in version 3.0.2 during the ongoing development
1868 \section{New Features in Released Version 3.0.2}
1870 This chapter presents the new features added to the
1871 Released Bacula Version 3.0.2.
1873 \subsection{Full Restore from a Given JobId}
1874 \index[general]{Restore menu}
1876 This feature allows selecting a single JobId and having Bacula
1877 automatically select all the other jobs that comprise a full backup up to
1878 and including the selected date (through JobId).
1880 Assume we start with the following jobs:
1882 +-------+--------------+---------------------+-------+----------+------------+
1883 | jobid | client | starttime | level | jobfiles | jobbytes |
1884 +-------+--------------+---------------------+-------+----------+------------
1885 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1886 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1887 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1888 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1889 +-------+--------------+---------------------+-------+----------+------------+
1892 Below is an example of this new feature (which is number 12 in the
1897 To select the JobIds, you have the following choices:
1898 1: List last 20 Jobs run
1899 2: List Jobs where a given File is saved
1901 12: Select full restore to a specified Job date
1904 Select item: (1-13): 12
1905 Enter JobId to get the state to restore: 5
1906 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1907 You have selected the following JobIds: 1,3,5
1909 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1910 1,444 files inserted into the tree.
1913 This project was funded by Bacula Systems.
1915 \subsection{Source Address}
1916 \index[general]{Source Address}
1918 A feature has been added which allows the administrator to specify the address
1919 from which the Director and File daemons will establish connections. This
1920 may be used to simplify system configuration overhead when working in complex
1921 networks utilizing multi-homing and policy-routing.
1923 To accomplish this, two new configuration directives have been implemented:
1926 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1930 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1934 Simply adding specific host routes on the OS
1935 would have an undesirable side-effect: any
1936 application trying to contact the destination host would be forced to use the
1937 more specific route possibly diverting management traffic onto a backup VLAN.
1938 Instead of adding host routes for each client connected to a multi-homed backup
1939 server (for example where there are management and backup VLANs), one can
1940 use the new directives to specify a specific source address at the application
1943 Additionally, this allows the simplification and abstraction of firewall rules
1944 when dealing with a Hot-Standby director or storage daemon configuration. The
1945 Hot-standby pair may share a CARP address, which connections must be sourced
1946 from, while system services listen and act from the unique interface addresses.
1948 This project was funded by Collaborative Fusion, Inc.
1950 \subsection{Show volume availability when doing restore}
1952 When doing a restore the selection dialog ends by displaying this
1956 The job will require the following
1957 Volume(s) Storage(s) SD Device(s)
1958 ===========================================================================
1959 *000741L3 LTO-4 LTO3
1960 *000866L3 LTO-4 LTO3
1961 *000765L3 LTO-4 LTO3
1962 *000764L3 LTO-4 LTO3
1963 *000756L3 LTO-4 LTO3
1964 *001759L3 LTO-4 LTO3
1965 *001763L3 LTO-4 LTO3
1969 Volumes marked with ``*'' are online (in the autochanger).
1972 This should help speed up large restores by minimizing the time spent
1973 waiting for the operator to discover that he must change tapes in the library.
1975 This project was funded by Bacula Systems.
1977 \subsection{Accurate estimate command}
1979 The \texttt{estimate} command can now use the accurate code to detect changes
1980 and give a better estimation.
1982 You can set the accurate behavior on the command line by using
1983 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1986 * estimate listing accurate=yes level=incremental job=BackupJob
1989 This project was funded by Bacula Systems.
1991 \section{New Features in 3.0.0}
1992 \label{NewFeaturesChapter}
1993 \index[general]{New Features}
1995 This chapter presents the new features added to the development 2.5.x
1996 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1998 \subsection{Accurate Backup}
1999 \index[general]{Accurate Backup}
2001 As with most other backup programs, by default Bacula decides what files to
2002 backup for Incremental and Differential backup by comparing the change
2003 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
2004 backup completed. If one of those two times is later than the last backup
2005 time, then the file will be backed up. This does not, however, permit tracking
2006 what files have been deleted and will miss any file with an old time that may
2007 have been restored to or moved onto the client filesystem.
2009 \subsubsection{Accurate = \lt{}yes\vb{}no\gt{}}
2010 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
2011 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
2012 backup, there is no difference, but for {\bf Differential} and {\bf
2013 Incremental} backups, the Director will send a list of all previous files
2014 backed up, and the File daemon will use that list to determine if any new files
2015 have been added or or moved and if any files have been deleted. This allows
2016 Bacula to make an accurate backup of your system to that point in time so that
2017 if you do a restore, it will restore your system exactly.
2020 about using Accurate backup is that it requires more resources (CPU and memory)
2021 on both the Director and the Client machines to create the list of previous
2022 files backed up, to send that list to the File daemon, for the File daemon to
2023 keep the list (possibly very big) in memory, and for the File daemon to do
2024 comparisons between every file in the FileSet and the list. In particular,
2025 if your client has lots of files (more than a few million), you will need
2026 lots of memory on the client machine.
2028 Accurate must not be enabled when backing up with a plugin that is not
2029 specially designed to work with Accurate. If you enable it, your restores
2030 will probably not work correctly.
2032 This project was funded by Bacula Systems.
2036 \subsection{Copy Jobs}
2037 \index[general]{Copy Jobs}
2039 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
2040 existing Migration feature with the exception that the Job that is copied is
2041 left unchanged. This essentially creates two identical copies of the same
2042 backup. However, the copy is treated as a copy rather than a backup job, and
2043 hence is not directly available for restore. The {\bf restore} command lists
2044 copy jobs and allows selection of copies by using \texttt{jobid=}
2045 option. If the keyword {\bf copies} is present on the command line, Bacula will
2046 display the list of all copies for selected jobs.
2051 These JobIds have copies as follows:
2052 +-------+------------------------------------+-----------+------------------+
2053 | JobId | Job | CopyJobId | MediaType |
2054 +-------+------------------------------------+-----------+------------------+
2055 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
2056 +-------+------------------------------------+-----------+------------------+
2057 +-------+-------+----------+----------+---------------------+------------------+
2058 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
2059 +-------+-------+----------+----------+---------------------+------------------+
2060 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
2061 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
2062 +-------+-------+----------+----------+---------------------+------------------+
2063 You have selected the following JobIds: 19,2
2065 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
2066 5,611 files inserted into the tree.
2071 The Copy Job runs without using the File daemon by copying the data from the
2072 old backup Volume to a different Volume in a different Pool. See the Migration
2073 documentation for additional details. For copy Jobs there is a new selection
2074 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
2075 not already copied to another Pool.
2077 As with Migration, the Client, Volume, Job, or SQL query, are
2078 other possible ways of selecting the Jobs to be copied. Selection
2079 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
2080 work, but are probably more suited for Migration Jobs.
2082 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
2083 it will promote the Copy to a \textsl{real} backup job and will make it available for
2084 automatic restore. If more than one Copy is available, it will promote the copy
2085 with the smallest JobId.
2087 A nice solution which can be built with the new Copy feature is often
2088 called disk-to-disk-to-tape backup (DTDTT). A sample config could
2089 look something like the one below:
2093 Name = FullBackupsVirtualPool
2095 Purge Oldest Volume = Yes
2097 NextPool = FullBackupsTapePool
2101 Name = FullBackupsTapePool
2105 Volume Retention = 365 days
2106 Storage = superloader
2110 # Fake fileset for copy jobs
2122 # Fake client for copy jobs
2132 # Default template for a CopyDiskToTape Job
2135 Name = CopyDiskToTape
2137 Messages = StandardCopy
2140 Selection Type = PoolUncopiedJobs
2141 Maximum Concurrent Jobs = 10
2143 Allow Duplicate Jobs = Yes
2144 Cancel Queued Duplicates = No
2145 Cancel Running Duplicates = No
2150 Name = DaySchedule7:00
2151 Run = Level=Full daily at 7:00
2155 Name = CopyDiskToTapeFullBackups
2157 Schedule = DaySchedule7:00
2158 Pool = FullBackupsVirtualPool
2159 JobDefs = CopyDiskToTape
2163 The example above had 2 pool which are copied using the PoolUncopiedJobs
2164 selection criteria. Normal Full backups go to the Virtual pool and are copied
2165 to the Tape pool the next morning.
2167 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
2172 +-------+------------------------------------+-----------+------------------+
2173 | JobId | Job | CopyJobId | MediaType |
2174 +-------+------------------------------------+-----------+------------------+
2175 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
2176 +-------+------------------------------------+-----------+------------------+
2179 \subsection{ACL Updates}
2180 \index[general]{ACL Updates}
2181 The whole ACL code had been overhauled and in this version each platforms has
2182 different streams for each type of acl available on such an platform. As ACLs
2183 between platforms tend to be not that portable (most implement POSIX acls but
2184 some use an other draft or a completely different format) we currently only
2185 allow certain platform specific ACL streams to be decoded and restored on the
2186 same platform that they were created on. The old code allowed to restore ACL
2187 cross platform but the comments already mention that not being to wise. For
2188 backward compatibility the new code will accept the two old ACL streams and
2189 handle those with the platform specific handler. But for all new backups it
2190 will save the ACLs using the new streams.
2192 Currently the following platforms support ACLs:
2196 \item {\bf Darwin/OSX}
2205 Currently we support the following ACL types (these ACL streams use a reserved
2206 part of the stream numbers):
2209 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
2211 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
2212 string representation from acl\_to\_text (POSIX acl)
2213 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
2214 string representation from acl\_to\_text (POSIX acl) for default acls.
2215 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
2216 string representation from acl\_to\_text (POSIX acl) for access acls.
2217 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
2218 string representation from acltostr (POSIX acl)
2219 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
2220 representation from acl\_to\_text (POSIX acl) for default acls.
2221 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
2222 representation from acl\_to\_text (POSIX acl) for access acls.
2223 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
2224 string representation from acl\_to\_text (POSIX acl) for default acls.
2225 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
2226 representation from acl\_to\_text (POSIX acl) for access acls.
2227 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
2228 string representation from acl\_to\_text (POSIX acl) for default acls.
2229 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
2230 string representation from acl\_to\_text (POSIX acl) for default acls.
2231 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
2232 representation from acl\_to\_text (POSIX acl) for access acls.
2233 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
2234 string representation from acltotext or acl\_totext (POSIX acl)
2235 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
2236 representation from from acl\_totext (NFSv4 or ZFS acl)
2239 In future versions we might support conversion functions from one type of acl
2240 into an other for types that are either the same or easily convertible. For now
2241 the streams are separate and restoring them on a platform that doesn't
2242 recognize them will give you a warning.
2244 \subsection{Extended Attributes}
2245 \index[general]{Extended Attributes}
2246 Something that was on the project list for some time is now implemented for
2247 platforms that support a similar kind of interface. Its the support for backup
2248 and restore of so called extended attributes. As extended attributes are so
2249 platform specific these attributes are saved in separate streams for each
2250 platform. Restores of the extended attributes can only be performed on the
2251 same platform the backup was done. There is support for all types of extended
2252 attributes, but restoring from one type of filesystem onto an other type of
2253 filesystem on the same platform may lead to surprises. As extended attributes
2254 can contain any type of data they are stored as a series of so called
2255 value-pairs. This data must be seen as mostly binary and is stored as such.
2256 As security labels from selinux are also extended attributes this option also
2257 stores those labels and no specific code is enabled for handling selinux
2260 Currently the following platforms support extended attributes:
2262 \item {\bf Darwin/OSX}
2268 On Linux acls are also extended attributes, as such when you enable ACLs on a
2269 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
2270 and not the same extended attribute.
2272 To enable the backup of extended attributes please add the following to your
2287 \subsection{Shared objects}
2288 \index[general]{Shared objects}
2289 A default build of Bacula will now create the libraries as shared objects
2290 (.so) rather than static libraries as was previously the case.
2291 The shared libraries are built using {\bf libtool} so it should be quite
2294 An important advantage of using shared objects is that on a machine with the
2295 Directory, File daemon, the Storage daemon, and a console, you will have only
2296 one copy of the code in memory rather than four copies. Also the total size of
2297 the binary release is smaller since the library code appears only once rather
2298 than once for every program that uses it; this results in significant reduction
2299 in the size of the binaries particularly for the utility tools.
2301 In order for the system loader to find the shared objects when loading the
2302 Bacula binaries, the Bacula shared objects must either be in a shared object
2303 directory known to the loader (typically /usr/lib) or they must be in the
2304 directory that may be specified on the {\bf ./configure} line using the {\bf
2305 {-}{-}libdir} option as:
2308 ./configure --libdir=/full-path/dir
2311 the default is /usr/lib. If {-}{-}libdir is specified, there should be
2312 no need to modify your loader configuration provided that
2313 the shared objects are installed in that directory (Bacula
2314 does this with the make install command). The shared objects
2315 that Bacula references are:
2324 These files are symbolically linked to the real shared object file,
2325 which has a version number to permit running multiple versions of
2326 the libraries if desired (not normally the case).
2328 If you have problems with libtool or you wish to use the old
2329 way of building static libraries, or you want to build a static
2330 version of Bacula you may disable
2331 libtool on the configure command line with:
2334 ./configure --disable-libtool
2338 \subsection{Building Static versions of Bacula}
2339 \index[general]{Static linking}
2340 In order to build static versions of Bacula, in addition
2341 to configuration options that were needed you now must
2342 also add --disable-libtool. Example
2345 ./configure --enable-static-client-only --disable-libtool
2349 \subsection{Virtual Backup (Vbackup)}
2350 \index[general]{Virtual Backup}
2351 \index[general]{Vbackup}
2353 Bacula's virtual backup feature is often called Synthetic Backup or
2354 Consolidation in other backup products. It permits you to consolidate the
2355 previous Full backup plus the most recent Differential backup and any
2356 subsequent Incremental backups into a new Full backup. This new Full
2357 backup will then be considered as the most recent Full for any future
2358 Incremental or Differential backups. The VirtualFull backup is
2359 accomplished without contacting the client by reading the previous backup
2360 data and writing it to a volume in a different pool.
2362 In some respects the Vbackup feature works similar to a Migration job, in
2363 that Bacula normally reads the data from the pool specified in the
2364 Job resource, and writes it to the {\bf Next Pool} specified in the
2365 Job resource. Note, this means that usually the output from the Virtual
2366 Backup is written into a different pool from where your prior backups
2367 are saved. Doing it this way guarantees that you will not get a deadlock
2368 situation attempting to read and write to the same volume in the Storage
2369 daemon. If you then want to do subsequent backups, you may need to
2370 move the Virtual Full Volume back to your normal backup pool.
2371 Alternatively, you can set your {\bf Next Pool} to point to the current
2372 pool. This will cause Bacula to read and write to Volumes in the
2373 current pool. In general, this will work, because Bacula will
2374 not allow reading and writing on the same Volume. In any case, once
2375 a VirtualFull has been created, and a restore is done involving the
2376 most current Full, it will read the Volume or Volumes by the VirtualFull
2377 regardless of in which Pool the Volume is found.
2379 The Vbackup is enabled on a Job by Job in the Job resource by specifying
2380 a level of {\bf VirtualFull}.
2382 A typical Job resource definition might look like the following:
2389 FileSet = "Full Set"
2396 # Default pool definition
2400 Recycle = yes # Automatically recycle Volumes
2401 AutoPrune = yes # Prune expired volumes
2402 Volume Retention = 365d # one year
2410 Recycle = yes # Automatically recycle Volumes
2411 AutoPrune = yes # Prune expired volumes
2412 Volume Retention = 365d # one year
2413 Storage = DiskChanger
2416 # Definition of file storage device
2421 Device = FileStorage
2423 Maximum Concurrent Jobs = 5
2426 # Definition of DDS Virtual tape disk storage device
2429 Address = localhost # N.B. Use a fully qualified name here
2431 Device = DiskChanger
2432 Media Type = DiskChangerMedia
2433 Maximum Concurrent Jobs = 4
2438 Then in bconsole or via a Run schedule, you would run the job as:
2441 run job=MyBackup level=Full
2442 run job=MyBackup level=Incremental
2443 run job=MyBackup level=Differential
2444 run job=MyBackup level=Incremental
2445 run job=MyBackup level=Incremental
2448 So providing there were changes between each of those jobs, you would end up
2449 with a Full backup, a Differential, which includes the first Incremental
2450 backup, then two Incremental backups. All the above jobs would be written to
2451 the {\bf Default} pool.
2453 To consolidate those backups into a new Full backup, you would run the
2457 run job=MyBackup level=VirtualFull
2460 And it would produce a new Full backup without using the client, and the output
2461 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
2463 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
2466 Note, the Start and End time of the Virtual Full backup is set to the
2467 values for the last job included in the Virtual Full (in the above example,
2468 it is an Increment). This is so that if another incremental is done, which
2469 will be based on the Virtual Full, it will backup all files from the
2470 last Job included in the Virtual Full rather than from the time the Virtual
2471 Full was actually run.
2475 \subsection{Catalog Format}
2476 \index[general]{Catalog Format}
2477 Bacula 3.0 comes with some changes to the catalog format. The upgrade
2478 operation will convert the FileId field of the File table from 32 bits (max 4
2479 billion table entries) to 64 bits (very large number of items). The
2480 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
2481 your catalog during the conversion. Also you won't be able to run jobs during
2482 this conversion period. For example, a 3 million file catalog will take 2
2483 minutes to upgrade on a normal machine. Please don't forget to make a valid
2484 backup of your database before executing the upgrade script. See the
2485 ReleaseNotes for additional details.
2487 \subsection{64 bit Windows Client}
2488 \index[general]{Win64 Client}
2489 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
2490 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
2491 As a consequence, we are also releasing a 64 bit version of the Bacula
2492 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
2493 These binaries should only be installed on 64 bit Windows operating systems.
2494 What is important is not your hardware but whether or not you have
2495 a 64 bit version of the Windows OS.
2497 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
2499 \item Before installing the Win64 Bacula Client, you must totally
2500 deinstall any prior 2.4.x Client installation using the
2501 Bacula deinstallation (see the menu item). You may want
2502 to save your .conf files first.
2503 \item Only the Client (File daemon) is ported to Win64, the Director
2504 and the Storage daemon are not in the 64 bit Windows installer.
2505 \item bwx-console is not yet ported.
2506 \item bconsole is ported but it has not been tested.
2507 \item The documentation is not included in the installer.
2508 \item Due to Vista security restrictions imposed on a default installation
2509 of Vista, before upgrading the Client, you must manually stop
2510 any prior version of Bacula from running, otherwise the install
2512 \item Due to Vista security restrictions imposed on a default installation
2513 of Vista, attempting to edit the conf files via the menu items
2514 will fail. You must directly edit the files with appropriate
2515 permissions. Generally double clicking on the appropriate .conf
2516 file will work providing you have sufficient permissions.
2517 \item All Bacula files are now installed in
2518 {\bf C:/Program Files/Bacula} except the main menu items,
2519 which are installed as before. This vastly simplifies the installation.
2520 \item If you are running on a foreign language version of Windows, most
2521 likely {\bf C:/Program Files} does not exist, so you should use the
2522 Custom installation and enter an appropriate location to install
2524 \item The 3.0.0 Win32 Client continues to install files in the locations used
2525 by prior versions. For the next version we will convert it to use
2526 the same installation conventions as the Win64 version.
2529 This project was funded by Bacula Systems.
2532 \subsection{Duplicate Job Control}
2533 \index[general]{Duplicate Jobs}
2534 The new version of Bacula provides four new directives that
2535 give additional control over what Bacula does if duplicate jobs
2536 are started. A duplicate job in the sense we use it here means
2537 a second or subsequent job with the same name starts. This
2538 happens most frequently when the first job runs longer than expected because no
2539 tapes are available.
2541 The four directives each take as an argument a {\bf yes} or {\bf no} value and
2542 are specified in the Job resource.
2546 \subsubsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
2547 \index[general]{Allow Duplicate Jobs}
2548 If this directive is set to {\bf yes}, duplicate jobs will be run. If
2549 the directive is set to {\bf no} (default) then only one job of a given name
2550 may run at one time, and the action that Bacula takes to ensure only
2551 one job runs is determined by the other directives (see below).
2553 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
2554 are present and none of the three directives given below permit
2555 Canceling a job, then the current job (the second one started)
2558 \subsubsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
2559 \index[general]{Allow Higher Duplicates}
2560 This directive was in version 5.0.0, but does not work as
2561 expected. If used, it should always be set to no. In later versions
2562 of Bacula the directive is disabled (disregarded).
2564 \subsubsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
2565 \index[general]{Cancel Running Duplicates}
2566 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
2567 if this directive is set to {\bf yes} any job that is already running
2568 will be canceled. The default is {\bf no}.
2570 \subsubsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
2571 \index[general]{Cancel Queued Duplicates}
2572 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
2573 if this directive is set to {\bf yes} any job that is
2574 already queued to run but not yet running will be canceled.
2575 The default is {\bf no}.
2578 \subsection{TLS Authentication}
2579 \index[general]{TLS Authentication}
2580 In Bacula version 2.5.x and later, in addition to the normal Bacula
2581 CRAM-MD5 authentication that is used to authenticate each Bacula
2582 connection, you can specify that you want TLS Authentication as well,
2583 which will provide more secure authentication.
2585 This new feature uses Bacula's existing TLS code (normally used for
2586 communications encryption) to do authentication. To use it, you must
2587 specify all the TLS directives normally used to enable communications
2588 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
2591 \subsubsection{TLS Authenticate = yes}
2593 TLS Authenticate = yes
2596 in the main daemon configuration resource (Director for the Director,
2597 Client for the File daemon, and Storage for the Storage daemon).
2599 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
2600 authentication, Bacula will also do TLS authentication, then TLS
2601 encryption will be turned off, and the rest of the communication between
2602 the two Bacula daemons will be done without encryption.
2604 If you want to encrypt communications data, use the normal TLS directives
2605 but do not turn on {\bf TLS Authenticate}.
2607 \subsection{bextract non-portable Win32 data}
2608 \index[general]{bextract handles Win32 non-portable data}
2609 {\bf bextract} has been enhanced to be able to restore
2610 non-portable Win32 data to any OS. Previous versions were
2611 unable to restore non-portable Win32 data to machines that
2612 did not have the Win32 BackupRead and BackupWrite API calls.
2614 \subsection{State File updated at Job Termination}
2615 \index[general]{State File}
2616 In previous versions of Bacula, the state file, which provides a
2617 summary of previous jobs run in the {\bf status} command output was
2618 updated only when Bacula terminated, thus if the daemon crashed, the
2619 state file might not contain all the run data. This version of
2620 the Bacula daemons updates the state file on each job termination.
2622 \subsection{MaxFullInterval = \lt{}time-interval\gt{}}
2623 \index[general]{MaxFullInterval}
2624 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
2625 can be used to specify the maximum time interval between {\bf Full} backup
2626 jobs. When a job starts, if the time since the last Full backup is
2627 greater than the specified interval, and the job would normally be an
2628 {\bf Incremental} or {\bf Differential}, it will be automatically
2629 upgraded to a {\bf Full} backup.
2631 \subsection{MaxDiffInterval = \lt{}time-interval\gt{}}
2632 \index[general]{MaxDiffInterval}
2633 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
2634 can be used to specify the maximum time interval between {\bf Differential} backup
2635 jobs. When a job starts, if the time since the last Differential backup is
2636 greater than the specified interval, and the job would normally be an
2637 {\bf Incremental}, it will be automatically
2638 upgraded to a {\bf Differential} backup.
2640 \subsection{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
2641 \index[general]{MaxDiffInterval}
2642 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
2643 by the user, and when it is set it is an indication to backup programs
2644 to not backup that particular file. This version of Bacula contains a
2645 new Options directive within a FileSet resource, which instructs Bacula to
2646 obey this flag. The new directive is:
2649 Honor No Dump Flag = yes\vb{}no
2652 The default value is {\bf no}.
2655 \subsection{Exclude Dir Containing = \lt{}filename-string\gt{}}
2656 \index[general]{IgnoreDir}
2657 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
2658 can be added to the Include section of the FileSet resource. If the specified
2659 filename ({\bf filename-string}) is found on the Client in any directory to be
2660 backed up, the whole directory will be ignored (not backed up). For example:
2663 # List of files to be backed up
2671 Exclude Dir Containing = .excludeme
2676 But in /home, there may be hundreds of directories of users and some
2677 people want to indicate that they don't want to have certain
2678 directories backed up. For example, with the above FileSet, if
2679 the user or sysadmin creates a file named {\bf .excludeme} in
2680 specific directories, such as
2683 /home/user/www/cache/.excludeme
2684 /home/user/temp/.excludeme
2687 then Bacula will not backup the two directories named:
2690 /home/user/www/cache
2694 NOTE: subdirectories will not be backed up. That is, the directive
2695 applies to the two directories in question and any children (be they
2696 files, directories, etc).
2699 \subsection{Bacula Plugins}
2700 \index[general]{Plugin}
2701 Support for shared object plugins has been implemented in the Linux, Unix
2702 and Win32 File daemons. The API will be documented separately in
2703 the Developer's Guide or in a new document. For the moment, there is
2704 a single plugin named {\bf bpipe} that allows an external program to
2705 get control to backup and restore a file.
2707 Plugins are also planned (partially implemented) in the Director and the
2710 \subsubsection{Plugin Directory}
2711 \index[general]{Plugin Directory}
2712 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2713 be added to the daemon definition resource. The directory takes a quoted
2714 string argument, which is the name of the directory in which the daemon can
2715 find the Bacula plugins. If this directive is not specified, Bacula will not
2716 load any plugins. Since each plugin has a distinctive name, all the daemons
2717 can share the same plugin directory.
2719 \subsubsection{Plugin Options}
2720 \index[general]{Plugin Options}
2721 The {\bf Plugin Options} directive takes a quoted string
2722 argument (after the equal sign) and may be specified in the
2723 Job resource. The options specified will be passed to all plugins
2724 when they are run. This each plugin must know what it is looking
2725 for. The value defined in the Job resource can be modified
2726 by the user when he runs a Job via the {\bf bconsole} command line
2729 Note: this directive may be specified, and there is code to modify
2730 the string in the run command, but the plugin options are not yet passed to
2731 the plugin (i.e. not fully implemented).
2733 \subsubsection{Plugin Options ACL}
2734 \index[general]{Plugin Options ACL}
2735 The {\bf Plugin Options ACL} directive may be specified in the
2736 Director's Console resource. It functions as all the other ACL commands
2737 do by permitting users running restricted consoles to specify a
2738 {\bf Plugin Options} that overrides the one specified in the Job
2739 definition. Without this directive restricted consoles may not modify
2742 \subsubsection{Plugin = \lt{}plugin-command-string\gt{}}
2743 \index[general]{Plugin}
2744 The {\bf Plugin} directive is specified in the Include section of
2745 a FileSet resource where you put your {\bf File = xxx} directives.
2756 Plugin = "bpipe:..."
2761 In the above example, when the File daemon is processing the directives
2762 in the Include section, it will first backup all the files in {\bf /home}
2763 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2764 the Plugin Directory. The syntax and semantics of the Plugin directive
2765 require the first part of the string up to the colon (:) to be the name
2766 of the plugin. Everything after the first colon is ignored by the File daemon but
2767 is passed to the plugin. Thus the plugin writer may define the meaning of the
2768 rest of the string as he wishes.
2770 Please see the next section for information about the {\bf bpipe} Bacula
2773 \subsection{The bpipe Plugin}
2774 \index[general]{The bpipe Plugin}
2775 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2776 the Bacula source distribution. When the plugin is compiled and linking into
2777 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2778 Please note that this is a very simple plugin that was written for
2779 demonstration and test purposes. It is and can be used in production, but
2780 that was never really intended.
2782 The purpose of the plugin is to provide an interface to any system program for
2783 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2784 the Include section of your Job's FileSet resource. The full syntax of the
2785 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2786 to specify the sytax as it wishes) is:
2789 Plugin = "<field1>:<field2>:<field3>:<field4>"
2794 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2795 stripped off, so in this case, we would put {\bf bpipe} in this field.
2797 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2798 pseudo path and filename under which the backup will be saved. This pseudo
2799 path and filename will be seen by the user in the restore file tree.
2800 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2801 backed up by the plugin will be put under that "pseudo" path and filename.
2802 You must be careful to choose a naming convention that is unique to avoid
2803 a conflict with a path and filename that actually exists on your system.
2805 \item {\bf field3} for the {\bf bpipe} plugin
2806 specifies the "reader" program that is called by the plugin during
2807 backup to read the data. {\bf bpipe} will call this program by doing a
2810 \item {\bf field4} for the {\bf bpipe} plugin
2811 specifies the "writer" program that is called by the plugin during
2812 restore to write the data back to the filesystem.
2815 Please note that for two items above describing the "reader" and "writer"
2816 fields, these programs are "executed" by Bacula, which
2817 means there is no shell interpretation of any command line arguments
2818 you might use. If you want to use shell characters (redirection of input
2819 or output, ...), then we recommend that you put your command or commands
2820 in a shell script and execute the script. In addition if you backup a
2821 file with the reader program, when running the writer program during
2822 the restore, Bacula will not automatically create the path to the file.
2823 Either the path must exist, or you must explicitly do so with your command
2824 or in a shell script.
2826 Putting it all together, the full plugin directive line might look
2830 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2831 --opt --databases bacula:mysql"
2834 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2835 would be written on a single line.
2837 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2838 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2839 program {\bf mysqldump -f --opt --database bacula} to read the data during
2840 backup. The mysqldump command outputs all the data for the database named
2841 {\bf bacula}, which will be read by the plugin and stored in the backup.
2842 During restore, the data that was backed up will be sent to the program
2843 specified in the last field, which in this case is {\bf mysql}. When
2844 {\bf mysql} is called, it will read the data sent to it by the plugn
2845 then write it back to the same database from which it came ({\bf bacula}
2848 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2849 the data from a specified program to Bacula for backup, and then from Bacula to
2850 a specified program for restore.
2852 By using different command lines to {\bf bpipe},
2853 you can backup any kind of data (ASCII or binary) depending
2854 on the program called.
2856 \subsection{Microsoft Exchange Server 2003/2007 Plugin}
2857 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2858 \subsubsection{Background}
2859 The Exchange plugin was made possible by a funded development project
2860 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2861 The code for the plugin was written by James Harper, and the Bacula core
2862 code by Kern Sibbald. All the code for this funded development has become
2863 part of the Bacula project. Thanks to everyone who made it happen.
2865 \subsubsection{Concepts}
2866 Although it is possible to backup Exchange using Bacula VSS the Exchange
2867 plugin adds a good deal of functionality, because while Bacula VSS
2868 completes a full backup (snapshot) of Exchange, it does
2869 not support Incremental or Differential backups, restoring is more
2870 complicated, and a single database restore is not possible.
2872 Microsoft Exchange organises its storage into Storage Groups with
2873 Databases inside them. A default installation of Exchange will have a
2874 single Storage Group called 'First Storage Group', with two Databases
2875 inside it, "Mailbox Store (SERVER NAME)" and
2876 "Public Folder Store (SERVER NAME)",
2877 which hold user email and public folders respectively.
2879 In the default configuration, Exchange logs everything that happens to
2880 log files, such that if you have a backup, and all the log files since,
2881 you can restore to the present time. Each Storage Group has its own set
2882 of log files and operates independently of any other Storage Groups. At
2883 the Storage Group level, the logging can be turned off by enabling a
2884 function called "Enable circular logging". At this time the Exchange
2885 plugin will not function if this option is enabled.
2887 The plugin allows backing up of entire storage groups, and the restoring
2888 of entire storage groups or individual databases. Backing up and
2889 restoring at the individual mailbox or email item is not supported but
2890 can be simulated by use of the "Recovery" Storage Group (see below).
2892 \subsubsection{Installing}
2893 The Exchange plugin requires a DLL that is shipped with Microsoft
2894 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2895 correctly the Exchange plugin should find this automatically and run
2896 without any additional installation.
2898 If the DLL can not be found automatically it will need to be copied into
2899 the Bacula installation
2900 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2901 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2902 default Exchange installation.
2904 \subsubsection{Backing Up}
2905 To back up an Exchange server the Fileset definition must contain at
2906 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2907 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2908 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2909 up files are prefixed with something that isn't going to share a name
2910 with something outside the plugin, and the 'Microsoft Information Store'
2911 bit is required also. It is also possible to add the name of a storage
2912 group to the "Plugin =" line, eg \\
2913 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2914 if you want only a single storage group backed up.
2916 Additionally, you can suffix the 'Plugin =' directive with
2917 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2918 database at the end of a full backup.
2920 An Incremental or Differential backup will backup only the database logs
2921 for each Storage Group by inspecting the "modified date" on each
2922 physical log file. Because of the way the Exchange API works, the last
2923 logfile backed up on each backup will always be backed up by the next
2924 Incremental or Differential backup too. This adds 5MB to each
2925 Incremental or Differential backup size but otherwise does not cause any
2928 By default, a normal VSS fileset containing all the drive letters will
2929 also back up the Exchange databases using VSS. This will interfere with
2930 the plugin and Exchange's shared ideas of when the last full backup was
2931 done, and may also truncate log files incorrectly. It is important,
2932 therefore, that the Exchange database files be excluded from the backup,
2933 although the folders the files are in should be included, or they will
2934 have to be recreated manually if a bare metal restore is done.
2939 File = C:/Program Files/Exchsrvr/mdbdata
2940 Plugin = "exchange:..."
2943 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2944 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2945 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2946 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2947 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2948 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2949 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2954 The advantage of excluding the above files is that you can significantly
2955 reduce the size of your backup since all the important Exchange files
2956 will be properly saved by the Plugin.
2959 \subsubsection{Restoring}
2960 The restore operation is much the same as a normal Bacula restore, with
2961 the following provisos:
2964 \item The {\bf Where} restore option must not be specified
2965 \item Each Database directory must be marked as a whole. You cannot just
2966 select (say) the .edb file and not the others.
2967 \item If a Storage Group is restored, the directory of the Storage Group
2969 \item It is possible to restore only a subset of the available log files,
2970 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2971 if a log file is missing from the sequence of log files
2972 \item Each database to be restored must be dismounted and marked as "Can be
2973 overwritten by restore"
2974 \item If an entire Storage Group is to be restored (eg all databases and
2975 logs in the Storage Group), then it is best to manually delete the
2976 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2977 as Exchange can get confused by stray log files lying around.
2980 \subsubsection{Restoring to the Recovery Storage Group}
2981 The concept of the Recovery Storage Group is well documented by
2983 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2984 but to briefly summarize...
2986 Microsoft Exchange allows the creation of an additional Storage Group
2987 called the Recovery Storage Group, which is used to restore an older
2988 copy of a database (e.g. before a mailbox was deleted) into without
2989 messing with the current live data. This is required as the Standard and
2990 Small Business Server versions of Exchange can not ordinarily have more
2991 than one Storage Group.
2993 To create the Recovery Storage Group, drill down to the Server in Exchange
2994 System Manager, right click, and select
2995 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2996 locations and click OK. On the Recovery Storage Group, right click and
2997 select {\bf "Add Database to Recover..."} and select the database you will
3000 Restore only the single database nominated as the database in the
3001 Recovery Storage Group. Exchange will redirect the restore to the
3002 Recovery Storage Group automatically.
3003 Then run the restore.
3005 \subsubsection{Restoring on Microsoft Server 2007}
3006 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
3007 2007, and hence you use a new procedure for recovering a single mail box.
3008 This procedure is documented by Microsoft at:
3009 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
3010 and involves using the {\bf Restore-Mailbox} and {\bf
3011 Get-Mailbox Statistics} shell commands.
3013 \subsubsection{Caveats}
3014 This plugin is still being developed, so you should consider it
3015 currently in BETA test, and thus use in a production environment
3016 should be done only after very careful testing.
3018 When doing a full backup, the Exchange database logs are truncated by
3019 Exchange as soon as the plugin has completed the backup. If the data
3020 never makes it to the backup medium (eg because of spooling) then the
3021 logs will still be truncated, but they will also not have been backed
3022 up. A solution to this is being worked on. You will have to schedule a
3023 new Full backup to ensure that your next backups will be usable.
3025 The "Enable Circular Logging" option cannot be enabled or the plugin
3028 Exchange insists that a successful Full backup must have taken place if
3029 an Incremental or Differential backup is desired, and the plugin will
3030 fail if this is not the case. If a restore is done, Exchange will
3031 require that a Full backup be done before an Incremental or Differential
3034 The plugin will most likely not work well if another backup application
3035 (eg NTBACKUP) is backing up the Exchange database, especially if the
3036 other backup application is truncating the log files.
3038 The Exchange plugin has not been tested with the {\bf Accurate} option, so
3039 we recommend either carefully testing or that you avoid this option for
3042 The Exchange plugin is not called during processing the bconsole {\bf
3043 estimate} command, and so anything that would be backed up by the plugin
3044 will not be added to the estimate total that is displayed.
3047 \subsection{libdbi Framework}
3048 \index[general]{libdbi Framework}
3049 As a general guideline, Bacula has support for a few catalog database drivers
3050 (MySQL, PostgreSQL, SQLite)
3051 coded natively by the Bacula team. With the libdbi implementation, which is a
3052 Bacula driver that uses libdbi to access the catalog, we have an open field to
3053 use many different kinds database engines following the needs of users.
3055 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
3056 implements a database-independent abstraction layer in C, similar to the
3057 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
3058 leverage the power of multiple databases and multiple simultaneous database
3059 connections by using this framework.
3061 Currently the libdbi driver in Bacula project only supports the same drivers
3062 natively coded in Bacula. However the libdbi project has support for many
3063 others database engines. You can view the list at
3064 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
3065 supported by Bacula, however, they must be tested properly by the Bacula team.
3067 Some of benefits of using libdbi are:
3069 \item The possibility to use proprietary databases engines in which your
3070 proprietary licenses prevent the Bacula team from developing the driver.
3071 \item The possibility to use the drivers written for the libdbi project.
3072 \item The possibility to use other database engines without recompiling Bacula
3073 to use them. Just change one line in bacula-dir.conf
3074 \item Abstract Database access, this is, unique point to code and profiling
3075 catalog database access.
3078 The following drivers have been tested:
3080 \item PostgreSQL, with and without batch insert
3081 \item Mysql, with and without batch insert
3086 In the future, we will test and approve to use others databases engines
3087 (proprietary or not) like DB2, Oracle, Microsoft SQL.
3089 To compile Bacula to support libdbi we need to configure the code with the
3090 --with-dbi and --with-dbi-driver=[database] ./configure options, where
3091 [database] is the database engine to be used with Bacula (of course we can
3092 change the driver in file bacula-dir.conf, see below). We must configure the
3093 access port of the database engine with the option --with-db-port, because the
3094 libdbi framework doesn't know the default access port of each database.
3096 The next phase is checking (or configuring) the bacula-dir.conf, example:
3100 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
3101 dbname = regress; user = regress; password = ""
3105 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
3106 mysql database. Currently the drivers supported by Bacula are: postgresql,
3107 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
3109 The following limitations apply when Bacula is set to use the libdbi framework:
3110 - Not tested on the Win32 platform
3111 - A little performance is lost if comparing with native database driver.
3112 The reason is bound with the database driver provided by libdbi and the
3113 simple fact that one more layer of code was added.
3115 It is important to remember, when compiling Bacula with libdbi, the
3116 following packages are needed:
3118 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
3119 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
3122 You can download them and compile them on your system or install the packages
3123 from your OS distribution.
3125 \subsection{Console Command Additions and Enhancements}
3126 \index[general]{Console Additions}
3128 \subsubsection{Display Autochanger Content}
3129 \index[general]{StatusSlots}
3131 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
3132 autochanger content.
3136 Slot | Volume Name | Status | Media Type | Pool |
3137 ------+---------------+----------+-------------------+------------|
3138 1 | 00001 | Append | DiskChangerMedia | Default |
3139 2 | 00002 | Append | DiskChangerMedia | Default |
3140 3*| 00003 | Append | DiskChangerMedia | Scratch |
3145 If you an asterisk ({\bf *}) appears after the slot number, you must run an
3146 {\bf update slots} command to synchronize autochanger content with your
3149 \subsubsection{list joblog job=xxx or jobid=nnn}
3150 \index[general]{list joblog}
3151 A new list command has been added that allows you to list the contents
3152 of the Job Log stored in the catalog for either a Job Name (fully qualified)
3153 or for a particular JobId. The {\bf llist} command will include a line with
3154 the time and date of the entry.
3156 Note for the catalog to have Job Log entries, you must have a directive
3163 In your Director's {\bf Messages} resource.
3165 \subsubsection{Use separator for multiple commands}
3166 \index[general]{Command Separator}
3167 When using bconsole with readline, you can set the command separator with
3168 \textbf{@separator} command to one
3169 of those characters to write commands who require multiple input in one line.
3171 !$%&'()*+,-/:;<>?[]^`{|}~
3174 \subsubsection{Deleting Volumes}
3175 The delete volume bconsole command has been modified to
3176 require an asterisk (*) in front of a MediaId otherwise the
3177 value you enter is a taken to be a Volume name. This is so that
3178 users may delete numeric Volume names. The previous Bacula versions
3179 assumed that all input that started with a number was a MediaId.
3181 This new behavior is indicated in the prompt if you read it
3184 \subsection{Bare Metal Recovery}
3185 The old bare metal recovery project is essentially dead. One
3186 of the main features of it was that it would build a recovery
3187 CD based on the kernel on your system. The problem was that
3188 every distribution has a different boot procedure and different
3189 scripts, and worse yet, the boot procedures and scripts change
3190 from one distribution to another. This meant that maintaining
3191 (keeping up with the changes) the rescue CD was too much work.
3193 To replace it, a new bare metal recovery USB boot stick has been developed
3194 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
3195 boot from a USB key.
3199 \item Recovery can be done from within graphical environment.
3200 \item Recovery can be done in a shell.
3201 \item Ubuntu boots on a large number of Linux systems.
3202 \item The process of updating the system and adding new
3203 packages is not too difficult.
3204 \item The USB key can easily be upgraded to newer Ubuntu versions.
3205 \item The USB key has writable partitions for modifications to
3206 the OS and for modification to your home directory.
3207 \item You can add new files/directories to the USB key very easily.
3208 \item You can save the environment from multiple machines on
3210 \item Bacula Systems is funding its ongoing development.
3213 The disadvantages are:
3215 \item The USB key is usable but currently under development.
3216 \item Not everyone may be familiar with Ubuntu (no worse
3218 \item Some older OSes cannot be booted from USB. This can
3219 be resolved by first booting a Ubuntu LiveCD then plugging
3221 \item Currently the documentation is sketchy and not yet added
3222 to the main manual. See below ...
3225 The documentation and the code can be found in the {\bf rescue} package
3226 in the directory {\bf linux/usb}.
3228 \subsection{Miscellaneous}
3229 \index[general]{Misc New Features}
3231 \subsubsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
3232 \index[general]{Allow Mixed Priority}
3233 This directive is only implemented in version 2.5 and later. When
3234 set to {\bf yes} (default {\bf no}), this job may run even if lower
3235 priority jobs are already running. This means a high priority job
3236 will not have to wait for other jobs to finish before starting.
3237 The scheduler will only mix priorities when all running jobs have
3240 Note that only higher priority jobs will start early. Suppose the
3241 director will allow two concurrent jobs, and that two jobs with
3242 priority 10 are running, with two more in the queue. If a job with
3243 priority 5 is added to the queue, it will be run as soon as one of
3244 the running jobs finishes. However, new priority 10 jobs will not
3245 be run until the priority 5 job has finished.
3247 \subsubsection{Bootstrap File Directive -- FileRegex}
3248 \index[general]{Bootstrap File Directive}
3249 {\bf FileRegex} is a new command that can be added to the bootstrap
3250 (.bsr) file. The value is a regular expression. When specified, only
3251 matching filenames will be restored.
3253 During a restore, if all File records are pruned from the catalog
3254 for a Job, normally Bacula can restore only all files saved. That
3255 is there is no way using the catalog to select individual files.
3256 With this new feature, Bacula will ask if you want to specify a Regex
3257 expression for extracting only a part of the full backup.
3260 Building directory tree for JobId(s) 1,3 ...
3261 There were no files inserted into the tree, so file selection
3262 is not possible.Most likely your retention policy pruned the files
3264 Do you want to restore all the files? (yes\vb{}no): no
3266 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
3267 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
3270 \subsubsection{Bootstrap File Optimization Changes}
3271 In order to permit proper seeking on disk files, we have extended the bootstrap
3272 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
3273 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
3274 address range and end address range respectively. These two directives replace
3275 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
3276 VolEndBlock} directives. Bootstrap files containing the old directives will
3277 still work, but will not properly take advantage of proper disk seeking, and
3278 may read completely to the end of a disk volume during a restore. With the new
3279 format (automatically generated by the new Director), restores will seek
3280 properly and stop reading the volume when all the files have been restored.
3282 \subsubsection{Solaris ZFS/NFSv4 ACLs}
3283 This is an upgrade of the previous Solaris ACL backup code
3284 to the new library format, which will backup both the old
3285 POSIX(UFS) ACLs as well as the ZFS ACLs.
3287 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
3288 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
3289 be used to transfer from UFS to ZFS filesystems.
3292 \subsubsection{Virtual Tape Emulation}
3293 \index[general]{Virtual Tape Emulation}
3294 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
3295 the tape code but actually reading and writing to a disk file. Used with the
3296 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
3297 and 700 slots. This feature is most useful in testing. It is enabled
3298 by using {\bf Device Type = vtape} in the Storage daemon's Device
3299 directive. This feature is only implemented on Linux machines and should not be
3300 used for production.
3302 \subsubsection{Bat Enhancements}
3303 \index[general]{Bat Enhancements}
3304 Bat (the Bacula Administration Tool) GUI program has been significantly
3305 enhanced and stabilized. In particular, there are new table based status
3306 commands; it can now be easily localized using Qt4 Linguist.
3308 The Bat communications protocol has been significantly enhanced to improve
3309 GUI handling. Note, you {\bf must} use a the bat that is distributed with
3310 the Director you are using otherwise the communications protocol will not
3313 \subsubsection{RunScript Enhancements}
3314 \index[general]{RunScript Enhancements}
3315 The {\bf RunScript} resource has been enhanced to permit multiple
3316 commands per RunScript. Simply specify multiple {\bf Command} directives
3323 Command = "/bin/echo test"
3324 Command = "/bin/echo an other test"
3325 Command = "/bin/echo 3 commands in the same runscript"
3332 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
3333 implemented, which runs the command after the Volume Shadow Copy has been made.
3335 Console commands can be specified within a RunScript by using:
3336 {\bf Console = \lt{}command\gt{}}, however, this command has not been
3337 carefully tested and debugged and is known to easily crash the Director.
3338 We would appreciate feedback. Due to the recursive nature of this command, we
3339 may remove it before the final release.
3341 \subsubsection{Status Enhancements}
3342 \index[general]{Status Enhancements}
3343 The bconsole {\bf status dir} output has been enhanced to indicate
3344 Storage daemon job spooling and despooling activity.
3346 \subsubsection{Connect Timeout}
3347 \index[general]{Connect Timeout}
3348 The default connect timeout to the File
3349 daemon has been set to 3 minutes. Previously it was 30 minutes.
3351 \subsubsection{ftruncate for NFS Volumes}
3352 \index[general]{ftruncate for NFS Volumes}
3353 If you write to a Volume mounted by NFS (say on a local file server),
3354 in previous Bacula versions, when the Volume was recycled, it was not
3355 properly truncated because NFS does not implement ftruncate (file
3356 truncate). This is now corrected in the new version because we have
3357 written code (actually a kind user) that deletes and recreates the Volume,
3358 thus accomplishing the same thing as a truncate.
3360 \subsubsection{Support for Ubuntu}
3361 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
3362 version of Linux, and thus now provides correct autostart routines.
3363 Since Ubuntu officially supports Bacula, you can also obtain any
3364 recent release of Bacula from the Ubuntu repositories.
3366 \subsubsection{Recycle Pool = \lt{}pool-name\gt{}}
3367 \index[general]{Recycle Pool}
3368 The new \textbf{RecyclePool} directive defines to which pool the Volume will
3369 be placed (moved) when it is recycled. Without this directive, a Volume will
3370 remain in the same pool when it is recycled. With this directive, it can be
3371 moved automatically to any existing pool during a recycle. This directive is
3372 probably most useful when defined in the Scratch pool, so that volumes will
3373 be recycled back into the Scratch pool.
3375 \subsubsection{FD Version}
3376 \index[general]{FD Version}
3377 The File daemon to Director protocol now includes a version
3378 number, which although there is no visible change for users,
3379 will help us in future versions automatically determine
3380 if a File daemon is not compatible.
3382 \subsubsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
3383 \index[general]{Max Run Sched Time}
3384 The time specifies the maximum allowed time that a job may run, counted from
3385 when the job was scheduled. This can be useful to prevent jobs from running
3386 during working hours. We can see it like \texttt{Max Start Delay + Max Run
3389 \subsubsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
3390 \index[general]{Max Wait Time}
3391 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
3392 of checking the maximum allowed time that a job may block for a resource,
3393 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
3394 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
3395 their job depending on the level. Now, they have to use
3396 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
3397 directives are now deprecated.
3399 \subsubsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
3400 \index[general]{Incremental Max Wait Time}
3401 \index[general]{Differential Max Wait Time}
3403 These directives have been deprecated in favor of
3404 \texttt{Incremental|Differential Max Run Time}.
3406 \subsubsection{Max Run Time directives}
3407 \index[general]{Max Run Time directives}
3408 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
3409 maximum allowed time that a job can run depending on the level.
3411 \addcontentsline{lof}{figure}{Job time control directives}
3413 \includegraphics[width=\linewidth]{different_time}
3416 \subsubsection{Statistics Enhancements}
3417 \index[general]{Statistics Enhancements}
3418 If you (or probably your boss) want to have statistics on your backups to
3419 provide some \textit{Service Level Agreement} indicators, you could use a few
3420 SQL queries on the Job table to report how many:
3424 \item jobs have been successful
3425 \item files have been backed up
3429 However, these statistics are accurate only if your job retention is greater
3430 than your statistics period. Ie, if jobs are purged from the catalog, you won't
3431 be able to use them.
3433 Now, you can use the \textbf{update stats [days=num]} console command to fill
3434 the JobHistory table with new Job records. If you want to be sure to take in
3435 account only \textbf{good jobs}, ie if one of your important job has failed but
3436 you have fixed the problem and restarted it on time, you probably want to
3437 delete the first \textit{bad} job record and keep only the successful one. For
3438 that simply let your staff do the job, and update JobHistory table after two or
3439 three days depending on your organization using the \textbf{[days=num]} option.
3441 These statistics records aren't used for restoring, but mainly for
3442 capacity planning, billings, etc.
3444 The Bweb interface provides a statistics module that can use this feature. You
3445 can also use tools like Talend or extract information by yourself.
3447 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
3448 the length of time that Bacula will keep statistics job records in the Catalog
3449 database after the Job End time. (In \texttt{JobHistory} table) When this time
3450 period expires, and if user runs \texttt{prune stats} command, Bacula will
3451 prune (remove) Job records that are older than the specified period.
3453 You can use the following Job resource in your nightly \textbf{BackupCatalog}
3454 job to maintain statistics.
3457 Name = BackupCatalog
3460 Console = "update stats days=3"
3461 Console = "prune stats yes"
3468 \subsubsection{ScratchPool = \lt{}pool-resource-name\gt{}}
3469 \index[general]{ScratchPool}
3470 This directive permits to specify a specific \textsl{Scratch} pool for the
3471 current pool. This is useful when using multiple storage sharing the same
3472 mediatype or when you want to dedicate volumes to a particular set of pool.
3474 \subsubsection{Enhanced Attribute Despooling}
3475 \index[general]{Attribute Despooling}
3476 If the storage daemon and the Director are on the same machine, the spool file
3477 that contains attributes is read directly by the Director instead of being
3478 transmitted across the network. That should reduce load and speedup insertion.
3480 \subsubsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
3481 \index[general]{SpoolSize}
3482 A new Job directive permits to specify the spool size per job. This is used
3483 in advanced job tunning. {\bf SpoolSize={\it bytes}}
3485 \subsubsection{MaximumConsoleConnections = \lt{}number\gt{}}
3486 \index[general]{MaximumConsoleConnections}
3487 A new director directive permits to specify the maximum number of Console
3488 Connections that could run concurrently. The default is set to 20, but you may
3489 set it to a larger number.
3491 \subsubsection{VerId = \lt{}string\gt{}}
3492 \index[general]{VerId}
3493 A new director directive permits to specify a personnal identifier that will be
3494 displayed in the \texttt{version} command.
3496 \subsubsection{dbcheck enhancements}
3497 \index[general]{dbcheck enhancements}
3498 If you are using Mysql, dbcheck will now ask you if you want to create
3499 temporary indexes to speed up orphaned Path and Filename elimination.
3501 A new \texttt{-B} option allows you to print catalog information in a simple
3502 text based format. This is useful to backup it in a secure way.
3517 You can now specify the database connection port in the command line.
3519 \subsubsection{{-}{-}docdir configure option}
3520 \index[general]{{-}{-}docdir configure option}
3521 You can use {-}{-}docdir= on the ./configure command to
3522 specify the directory where you want Bacula to install the
3523 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
3524 {\bf /usr/share/doc/bacula}.
3526 \subsubsection{{-}{-}htmldir configure option}
3527 \index[general]{{-}{-}htmldir configure option}
3528 You can use {-}{-}htmldir= on the ./configure command to
3529 specify the directory where you want Bacula to install the bat html help
3530 files. The default is {\bf /usr/share/doc/bacula/html}
3532 \subsubsection{{-}{-}with-plugindir configure option}
3533 \index[general]{{-}{-}plugindir configure option}
3534 You can use {-}{-}plugindir= on the ./configure command to
3535 specify the directory where you want Bacula to install
3536 the plugins (currently only bpipe-fd). The default is