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