]> git.sur5r.net Git - bacula/docs/blob - docs/manuals/en/main/newfeatures.tex
03a498ccdd1e4cf92ef9da358fcceec5043e28e0
[bacula/docs] / docs / manuals / en / main / newfeatures.tex
1 \chapter{Community Bacula New Features in 5.1.x}
2 This chapter presents the new features that have been added to the current
3 Community version of Bacula that is under development. This version will be
4 released at some later date, probably near the end of April 2011.
5
6 There are additional features (plugins) available in the Enterprise version
7 that are described in another chapter. A subscription to Bacula Systems
8 is required for the Enterprise version.
9
10
11 \section{LZO Compression}
12
13 LZO compression was added in the File Daemon. From the user point of view, it
14 works like the GZIP compression (just replace {\bf compression=GZIP} with {\bf
15   compression=LZO}).
16
17 For example:
18 \begin{verbatim}
19 Include {
20    Options { compression=LZO }
21    File = /home
22    File = /data
23 }
24 \end{verbatim}
25
26 LZO provides much faster compression and decompression speed but lower
27 compression ratio than GZIP. It is a good option when you backup to disk. For
28 tape, the built-in compression may be a better option.
29
30 LZO is a good altenative for GZIP1 when you don't want to slow down your
31 backup. On a modern CPU it should be able to run almost as fast as:
32
33 \begin{itemize}
34 \item your client can read data from disk. Unless you have very fast disks like
35   SSD or large/fast RAID array.
36 \item the data transfers between the file daemon and the storage daemon even on
37   a 1Gb/s link.
38 \end{itemize}
39
40 Note that bacula only use one compression level LZO1X-1.
41
42 \medskip
43 The code for this feature was contributed by Laurent Papier.
44
45 \section{New Tray Monitor}
46
47 Since the old integrated Windows tray monitor doesn't work anymore with
48 recent Windows versions, we have written a new Qt Tray Monitor that is available
49 for both Linux and Windows.  This new version allows you to run Backup from
50 the tray monitor menu.
51
52 \begin{figure}[htbp]
53   \centering
54   \includegraphics[width=10cm]{\idir tray-monitor}
55   \label{fig:traymonitor}
56   \caption{New tray monitor}
57 \end{figure}
58
59 \begin{figure}[htbp]
60   \centering
61   \includegraphics[width=10cm]{\idir tray-monitor1}
62   \label{fig:traymonitor1}
63   \caption{Run a Job through the new tray monitor}
64 \end{figure}
65
66 \medskip
67 This project was funded by Bacula Systems and is available with Bacula
68 the Enterprise Edition and the Community Edition.
69
70 \section{Purge Migration Job}
71
72 The new {\bf Purge Migration Job} directive may be added to the Migration
73 Job definition in the Director's configuration file. When it is enabled 
74 the Job that was migrated during a migration will be purged at
75 the end of the migration job.
76
77 For example:
78 \begin{verbatim}
79 Job {
80   Name = "migrate-job"
81   Type = Migrate
82   Level = Full
83   Client = localhost-fd
84   FileSet = "Full Set"
85   Messages = Standard
86   Storage = DiskChanger
87   Pool = Default
88   Selection Type = Job
89   Selection Pattern = ".*Save"
90 ...
91   Purge Migrated Job = yes
92 }
93 \end{verbatim}
94
95 \medskip
96
97 This project was submited by Dunlap Blake, testing and documentation was funded
98 by Bacula Systems.
99
100 \section{Changes in Bvfs (Bacula Virtual FileSystem)}
101
102 Bat has now a bRestore panel that uses Bvfs to display files and
103 directories. It's still experimental.
104
105 \begin{figure}[htbp]
106   \centering
107   \includegraphics[width=12cm]{\idir bat-brestore}
108   \label{fig:batbrestore}
109   \caption{Bat Brestore Panel}
110 \end{figure}
111
112 \texttt{Important}, the Bvfs module is not currently compatible with BaseJobs,
113 Copy and Migration jobs.
114
115 \medskip
116 This project was funded by Bacula Systems.
117
118 \subsection*{General notes}
119
120 \begin{itemize}
121 \item All fields are separated by a tab
122 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
123   records in very big directories
124 \item All operations (except cache creation) are designed to run instantly
125 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
126   can contribute new faster SQL queries we will be happy, else don't complain
127   about speed.
128 \item The cache creation is dependent of the number of directories. As Bvfs
129   shares information accross jobs, the first creation can be slow
130 \item All fields are separated by a tab
131 \item Due to potential encoding problem, it's advised to allways use pathid in
132   queries.
133 \end{itemize}
134
135 \subsection*{Get dependent jobs from a given JobId}
136
137 Bvfs allows you to query the catalog against any combination of jobs. You
138 can combine all Jobs and all FileSet for a Client in a single session.
139
140 To get all JobId needed to restore a particular job, you can use the
141 \texttt{.bvfs\_get\_jobids} command.
142
143 \begin{verbatim}
144 .bvfs_get_jobids jobid=num [all]
145 \end{verbatim}
146
147 \begin{verbatim}
148 .bvfs_get_jobids jobid=10
149 1,2,5,10
150 .bvfs_get_jobids jobid=10 all
151 1,2,3,5,10
152 \end{verbatim}
153
154 In this example, a normal restore will need to use JobIds 1,2,5,10 to
155 compute a complete restore of the system.
156
157 With the \texttt{all} option, the Director will use all defined FileSet for
158 this client.
159
160 \subsection*{Generating Bvfs cache}
161
162 The \texttt{.bvfs\_update} command computes the directory cache for jobs
163 specified in argument, or for all jobs if unspecified.
164
165 \begin{verbatim}
166 .bvfs_update [jobid=numlist]
167 \end{verbatim}
168
169 Example:
170 \begin{verbatim}
171 .bvfs_update jobid=1,2,3
172 \end{verbatim}
173
174 You can run the cache update process in a RunScript after the catalog backup.
175
176 \subsection*{Get all versions of a specific file}
177
178 Bvfs allows you to find all versions of a specific file for a given Client with
179 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
180 function uses only PathId and FilenameId. The jobid argument is mandatory but
181 unused.
182
183 \begin{verbatim}
184 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
185 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
186 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
187 ...
188 \end{verbatim}
189
190 Example:
191
192 \begin{verbatim}
193 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
194 1  47  52  12  gD HRid IGk D Po Po A P BAA I A   /uPgWaxMgKZlnMti7LChyA  Vol1  1
195 \end{verbatim}
196
197 \subsection*{List directories}
198
199 Bvfs allows you to list directories in a specific path.
200 \begin{verbatim}
201 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
202 PathId  FilenameId  FileId  JobId  LStat  Path
203 PathId  FilenameId  FileId  JobId  LStat  Path
204 PathId  FilenameId  FileId  JobId  LStat  Path
205 ...
206 \end{verbatim}
207
208 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
209 ``/'' on Unix and all drives on Windows.  If FilenameId is 0, the record
210 listed is a directory.
211
212 \begin{verbatim}
213 .bvfs_lsdirs pathid=4 jobid=1,11,12
214 4       0       0       0       A A A A A A A A A A A A A A     .
215 5       0       0       0       A A A A A A A A A A A A A A     ..
216 3       0       0       0       A A A A A A A A A A A A A A     regress/
217 \end{verbatim}
218
219 In this example, to list directories present in \texttt{regress/}, you can use
220 \begin{verbatim}
221 .bvfs_lsdirs pathid=3 jobid=1,11,12
222 3       0       0       0       A A A A A A A A A A A A A A     .
223 4       0       0       0       A A A A A A A A A A A A A A     ..
224 2       0       0       0       A A A A A A A A A A A A A A     tmp/
225 \end{verbatim}
226
227 \subsection*{List files}
228
229 Bvfs allows you to list files in a specific path.
230 \begin{verbatim}
231 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
232 PathId  FilenameId  FileId  JobId  LStat  Path
233 PathId  FilenameId  FileId  JobId  LStat  Path
234 PathId  FilenameId  FileId  JobId  LStat  Path
235 ...
236 \end{verbatim}
237
238 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
239 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
240 is a directory.
241
242 \begin{verbatim}
243 .bvfs_lsfiles pathid=4 jobid=1,11,12
244 4       0       0       0       A A A A A A A A A A A A A A     .
245 5       0       0       0       A A A A A A A A A A A A A A     ..
246 1       0       0       0       A A A A A A A A A A A A A A     regress/
247 \end{verbatim}
248
249 In this example, to list files present in \texttt{regress/}, you can use
250 \begin{verbatim}
251 .bvfs_lsfiles pathid=1 jobid=1,11,12
252 1   47   52   12    gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A     titi
253 1   49   53   12    gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B     toto
254 1   48   54   12    gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A     tutu
255 1   45   55   12    gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B     ficheriro1.txt
256 1   46   56   12    gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D     ficheriro2.txt
257 \end{verbatim}
258
259 \subsection*{Restore set of files}
260
261 Bvfs allows you to create a SQL table that contains files that you want to
262 restore. This table can be provided to a restore command with the file option.
263
264 \begin{verbatim}
265 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
266 OK
267 restore file=?b2num ...
268 \end{verbatim}
269
270 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
271 select all files. This query could be time consuming.
272
273 \texttt{hardlink} list is always composed of a serie of two numbers (jobid,
274 fileindex). This information can be found in the LinkFI field of the LStat
275 packet.
276
277 The \texttt{path} argument represents the name of the table that Bvfs will
278 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
279 b2 and followed by digits).
280
281 Example:
282
283 \begin{verbatim}
284 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
285 OK
286 \end{verbatim}
287
288 \subsection*{Cleanup after restore}
289
290 To drop the table used by the restore command, you can use the
291 \texttt{.bvfs\_cleanup} command.
292
293 \begin{verbatim}
294 .bvfs_cleanup path=b20001
295 \end{verbatim}
296
297 \section{Changes in the pruning algorithm}
298
299 We rewrote the job pruning algorithm in this version. Previously, in some users
300 reported that the pruning process at the end of jobs was very long. It should
301 not be longer the case. Now, Bacula won't prune automatically a Job if this
302 particular Job is needed to restore data. Example:
303
304 \begin{verbatim}
305 JobId: 1  Level: Full
306 JobId: 2  Level: Incremental
307 JobId: 3  Level: Incremental
308 JobId: 4  Level: Differential
309 .. Other incrementals up to now
310 \end{verbatim}
311
312 In this example, if the Job Retention defined in the Pool or in the Client
313 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
314 detect that JobId 1 and 4 are essential to restore data at the current state
315 and will prune only JobId 2 and 3.
316
317 \texttt{Important}, this change affect only the automatic pruning step after a
318 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
319 \texttt{VolumeRetention} period, important jobs can be pruned.
320
321 \section{Ability to Verify any specified Job}
322 You now have the ability to tell Bacula which Job should verify instead of
323 automatically verify just the last one.
324
325 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
326
327 To verify a given job, just specify the Job jobid in argument when starting the
328 job.
329 \begin{verbatim}
330 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
331 Run Verify job
332 JobName:     VerifyVolume
333 Level:       VolumeToCatalog
334 Client:      127.0.0.1-fd
335 FileSet:     Full Set
336 Pool:        Default (From Job resource)
337 Storage:     File (From Job resource)
338 Verify Job:  VerifyVol.2010-09-08_14.17.17_03
339 Verify List: /tmp/regress/working/VerifyVol.bsr
340 When:        2010-09-08 14:17:31
341 Priority:    10
342 OK to run? (yes/mod/no):
343 \end{verbatim}
344
345 \medskip
346 This project was funded by Bacula Systems and is available with Bacula
347 Enterprise Edition and Community Edition.
348
349 \section{Additions to RunScript variables}
350 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
351 command. The Client address is now available through \%h.
352
353 \begin{verbatim}
354 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
355 \end{verbatim}
356
357 %\section{Changes in drivetype.exe}
358 %
359 %Now the \texttt{drivetype.exe} program allows you to list all local hard
360 %drives. It can help to build dynamic FileSet on Windows.
361 %
362 %\begin{verbatim}
363 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
364 %\end{verbatim}
365 %
366
367 \section{Additions to the Plugin API}
368 The bfuncs structure has been extended to include a number of
369 new entrypoints.
370
371 \subsection{bfuncs}
372 The bFuncs structure defines the callback entry points within Bacula
373 that the plugin can use register events, get Bacula values, set
374 Bacula values, and send messages to the Job output or debug output.
375
376 The exact definition as of this writing is:
377 \begin{verbatim}
378 typedef struct s_baculaFuncs {
379    uint32_t size;
380    uint32_t version;
381    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
382    bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
383    bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
384    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
385        int type, utime_t mtime, const char *fmt, ...);
386    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
387        int level, const char *fmt, ...);
388    void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
389        size_t size);
390    void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
391    
392    /* New functions follow */
393    bRC (*AddExclude)(bpContext *ctx, const char *file);
394    bRC (*AddInclude)(bpContext *ctx, const char *file);
395    bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
396    bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
397    bRC (*AddWild)(bpContext *ctx, const char *item, int type);
398    bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
399
400 } bFuncs;
401 \end{verbatim}
402
403 \begin{description}
404 \item [AddExclude] can be called to exclude a file. The file
405   string passed may include wildcards that will be interpreted by
406   the {\bf fnmatch} subroutine. This function can be called 
407   multiple times, and each time the file specified will be added
408   to the list of files to be excluded. Note, this function only
409   permits adding excludes of specific file or directory names,
410   or files matched by the rather simple fnmatch mechanism.
411   See below for information on doing wild-card and regex excludes.
412
413 \item [NewInclude] can be called to create a new Include block. This
414   block will be added before any user defined Include blocks. This
415   function can be called multiple times, but each time, it will create
416   a new Include section (not normally needed). This function should
417   be called only if you want to add an entirely new Include block.
418
419 \item [AddInclude] can be called to add new files/directories to
420   be included.  They are added to the current Include block. If
421   NewInclude has not been included, the current Include block is
422   the last one that the user created. This function
423   should be used only if you want to add totally new files/directories
424   to be included in the backup. 
425
426 \item [NewOptions] adds a new Options block to the current Include
427   in front of any other Options blocks. This permits the plugin to
428   add exclude directives (wild-cards and regexes) in front of the
429   user Options, and thus prevent certain files from being backed up.
430   This can be useful if the plugin backs up files, and they should
431   not be also backed up by the main Bacula code.  This function
432   may be called multiple times, and each time, it creates a new
433   prepended Options block. Note: normally you want to call this 
434   entry point prior to calling AddOptions, AddRegex, or AddWild.
435   
436 \item [AddOptions] allows the plugin it set options in
437   the current Options block, which is normally created with the
438   NewOptions call just prior to adding Include Options.
439   The permitted options are passed as a character string, where
440   each character has a specific meaning as defined below:
441
442   \begin{description}
443   \item [a] always replace files (default).
444   \item [e] exclude rather than include.
445   \item [h] no recursion into subdirectories.
446   \item [H] do not handle hard links.
447   \item [i] ignore case in wildcard and regex matches.
448   \item [M] compute an MD5 sum.
449   \item [p] use a portable data format on Windows (not recommended).
450   \item [R] backup resource forks and Findr Info.
451   \item [r] read from a fifo
452   \item [S1] compute an SHA1 sum.
453   \item [S2] compute an SHA256 sum.
454   \item [S3] comput an SHA512 sum.
455   \item [s] handle sparse files.
456   \item [m] use st\_mtime only for file differences.
457   \item [k] restore the st\_atime after accessing a file.
458   \item [A] enable ACL backup.
459   \item [Vxxx:] specify verify options. Must terminate with :
460   \item [Cxxx:] specify accurate options. Must terminate with :
461   \item [Jxxx:] specify base job Options. Must terminate with :
462   \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
463   \item [w] if newer
464   \item [Zn] specify gzip compression level n.
465   \item [K] do not use st\_atime in backup decision.
466   \item [c] check if file changed during backup.
467   \item [N] honor no dump flag.
468   \item [X] enable backup of extended attributes.
469   \end{description}
470
471 \item [AddRegex] adds a regex expression to the current Options block.
472   The fillowing options are permitted:
473   \begin{description}
474   \item [ ] (a blank) regex applies to whole path and filename.
475   \item [F] regex applies only to the filename (directory or path stripped).
476   \item [D] regex applies only to the directory (path) part of the name.
477   \end{description}
478
479 \item [AddWild] adds a wildcard expression to the current Options block.
480   The fillowing options are permitted:
481   \begin{description}
482   \item [ ] (a blank) regex applies to whole path and filename.
483   \item [F] regex applies only to the filename (directory or path stripped).
484   \item [D] regex applies only to the directory (path) part of the name.
485   \end{description}
486
487 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
488   that can use Accurate code to compare the file information in argument with
489   the previous file information. The \texttt{delta\_seq} attribute of the
490   \texttt{save\_pkt} will be updated, and the call will return
491   \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
492   
493 \end{description}
494   
495
496 \subsection{Bacula events}
497 The list of events has been extended to include:
498
499 \begin{verbatim}
500 typedef enum {
501   bEventJobStart        = 1,
502   bEventJobEnd          = 2,
503   bEventStartBackupJob  = 3,
504   bEventEndBackupJob    = 4,
505   bEventStartRestoreJob = 5,
506   bEventEndRestoreJob   = 6,
507   bEventStartVerifyJob  = 7,
508   bEventEndVerifyJob    = 8,
509   bEventBackupCommand   = 9,
510   bEventRestoreCommand  = 10,
511   bEventLevel           = 11,
512   bEventSince           = 12,
513    
514   /* New events */
515   bEventCancelCommand                   = 13,
516   bEventVssBackupAddComponents          = 14,
517   bEventVssRestoreLoadComponentMetadata = 15,
518   bEventVssRestoreSetComponentsSelected = 16,
519   bEventRestoreObject                   = 17,
520   bEventEndFileSet                      = 18,
521   bEventPluginCommand                   = 19,
522   bEventVssBeforeCloseRestore           = 20,
523   bEventVssPrepareSnapshot              = 21
524
525 } bEventType;
526 \end{verbatim}
527
528 \begin{description}
529 \item [bEventCancelCommand] is called whenever the currently
530   running Job is cancelled */
531
532 \item [bEventVssBackupAddComponents] 
533
534 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
535   provides a char[27] table where the plugin can add Windows drives that will
536   be used during the Job. You need to add them without duplicates, and you can
537   use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
538   for this purpose.
539 \end{description}
540
541 \section{ACL enhancements}
542
543 The following enhancements are made to the Bacula Filed with regards to
544 Access Control Lists (ACLs)
545
546 \begin{itemize}
547 \item Added support for AIX 5.3 and later new aclx_get interface which supports
548   POSIX and NFSv4 ACLs.
549 \item Added support for new acl types on FreeBSD 8.1 and later which supports
550   POSIX and NFSv4 ACLs.
551 \item Some generic cleanups for internal ACL handling.
552 \item Fix for acl storage on OSX
553 \item Cleanup of configure checks for ACL detection, now configure only
554   tests for a certain interface type based on the operating system
555   this should give less false possitives on detection. Also when acls
556   are detected no other acl checks are performed anymore.
557 \end{itemize}
558
559 \medskip
560 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
561 and is available with Bacula Enterprise Edition and Community Edition.
562
563 \section{XATTR enhancements}
564
565 The following enhancements are made to the Bacula Filed with regards to
566 Extended Attributes (XATTRs)
567
568 \begin{itemize}
569 \item Added support for IRIX extended attributes using the attr_get interface.
570 \item Added support for Tru64 (OSF1) extended attributes using the
571   getproplist interface.
572 \item Added support for AIX extended attributes available in AIX 6.x
573   and higher using the listea/getea/setea interface.
574 \item Added some debugging to generic xattr code so it easier to
575   debug.
576 \item Cleanup of configure checks for XATTR detection, now configure only
577   tests for a certain interface type based on the operating system
578   this should give less false possitives on detection. Also when xattrs
579   are detected no other xattr checks are performed anymore.
580 \end{itemize}
581
582 \medskip
583 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
584 and is available with Bacula Enterprise Edition and Community Edition.
585
586 \section{Class based database backend drivers}
587
588 All current database backend drivers for catalog information are rewritten
589 to use a set of multi inherited C++ classes which abstract the specific
590 database specific internals and make sure we have a more stable generic
591 interface with the rest of sql code. From now on there is a strict boundery
592 between the sql code and the low-level database functions. This new interface
593 should also make it easier to add a new backend for a currently unsupported
594 database. As part of the rewrite the SQLITE2 code was removed (e.g. only
595 SQLITE3 is now supported). An extra bonus of the new code is that you can
596 configure multiple backends in the configure and build all backends in one
597 compile session and select the correct database backend at install time.
598 This should make it a lot easier for packages maintainers.
599
600 \medskip
601 We also added cursor support for PostgreSQL backend, this improves memory usage
602 for large installation.
603
604 \medskip
605 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
606 and Bacula Systems and is available with Bacula Enterprise Edition and
607 Community Edition.
608
609 \section{Hash list enhancements}
610
611 The htable hash table class has been extended with extra hash functions for
612 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
613 Also the hash table initialization routines have been enhanced with
614 support for passing a hint as to the number of initial pages to use
615 for the size of the hash table. Until now the hash table always used
616 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
617 cache have been rewritten to use the new htable class with a small memory
618 footprint.
619
620 \medskip
621 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
622 and Bacula Systems and is available with Bacula Enterprise Edition and
623 Community Edition.
624
625
626 \chapter{Release Version 5.0.3}
627
628 There are no new features in version 5.0.2.  This version simply fixes a
629 number of bugs found in version 5.0.1 during the onging development
630 process.
631
632 \chapter{Release Version 5.0.2}
633
634 There are no new features in version 5.0.2.  This version simply fixes a
635 number of bugs found in version 5.0.1 during the onging development
636 process.
637
638 %%
639 %%
640
641 \chapter{New Features in 5.0.1}
642
643 This chapter presents the new features that are in the released Bacula version
644 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
645 the onging development process.
646
647 \section{Truncate Volume after Purge}
648 \label{sec:actiononpurge}
649
650 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
651 the volume when it is purged with the new command \texttt{purge volume
652   action}. It is useful to prevent disk based volumes from consuming too much
653 space.
654
655 \begin{verbatim}
656 Pool {
657   Name = Default
658   Action On Purge = Truncate
659   ...
660 }
661 \end{verbatim}
662
663 As usual you can also set this property with the \texttt{update volume} command
664 \begin{verbatim}
665 *update volume=xxx ActionOnPurge=Truncate
666 *update volume=xxx actiononpurge=None
667 \end{verbatim}
668
669 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
670 following command in interactive mode or in a RunScript as shown after:
671 \begin{verbatim}
672 *purge volume action=truncate storage=File allpools
673 # or by default, action=all
674 *purge volume action storage=File pool=Default
675 \end{verbatim}
676
677 This is possible to specify the volume name, the media type, the pool, the
678 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
679 idle when you decide to run this command.
680
681 \begin{verbatim}
682 Job {
683  Name = CatalogBackup
684  ...
685  RunScript {
686    RunsWhen=After
687    RunsOnClient=No
688    Console = "purge volume action=all allpools storage=File"
689  }
690 }
691 \end{verbatim}
692
693 \textbf{Important note}: This feature doesn't work as
694 expected in version 5.0.0. Please do not use it before version 5.0.1.
695
696 \section{Allow Higher Duplicates}
697 This directive did not work correctly and has been depreciated
698 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
699 file as it will be removed in a future rlease.
700
701 \section{Cancel Lower Level Duplicates}
702 This directive was added in Bacula version 5.0.1.  It compares the
703 level of a new backup job to old jobs of the same name, if any,
704 and will kill the job which has a lower level than the other one.
705 If the levels are the same (i.e. both are Full backups), then 
706 nothing is done and the other Cancel XXX Duplicate directives
707 will be examined.
708
709 \chapter{New Features in 5.0.0}
710
711 \section{Maximum Concurrent Jobs for Devices}
712 \label{sec:maximumconcurrentjobdevice}
713
714 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
715 Daemon configuration permits setting the maximum number of Jobs that can
716 run concurrently on a specified Device.  Using this directive, it is
717 possible to have different Jobs using multiple drives, because when the
718 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
719 Jobs on any other available compatible drive.  This facilitates writing to
720 multiple drives with multiple Jobs that all use the same Pool.
721
722 This project was funded by Bacula Systems.
723
724 \section{Restore from Multiple Storage Daemons}
725 \index[general]{Restore}
726
727 Previously, you were able to restore from multiple devices in a single Storage
728 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
729 example, if your full backup runs on a Storage Daemon with an autochanger, and
730 your incremental jobs use another Storage Daemon with lots of disks, Bacula
731 will switch automatically from one Storage Daemon to an other within the same
732 Restore job.
733
734 You must upgrade your File Daemon to version 3.1.3 or greater to use this
735 feature.
736
737 This project was funded by Bacula Systems with the help of Equiinet.
738
739 \section{File Deduplication using Base Jobs}
740 A base job is sort of like a Full save except that you will want the FileSet to
741 contain only files that are unlikely to change in the future (i.e.  a snapshot
742 of most of your system after installing it).  After the base job has been run,
743 when you are doing a Full save, you specify one or more Base jobs to be used.
744 All files that have been backed up in the Base job/jobs but not modified will
745 then be excluded from the backup.  During a restore, the Base jobs will be
746 automatically pulled in where necessary.
747
748 This is something none of the competition does, as far as we know (except
749 perhaps BackupPC, which is a Perl program that saves to disk only).  It is big
750 win for the user, it makes Bacula stand out as offering a unique optimization
751 that immediately saves time and money.  Basically, imagine that you have 100
752 nearly identical Windows or Linux machine containing the OS and user files.
753 Now for the OS part, a Base job will be backed up once, and rather than making
754 100 copies of the OS, there will be only one.  If one or more of the systems
755 have some files updated, no problem, they will be automatically restored.
756
757 See the \ilink{Base Job Chapter}{basejobs} for more information.
758
759 This project was funded by Bacula Systems.
760
761 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
762 \index[dir]{AllowCompression}
763
764 This new directive may be added to Storage resource within the Director's
765 configuration to allow users to selectively disable the client compression for
766 any job which writes to this storage resource.
767
768 For example:
769 \begin{verbatim}
770 Storage {
771   Name = UltriumTape
772   Address = ultrium-tape
773   Password = storage_password # Password for Storage Daemon
774   Device = Ultrium
775   Media Type = LTO 3
776   AllowCompression = No # Tape drive has hardware compression
777 }
778 \end{verbatim}
779 The above example would cause any jobs running with the UltriumTape storage
780 resource to run without compression from the client file daemons.  This
781 effectively overrides any compression settings defined at the FileSet level.
782
783 This feature is probably most useful if you have a tape drive which supports
784 hardware compression.  By setting the \texttt{AllowCompression = No} directive
785 for your tape drive storage resource, you can avoid additional load on the file
786 daemon and possibly speed up tape backups.
787
788 This project was funded by Collaborative Fusion, Inc.
789
790 \section{Accurate Fileset Options}
791 \label{sec:accuratefileset}
792
793 In previous versions, the accurate code used the file creation and modification
794 times to determine if a file was modified or not. Now you can specify which
795 attributes to use (time, size, checksum, permission, owner, group, \dots),
796 similar to the Verify options.
797
798 \begin{verbatim}
799 FileSet {
800   Name = Full
801   Include = {
802     Options {
803        Accurate = mcs
804        Verify   = pin5
805     }
806     File = /
807   }
808 }
809 \end{verbatim}
810
811 \begin{description}  
812 \item {\bf i}  compare the inodes  
813 \item {\bf p}  compare the permission bits  
814 \item {\bf n}  compare the number of links  
815 \item {\bf u}  compare the user id  
816 \item {\bf g}  compare the group id  
817 \item {\bf s}  compare the size  
818 \item {\bf a}  compare the access time  
819 \item {\bf m}  compare the modification time (st\_mtime)  
820 \item {\bf c}  compare the change time (st\_ctime)  
821 \item {\bf d}  report file size decreases  
822 \item {\bf 5}  compare the MD5 signature  
823 \item {\bf 1}  compare the SHA1 signature  
824 \end{description}
825
826 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
827 the File Daemon will have to read all files even if they normally would not
828 be saved.  This increases the I/O load, but also the accuracy of the
829 deduplication.  By default, Bacula will check modification/creation time
830 and size.
831
832 This project was funded by Bacula Systems.
833
834 \section{Tab-completion for Bconsole}
835 \label{sec:tabcompletion}
836
837 If you build \texttt{bconsole} with readline support, you will be able to use
838 the new auto-completion mode. This mode supports all commands, gives help
839 inside command, and lists resources when required. It works also in the restore
840 mode.
841
842 To use this feature, you should have readline development package loaded on
843 your system, and use the following option in configure.
844 \begin{verbatim}
845 ./configure --with-readline=/usr/include/readline --disable-conio ...
846 \end{verbatim}
847
848 The new bconsole won't be able to tab-complete with older directors.
849
850 This project was funded by Bacula Systems.
851
852 \section{Pool File and Job Retention}
853 \label{sec:poolfilejobretention}
854
855 We added two new Pool directives, \texttt{FileRetention} and
856 \texttt{JobRetention}, that take precedence over Client directives of the same
857 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
858 example, you can decide to increase Retention times for Archive or OffSite Pool.
859
860 It seems obvious to us, but apparently not to some users, that given the
861 definition above that the Pool File and Job Retention periods is a global
862 override for the normal Client based prunning, which means that when the
863 Job is prunned, the prunning will apply globally to that particular Job.
864
865 Currently, there is a bug in the implementation that causes any Pool 
866 retention periods specified to apply to {\bf all} Pools for that
867 particular Client.  Thus we suggest that you avoid using these two
868 directives until this implementation problem is corrected.
869
870 \section{Read-only File Daemon using capabilities}
871 \label{sec:fdreadonly}
872 This feature implements support of keeping \textbf{ReadAll} capabilities after
873 UID/GID switch, this allows FD to keep root read but drop write permission.
874
875 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
876 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
877
878 \begin{verbatim}
879 root@localhost:~# bacula-fd -k -u nobody -g nobody
880 \end{verbatim}
881
882 The code for this feature was contributed by our friends at AltLinux.
883
884 \section{Bvfs API}
885 \label{sec:bvfs}
886
887 To help developers of restore GUI interfaces, we have added new \textsl{dot
888   commands} that permit browsing the catalog in a very simple way.
889
890 \begin{itemize}
891 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
892   the Bvfs cache in the catalog. You need to run it before any access to the
893   Bvfs layer.
894
895 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
896   will list all directories in the specified \texttt{path} or
897   \texttt{pathid}. Using \texttt{pathid} avoids problems with character
898   encoding of path/filenames.
899
900 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
901   will list all files in the specified \texttt{path} or \texttt{pathid}. Using
902   \texttt{pathid} avoids problems with character encoding.
903 \end{itemize}
904
905 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
906 data that will be displayed.
907
908 \begin{verbatim}
909 * .bvfs_update jobid=1,2
910 * .bvfs_update
911 * .bvfs_lsdir path=/ jobid=1,2
912 \end{verbatim}
913
914 This project was funded by Bacula Systems.
915
916 \section{Testing your Tape Drive}
917 \label{sec:btapespeed}
918
919 To determine the best configuration of your tape drive, you can run the new
920 \texttt{speed} command available in the \texttt{btape} program.
921
922 This command can have the following arguments:
923 \begin{itemize}
924 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
925   (between 1 and 5GB). This counter is in GB.
926 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
927   of data should be greater than your memory ($file\_size*nb\_file$).
928 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
929   data.
930 \item[\texttt{skip\_random}] This flag permits to skip tests with random
931   data.
932 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
933 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
934   access.
935 \end{itemize}
936
937 \begin{verbatim}
938 *speed file_size=3 skip_raw
939 btape.c:1078 Test with zero data and bacula block structure.
940 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
941 ++++++++++++++++++++++++++++++++++++++++++
942 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
943 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
944 ...
945 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
946
947 btape.c:1090 Test with random data, should give the minimum throughput.
948 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
949 +++++++++++++++++++++++++++++++++++++++++++
950 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
951 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
952 +++++++++++++++++++++++++++++++++++++++++++
953 ...
954 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
955
956 \end{verbatim}
957
958 When using compression, the random test will give your the minimum throughput
959 of your drive . The test using constant string will give you the maximum speed
960 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
961
962 You can change the block size in the Storage Daemon configuration file.
963
964 \section{New {\bf Block Checksum} Device Directive}
965 You may now turn off the Block Checksum (CRC32) code
966 that Bacula uses when writing blocks to a Volume.  This is
967 done by adding:
968
969 \begin{verbatim}
970 Block Checksum = no
971 \end{verbatim}
972
973 doing so can reduce the Storage daemon CPU usage slightly.  It
974 will also permit Bacula to read a Volume that has corrupted data.
975
976 The default is {\bf yes} -- i.e. the checksum is computed on write
977 and checked on read. 
978
979 We do not recommend to turn this off particularly on older tape
980 drives or for disk Volumes where doing so may allow corrupted data
981 to go undetected.
982
983 \section{New Bat Features}
984
985 Those new features were funded by Bacula Systems.
986
987 \subsection{Media List View}
988
989 By clicking on ``Media'', you can see the list of all your volumes. You will be
990 able to filter by Pool, Media Type, Location,\dots And sort the result directly
991 in the table. The old ``Media'' view is now known as ``Pool''.
992 \begin{figure}[htbp]
993   \centering
994   \includegraphics[width=13cm]{\idir bat-mediaview.eps}
995   \label{fig:mediaview}
996 \end{figure}
997
998
999 \subsection{Media Information View}
1000
1001 By double-clicking on a volume (on the Media list, in the Autochanger content
1002 or in the Job information panel), you can access a detailed overview of your
1003 Volume. (cf \ref{fig:mediainfo}.)
1004 \begin{figure}[htbp]
1005   \centering
1006   \includegraphics[width=13cm]{\idir bat11.eps}  
1007   \caption{Media information}
1008   \label{fig:mediainfo}
1009 \end{figure}
1010
1011 \subsection{Job Information View}
1012
1013 By double-clicking on a Job record (on the Job run list or in the Media
1014 information panel), you can access a detailed overview of your Job. (cf
1015 \ref{fig:jobinfo}.)
1016 \begin{figure}[htbp]
1017   \centering
1018   \includegraphics[width=13cm]{\idir bat12.eps}  
1019   \caption{Job information}
1020   \label{fig:jobinfo}
1021 \end{figure}
1022
1023 \subsection{Autochanger Content View}
1024
1025 By double-clicking on a Storage record (on the Storage list panel), you can
1026 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
1027 \begin{figure}[htbp]
1028   \centering
1029   \includegraphics[width=13cm]{\idir bat13.eps}  
1030   \caption{Autochanger content}
1031   \label{fig:achcontent}
1032 \end{figure}
1033
1034 To use this feature, you need to use the latest mtx-changer script
1035 version. (With new \texttt{listall} and \texttt{transfer} commands)
1036
1037 \section{Bat on Windows}
1038 We have ported {\bf bat} to Windows and it is now installed 
1039 by default when the installer is run.  It works quite well 
1040 on Win32, but has not had a lot of testing there, so your
1041 feedback would be welcome.  Unfortunately, eventhough it is
1042 installed by default, it does not yet work on 64 bit Windows
1043 operating systems.
1044
1045 \section{New Win32 Installer}
1046 The Win32 installer has been modified in several very important
1047 ways.  
1048 \begin{itemize}
1049 \item You must deinstall any current version of the
1050 Win32 File daemon before upgrading to the new one. 
1051 If you forget to do so, the new installation will fail.
1052 To correct this failure, you must manually shutdown 
1053 and deinstall the old File daemon. 
1054 \item All files (other than menu links) are installed
1055 in {\bf c:/Program Files/Bacula}.  
1056 \item The installer no longer sets this
1057 file to require administrator privileges by default. If you want
1058 to do so, please do it manually using the {\bf cacls} program.
1059 For example:
1060 \begin{verbatim}
1061 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1062 \end{verbatim}
1063 \item The server daemons (Director and Storage daemon) are
1064 no longer included in the Windows installer.  If you want the
1065 Windows servers, you will either need to build them yourself (note
1066 they have not been ported to 64 bits), or you can contact 
1067 Bacula Systems about this.
1068 \end{itemize}
1069
1070 \section{Win64 Installer}
1071 We have corrected a number of problems that required manual
1072 editing of the conf files.  In most cases, it should now
1073 install and work.  {\bf bat} is by default installed in
1074 {\bf c:/Program Files/Bacula/bin32} rather than
1075 {\bf c:/Program Files/Bacula} as is the case with the 32
1076 bit Windows installer.
1077
1078 \section{Linux Bare Metal Recovery USB Key}
1079 We have made a number of significant improvements in the
1080 Bare Metal Recovery USB key.  Please see the README files
1081 it the {\bf rescue} release for more details.  
1082
1083 We are working on an equivalent USB key for Windows bare
1084 metal recovery, but it will take some time to develop it (best
1085 estimate 3Q2010 or 4Q2010)
1086
1087
1088 \section{bconsole Timeout Option}
1089 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1090 for commands. This is useful with GUI programs that use {\bf bconsole}
1091 to interface to the Director.
1092
1093 \section{Important Changes}
1094 \label{sec:importantchanges}
1095
1096 \begin{itemize}
1097 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1098   to the same Pool. The Storage daemon ensures that you do not read and
1099   write to the same Volume.
1100 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1101   poll by default).
1102 \item Virtually all the features of {\bf mtx-changer} have
1103   now been parameterized, which allows you to configure
1104   mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf} 
1105   that contains variables that you can set to configure mtx-changer.
1106   This configuration file will not be overwritten during upgrades.
1107   We encourage you to submit any changes
1108   that are made to mtx-changer and to parameterize it all in
1109   mtx-changer.conf so that all configuration will be done by
1110   changing only mtx-changer.conf.
1111 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1112   and \texttt{transfer}. Please configure them as appropriate
1113   in mtx-changer.conf.
1114 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1115   script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1116   password. If you want to use the new script, you will need to 
1117   manually change the \texttt{BackupCatalog} Job definition.
1118 \item The \texttt{bconsole} \texttt{help} command now accepts
1119   an argument, which if provided produces information on that
1120   command (ex: \texttt{help run}).
1121 \end{itemize}
1122
1123
1124 \subsubsection*{Truncate volume after purge}
1125
1126 Note that the Truncate Volume after purge feature doesn't work as expected
1127 in 5.0.0 version. Please, don't use it before version 5.0.1.
1128
1129 \subsection{Custom Catalog queries}
1130
1131 If you wish to add specialized commands that list the contents of the catalog,
1132 you can do so by adding them to the \texttt{query.sql} file. This
1133 \texttt{query.sql} file is now empty by default.  The file
1134 \texttt{examples/sample-query.sql} has an a number of sample commands
1135 you might find useful.
1136
1137 \subsection{Deprecated parts}
1138
1139 The following items have been \textbf{deprecated} for a long time, and are now
1140 removed from the code.
1141 \begin{itemize}
1142 \item Gnome console
1143 \item Support for SQLite 2
1144 \end{itemize}
1145
1146 \section{Misc Changes}
1147 \label{sec:miscchanges}
1148
1149 \begin{itemize}
1150 \item Updated Nagios check\_bacula
1151 \item Updated man files
1152 \item Added OSX package generation script in platforms/darwin
1153 \item Added Spanish and Ukrainian Bacula translations
1154 \item Enable/disable command shows only Jobs that can change
1155 \item Added \texttt{show disabled} command to show disabled Jobs
1156 \item Many ACL improvements
1157 \item Added Level to FD status Job output
1158 \item Begin Ingres DB driver (not yet working)
1159 \item Split RedHat spec files into bacula, bat, mtx, and docs
1160 \item Reorganized the manuals (fewer separate manuals)
1161 \item Added lock/unlock order protection in lock manager
1162 \item Allow 64 bit sizes for a number of variables
1163 \item Fixed several deadlocks or potential race conditions in the SD
1164 \end{itemize}
1165
1166 \chapter{Released Version 3.0.3 and 3.0.3a}
1167
1168 There are no new features in version 3.0.3.  This version simply fixes a
1169 number of bugs found in version 3.0.2 during the onging development
1170 process.
1171
1172 \chapter{New Features in Released Version 3.0.2}
1173
1174 This chapter presents the new features added to the
1175 Released Bacula Version 3.0.2.
1176
1177 \section{Full Restore from a Given JobId}
1178 \index[general]{Restore menu}
1179
1180 This feature allows selecting a single JobId and having Bacula
1181 automatically select all the other jobs that comprise a full backup up to
1182 and including the selected date (through JobId).
1183
1184 Assume we start with the following jobs:
1185 \begin{verbatim}
1186 +-------+--------------+---------------------+-------+----------+------------+
1187 | jobid | client       | starttime           | level | jobfiles | jobbytes   |
1188 +-------+--------------+---------------------+-------+----------+------------
1189 | 6     | localhost-fd | 2009-07-15 11:45:49 | I     | 2        | 0          |
1190 | 5     | localhost-fd | 2009-07-15 11:45:45 | I     | 15       | 44143      |
1191 | 3     | localhost-fd | 2009-07-15 11:45:38 | I     | 1        | 10         |
1192 | 1     | localhost-fd | 2009-07-15 11:45:30 | F     | 1527     | 44143073   |
1193 +-------+--------------+---------------------+-------+----------+------------+
1194 \end{verbatim}
1195
1196 Below is an example of this new feature (which is number 12 in the
1197 menu).
1198
1199 \begin{verbatim}
1200 * restore
1201 To select the JobIds, you have the following choices:
1202      1: List last 20 Jobs run
1203      2: List Jobs where a given File is saved
1204 ...
1205     12: Select full restore to a specified Job date
1206     13: Cancel
1207
1208 Select item:  (1-13): 12
1209 Enter JobId to get the state to restore: 5
1210 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1211 You have selected the following JobIds: 1,3,5
1212
1213 Building directory tree for JobId(s) 1,3,5 ...  +++++++++++++++++++
1214 1,444 files inserted into the tree.
1215 \end{verbatim}
1216
1217 This project was funded by Bacula Systems.
1218
1219 \section{Source Address}
1220 \index[general]{Source Address}
1221
1222 A feature has been added which allows the administrator to specify the address
1223 from which the Director and File daemons will establish connections.  This
1224 may be used to simplify system configuration overhead when working in complex
1225 networks utilizing multi-homing and policy-routing.
1226
1227 To accomplish this, two new configuration directives have been implemented:
1228 \begin{verbatim}
1229 FileDaemon {
1230   FDSourceAddress=10.0.1.20    # Always initiate connections from this address
1231 }
1232
1233 Director {
1234   DirSourceAddress=10.0.1.10   # Always initiate connections from this address
1235 }
1236 \end{verbatim}
1237
1238 Simply adding specific host routes on the OS
1239 would have an undesirable side-effect: any
1240 application trying to contact the destination host would be forced to use the
1241 more specific route possibly diverting management traffic onto a backup VLAN.
1242 Instead of adding host routes for each client connected to a multi-homed backup
1243 server (for example where there are management and backup VLANs), one can
1244 use the new directives to specify a specific source address at the application
1245 level.
1246
1247 Additionally, this allows the simplification and abstraction of firewall rules
1248 when dealing with a Hot-Standby director or storage daemon configuration.  The
1249 Hot-standby pair may share a CARP address, which connections must be sourced
1250 from, while system services listen and act from the unique interface addresses.
1251
1252 This project was funded by Collaborative Fusion, Inc.
1253
1254 \section{Show volume availability when doing restore}
1255
1256 When doing a restore the selection dialog ends by displaying this
1257 screen:
1258
1259 \begin{verbatim}
1260   The job will require the following
1261    Volume(s)                 Storage(s)                SD Device(s)
1262    ===========================================================================
1263    *000741L3                  LTO-4                     LTO3 
1264    *000866L3                  LTO-4                     LTO3 
1265    *000765L3                  LTO-4                     LTO3 
1266    *000764L3                  LTO-4                     LTO3 
1267    *000756L3                  LTO-4                     LTO3 
1268    *001759L3                  LTO-4                     LTO3 
1269    *001763L3                  LTO-4                     LTO3 
1270     001762L3                  LTO-4                     LTO3 
1271     001767L3                  LTO-4                     LTO3 
1272
1273 Volumes marked with ``*'' are online (in the autochanger).
1274 \end{verbatim}
1275
1276 This should help speed up large restores by minimizing the time spent
1277 waiting for the operator to discover that he must change tapes in the library.
1278
1279 This project was funded by Bacula Systems.
1280
1281 \section{Accurate estimate command}
1282
1283 The \texttt{estimate} command can now use the accurate code to detect changes
1284 and give a better estimation.
1285
1286 You can set the accurate behavior on the command line by using
1287 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1288
1289 \begin{verbatim}
1290 * estimate listing accurate=yes level=incremental job=BackupJob
1291 \end{verbatim}
1292
1293 This project was funded by Bacula Systems.
1294
1295 \chapter{New Features in 3.0.0}
1296 \label{NewFeaturesChapter}
1297 \index[general]{New Features}
1298
1299 This chapter presents the new features added to the development 2.5.x
1300 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1301
1302 \section{Accurate Backup}
1303 \index[general]{Accurate Backup}
1304
1305 As with most other backup programs, by default Bacula decides what files to
1306 backup for Incremental and Differental backup by comparing the change
1307 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1308 backup completed.  If one of those two times is later than the last backup
1309 time, then the file will be backed up.  This does not, however, permit tracking
1310 what files have been deleted and will miss any file with an old time that may
1311 have been restored to or moved onto the client filesystem.
1312
1313 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1314 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1315 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1316 backup, there is no difference, but for {\bf Differential} and {\bf
1317   Incremental} backups, the Director will send a list of all previous files
1318 backed up, and the File daemon will use that list to determine if any new files
1319 have been added or or moved and if any files have been deleted. This allows
1320 Bacula to make an accurate backup of your system to that point in time so that
1321 if you do a restore, it will restore your system exactly.  
1322
1323 One note of caution
1324 about using Accurate backup is that it requires more resources (CPU and memory)
1325 on both the Director and the Client machines to create the list of previous
1326 files backed up, to send that list to the File daemon, for the File daemon to
1327 keep the list (possibly very big) in memory, and for the File daemon to do
1328 comparisons between every file in the FileSet and the list.  In particular,
1329 if your client has lots of files (more than a few million), you will need
1330 lots of memory on the client machine.
1331
1332 Accurate must not be enabled when backing up with a plugin that is not
1333 specially designed to work with Accurate. If you enable it, your restores
1334 will probably not work correctly.
1335
1336 This project was funded by Bacula Systems.
1337                                        
1338
1339
1340 \section{Copy Jobs}
1341 \index[general]{Copy Jobs}
1342
1343 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1344 existing Migration feature with the exception that the Job that is copied is
1345 left unchanged.  This essentially creates two identical copies of the same
1346 backup. However, the copy is treated as a copy rather than a backup job, and
1347 hence is not directly available for restore.  The {\bf restore} command lists
1348 copy jobs and allows selection of copies by using \texttt{jobid=}
1349 option. If the keyword {\bf copies} is present on the command line, Bacula will
1350 display the list of all copies for selected jobs.
1351
1352 \begin{verbatim}
1353 * restore copies
1354 [...]
1355 These JobIds have copies as follows:
1356 +-------+------------------------------------+-----------+------------------+
1357 | JobId | Job                                | CopyJobId | MediaType        |
1358 +-------+------------------------------------+-----------+------------------+
1359 | 2     | CopyJobSave.2009-02-17_16.31.00.11 | 7         | DiskChangerMedia |
1360 +-------+------------------------------------+-----------+------------------+
1361 +-------+-------+----------+----------+---------------------+------------------+
1362 | JobId | Level | JobFiles | JobBytes | StartTime           | VolumeName       |
1363 +-------+-------+----------+----------+---------------------+------------------+
1364 | 19    | F     | 6274     | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1365 | 2     | I     | 1        | 5        | 2009-02-17 16:30:51 | FileVolume001    |
1366 +-------+-------+----------+----------+---------------------+------------------+
1367 You have selected the following JobIds: 19,2
1368
1369 Building directory tree for JobId(s) 19,2 ...  ++++++++++++++++++++++++++++++++++++++++++++
1370 5,611 files inserted into the tree.
1371 ...
1372 \end{verbatim}
1373
1374
1375 The Copy Job runs without using the File daemon by copying the data from the
1376 old backup Volume to a different Volume in a different Pool. See the Migration
1377 documentation for additional details. For copy Jobs there is a new selection
1378 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1379 not already copied to another Pool. 
1380
1381 As with Migration, the Client, Volume, Job, or SQL query, are
1382 other possible ways of selecting the Jobs to be copied. Selection
1383 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1384 work, but are probably more suited for Migration Jobs. 
1385
1386 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1387 it will promote the Copy to a \textsl{real} backup job and will make it available for
1388 automatic restore. If more than one Copy is available, it will promote the copy
1389 with the smallest JobId.
1390
1391 A nice solution which can be built with the new Copy feature is often
1392 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1393 look something like the one below:
1394
1395 \begin{verbatim}
1396 Pool {
1397   Name = FullBackupsVirtualPool
1398   Pool Type = Backup
1399   Purge Oldest Volume = Yes
1400   Storage = vtl
1401   NextPool = FullBackupsTapePool
1402 }
1403
1404 Pool {
1405   Name = FullBackupsTapePool
1406   Pool Type = Backup
1407   Recycle = Yes
1408   AutoPrune = Yes
1409   Volume Retention = 365 days
1410   Storage = superloader
1411 }
1412
1413 #
1414 # Fake fileset for copy jobs
1415 #
1416 Fileset {
1417   Name = None
1418   Include {
1419     Options {
1420       signature = MD5
1421     }
1422   }
1423 }
1424
1425 #
1426 # Fake client for copy jobs
1427 #
1428 Client {
1429   Name = None
1430   Address = localhost
1431   Password = "NoNe"
1432   Catalog = MyCatalog
1433 }
1434
1435 #
1436 # Default template for a CopyDiskToTape Job
1437 #
1438 JobDefs {
1439   Name = CopyDiskToTape
1440   Type = Copy
1441   Messages = StandardCopy
1442   Client = None
1443   FileSet = None
1444   Selection Type = PoolUncopiedJobs
1445   Maximum Concurrent Jobs = 10
1446   SpoolData = No
1447   Allow Duplicate Jobs = Yes
1448   Cancel Queued Duplicates = No
1449   Cancel Running Duplicates = No
1450   Priority = 13
1451 }
1452
1453 Schedule {
1454    Name = DaySchedule7:00
1455    Run = Level=Full daily at 7:00
1456 }
1457
1458 Job {
1459   Name = CopyDiskToTapeFullBackups
1460   Enabled = Yes
1461   Schedule = DaySchedule7:00
1462   Pool = FullBackupsVirtualPool
1463   JobDefs = CopyDiskToTape
1464 }
1465 \end{verbatim}
1466
1467 The example above had 2 pool which are copied using the PoolUncopiedJobs
1468 selection criteria. Normal Full backups go to the Virtual pool and are copied
1469 to the Tape pool the next morning.
1470
1471 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1472 \textbf{jobid}.
1473
1474 \begin{verbatim}
1475 *list copies
1476 +-------+------------------------------------+-----------+------------------+
1477 | JobId | Job                                | CopyJobId | MediaType        |
1478 +-------+------------------------------------+-----------+------------------+
1479 |     9 | CopyJobSave.2008-12-20_22.26.49.05 |        11 | DiskChangerMedia |
1480 +-------+------------------------------------+-----------+------------------+
1481 \end{verbatim}
1482
1483 \section{ACL Updates}
1484 \index[general]{ACL Updates}
1485 The whole ACL code had been overhauled and in this version each platforms has
1486 different streams for each type of acl available on such an platform. As ACLs
1487 between platforms tend to be not that portable (most implement POSIX acls but
1488 some use an other draft or a completely different format) we currently only
1489 allow certain platform specific ACL streams to be decoded and restored on the
1490 same platform that they were created on.  The old code allowed to restore ACL
1491 cross platform but the comments already mention that not being to wise. For
1492 backward compatability the new code will accept the two old ACL streams and
1493 handle those with the platform specific handler. But for all new backups it
1494 will save the ACLs using the new streams.
1495
1496 Currently the following platforms support ACLs:
1497
1498 \begin{itemize}
1499  \item {\bf AIX}
1500  \item {\bf Darwin/OSX}
1501  \item {\bf FreeBSD}
1502  \item {\bf HPUX}
1503  \item {\bf IRIX}
1504  \item {\bf Linux}
1505  \item {\bf Tru64}
1506  \item {\bf Solaris}
1507 \end{itemize}
1508
1509 Currently we support the following ACL types (these ACL streams use a reserved
1510 part of the stream numbers):
1511
1512 \begin{itemize}
1513 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1514   acl\_get
1515  \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1516    string representation from acl\_to\_text (POSIX acl)
1517   \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1518     string representation from acl\_to\_text (POSIX acl) for default acls.
1519   \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1520     string representation from acl\_to\_text (POSIX acl) for access acls.
1521   \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1522     string representation from acltostr (POSIX acl)
1523   \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1524     representation from acl\_to\_text (POSIX acl) for default acls.
1525   \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1526     representation from acl\_to\_text (POSIX acl) for access acls.
1527   \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1528     string representation from acl\_to\_text (POSIX acl) for default acls.
1529   \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1530     representation from acl\_to\_text (POSIX acl) for access acls.
1531   \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1532     string representation from acl\_to\_text (POSIX acl) for default acls.
1533   \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1534     string representation from acl\_to\_text (POSIX acl) for default acls.
1535   \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1536     representation from acl\_to\_text (POSIX acl) for access acls.
1537   \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1538     string representation from acltotext or acl\_totext (POSIX acl)
1539   \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1540     representation from from acl\_totext (NFSv4 or ZFS acl)
1541 \end{itemize}
1542
1543 In future versions we might support conversion functions from one type of acl
1544 into an other for types that are either the same or easily convertable. For now
1545 the streams are seperate and restoring them on a platform that doesn't
1546 recognize them will give you a warning.
1547
1548 \section{Extended Attributes}
1549 \index[general]{Extended Attributes}
1550 Something that was on the project list for some time is now implemented for
1551 platforms that support a similar kind of interface. Its the support for backup
1552 and restore of so called extended attributes. As extended attributes are so
1553 platform specific these attributes are saved in seperate streams for each
1554 platform.  Restores of the extended attributes can only be performed on the
1555 same platform the backup was done.  There is support for all types of extended
1556 attributes, but restoring from one type of filesystem onto an other type of
1557 filesystem on the same platform may lead to supprises.  As extended attributes
1558 can contain any type of data they are stored as a series of so called
1559 value-pairs.  This data must be seen as mostly binary and is stored as such.
1560 As security labels from selinux are also extended attributes this option also
1561 stores those labels and no specific code is enabled for handling selinux
1562 security labels.
1563
1564 Currently the following platforms support extended attributes:
1565 \begin{itemize}
1566  \item {\bf Darwin/OSX}
1567  \item {\bf FreeBSD}
1568  \item {\bf Linux}
1569  \item {\bf NetBSD}
1570 \end{itemize}
1571
1572 On linux acls are also extended attributes, as such when you enable ACLs on a
1573 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1574 and not the same exteneded attribute.
1575
1576 To enable the backup of extended attributes please add the following to your
1577 fileset definition.
1578 \begin{verbatim}
1579   FileSet {
1580     Name = "MyFileSet"
1581     Include {
1582       Options {
1583         signature = MD5
1584         xattrsupport = yes
1585       }
1586       File = ...
1587     }
1588   }
1589 \end{verbatim}
1590
1591 \section{Shared objects}
1592 \index[general]{Shared objects}
1593 A default build of Bacula will now create the libraries as shared objects
1594 (.so) rather than static libraries as was previously the case.  
1595 The shared libraries are built using {\bf libtool} so it should be quite
1596 portable.
1597
1598 An important advantage of using shared objects is that on a machine with the
1599 Directory, File daemon, the Storage daemon, and a console, you will have only
1600 one copy of the code in memory rather than four copies.  Also the total size of
1601 the binary release is smaller since the library code appears only once rather
1602 than once for every program that uses it; this results in significant reduction
1603 in the size of the binaries particularly for the utility tools.
1604  
1605 In order for the system loader to find the shared objects when loading the
1606 Bacula binaries, the Bacula shared objects must either be in a shared object
1607 directory known to the loader (typically /usr/lib) or they must be in the
1608 directory that may be specified on the {\bf ./configure} line using the {\bf
1609   {-}{-}libdir} option as:
1610
1611 \begin{verbatim}
1612   ./configure --libdir=/full-path/dir
1613 \end{verbatim}
1614
1615 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1616 no need to modify your loader configuration provided that
1617 the shared objects are installed in that directory (Bacula
1618 does this with the make install command). The shared objects
1619 that Bacula references are:
1620
1621 \begin{verbatim}
1622 libbaccfg.so
1623 libbacfind.so
1624 libbacpy.so
1625 libbac.so
1626 \end{verbatim}
1627
1628 These files are symbolically linked to the real shared object file,
1629 which has a version number to permit running multiple versions of
1630 the libraries if desired (not normally the case).
1631
1632 If you have problems with libtool or you wish to use the old
1633 way of building static libraries, or you want to build a static
1634 version of Bacula you may disable
1635 libtool on the configure command line with:
1636
1637 \begin{verbatim}
1638   ./configure --disable-libtool
1639 \end{verbatim}
1640
1641
1642 \section{Building Static versions of Bacula}
1643 \index[general]{Static linking}
1644 In order to build static versions of Bacula, in addition
1645 to configuration options that were needed you now must
1646 also add --disable-libtool.  Example
1647
1648 \begin{verbatim}
1649   ./configure --enable-static-client-only --disable-libtool
1650 \end{verbatim}
1651
1652
1653 \section{Virtual Backup (Vbackup)}
1654 \index[general]{Virtual Backup}
1655 \index[general]{Vbackup}
1656
1657 Bacula's virtual backup feature is often called Synthetic Backup or
1658 Consolidation in other backup products.  It permits you to consolidate the
1659 previous Full backup plus the most recent Differential backup and any
1660 subsequent Incremental backups into a new Full backup.  This new Full
1661 backup will then be considered as the most recent Full for any future
1662 Incremental or Differential backups.  The VirtualFull backup is
1663 accomplished without contacting the client by reading the previous backup
1664 data and writing it to a volume in a different pool.
1665
1666 In some respects the Vbackup feature works similar to a Migration job, in
1667 that Bacula normally reads the data from the pool specified in the 
1668 Job resource, and writes it to the {\bf Next Pool} specified in the 
1669 Job resource. Note, this means that usually the output from the Virtual
1670 Backup is written into a different pool from where your prior backups
1671 are saved. Doing it this way guarantees that you will not get a deadlock
1672 situation attempting to read and write to the same volume in the Storage
1673 daemon. If you then want to do subsequent backups, you may need to
1674 move the Virtual Full Volume back to your normal backup pool.
1675 Alternatively, you can set your {\bf Next Pool} to point to the current
1676 pool.  This will cause Bacula to read and write to Volumes in the
1677 current pool. In general, this will work, because Bacula will
1678 not allow reading and writing on the same Volume. In any case, once
1679 a VirtualFull has been created, and a restore is done involving the
1680 most current Full, it will read the Volume or Volumes by the VirtualFull 
1681 regardless of in which Pool the Volume is found.
1682
1683 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1684 a level of {\bf VirtualFull}.
1685
1686 A typical Job resource definition might look like the following:
1687
1688 \begin{verbatim}
1689 Job {
1690   Name = "MyBackup"
1691   Type = Backup
1692   Client=localhost-fd
1693   FileSet = "Full Set"
1694   Storage = File
1695   Messages = Standard
1696   Pool = Default
1697   SpoolData = yes
1698 }
1699
1700 # Default pool definition
1701 Pool {
1702   Name = Default
1703   Pool Type = Backup
1704   Recycle = yes            # Automatically recycle Volumes
1705   AutoPrune = yes          # Prune expired volumes
1706   Volume Retention = 365d  # one year
1707   NextPool = Full
1708   Storage = File
1709 }
1710
1711 Pool {
1712   Name = Full
1713   Pool Type = Backup
1714   Recycle = yes            # Automatically recycle Volumes
1715   AutoPrune = yes          # Prune expired volumes
1716   Volume Retention = 365d  # one year
1717   Storage = DiskChanger
1718 }
1719
1720 # Definition of file storage device
1721 Storage {
1722   Name = File
1723   Address = localhost
1724   Password = "xxx"
1725   Device = FileStorage
1726   Media Type = File
1727   Maximum Concurrent Jobs = 5
1728 }
1729
1730 # Definition of DDS Virtual tape disk storage device
1731 Storage {
1732   Name = DiskChanger
1733   Address = localhost  # N.B. Use a fully qualified name here
1734   Password = "yyy"
1735   Device = DiskChanger
1736   Media Type = DiskChangerMedia
1737   Maximum Concurrent Jobs = 4
1738   Autochanger = yes
1739 }
1740 \end{verbatim}
1741
1742 Then in bconsole or via a Run schedule, you would run the job as:
1743
1744 \begin{verbatim}
1745 run job=MyBackup level=Full
1746 run job=MyBackup level=Incremental
1747 run job=MyBackup level=Differential
1748 run job=MyBackup level=Incremental
1749 run job=MyBackup level=Incremental
1750 \end{verbatim}
1751
1752 So providing there were changes between each of those jobs, you would end up
1753 with a Full backup, a Differential, which includes the first Incremental
1754 backup, then two Incremental backups.  All the above jobs would be written to
1755 the {\bf Default} pool.
1756
1757 To consolidate those backups into a new Full backup, you would run the
1758 following:
1759
1760 \begin{verbatim}
1761 run job=MyBackup level=VirtualFull
1762 \end{verbatim}
1763
1764 And it would produce a new Full backup without using the client, and the output
1765 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1766
1767 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1768 fail with an error.
1769
1770 Note, the Start and End time of the Virtual Full backup is set to the
1771 values for the last job included in the Virtual Full (in the above example,
1772 it is an Increment). This is so that if another incremental is done, which
1773 will be based on the Virtual Full, it will backup all files from the
1774 last Job included in the Virtual Full rather than from the time the Virtual
1775 Full was actually run.
1776
1777
1778
1779 \section{Catalog Format}
1780 \index[general]{Catalog Format}
1781 Bacula 3.0 comes with some changes to the catalog format.  The upgrade
1782 operation will convert the FileId field of the File table from 32 bits (max 4
1783 billion table entries) to 64 bits (very large number of items).  The
1784 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1785 your catalog during the conversion.  Also you won't be able to run jobs during
1786 this conversion period.  For example, a 3 million file catalog will take 2
1787 minutes to upgrade on a normal machine.  Please don't forget to make a valid
1788 backup of your database before executing the upgrade script. See the 
1789 ReleaseNotes for additional details.
1790
1791 \section{64 bit Windows Client}
1792 \index[general]{Win64 Client}
1793 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1794 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1795 As a consequence, we are also releasing a 64 bit version of the Bacula 
1796 Windows Client (win64bacula-3.0.0.exe) that does work with VSS. 
1797 These binaries should only be installed on 64 bit Windows operating systems.
1798 What is important is not your hardware but whether or not you have
1799 a 64 bit version of the Windows OS.  
1800
1801 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1802 \begin{enumerate}
1803 \item Before installing the Win64 Bacula Client, you must totally
1804       deinstall any prior 2.4.x Client installation using the 
1805       Bacula deinstallation (see the menu item). You may want
1806       to save your .conf files first.
1807 \item Only the Client (File daemon) is ported to Win64, the Director
1808       and the Storage daemon are not in the 64 bit Windows installer.
1809 \item bwx-console is not yet ported.
1810 \item bconsole is ported but it has not been tested.
1811 \item The documentation is not included in the installer.
1812 \item Due to Vista security restrictions imposed on a default installation
1813       of Vista, before upgrading the Client, you must manually stop
1814       any prior version of Bacula from running, otherwise the install
1815       will fail.
1816 \item Due to Vista security restrictions imposed on a default installation
1817       of Vista, attempting to edit the conf files via the menu items
1818       will fail. You must directly edit the files with appropriate 
1819       permissions.  Generally double clicking on the appropriate .conf
1820       file will work providing you have sufficient permissions.
1821 \item All Bacula files are now installed in 
1822       {\bf C:/Program Files/Bacula} except the main menu items,
1823       which are installed as before. This vastly simplifies the installation.
1824 \item If you are running on a foreign language version of Windows, most
1825       likely {\bf C:/Program Files} does not exist, so you should use the
1826       Custom installation and enter an appropriate location to install
1827       the files.
1828 \item The 3.0.0 Win32 Client continues to install files in the locations used
1829       by prior versions. For the next version we will convert it to use
1830       the same installation conventions as the Win64 version.
1831 \end{enumerate}
1832
1833 This project was funded by Bacula Systems.
1834
1835
1836 \section{Duplicate Job Control}
1837 \index[general]{Duplicate Jobs}
1838 The new version of Bacula provides four new directives that
1839 give additional control over what Bacula does if duplicate jobs 
1840 are started.  A duplicate job in the sense we use it here means
1841 a second or subsequent job with the same name starts.  This
1842 happens most frequently when the first job runs longer than expected because no 
1843 tapes are available.
1844
1845 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1846 are specified in the Job resource.
1847
1848 They are:
1849
1850 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1851 \index[general]{Allow Duplicate Jobs}
1852   If this directive is set to {\bf yes}, duplicate jobs will be run.  If
1853   the directive is set to {\bf no} (default) then only one job of a given name
1854   may run at one time, and the action that Bacula takes to ensure only
1855   one job runs is determined by the other directives (see below).
1856  
1857   If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1858   are present and none of the three directives given below permit
1859   cancelling a job, then the current job (the second one started)
1860   will be cancelled.
1861
1862 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1863 \index[general]{Allow Higher Duplicates}
1864   This directive was in version 5.0.0, but does not work as
1865   expected. If used, it should always be set to no.  In later versions
1866   of Bacula the directive is disabled (disregarded).
1867
1868 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1869 \index[general]{Cancel Running Duplicates}
1870   If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1871   if this directive is set to {\bf yes} any job that is already running
1872   will be canceled.  The default is {\bf no}.
1873
1874 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1875 \index[general]{Cancel Queued Duplicates}
1876   If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1877   if this directive is set to {\bf yes} any job that is
1878   already queued to run but not yet running will be canceled.
1879   The default is {\bf no}. 
1880
1881
1882 \section{TLS Authentication}
1883 \index[general]{TLS Authentication}
1884 In Bacula version 2.5.x and later, in addition to the normal Bacula
1885 CRAM-MD5 authentication that is used to authenticate each Bacula
1886 connection, you can specify that you want TLS Authentication as well,
1887 which will provide more secure authentication.
1888
1889 This new feature uses Bacula's existing TLS code (normally used for
1890 communications encryption) to do authentication.  To use it, you must
1891 specify all the TLS directives normally used to enable communications
1892 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1893 a new directive:
1894
1895 \subsection{TLS Authenticate = yes}
1896 \begin{verbatim}
1897 TLS Authenticate = yes
1898 \end{verbatim}
1899
1900 in the main daemon configuration resource (Director for the Director,
1901 Client for the File daemon, and Storage for the Storage daemon).
1902
1903 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1904 authentication, Bacula will also do TLS authentication, then TLS 
1905 encryption will be turned off, and the rest of the communication between
1906 the two Bacula daemons will be done without encryption.
1907
1908 If you want to encrypt communications data, use the normal TLS directives
1909 but do not turn on {\bf TLS Authenticate}.
1910
1911 \section{bextract non-portable Win32 data}
1912 \index[general]{bextract handles Win32 non-portable data}
1913 {\bf bextract} has been enhanced to be able to restore
1914 non-portable Win32 data to any OS.  Previous versions were 
1915 unable to restore non-portable Win32 data to machines that
1916 did not have the Win32 BackupRead and BackupWrite API calls.
1917
1918 \section{State File updated at Job Termination}
1919 \index[general]{State File}
1920 In previous versions of Bacula, the state file, which provides a
1921 summary of previous jobs run in the {\bf status} command output was
1922 updated only when Bacula terminated, thus if the daemon crashed, the
1923 state file might not contain all the run data.  This version of
1924 the Bacula daemons updates the state file on each job termination.
1925
1926 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1927 \index[general]{MaxFullInterval}
1928 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1929 can be used to specify the maximum time interval between {\bf Full} backup
1930 jobs. When a job starts, if the time since the last Full backup is
1931 greater than the specified interval, and the job would normally be an
1932 {\bf Incremental} or {\bf Differential}, it will be automatically
1933 upgraded to a {\bf Full} backup.
1934
1935 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1936 \index[general]{MaxDiffInterval}
1937 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1938 can be used to specify the maximum time interval between {\bf Differential} backup
1939 jobs. When a job starts, if the time since the last Differential backup is
1940 greater than the specified interval, and the job would normally be an
1941 {\bf Incremental}, it will be automatically
1942 upgraded to a {\bf Differential} backup.
1943
1944 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1945 \index[general]{MaxDiffInterval}
1946 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1947 by the user, and when it is set it is an indication to backup programs
1948 to not backup that particular file.  This version of Bacula contains a
1949 new Options directive within a FileSet resource, which instructs Bacula to
1950 obey this flag.  The new directive is:
1951
1952 \begin{verbatim}
1953   Honor No Dump Flag = yes\vb{}no
1954 \end{verbatim}
1955
1956 The default value is {\bf no}.
1957
1958
1959 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1960 \index[general]{IgnoreDir}
1961 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1962 can be added to the Include section of the FileSet resource.  If the specified
1963 filename ({\bf filename-string}) is found on the Client in any directory to be
1964 backed up, the whole directory will be ignored (not backed up).  For example:
1965
1966 \begin{verbatim}
1967   # List of files to be backed up
1968   FileSet {
1969     Name = "MyFileSet"
1970     Include {
1971       Options {
1972         signature = MD5
1973       }
1974       File = /home
1975       Exclude Dir Containing = .excludeme
1976     }
1977   }
1978 \end{verbatim}
1979
1980 But in /home, there may be hundreds of directories of users and some
1981 people want to indicate that they don't want to have certain
1982 directories backed up. For example, with the above FileSet, if
1983 the user or sysadmin creates a file named {\bf .excludeme} in 
1984 specific directories, such as
1985
1986 \begin{verbatim}
1987    /home/user/www/cache/.excludeme
1988    /home/user/temp/.excludeme
1989 \end{verbatim}
1990
1991 then Bacula will not backup the two directories named:
1992
1993 \begin{verbatim}
1994    /home/user/www/cache
1995    /home/user/temp
1996 \end{verbatim}
1997
1998 NOTE: subdirectories will not be backed up.  That is, the directive
1999 applies to the two directories in question and any children (be they
2000 files, directories, etc).
2001
2002
2003 \section{Bacula Plugins}
2004 \index[general]{Plugin}
2005 Support for shared object plugins has been implemented in the Linux, Unix
2006 and Win32 File daemons. The API will be documented separately in
2007 the Developer's Guide or in a new document.  For the moment, there is
2008 a single plugin named {\bf bpipe} that allows an external program to
2009 get control to backup and restore a file.
2010
2011 Plugins are also planned (partially implemented) in the Director and the
2012 Storage daemon.  
2013
2014 \subsection{Plugin Directory}
2015 \index[general]{Plugin Directory}
2016 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2017 be added to the daemon definition resource. The directory takes a quoted 
2018 string argument, which is the name of the directory in which the daemon can
2019 find the Bacula plugins. If this directive is not specified, Bacula will not
2020 load any plugins. Since each plugin has a distinctive name, all the daemons
2021 can share the same plugin directory. 
2022
2023 \subsection{Plugin Options}
2024 \index[general]{Plugin Options}
2025 The {\bf Plugin Options} directive takes a quoted string
2026 arguement (after the equal sign) and may be specified in the
2027 Job resource.  The options specified will be passed to all plugins
2028 when they are run.  This each plugin must know what it is looking
2029 for. The value defined in the Job resource can be modified
2030 by the user when he runs a Job via the {\bf bconsole} command line 
2031 prompts.
2032
2033 Note: this directive may be specified, and there is code to modify
2034 the string in the run command, but the plugin options are not yet passed to
2035 the plugin (i.e. not fully implemented).
2036
2037 \subsection{Plugin Options ACL}
2038 \index[general]{Plugin Options ACL}
2039 The {\bf Plugin Options ACL} directive may be specified in the
2040 Director's Console resource. It functions as all the other ACL commands
2041 do by permitting users running restricted consoles to specify a 
2042 {\bf Plugin Options} that overrides the one specified in the Job
2043 definition. Without this directive restricted consoles may not modify
2044 the Plugin Options.
2045
2046 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2047 \index[general]{Plugin}
2048 The {\bf Plugin} directive is specified in the Include section of
2049 a FileSet resource where you put your {\bf File = xxx} directives.
2050 For example:
2051
2052 \begin{verbatim}
2053   FileSet {
2054     Name = "MyFileSet"
2055     Include {
2056       Options {
2057         signature = MD5
2058       }
2059       File = /home
2060       Plugin = "bpipe:..."
2061     }
2062   }
2063 \end{verbatim}
2064
2065 In the above example, when the File daemon is processing the directives
2066 in the Include section, it will first backup all the files in {\bf /home}
2067 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2068 the Plugin Directory.  The syntax and semantics of the Plugin directive
2069 require the first part of the string up to the colon (:) to be the name
2070 of the plugin. Everything after the first colon is ignored by the File daemon but
2071 is passed to the plugin. Thus the plugin writer may define the meaning of the
2072 rest of the string as he wishes.
2073
2074 Please see the next section for information about the {\bf bpipe} Bacula
2075 plugin.
2076
2077 \section{The bpipe Plugin}
2078 \index[general]{The bpipe Plugin}
2079 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2080 the Bacula source distribution. When the plugin is compiled and linking into
2081 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2082 Please note that this is a very simple plugin that was written for
2083 demonstration and test purposes. It is and can be used in production, but
2084 that was never really intended.
2085
2086 The purpose of the plugin is to provide an interface to any system program for
2087 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2088 the Include section of your Job's FileSet resource.  The full syntax of the
2089 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2090 to specify the sytax as it wishes) is:
2091
2092 \begin{verbatim}
2093   Plugin = "<field1>:<field2>:<field3>:<field4>"
2094 \end{verbatim}
2095
2096 where
2097 \begin{description}
2098 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2099 stripped off, so in this case, we would put {\bf bpipe} in this field.
2100
2101 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2102 pseudo path and filename under which the backup will be saved. This pseudo
2103 path and filename will be seen by the user in the restore file tree.
2104 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2105 backed up by the plugin will be put under that "pseudo" path and filename.
2106 You must be careful to choose a naming convention that is unique to avoid
2107 a conflict with a path and filename that actually exists on your system.
2108
2109 \item {\bf field3} for the {\bf bpipe} plugin 
2110 specifies the "reader" program that is called by the plugin during
2111 backup to read the data. {\bf bpipe} will call this program by doing a
2112 {\bf popen} on it. 
2113
2114 \item {\bf field4} for the {\bf bpipe} plugin
2115 specifies the "writer" program that is called by the plugin during
2116 restore to write the data back to the filesystem.  
2117 \end{description}
2118
2119 Please note that for two items above describing the "reader" and "writer"
2120 fields, these programs are "executed" by Bacula, which
2121 means there is no shell interpretation of any command line arguments
2122 you might use.  If you want to use shell characters (redirection of input
2123 or output, ...), then we recommend that you put your command or commands
2124 in a shell script and execute the script. In addition if you backup a
2125 file with the reader program, when running the writer program during
2126 the restore, Bacula will not automatically create the path to the file.
2127 Either the path must exist, or you must explicitly do so with your command
2128 or in a shell script.
2129
2130 Putting it all together, the full plugin directive line might look
2131 like the following:
2132
2133 \begin{verbatim}
2134 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f 
2135           --opt --databases bacula:mysql"
2136 \end{verbatim}
2137
2138 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2139 would be written on a single line.
2140
2141 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2142 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the 
2143 program {\bf mysqldump -f --opt --database bacula} to read the data during
2144 backup. The mysqldump command outputs all the data for the database named
2145 {\bf bacula}, which will be read by the plugin and stored in the backup.
2146 During restore, the data that was backed up will be sent to the program
2147 specified in the last field, which in this case is {\bf mysql}.  When
2148 {\bf mysql} is called, it will read the data sent to it by the plugn
2149 then write it back to the same database from which it came ({\bf bacula}
2150 in this case).
2151
2152 The {\bf bpipe} plugin is a generic pipe program, that simply transmits 
2153 the data from a specified program to Bacula for backup, and then from Bacula to 
2154 a specified program for restore.
2155
2156 By using different command lines to {\bf bpipe},
2157 you can backup any kind of data (ASCII or binary) depending
2158 on the program called.
2159
2160 \section{Microsoft Exchange Server 2003/2007 Plugin}
2161 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2162 \subsection{Background}
2163 The Exchange plugin was made possible by a funded development project
2164 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2165 The code for the plugin was written by James Harper, and the Bacula core
2166 code by Kern Sibbald.  All the code for this funded development has become
2167 part of the Bacula project.  Thanks to everyone who made it happen.
2168
2169 \subsection{Concepts}
2170 Although it is possible to backup Exchange using Bacula VSS the Exchange 
2171 plugin adds a good deal of functionality, because while Bacula VSS
2172 completes a full backup (snapshot) of Exchange, it does
2173 not support Incremental or Differential backups, restoring is more
2174 complicated, and a single database restore is not possible.
2175
2176 Microsoft Exchange organises its storage into Storage Groups with
2177 Databases inside them. A default installation of Exchange will have a
2178 single Storage Group called 'First Storage Group', with two Databases
2179 inside it, "Mailbox Store (SERVER NAME)" and 
2180 "Public Folder Store (SERVER NAME)", 
2181 which hold user email and public folders respectively.
2182
2183 In the default configuration, Exchange logs everything that happens to
2184 log files, such that if you have a backup, and all the log files since,
2185 you can restore to the present time. Each Storage Group has its own set
2186 of log files and operates independently of any other Storage Groups. At
2187 the Storage Group level, the logging can be turned off by enabling a
2188 function called "Enable circular logging". At this time the Exchange
2189 plugin will not function if this option is enabled.
2190
2191 The plugin allows backing up of entire storage groups, and the restoring
2192 of entire storage groups or individual databases. Backing up and
2193 restoring at the individual mailbox or email item is not supported but
2194 can be simulated by use of the "Recovery" Storage Group (see below).
2195
2196 \subsection{Installing}
2197 The Exchange plugin requires a DLL that is shipped with Microsoft
2198 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2199 correctly the Exchange plugin should find this automatically and run
2200 without any additional installation.
2201
2202 If the DLL can not be found automatically it will need to be copied into
2203 the Bacula installation
2204 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2205 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2206 default Exchange installation.
2207
2208 \subsection{Backing Up}
2209 To back up an Exchange server the Fileset definition must contain at
2210 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2211 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2212 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2213 up files are prefixed with something that isn't going to share a name
2214 with something outside the plugin, and the 'Microsoft Information Store'
2215 bit is required also. It is also possible to add the name of a storage
2216 group to the "Plugin =" line, eg \\
2217 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2218 if you want only a single storage group backed up.
2219
2220 Additionally, you can suffix the 'Plugin =' directive with
2221 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2222 database at the end of a full backup.
2223
2224 An Incremental or Differential backup will backup only the database logs
2225 for each Storage Group by inspecting the "modified date" on each
2226 physical log file. Because of the way the Exchange API works, the last
2227 logfile backed up on each backup will always be backed up by the next
2228 Incremental or Differential backup too. This adds 5MB to each
2229 Incremental or Differential backup size but otherwise does not cause any
2230 problems.
2231
2232 By default, a normal VSS fileset containing all the drive letters will
2233 also back up the Exchange databases using VSS. This will interfere with
2234 the plugin and Exchange's shared ideas of when the last full backup was
2235 done, and may also truncate log files incorrectly. It is important,
2236 therefore, that the Exchange database files be excluded from the backup,
2237 although the folders the files are in should be included, or they will
2238 have to be recreated manually if a baremetal restore is done.
2239
2240 \begin{verbatim}
2241 FileSet {
2242    Include {
2243       File = C:/Program Files/Exchsrvr/mdbdata
2244       Plugin = "exchange:..."
2245    }
2246    Exclude {
2247       File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2248       File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2249       File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2250       File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2251       File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2252       File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2253       File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2254    }
2255 }
2256 \end{verbatim}
2257
2258 The advantage of excluding the above files is that you can significantly
2259 reduce the size of your backup since all the important Exchange files
2260 will be properly saved by the Plugin.
2261
2262
2263 \subsection{Restoring}
2264 The restore operation is much the same as a normal Bacula restore, with
2265 the following provisos:
2266
2267 \begin{itemize}
2268 \item  The {\bf Where} restore option must not be specified
2269 \item Each Database directory must be marked as a whole. You cannot just
2270      select (say) the .edb file and not the others.
2271 \item If a Storage Group is restored, the directory of the Storage Group
2272      must be marked too.
2273 \item  It is possible to restore only a subset of the available log files,
2274      but they {\bf must} be contiguous. Exchange will fail to restore correctly
2275      if a log file is missing from the sequence of log files
2276 \item Each database to be restored must be dismounted and marked as "Can be
2277     overwritten by restore"
2278 \item If an entire Storage Group is to be restored (eg all databases and
2279    logs in the Storage Group), then it is best to manually delete the
2280    database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2281    as Exchange can get confused by stray log files lying around.
2282 \end{itemize}
2283
2284 \subsection{Restoring to the Recovery Storage Group}
2285 The concept of the Recovery Storage Group is well documented by
2286 Microsoft 
2287 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126}, 
2288 but to briefly summarize...
2289
2290 Microsoft Exchange allows the creation of an additional Storage Group
2291 called the Recovery Storage Group, which is used to restore an older
2292 copy of a database (e.g. before a mailbox was deleted) into without
2293 messing with the current live data. This is required as the Standard and
2294 Small Business Server versions of Exchange can not ordinarily have more
2295 than one Storage Group.
2296
2297 To create the Recovery Storage Group, drill down to the Server in Exchange
2298 System Manager, right click, and select
2299 {\bf "New -> Recovery Storage Group..."}.  Accept or change the file
2300 locations and click OK. On the Recovery Storage Group, right click and
2301 select {\bf "Add Database to Recover..."} and select the database you will
2302 be restoring.
2303
2304 Restore only the single database nominated as the database in the
2305 Recovery Storage Group. Exchange will redirect the restore to the
2306 Recovery Storage Group automatically.
2307 Then run the restore.
2308
2309 \subsection{Restoring on Microsoft Server 2007}
2310 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2311 2007, and henc you use a new proceedure for recovering a single mail box.
2312 This procedure is ducomented by Microsoft at:
2313 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2314 and involves using the {\bf Restore-Mailbox} and {\bf
2315 Get-MailboxStatistics} shell commands.
2316
2317 \subsection{Caveats}
2318 This plugin is still being developed, so you should consider it
2319 currently in BETA test, and thus use in a production environment
2320 should be done only after very careful testing.
2321
2322 When doing a full backup, the Exchange database logs are truncated by
2323 Exchange as soon as the plugin has completed the backup. If the data
2324 never makes it to the backup medium (eg because of spooling) then the
2325 logs will still be truncated, but they will also not have been backed
2326 up. A solution to this is being worked on. You will have to schedule a
2327 new Full backup to ensure that your next backups will be usable.
2328
2329 The "Enable Circular Logging" option cannot be enabled or the plugin
2330 will fail.
2331
2332 Exchange insists that a successful Full backup must have taken place if
2333 an Incremental or Differential backup is desired, and the plugin will
2334 fail if this is not the case. If a restore is done, Exchange will
2335 require that a Full backup be done before an Incremental or Differential
2336 backup is done.
2337
2338 The plugin will most likely not work well if another backup application
2339 (eg NTBACKUP) is backing up the Exchange database, especially if the
2340 other backup application is truncating the log files.
2341
2342 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2343 we recommend either carefully testing or that you avoid this option for
2344 the current time.
2345
2346 The Exchange plugin is not called during processing the bconsole {\bf
2347 estimate} command, and so anything that would be backed up by the plugin
2348 will not be added to the estimate total that is displayed.
2349
2350
2351 \section{libdbi Framework}
2352 \index[general]{libdbi Framework}
2353 As a general guideline, Bacula has support for a few catalog database drivers
2354 (MySQL, PostgreSQL, SQLite)
2355 coded natively by the Bacula team.  With the libdbi implementation, which is a
2356 Bacula driver that uses libdbi to access the catalog, we have an open field to
2357 use many different kinds database engines following the needs of users.
2358
2359 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2360 implements a database-independent abstraction layer in C, similar to the
2361 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2362 leverage the power of multiple databases and multiple simultaneous database
2363 connections by using this framework.
2364
2365 Currently the libdbi driver in Bacula project only supports the same drivers
2366 natively coded in Bacula.  However the libdbi project has support for many
2367 others database engines. You can view the list at
2368 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2369 supported by Bacula, however, they must be tested properly by the Bacula team.
2370
2371 Some of benefits of using libdbi are:
2372 \begin{itemize}
2373 \item The possibility to use proprietary databases engines in which your
2374   proprietary licenses prevent the Bacula team from developing the driver.
2375  \item The possibility to use the drivers written for the libdbi project.
2376  \item The possibility to use other database engines without recompiling Bacula
2377    to use them.  Just change one line in bacula-dir.conf
2378  \item Abstract Database access, this is, unique point to code and profiling
2379    catalog database access.
2380  \end{itemize}
2381  
2382  The following drivers have been tested:
2383  \begin{itemize}
2384  \item PostgreSQL, with and without batch insert
2385  \item Mysql, with and without batch insert
2386  \item SQLite
2387  \item SQLite3
2388  \end{itemize}
2389
2390  In the future, we will test and approve to use others databases engines
2391  (proprietary or not) like DB2, Oracle, Microsoft SQL.
2392
2393  To compile Bacula to support libdbi we need to configure the code with the
2394  --with-dbi and --with-dbi-driver=[database] ./configure options, where
2395  [database] is the database engine to be used with Bacula (of course we can
2396  change the driver in file bacula-dir.conf, see below).  We must configure the
2397  access port of the database engine with the option --with-db-port, because the
2398  libdbi framework doesn't know the default access port of each database.
2399
2400 The next phase is checking (or configuring) the bacula-dir.conf, example:
2401 \begin{verbatim}
2402 Catalog {
2403   Name = MyCatalog
2404   dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2405   dbname = regress; user = regress; password = ""
2406 }
2407 \end{verbatim}
2408
2409 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2410 mysql database.  Currently the drivers supported by Bacula are: postgresql,
2411 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2412
2413 The following limitations apply when Bacula is set to use the libdbi framework:
2414  - Not tested on the Win32 platform
2415  - A little performance is lost if comparing with native database driver. 
2416    The reason is bound with the database driver provided by libdbi and the 
2417    simple fact that one more layer of code was added.
2418
2419 It is important to remember, when compiling Bacula with libdbi, the
2420 following packages are needed:
2421  \begin{itemize}
2422   \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2423   \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2424  \end{itemize}
2425  
2426  You can download them and compile them on your system or install the packages
2427  from your OS distribution.
2428
2429 \section{Console Command Additions and Enhancements}
2430 \index[general]{Console Additions}                                 
2431
2432 \subsection{Display Autochanger Content}
2433 \index[general]{StatusSlots}
2434
2435 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2436 autochanger content.
2437
2438 \footnotesize
2439 \begin{verbatim}
2440  Slot |  Volume Name  |  Status  |  Media Type       |   Pool     |
2441 ------+---------------+----------+-------------------+------------|
2442     1 |         00001 |   Append |  DiskChangerMedia |    Default |
2443     2 |         00002 |   Append |  DiskChangerMedia |    Default |
2444     3*|         00003 |   Append |  DiskChangerMedia |    Scratch |
2445     4 |               |          |                   |            |
2446 \end{verbatim}
2447 \normalsize
2448
2449 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2450 {\bf update slots} command to synchronize autochanger content with your
2451 catalog.
2452
2453 \subsection{list joblog job=xxx or jobid=nnn}
2454 \index[general]{list joblog}
2455 A new list command has been added that allows you to list the contents
2456 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2457 or for a particular JobId.  The {\bf llist} command will include a line with
2458 the time and date of the entry.
2459
2460 Note for the catalog to have Job Log entries, you must have a directive 
2461 such as:
2462
2463 \begin{verbatim}
2464   catalog = all
2465 \end{verbatim}
2466
2467 In your Director's {\bf Messages} resource.
2468
2469 \subsection{Use separator for multiple commands}
2470 \index[general]{Command Separator}
2471   When using bconsole with readline, you can set the command separator with 
2472   \textbf{@separator} command to one
2473   of those characters to write commands who require multiple input in one line.
2474 \begin{verbatim}
2475   !$%&'()*+,-/:;<>?[]^`{|}~
2476 \end{verbatim}
2477
2478 \subsection{Deleting Volumes}
2479 The delete volume bconsole command has been modified to
2480 require an asterisk (*) in front of a MediaId otherwise the
2481 value you enter is a taken to be a Volume name. This is so that
2482 users may delete numeric Volume names. The previous Bacula versions
2483 assumed that all input that started with a number was a MediaId.
2484
2485 This new behavior is indicated in the prompt if you read it
2486 carefully.
2487
2488 \section{Bare Metal Recovery}
2489 The old bare metal recovery project is essentially dead. One
2490 of the main features of it was that it would build a recovery
2491 CD based on the kernel on your system. The problem was that
2492 every distribution has a different boot procedure and different 
2493 scripts, and worse yet, the boot procedures and scripts change
2494 from one distribution to another.  This meant that maintaining
2495 (keeping up with the changes) the rescue CD was too much work.
2496
2497 To replace it, a new bare metal recovery USB boot stick has been developed
2498 by Bacula Systems.  This technology involves remastering a Ubuntu LiveCD to
2499 boot from a USB key.  
2500
2501 Advantages: 
2502 \begin{enumerate} 
2503 \item Recovery can be done from within graphical environment.  
2504 \item Recovery can be done in a shell.  
2505 \item Ubuntu boots on a large number of Linux systems.  
2506 \item The process of updating the system and adding new
2507    packages is not too difficult. 
2508 \item The USB key can easily be upgraded to newer Ubuntu versions.
2509 \item The USB key has writable partitions for modifications to
2510    the OS and for modification to your home directory.
2511 \item You can add new files/directories to the USB key very easily.
2512 \item You can save the environment from multiple machines on
2513    one USB key.
2514 \item Bacula Systems is funding its ongoing development.
2515 \end{enumerate}
2516
2517 The disadvantages are:
2518 \begin{enumerate}
2519 \item The USB key is usable but currently under development.
2520 \item Not everyone may be familiar with Ubuntu (no worse
2521   than using Knoppix)
2522 \item Some older OSes cannot be booted from USB. This can
2523    be resolved by first booting a Ubuntu LiveCD then plugging
2524    in the USB key.
2525 \item Currently the documentation is sketchy and not yet added
2526    to the main manual. See below ...
2527 \end{enumerate}
2528
2529 The documentation and the code can be found in the {\bf rescue} package
2530 in the directory {\bf linux/usb}.
2531
2532 \section{Miscellaneous}
2533 \index[general]{Misc New Features}
2534
2535 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2536 \index[general]{Allow Mixed Priority}
2537    This directive is only implemented in version 2.5 and later.  When
2538    set to {\bf yes} (default {\bf no}), this job may run even if lower
2539    priority jobs are already running.  This means a high priority job
2540    will not have to wait for other jobs to finish before starting.
2541    The scheduler will only mix priorities when all running jobs have
2542    this set to true.
2543
2544    Note that only higher priority jobs will start early.  Suppose the
2545    director will allow two concurrent jobs, and that two jobs with
2546    priority 10 are running, with two more in the queue.  If a job with
2547    priority 5 is added to the queue, it will be run as soon as one of
2548    the running jobs finishes.  However, new priority 10 jobs will not
2549    be run until the priority 5 job has finished.
2550
2551 \subsection{Bootstrap File Directive -- FileRegex}
2552 \index[general]{Bootstrap File Directive}
2553   {\bf FileRegex} is a new command that can be added to the bootstrap
2554   (.bsr) file.  The value is a regular expression.  When specified, only
2555   matching filenames will be restored.
2556
2557   During a restore, if all File records are pruned from the catalog
2558   for a Job, normally Bacula can restore only all files saved. That
2559   is there is no way using the catalog to select individual files.
2560   With this new feature, Bacula will ask if you want to specify a Regex
2561   expression for extracting only a part of the full backup.
2562
2563 \begin{verbatim}
2564   Building directory tree for JobId(s) 1,3 ...
2565   There were no files inserted into the tree, so file selection
2566   is not possible.Most likely your retention policy pruned the files
2567   
2568   Do you want to restore all the files? (yes\vb{}no): no
2569   
2570   Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2571   Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2572 \end{verbatim}
2573
2574 \subsection{Bootstrap File Optimization Changes}
2575 In order to permit proper seeking on disk files, we have extended the bootstrap
2576 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2577 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2578 address range and end address range respectively.  These two directives replace
2579 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2580   VolEndBlock} directives.  Bootstrap files containing the old directives will
2581 still work, but will not properly take advantage of proper disk seeking, and
2582 may read completely to the end of a disk volume during a restore.  With the new
2583 format (automatically generated by the new Director), restores will seek
2584 properly and stop reading the volume when all the files have been restored.
2585
2586 \subsection{Solaris ZFS/NFSv4 ACLs}
2587 This is an upgrade of the previous Solaris ACL backup code
2588 to the new library format, which will backup both the old
2589 POSIX(UFS) ACLs as well as the ZFS ACLs.
2590
2591 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2592 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2593 be used to transfer from UFS to ZFS filesystems.
2594
2595
2596 \subsection{Virtual Tape Emulation}
2597 \index[general]{Virtual Tape Emulation}
2598 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2599 the tape code but actually reading and writing to a disk file. Used with the
2600 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2601 and 700 slots. This feature is most useful in testing.  It is enabled
2602 by using {\bf Device Type = vtape} in the Storage daemon's Device
2603 directive. This feature is only implemented on Linux machines and should not be
2604 used for production.
2605
2606 \subsection{Bat Enhancements}
2607 \index[general]{Bat Enhancements}
2608 Bat (the Bacula Administration Tool) GUI program has been significantly
2609 enhanced and stabilized. In particular, there are new table based status 
2610 commands; it can now be easily localized using Qt4 Linguist.
2611
2612 The Bat communications protocol has been significantly enhanced to improve
2613 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2614 the Director you are using otherwise the communications protocol will not
2615 work.
2616
2617 \subsection{RunScript Enhancements}
2618 \index[general]{RunScript Enhancements}
2619 The {\bf RunScript} resource has been enhanced to permit multiple
2620 commands per RunScript.  Simply specify multiple {\bf Command} directives
2621 in your RunScript.
2622
2623 \begin{verbatim}
2624 Job {
2625   Name = aJob
2626   RunScript {
2627     Command = "/bin/echo test"
2628     Command = "/bin/echo an other test"
2629     Command = "/bin/echo 3 commands in the same runscript"
2630     RunsWhen = Before
2631   }
2632  ...
2633 }
2634 \end{verbatim}
2635
2636 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2637 implemented, which runs the command after the Volume Shadow Copy has been made.
2638
2639 Console commands can be specified within a RunScript by using:
2640 {\bf Console = \lt{}command\gt{}}, however, this command has not been 
2641 carefully tested and debugged and is known to easily crash the Director.
2642 We would appreciate feedback.  Due to the recursive nature of this command, we
2643 may remove it before the final release.
2644
2645 \subsection{Status Enhancements}
2646 \index[general]{Status Enhancements}
2647 The bconsole {\bf status dir} output has been enhanced to indicate
2648 Storage daemon job spooling and despooling activity.
2649
2650 \subsection{Connect Timeout}
2651 \index[general]{Connect Timeout}
2652 The default connect timeout to the File
2653 daemon has been set to 3 minutes. Previously it was 30 minutes.
2654
2655 \subsection{ftruncate for NFS Volumes}
2656 \index[general]{ftruncate for NFS Volumes}
2657 If you write to a Volume mounted by NFS (say on a local file server),
2658 in previous Bacula versions, when the Volume was recycled, it was not
2659 properly truncated because NFS does not implement ftruncate (file 
2660 truncate). This is now corrected in the new version because we have
2661 written code (actually a kind user) that deletes and recreates the Volume,
2662 thus accomplishing the same thing as a truncate.
2663
2664 \subsection{Support for Ubuntu}
2665 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2666 version of Linux, and thus now provides correct autostart routines.
2667 Since Ubuntu officially supports Bacula, you can also obtain any
2668 recent release of Bacula from the Ubuntu repositories.
2669
2670 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2671 \index[general]{Recycle Pool}
2672 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2673 be placed (moved) when it is recycled. Without this directive, a Volume will
2674 remain in the same pool when it is recycled. With this directive, it can be
2675 moved automatically to any existing pool during a recycle. This directive is
2676 probably most useful when defined in the Scratch pool, so that volumes will
2677 be recycled back into the Scratch pool.
2678
2679 \subsection{FD Version}
2680 \index[general]{FD Version}
2681 The File daemon to Director protocol now includes a version 
2682 number, which although there is no visible change for users, 
2683 will help us in future versions automatically determine
2684 if a File daemon is not compatible.
2685
2686 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2687 \index[general]{Max Run Sched Time}
2688 The time specifies the maximum allowed time that a job may run, counted from
2689 when the job was scheduled. This can be useful to prevent jobs from running
2690 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2691   Time}.
2692
2693 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2694 \index[general]{Max Wait Time}
2695 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2696 of checking the maximum allowed time that a job may block for a resource,
2697 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2698 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2699 their job depending on the level. Now, they have to use
2700 \textbf{Incr/Diff/Full Max Run Time}.  \textbf{Incr/Diff/Full Max Wait Time}
2701 directives are now deprecated.
2702
2703 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}} 
2704 \index[general]{Incremental Max Wait Time}
2705 \index[general]{Differential Max Wait Time}
2706
2707 These directives have been deprecated in favor of
2708 \texttt{Incremental|Differential Max Run Time}.
2709
2710 \subsection{Max Run Time directives}
2711 \index[general]{Max Run Time directives}
2712 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2713 maximum allowed time that a job can run depending on the level.
2714
2715 \addcontentsline{lof}{figure}{Job time control directives}
2716 \includegraphics{\idir different_time.eps}
2717
2718 \subsection{Statistics Enhancements}
2719 \index[general]{Statistics Enhancements}
2720 If you (or probably your boss) want to have statistics on your backups to
2721 provide some \textit{Service Level Agreement} indicators, you could use a few
2722 SQL queries on the Job table to report how many:
2723
2724 \begin{itemize}
2725 \item jobs have run
2726 \item jobs have been successful
2727 \item files have been backed up
2728 \item ...
2729 \end{itemize}
2730
2731 However, these statistics are accurate only if your job retention is greater
2732 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2733 be able to use them. 
2734
2735 Now, you can use the \textbf{update stats [days=num]} console command to fill
2736 the JobHistory table with new Job records. If you want to be sure to take in
2737 account only \textbf{good jobs}, ie if one of your important job has failed but
2738 you have fixed the problem and restarted it on time, you probably want to
2739 delete the first \textit{bad} job record and keep only the successful one. For
2740 that simply let your staff do the job, and update JobHistory table after two or
2741 three days depending on your organization using the \textbf{[days=num]} option.
2742
2743 These statistics records aren't used for restoring, but mainly for
2744 capacity planning, billings, etc.
2745
2746 The Bweb interface provides a statistics module that can use this feature. You
2747 can also use tools like Talend or extract information by yourself.
2748
2749 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2750 the length of time that Bacula will keep statistics job records in the Catalog
2751 database after the Job End time. (In \texttt{JobHistory} table) When this time
2752 period expires, and if user runs \texttt{prune stats} command, Bacula will
2753 prune (remove) Job records that are older than the specified period.
2754
2755 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2756 job to maintain statistics.
2757 \begin{verbatim}
2758 Job {
2759   Name = BackupCatalog
2760   ...
2761   RunScript {
2762     Console = "update stats days=3"
2763     Console = "prune stats yes"
2764     RunsWhen = After
2765     RunsOnClient = no
2766   }
2767 }
2768 \end{verbatim}
2769
2770 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2771 \index[general]{ScratchPool}
2772 This directive permits to specify a specific \textsl{Scratch} pool for the
2773 current pool. This is useful when using multiple storage sharing the same
2774 mediatype or when you want to dedicate volumes to a particular set of pool.
2775
2776 \subsection{Enhanced Attribute Despooling}
2777 \index[general]{Attribute Despooling}
2778 If the storage daemon and the Director are on the same machine, the spool file
2779 that contains attributes is read directly by the Director instead of being
2780 transmitted across the network. That should reduce load and speedup insertion.
2781
2782 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2783 \index[general]{SpoolSize}
2784 A new Job directive permits to specify the spool size per job. This is used
2785 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2786
2787 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2788 \index[general]{MaximumConsoleConnections}
2789 A new director directive permits to specify the maximum number of Console
2790 Connections that could run concurrently. The default is set to 20, but you may
2791 set it to a larger number.
2792
2793 \subsection{VerId = \lt{}string\gt{}}
2794 \index[general]{VerId}
2795 A new director directive permits to specify a personnal identifier that will be
2796 displayed in the \texttt{version} command.
2797
2798 \subsection{dbcheck enhancements}
2799 \index[general]{dbcheck enhancements}
2800 If you are using Mysql, dbcheck will now ask you if you want to create
2801 temporary indexes to speed up orphaned Path and Filename elimination. 
2802
2803 A new \texttt{-B} option allows you to print catalog information in a simple
2804 text based format. This is useful to backup it in a secure way.
2805
2806 \begin{verbatim}
2807  $ dbcheck -B 
2808  catalog=MyCatalog
2809  db_type=SQLite
2810  db_name=regress
2811  db_driver=
2812  db_user=regress
2813  db_password=
2814  db_address=
2815  db_port=0
2816  db_socket=
2817 \end{verbatim} %$
2818
2819 You can now specify the database connection port in the command line.
2820
2821 \subsection{{-}{-}docdir configure option}
2822 \index[general]{{-}{-}docdir configure option}
2823 You can use {-}{-}docdir= on the ./configure command to
2824 specify the directory where you want Bacula to install the
2825 LICENSE, ReleaseNotes, ChangeLog, ... files.   The default is 
2826 {\bf /usr/share/doc/bacula}.
2827       
2828 \subsection{{-}{-}htmldir configure option}
2829 \index[general]{{-}{-}htmldir configure option}
2830 You can use {-}{-}htmldir= on the ./configure command to
2831 specify the directory where you want Bacula to install the bat html help
2832 files. The default is {\bf /usr/share/doc/bacula/html}
2833
2834 \subsection{{-}{-}with-plugindir configure option}
2835 \index[general]{{-}{-}plugindir configure option}
2836 You can use {-}{-}plugindir= on the ./configure command to
2837 specify the directory where you want Bacula to install
2838 the plugins (currently only bpipe-fd). The default is
2839 /usr/lib.