1 \chapter{New Features in 7.0.0}
2 This chapter presents the new features that have been added to the next
3 Community version of Bacula that is not yet released.
5 \section{New Features in 7.0.0}
7 \subsection{Data Encryption Cipher Configuration}
8 Bacula version 7.0 and later now allows to configure the data
9 encryption cipher and the digest algorithm. The cipher was forced to AES
11 and it is now possible to choose between the following ciphers:
14 \item AES128 (default)
20 The digest algorithm was set to SHA1 or SHA256 depending on the local
22 options. We advise you to not modify the PkiDigest default setting. Please,
23 refer to OpenSSL documentation to know about pro and cons on these options.
32 \subsection{New Truncate Command}
33 We have added a new truncate command to bconsole, which
34 will truncate a Volume if the Volume is purged and if
35 the Volume is also marked {\bf Action On Purge = Truncate}.
36 This feature was originally added in Bacula version 5.0.1,
37 but the mechanism for actually doing the truncate required
38 the user to enter a command such as:
41 purge volume action=truncate storage=File pool=Default
44 The above command is now simplified to be:
47 truncate storage=File pool=Default
50 \subsection{New Resume Command}
51 This command does exactly the same thing as a
52 {\bf restart} command but for some users the
53 name may be more logical since in general the
54 {\bf restart} command is used to resume running
55 a Job that was incompleted.
57 \subsection{Migration/Copy/VirtualFull Performance Enhancements}
58 The Bacula Storage daemon now permits multiple jobs to simultaneously read
59 the same disk Volume, which gives substantial performance enhancements when
60 running Migration, Copy, or VirtualFull jobs that read disk Volumes. Our
61 testing shows that when running multiple simultaneous jobs, the jobs can
62 finish up to ten times faster with this version of Bacula. This is
63 built-in to the Storage daemon, so it happens automatically and
66 \subsection{FD Storage Address}
68 When the Director is behind a NAT, in a WAN area, to connect to
70 the StorageDaemon, the Director uses an ``external'' ip address,
71 and the FileDaemon should use an ``internal'' IP address to contact the
74 The normal way to handle this situation is to use a canonical name such as
75 ``storage-server'' that will be resolved on the Director side as the WAN
76 address and on the Client side as the LAN address. This is now possible to
77 configure this parameter using the new directive \texttt{FDStorageAddress} in
78 the Storage or Client resource.
81 \includegraphics[width=0.8\linewidth]{BackupOverWan1}
82 \label{fig:fdstorageaddress}
88 FD Storage Address = 10.0.0.1
94 % # or in the Client resouce
101 FD Storage Address = 10.0.0.1
107 Note that using the Client \texttt{FDStorageAddress} directive will not allow
108 to use multiple Storage Daemon, all Backup or Restore requests will be sent to
109 the specified \texttt{FDStorageAddress}.
111 \subsection{Job Bandwidth Limitation}
113 The new {\bf Job Bandwidth Limitation} directive may be added to the File
114 daemon's and/or Director's configuration to limit the bandwidth used by a
115 Job on a Client. It can be set in the File daemon's conf file for all Jobs
116 run in that File daemon, or it can be set for each Job in the Director's
117 conf file. The speed is always specified in bytes per second.
123 Working Directory = /some/path
124 Pid Directory = /some/path
126 Maximum Bandwidth Per Job = 5Mb/s
130 The above example would cause any jobs running with the FileDaemon to not
131 exceed 5 megabytes per second of throughput when sending data to the
132 Storage Daemon. Note, the speed is always specified in bytes per second
133 (not in bits per second), and the case (upper/lower) of the specification
134 characters is ignored (i.e. 1MB/s = 1Mb/s).
136 You may specify the following speed parameter modifiers:
137 k/s (1,000 bytes per second), kb/s (1,024 bytes per second),
138 m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second).
144 FileSet = FS_localhost
147 Maximum Bandwidth = 5Mb/s
152 The above example would cause Job \texttt{localhost-data} to not exceed 5MB/s
153 of throughput when sending data from the File daemon to the Storage daemon.
155 A new console command \texttt{setbandwidth} permits to set dynamically the
156 maximum throughput of a running Job or for future jobs of a Client.
159 * setbandwidth limit=1000 jobid=10
162 Please note that the value specified for the \texttt{limit} command
163 line parameter is always in units of 1024 bytes (i.e. the number
164 is multiplied by 1024 to give the number of bytes per second). As
165 a consequence, the above limit of 1000 will be interpreted as a
166 limit of 1000 * 1024 = 1,024,000 bytes per second.
169 This project was funded by Bacula Systems.
172 \subsection{Maximum Concurrent Read Jobs}
173 This is a new directive that can be used in the {\bf bacula-dir.conf} file
174 in the Storage resource. The main purpose is to limit the number
175 of concurrent Copy, Migration, and VirtualFull jobs so that
176 they don't monopolize all the Storage drives causing a deadlock situation
177 where all the drives are allocated for reading but none remain for
178 writing. This deadlock situation can occur when running multiple
179 simultaneous Copy, Migration, and VirtualFull jobs.
182 The default value is set to 0 (zero), which means there is no
183 limit on the number of read jobs. Note, limiting the read jobs
184 does not apply to Restore jobs, which are normally started by
185 hand. A reasonable value for this directive is one half the number
186 of drives that the Storage resource has rounded down. Doing so,
187 will leave the same number of drives for writing and will generally
188 avoid over committing drives and a deadlock.
191 \subsection{Director job Codes in Message Resource Commands}
192 Before submitting the specified mail command to the operating system, Bacula
193 performs character substitution like in Runscript commands. Bacula will now
194 perform also specific Director character substitution.
197 The code for this feature was contributed by Bastian Friedrich.
199 \subsection{Additions to RunScript variables}
200 The following variables are now available in runscripts:
202 \item current PID using \%P
203 \item if the job is a clone job using \%C
207 RunAfterJob = "/bin/echo Pid=%P isCloned=%C"
211 \subsection{Read Only Storage Devices}
212 This version of Bacula permits defining a Storage deamon device
213 to be read-only. That is if the {\bf ReadOnly} directive is specified and
214 enabled, the drive can only be used for read operations.
215 The the {\bf ReadOnly} directive can be defined in any bacula-sd.conf
216 Device resource, and is most useful to reserve one or more
217 drives for restores. An example is:
223 \subsection{New Prune ``Expired'' Volume Command}
224 It is now possible to prune all volumes
225 (from a pool, or globally) that are ``expired''. This option can be
226 scheduled after or before the backup of the Catalog and can be
227 combined with the Truncate On Purge option. The Expired Prune option can
228 be used instead of the \texttt{manual\_prune.pl} script.
231 * prune expired volumes
233 * prune expired volumes pool=FullPool
236 To schedule this option automatically, it can be added to the BackupCatalog job
244 Console = "prune expired volume yes"
251 \subsection*{New Debug Options}
253 In Bacula Enterprise version 8.0 and later, we introduced new options to
254 the \texttt{setdebug} command.
258 If the \texttt{options} parameter is set, the following arguments can be
259 used to control debug functions.
262 \item [0] clear debug flags
263 \item [i] Turn off, ignore bwrite() errors on restore on File Daemon
264 \item [d] Turn off decomp of BackupRead() streams on File Daemon
265 \item [t] Turn on timestamp in traces
266 \item [T] Turn off timestamp in traces
267 \item [c] Truncate trace file if trace file is activated
268 \item [l] Turn on recoding events on P() and V()
269 \item [p] Turn on the display of the event ring when doing a bactrace
274 The following command will truncate the trace file and will turn on timestamps
278 * setdebug level=10 trace=1 options=ct fd
283 It is now possible to use \textsl{class} of debug messages called \texttt{tags}
284 to control the debug output of Bacula daemons.
287 \item [all] Display all debug messages
288 \item [bvfs] Display BVFS debug messages
289 \item [sql] Display SQL related debug messages
290 \item [memory] Display memory and poolmem allocation messages
291 \item [scheduler] Display scheduler related debug messages
295 * setdebug level=10 tags=bvfs,sql,memory
296 * setdebug level=10 tags=!bvfs
298 # bacula-dir -t -d 200,bvfs,sql
301 The \texttt{tags} option is composed of a list of tags, tags are separated by
302 ``,'' or ``+'' or ``-'' or ``!''. To disable a specific tag, use ``-'' or ``!''
303 in front of the tag. Note that more tags will come in future versions.
305 %\LTXtable{\linewidth}{table_debugtags}
308 \chapter{New Features in 5.2.13}
309 This chapter presents the new features that have been added to the current
310 Community version of Bacula that is now released.
312 \subsection{Additions to RunScript variables}
313 You can have access to Director name using \%D in your runscript
317 RunAfterJob = "/bin/echo Director=%D
320 \section{New Features in 5.2.1}
321 This chapter presents the new features were added in the
322 Community release version 5.2.1.
324 There are additional features (plugins) available in the Enterprise version
325 that are described in another chapter. A subscription to Bacula Systems
326 is required for the Enterprise version.
328 \subsection{LZO Compression}
330 LZO compression has been to the File daemon. From the user's point of view,
331 it works like the GZIP compression (just replace {\bf compression=GZIP} with
332 {\bf compression=LZO}).
337 Options {compression=LZO }
343 LZO provides a much faster compression and decompression speed but lower
344 compression ratio than GZIP. It is a good option when you backup to disk. For
345 tape, the hardware compression is almost always a better option.
347 LZO is a good alternative for GZIP1 when you don't want to slow down your
348 backup. With a modern CPU it should be able to run almost as fast as:
351 \item your client can read data from disk. Unless you have very fast disks like
352 SSD or large/fast RAID array.
353 \item the data transfers between the file daemon and the storage daemon even on
357 Note, Bacula uses compression level LZO1X-1.
360 The code for this feature was contributed by Laurent Papier.
362 \subsection{New Tray Monitor}
364 Since the old integrated Windows tray monitor doesn't work with
365 recent Windows versions, we have written a new Qt Tray Monitor that is available
366 for both Linux and Windows. In addition to all the previous features,
367 this new version allows you to run Backups from
368 the tray monitor menu.
372 \includegraphics[width=0.8\linewidth]{tray-monitor}
373 \label{fig:traymonitor}
374 \caption{New tray monitor}
379 \includegraphics[width=0.8\linewidth]{tray-monitor1}
380 \label{fig:traymonitor1}
381 \caption{Run a Job through the new tray monitor}
385 To be able to run a job from the tray monitor, you need to
386 allow specific commands in the Director monitor console:
391 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
392 ClientACL = *all* # you can restrict to a specific host
404 This project was funded by Bacula Systems and is available with Bacula
405 the Enterprise Edition and the Community Edition.
407 \subsection{Purge Migration Job}
409 The new {\bf Purge Migration Job} directive may be added to the Migration
410 Job definition in the Director's configuration file. When it is enabled
411 the Job that was migrated during a migration will be purged at
412 the end of the migration job.
420 Client = localhost-fd
423 Storage = DiskChanger
426 Selection Pattern = ".*Save"
428 Purge Migration Job = yes
434 This project was submitted by Dunlap Blake; testing and documentation was funded
437 \subsection{Changes in Bvfs (Bacula Virtual FileSystem)}
439 Bat has now a bRestore panel that uses Bvfs to display files and
444 \includegraphics[width=0.8\linewidth]{bat-brestore}
445 \label{fig:batbrestore}
446 \caption{Bat Brestore Panel}
449 the Bvfs module works correctly with BaseJobs, Copy and Migration jobs.
452 This project was funded by Bacula Systems.
454 \subsubsection*{General notes}
457 \item All fields are separated by a tab
458 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
459 records in very big directories
460 \item All operations (except cache creation) are designed to run instantly
461 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
462 can contribute new faster SQL queries we will be happy, else don't complain
464 \item The cache creation is dependent of the number of directories. As Bvfs
465 shares information across jobs, the first creation can be slow
466 \item All fields are separated by a tab
467 \item Due to potential encoding problem, it's advised to always use pathid in
471 \subsubsection*{Get dependent jobs from a given JobId}
473 Bvfs allows you to query the catalog against any combination of jobs. You
474 can combine all Jobs and all FileSet for a Client in a single session.
476 To get all JobId needed to restore a particular job, you can use the
477 \texttt{.bvfs\_get\_jobids} command.
480 .bvfs_get_jobids jobid=num [all]
484 .bvfs_get_jobids jobid=10
486 .bvfs_get_jobids jobid=10 all
490 In this example, a normal restore will need to use JobIds 1,2,5,10 to
491 compute a complete restore of the system.
493 With the \texttt{all} option, the Director will use all defined FileSet for
496 \subsubsection*{Generating Bvfs cache}
498 The \texttt{.bvfs\_update} command computes the directory cache for jobs
499 specified in argument, or for all jobs if unspecified.
502 .bvfs_update [jobid=numlist]
507 .bvfs_update jobid=1,2,3
510 You can run the cache update process in a RunScript after the catalog backup.
512 \subsubsection*{Get all versions of a specific file}
514 Bvfs allows you to find all versions of a specific file for a given Client with
515 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
516 function uses only PathId and FilenameId. The jobid argument is mandatory but
520 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
521 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
522 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
529 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
530 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
533 \subsubsection*{List directories}
535 Bvfs allows you to list directories in a specific path.
537 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
538 PathId FilenameId FileId JobId LStat Path
539 PathId FilenameId FileId JobId LStat Path
540 PathId FilenameId FileId JobId LStat Path
544 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
545 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
546 listed is a directory.
549 .bvfs_lsdirs pathid=4 jobid=1,11,12
550 4 0 0 0 A A A A A A A A A A A A A A .
551 5 0 0 0 A A A A A A A A A A A A A A ..
552 3 0 0 0 A A A A A A A A A A A A A A regress/
555 In this example, to list directories present in \texttt{regress/}, you can use
557 .bvfs_lsdirs pathid=3 jobid=1,11,12
558 3 0 0 0 A A A A A A A A A A A A A A .
559 4 0 0 0 A A A A A A A A A A A A A A ..
560 2 0 0 0 A A A A A A A A A A A A A A tmp/
563 \subsubsection*{List files}
565 Bvfs allows you to list files in a specific path.
567 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
568 PathId FilenameId FileId JobId LStat Path
569 PathId FilenameId FileId JobId LStat Path
570 PathId FilenameId FileId JobId LStat Path
574 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
575 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
579 .bvfs_lsfiles pathid=4 jobid=1,11,12
580 4 0 0 0 A A A A A A A A A A A A A A .
581 5 0 0 0 A A A A A A A A A A A A A A ..
582 1 0 0 0 A A A A A A A A A A A A A A regress/
585 In this example, to list files present in \texttt{regress/}, you can use
587 .bvfs_lsfiles pathid=1 jobid=1,11,12
588 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
589 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
590 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
591 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
592 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
595 \subsubsection*{Restore set of files}
597 Bvfs allows you to create a SQL table that contains files that you want to
598 restore. This table can be provided to a restore command with the file option.
601 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
603 restore file=?b2num ...
606 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
607 select all files. This query could be time consuming.
609 \texttt{hardlink} list is always composed of a series of two numbers (jobid,
610 fileindex). This information can be found in the LinkFI field of the LStat
613 The \texttt{path} argument represents the name of the table that Bvfs will
614 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
615 b2 and followed by digits).
620 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
624 \subsubsection*{Cleanup after Restore}
626 To drop the table used by the restore command, you can use the
627 \texttt{.bvfs\_cleanup} command.
630 .bvfs_cleanup path=b20001
633 \subsubsection*{Clearing the BVFS Cache}
635 To clear the BVFS cache, you can use the \texttt{.bvfs\_clear\_cache} command.
638 .bvfs_clear_cache yes
642 \subsection{Changes in the Pruning Algorithm}
644 We rewrote the job pruning algorithm in this version. Previously, in some users
645 reported that the pruning process at the end of jobs was very long. It should
646 not be longer the case. Now, Bacula won't prune automatically a Job if this
647 particular Job is needed to restore data. Example:
651 JobId: 2 Level: Incremental
652 JobId: 3 Level: Incremental
653 JobId: 4 Level: Differential
654 .. Other incrementals up to now
657 In this example, if the Job Retention defined in the Pool or in the Client
658 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
659 detect that JobId 1 and 4 are essential to restore data at the current state
660 and will prune only JobId 2 and 3.
662 \texttt{Important}, this change affect only the automatic pruning step after a
663 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
664 \texttt{VolumeRetention} period, important jobs can be pruned.
666 \subsection{Ability to Verify any specified Job}
667 You now have the ability to tell Bacula which Job should verify instead of
668 automatically verify just the last one.
670 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
672 To verify a given job, just specify the Job jobid in argument when starting the
675 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
677 JobName: VerifyVolume
678 Level: VolumeToCatalog
681 Pool: Default (From Job resource)
682 Storage: File (From Job resource)
683 Verify Job: VerifyVol.2010-09-08_14.17.17_03
684 Verify List: /tmp/regress/working/VerifyVol.bsr
685 When: 2010-09-08 14:17:31
687 OK to run? (yes/mod/no):
691 This project was funded by Bacula Systems and is available with Bacula
692 Enterprise Edition and Community Edition.
694 \subsection{Additions to RunScript variables}
695 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
696 command. The Client address is now available through \%h.
699 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
702 %\subsection{Changes in drivetype.exe}
704 %Now the \texttt{drivetype.exe} program allows you to list all local hard
705 %drives. It can help to build dynamic FileSet on Windows.
708 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
712 \subsection{Additions to the Plugin API}
713 The bfuncs structure has been extended to include a number of
716 \subsubsection{bfuncs}
717 The bFuncs structure defines the callback entry points within Bacula
718 that the plugin can use register events, get Bacula values, set
719 Bacula values, and send messages to the Job output or debug output.
721 The exact definition as of this writing is:
723 typedef struct s_baculaFuncs {
726 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
727 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
728 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
729 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
730 int type, utime_t mtime, const char *fmt, ...);
731 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
732 int level, const char *fmt, ...);
733 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
735 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
737 /* New functions follow */
738 bRC (*AddExclude)(bpContext *ctx, const char *file);
739 bRC (*AddInclude)(bpContext *ctx, const char *file);
740 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
741 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
742 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
743 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
749 \item [AddExclude] can be called to exclude a file. The file
750 string passed may include wildcards that will be interpreted by
751 the {\bf fnmatch} subroutine. This function can be called
752 multiple times, and each time the file specified will be added
753 to the list of files to be excluded. Note, this function only
754 permits adding excludes of specific file or directory names,
755 or files matched by the rather simple fnmatch mechanism.
756 See below for information on doing wild-card and regex excludes.
758 \item [NewPreInclude] can be called to create a new Include block. This
759 block will be added after the current defined Include block. This
760 function can be called multiple times, but each time, it will create
761 a new Include section (not normally needed). This function should
762 be called only if you want to add an entirely new Include block.
764 \item [NewInclude] can be called to create a new Include block. This
765 block will be added before any user defined Include blocks. This
766 function can be called multiple times, but each time, it will create
767 a new Include section (not normally needed). This function should
768 be called only if you want to add an entirely new Include block.
770 \item [AddInclude] can be called to add new files/directories to
771 be included. They are added to the current Include block. If
772 NewInclude has not been included, the current Include block is
773 the last one that the user created. This function
774 should be used only if you want to add totally new files/directories
775 to be included in the backup.
777 \item [NewOptions] adds a new Options block to the current Include
778 in front of any other Options blocks. This permits the plugin to
779 add exclude directives (wild-cards and regexes) in front of the
780 user Options, and thus prevent certain files from being backed up.
781 This can be useful if the plugin backs up files, and they should
782 not be also backed up by the main Bacula code. This function
783 may be called multiple times, and each time, it creates a new
784 prepended Options block. Note: normally you want to call this
785 entry point prior to calling AddOptions, AddRegex, or AddWild.
787 \item [AddOptions] allows the plugin it set options in
788 the current Options block, which is normally created with the
789 NewOptions call just prior to adding Include Options.
790 The permitted options are passed as a character string, where
791 each character has a specific meaning as defined below:
794 \item [a] always replace files (default).
795 \item [e] exclude rather than include.
796 \item [h] no recursion into subdirectories.
797 \item [H] do not handle hard links.
798 \item [i] ignore case in wildcard and regex matches.
799 \item [M] compute an MD5 sum.
800 \item [p] use a portable data format on Windows (not recommended).
801 \item [R] backup resource forks and Findr Info.
802 \item [r] read from a fifo
803 \item [S1] compute an SHA1 sum.
804 \item [S2] compute an SHA256 sum.
805 \item [S3] comput an SHA512 sum.
806 \item [s] handle sparse files.
807 \item [m] use st\_mtime only for file differences.
808 \item [k] restore the st\_atime after accessing a file.
809 \item [A] enable ACL backup.
810 \item [Vxxx:] specify verify options. Must terminate with :
811 \item [Cxxx:] specify accurate options. Must terminate with :
812 \item [Jxxx:] specify base job Options. Must terminate with :
813 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
815 \item [Zn] specify gzip compression level n.
816 \item [K] do not use st\_atime in backup decision.
817 \item [c] check if file changed during backup.
818 \item [N] honor no dump flag.
819 \item [X] enable backup of extended attributes.
822 \item [AddRegex] adds a regex expression to the current Options block.
823 The following options are permitted:
825 \item [ ] (a blank) regex applies to whole path and filename.
826 \item [F] regex applies only to the filename (directory or path stripped).
827 \item [D] regex applies only to the directory (path) part of the name.
830 \item [AddWild] adds a wildcard expression to the current Options block.
831 The following options are permitted:
833 \item [ ] (a blank) regex applies to whole path and filename.
834 \item [F] regex applies only to the filename (directory or path stripped).
835 \item [D] regex applies only to the directory (path) part of the name.
838 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
839 that can use Accurate code to compare the file information in argument with
840 the previous file information. The \texttt{delta\_seq} attribute of the
841 \texttt{save\_pkt} will be updated, and the call will return
842 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
847 \subsubsection{Bacula events}
848 The list of events has been extended to include:
854 bEventStartBackupJob = 3,
855 bEventEndBackupJob = 4,
856 bEventStartRestoreJob = 5,
857 bEventEndRestoreJob = 6,
858 bEventStartVerifyJob = 7,
859 bEventEndVerifyJob = 8,
860 bEventBackupCommand = 9,
861 bEventRestoreCommand = 10,
866 bEventCancelCommand = 13,
867 bEventVssBackupAddComponents = 14,
868 bEventVssRestoreLoadComponentMetadata = 15,
869 bEventVssRestoreSetComponentsSelected = 16,
870 bEventRestoreObject = 17,
871 bEventEndFileSet = 18,
872 bEventPluginCommand = 19,
873 bEventVssBeforeCloseRestore = 20,
874 bEventVssPrepareSnapshot = 21
880 \item [bEventCancelCommand] is called whenever the currently
881 running Job is canceled */
883 \item [bEventVssBackupAddComponents]
885 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
886 provides a char[27] table where the plugin can add Windows drives that will
887 be used during the Job. You need to add them without duplicates, and you can
888 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
892 \subsection{ACL enhancements}
894 The following enhancements are made to the Bacula Filed with regards to
895 Access Control Lists (ACLs)
898 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
899 POSIX and NFSv4 ACLs.
900 \item Added support for new acl types on FreeBSD 8.1 and later which supports
901 POSIX and NFSv4 ACLs.
902 \item Some generic cleanups for internal ACL handling.
903 \item Fix for acl storage on OSX
904 \item Cleanup of configure checks for ACL detection, now configure only
905 tests for a certain interface type based on the operating system
906 this should give less false positives on detection. Also when ACLs
907 are detected no other acl checks are performed anymore.
911 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
912 and is available with Bacula Enterprise Edition and Community Edition.
914 \subsection{XATTR enhancements}
916 The following enhancements are made to the Bacula Filed with regards to
917 Extended Attributes (XATTRs)
920 \item Added support for IRIX extended attributes using the attr\_get interface.
921 \item Added support for Tru64 (OSF1) extended attributes using the
922 getproplist interface.
923 \item Added support for AIX extended attributes available in AIX 6.x
924 and higher using the listea/getea/setea interface.
925 \item Added some debugging to generic xattr code so it easier to
927 \item Cleanup of configure checks for XATTR detection, now configure only
928 tests for a certain interface type based on the operating system
929 this should give less false positives on detection. Also when xattrs
930 are detected no other xattr checks are performed anymore.
934 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
935 and is available with Bacula Enterprise Edition and Community Edition.
937 \subsection{Class Based Database Backend Drivers}
939 The main Bacula Director code is independent of the SQL backend
940 in version 5.2.0 and greater. This means that the Bacula Director can be
941 packaged by itself, then each of the different SQL backends supported can
942 be packaged separately. It is possible to build all the DB backends at the
943 same time by including multiple database options at the same time.
945 ./configure can be run with multiple database configure options.
952 Order of testing for databases is:
959 Each configured backend generates a file named:
960 \verb+libbaccats-<sql_backend_name>-<version>.so+
961 A dummy catalog library is created named libbaccats-version.so
963 At configure time the first detected backend is used as the so called
964 default backend and at install time the dummy
965 \verb+libbaccats-<version>.so+ is replaced with the default backend type.
967 If you configure all three backends you get three backend libraries and the
968 postgresql gets installed as the default.
970 When you want to switch to another database, first save any old catalog you
971 may have then you can copy one of the three backend libraries over the
972 \verb+libbaccats-<version>.so+ e.g.
974 An actual command, depending on your Bacula version might be:
976 cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
979 where the \verb+5.2.2+ must be replaced by the Bacula release
982 Then you must update the default backend in the following files:
985 create_bacula_database
988 grant_bacula_privileges
994 And re-run all the above scripts. Please note, this means
995 you will have a new empty database and if you had a previous
998 All current database backend drivers for catalog information are rewritten
999 to use a set of multi inherited C++ classes which abstract the specific
1000 database specific internals and make sure we have a more stable generic
1001 interface with the rest of SQL code. From now on there is a strict
1002 boundary between the SQL code and the low-level database functions. This
1003 new interface should also make it easier to add a new backend for a
1004 currently unsupported database. As part of the rewrite the SQLite 2 code
1005 was removed (e.g. only SQLite 3 is now supported). An extra bonus of the
1006 new code is that you can configure multiple backends in the configure and
1007 build all backends in one compile session and select the correct database
1008 backend at install time. This should make it a lot easier for packages
1014 We also added cursor support for PostgreSQL backend, this improves memory
1015 usage for large installation.
1018 This project was implemented by Planets Communications B.V. and ELM
1019 Consultancy B.V. and Bacula Systems and is available with both the Bacula
1020 Enterprise Edition and the Community Edition.
1022 \subsection{Hash List Enhancements}
1024 The htable hash table class has been extended with extra hash functions for
1025 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
1026 Also the hash table initialization routines have been enhanced with
1027 support for passing a hint as to the number of initial pages to use
1028 for the size of the hash table. Until now the hash table always used
1029 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
1030 cache have been rewritten to use the new htable class with a small memory
1034 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
1035 and Bacula Systems and is available with Bacula Enterprise Edition and
1040 %%% =====================================================================
1045 \section{Release Version 5.0.3}
1047 There are no new features in version 5.0.2. This version simply fixes a
1048 number of bugs found in version 5.0.1 during the ongoing development
1051 \section{Release Version 5.0.2}
1053 There are no new features in version 5.0.2. This version simply fixes a
1054 number of bugs found in version 5.0.1 during the ongoing development
1060 \section{New Features in 5.0.1}
1062 This chapter presents the new features that are in the released Bacula version
1063 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
1064 the ongoing development process.
1066 \subsection{Truncate Volume after Purge}
1067 \label{sec:actiononpurge}
1069 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
1070 the volume when it is purged with the new command \texttt{purge volume
1071 action}. It is useful to prevent disk based volumes from consuming too much
1077 Action On Purge = Truncate
1082 As usual you can also set this property with the \texttt{update volume} command
1084 *update volume=xxx ActionOnPurge=Truncate
1085 *update volume=xxx actiononpurge=None
1088 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
1089 following command in interactive mode or in a RunScript as shown after:
1091 *purge volume action=truncate storage=File allpools
1092 # or by default, action=all
1093 *purge volume action storage=File pool=Default
1096 This is possible to specify the volume name, the media type, the pool, the
1097 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
1098 idle when you decide to run this command.
1102 Name = CatalogBackup
1107 Console = "purge volume action=all allpools storage=File"
1112 \textbf{Important note}: This feature doesn't work as
1113 expected in version 5.0.0. Please do not use it before version 5.0.1.
1115 \subsection{Allow Higher Duplicates}
1116 This directive did not work correctly and has been depreciated
1117 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
1118 file as it will be removed in a future release.
1120 \subsection{Cancel Lower Level Duplicates}
1121 This directive was added in Bacula version 5.0.1. It compares the
1122 level of a new backup job to old jobs of the same name, if any,
1123 and will kill the job which has a lower level than the other one.
1124 If the levels are the same (i.e. both are Full backups), then
1125 nothing is done and the other Cancel XXX Duplicate directives
1128 \section{New Features in 5.0.0}
1130 \subsection{Maximum Concurrent Jobs for Devices}
1131 \label{sec:maximumconcurrentjobdevice}
1133 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
1134 Daemon configuration permits setting the maximum number of Jobs that can
1135 run concurrently on a specified Device. Using this directive, it is
1136 possible to have different Jobs using multiple drives, because when the
1137 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
1138 Jobs on any other available compatible drive. This facilitates writing to
1139 multiple drives with multiple Jobs that all use the same Pool.
1141 This project was funded by Bacula Systems.
1143 \subsection{Restore from Multiple Storage Daemons}
1144 \index[general]{Restore}
1146 Previously, you were able to restore from multiple devices in a single Storage
1147 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
1148 example, if your full backup runs on a Storage Daemon with an autochanger, and
1149 your incremental jobs use another Storage Daemon with lots of disks, Bacula
1150 will switch automatically from one Storage Daemon to an other within the same
1153 You must upgrade your File Daemon to version 3.1.3 or greater to use this
1156 This project was funded by Bacula Systems with the help of Equiinet.
1158 \subsection{File Deduplication using Base Jobs}
1159 A base job is sort of like a Full save except that you will want the FileSet to
1160 contain only files that are unlikely to change in the future (i.e. a snapshot
1161 of most of your system after installing it). After the base job has been run,
1162 when you are doing a Full save, you specify one or more Base jobs to be used.
1163 All files that have been backed up in the Base job/jobs but not modified will
1164 then be excluded from the backup. During a restore, the Base jobs will be
1165 automatically pulled in where necessary.
1167 This is something none of the competition does, as far as we know (except
1168 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
1169 win for the user, it makes Bacula stand out as offering a unique optimization
1170 that immediately saves time and money. Basically, imagine that you have 100
1171 nearly identical Windows or Linux machine containing the OS and user files.
1172 Now for the OS part, a Base job will be backed up once, and rather than making
1173 100 copies of the OS, there will be only one. If one or more of the systems
1174 have some files updated, no problem, they will be automatically restored.
1176 See the \ilink{Base Job Chapter}{basejobs} for more information.
1178 This project was funded by Bacula Systems.
1180 \subsection{AllowCompression = \lt{}yes\vb{}no\gt{}}
1181 \index[dir]{AllowCompression}
1183 This new directive may be added to Storage resource within the Director's
1184 configuration to allow users to selectively disable the client compression for
1185 any job which writes to this storage resource.
1191 Address = ultrium-tape
1192 Password = storage_password # Password for Storage Daemon
1195 AllowCompression = No # Tape drive has hardware compression
1198 The above example would cause any jobs running with the UltriumTape storage
1199 resource to run without compression from the client file daemons. This
1200 effectively overrides any compression settings defined at the FileSet level.
1202 This feature is probably most useful if you have a tape drive which supports
1203 hardware compression. By setting the \texttt{AllowCompression = No} directive
1204 for your tape drive storage resource, you can avoid additional load on the file
1205 daemon and possibly speed up tape backups.
1207 This project was funded by Collaborative Fusion, Inc.
1209 \subsection{Accurate Fileset Options}
1210 \label{sec:accuratefileset}
1212 In previous versions, the accurate code used the file creation and modification
1213 times to determine if a file was modified or not. Now you can specify which
1214 attributes to use (time, size, checksum, permission, owner, group, \dots),
1215 similar to the Verify options.
1231 \item {\bf i} compare the inodes
1232 \item {\bf p} compare the permission bits
1233 \item {\bf n} compare the number of links
1234 \item {\bf u} compare the user id
1235 \item {\bf g} compare the group id
1236 \item {\bf s} compare the size
1237 \item {\bf a} compare the access time
1238 \item {\bf m} compare the modification time (st\_mtime)
1239 \item {\bf c} compare the change time (st\_ctime)
1240 \item {\bf d} report file size decreases
1241 \item {\bf 5} compare the MD5 signature
1242 \item {\bf 1} compare the SHA1 signature
1245 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
1246 the File Daemon will have to read all files even if they normally would not
1247 be saved. This increases the I/O load, but also the accuracy of the
1248 deduplication. By default, Bacula will check modification/creation time
1251 This project was funded by Bacula Systems.
1253 \subsection{Tab-completion for Bconsole}
1254 \label{sec:tabcompletion}
1256 If you build \texttt{bconsole} with readline support, you will be able to use
1257 the new auto-completion mode. This mode supports all commands, gives help
1258 inside command, and lists resources when required. It works also in the restore
1261 To use this feature, you should have readline development package loaded on
1262 your system, and use the following option in configure.
1264 ./configure --with-readline=/usr/include/readline --disable-conio ...
1267 The new bconsole won't be able to tab-complete with older directors.
1269 This project was funded by Bacula Systems.
1271 \subsection{Pool File and Job Retention}
1272 \label{sec:poolfilejobretention}
1274 We added two new Pool directives, \texttt{FileRetention} and
1275 \texttt{JobRetention}, that take precedence over Client directives of the same
1276 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
1277 example, you can decide to increase Retention times for Archive or OffSite Pool.
1279 It seems obvious to us, but apparently not to some users, that given the
1280 definition above that the Pool File and Job Retention periods is a global
1281 override for the normal Client based pruning, which means that when the
1282 Job is pruned, the pruning will apply globally to that particular Job.
1284 Currently, there is a bug in the implementation that causes any Pool
1285 retention periods specified to apply to {\bf all} Pools for that
1286 particular Client. Thus we suggest that you avoid using these two
1287 directives until this implementation problem is corrected.
1289 \subsection{Read-only File Daemon using capabilities}
1290 \label{sec:fdreadonly}
1291 This feature implements support of keeping \textbf{ReadAll} capabilities after
1292 UID/GID switch, this allows FD to keep root read but drop write permission.
1294 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
1295 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
1298 root@localhost:~# bacula-fd -k -u nobody -g nobody
1301 The code for this feature was contributed by our friends at AltLinux.
1303 \subsection{Bvfs API}
1306 To help developers of restore GUI interfaces, we have added new \textsl{dot
1307 commands} that permit browsing the catalog in a very simple way.
1310 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
1311 the Bvfs cache in the catalog. You need to run it before any access to the
1314 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
1315 will list all directories in the specified \texttt{path} or
1316 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
1317 encoding of path/filenames.
1319 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
1320 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
1321 \texttt{pathid} avoids problems with character encoding.
1324 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
1325 data that will be displayed.
1328 * .bvfs_update jobid=1,2
1330 * .bvfs_lsdir path=/ jobid=1,2
1333 This project was funded by Bacula Systems.
1335 \subsection{Testing your Tape Drive}
1336 \label{sec:btapespeed}
1338 To determine the best configuration of your tape drive, you can run the new
1339 \texttt{speed} command available in the \texttt{btape} program.
1341 This command can have the following arguments:
1343 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
1344 (between 1 and 5GB). This counter is in GB.
1345 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
1346 of data should be greater than your memory ($file\_size*nb\_file$).
1347 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
1349 \item[\texttt{skip\_random}] This flag permits to skip tests with random
1351 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
1352 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
1357 *speed file_size=3 skip_raw
1358 btape.c:1078 Test with zero data and bacula block structure.
1359 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1360 ++++++++++++++++++++++++++++++++++++++++++
1361 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1362 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
1364 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
1366 btape.c:1090 Test with random data, should give the minimum throughput.
1367 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
1368 +++++++++++++++++++++++++++++++++++++++++++
1369 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
1370 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
1371 +++++++++++++++++++++++++++++++++++++++++++
1373 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
1377 When using compression, the random test will give your the minimum throughput
1378 of your drive . The test using constant string will give you the maximum speed
1379 of your hardware chain. (CPU, memory, SCSI card, cable, drive, tape).
1381 You can change the block size in the Storage Daemon configuration file.
1383 \subsection{New {\bf Block Checksum} Device Directive}
1384 You may now turn off the Block Checksum (CRC32) code
1385 that Bacula uses when writing blocks to a Volume. This is
1392 doing so can reduce the Storage daemon CPU usage slightly. It
1393 will also permit Bacula to read a Volume that has corrupted data.
1395 The default is {\bf yes} -- i.e. the checksum is computed on write
1396 and checked on read.
1398 We do not recommend to turn this off particularly on older tape
1399 drives or for disk Volumes where doing so may allow corrupted data
1402 \subsection{New Bat Features}
1404 Those new features were funded by Bacula Systems.
1406 \subsubsection{Media List View}
1408 By clicking on ``Media'', you can see the list of all your volumes. You will be
1409 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1410 in the table. The old ``Media'' view is now known as ``Pool''.
1411 \begin{figure}[htbp]
1413 \includegraphics[width=0.8\linewidth]{bat-mediaview}
1414 \label{fig:mediaview}
1418 \subsubsection{Media Information View}
1420 By double-clicking on a volume (on the Media list, in the Autochanger content
1421 or in the Job information panel), you can access a detailed overview of your
1422 Volume. (cf figure \vref{fig:mediainfo}.)
1423 \begin{figure}[htbp]
1425 \includegraphics[width=0.8\linewidth]{bat11}
1426 \caption{Media information}
1427 \label{fig:mediainfo}
1430 \subsubsection{Job Information View}
1432 By double-clicking on a Job record (on the Job run list or in the Media
1433 information panel), you can access a detailed overview of your Job. (cf
1434 figure \vref{fig:jobinfo}.)
1435 \begin{figure}[htbp]
1437 \includegraphics[width=0.8\linewidth]{bat12}
1438 \caption{Job information}
1442 \subsubsection{Autochanger Content View}
1444 By double-clicking on a Storage record (on the Storage list panel), you can
1445 access a detailed overview of your Autochanger. (cf figure \vref{fig:jobinfo}.)
1446 \begin{figure}[htbp]
1448 \includegraphics[width=0.8\linewidth]{bat13}
1449 \caption{Autochanger content}
1450 \label{fig:achcontent}
1453 To use this feature, you need to use the latest mtx-changer script
1454 version. (With new \texttt{listall} and \texttt{transfer} commands)
1456 \subsection{Bat on Windows}
1457 We have ported {\bf bat} to Windows and it is now installed
1458 by default when the installer is run. It works quite well
1459 on Win32, but has not had a lot of testing there, so your
1460 feedback would be welcome. Unfortunately, even though it is
1461 installed by default, it does not yet work on 64 bit Windows
1464 \subsection{New Win32 Installer}
1465 The Win32 installer has been modified in several very important
1468 \item You must deinstall any current version of the
1469 Win32 File daemon before upgrading to the new one.
1470 If you forget to do so, the new installation will fail.
1471 To correct this failure, you must manually shutdown
1472 and deinstall the old File daemon.
1473 \item All files (other than menu links) are installed
1474 in {\bf c:/Program Files/Bacula}.
1475 \item The installer no longer sets this
1476 file to require administrator privileges by default. If you want
1477 to do so, please do it manually using the {\bf cacls} program.
1480 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1482 \item The server daemons (Director and Storage daemon) are
1483 no longer included in the Windows installer. If you want the
1484 Windows servers, you will either need to build them yourself (note
1485 they have not been ported to 64 bits), or you can contact
1486 Bacula Systems about this.
1489 \subsection{Win64 Installer}
1490 We have corrected a number of problems that required manual
1491 editing of the conf files. In most cases, it should now
1492 install and work. {\bf bat} is by default installed in
1493 {\bf c:/Program Files/Bacula/bin32} rather than
1494 {\bf c:/Program Files/Bacula} as is the case with the 32
1495 bit Windows installer.
1497 \subsection{Linux Bare Metal Recovery USB Key}
1498 We have made a number of significant improvements in the
1499 Bare Metal Recovery USB key. Please see the README files
1500 it the {\bf rescue} release for more details.
1502 We are working on an equivalent USB key for Windows bare
1503 metal recovery, but it will take some time to develop it (best
1504 estimate 3Q2010 or 4Q2010)
1507 \subsection{bconsole Timeout Option}
1508 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1509 for commands. This is useful with GUI programs that use {\bf bconsole}
1510 to interface to the Director.
1512 \subsection{Important Changes}
1513 \label{sec:importantchanges}
1516 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1517 to the same Pool. The Storage daemon ensures that you do not read and
1518 write to the same Volume.
1519 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1521 \item Virtually all the features of {\bf mtx-changer} have
1522 now been parametrized, which allows you to configure
1523 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1524 that contains variables that you can set to configure mtx-changer.
1525 This configuration file will not be overwritten during upgrades.
1526 We encourage you to submit any changes
1527 that are made to mtx-changer and to parametrize it all in
1528 mtx-changer.conf so that all configuration will be done by
1529 changing only mtx-changer.conf.
1530 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1531 and \texttt{transfer}. Please configure them as appropriate
1532 in mtx-changer.conf.
1533 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1534 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1535 password. If you want to use the new script, you will need to
1536 manually change the \texttt{BackupCatalog} Job definition.
1537 \item The \texttt{bconsole} \texttt{help} command now accepts
1538 an argument, which if provided produces information on that
1539 command (ex: \texttt{help run}).
1543 \subsubsection*{Truncate volume after purge}
1545 Note that the Truncate Volume after purge feature doesn't work as expected
1546 in 5.0.0 version. Please, don't use it before version 5.0.1.
1548 \subsubsection{Custom Catalog queries}
1550 If you wish to add specialized commands that list the contents of the catalog,
1551 you can do so by adding them to the \texttt{query.sql} file. This
1552 \texttt{query.sql} file is now empty by default. The file
1553 \texttt{examples/sample-query.sql} has an a number of sample commands
1554 you might find useful.
1556 \subsubsection{Deprecated parts}
1558 The following items have been \textbf{deprecated} for a long time, and are now
1559 removed from the code.
1562 \item Support for SQLite 2
1565 \subsection{Misc Changes}
1566 \label{sec:miscchanges}
1569 \item Updated Nagios check\_bacula
1570 \item Updated man files
1571 \item Added OSX package generation script in platforms/darwin
1572 \item Added Spanish and Ukrainian Bacula translations
1573 \item Enable/disable command shows only Jobs that can change
1574 \item Added \texttt{show disabled} command to show disabled Jobs
1575 \item Many ACL improvements
1576 \item Added Level to FD status Job output
1577 \item Begin Ingres DB driver (not yet working)
1578 \item Split RedHat spec files into bacula, bat, mtx, and docs
1579 \item Reorganized the manuals (fewer separate manuals)
1580 \item Added lock/unlock order protection in lock manager
1581 \item Allow 64 bit sizes for a number of variables
1582 \item Fixed several deadlocks or potential race conditions in the SD
1585 \chapter{Released Version 3.0.3 and 3.0.3a}
1587 There are no new features in version 3.0.3. This version simply fixes a
1588 number of bugs found in version 3.0.2 during the ongoing development
1591 \section{New Features in Released Version 3.0.2}
1593 This chapter presents the new features added to the
1594 Released Bacula Version 3.0.2.
1596 \subsection{Full Restore from a Given JobId}
1597 \index[general]{Restore menu}
1599 This feature allows selecting a single JobId and having Bacula
1600 automatically select all the other jobs that comprise a full backup up to
1601 and including the selected date (through JobId).
1603 Assume we start with the following jobs:
1605 +-------+--------------+---------------------+-------+----------+------------+
1606 | jobid | client | starttime | level | jobfiles | jobbytes |
1607 +-------+--------------+---------------------+-------+----------+------------
1608 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1609 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1610 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1611 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1612 +-------+--------------+---------------------+-------+----------+------------+
1615 Below is an example of this new feature (which is number 12 in the
1620 To select the JobIds, you have the following choices:
1621 1: List last 20 Jobs run
1622 2: List Jobs where a given File is saved
1624 12: Select full restore to a specified Job date
1627 Select item: (1-13): 12
1628 Enter JobId to get the state to restore: 5
1629 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1630 You have selected the following JobIds: 1,3,5
1632 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1633 1,444 files inserted into the tree.
1636 This project was funded by Bacula Systems.
1638 \subsection{Source Address}
1639 \index[general]{Source Address}
1641 A feature has been added which allows the administrator to specify the address
1642 from which the Director and File daemons will establish connections. This
1643 may be used to simplify system configuration overhead when working in complex
1644 networks utilizing multi-homing and policy-routing.
1646 To accomplish this, two new configuration directives have been implemented:
1649 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1653 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1657 Simply adding specific host routes on the OS
1658 would have an undesirable side-effect: any
1659 application trying to contact the destination host would be forced to use the
1660 more specific route possibly diverting management traffic onto a backup VLAN.
1661 Instead of adding host routes for each client connected to a multi-homed backup
1662 server (for example where there are management and backup VLANs), one can
1663 use the new directives to specify a specific source address at the application
1666 Additionally, this allows the simplification and abstraction of firewall rules
1667 when dealing with a Hot-Standby director or storage daemon configuration. The
1668 Hot-standby pair may share a CARP address, which connections must be sourced
1669 from, while system services listen and act from the unique interface addresses.
1671 This project was funded by Collaborative Fusion, Inc.
1673 \subsection{Show volume availability when doing restore}
1675 When doing a restore the selection dialog ends by displaying this
1679 The job will require the following
1680 Volume(s) Storage(s) SD Device(s)
1681 ===========================================================================
1682 *000741L3 LTO-4 LTO3
1683 *000866L3 LTO-4 LTO3
1684 *000765L3 LTO-4 LTO3
1685 *000764L3 LTO-4 LTO3
1686 *000756L3 LTO-4 LTO3
1687 *001759L3 LTO-4 LTO3
1688 *001763L3 LTO-4 LTO3
1692 Volumes marked with ``*'' are online (in the autochanger).
1695 This should help speed up large restores by minimizing the time spent
1696 waiting for the operator to discover that he must change tapes in the library.
1698 This project was funded by Bacula Systems.
1700 \subsection{Accurate estimate command}
1702 The \texttt{estimate} command can now use the accurate code to detect changes
1703 and give a better estimation.
1705 You can set the accurate behavior on the command line by using
1706 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1709 * estimate listing accurate=yes level=incremental job=BackupJob
1712 This project was funded by Bacula Systems.
1714 \section{New Features in 3.0.0}
1715 \label{NewFeaturesChapter}
1716 \index[general]{New Features}
1718 This chapter presents the new features added to the development 2.5.x
1719 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1721 \subsection{Accurate Backup}
1722 \index[general]{Accurate Backup}
1724 As with most other backup programs, by default Bacula decides what files to
1725 backup for Incremental and Differential backup by comparing the change
1726 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1727 backup completed. If one of those two times is later than the last backup
1728 time, then the file will be backed up. This does not, however, permit tracking
1729 what files have been deleted and will miss any file with an old time that may
1730 have been restored to or moved onto the client filesystem.
1732 \subsubsection{Accurate = \lt{}yes\vb{}no\gt{}}
1733 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1734 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1735 backup, there is no difference, but for {\bf Differential} and {\bf
1736 Incremental} backups, the Director will send a list of all previous files
1737 backed up, and the File daemon will use that list to determine if any new files
1738 have been added or or moved and if any files have been deleted. This allows
1739 Bacula to make an accurate backup of your system to that point in time so that
1740 if you do a restore, it will restore your system exactly.
1743 about using Accurate backup is that it requires more resources (CPU and memory)
1744 on both the Director and the Client machines to create the list of previous
1745 files backed up, to send that list to the File daemon, for the File daemon to
1746 keep the list (possibly very big) in memory, and for the File daemon to do
1747 comparisons between every file in the FileSet and the list. In particular,
1748 if your client has lots of files (more than a few million), you will need
1749 lots of memory on the client machine.
1751 Accurate must not be enabled when backing up with a plugin that is not
1752 specially designed to work with Accurate. If you enable it, your restores
1753 will probably not work correctly.
1755 This project was funded by Bacula Systems.
1759 \subsection{Copy Jobs}
1760 \index[general]{Copy Jobs}
1762 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1763 existing Migration feature with the exception that the Job that is copied is
1764 left unchanged. This essentially creates two identical copies of the same
1765 backup. However, the copy is treated as a copy rather than a backup job, and
1766 hence is not directly available for restore. The {\bf restore} command lists
1767 copy jobs and allows selection of copies by using \texttt{jobid=}
1768 option. If the keyword {\bf copies} is present on the command line, Bacula will
1769 display the list of all copies for selected jobs.
1774 These JobIds have copies as follows:
1775 +-------+------------------------------------+-----------+------------------+
1776 | JobId | Job | CopyJobId | MediaType |
1777 +-------+------------------------------------+-----------+------------------+
1778 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1779 +-------+------------------------------------+-----------+------------------+
1780 +-------+-------+----------+----------+---------------------+------------------+
1781 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1782 +-------+-------+----------+----------+---------------------+------------------+
1783 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1784 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1785 +-------+-------+----------+----------+---------------------+------------------+
1786 You have selected the following JobIds: 19,2
1788 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1789 5,611 files inserted into the tree.
1794 The Copy Job runs without using the File daemon by copying the data from the
1795 old backup Volume to a different Volume in a different Pool. See the Migration
1796 documentation for additional details. For copy Jobs there is a new selection
1797 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1798 not already copied to another Pool.
1800 As with Migration, the Client, Volume, Job, or SQL query, are
1801 other possible ways of selecting the Jobs to be copied. Selection
1802 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1803 work, but are probably more suited for Migration Jobs.
1805 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1806 it will promote the Copy to a \textsl{real} backup job and will make it available for
1807 automatic restore. If more than one Copy is available, it will promote the copy
1808 with the smallest JobId.
1810 A nice solution which can be built with the new Copy feature is often
1811 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1812 look something like the one below:
1816 Name = FullBackupsVirtualPool
1818 Purge Oldest Volume = Yes
1820 NextPool = FullBackupsTapePool
1824 Name = FullBackupsTapePool
1828 Volume Retention = 365 days
1829 Storage = superloader
1833 # Fake fileset for copy jobs
1845 # Fake client for copy jobs
1855 # Default template for a CopyDiskToTape Job
1858 Name = CopyDiskToTape
1860 Messages = StandardCopy
1863 Selection Type = PoolUncopiedJobs
1864 Maximum Concurrent Jobs = 10
1866 Allow Duplicate Jobs = Yes
1867 Cancel Queued Duplicates = No
1868 Cancel Running Duplicates = No
1873 Name = DaySchedule7:00
1874 Run = Level=Full daily at 7:00
1878 Name = CopyDiskToTapeFullBackups
1880 Schedule = DaySchedule7:00
1881 Pool = FullBackupsVirtualPool
1882 JobDefs = CopyDiskToTape
1886 The example above had 2 pool which are copied using the PoolUncopiedJobs
1887 selection criteria. Normal Full backups go to the Virtual pool and are copied
1888 to the Tape pool the next morning.
1890 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1895 +-------+------------------------------------+-----------+------------------+
1896 | JobId | Job | CopyJobId | MediaType |
1897 +-------+------------------------------------+-----------+------------------+
1898 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1899 +-------+------------------------------------+-----------+------------------+
1902 \subsection{ACL Updates}
1903 \index[general]{ACL Updates}
1904 The whole ACL code had been overhauled and in this version each platforms has
1905 different streams for each type of acl available on such an platform. As ACLs
1906 between platforms tend to be not that portable (most implement POSIX acls but
1907 some use an other draft or a completely different format) we currently only
1908 allow certain platform specific ACL streams to be decoded and restored on the
1909 same platform that they were created on. The old code allowed to restore ACL
1910 cross platform but the comments already mention that not being to wise. For
1911 backward compatibility the new code will accept the two old ACL streams and
1912 handle those with the platform specific handler. But for all new backups it
1913 will save the ACLs using the new streams.
1915 Currently the following platforms support ACLs:
1919 \item {\bf Darwin/OSX}
1928 Currently we support the following ACL types (these ACL streams use a reserved
1929 part of the stream numbers):
1932 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1934 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1935 string representation from acl\_to\_text (POSIX acl)
1936 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1937 string representation from acl\_to\_text (POSIX acl) for default acls.
1938 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1939 string representation from acl\_to\_text (POSIX acl) for access acls.
1940 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1941 string representation from acltostr (POSIX acl)
1942 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1943 representation from acl\_to\_text (POSIX acl) for default acls.
1944 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1945 representation from acl\_to\_text (POSIX acl) for access acls.
1946 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1947 string representation from acl\_to\_text (POSIX acl) for default acls.
1948 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1949 representation from acl\_to\_text (POSIX acl) for access acls.
1950 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1951 string representation from acl\_to\_text (POSIX acl) for default acls.
1952 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1953 string representation from acl\_to\_text (POSIX acl) for default acls.
1954 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1955 representation from acl\_to\_text (POSIX acl) for access acls.
1956 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1957 string representation from acltotext or acl\_totext (POSIX acl)
1958 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1959 representation from from acl\_totext (NFSv4 or ZFS acl)
1962 In future versions we might support conversion functions from one type of acl
1963 into an other for types that are either the same or easily convertible. For now
1964 the streams are separate and restoring them on a platform that doesn't
1965 recognize them will give you a warning.
1967 \subsection{Extended Attributes}
1968 \index[general]{Extended Attributes}
1969 Something that was on the project list for some time is now implemented for
1970 platforms that support a similar kind of interface. Its the support for backup
1971 and restore of so called extended attributes. As extended attributes are so
1972 platform specific these attributes are saved in separate streams for each
1973 platform. Restores of the extended attributes can only be performed on the
1974 same platform the backup was done. There is support for all types of extended
1975 attributes, but restoring from one type of filesystem onto an other type of
1976 filesystem on the same platform may lead to surprises. As extended attributes
1977 can contain any type of data they are stored as a series of so called
1978 value-pairs. This data must be seen as mostly binary and is stored as such.
1979 As security labels from selinux are also extended attributes this option also
1980 stores those labels and no specific code is enabled for handling selinux
1983 Currently the following platforms support extended attributes:
1985 \item {\bf Darwin/OSX}
1991 On Linux acls are also extended attributes, as such when you enable ACLs on a
1992 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1993 and not the same extended attribute.
1995 To enable the backup of extended attributes please add the following to your
2010 \subsection{Shared objects}
2011 \index[general]{Shared objects}
2012 A default build of Bacula will now create the libraries as shared objects
2013 (.so) rather than static libraries as was previously the case.
2014 The shared libraries are built using {\bf libtool} so it should be quite
2017 An important advantage of using shared objects is that on a machine with the
2018 Directory, File daemon, the Storage daemon, and a console, you will have only
2019 one copy of the code in memory rather than four copies. Also the total size of
2020 the binary release is smaller since the library code appears only once rather
2021 than once for every program that uses it; this results in significant reduction
2022 in the size of the binaries particularly for the utility tools.
2024 In order for the system loader to find the shared objects when loading the
2025 Bacula binaries, the Bacula shared objects must either be in a shared object
2026 directory known to the loader (typically /usr/lib) or they must be in the
2027 directory that may be specified on the {\bf ./configure} line using the {\bf
2028 {-}{-}libdir} option as:
2031 ./configure --libdir=/full-path/dir
2034 the default is /usr/lib. If {-}{-}libdir is specified, there should be
2035 no need to modify your loader configuration provided that
2036 the shared objects are installed in that directory (Bacula
2037 does this with the make install command). The shared objects
2038 that Bacula references are:
2047 These files are symbolically linked to the real shared object file,
2048 which has a version number to permit running multiple versions of
2049 the libraries if desired (not normally the case).
2051 If you have problems with libtool or you wish to use the old
2052 way of building static libraries, or you want to build a static
2053 version of Bacula you may disable
2054 libtool on the configure command line with:
2057 ./configure --disable-libtool
2061 \subsection{Building Static versions of Bacula}
2062 \index[general]{Static linking}
2063 In order to build static versions of Bacula, in addition
2064 to configuration options that were needed you now must
2065 also add --disable-libtool. Example
2068 ./configure --enable-static-client-only --disable-libtool
2072 \subsection{Virtual Backup (Vbackup)}
2073 \index[general]{Virtual Backup}
2074 \index[general]{Vbackup}
2076 Bacula's virtual backup feature is often called Synthetic Backup or
2077 Consolidation in other backup products. It permits you to consolidate the
2078 previous Full backup plus the most recent Differential backup and any
2079 subsequent Incremental backups into a new Full backup. This new Full
2080 backup will then be considered as the most recent Full for any future
2081 Incremental or Differential backups. The VirtualFull backup is
2082 accomplished without contacting the client by reading the previous backup
2083 data and writing it to a volume in a different pool.
2085 In some respects the Vbackup feature works similar to a Migration job, in
2086 that Bacula normally reads the data from the pool specified in the
2087 Job resource, and writes it to the {\bf Next Pool} specified in the
2088 Job resource. Note, this means that usually the output from the Virtual
2089 Backup is written into a different pool from where your prior backups
2090 are saved. Doing it this way guarantees that you will not get a deadlock
2091 situation attempting to read and write to the same volume in the Storage
2092 daemon. If you then want to do subsequent backups, you may need to
2093 move the Virtual Full Volume back to your normal backup pool.
2094 Alternatively, you can set your {\bf Next Pool} to point to the current
2095 pool. This will cause Bacula to read and write to Volumes in the
2096 current pool. In general, this will work, because Bacula will
2097 not allow reading and writing on the same Volume. In any case, once
2098 a VirtualFull has been created, and a restore is done involving the
2099 most current Full, it will read the Volume or Volumes by the VirtualFull
2100 regardless of in which Pool the Volume is found.
2102 The Vbackup is enabled on a Job by Job in the Job resource by specifying
2103 a level of {\bf VirtualFull}.
2105 A typical Job resource definition might look like the following:
2112 FileSet = "Full Set"
2119 # Default pool definition
2123 Recycle = yes # Automatically recycle Volumes
2124 AutoPrune = yes # Prune expired volumes
2125 Volume Retention = 365d # one year
2133 Recycle = yes # Automatically recycle Volumes
2134 AutoPrune = yes # Prune expired volumes
2135 Volume Retention = 365d # one year
2136 Storage = DiskChanger
2139 # Definition of file storage device
2144 Device = FileStorage
2146 Maximum Concurrent Jobs = 5
2149 # Definition of DDS Virtual tape disk storage device
2152 Address = localhost # N.B. Use a fully qualified name here
2154 Device = DiskChanger
2155 Media Type = DiskChangerMedia
2156 Maximum Concurrent Jobs = 4
2161 Then in bconsole or via a Run schedule, you would run the job as:
2164 run job=MyBackup level=Full
2165 run job=MyBackup level=Incremental
2166 run job=MyBackup level=Differential
2167 run job=MyBackup level=Incremental
2168 run job=MyBackup level=Incremental
2171 So providing there were changes between each of those jobs, you would end up
2172 with a Full backup, a Differential, which includes the first Incremental
2173 backup, then two Incremental backups. All the above jobs would be written to
2174 the {\bf Default} pool.
2176 To consolidate those backups into a new Full backup, you would run the
2180 run job=MyBackup level=VirtualFull
2183 And it would produce a new Full backup without using the client, and the output
2184 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
2186 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
2189 Note, the Start and End time of the Virtual Full backup is set to the
2190 values for the last job included in the Virtual Full (in the above example,
2191 it is an Increment). This is so that if another incremental is done, which
2192 will be based on the Virtual Full, it will backup all files from the
2193 last Job included in the Virtual Full rather than from the time the Virtual
2194 Full was actually run.
2198 \subsection{Catalog Format}
2199 \index[general]{Catalog Format}
2200 Bacula 3.0 comes with some changes to the catalog format. The upgrade
2201 operation will convert the FileId field of the File table from 32 bits (max 4
2202 billion table entries) to 64 bits (very large number of items). The
2203 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
2204 your catalog during the conversion. Also you won't be able to run jobs during
2205 this conversion period. For example, a 3 million file catalog will take 2
2206 minutes to upgrade on a normal machine. Please don't forget to make a valid
2207 backup of your database before executing the upgrade script. See the
2208 ReleaseNotes for additional details.
2210 \subsection{64 bit Windows Client}
2211 \index[general]{Win64 Client}
2212 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
2213 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
2214 As a consequence, we are also releasing a 64 bit version of the Bacula
2215 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
2216 These binaries should only be installed on 64 bit Windows operating systems.
2217 What is important is not your hardware but whether or not you have
2218 a 64 bit version of the Windows OS.
2220 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
2222 \item Before installing the Win64 Bacula Client, you must totally
2223 deinstall any prior 2.4.x Client installation using the
2224 Bacula deinstallation (see the menu item). You may want
2225 to save your .conf files first.
2226 \item Only the Client (File daemon) is ported to Win64, the Director
2227 and the Storage daemon are not in the 64 bit Windows installer.
2228 \item bwx-console is not yet ported.
2229 \item bconsole is ported but it has not been tested.
2230 \item The documentation is not included in the installer.
2231 \item Due to Vista security restrictions imposed on a default installation
2232 of Vista, before upgrading the Client, you must manually stop
2233 any prior version of Bacula from running, otherwise the install
2235 \item Due to Vista security restrictions imposed on a default installation
2236 of Vista, attempting to edit the conf files via the menu items
2237 will fail. You must directly edit the files with appropriate
2238 permissions. Generally double clicking on the appropriate .conf
2239 file will work providing you have sufficient permissions.
2240 \item All Bacula files are now installed in
2241 {\bf C:/Program Files/Bacula} except the main menu items,
2242 which are installed as before. This vastly simplifies the installation.
2243 \item If you are running on a foreign language version of Windows, most
2244 likely {\bf C:/Program Files} does not exist, so you should use the
2245 Custom installation and enter an appropriate location to install
2247 \item The 3.0.0 Win32 Client continues to install files in the locations used
2248 by prior versions. For the next version we will convert it to use
2249 the same installation conventions as the Win64 version.
2252 This project was funded by Bacula Systems.
2255 \subsection{Duplicate Job Control}
2256 \index[general]{Duplicate Jobs}
2257 The new version of Bacula provides four new directives that
2258 give additional control over what Bacula does if duplicate jobs
2259 are started. A duplicate job in the sense we use it here means
2260 a second or subsequent job with the same name starts. This
2261 happens most frequently when the first job runs longer than expected because no
2262 tapes are available.
2264 The four directives each take as an argument a {\bf yes} or {\bf no} value and
2265 are specified in the Job resource.
2269 \subsubsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
2270 \index[general]{Allow Duplicate Jobs}
2271 If this directive is set to {\bf yes}, duplicate jobs will be run. If
2272 the directive is set to {\bf no} (default) then only one job of a given name
2273 may run at one time, and the action that Bacula takes to ensure only
2274 one job runs is determined by the other directives (see below).
2276 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
2277 are present and none of the three directives given below permit
2278 Canceling a job, then the current job (the second one started)
2281 \subsubsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
2282 \index[general]{Allow Higher Duplicates}
2283 This directive was in version 5.0.0, but does not work as
2284 expected. If used, it should always be set to no. In later versions
2285 of Bacula the directive is disabled (disregarded).
2287 \subsubsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
2288 \index[general]{Cancel Running Duplicates}
2289 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
2290 if this directive is set to {\bf yes} any job that is already running
2291 will be canceled. The default is {\bf no}.
2293 \subsubsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
2294 \index[general]{Cancel Queued Duplicates}
2295 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
2296 if this directive is set to {\bf yes} any job that is
2297 already queued to run but not yet running will be canceled.
2298 The default is {\bf no}.
2301 \subsection{TLS Authentication}
2302 \index[general]{TLS Authentication}
2303 In Bacula version 2.5.x and later, in addition to the normal Bacula
2304 CRAM-MD5 authentication that is used to authenticate each Bacula
2305 connection, you can specify that you want TLS Authentication as well,
2306 which will provide more secure authentication.
2308 This new feature uses Bacula's existing TLS code (normally used for
2309 communications encryption) to do authentication. To use it, you must
2310 specify all the TLS directives normally used to enable communications
2311 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
2314 \subsubsection{TLS Authenticate = yes}
2316 TLS Authenticate = yes
2319 in the main daemon configuration resource (Director for the Director,
2320 Client for the File daemon, and Storage for the Storage daemon).
2322 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
2323 authentication, Bacula will also do TLS authentication, then TLS
2324 encryption will be turned off, and the rest of the communication between
2325 the two Bacula daemons will be done without encryption.
2327 If you want to encrypt communications data, use the normal TLS directives
2328 but do not turn on {\bf TLS Authenticate}.
2330 \subsection{bextract non-portable Win32 data}
2331 \index[general]{bextract handles Win32 non-portable data}
2332 {\bf bextract} has been enhanced to be able to restore
2333 non-portable Win32 data to any OS. Previous versions were
2334 unable to restore non-portable Win32 data to machines that
2335 did not have the Win32 BackupRead and BackupWrite API calls.
2337 \subsection{State File updated at Job Termination}
2338 \index[general]{State File}
2339 In previous versions of Bacula, the state file, which provides a
2340 summary of previous jobs run in the {\bf status} command output was
2341 updated only when Bacula terminated, thus if the daemon crashed, the
2342 state file might not contain all the run data. This version of
2343 the Bacula daemons updates the state file on each job termination.
2345 \subsection{MaxFullInterval = \lt{}time-interval\gt{}}
2346 \index[general]{MaxFullInterval}
2347 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
2348 can be used to specify the maximum time interval between {\bf Full} backup
2349 jobs. When a job starts, if the time since the last Full backup is
2350 greater than the specified interval, and the job would normally be an
2351 {\bf Incremental} or {\bf Differential}, it will be automatically
2352 upgraded to a {\bf Full} backup.
2354 \subsection{MaxDiffInterval = \lt{}time-interval\gt{}}
2355 \index[general]{MaxDiffInterval}
2356 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
2357 can be used to specify the maximum time interval between {\bf Differential} backup
2358 jobs. When a job starts, if the time since the last Differential backup is
2359 greater than the specified interval, and the job would normally be an
2360 {\bf Incremental}, it will be automatically
2361 upgraded to a {\bf Differential} backup.
2363 \subsection{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
2364 \index[general]{MaxDiffInterval}
2365 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
2366 by the user, and when it is set it is an indication to backup programs
2367 to not backup that particular file. This version of Bacula contains a
2368 new Options directive within a FileSet resource, which instructs Bacula to
2369 obey this flag. The new directive is:
2372 Honor No Dump Flag = yes\vb{}no
2375 The default value is {\bf no}.
2378 \subsection{Exclude Dir Containing = \lt{}filename-string\gt{}}
2379 \index[general]{IgnoreDir}
2380 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
2381 can be added to the Include section of the FileSet resource. If the specified
2382 filename ({\bf filename-string}) is found on the Client in any directory to be
2383 backed up, the whole directory will be ignored (not backed up). For example:
2386 # List of files to be backed up
2394 Exclude Dir Containing = .excludeme
2399 But in /home, there may be hundreds of directories of users and some
2400 people want to indicate that they don't want to have certain
2401 directories backed up. For example, with the above FileSet, if
2402 the user or sysadmin creates a file named {\bf .excludeme} in
2403 specific directories, such as
2406 /home/user/www/cache/.excludeme
2407 /home/user/temp/.excludeme
2410 then Bacula will not backup the two directories named:
2413 /home/user/www/cache
2417 NOTE: subdirectories will not be backed up. That is, the directive
2418 applies to the two directories in question and any children (be they
2419 files, directories, etc).
2422 \subsection{Bacula Plugins}
2423 \index[general]{Plugin}
2424 Support for shared object plugins has been implemented in the Linux, Unix
2425 and Win32 File daemons. The API will be documented separately in
2426 the Developer's Guide or in a new document. For the moment, there is
2427 a single plugin named {\bf bpipe} that allows an external program to
2428 get control to backup and restore a file.
2430 Plugins are also planned (partially implemented) in the Director and the
2433 \subsubsection{Plugin Directory}
2434 \index[general]{Plugin Directory}
2435 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2436 be added to the daemon definition resource. The directory takes a quoted
2437 string argument, which is the name of the directory in which the daemon can
2438 find the Bacula plugins. If this directive is not specified, Bacula will not
2439 load any plugins. Since each plugin has a distinctive name, all the daemons
2440 can share the same plugin directory.
2442 \subsubsection{Plugin Options}
2443 \index[general]{Plugin Options}
2444 The {\bf Plugin Options} directive takes a quoted string
2445 argument (after the equal sign) and may be specified in the
2446 Job resource. The options specified will be passed to all plugins
2447 when they are run. This each plugin must know what it is looking
2448 for. The value defined in the Job resource can be modified
2449 by the user when he runs a Job via the {\bf bconsole} command line
2452 Note: this directive may be specified, and there is code to modify
2453 the string in the run command, but the plugin options are not yet passed to
2454 the plugin (i.e. not fully implemented).
2456 \subsubsection{Plugin Options ACL}
2457 \index[general]{Plugin Options ACL}
2458 The {\bf Plugin Options ACL} directive may be specified in the
2459 Director's Console resource. It functions as all the other ACL commands
2460 do by permitting users running restricted consoles to specify a
2461 {\bf Plugin Options} that overrides the one specified in the Job
2462 definition. Without this directive restricted consoles may not modify
2465 \subsubsection{Plugin = \lt{}plugin-command-string\gt{}}
2466 \index[general]{Plugin}
2467 The {\bf Plugin} directive is specified in the Include section of
2468 a FileSet resource where you put your {\bf File = xxx} directives.
2479 Plugin = "bpipe:..."
2484 In the above example, when the File daemon is processing the directives
2485 in the Include section, it will first backup all the files in {\bf /home}
2486 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2487 the Plugin Directory. The syntax and semantics of the Plugin directive
2488 require the first part of the string up to the colon (:) to be the name
2489 of the plugin. Everything after the first colon is ignored by the File daemon but
2490 is passed to the plugin. Thus the plugin writer may define the meaning of the
2491 rest of the string as he wishes.
2493 Please see the next section for information about the {\bf bpipe} Bacula
2496 \subsection{The bpipe Plugin}
2497 \index[general]{The bpipe Plugin}
2498 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2499 the Bacula source distribution. When the plugin is compiled and linking into
2500 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2501 Please note that this is a very simple plugin that was written for
2502 demonstration and test purposes. It is and can be used in production, but
2503 that was never really intended.
2505 The purpose of the plugin is to provide an interface to any system program for
2506 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2507 the Include section of your Job's FileSet resource. The full syntax of the
2508 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2509 to specify the sytax as it wishes) is:
2512 Plugin = "<field1>:<field2>:<field3>:<field4>"
2517 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2518 stripped off, so in this case, we would put {\bf bpipe} in this field.
2520 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2521 pseudo path and filename under which the backup will be saved. This pseudo
2522 path and filename will be seen by the user in the restore file tree.
2523 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2524 backed up by the plugin will be put under that "pseudo" path and filename.
2525 You must be careful to choose a naming convention that is unique to avoid
2526 a conflict with a path and filename that actually exists on your system.
2528 \item {\bf field3} for the {\bf bpipe} plugin
2529 specifies the "reader" program that is called by the plugin during
2530 backup to read the data. {\bf bpipe} will call this program by doing a
2533 \item {\bf field4} for the {\bf bpipe} plugin
2534 specifies the "writer" program that is called by the plugin during
2535 restore to write the data back to the filesystem.
2538 Please note that for two items above describing the "reader" and "writer"
2539 fields, these programs are "executed" by Bacula, which
2540 means there is no shell interpretation of any command line arguments
2541 you might use. If you want to use shell characters (redirection of input
2542 or output, ...), then we recommend that you put your command or commands
2543 in a shell script and execute the script. In addition if you backup a
2544 file with the reader program, when running the writer program during
2545 the restore, Bacula will not automatically create the path to the file.
2546 Either the path must exist, or you must explicitly do so with your command
2547 or in a shell script.
2549 Putting it all together, the full plugin directive line might look
2553 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2554 --opt --databases bacula:mysql"
2557 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2558 would be written on a single line.
2560 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2561 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2562 program {\bf mysqldump -f --opt --database bacula} to read the data during
2563 backup. The mysqldump command outputs all the data for the database named
2564 {\bf bacula}, which will be read by the plugin and stored in the backup.
2565 During restore, the data that was backed up will be sent to the program
2566 specified in the last field, which in this case is {\bf mysql}. When
2567 {\bf mysql} is called, it will read the data sent to it by the plugn
2568 then write it back to the same database from which it came ({\bf bacula}
2571 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2572 the data from a specified program to Bacula for backup, and then from Bacula to
2573 a specified program for restore.
2575 By using different command lines to {\bf bpipe},
2576 you can backup any kind of data (ASCII or binary) depending
2577 on the program called.
2579 \subsection{Microsoft Exchange Server 2003/2007 Plugin}
2580 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2581 \subsubsection{Background}
2582 The Exchange plugin was made possible by a funded development project
2583 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2584 The code for the plugin was written by James Harper, and the Bacula core
2585 code by Kern Sibbald. All the code for this funded development has become
2586 part of the Bacula project. Thanks to everyone who made it happen.
2588 \subsubsection{Concepts}
2589 Although it is possible to backup Exchange using Bacula VSS the Exchange
2590 plugin adds a good deal of functionality, because while Bacula VSS
2591 completes a full backup (snapshot) of Exchange, it does
2592 not support Incremental or Differential backups, restoring is more
2593 complicated, and a single database restore is not possible.
2595 Microsoft Exchange organises its storage into Storage Groups with
2596 Databases inside them. A default installation of Exchange will have a
2597 single Storage Group called 'First Storage Group', with two Databases
2598 inside it, "Mailbox Store (SERVER NAME)" and
2599 "Public Folder Store (SERVER NAME)",
2600 which hold user email and public folders respectively.
2602 In the default configuration, Exchange logs everything that happens to
2603 log files, such that if you have a backup, and all the log files since,
2604 you can restore to the present time. Each Storage Group has its own set
2605 of log files and operates independently of any other Storage Groups. At
2606 the Storage Group level, the logging can be turned off by enabling a
2607 function called "Enable circular logging". At this time the Exchange
2608 plugin will not function if this option is enabled.
2610 The plugin allows backing up of entire storage groups, and the restoring
2611 of entire storage groups or individual databases. Backing up and
2612 restoring at the individual mailbox or email item is not supported but
2613 can be simulated by use of the "Recovery" Storage Group (see below).
2615 \subsubsection{Installing}
2616 The Exchange plugin requires a DLL that is shipped with Microsoft
2617 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2618 correctly the Exchange plugin should find this automatically and run
2619 without any additional installation.
2621 If the DLL can not be found automatically it will need to be copied into
2622 the Bacula installation
2623 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2624 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2625 default Exchange installation.
2627 \subsubsection{Backing Up}
2628 To back up an Exchange server the Fileset definition must contain at
2629 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2630 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2631 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2632 up files are prefixed with something that isn't going to share a name
2633 with something outside the plugin, and the 'Microsoft Information Store'
2634 bit is required also. It is also possible to add the name of a storage
2635 group to the "Plugin =" line, eg \\
2636 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2637 if you want only a single storage group backed up.
2639 Additionally, you can suffix the 'Plugin =' directive with
2640 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2641 database at the end of a full backup.
2643 An Incremental or Differential backup will backup only the database logs
2644 for each Storage Group by inspecting the "modified date" on each
2645 physical log file. Because of the way the Exchange API works, the last
2646 logfile backed up on each backup will always be backed up by the next
2647 Incremental or Differential backup too. This adds 5MB to each
2648 Incremental or Differential backup size but otherwise does not cause any
2651 By default, a normal VSS fileset containing all the drive letters will
2652 also back up the Exchange databases using VSS. This will interfere with
2653 the plugin and Exchange's shared ideas of when the last full backup was
2654 done, and may also truncate log files incorrectly. It is important,
2655 therefore, that the Exchange database files be excluded from the backup,
2656 although the folders the files are in should be included, or they will
2657 have to be recreated manually if a bare metal restore is done.
2662 File = C:/Program Files/Exchsrvr/mdbdata
2663 Plugin = "exchange:..."
2666 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2667 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2668 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2669 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2670 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2671 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2672 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2677 The advantage of excluding the above files is that you can significantly
2678 reduce the size of your backup since all the important Exchange files
2679 will be properly saved by the Plugin.
2682 \subsubsection{Restoring}
2683 The restore operation is much the same as a normal Bacula restore, with
2684 the following provisos:
2687 \item The {\bf Where} restore option must not be specified
2688 \item Each Database directory must be marked as a whole. You cannot just
2689 select (say) the .edb file and not the others.
2690 \item If a Storage Group is restored, the directory of the Storage Group
2692 \item It is possible to restore only a subset of the available log files,
2693 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2694 if a log file is missing from the sequence of log files
2695 \item Each database to be restored must be dismounted and marked as "Can be
2696 overwritten by restore"
2697 \item If an entire Storage Group is to be restored (eg all databases and
2698 logs in the Storage Group), then it is best to manually delete the
2699 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2700 as Exchange can get confused by stray log files lying around.
2703 \subsubsection{Restoring to the Recovery Storage Group}
2704 The concept of the Recovery Storage Group is well documented by
2706 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2707 but to briefly summarize...
2709 Microsoft Exchange allows the creation of an additional Storage Group
2710 called the Recovery Storage Group, which is used to restore an older
2711 copy of a database (e.g. before a mailbox was deleted) into without
2712 messing with the current live data. This is required as the Standard and
2713 Small Business Server versions of Exchange can not ordinarily have more
2714 than one Storage Group.
2716 To create the Recovery Storage Group, drill down to the Server in Exchange
2717 System Manager, right click, and select
2718 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2719 locations and click OK. On the Recovery Storage Group, right click and
2720 select {\bf "Add Database to Recover..."} and select the database you will
2723 Restore only the single database nominated as the database in the
2724 Recovery Storage Group. Exchange will redirect the restore to the
2725 Recovery Storage Group automatically.
2726 Then run the restore.
2728 \subsubsection{Restoring on Microsoft Server 2007}
2729 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2730 2007, and hence you use a new procedure for recovering a single mail box.
2731 This procedure is documented by Microsoft at:
2732 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2733 and involves using the {\bf Restore-Mailbox} and {\bf
2734 Get-Mailbox Statistics} shell commands.
2736 \subsubsection{Caveats}
2737 This plugin is still being developed, so you should consider it
2738 currently in BETA test, and thus use in a production environment
2739 should be done only after very careful testing.
2741 When doing a full backup, the Exchange database logs are truncated by
2742 Exchange as soon as the plugin has completed the backup. If the data
2743 never makes it to the backup medium (eg because of spooling) then the
2744 logs will still be truncated, but they will also not have been backed
2745 up. A solution to this is being worked on. You will have to schedule a
2746 new Full backup to ensure that your next backups will be usable.
2748 The "Enable Circular Logging" option cannot be enabled or the plugin
2751 Exchange insists that a successful Full backup must have taken place if
2752 an Incremental or Differential backup is desired, and the plugin will
2753 fail if this is not the case. If a restore is done, Exchange will
2754 require that a Full backup be done before an Incremental or Differential
2757 The plugin will most likely not work well if another backup application
2758 (eg NTBACKUP) is backing up the Exchange database, especially if the
2759 other backup application is truncating the log files.
2761 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2762 we recommend either carefully testing or that you avoid this option for
2765 The Exchange plugin is not called during processing the bconsole {\bf
2766 estimate} command, and so anything that would be backed up by the plugin
2767 will not be added to the estimate total that is displayed.
2770 \subsection{libdbi Framework}
2771 \index[general]{libdbi Framework}
2772 As a general guideline, Bacula has support for a few catalog database drivers
2773 (MySQL, PostgreSQL, SQLite)
2774 coded natively by the Bacula team. With the libdbi implementation, which is a
2775 Bacula driver that uses libdbi to access the catalog, we have an open field to
2776 use many different kinds database engines following the needs of users.
2778 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2779 implements a database-independent abstraction layer in C, similar to the
2780 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2781 leverage the power of multiple databases and multiple simultaneous database
2782 connections by using this framework.
2784 Currently the libdbi driver in Bacula project only supports the same drivers
2785 natively coded in Bacula. However the libdbi project has support for many
2786 others database engines. You can view the list at
2787 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2788 supported by Bacula, however, they must be tested properly by the Bacula team.
2790 Some of benefits of using libdbi are:
2792 \item The possibility to use proprietary databases engines in which your
2793 proprietary licenses prevent the Bacula team from developing the driver.
2794 \item The possibility to use the drivers written for the libdbi project.
2795 \item The possibility to use other database engines without recompiling Bacula
2796 to use them. Just change one line in bacula-dir.conf
2797 \item Abstract Database access, this is, unique point to code and profiling
2798 catalog database access.
2801 The following drivers have been tested:
2803 \item PostgreSQL, with and without batch insert
2804 \item Mysql, with and without batch insert
2809 In the future, we will test and approve to use others databases engines
2810 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2812 To compile Bacula to support libdbi we need to configure the code with the
2813 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2814 [database] is the database engine to be used with Bacula (of course we can
2815 change the driver in file bacula-dir.conf, see below). We must configure the
2816 access port of the database engine with the option --with-db-port, because the
2817 libdbi framework doesn't know the default access port of each database.
2819 The next phase is checking (or configuring) the bacula-dir.conf, example:
2823 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2824 dbname = regress; user = regress; password = ""
2828 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2829 mysql database. Currently the drivers supported by Bacula are: postgresql,
2830 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2832 The following limitations apply when Bacula is set to use the libdbi framework:
2833 - Not tested on the Win32 platform
2834 - A little performance is lost if comparing with native database driver.
2835 The reason is bound with the database driver provided by libdbi and the
2836 simple fact that one more layer of code was added.
2838 It is important to remember, when compiling Bacula with libdbi, the
2839 following packages are needed:
2841 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2842 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2845 You can download them and compile them on your system or install the packages
2846 from your OS distribution.
2848 \subsection{Console Command Additions and Enhancements}
2849 \index[general]{Console Additions}
2851 \subsubsection{Display Autochanger Content}
2852 \index[general]{StatusSlots}
2854 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2855 autochanger content.
2859 Slot | Volume Name | Status | Media Type | Pool |
2860 ------+---------------+----------+-------------------+------------|
2861 1 | 00001 | Append | DiskChangerMedia | Default |
2862 2 | 00002 | Append | DiskChangerMedia | Default |
2863 3*| 00003 | Append | DiskChangerMedia | Scratch |
2868 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2869 {\bf update slots} command to synchronize autochanger content with your
2872 \subsubsection{list joblog job=xxx or jobid=nnn}
2873 \index[general]{list joblog}
2874 A new list command has been added that allows you to list the contents
2875 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2876 or for a particular JobId. The {\bf llist} command will include a line with
2877 the time and date of the entry.
2879 Note for the catalog to have Job Log entries, you must have a directive
2886 In your Director's {\bf Messages} resource.
2888 \subsubsection{Use separator for multiple commands}
2889 \index[general]{Command Separator}
2890 When using bconsole with readline, you can set the command separator with
2891 \textbf{@separator} command to one
2892 of those characters to write commands who require multiple input in one line.
2894 !$%&'()*+,-/:;<>?[]^`{|}~
2897 \subsubsection{Deleting Volumes}
2898 The delete volume bconsole command has been modified to
2899 require an asterisk (*) in front of a MediaId otherwise the
2900 value you enter is a taken to be a Volume name. This is so that
2901 users may delete numeric Volume names. The previous Bacula versions
2902 assumed that all input that started with a number was a MediaId.
2904 This new behavior is indicated in the prompt if you read it
2907 \subsection{Bare Metal Recovery}
2908 The old bare metal recovery project is essentially dead. One
2909 of the main features of it was that it would build a recovery
2910 CD based on the kernel on your system. The problem was that
2911 every distribution has a different boot procedure and different
2912 scripts, and worse yet, the boot procedures and scripts change
2913 from one distribution to another. This meant that maintaining
2914 (keeping up with the changes) the rescue CD was too much work.
2916 To replace it, a new bare metal recovery USB boot stick has been developed
2917 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2918 boot from a USB key.
2922 \item Recovery can be done from within graphical environment.
2923 \item Recovery can be done in a shell.
2924 \item Ubuntu boots on a large number of Linux systems.
2925 \item The process of updating the system and adding new
2926 packages is not too difficult.
2927 \item The USB key can easily be upgraded to newer Ubuntu versions.
2928 \item The USB key has writable partitions for modifications to
2929 the OS and for modification to your home directory.
2930 \item You can add new files/directories to the USB key very easily.
2931 \item You can save the environment from multiple machines on
2933 \item Bacula Systems is funding its ongoing development.
2936 The disadvantages are:
2938 \item The USB key is usable but currently under development.
2939 \item Not everyone may be familiar with Ubuntu (no worse
2941 \item Some older OSes cannot be booted from USB. This can
2942 be resolved by first booting a Ubuntu LiveCD then plugging
2944 \item Currently the documentation is sketchy and not yet added
2945 to the main manual. See below ...
2948 The documentation and the code can be found in the {\bf rescue} package
2949 in the directory {\bf linux/usb}.
2951 \subsection{Miscellaneous}
2952 \index[general]{Misc New Features}
2954 \subsubsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2955 \index[general]{Allow Mixed Priority}
2956 This directive is only implemented in version 2.5 and later. When
2957 set to {\bf yes} (default {\bf no}), this job may run even if lower
2958 priority jobs are already running. This means a high priority job
2959 will not have to wait for other jobs to finish before starting.
2960 The scheduler will only mix priorities when all running jobs have
2963 Note that only higher priority jobs will start early. Suppose the
2964 director will allow two concurrent jobs, and that two jobs with
2965 priority 10 are running, with two more in the queue. If a job with
2966 priority 5 is added to the queue, it will be run as soon as one of
2967 the running jobs finishes. However, new priority 10 jobs will not
2968 be run until the priority 5 job has finished.
2970 \subsubsection{Bootstrap File Directive -- FileRegex}
2971 \index[general]{Bootstrap File Directive}
2972 {\bf FileRegex} is a new command that can be added to the bootstrap
2973 (.bsr) file. The value is a regular expression. When specified, only
2974 matching filenames will be restored.
2976 During a restore, if all File records are pruned from the catalog
2977 for a Job, normally Bacula can restore only all files saved. That
2978 is there is no way using the catalog to select individual files.
2979 With this new feature, Bacula will ask if you want to specify a Regex
2980 expression for extracting only a part of the full backup.
2983 Building directory tree for JobId(s) 1,3 ...
2984 There were no files inserted into the tree, so file selection
2985 is not possible.Most likely your retention policy pruned the files
2987 Do you want to restore all the files? (yes\vb{}no): no
2989 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2990 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2993 \subsubsection{Bootstrap File Optimization Changes}
2994 In order to permit proper seeking on disk files, we have extended the bootstrap
2995 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2996 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2997 address range and end address range respectively. These two directives replace
2998 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2999 VolEndBlock} directives. Bootstrap files containing the old directives will
3000 still work, but will not properly take advantage of proper disk seeking, and
3001 may read completely to the end of a disk volume during a restore. With the new
3002 format (automatically generated by the new Director), restores will seek
3003 properly and stop reading the volume when all the files have been restored.
3005 \subsubsection{Solaris ZFS/NFSv4 ACLs}
3006 This is an upgrade of the previous Solaris ACL backup code
3007 to the new library format, which will backup both the old
3008 POSIX(UFS) ACLs as well as the ZFS ACLs.
3010 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
3011 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
3012 be used to transfer from UFS to ZFS filesystems.
3015 \subsubsection{Virtual Tape Emulation}
3016 \index[general]{Virtual Tape Emulation}
3017 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
3018 the tape code but actually reading and writing to a disk file. Used with the
3019 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
3020 and 700 slots. This feature is most useful in testing. It is enabled
3021 by using {\bf Device Type = vtape} in the Storage daemon's Device
3022 directive. This feature is only implemented on Linux machines and should not be
3023 used for production.
3025 \subsubsection{Bat Enhancements}
3026 \index[general]{Bat Enhancements}
3027 Bat (the Bacula Administration Tool) GUI program has been significantly
3028 enhanced and stabilized. In particular, there are new table based status
3029 commands; it can now be easily localized using Qt4 Linguist.
3031 The Bat communications protocol has been significantly enhanced to improve
3032 GUI handling. Note, you {\bf must} use a the bat that is distributed with
3033 the Director you are using otherwise the communications protocol will not
3036 \subsubsection{RunScript Enhancements}
3037 \index[general]{RunScript Enhancements}
3038 The {\bf RunScript} resource has been enhanced to permit multiple
3039 commands per RunScript. Simply specify multiple {\bf Command} directives
3046 Command = "/bin/echo test"
3047 Command = "/bin/echo an other test"
3048 Command = "/bin/echo 3 commands in the same runscript"
3055 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
3056 implemented, which runs the command after the Volume Shadow Copy has been made.
3058 Console commands can be specified within a RunScript by using:
3059 {\bf Console = \lt{}command\gt{}}, however, this command has not been
3060 carefully tested and debugged and is known to easily crash the Director.
3061 We would appreciate feedback. Due to the recursive nature of this command, we
3062 may remove it before the final release.
3064 \subsubsection{Status Enhancements}
3065 \index[general]{Status Enhancements}
3066 The bconsole {\bf status dir} output has been enhanced to indicate
3067 Storage daemon job spooling and despooling activity.
3069 \subsubsection{Connect Timeout}
3070 \index[general]{Connect Timeout}
3071 The default connect timeout to the File
3072 daemon has been set to 3 minutes. Previously it was 30 minutes.
3074 \subsubsection{ftruncate for NFS Volumes}
3075 \index[general]{ftruncate for NFS Volumes}
3076 If you write to a Volume mounted by NFS (say on a local file server),
3077 in previous Bacula versions, when the Volume was recycled, it was not
3078 properly truncated because NFS does not implement ftruncate (file
3079 truncate). This is now corrected in the new version because we have
3080 written code (actually a kind user) that deletes and recreates the Volume,
3081 thus accomplishing the same thing as a truncate.
3083 \subsubsection{Support for Ubuntu}
3084 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
3085 version of Linux, and thus now provides correct autostart routines.
3086 Since Ubuntu officially supports Bacula, you can also obtain any
3087 recent release of Bacula from the Ubuntu repositories.
3089 \subsubsection{Recycle Pool = \lt{}pool-name\gt{}}
3090 \index[general]{Recycle Pool}
3091 The new \textbf{RecyclePool} directive defines to which pool the Volume will
3092 be placed (moved) when it is recycled. Without this directive, a Volume will
3093 remain in the same pool when it is recycled. With this directive, it can be
3094 moved automatically to any existing pool during a recycle. This directive is
3095 probably most useful when defined in the Scratch pool, so that volumes will
3096 be recycled back into the Scratch pool.
3098 \subsubsection{FD Version}
3099 \index[general]{FD Version}
3100 The File daemon to Director protocol now includes a version
3101 number, which although there is no visible change for users,
3102 will help us in future versions automatically determine
3103 if a File daemon is not compatible.
3105 \subsubsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
3106 \index[general]{Max Run Sched Time}
3107 The time specifies the maximum allowed time that a job may run, counted from
3108 when the job was scheduled. This can be useful to prevent jobs from running
3109 during working hours. We can see it like \texttt{Max Start Delay + Max Run
3112 \subsubsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
3113 \index[general]{Max Wait Time}
3114 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
3115 of checking the maximum allowed time that a job may block for a resource,
3116 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
3117 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
3118 their job depending on the level. Now, they have to use
3119 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
3120 directives are now deprecated.
3122 \subsubsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
3123 \index[general]{Incremental Max Wait Time}
3124 \index[general]{Differential Max Wait Time}
3126 These directives have been deprecated in favor of
3127 \texttt{Incremental|Differential Max Run Time}.
3129 \subsubsection{Max Run Time directives}
3130 \index[general]{Max Run Time directives}
3131 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
3132 maximum allowed time that a job can run depending on the level.
3134 \addcontentsline{lof}{figure}{Job time control directives}
3136 \includegraphics[width=\linewidth]{different_time}
3139 \subsubsection{Statistics Enhancements}
3140 \index[general]{Statistics Enhancements}
3141 If you (or probably your boss) want to have statistics on your backups to
3142 provide some \textit{Service Level Agreement} indicators, you could use a few
3143 SQL queries on the Job table to report how many:
3147 \item jobs have been successful
3148 \item files have been backed up
3152 However, these statistics are accurate only if your job retention is greater
3153 than your statistics period. Ie, if jobs are purged from the catalog, you won't
3154 be able to use them.
3156 Now, you can use the \textbf{update stats [days=num]} console command to fill
3157 the JobHistory table with new Job records. If you want to be sure to take in
3158 account only \textbf{good jobs}, ie if one of your important job has failed but
3159 you have fixed the problem and restarted it on time, you probably want to
3160 delete the first \textit{bad} job record and keep only the successful one. For
3161 that simply let your staff do the job, and update JobHistory table after two or
3162 three days depending on your organization using the \textbf{[days=num]} option.
3164 These statistics records aren't used for restoring, but mainly for
3165 capacity planning, billings, etc.
3167 The Bweb interface provides a statistics module that can use this feature. You
3168 can also use tools like Talend or extract information by yourself.
3170 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
3171 the length of time that Bacula will keep statistics job records in the Catalog
3172 database after the Job End time. (In \texttt{JobHistory} table) When this time
3173 period expires, and if user runs \texttt{prune stats} command, Bacula will
3174 prune (remove) Job records that are older than the specified period.
3176 You can use the following Job resource in your nightly \textbf{BackupCatalog}
3177 job to maintain statistics.
3180 Name = BackupCatalog
3183 Console = "update stats days=3"
3184 Console = "prune stats yes"
3191 \subsubsection{ScratchPool = \lt{}pool-resource-name\gt{}}
3192 \index[general]{ScratchPool}
3193 This directive permits to specify a specific \textsl{Scratch} pool for the
3194 current pool. This is useful when using multiple storage sharing the same
3195 mediatype or when you want to dedicate volumes to a particular set of pool.
3197 \subsubsection{Enhanced Attribute Despooling}
3198 \index[general]{Attribute Despooling}
3199 If the storage daemon and the Director are on the same machine, the spool file
3200 that contains attributes is read directly by the Director instead of being
3201 transmitted across the network. That should reduce load and speedup insertion.
3203 \subsubsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
3204 \index[general]{SpoolSize}
3205 A new Job directive permits to specify the spool size per job. This is used
3206 in advanced job tunning. {\bf SpoolSize={\it bytes}}
3208 \subsubsection{MaximumConsoleConnections = \lt{}number\gt{}}
3209 \index[general]{MaximumConsoleConnections}
3210 A new director directive permits to specify the maximum number of Console
3211 Connections that could run concurrently. The default is set to 20, but you may
3212 set it to a larger number.
3214 \subsubsection{VerId = \lt{}string\gt{}}
3215 \index[general]{VerId}
3216 A new director directive permits to specify a personnal identifier that will be
3217 displayed in the \texttt{version} command.
3219 \subsubsection{dbcheck enhancements}
3220 \index[general]{dbcheck enhancements}
3221 If you are using Mysql, dbcheck will now ask you if you want to create
3222 temporary indexes to speed up orphaned Path and Filename elimination.
3224 A new \texttt{-B} option allows you to print catalog information in a simple
3225 text based format. This is useful to backup it in a secure way.
3240 You can now specify the database connection port in the command line.
3242 \subsubsection{{-}{-}docdir configure option}
3243 \index[general]{{-}{-}docdir configure option}
3244 You can use {-}{-}docdir= on the ./configure command to
3245 specify the directory where you want Bacula to install the
3246 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
3247 {\bf /usr/share/doc/bacula}.
3249 \subsubsection{{-}{-}htmldir configure option}
3250 \index[general]{{-}{-}htmldir configure option}
3251 You can use {-}{-}htmldir= on the ./configure command to
3252 specify the directory where you want Bacula to install the bat html help
3253 files. The default is {\bf /usr/share/doc/bacula/html}
3255 \subsubsection{{-}{-}with-plugindir configure option}
3256 \index[general]{{-}{-}plugindir configure option}
3257 You can use {-}{-}plugindir= on the ./configure command to
3258 specify the directory where you want Bacula to install
3259 the plugins (currently only bpipe-fd). The default is