]> git.sur5r.net Git - bacula/docs/blob - docs/manuals/en/concepts/newfeatures.tex
d657c04981c04fd50948a3e37f45881a4375c9ae
[bacula/docs] / docs / manuals / en / concepts / newfeatures.tex
1 %%
2
3 %%
4
5 \chapter{New Features in 3.1.4 (Development Version}
6 \label{NewFeaturesChapter}
7
8 This chapter presents the new features that are currently under development
9 in the 3.1.x versions to be released as Bacula version 3.2.0 sometime in
10 late 2009 or early 2010.
11
12
13 \section{Maximum concurent jobs for Devices}
14 \label{sec:maximumconcurentjobdevice}
15
16 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
17 Daemon configuration permits setting the maximum number of Jobs that can
18 run concurrently on a specified Device.  Using this directive, it is
19 possible to have different Jobs using multiple drives, because when the
20 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
21 Jobs on any other available compatible drive.  This facilitates writing to
22 multiple drives with multiple Jobs that all use the same Pool.
23
24 \section{Restore from Multiple Storage Daemons}
25 \index[general]{Restore}
26
27 Previously, you were able to restore from multiple devices in a single Storage
28 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
29 example, if your full backup runs on a Storage Daemon with an autochanger, and
30 your incremental jobs use another Storage Daemon with lots of disks, Bacula
31 will switch automatically from one Storage Daemon to an other within the same
32 Restore job.
33
34 You must upgrade your File Daemon to version 3.1.3 or greater to use this feature.
35
36 This project was funded by Bacula Systems with the help of Equiinet.
37
38 \section{File Deduplication using Base Jobs}
39 A base job is sort of like a Full save except that you will want the FileSet to
40 contain only files that are unlikely to change in the future (i.e.  a snapshot
41 of most of your system after installing it).  After the base job has been run,
42 when you are doing a Full save, you specify one or more Base jobs to be used.
43 All files that have been backed up in the Base job/jobs but not modified will
44 then be excluded from the backup.  During a restore, the Base jobs will be
45 automatically pulled in where necessary.
46
47 This is something none of the competition does, as far as we know (except
48 perhaps BackupPC, which is a Perl program that saves to disk only).  It is big
49 win for the user, it makes Bacula stand out as offering a unique optimization
50 that immediately saves time and money.  Basically, imagine that you have 100
51 nearly identical Windows or Linux machine containing the OS and user files.
52 Now for the OS part, a Base job will be backed up once, and rather than making
53 100 copies of the OS, there will be only one.  If one or more of the systems
54 have some files updated, no problem, they will be automatically restored.
55
56 A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
57 files that will be used during Full backup as base.
58
59 \begin{verbatim}
60 Job {
61    Name = BackupLinux
62    Level= Base
63    ...
64 }
65
66 Job {
67    Name = BackupZog4
68    Base = BackupZog4, BackupLinux
69    Accurate = yes
70    ...
71 }
72 \end{verbatim}
73
74 In this example, the job \texttt{BackupZog4} will use the most recent version
75 of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
76 jobs. Base jobs should have run with \texttt{level=Base} to be used.
77
78 By default, Bacula will compare permissions bits, user and group fields,
79 modification time, size and the checksum of the file to choose between the
80 current backup and the BaseJob file list. You can change this behavior with the
81 \texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
82 one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
83
84 \begin{verbatim}
85 FileSet {
86   Name = Full
87   Include = {
88     Options {
89        BaseJob  = pmugcs5
90        Accurate = mcs5
91        Verify   = pin5
92     }
93     File = /
94   }
95 }
96 \end{verbatim}
97
98
99 This project was funded by Bacula Systems.
100
101
102 \section{Accurate Fileset options}
103 \label{sec:accuratefileset}
104
105 In previous versions, the accurate code used the file creation and
106 modification times to determine if a file was modified or not. Now you can specify
107 which attributes to use (time, size, checksum, permission, owner, group,
108 \dots), similar to the Verify options.
109
110 \begin{verbatim}
111 FileSet {
112   Name = Full
113   Include = {
114     Options {
115        Accurate = mcs5
116        Verify   = pin5
117     }
118     File = /
119   }
120 }
121 \end{verbatim}
122
123 \begin{description}  
124 \item {\bf i}
125   compare the inodes  
126   
127 \item {\bf p}
128   compare the permission bits  
129   
130 \item {\bf n}
131   compare the number of links  
132   
133 \item {\bf u}
134   compare the user id  
135   
136 \item {\bf g}
137   compare the group id  
138   
139 \item {\bf s}
140   compare the size  
141   
142 \item {\bf a}
143   compare the access time  
144   
145 \item {\bf m}
146   compare the modification time (st\_mtime)  
147   
148 \item {\bf c}
149   compare the change time (st\_ctime)  
150   
151 \item {\bf d}
152   report file size decreases  
153   
154 \item {\bf 5}
155   compare the MD5 signature  
156   
157 \item {\bf 1}
158   compare the SHA1 signature  
159 \end{description}
160
161 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
162 the File Daemon will have to read all files even if they normally would not
163 be saved.  This increases the I/O load, but also the accuracy of the
164 deduplication.  By default, Bacula will check modification/creation time
165 and size.
166
167 \section{Bvfs API}
168 \label{sec:bvfs}
169
170 To help developers of restore GUI interfaces, we have added new \textsl{dot
171   commands} that permit browsing the catalog in a very simple way.
172
173 \begin{itemize}
174 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update the
175   Bvfs cache in the catalog. You need to run it before any access to the Bvfs
176   layer.
177
178 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
179   will list all directories in the specified \texttt{path} or
180   \texttt{pathid}. Using \texttt{pathid} avoids problems with character
181   encoding of path/filenames.
182
183 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
184   will list all files in the specified \texttt{path} or \texttt{pathid}. Using
185   \texttt{pathid} avoids problems with character encoding.
186 \end{itemize}
187
188 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
189 data that will be displayed.
190
191 \begin{verbatim}
192 * .bvfs_update jobid=1,2
193 * .bvfs_update
194 * .bvfs_lsdir path=/ jobid=1,2
195 \end{verbatim}
196
197 \section{Testing your tape drive}
198 \label{sec:btapespeed}
199
200 To determine the best configuration of your tape drive, you can run the new
201 \texttt{speed} command available in the \texttt{btape} program.
202
203 This command can have the following arguments:
204 \begin{itemize}
205 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
206   (between 1 and 5GB). This counter is in GB.
207 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
208   of data should be greater than your memory ($file\_size*nb\_file$).
209 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
210   data.
211 \item[\texttt{skip\_random}] This flag permits to skip tests with random
212   data.
213 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
214 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
215   access.
216 \end{itemize}
217
218 \begin{verbatim}
219 *speed file_size=3 skip_raw
220 btape.c:1078 Test with zero data and bacula block structure.
221 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
222 ++++++++++++++++++++++++++++++++++++++++++
223 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
224 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
225 ...
226 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
227
228 btape.c:1090 Test with random data, should give the minimum throughput.
229 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
230 +++++++++++++++++++++++++++++++++++++++++++
231 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
232 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
233 +++++++++++++++++++++++++++++++++++++++++++
234 ...
235 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
236
237 \end{verbatim}
238
239 When using compression, the random test will give your the minimum throughput
240 of your drive . The test using constant string will give you the maximum speed
241 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
242
243 You can change the block size in the Storage Daemon configuration file.
244
245 \section{New {\bf Block Checksum} Device directive}
246 You may now turn off the Block Checksum (CRC32) code
247 that Bacula uses when writing blocks to a Volume.  This is
248 done by adding:
249
250 \begin{verbatim}
251 Block Checksum = no
252 \end{verbatim}
253
254 doing so can reduce the Storage daemon CPU usage slightly.  It
255 will also permit Bacula to read a Volume that has corrupted data.
256
257 The default is {\bf yes} -- i.e. the checksum is computed on write
258 and checked on read. 
259
260 We do not recommend to turn this off particularly on older tape
261 drives or for disk Volumes where doing so may allow corrupted data
262 to go undetected.
263
264 \section{New Bat Features}
265
266 \subsection{Media information view}
267
268 By double-clicking on a volume (on the Media list, in the Autochanger content
269 or in the Job information panel), you can access a detailed overview of your
270 Volume. (cf \ref{fig:mediainfo}.)
271 \begin{figure}[htbp]
272   \centering
273   \includegraphics[width=13cm]{\idir bat11.eps}  
274   \caption{Media information}
275   \label{fig:mediainfo}
276 \end{figure}
277
278 \subsection{Job information view}
279
280 By double-clicking on a Job record (on the Job run list or in the Media
281 information panel), you can access a detailed overview of your Job. (cf
282 \ref{fig:jobinfo}.)
283 \begin{figure}[htbp]
284   \centering
285   \includegraphics[width=13cm]{\idir bat12.eps}  
286   \caption{Job information}
287   \label{fig:jobinfo}
288 \end{figure}
289
290 \subsection{Autochanger content view}
291
292 By double-clicking on a Storage record (on the Storage list panel), you can
293 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
294 \begin{figure}[htbp]
295   \centering
296   \includegraphics[width=13cm]{\idir bat13.eps}  
297   \caption{Autochanger content}
298   \label{fig:achcontent}
299 \end{figure}
300
301 \section{Console timeout option}
302 You can now use the -u option of bconsole to set a timeout for each command.
303
304 \chapter{New Features in Released Version 3.0.2}
305
306 This chapter presents the new features added to the
307 Released Bacula Version 3.0.2.
308
309 \section{Full restore from a given JobId}
310 \index[general]{Restore menu}
311
312 This feature allows selecting a single JobId and having Bacula
313 automatically select all the other jobs that comprise a full backup up to
314 and including the selected date (through JobId).
315
316 Assume we start with the following jobs:
317 \begin{verbatim}
318 +-------+--------------+---------------------+-------+----------+------------+
319 | jobid | client       | starttime           | level | jobfiles | jobbytes   |
320 +-------+--------------+---------------------+-------+----------+------------
321 | 6     | localhost-fd | 2009-07-15 11:45:49 | I     | 2        | 0          |
322 | 5     | localhost-fd | 2009-07-15 11:45:45 | I     | 15       | 44143      |
323 | 3     | localhost-fd | 2009-07-15 11:45:38 | I     | 1        | 10         |
324 | 1     | localhost-fd | 2009-07-15 11:45:30 | F     | 1527     | 44143073   |
325 +-------+--------------+---------------------+-------+----------+------------+
326 \end{verbatim}
327
328 Below is an example of this new feature (which is number 12 in the
329 menu).
330
331 \begin{verbatim}
332 * restore
333 To select the JobIds, you have the following choices:
334      1: List last 20 Jobs run
335      2: List Jobs where a given File is saved
336 ...
337     12: Select full restore to a specified Job date
338     13: Cancel
339
340 Select item:  (1-13): 12
341 Enter JobId to get the state to restore: 5
342 Selecting jobs to build the Full state at 2009-07-15 11:45:45
343 You have selected the following JobIds: 1,3,5
344
345 Building directory tree for JobId(s) 1,3,5 ...  +++++++++++++++++++
346 1,444 files inserted into the tree.
347 \end{verbatim}
348
349 This project was funded by Bacula Systems.
350
351 \section{Source Address}
352 \index[general]{Source Address}
353
354 A feature has been added which allows the administrator to specify the address
355 from which the Director and File daemons will establish connections.  This
356 may be used to simplify system configuration overhead when working in complex
357 networks utilizing multi-homing and policy-routing.
358
359 To accomplish this, two new configuration directives have been implemented:
360 \begin{verbatim}
361 FileDaemon {
362   FDSourceAddress=10.0.1.20    # Always initiate connections from this address
363 }
364
365 Director {
366   DirSourceAddress=10.0.1.10   # Always initiate connections from this address
367 }
368 \end{verbatim}
369
370 Simply adding specific host routes on the OS
371 would have an undesirable side-effect: any
372 application trying to contact the destination host would be forced to use the
373 more specific route possibly diverting management traffic onto a backup VLAN.
374 Instead of adding host routes for each client connected to a multi-homed backup
375 server (for example where there are management and backup VLANs), one can
376 use the new directives to specify a specific source address at the application
377 level.
378
379 Additionally, this allows the simplification and abstraction of firewall rules
380 when dealing with a Hot-Standby director or storage daemon configuration.  The
381 Hot-standby pair may share a CARP address, which connections must be sourced
382 from, while system services listen and act from the unique interface addresses.
383
384 This project was funded by Collaborative Fusion, Inc.
385
386 \section{Show volume availability when doing restore}
387
388 When doing a restore the selection dialog ends by displaying this
389 screen:
390
391 \begin{verbatim}
392   The job will require the following
393    Volume(s)                 Storage(s)                SD Device(s)
394    ===========================================================================
395    *000741L3                  LTO-4                     LTO3 
396    *000866L3                  LTO-4                     LTO3 
397    *000765L3                  LTO-4                     LTO3 
398    *000764L3                  LTO-4                     LTO3 
399    *000756L3                  LTO-4                     LTO3 
400    *001759L3                  LTO-4                     LTO3 
401    *001763L3                  LTO-4                     LTO3 
402     001762L3                  LTO-4                     LTO3 
403     001767L3                  LTO-4                     LTO3 
404
405 Volumes marked with ``*'' are online (in the autochanger).
406 \end{verbatim}
407
408 This should help speed up large restores by minimizing the time spent
409 waiting for the operator to discover that he must change tapes in the library.
410
411 This project was funded by Bacula Systems.
412
413 \section{Accurate estimate command}
414
415 The \texttt{estimate} command can now use the accurate code to detect changes
416 and give a better estimation.
417
418 You can set the accurate behavior on the command line by using
419 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
420
421 \begin{verbatim}
422 * estimate listing accurate=yes level=incremental job=BackupJob
423 \end{verbatim}
424
425 This project was funded by Bacula Systems.
426
427 \chapter{New Features in 3.0.0}
428 \label{NewFeaturesChapter}
429 \index[general]{New Features}
430
431 This chapter presents the new features added to the development 2.5.x
432 versions to be released as Bacula version 3.0.0 sometime in April 2009.
433
434 \section{Accurate Backup}
435 \index[general]{Accurate Backup}
436
437 As with most other backup programs, by default Bacula decides what files to
438 backup for Incremental and Differental backup by comparing the change
439 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
440 backup completed.  If one of those two times is later than the last backup
441 time, then the file will be backed up.  This does not, however, permit tracking
442 what files have been deleted and will miss any file with an old time that may
443 have been restored to or moved onto the client filesystem.
444
445 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
446 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
447 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
448 backup, there is no difference, but for {\bf Differential} and {\bf
449   Incremental} backups, the Director will send a list of all previous files
450 backed up, and the File daemon will use that list to determine if any new files
451 have been added or or moved and if any files have been deleted. This allows
452 Bacula to make an accurate backup of your system to that point in time so that
453 if you do a restore, it will restore your system exactly.  
454
455 One note of caution
456 about using Accurate backup is that it requires more resources (CPU and memory)
457 on both the Director and the Client machines to create the list of previous
458 files backed up, to send that list to the File daemon, for the File daemon to
459 keep the list (possibly very big) in memory, and for the File daemon to do
460 comparisons between every file in the FileSet and the list.  In particular,
461 if your client has lots of files (more than a few million), you will need
462 lots of memory on the client machine.
463
464 Accurate must not be enabled when backing up with a plugin that is not
465 specially designed to work with Accurate. If you enable it, your restores
466 will probably not work correctly.
467
468 This project was funded by Bacula Systems.
469                                        
470
471
472 \section{Copy Jobs}
473 \index[general]{Copy Jobs}
474
475 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
476 existing Migration feature with the exception that the Job that is copied is
477 left unchanged.  This essentially creates two identical copies of the same
478 backup. However, the copy is treated as a copy rather than a backup job, and
479 hence is not directly available for restore.  The {\bf restore} command lists
480 copy jobs and allows selection of copies by using \texttt{jobid=}
481 option. If the keyword {\bf copies} is present on the command line, Bacula will
482 display the list of all copies for selected jobs.
483
484 \begin{verbatim}
485 * restore copies
486 [...]
487 These JobIds have copies as follows:
488 +-------+------------------------------------+-----------+------------------+
489 | JobId | Job                                | CopyJobId | MediaType        |
490 +-------+------------------------------------+-----------+------------------+
491 | 2     | CopyJobSave.2009-02-17_16.31.00.11 | 7         | DiskChangerMedia |
492 +-------+------------------------------------+-----------+------------------+
493 +-------+-------+----------+----------+---------------------+------------------+
494 | JobId | Level | JobFiles | JobBytes | StartTime           | VolumeName       |
495 +-------+-------+----------+----------+---------------------+------------------+
496 | 19    | F     | 6274     | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
497 | 2     | I     | 1        | 5        | 2009-02-17 16:30:51 | FileVolume001    |
498 +-------+-------+----------+----------+---------------------+------------------+
499 You have selected the following JobIds: 19,2
500
501 Building directory tree for JobId(s) 19,2 ...  ++++++++++++++++++++++++++++++++++++++++++++
502 5,611 files inserted into the tree.
503 ...
504 \end{verbatim}
505
506
507 The Copy Job runs without using the File daemon by copying the data from the
508 old backup Volume to a different Volume in a different Pool. See the Migration
509 documentation for additional details. For copy Jobs there is a new selection
510 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
511 not already copied to another Pool. 
512
513 As with Migration, the Client, Volume, Job, or SQL query, are
514 other possible ways of selecting the Jobs to be copied. Selection
515 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
516 work, but are probably more suited for Migration Jobs. 
517
518 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
519 it will promote the Copy to a \textsl{real} backup job and will make it available for
520 automatic restore. If more than one Copy is available, it will promote the copy
521 with the smallest JobId.
522
523 A nice solution which can be built with the new Copy feature is often
524 called disk-to-disk-to-tape backup (DTDTT). A sample config could
525 look something like the one below:
526
527 \begin{verbatim}
528 Pool {
529   Name = FullBackupsVirtualPool
530   Pool Type = Backup
531   Purge Oldest Volume = Yes
532   Storage = vtl
533   NextPool = FullBackupsTapePool
534 }
535
536 Pool {
537   Name = FullBackupsTapePool
538   Pool Type = Backup
539   Recycle = Yes
540   AutoPrune = Yes
541   Volume Retention = 365 days
542   Storage = superloader
543 }
544
545 #
546 # Fake fileset for copy jobs
547 #
548 Fileset {
549   Name = None
550   Include {
551     Options {
552       signature = MD5
553     }
554   }
555 }
556
557 #
558 # Fake client for copy jobs
559 #
560 Client {
561   Name = None
562   Address = localhost
563   Password = "NoNe"
564   Catalog = MyCatalog
565 }
566
567 #
568 # Default template for a CopyDiskToTape Job
569 #
570 JobDefs {
571   Name = CopyDiskToTape
572   Type = Copy
573   Messages = StandardCopy
574   Client = None
575   FileSet = None
576   Selection Type = PoolUncopiedJobs
577   Maximum Concurrent Jobs = 10
578   SpoolData = No
579   Allow Duplicate Jobs = Yes
580   Allow Higher Duplicates = No
581   Cancel Queued Duplicates = No
582   Cancel Running Duplicates = No
583   Priority = 13
584 }
585
586 Schedule {
587    Name = DaySchedule7:00
588    Run = Level=Full daily at 7:00
589 }
590
591 Job {
592   Name = CopyDiskToTapeFullBackups
593   Enabled = Yes
594   Schedule = DaySchedule7:00
595   Pool = FullBackupsVirtualPool
596   JobDefs = CopyDiskToTape
597 }
598 \end{verbatim}
599
600 The example above had 2 pool which are copied using the PoolUncopiedJobs
601 selection criteria. Normal Full backups go to the Virtual pool and are copied
602 to the Tape pool the next morning.
603
604 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
605 \textbf{jobid}.
606
607 \begin{verbatim}
608 *list copies
609 +-------+------------------------------------+-----------+------------------+
610 | JobId | Job                                | CopyJobId | MediaType        |
611 +-------+------------------------------------+-----------+------------------+
612 |     9 | CopyJobSave.2008-12-20_22.26.49.05 |        11 | DiskChangerMedia |
613 +-------+------------------------------------+-----------+------------------+
614 \end{verbatim}
615
616 \section{ACL Updates}
617 \index[general]{ACL Updates}
618 The whole ACL code had been overhauled and in this version each platforms has
619 different streams for each type of acl available on such an platform. As ACLs
620 between platforms tend to be not that portable (most implement POSIX acls but
621 some use an other draft or a completely different format) we currently only
622 allow certain platform specific ACL streams to be decoded and restored on the
623 same platform that they were created on.  The old code allowed to restore ACL
624 cross platform but the comments already mention that not being to wise. For
625 backward compatability the new code will accept the two old ACL streams and
626 handle those with the platform specific handler. But for all new backups it
627 will save the ACLs using the new streams.
628
629 Currently the following platforms support ACLs:
630
631 \begin{itemize}
632  \item {\bf AIX}
633  \item {\bf Darwin/OSX}
634  \item {\bf FreeBSD}
635  \item {\bf HPUX}
636  \item {\bf IRIX}
637  \item {\bf Linux}
638  \item {\bf Tru64}
639  \item {\bf Solaris}
640 \end{itemize}
641
642 Currently we support the following ACL types (these ACL streams use a reserved
643 part of the stream numbers):
644
645 \begin{itemize}
646 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
647   acl\_get
648  \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
649    string representation from acl\_to\_text (POSIX acl)
650   \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
651     string representation from acl\_to\_text (POSIX acl) for default acls.
652   \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
653     string representation from acl\_to\_text (POSIX acl) for access acls.
654   \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
655     string representation from acltostr (POSIX acl)
656   \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
657     representation from acl\_to\_text (POSIX acl) for default acls.
658   \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
659     representation from acl\_to\_text (POSIX acl) for access acls.
660   \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
661     string representation from acl\_to\_text (POSIX acl) for default acls.
662   \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
663     representation from acl\_to\_text (POSIX acl) for access acls.
664   \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
665     string representation from acl\_to\_text (POSIX acl) for default acls.
666   \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
667     string representation from acl\_to\_text (POSIX acl) for default acls.
668   \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
669     representation from acl\_to\_text (POSIX acl) for access acls.
670   \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
671     string representation from acltotext or acl\_totext (POSIX acl)
672   \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
673     representation from from acl\_totext (NFSv4 or ZFS acl)
674 \end{itemize}
675
676 In future versions we might support conversion functions from one type of acl
677 into an other for types that are either the same or easily convertable. For now
678 the streams are seperate and restoring them on a platform that doesn't
679 recognize them will give you a warning.
680
681 \section{Extended Attributes}
682 \index[general]{Extended Attributes}
683 Something that was on the project list for some time is now implemented for
684 platforms that support a similar kind of interface. Its the support for backup
685 and restore of so called extended attributes. As extended attributes are so
686 platform specific these attributes are saved in seperate streams for each
687 platform.  Restores of the extended attributes can only be performed on the
688 same platform the backup was done.  There is support for all types of extended
689 attributes, but restoring from one type of filesystem onto an other type of
690 filesystem on the same platform may lead to supprises.  As extended attributes
691 can contain any type of data they are stored as a series of so called
692 value-pairs.  This data must be seen as mostly binary and is stored as such.
693 As security labels from selinux are also extended attributes this option also
694 stores those labels and no specific code is enabled for handling selinux
695 security labels.
696
697 Currently the following platforms support extended attributes:
698 \begin{itemize}
699  \item {\bf Darwin/OSX}
700  \item {\bf FreeBSD}
701  \item {\bf Linux}
702  \item {\bf NetBSD}
703 \end{itemize}
704
705 On linux acls are also extended attributes, as such when you enable ACLs on a
706 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
707 and not the same exteneded attribute.
708
709 To enable the backup of extended attributes please add the following to your
710 fileset definition.
711 \begin{verbatim}
712   FileSet {
713     Name = "MyFileSet"
714     Include {
715       Options {
716         signature = MD5
717         xattrsupport = yes
718       }
719       File = ...
720     }
721   }
722 \end{verbatim}
723
724 \section{Shared objects}
725 \index[general]{Shared objects}
726 A default build of Bacula will now create the libraries as shared objects
727 (.so) rather than static libraries as was previously the case.  
728 The shared libraries are built using {\bf libtool} so it should be quite
729 portable.
730
731 An important advantage of using shared objects is that on a machine with the
732 Directory, File daemon, the Storage daemon, and a console, you will have only
733 one copy of the code in memory rather than four copies.  Also the total size of
734 the binary release is smaller since the library code appears only once rather
735 than once for every program that uses it; this results in significant reduction
736 in the size of the binaries particularly for the utility tools.
737  
738 In order for the system loader to find the shared objects when loading the
739 Bacula binaries, the Bacula shared objects must either be in a shared object
740 directory known to the loader (typically /usr/lib) or they must be in the
741 directory that may be specified on the {\bf ./configure} line using the {\bf
742   {-}{-}libdir} option as:
743
744 \begin{verbatim}
745   ./configure --libdir=/full-path/dir
746 \end{verbatim}
747
748 the default is /usr/lib. If {-}{-}libdir is specified, there should be
749 no need to modify your loader configuration provided that
750 the shared objects are installed in that directory (Bacula
751 does this with the make install command). The shared objects
752 that Bacula references are:
753
754 \begin{verbatim}
755 libbaccfg.so
756 libbacfind.so
757 libbacpy.so
758 libbac.so
759 \end{verbatim}
760
761 These files are symbolically linked to the real shared object file,
762 which has a version number to permit running multiple versions of
763 the libraries if desired (not normally the case).
764
765 If you have problems with libtool or you wish to use the old
766 way of building static libraries, or you want to build a static
767 version of Bacula you may disable
768 libtool on the configure command line with:
769
770 \begin{verbatim}
771   ./configure --disable-libtool
772 \end{verbatim}
773
774
775 \section{Building Static versions of Bacula}
776 \index[general]{Static linking}
777 In order to build static versions of Bacula, in addition
778 to configuration options that were needed you now must
779 also add --disable-libtool.  Example
780
781 \begin{verbatim}
782   ./configure --enable-static-client-only --disable-libtool
783 \end{verbatim}
784
785
786 \section{Virtual Backup (Vbackup)}
787 \index[general]{Virtual Backup}
788 \index[general]{Vbackup}
789
790 Bacula's virtual backup feature is often called Synthetic Backup or
791 Consolidation in other backup products.  It permits you to consolidate the
792 previous Full backup plus the most recent Differential backup and any
793 subsequent Incremental backups into a new Full backup.  This new Full
794 backup will then be considered as the most recent Full for any future
795 Incremental or Differential backups.  The VirtualFull backup is
796 accomplished without contacting the client by reading the previous backup
797 data and writing it to a volume in a different pool.
798
799 In some respects the Vbackup feature works similar to a Migration job, in
800 that Bacula normally reads the data from the pool specified in the 
801 Job resource, and writes it to the {\bf Next Pool} specified in the 
802 Job resource. Note, this means that usually the output from the Virtual
803 Backup is written into a different pool from where your prior backups
804 are saved. Doing it this way guarantees that you will not get a deadlock
805 situation attempting to read and write to the same volume in the Storage
806 daemon. If you then want to do subsequent backups, you may need to
807 move the Virtual Full Volume back to your normal backup pool.
808 Alternatively, you can set your {\bf Next Pool} to point to the current
809 pool.  This will cause Bacula to read and write to Volumes in the
810 current pool. In general, this will work, because Bacula will
811 not allow reading and writing on the same Volume. In any case, once
812 a VirtualFull has been created, and a restore is done involving the
813 most current Full, it will read the Volume or Volumes by the VirtualFull 
814 regardless of in which Pool the Volume is found.
815
816 The Vbackup is enabled on a Job by Job in the Job resource by specifying
817 a level of {\bf VirtualFull}.
818
819 A typical Job resource definition might look like the following:
820
821 \begin{verbatim}
822 Job {
823   Name = "MyBackup"
824   Type = Backup
825   Client=localhost-fd
826   FileSet = "Full Set"
827   Storage = File
828   Messages = Standard
829   Pool = Default
830   SpoolData = yes
831 }
832
833 # Default pool definition
834 Pool {
835   Name = Default
836   Pool Type = Backup
837   Recycle = yes            # Automatically recycle Volumes
838   AutoPrune = yes          # Prune expired volumes
839   Volume Retention = 365d  # one year
840   NextPool = Full
841   Storage = File
842 }
843
844 Pool {
845   Name = Full
846   Pool Type = Backup
847   Recycle = yes            # Automatically recycle Volumes
848   AutoPrune = yes          # Prune expired volumes
849   Volume Retention = 365d  # one year
850   Storage = DiskChanger
851 }
852
853 # Definition of file storage device
854 Storage {
855   Name = File
856   Address = localhost
857   Password = "xxx"
858   Device = FileStorage
859   Media Type = File
860   Maximum Concurrent Jobs = 5
861 }
862
863 # Definition of DDS Virtual tape disk storage device
864 Storage {
865   Name = DiskChanger
866   Address = localhost  # N.B. Use a fully qualified name here
867   Password = "yyy"
868   Device = DiskChanger
869   Media Type = DiskChangerMedia
870   Maximum Concurrent Jobs = 4
871   Autochanger = yes
872 }
873 \end{verbatim}
874
875 Then in bconsole or via a Run schedule, you would run the job as:
876
877 \begin{verbatim}
878 run job=MyBackup level=Full
879 run job=MyBackup level=Incremental
880 run job=MyBackup level=Differential
881 run job=MyBackup level=Incremental
882 run job=MyBackup level=Incremental
883 \end{verbatim}
884
885 So providing there were changes between each of those jobs, you would end up
886 with a Full backup, a Differential, which includes the first Incremental
887 backup, then two Incremental backups.  All the above jobs would be written to
888 the {\bf Default} pool.
889
890 To consolidate those backups into a new Full backup, you would run the
891 following:
892
893 \begin{verbatim}
894 run job=MyBackup level=VirtualFull
895 \end{verbatim}
896
897 And it would produce a new Full backup without using the client, and the output
898 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
899
900 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
901 fail with an error.
902
903 Note, the Start and End time of the Virtual Full backup is set to the
904 values for the last job included in the Virtual Full (in the above example,
905 it is an Increment). This is so that if another incremental is done, which
906 will be based on the Virtual Full, it will backup all files from the
907 last Job included in the Virtual Full rather than from the time the Virtual
908 Full was actually run.
909
910
911
912 \section{Catalog Format}
913 \index[general]{Catalog Format}
914 Bacula 3.0 comes with some changes to the catalog format.  The upgrade
915 operation will convert the FileId field of the File table from 32 bits (max 4
916 billion table entries) to 64 bits (very large number of items).  The
917 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
918 your catalog during the conversion.  Also you won't be able to run jobs during
919 this conversion period.  For example, a 3 million file catalog will take 2
920 minutes to upgrade on a normal machine.  Please don't forget to make a valid
921 backup of your database before executing the upgrade script. See the 
922 ReleaseNotes for additional details.
923
924 \section{64 bit Windows Client}
925 \index[general]{Win64 Client}
926 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
927 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
928 As a consequence, we are also releasing a 64 bit version of the Bacula 
929 Windows Client (win64bacula-3.0.0.exe) that does work with VSS. 
930 These binaries should only be installed on 64 bit Windows operating systems.
931 What is important is not your hardware but whether or not you have
932 a 64 bit version of the Windows OS.  
933
934 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
935 \begin{enumerate}
936 \item Before installing the Win64 Bacula Client, you must totally
937       deinstall any prior 2.4.x Client installation using the 
938       Bacula deinstallation (see the menu item). You may want
939       to save your .conf files first.
940 \item Only the Client (File daemon) is ported to Win64, the Director
941       and the Storage daemon are not in the 64 bit Windows installer.
942 \item bwx-console is not yet ported.
943 \item bconsole is ported but it has not been tested.
944 \item The documentation is not included in the installer.
945 \item Due to Vista security restrictions imposed on a default installation
946       of Vista, before upgrading the Client, you must manually stop
947       any prior version of Bacula from running, otherwise the install
948       will fail.
949 \item Due to Vista security restrictions imposed on a default installation
950       of Vista, attempting to edit the conf files via the menu items
951       will fail. You must directly edit the files with appropriate 
952       permissions.  Generally double clicking on the appropriate .conf
953       file will work providing you have sufficient permissions.
954 \item All Bacula files are now installed in 
955       {\bf C:/Program Files/Bacula} except the main menu items,
956       which are installed as before. This vastly simplifies the installation.
957 \item If you are running on a foreign language version of Windows, most
958       likely {\bf C:/Program Files} does not exist, so you should use the
959       Custom installation and enter an appropriate location to install
960       the files.
961 \item The 3.0.0 Win32 Client continues to install files in the locations used
962       by prior versions. For the next version we will convert it to use
963       the same installation conventions as the Win64 version.
964 \end{enumerate}
965
966 This project was funded by Bacula Systems.
967
968
969 \section{Duplicate Job Control}
970 \index[general]{Duplicate Jobs}
971 The new version of Bacula provides four new directives that
972 give additional control over what Bacula does if duplicate jobs 
973 are started.  A duplicate job in the sense we use it here means
974 a second or subsequent job with the same name starts.  This
975 happens most frequently when the first job runs longer than expected because no 
976 tapes are available.
977
978 The four directives each take as an argument a {\bf yes} or {\bf no} value and
979 are specified in the Job resource.
980
981 They are:
982
983 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
984 \index[general]{Allow Duplicate Jobs}
985   If this directive is enabled duplicate jobs will be run.  If
986   the directive is set to {\bf no} (default) then only one job of a given name
987   may run at one time, and the action that Bacula takes to ensure only
988   one job runs is determined by the other directives (see below).
989  
990   If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
991   are present and none of the three directives given below permit
992   cancelling a job, then the current job (the second one started)
993   will be cancelled.
994
995
996 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
997 \index[general]{Allow Higher Duplicates}
998   If this directive is set to {\bf yes} (default) the job with a higher
999   priority (lower priority number) will be permitted to run, and
1000   the current job will be cancelled.  If the
1001   priorities of the two jobs are the same, the outcome is determined by
1002   other directives (see below).
1003
1004 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1005 \index[general]{Cancel Queued Duplicates}
1006   If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1007   if this directive is set to {\bf yes} any job that is
1008   already queued to run but not yet running will be canceled.
1009   The default is {\bf no}. 
1010
1011 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1012 \index[general]{Cancel Running Duplicates}
1013   If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1014   if this directive is set to {\bf yes} any job that is already running
1015   will be canceled.  The default is {\bf no}.
1016
1017
1018 \section{TLS Authentication}
1019 \index[general]{TLS Authentication}
1020 In Bacula version 2.5.x and later, in addition to the normal Bacula
1021 CRAM-MD5 authentication that is used to authenticate each Bacula
1022 connection, you can specify that you want TLS Authentication as well,
1023 which will provide more secure authentication.
1024
1025 This new feature uses Bacula's existing TLS code (normally used for
1026 communications encryption) to do authentication.  To use it, you must
1027 specify all the TLS directives normally used to enable communications
1028 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1029 a new directive:
1030
1031 \subsection{TLS Authenticate = yes}
1032 \begin{verbatim}
1033 TLS Authenticate = yes
1034 \end{verbatim}
1035
1036 in the main daemon configuration resource (Director for the Director,
1037 Client for the File daemon, and Storage for the Storage daemon).
1038
1039 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1040 authentication, Bacula will also do TLS authentication, then TLS 
1041 encryption will be turned off, and the rest of the communication between
1042 the two Bacula daemons will be done without encryption.
1043
1044 If you want to encrypt communications data, use the normal TLS directives
1045 but do not turn on {\bf TLS Authenticate}.
1046
1047 \section{bextract non-portable Win32 data}
1048 \index[general]{bextract handles Win32 non-portable data}
1049 {\bf bextract} has been enhanced to be able to restore
1050 non-portable Win32 data to any OS.  Previous versions were 
1051 unable to restore non-portable Win32 data to machines that
1052 did not have the Win32 BackupRead and BackupWrite API calls.
1053
1054 \section{State File updated at Job Termination}
1055 \index[general]{State File}
1056 In previous versions of Bacula, the state file, which provides a
1057 summary of previous jobs run in the {\bf status} command output was
1058 updated only when Bacula terminated, thus if the daemon crashed, the
1059 state file might not contain all the run data.  This version of
1060 the Bacula daemons updates the state file on each job termination.
1061
1062 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1063 \index[general]{MaxFullInterval}
1064 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1065 can be used to specify the maximum time interval between {\bf Full} backup
1066 jobs. When a job starts, if the time since the last Full backup is
1067 greater than the specified interval, and the job would normally be an
1068 {\bf Incremental} or {\bf Differential}, it will be automatically
1069 upgraded to a {\bf Full} backup.
1070
1071 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1072 \index[general]{MaxDiffInterval}
1073 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1074 can be used to specify the maximum time interval between {\bf Differential} backup
1075 jobs. When a job starts, if the time since the last Differential backup is
1076 greater than the specified interval, and the job would normally be an
1077 {\bf Incremental}, it will be automatically
1078 upgraded to a {\bf Differential} backup.
1079
1080 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1081 \index[general]{MaxDiffInterval}
1082 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1083 by the user, and when it is set it is an indication to backup programs
1084 to not backup that particular file.  This version of Bacula contains a
1085 new Options directive within a FileSet resource, which instructs Bacula to
1086 obey this flag.  The new directive is:
1087
1088 \begin{verbatim}
1089   Honor No Dump Flag = yes\vb{}no
1090 \end{verbatim}
1091
1092 The default value is {\bf no}.
1093
1094
1095 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1096 \index[general]{IgnoreDir}
1097 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1098 can be added to the Include section of the FileSet resource.  If the specified
1099 filename ({\bf filename-string}) is found on the Client in any directory to be
1100 backed up, the whole directory will be ignored (not backed up).  For example:
1101
1102 \begin{verbatim}
1103   # List of files to be backed up
1104   FileSet {
1105     Name = "MyFileSet"
1106     Include {
1107       Options {
1108         signature = MD5
1109       }
1110       File = /home
1111       Exclude Dir Containing = .excludeme
1112     }
1113   }
1114 \end{verbatim}
1115
1116 But in /home, there may be hundreds of directories of users and some
1117 people want to indicate that they don't want to have certain
1118 directories backed up. For example, with the above FileSet, if
1119 the user or sysadmin creates a file named {\bf .excludeme} in 
1120 specific directories, such as
1121
1122 \begin{verbatim}
1123    /home/user/www/cache/.excludeme
1124    /home/user/temp/.excludeme
1125 \end{verbatim}
1126
1127 then Bacula will not backup the two directories named:
1128
1129 \begin{verbatim}
1130    /home/user/www/cache
1131    /home/user/temp
1132 \end{verbatim}
1133
1134 NOTE: subdirectories will not be backed up.  That is, the directive
1135 applies to the two directories in question and any children (be they
1136 files, directories, etc).
1137
1138
1139 \section{Bacula Plugins}
1140 \index[general]{Plugin}
1141 Support for shared object plugins has been implemented in the Linux, Unix
1142 and Win32 File daemons. The API will be documented separately in
1143 the Developer's Guide or in a new document.  For the moment, there is
1144 a single plugin named {\bf bpipe} that allows an external program to
1145 get control to backup and restore a file.
1146
1147 Plugins are also planned (partially implemented) in the Director and the
1148 Storage daemon.  
1149
1150 \subsection{Plugin Directory}
1151 \index[general]{Plugin Directory}
1152 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1153 be added to the daemon definition resource. The directory takes a quoted 
1154 string argument, which is the name of the directory in which the daemon can
1155 find the Bacula plugins. If this directive is not specified, Bacula will not
1156 load any plugins. Since each plugin has a distinctive name, all the daemons
1157 can share the same plugin directory. 
1158
1159 \subsection{Plugin Options}
1160 \index[general]{Plugin Options}
1161 The {\bf Plugin Options} directive takes a quoted string
1162 arguement (after the equal sign) and may be specified in the
1163 Job resource.  The options specified will be passed to all plugins
1164 when they are run.  This each plugin must know what it is looking
1165 for. The value defined in the Job resource can be modified
1166 by the user when he runs a Job via the {\bf bconsole} command line 
1167 prompts.
1168
1169 Note: this directive may be specified, and there is code to modify
1170 the string in the run command, but the plugin options are not yet passed to
1171 the plugin (i.e. not fully implemented).
1172
1173 \subsection{Plugin Options ACL}
1174 \index[general]{Plugin Options ACL}
1175 The {\bf Plugin Options ACL} directive may be specified in the
1176 Director's Console resource. It functions as all the other ACL commands
1177 do by permitting users running restricted consoles to specify a 
1178 {\bf Plugin Options} that overrides the one specified in the Job
1179 definition. Without this directive restricted consoles may not modify
1180 the Plugin Options.
1181
1182 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
1183 \index[general]{Plugin}
1184 The {\bf Plugin} directive is specified in the Include section of
1185 a FileSet resource where you put your {\bf File = xxx} directives.
1186 For example:
1187
1188 \begin{verbatim}
1189   FileSet {
1190     Name = "MyFileSet"
1191     Include {
1192       Options {
1193         signature = MD5
1194       }
1195       File = /home
1196       Plugin = "bpipe:..."
1197     }
1198   }
1199 \end{verbatim}
1200
1201 In the above example, when the File daemon is processing the directives
1202 in the Include section, it will first backup all the files in {\bf /home}
1203 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
1204 the Plugin Directory.  The syntax and semantics of the Plugin directive
1205 require the first part of the string up to the colon (:) to be the name
1206 of the plugin. Everything after the first colon is ignored by the File daemon but
1207 is passed to the plugin. Thus the plugin writer may define the meaning of the
1208 rest of the string as he wishes.
1209
1210 Please see the next section for information about the {\bf bpipe} Bacula
1211 plugin.
1212
1213 \section{The bpipe Plugin}
1214 \index[general]{The bpipe Plugin}
1215 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
1216 the Bacula source distribution. When the plugin is compiled and linking into
1217 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
1218
1219 The purpose of the plugin is to provide an interface to any system program for
1220 backup and restore. As specified above the {\bf bpipe} plugin is specified in
1221 the Include section of your Job's FileSet resource.  The full syntax of the
1222 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
1223 to specify the sytax as it wishes) is:
1224
1225 \begin{verbatim}
1226   Plugin = "<field1>:<field2>:<field3>:<field4>"
1227 \end{verbatim}
1228
1229 where
1230 \begin{description}
1231 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
1232 stripped off, so in this case, we would put {\bf bpipe} in this field.
1233
1234 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
1235 pseudo path and filename under which the backup will be saved. This pseudo
1236 path and filename will be seen by the user in the restore file tree.
1237 For example, if the value is {\bf /MYSQL/regress.sql}, the data
1238 backed up by the plugin will be put under that "pseudo" path and filename.
1239 You must be careful to choose a naming convention that is unique to avoid
1240 a conflict with a path and filename that actually exists on your system.
1241
1242 \item {\bf field3} for the {\bf bpipe} plugin 
1243 specifies the "reader" program that is called by the plugin during
1244 backup to read the data. {\bf bpipe} will call this program by doing a
1245 {\bf popen} on it.
1246
1247 \item {\bf field4} for the {\bf bpipe} plugin
1248 specifies the "writer" program that is called by the plugin during
1249 restore to write the data back to the filesystem.  
1250 \end{description}
1251
1252 Putting it all together, the full plugin directive line might look
1253 like the following:
1254
1255 \begin{verbatim}
1256 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f 
1257           --opt --databases bacula:mysql"
1258 \end{verbatim}
1259
1260 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
1261 would be written on a single line.
1262
1263 This causes the File daemon to call the {\bf bpipe} plugin, which will write
1264 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the 
1265 program {\bf mysqldump -f --opt --database bacula} to read the data during
1266 backup. The mysqldump command outputs all the data for the database named
1267 {\bf bacula}, which will be read by the plugin and stored in the backup.
1268 During restore, the data that was backed up will be sent to the program
1269 specified in the last field, which in this case is {\bf mysql}.  When
1270 {\bf mysql} is called, it will read the data sent to it by the plugn
1271 then write it back to the same database from which it came ({\bf bacula}
1272 in this case).
1273
1274 The {\bf bpipe} plugin is a generic pipe program, that simply transmits 
1275 the data from a specified program to Bacula for backup, and then from Bacula to 
1276 a specified program for restore.
1277
1278 By using different command lines to {\bf bpipe},
1279 you can backup any kind of data (ASCII or binary) depending
1280 on the program called.
1281
1282 \section{Microsoft Exchange Server 2003/2007 Plugin}
1283 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
1284 \subsection{Background}
1285 The Exchange plugin was made possible by a funded development project
1286 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
1287 The code for the plugin was written by James Harper, and the Bacula core
1288 code by Kern Sibbald.  All the code for this funded development has become
1289 part of the Bacula project.  Thanks to everyone who made it happen.
1290
1291 \subsection{Concepts}
1292 Although it is possible to backup Exchange using Bacula VSS the Exchange 
1293 plugin adds a good deal of functionality, because while Bacula VSS
1294 completes a full backup (snapshot) of Exchange, it does
1295 not support Incremental or Differential backups, restoring is more
1296 complicated, and a single database restore is not possible.
1297
1298 Microsoft Exchange organises its storage into Storage Groups with
1299 Databases inside them. A default installation of Exchange will have a
1300 single Storage Group called 'First Storage Group', with two Databases
1301 inside it, "Mailbox Store (SERVER NAME)" and 
1302 "Public Folder Store (SERVER NAME)", 
1303 which hold user email and public folders respectively.
1304
1305 In the default configuration, Exchange logs everything that happens to
1306 log files, such that if you have a backup, and all the log files since,
1307 you can restore to the present time. Each Storage Group has its own set
1308 of log files and operates independently of any other Storage Groups. At
1309 the Storage Group level, the logging can be turned off by enabling a
1310 function called "Enable circular logging". At this time the Exchange
1311 plugin will not function if this option is enabled.
1312
1313 The plugin allows backing up of entire storage groups, and the restoring
1314 of entire storage groups or individual databases. Backing up and
1315 restoring at the individual mailbox or email item is not supported but
1316 can be simulated by use of the "Recovery" Storage Group (see below).
1317
1318 \subsection{Installing}
1319 The Exchange plugin requires a DLL that is shipped with Microsoft
1320 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
1321 correctly the Exchange plugin should find this automatically and run
1322 without any additional installation.
1323
1324 If the DLL can not be found automatically it will need to be copied into
1325 the Bacula installation
1326 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
1327 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
1328 default Exchange installation.
1329
1330 \subsection{Backup up}
1331 To back up an Exchange server the Fileset definition must contain at
1332 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
1333 the backup to work correctly. The 'exchange:' bit tells Bacula to look
1334 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
1335 up files are prefixed with something that isn't going to share a name
1336 with something outside the plugin, and the 'Microsoft Information Store'
1337 bit is required also. It is also possible to add the name of a storage
1338 group to the "Plugin =" line, eg \\
1339 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
1340 if you want only a single storage group backed up.
1341
1342 Additionally, you can suffix the 'Plugin =' directive with
1343 ":notrunconfull" which will tell the plugin not to truncate the Exchange
1344 database at the end of a full backup.
1345
1346 An Incremental or Differential backup will backup only the database logs
1347 for each Storage Group by inspecting the "modified date" on each
1348 physical log file. Because of the way the Exchange API works, the last
1349 logfile backed up on each backup will always be backed up by the next
1350 Incremental or Differential backup too. This adds 5MB to each
1351 Incremental or Differential backup size but otherwise does not cause any
1352 problems.
1353
1354 By default, a normal VSS fileset containing all the drive letters will
1355 also back up the Exchange databases using VSS. This will interfere with
1356 the plugin and Exchange's shared ideas of when the last full backup was
1357 done, and may also truncate log files incorrectly. It is important,
1358 therefore, that the Exchange database files be excluded from the backup,
1359 although the folders the files are in should be included, or they will
1360 have to be recreated manually if a baremetal restore is done.
1361
1362 \begin{verbatim}
1363 FileSet {
1364    Include {
1365       File = C:/Program Files/Exchsrvr/mdbdata
1366       Plugin = "exchange:..."
1367    }
1368    Exclude {
1369       File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
1370       File = C:/Program Files/Exchsrvr/mdbdata/E00.log
1371       File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
1372       File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
1373       File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
1374       File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
1375       File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
1376    }
1377 }
1378 \end{verbatim}
1379
1380 The advantage of excluding the above files is that you can significantly
1381 reduce the size of your backup since all the important Exchange files
1382 will be properly saved by the Plugin.
1383
1384
1385 \subsection{Restoring}
1386 The restore operation is much the same as a normal Bacula restore, with
1387 the following provisos:
1388
1389 \begin{itemize}
1390 \item  The {\bf Where} restore option must not be specified
1391 \item Each Database directory must be marked as a whole. You cannot just
1392      select (say) the .edb file and not the others.
1393 \item If a Storage Group is restored, the directory of the Storage Group
1394      must be marked too.
1395 \item  It is possible to restore only a subset of the available log files,
1396      but they {\bf must} be contiguous. Exchange will fail to restore correctly
1397      if a log file is missing from the sequence of log files
1398 \item Each database to be restored must be dismounted and marked as "Can be
1399     overwritten by restore"
1400 \item If an entire Storage Group is to be restored (eg all databases and
1401    logs in the Storage Group), then it is best to manually delete the
1402    database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
1403    as Exchange can get confused by stray log files lying around.
1404 \end{itemize}
1405
1406 \subsection{Restoring to the Recovery Storage Group}
1407 The concept of the Recovery Storage Group is well documented by
1408 Microsoft 
1409 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126}, 
1410 but to briefly summarize...
1411
1412 Microsoft Exchange allows the creation of an additional Storage Group
1413 called the Recovery Storage Group, which is used to restore an older
1414 copy of a database (e.g. before a mailbox was deleted) into without
1415 messing with the current live data. This is required as the Standard and
1416 Small Business Server versions of Exchange can not ordinarily have more
1417 than one Storage Group.
1418
1419 To create the Recovery Storage Group, drill down to the Server in Exchange
1420 System Manager, right click, and select
1421 {\bf "New -> Recovery Storage Group..."}.  Accept or change the file
1422 locations and click OK. On the Recovery Storage Group, right click and
1423 select {\bf "Add Database to Recover..."} and select the database you will
1424 be restoring.
1425
1426 Restore only the single database nominated as the database in the
1427 Recovery Storage Group. Exchange will redirect the restore to the
1428 Recovery Storage Group automatically.
1429 Then run the restore.
1430
1431 \subsection{Restoring on Microsoft Server 2007}
1432 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
1433 2007, and henc you use a new proceedure for recovering a single mail box.
1434 This procedure is ducomented by Microsoft at:
1435 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
1436 and involves using the {\bf Restore-Mailbox} and {\bf
1437 Get-MailboxStatistics} shell commands.
1438
1439 \subsection{Caveats}
1440 This plugin is still being developed, so you should consider it
1441 currently in BETA test, and thus use in a production environment
1442 should be done only after very careful testing.
1443
1444 When doing a full backup, the Exchange database logs are truncated by
1445 Exchange as soon as the plugin has completed the backup. If the data
1446 never makes it to the backup medium (eg because of spooling) then the
1447 logs will still be truncated, but they will also not have been backed
1448 up. A solution to this is being worked on. You will have to schedule a
1449 new Full backup to ensure that your next backups will be usable.
1450
1451 The "Enable Circular Logging" option cannot be enabled or the plugin
1452 will fail.
1453
1454 Exchange insists that a successful Full backup must have taken place if
1455 an Incremental or Differential backup is desired, and the plugin will
1456 fail if this is not the case. If a restore is done, Exchange will
1457 require that a Full backup be done before an Incremental or Differential
1458 backup is done.
1459
1460 The plugin will most likely not work well if another backup application
1461 (eg NTBACKUP) is backing up the Exchange database, especially if the
1462 other backup application is truncating the log files.
1463
1464 The Exchange plugin has not been tested with the {\bf Accurate} option, so
1465 we recommend either carefully testing or that you avoid this option for
1466 the current time.
1467
1468 The Exchange plugin is not called during processing the bconsole {\bf
1469 estimate} command, and so anything that would be backed up by the plugin
1470 will not be added to the estimate total that is displayed.
1471
1472
1473 \section{libdbi Framework}
1474 \index[general]{libdbi Framework}
1475 As a general guideline, Bacula has support for a few catalog database drivers
1476 (MySQL, PostgreSQL, SQLite)
1477 coded natively by the Bacula team.  With the libdbi implementation, which is a
1478 Bacula driver that uses libdbi to access the catalog, we have an open field to
1479 use many different kinds database engines following the needs of users.
1480
1481 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
1482 implements a database-independent abstraction layer in C, similar to the
1483 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
1484 leverage the power of multiple databases and multiple simultaneous database
1485 connections by using this framework.
1486
1487 Currently the libdbi driver in Bacula project only supports the same drivers
1488 natively coded in Bacula.  However the libdbi project has support for many
1489 others database engines. You can view the list at
1490 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
1491 supported by Bacula, however, they must be tested properly by the Bacula team.
1492
1493 Some of benefits of using libdbi are:
1494 \begin{itemize}
1495 \item The possibility to use proprietary databases engines in which your
1496   proprietary licenses prevent the Bacula team from developing the driver.
1497  \item The possibility to use the drivers written for the libdbi project.
1498  \item The possibility to use other database engines without recompiling Bacula
1499    to use them.  Just change one line in bacula-dir.conf
1500  \item Abstract Database access, this is, unique point to code and profiling
1501    catalog database access.
1502  \end{itemize}
1503  
1504  The following drivers have been tested:
1505  \begin{itemize}
1506  \item PostgreSQL, with and without batch insert
1507  \item Mysql, with and without batch insert
1508  \item SQLite
1509  \item SQLite3
1510  \end{itemize}
1511
1512  In the future, we will test and approve to use others databases engines
1513  (proprietary or not) like DB2, Oracle, Microsoft SQL.
1514
1515  To compile Bacula to support libdbi we need to configure the code with the
1516  --with-dbi and --with-dbi-driver=[database] ./configure options, where
1517  [database] is the database engine to be used with Bacula (of course we can
1518  change the driver in file bacula-dir.conf, see below).  We must configure the
1519  access port of the database engine with the option --with-db-port, because the
1520  libdbi framework doesn't know the default access port of each database.
1521
1522 The next phase is checking (or configuring) the bacula-dir.conf, example:
1523 \begin{verbatim}
1524 Catalog {
1525   Name = MyCatalog
1526   dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
1527   dbname = regress; user = regress; password = ""
1528 }
1529 \end{verbatim}
1530
1531 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
1532 mysql database.  Currently the drivers supported by Bacula are: postgresql,
1533 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
1534
1535 The following limitations apply when Bacula is set to use the libdbi framework:
1536  - Not tested on the Win32 platform
1537  - A little performance is lost if comparing with native database driver. 
1538    The reason is bound with the database driver provided by libdbi and the 
1539    simple fact that one more layer of code was added.
1540
1541 It is important to remember, when compiling Bacula with libdbi, the
1542 following packages are needed:
1543  \begin{itemize}
1544   \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
1545   \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
1546  \end{itemize}
1547  
1548  You can download them and compile them on your system or install the packages
1549  from your OS distribution.
1550
1551 \section{Console Command Additions and Enhancements}
1552 \index[general]{Console Additions}                                 
1553
1554 \subsection{Display Autochanger Content}
1555 \index[general]{StatusSlots}
1556
1557 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
1558 autochanger content.
1559
1560 \footnotesize
1561 \begin{verbatim}
1562  Slot |  Volume Name  |  Status  |  Media Type       |   Pool     |
1563 ------+---------------+----------+-------------------+------------|
1564     1 |         00001 |   Append |  DiskChangerMedia |    Default |
1565     2 |         00002 |   Append |  DiskChangerMedia |    Default |
1566     3*|         00003 |   Append |  DiskChangerMedia |    Scratch |
1567     4 |               |          |                   |            |
1568 \end{verbatim}
1569 \normalsize
1570
1571 If you an asterisk ({\bf *}) appears after the slot number, you must run an
1572 {\bf update slots} command to synchronize autochanger content with your
1573 catalog.
1574
1575 \subsection{list joblog job=xxx or jobid=nnn}
1576 \index[general]{list joblog}
1577 A new list command has been added that allows you to list the contents
1578 of the Job Log stored in the catalog for either a Job Name (fully qualified)
1579 or for a particular JobId.  The {\bf llist} command will include a line with
1580 the time and date of the entry.
1581
1582 Note for the catalog to have Job Log entries, you must have a directive 
1583 such as:
1584
1585 \begin{verbatim}
1586   catalog = all
1587 \end{verbatim}
1588
1589 In your Director's {\bf Messages} resource.
1590
1591 \subsection{Use separator for multiple commands}
1592 \index[general]{Command Separator}
1593   When using bconsole with readline, you can set the command separator with 
1594   \textbf{@separator} command to one
1595   of those characters to write commands who require multiple input in one line.
1596 \begin{verbatim}
1597   !$%&'()*+,-/:;<>?[]^`{|}~
1598 \end{verbatim}
1599
1600 \subsection{Deleting Volumes}
1601 The delete volume bconsole command has been modified to
1602 require an asterisk (*) in front of a MediaId otherwise the
1603 value you enter is a taken to be a Volume name. This is so that
1604 users may delete numeric Volume names. The previous Bacula versions
1605 assumed that all input that started with a number was a MediaId.
1606
1607 This new behavior is indicated in the prompt if you read it
1608 carefully.
1609
1610 \section{Bare Metal Recovery}
1611 The old bare metal recovery project is essentially dead. One
1612 of the main features of it was that it would build a recovery
1613 CD based on the kernel on your system. The problem was that
1614 every distribution has a different boot procedure and different 
1615 scripts, and worse yet, the boot procedures and scripts change
1616 from one distribution to another.  This meant that maintaining
1617 (keeping up with the changes) the rescue CD was too much work.
1618
1619 To replace it, a new bare metal recovery USB boot stick has been developed
1620 by Bacula Systems.  This technology involves remastering a Ubuntu LiveCD to
1621 boot from a USB key.  
1622
1623 Advantages: 
1624 \begin{enumerate} 
1625 \item Recovery can be done from within graphical environment.  
1626 \item Recovery can be done in a shell.  
1627 \item Ubuntu boots on a large number of Linux systems.  
1628 \item The process of updating the system and adding new
1629    packages is not too difficult. 
1630 \item The USB key can easily be upgraded to newer Ubuntu versions.
1631 \item The USB key has writable partitions for modifications to
1632    the OS and for modification to your home directory.
1633 \item You can add new files/directories to the USB key very easily.
1634 \item You can save the environment from multiple machines on
1635    one USB key.
1636 \item Bacula Systems is funding its ongoing development.
1637 \end{enumerate}
1638
1639 The disadvantages are:
1640 \begin{enumerate}
1641 \item The USB key is usable but currently under development.
1642 \item Not everyone may be familiar with Ubuntu (no worse
1643   than using Knoppix)
1644 \item Some older OSes cannot be booted from USB. This can
1645    be resolved by first booting a Ubuntu LiveCD then plugging
1646    in the USB key.
1647 \item Currently the documentation is sketchy and not yet added
1648    to the main manual. See below ...
1649 \end{enumerate}
1650
1651 The documentation and the code can be found in the {\bf rescue} package
1652 in the directory {\bf linux/usb}.
1653
1654 \section{Miscellaneous}
1655 \index[general]{Misc New Features}
1656
1657 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
1658 \index[general]{Allow Mixed Priority}
1659    This directive is only implemented in version 2.5 and later.  When
1660    set to {\bf yes} (default {\bf no}), this job may run even if lower
1661    priority jobs are already running.  This means a high priority job
1662    will not have to wait for other jobs to finish before starting.
1663    The scheduler will only mix priorities when all running jobs have
1664    this set to true.
1665
1666    Note that only higher priority jobs will start early.  Suppose the
1667    director will allow two concurrent jobs, and that two jobs with
1668    priority 10 are running, with two more in the queue.  If a job with
1669    priority 5 is added to the queue, it will be run as soon as one of
1670    the running jobs finishes.  However, new priority 10 jobs will not
1671    be run until the priority 5 job has finished.
1672
1673 \subsection{Bootstrap File Directive -- FileRegex}
1674 \index[general]{Bootstrap File Directive}
1675   {\bf FileRegex} is a new command that can be added to the bootstrap
1676   (.bsr) file.  The value is a regular expression.  When specified, only
1677   matching filenames will be restored.
1678
1679   During a restore, if all File records are pruned from the catalog
1680   for a Job, normally Bacula can restore only all files saved. That
1681   is there is no way using the catalog to select individual files.
1682   With this new feature, Bacula will ask if you want to specify a Regex
1683   expression for extracting only a part of the full backup.
1684
1685 \begin{verbatim}
1686   Building directory tree for JobId(s) 1,3 ...
1687   There were no files inserted into the tree, so file selection
1688   is not possible.Most likely your retention policy pruned the files
1689   
1690   Do you want to restore all the files? (yes\vb{}no): no
1691   
1692   Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
1693   Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
1694 \end{verbatim}
1695
1696 \subsection{Bootstrap File Optimization Changes}
1697 In order to permit proper seeking on disk files, we have extended the bootstrap
1698 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
1699 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
1700 address range and end address range respectively.  These two directives replace
1701 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
1702   VolEndBlock} directives.  Bootstrap files containing the old directives will
1703 still work, but will not properly take advantage of proper disk seeking, and
1704 may read completely to the end of a disk volume during a restore.  With the new
1705 format (automatically generated by the new Director), restores will seek
1706 properly and stop reading the volume when all the files have been restored.
1707
1708 \subsection{Solaris ZFS/NFSv4 ACLs}
1709 This is an upgrade of the previous Solaris ACL backup code
1710 to the new library format, which will backup both the old
1711 POSIX(UFS) ACLs as well as the ZFS ACLs.
1712
1713 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
1714 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
1715 be used to transfer from UFS to ZFS filesystems.
1716
1717
1718 \subsection{Virtual Tape Emulation}
1719 \index[general]{Virtual Tape Emulation}
1720 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
1721 the tape code but actually reading and writing to a disk file. Used with the
1722 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
1723 and 700 slots. This feature is most useful in testing.  It is enabled
1724 by using {\bf Device Type = vtape} in the Storage daemon's Device
1725 directive. This feature is only implemented on Linux machines and should not be
1726 used for production.
1727
1728 \subsection{Bat Enhancements}
1729 \index[general]{Bat Enhancements}
1730 Bat (the Bacula Administration Tool) GUI program has been significantly
1731 enhanced and stabilized. In particular, there are new table based status 
1732 commands; it can now be easily localized using Qt4 Linguist.
1733
1734 The Bat communications protocol has been significantly enhanced to improve
1735 GUI handling. Note, you {\bf must} use a the bat that is distributed with
1736 the Director you are using otherwise the communications protocol will not
1737 work.
1738
1739 \subsection{RunScript Enhancements}
1740 \index[general]{RunScript Enhancements}
1741 The {\bf RunScript} resource has been enhanced to permit multiple
1742 commands per RunScript.  Simply specify multiple {\bf Command} directives
1743 in your RunScript.
1744
1745 \begin{verbatim}
1746 Job {
1747   Name = aJob
1748   RunScript {
1749     Command = "/bin/echo test"
1750     Command = "/bin/echo an other test"
1751     Command = "/bin/echo 3 commands in the same runscript"
1752     RunsWhen = Before
1753   }
1754  ...
1755 }
1756 \end{verbatim}
1757
1758 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
1759 implemented, which runs the command after the Volume Shadow Copy has been made.
1760
1761 Console commands can be specified within a RunScript by using:
1762 {\bf Console = \lt{}command\gt{}}, however, this command has not been 
1763 carefully tested and debugged and is known to easily crash the Director.
1764 We would appreciate feedback.  Due to the recursive nature of this command, we
1765 may remove it before the final release.
1766
1767 \subsection{Status Enhancements}
1768 \index[general]{Status Enhancements}
1769 The bconsole {\bf status dir} output has been enhanced to indicate
1770 Storage daemon job spooling and despooling activity.
1771
1772 \subsection{Connect Timeout}
1773 \index[general]{Connect Timeout}
1774 The default connect timeout to the File
1775 daemon has been set to 3 minutes. Previously it was 30 minutes.
1776
1777 \subsection{ftruncate for NFS Volumes}
1778 \index[general]{ftruncate for NFS Volumes}
1779 If you write to a Volume mounted by NFS (say on a local file server),
1780 in previous Bacula versions, when the Volume was recycled, it was not
1781 properly truncated because NFS does not implement ftruncate (file 
1782 truncate). This is now corrected in the new version because we have
1783 written code (actually a kind user) that deletes and recreates the Volume,
1784 thus accomplishing the same thing as a truncate.
1785
1786 \subsection{Support for Ubuntu}
1787 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
1788 version of Linux, and thus now provides correct autostart routines.
1789 Since Ubuntu officially supports Bacula, you can also obtain any
1790 recent release of Bacula from the Ubuntu repositories.
1791
1792 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
1793 \index[general]{Recycle Pool}
1794 The new \textbf{RecyclePool} directive defines to which pool the Volume will
1795 be placed (moved) when it is recycled. Without this directive, a Volume will
1796 remain in the same pool when it is recycled. With this directive, it can be
1797 moved automatically to any existing pool during a recycle. This directive is
1798 probably most useful when defined in the Scratch pool, so that volumes will
1799 be recycled back into the Scratch pool.
1800
1801 \subsection{FD Version}
1802 \index[general]{FD Version}
1803 The File daemon to Director protocol now includes a version 
1804 number, which although there is no visible change for users, 
1805 will help us in future versions automatically determine
1806 if a File daemon is not compatible.
1807
1808 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
1809 \index[general]{Max Run Sched Time}
1810 The time specifies the maximum allowed time that a job may run, counted from
1811 when the job was scheduled. This can be useful to prevent jobs from running
1812 during working hours. We can see it like \texttt{Max Start Delay + Max Run
1813   Time}.
1814
1815 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
1816 \index[general]{Max Wait Time}
1817 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
1818 of checking the maximum allowed time that a job may block for a resource,
1819 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
1820 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
1821 their job depending on the level. Now, they have to use
1822 \textbf{Incr/Diff/Full Max Run Time}.  \textbf{Incr/Diff/Full Max Wait Time}
1823 directives are now deprecated.
1824
1825 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}} 
1826 \index[general]{Incremental Max Wait Time}
1827 \index[general]{Differential Max Wait Time}
1828
1829 These directives have been deprecated in favor of
1830 \texttt{Incremental|Differential Max Run Time}.
1831
1832 \subsection{Max Run Time directives}
1833 \index[general]{Max Run Time directives}
1834 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
1835 maximum allowed time that a job can run depending on the level.
1836
1837 \addcontentsline{lof}{figure}{Job time control directives}
1838 \includegraphics{\idir different_time.eps}
1839
1840 \subsection{Statistics Enhancements}
1841 \index[general]{Statistics Enhancements}
1842 If you (or probably your boss) want to have statistics on your backups to
1843 provide some \textit{Service Level Agreement} indicators, you could use a few
1844 SQL queries on the Job table to report how many:
1845
1846 \begin{itemize}
1847 \item jobs have run
1848 \item jobs have been successful
1849 \item files have been backed up
1850 \item ...
1851 \end{itemize}
1852
1853 However, these statistics are accurate only if your job retention is greater
1854 than your statistics period. Ie, if jobs are purged from the catalog, you won't
1855 be able to use them. 
1856
1857 Now, you can use the \textbf{update stats [days=num]} console command to fill
1858 the JobHistory table with new Job records. If you want to be sure to take in
1859 account only \textbf{good jobs}, ie if one of your important job has failed but
1860 you have fixed the problem and restarted it on time, you probably want to
1861 delete the first \textit{bad} job record and keep only the successful one. For
1862 that simply let your staff do the job, and update JobHistory table after two or
1863 three days depending on your organization using the \textbf{[days=num]} option.
1864
1865 These statistics records aren't used for restoring, but mainly for
1866 capacity planning, billings, etc.
1867
1868 The Bweb interface provides a statistics module that can use this feature. You
1869 can also use tools like Talend or extract information by yourself.
1870
1871 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
1872 the length of time that Bacula will keep statistics job records in the Catalog
1873 database after the Job End time. (In \texttt{JobHistory} table) When this time
1874 period expires, and if user runs \texttt{prune stats} command, Bacula will
1875 prune (remove) Job records that are older than the specified period.
1876
1877 You can use the following Job resource in your nightly \textbf{BackupCatalog}
1878 job to maintain statistics.
1879 \begin{verbatim}
1880 Job {
1881   Name = BackupCatalog
1882   ...
1883   RunScript {
1884     Console = "update stats days=3"
1885     Console = "prune stats yes"
1886     RunsWhen = After
1887     RunsOnClient = no
1888   }
1889 }
1890 \end{verbatim}
1891
1892 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
1893 \index[general]{ScratchPool}
1894 This directive permits to specify a specific \textsl{Scratch} pool for the
1895 current pool. This is useful when using multiple storage sharing the same
1896 mediatype or when you want to dedicate volumes to a particular set of pool.
1897
1898 \subsection{Enhanced Attribute Despooling}
1899 \index[general]{Attribute Despooling}
1900 If the storage daemon and the Director are on the same machine, the spool file
1901 that contains attributes is read directly by the Director instead of being
1902 transmitted across the network. That should reduce load and speedup insertion.
1903
1904 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
1905 \index[general]{SpoolSize}
1906 A new Job directive permits to specify the spool size per job. This is used
1907 in advanced job tunning. {\bf SpoolSize={\it bytes}}
1908
1909 \subsection{MaxConsoleConnections = \lt{}number\gt{}}
1910 \index[general]{MaxConsoleConnections}
1911 A new director directive permits to specify the maximum number of Console
1912 Connections that could run concurrently. The default is set to 20, but you may
1913 set it to a larger number.
1914
1915 \subsection{VerId = \lt{}string\gt{}}
1916 \index[general]{VerId}
1917 A new director directive permits to specify a personnal identifier that will be
1918 displayed in the \texttt{version} command.
1919
1920 \subsection{dbcheck enhancements}
1921 \index[general]{dbcheck enhancements}
1922 If you are using Mysql, dbcheck will now ask you if you want to create
1923 temporary indexes to speed up orphaned Path and Filename elimination. 
1924
1925 A new \texttt{-B} option allows you to print catalog information in a simple
1926 text based format. This is useful to backup it in a secure way.
1927
1928 \begin{verbatim}
1929  $ dbcheck -B 
1930  catalog=MyCatalog
1931  db_type=SQLite
1932  db_name=regress
1933  db_driver=
1934  db_user=regress
1935  db_password=
1936  db_address=
1937  db_port=0
1938  db_socket=
1939 \end{verbatim} %$
1940
1941 You can now specify the database connection port in the command line.
1942
1943 \subsection{{-}{-}docdir configure option}
1944 \index[general]{{-}{-}docdir configure option}
1945 You can use {-}{-}docdir= on the ./configure command to
1946 specify the directory where you want Bacula to install the
1947 LICENSE, ReleaseNotes, ChangeLog, ... files.   The default is 
1948 {\bf /usr/share/doc/bacula}.
1949       
1950 \subsection{{-}{-}htmldir configure option}
1951 \index[general]{{-}{-}htmldir configure option}
1952 You can use {-}{-}htmldir= on the ./configure command to
1953 specify the directory where you want Bacula to install the bat html help
1954 files. The default is {\bf /usr/share/doc/bacula/html}
1955
1956 \subsection{{-}{-}with-plugindir configure option}
1957 \index[general]{{-}{-}plugindir configure option}
1958 You can use {-}{-}plugindir= on the ./configure command to
1959 specify the directory where you want Bacula to install
1960 the plugins (currently only bpipe-fd). The default is
1961 /usr/lib.