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