Fix description of Volume Retention -- bug 1844

[bacula/docs] / docs / manuals / en / main / newfeatures.tex

\chapter{New Features in 7.4.0}
This chapter presents the new features that have been added to
the various versions of Bacula.

\section{New Features in 7.4.3}
\subsection{RunScripts}
There are two new RunScript short cut directives implemented in
the Director.  They are:

\begin{verbatim}
Job {
  ...
  ConsoleRunBeforeJob = "console-command"
  ...
}
\end{verbatim}

\begin{verbatim}
Job {
  ...
  ConsoleRunAfterJob = "console-command"
  ...
}
\end{verbatim}

As with other RunScript commands, you may have multiple copies
of either the {\bf ConsoleRunBeforeJob} or the {\bf ConsoleRunAfterJob}
in the same Job resource definition.
\smallskip
Please note that not all console commands are permitted, and that 
if you run a console command that requires a response, the results
are not determined (i.e. it will probably fail).


\section{New Features in 7.4.0}
\subsection{Verify Volume Data}

It is now possible to have a Verify Job configured with \texttt{level=Data} to
reread all records from a job and optionally check the size and the checksum
of all files.

\begin{verbatim}
# Verify Job definition
Job {
  Name = VerifyData
  Level = Data
  Client = 127.0.0.1-fd     # Use local file daemon
  FileSet = Dummy           # Will be adapted during the job
  Storage = File            # Should be the right one
  Messages = Standard
  Pool = Default
}

# Backup Job definition
Job {
  Name = MyBackupJob
  Type = Backup
  Client = windows1
  FileSet = MyFileSet
  Pool = 1Month
  Storage = File
}

FileSet {
  Name = MyFileSet
  Include {
    Options {
      Verify = s5
      Signature = MD5
    }
  File = /
}
\end{verbatim}

To run the Verify job, it is possible to use the ``jobid'' parameter of the ``run'' command.

\begin{verbatim}
*run job=VerifyData jobid=10
Run Verify Job
JobName:     VerifyData
Level:       Data
Client:      127.0.0.1-fd
FileSet:     Dummy
Pool:        Default (From Job resource)
Storage:     File (From Job resource)
Verify Job:  MyBackupJob.2015-11-11_09.41.55_03
Verify List: /opt/bacula/working/working/VerifyVol.bsr
When:        2015-11-11 09:47:38
Priority:    10
OK to run? (yes/mod/no): yes
Job queued. JobId=14

...

11-Nov 09:46 my-dir JobId 13: Bacula 7.4.0 (13Nov15):
  Build OS:               x86_64-unknown-linux-gnu archlinux
  JobId:                  14
  Job:                    VerifyData.2015-11-11_09.46.29_03
  FileSet:                MyFileSet
  Verify Level:           Data
  Client:                 127.0.0.1-fd
  Verify JobId:           10
  Verify Job:q
  Start time:             11-Nov-2015 09:46:31
  End time:               11-Nov-2015 09:46:32
  Files Expected:         1,116
  Files Examined:         1,116
  Non-fatal FD errors:    0
  SD Errors:              0
  FD termination status:  Verify differences
  SD termination status:  OK
  Termination:            Verify Differences
\end{verbatim}

The current Verify Data implementation requires specifying the correct Storage
resource in the Verify job. The Storage resource can be changed with the bconsole
command line and with the menu.

\subsection{Bconsole ``list jobs'' command options}

The \texttt{list jobs} bconsole command now accepts new command line options:

\begin{itemize}
\item \textbf{joberrors} Display jobs with JobErrors
\item \textbf{jobstatus=T} Display jobs with the specified status code
\item \textbf{client=cli} Display jobs for a specified client
\item \textbf{order=asc/desc} Change the output format of the job list. The
  jobs are sorted by start time and JobId, the sort can use ascendant (asc) or
  descendant (desc) (default) value.
\end{itemize}

\subsection{Minor Enhancements}

\subsubsection{New Bconsole "Tee All" Command}

The ``@tall'' command allows logging all input/output from a console session.

\begin{verbatim}
*@tall /tmp/log
*st dir
...
\end{verbatim}

\subsection{Windows Encrypted File System (EFS) Support}

The Bacula Enterprise Windows File Daemon for the community version
7.4.0 now automatically supports files and
directories that are encrypted on Windows filesystem.

\subsection{SSL Connections to MySQL}

There are five new Directives for the Catalog resource in the
{\bf bacula-dir.conf} file that you can use to encrypt the 
communications between Bacula and MySQL for additional
security.

\begin{description}
\item [dbsslkey] takes a string variable that specifies the filename of an
SSL key file.
\item [dbsslcert] takes a string variable that specifies the filename of an
SSL certificate file.
\item [dbsslca] takes a string variable that specifies the filename of a
SSL CA (certificate authority) certificate.
\item [dbsslcipher] takes a string variable that specifies the cipher
to be used.
\end{description}

\subsection{Max Virtual Full Interval}
This is a new Job resource directive that specifies the time in seconds
that is a maximum time between Virtual Full jobs.  It is much like the
Max Full Interval directive but applies to Virtual Full jobs rather
that Full jobs.

\subsection{New List Volumes Output}
The {\bf list} and {\bf llist} commands have been modified so that when
listing Volumes a new pseudo field {\bf expiresin} will be printed. This 
field is the number of seconds in which the retention period will expire. 
If the retention period has already expired the value will be zero.  Any
non-zero value means that the retention period is still in effect.

An example with many columns shorted for display purpose is:

\begin{verbatim}
*list volumes
Pool: Default
*list volumes
Pool: Default
+----+---------------+-----------+---------+-------------+-----------+
| id | volumename    | volstatus | enabled | volbytes    | expiresin |
+----+---------------+-----------+---------+-------------+-----------+
|  1 | TestVolume001 | Full      |       1 | 249,940,696 |         0 |
|  2 | TestVolume002 | Full      |       1 | 249,961,704 |         1 |
|  3 | TestVolume003 | Full      |       1 | 249,961,704 |         2 |
|  4 | TestVolume004 | Append    |       1 | 127,367,896 |         3 |
+----+---------------+-----------+---------+-------------+-----------+
\end{verbatim}

%%
%%
\chapter{New Features in 7.2.0}
This chapter presents the new features that have been added to
the various versions of Bacula.

\section{New Features in 7.2.0}

\subsection{New Job Edit Codes \%E \%R}
In various places such as RunScripts, you have now access to \%E to get the
number of non-fatal errors for the current Job and \%R to get the number of
bytes read from disk or from the network during a job.

\subsection{Enable/Disable commands}
The \textbf{bconsole} \textbf{enable} and \textbf{disable} commands have
been extended from enabling/disabling Jobs to include Clients, Schedule,
and Storage devices.  Examples:

\begin{verbatim}
   disable Job=NightlyBackup Client=Windows-fd
\end{verbatim}

will disable the Job named \textbf{NightlyBackup} as well as the
client named \textbf{Windows-fd}.

\begin{verbatim}
   disable Storage=LTO-changer Drive=1
\end{verbatim}

will disable the first drive in the autochanger named \textbf{LTO-changer}.

Please note that doing a \textbf{reload} command will set any values
changed by the enable/disable commands back to the values in the
bacula-dir.conf file.

The Client and Schedule resources in the bacula-dir.conf file now permit
the directive Enable = yes or Enable = no.


\section{Bacula 7.2}

\subsection{Snapshot Management}

Bacula 7.2 is now able to handle Snapshots on Linux/Unix
systems. Snapshots can be automatically created and used to backup files. It is
also possible to manage Snapshots from Bacula's \texttt{bconsole} tool through a
unique interface.

\subsubsection{Snapshot Backends}

The following Snapshot backends are supported with Bacula Enterprise 8.2:

\begin{itemize}
\item BTRFS
\item ZFS
\item LVM\footnote{Some restrictions described in \vref{LVMBackend} applies to
    the LVM backend}
\end{itemize}

By default, Snapshots are mounted (or directly available) under
\textbf{.snapshots} directory on the root filesystem. (On ZFS, the default
is \textbf{.zfs/snapshots}).

\smallskip{}

The Snapshot backend program is called \textbf{bsnapshot} and is available in
the \textbf{bacula-enterprise-snapshot} package. In order to use the Snapshot
Management feature, the package must be installed on the Client.

\smallskip{}
\label{bsnapshotconf}
The \textbf{bsnapshot} program can be configured using
\texttt{/opt/bacula/etc/bsnapshot.conf} file. The following parameters can
be adjusted in the configuration file:

\begin{itemize}
\item \texttt{trace=<file>} Specify a trace file
\item \texttt{debug=<num>} Specify a debug level
\item \texttt{sudo=<yes/no>} Use sudo to run commands
\item \texttt{disabled=<yes/no>} Disable snapshot support
\item \texttt{retry=<num>} Configure the number of retries for some operations
\item \texttt{snapshot\_dir=<dirname>} Use a custom name for the Snapshot directory. (\textbf{.SNAPSHOT}, \textbf{.snapdir}, etc...)
\item \texttt{lvm\_snapshot\_size=<lvpath:size>} Specify a custom snapshot size for a given LVM volume
\end{itemize}

\begin{verbatim}
# cat /opt/bacula/etc/bsnapshot.conf
trace=/tmp/snap.log
debug=10
lvm_snapshot_size=/dev/ubuntu-vg/root:5%
\end{verbatim}


\subsubsection{Application Quiescing}

When using Snapshots, it is very important to quiesce applications that are
running on the system. The simplest way to quiesce an application is to stop
it. Usually, taking the Snapshot is very fast, and the downtime is only about a
couple of seconds. If downtime is not possible and/or the application provides
a way to quiesce, a more advanced script can be used. An example is
described on \vref{SnapRunScriptExample}.

\subsubsection{New Director Directives}

The use of the Snapshot Engine on the FileDaemon is determined by the
new \textbf{Enable Snapshot} FileSet directive. The default is \textbf{no}.

\begin{verbatim}
FileSet {
  Name = LinuxHome

  Enable Snapshot = yes

  Include {
    Options = { Compression = LZO }
    File = /home
  }
}
\end{verbatim}

By default, Snapshots are deleted from the Client at the end of the backup.  To
keep Snapshots on the Client and record them in the Catalog for a determined
period, it is possible to use the \textbf{Snapshot Retention} directive in the
Client or in the Job resource. The default value is 0 secconds. If, for a given Job,
both Client and Job \textbf{Snapshot Retention} directives are set, the Job
directive will be used.

\begin{verbatim}
Client {
   Name = linux1
   ...

   Snapshot Retention = 5 days
}
\end{verbatim}

To automatically prune Snapshots, it is possible to use the following RunScript
command:

\begin{verbatim}
Job {
   ...
   Client = linux1
   ...
   RunScript {
      RunsOnClient = no
      Console = "prune snapshot client=%c yes"
      RunsAfter = yes
   }
}
\end{verbatim}


\smallskip{}



In RunScripts, the \texttt{AfterSnapshot} keyword for the \texttt{RunsWhen} directive will
allow a command to be run just after the Snapshot creation.  \texttt{AfterSnapshot} is a
synonym for the \texttt{AfterVSS} keyword.

\label{SnapRunScriptExample}
\begin{verbatim}
Job {
 ...
  RunScript {
    Command = "/etc/init.d/mysql start"
    RunsWhen = AfterSnapshot
    RunsOnClient = yes
  }
  RunScript {
    Command = "/etc/init.d/mysql stop"
    RunsWhen = Before
    RunsOnClient = yes
  }
}
\end{verbatim}

\subsubsection{Job Output Information}

Information about Snapshots are displayed in the Job output. The list of all
devices used by the Snapshot Engine is displayed, and the Job summary
indicates if Snapshots were available.

\begin{verbatim}
JobId 3:    Create Snapshot of /home/build
JobId 3:    Create Snapshot of /home/build/subvol
JobId 3:    Delete snapshot of /home/build
JobId 3:    Delete snapshot of /home/build/subvol
...
JobId 3: Bacula 127.0.0.1-dir 7.2.0 (23Jul15):
  Build OS:               x86_64-unknown-linux-gnu archlinux 
  JobId:                  3
  Job:                    Incremental.2015-02-24_11.20.27_08
  Backup Level:           Full
...
  Snapshot/VSS:           yes
...
  Termination:            Backup OK
\end{verbatim}


\subsubsection{New ``snapshot'' Bconsole Commands}

The new \textbf{snapshot} command will display by default the following menu:
\begin{verbatim}
*snapshot
Snapshot choice:
     1: List snapshots in Catalog
     2: List snapshots on Client
     3: Prune snapshots
     4: Delete snapshot
     5: Update snapshot parameters
     6: Update catalog with Client snapshots
     7: Done
Select action to perform on Snapshot Engine (1-7):
\end{verbatim}

The \textbf{snapshot} command can also have the following parameters:
\begin{verbatim}
[client=<client-name> | job=<job-name> | jobid=<jobid>]
 [delete | list | listclient | prune | sync | update]
\end{verbatim}

It is also possible to use traditional \texttt{list}, \texttt{llist},
\texttt{update}, \texttt{prune} or \texttt{delete} commands on Snapshots.

\begin{verbatim}
*llist snapshot jobid=5
 snapshotid: 1
       name: NightlySave.2015-02-24_12.01.00_04
 createdate: 2015-02-24 12:01:03
     client: 127.0.0.1-fd
    fileset: Full Set
      jobid: 5
     volume: /home/.snapshots/NightlySave.2015-02-24_12.01.00_04
     device: /home/btrfs
       type: btrfs
  retention: 30
    comment:
\end{verbatim}

\begin{verbatim}
* snapshot listclient
Automatically selected Client: 127.0.0.1-fd
Connecting to Client 127.0.0.1-fd at 127.0.0.1:8102
Snapshot      NightlySave.2015-02-24_12.01.00_04:
  Volume:     /home/.snapshots/NightlySave.2015-02-24_12.01.00_04
  Device:     /home
  CreateDate: 2015-02-24 12:01:03
  Type:       btrfs
  Status:     OK
  Error:
\end{verbatim}

\smallskip{}

With the \textsl{Update catalog with Client snapshots} option (or
\textbf{snapshot sync}), the Director contacts the FileDaemon, lists snapshots
of the system and creates catalog records of the Snapshots.

\begin{verbatim}
*snapshot sync
Automatically selected Client: 127.0.0.1-fd
Connecting to Client 127.0.0.1-fd at 127.0.0.1:8102
Snapshot      NightlySave.2015-02-24_12.35.47_06:
  Volume:     /home/.snapshots/NightlySave.2015-02-24_12.35.47_06
  Device:     /home
  CreateDate: 2015-02-24 12:35:47
  Type:       btrfs
  Status:     OK
  Error:
Snapshot added in Catalog

*llist snapshot
 snapshotid: 13
       name: NightlySave.2015-02-24_12.35.47_06
 createdate: 2015-02-24 12:35:47
     client: 127.0.0.1-fd
    fileset:
      jobid: 0
     volume: /home/.snapshots/NightlySave.2015-02-24_12.35.47_06
     device: /home
       type: btrfs
  retention: 0
    comment: 
\end{verbatim}

% list
% llist
% prune
% delete
% update snapshot
% sync

\subsubsection{LVM Backend Restrictions}
\label{LVMBackend}

LVM Snapshots are quite primitive compared to ZFS, BTRFS, NetApp and other
systems. For example, it is not possible to use Snapshots if the Volume Group
(VG) is full. The administrator must keep some free space in the VG
to create Snapshots. The amount of free space required depends on the activity of the
Logical Volume (LV). \textbf{bsnapshot} uses 10\% of the LV by
default. This number can be configured per LV in the
\textbf{bsnapshot.conf} file.

\begin{verbatim}
[root@system1]# vgdisplay
  --- Volume group ---
  VG Name               vg_ssd
  System ID
  Format                lvm2
...
  VG Size               29,81 GiB
  PE Size               4,00 MiB
  Total PE              7632
  Alloc PE / Size       125 / 500,00 MiB
  Free  PE / Size       7507 / 29,32 GiB
...
\end{verbatim}

It is also not advisable to leave snapshots on the LVM backend. Having multiple
snapshots of the same LV on LVM will slow down the system.

\subsubsection{Debug Options}

To get low level information about the Snapshot Engine, the debug tag ``snapshot''
should be used in the \textbf{setdebug} command.

\begin{verbatim}
* setdebug level=10 tags=snapshot client
* setdebug level=10 tags=snapshot dir
\end{verbatim}

\subsection{Minor Enhancements}
\subsubsection{Storage Daemon Reports Disk Usage}

The \texttt{status storage} command now  reports the space available on disk devices:
\begin{verbatim}
...
Device status:

Device file: "FileStorage" (/bacula/arch1) is not open.
    Available Space=5.762 GB
==

Device file: "FileStorage1" (/bacula/arch2) is not open.
    Available Space=5.862 GB
\end{verbatim}

\subsection{Data Encryption Cipher Configuration}
Bacula Enterprise version 8.0 and later now allows configuration of the data
encryption cipher and the digest algorithm. Previously, the cipher was forced to AES 128,
but it is now possible to choose between the following ciphers:

\begin{itemize}
\item AES128 (default)
\item AES192
\item AES256
\item blowfish
\end{itemize}

The digest algorithm was set to SHA1 or SHA256 depending on the local OpenSSL
options. We advise you to not modify the PkiDigest default setting. Please,
refer to the OpenSSL documentation to understand the pros and cons regarding these options.

\begin{verbatim}
  FileDaemon {
    ...
    PkiCipher = AES256
  }
\end{verbatim}

\subsubsection*{New  Option Letter ``M'' for Accurate Directive in FileSet}

% waa - 20150317 - is 8.0.5 correct here?
Added in version 8.0.5, the new ``M'' option letter for the Accurate directive
in the FileSet Options block, which allows comparing the modification time and/or
creation time against the last backup timestamp. This is in contrast to the
existing options letters ``m'' and/or ``c'', mtime and ctime, which are checked
against the stored catalog values, which can vary accross different machines
when using the BaseJob feature.

The advantage of the new ``M'' option letter for Jobs that refer to BaseJobs is
that it will instruct Bacula to backup files based on the last backup time, which
is more useful because the mtime/ctime timestamps may differ on various Clients,
causing files to be needlessly backed up.

\smallskip{}

\begin{verbatim}
  Job {
    Name = USR
    Level = Base
    FileSet = BaseFS
...
  }

  Job {
    Name = Full
    FileSet = FullFS
    Base = USR
...
  }

  FileSet {
    Name = BaseFS
    Include {
      Options {
        Signature = MD5
      }
      File = /usr
    }
  }

  FileSet {
    Name = FullFS
    Include {
      Options {
        Accurate = Ms      # check for mtime/ctime of last backup timestamp and Size
        Signature = MD5
      }
      File = /home
      File = /usr
    }
  }
\end{verbatim}

\subsubsection*{New Debug Options}

In Bacula Enterprise version 8.0 and later, we introduced a new \texttt{options} parameter for
the \texttt{setdebug} bconsole command.

\smallskip{}

The following arguments to the new \texttt{option} parameter are available to control debug functions.

\begin{itemize}
\item [0] Clear debug flags
\item [i] Turn off, ignore bwrite() errors on restore on File Daemon
\item [d] Turn off decomp of BackupRead() streams on File Daemon
\item [t] Turn on timestamps in traces
\item [T] Turn off timestamps in traces

% waa - 20150306 - does this "c" item mean to say "Truncate trace file if one exists, otherwise append to it"   ???
\item [c] Truncate trace file if trace file is activated

\item [l] Turn on recoding events on P() and V()
\item [p] Turn on the display of the event ring when doing a bactrace
\end{itemize}

\smallskip{}

The following command will enable debugging for the File Daemon, truncate an existing trace file,
and turn on timestamps when writing to the trace file.

\begin{verbatim}
* setdebug level=10 trace=1 options=ct fd
\end{verbatim}

\smallskip{}

It is now possible to use a \textsl{class} of debug messages called \texttt{tags}
to control the debug output of Bacula daemons.

\begin{itemize}
\item [all] Display all debug messages
\item [bvfs] Display BVFS debug messages
\item [sql] Display SQL related debug messages
\item [memory] Display memory and poolmem allocation messages
\item [scheduler] Display scheduler related debug messages
\end{itemize}

\begin{verbatim}
* setdebug level=10 tags=bvfs,sql,memory
* setdebug level=10 tags=!bvfs

# bacula-dir -t -d 200,bvfs,sql
\end{verbatim}

The \texttt{tags} option is composed of a list of tags. Tags are separated by
``,'' or ``+'' or ``-'' or ``!''. To disable a specific tag, use ``-'' or ``!''
in front of the tag. Note that more tags are planned for future versions.

%%\LTXtable{\linewidth}{table_debugtags}

\subsection{Read Only Storage Devices}
This version of Bacula allows you to define a Storage deamon device
to be read-only. If the {\bf Read Only} directive is specified and
enabled, the drive can only be used for read operations.
The {\bf Read Only} directive can be defined in any bacula-sd.conf
Device resource, and is most useful for reserving one or more
drives for restores. An example is:

\begin{verbatim}
Read Only = yes
\end{verbatim}

\subsection{New Truncate Command}
We have added a new truncate command to bconsole which
will truncate a volume if the volume is purged, and if
the volume is also marked {\bf Action On Purge = Truncate}.
This feature was originally added in Bacula version 5.0.1,
but the mechanism for actually doing the truncate required
the user to enter a complicated command such as:

\begin{verbatim}
purge volume action=truncate storage=File pool=Default
\end{verbatim}

The above command is now simplified to be:

\begin{verbatim}
truncate storage=File pool=Default
\end{verbatim}

\subsection{New Resume Command}
The new \texttt{resume} command does exactly the same thing as a
{\bf restart} command, but for some users the
name may be more logical because in general the
{\bf restart} command is used to resume running
a Job that was incomplete.

\subsection{New Prune ``Expired'' Volume Command}
In Bacula Enterprise 6.4, it is now possible to prune all volumes
(from a pool, or globally) that are ``expired''.  This option can be
scheduled after or before the backup of the catalog and can be
combined with the \texttt{Truncate On Purge} option.  The \texttt{prune expired volme} command may
be used instead of the \texttt{manual\_prune.pl} script.

\begin{verbatim}
* prune expired volume

* prune expired volume pool=FullPool
\end{verbatim}

To schedule this option automatically, it can be added to the Catalog backup job
definition.

\begin{verbatim}
 Job {
   Name = CatalogBackup
   ...
   RunScript {
     Console = "prune expired volume yes"
     RunsWhen = Before
   }
 }
\end{verbatim}


\subsection{New Job Edit Codes \%P \%C}
In various places such as RunScripts, you have now access to \%P to get the
current Bacula process ID (PID) and \%C to know if the current job is a
cloned job.

\subsection{Enhanced Status and Error Messages}
We have enhanced the Storage daemon status output to be more
readable. This is important when there are a large number of
devices. In addition to formatting changes, it also includes more
details on which devices are reading and writing.

A number of error messages have been enhanced to have more specific
data on what went wrong.

If a file changes size while being backed up the old and new size
are reported.

\subsection{Miscellaneous New Features}
\begin{itemize}
\item Allow unlimited line lengths in .conf files (previously limited
to 2000 characters).

\item Allow /dev/null in ChangerCommand to indicated a Virtual Autochanger.

\item Add a --fileprune option to the manual\_prune.pl script.

\item Add a -m option to make\_catalog\_backup.pl to do maintenance
on the catalog.

\item Safer code that cleans up the working directory when starting
the daemons. It limits what files can be deleted, hence enhances 
security.

\item Added a new .ls command in bconsole to permit browsing a client's
filesystem.

\item Fixed a number of bugs, includes some obscure seg faults, and a
race condition that occurred infrequently when running Copy, Migration,
or Virtual Full backups.

\item Upgraded to a newer version of Qt4 for bat. All indications
are that this will improve bat's stability on Windows machines.

\item The Windows installers now detect and refuse to install on
an OS that does not match the 32/64 bit value of the installer.
\end{itemize}

\subsection{FD Storage Address}

When the Director is behind a NAT, in a WAN area, to connect to
% the FileDaemon or
the StorageDaemon, the Director uses an ``external'' ip address,
and the FileDaemon should use an ``internal'' IP address to contact the
StorageDaemon.

The normal way to handle this situation is to use a canonical name such as
``storage-server'' that will be resolved on the Director side as the WAN
address and on the Client side as the LAN address. This is now possible to
configure this parameter using the new directive \texttt{FDStorageAddress} in
the Storage or Client resource.


%%\bsysimageH{BackupOverWan1}{Backup Over WAN}{figbs6:fdstorageaddress}
%  \label{fig:fdstorageaddress}

\begin{verbatim}
Storage {
     Name = storage1
     Address = 65.1.1.1
     FD Storage Address = 10.0.0.1
     SD Port = 9103
     ...
}
\end{verbatim}

% # or in the Client resouce
%

\begin{verbatim}
 Client {
      Name = client1
      Address = 65.1.1.2
      FD Storage Address = 10.0.0.1
      FD Port = 9102
      ...
 }
\end{verbatim}

Note that using the Client \texttt{FDStorageAddress} directive will not allow
to use multiple Storage Daemon, all Backup or Restore requests will be sent to
the specified \texttt{FDStorageAddress}.

\subsection{Maximum Concurrent Read Jobs}
This is a new directive that can be used in the {\bf bacula-dir.conf} file
in the Storage resource.  The main purpose is to limit the number
of concurrent Copy, Migration, and VirtualFull jobs so that
they don't monopolize all the Storage drives causing a deadlock situation
where all the drives are allocated for reading but none remain for
writing.  This deadlock situation can occur when running multiple
simultaneous Copy, Migration, and VirtualFull jobs.

\smallskip
The default value is set to 0 (zero), which means there is no
limit on the number of read jobs.  Note, limiting the read jobs
does not apply to Restore jobs, which are normally started by
hand.  A reasonable value for this directive is one half the number
of drives that the Storage resource has rounded down.  Doing so,
will leave the same number of drives for writing and will generally
avoid over committing drives and a deadlock.

\subsection{Incomplete Jobs}
During a backup, if the Storage daemon experiences disconnection
with the File daemon during backup (normally a comm line problem
or possibly an FD failure), under conditions that the SD determines
to be safe it will make the failed job as Incomplete rather than
failed.  This is done only if there is sufficient valid backup
data that was written to the Volume. The advantage of an Incomplete
job is that it can be restarted by the new bconsole {\bf restart}
command from the point where it left off rather than from the
beginning of the jobs as is the case with a cancel.

\subsection{The Stop Command}
Bacula has been enhanced to provide a {\bf stop} command,
very similar to the {\bf cancel} command with the main difference
that the Job that is stopped is marked as Incomplete so that
it can be restarted later by the {\bf restart} command where
it left off (see below).  The {\bf stop} command with no
arguments, will like the cancel command, prompt you with the
list of running jobs allowing you to select one, which might
look like the following:

\begin{verbatim}
*stop
Select Job:
     1: JobId=3 Job=Incremental.2012-03-26_12.04.26_07
     2: JobId=4 Job=Incremental.2012-03-26_12.04.30_08
     3: JobId=5 Job=Incremental.2012-03-26_12.04.36_09
Choose Job to stop (1-3): 2
2001 Job "Incremental.2012-03-26_12.04.30_08" marked to be stopped.
3000 JobId=4 Job="Incremental.2012-03-26_12.04.30_08" marked to be stopped.
\end{verbatim}

\subsection{The Restart Command}
The new {\bf Restart command} allows console users to restart
a canceled, failed, or incomplete Job.  For canceled and failed
Jobs, the Job will restart from the beginning.  For incomplete
Jobs the Job will restart at the point that it was stopped either
by a stop command or by some recoverable failure.

\smallskip
If you enter the {\bf restart} command in bconsole, you will get the
following prompts:

\begin{verbatim}
*restart
You have the following choices:
     1: Incomplete
     2: Canceled
     3: Failed
     4: All
Select termination code:  (1-4):
\end{verbatim}

If you select the {\bf All} option, you may see something like:

\begin{verbatim}
Select termination code:  (1-4): 4
+-------+-------------+---------------------+------+-------+----------+-----------+-----------+
| jobid | name        | starttime           | type | level | jobfiles |
jobbytes  | jobstatus |
+-------+-------------+---------------------+------+-------+----------+-----------+-----------+
|     1 | Incremental | 2012-03-26 12:15:21 | B    | F     |        0 |
    0 | A         |
|     2 | Incremental | 2012-03-26 12:18:14 | B    | F     |      350 |
4,013,397 | I         |
|     3 | Incremental | 2012-03-26 12:18:30 | B    | F     |        0 |
    0 | A         |
|     4 | Incremental | 2012-03-26 12:18:38 | B    | F     |      331 |
3,548,058 | I         |
+-------+-------------+---------------------+------+-------+----------+-----------+-----------+
Enter the JobId list to select:
\end{verbatim}

Then you may enter one or more JobIds to be restarted, which may
take the form of a list of JobIds separated by commas, and/or JobId
ranges such as {\bf 1-4}, which indicates you want to restart JobIds
1 through 4, inclusive.

\subsection{Job Bandwidth Limitation}

The new {\bf Job Bandwidth Limitation} directive may be added to the File
daemon's and/or Director's configuration to limit the bandwidth used by a
Job on a Client.  It can be set in the File daemon's conf file for all Jobs
run in that File daemon, or it can be set for each Job in the Director's
conf file. The speed is always specified in bytes per second.

For example:
\begin{verbatim}
FileDaemon {
  Name = localhost-fd
  Working Directory = /some/path
  Pid Directory = /some/path
  ...
  Maximum Bandwidth Per Job = 5Mb/s
}
\end{verbatim}

The above example would cause any jobs running with the FileDaemon to not
exceed 5 megabytes per second of throughput when sending data to the
Storage Daemon. Note, the speed is always specified in bytes per second
(not in bits per second), and the case (upper/lower) of the specification
characters is ignored (i.e. 1MB/s = 1Mb/s).

You may specify the following speed parameter modifiers:
   k/s (1,000 bytes per second), kb/s (1,024 bytes per second),
   m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second).

For example:
\begin{verbatim}
Job {
  Name = locahost-data
  FileSet = FS_localhost
  Accurate = yes
  ...
  Maximum Bandwidth = 5Mb/s
  ...
}
\end{verbatim}

The above example would cause Job \texttt{localhost-data} to not exceed 5MB/s
of throughput when sending data from the File daemon to the Storage daemon.

A new console command \texttt{setbandwidth} permits to set dynamically the
maximum throughput of a running Job or for future jobs of a Client.

\begin{verbatim}
* setbandwidth limit=1000 jobid=10
\end{verbatim}

Please note that the value specified for the \texttt{limit} command
line parameter is always in units of 1024 bytes (i.e. the number
is multiplied by 1024 to give the number of bytes per second).  As 
a consequence, the above limit of 1000 will be interpreted as a
limit of 1000 * 1024 = 1,024,000 bytes per second.

\subsection{Always Backup a File}

When the Accurate mode is turned on, you can decide to always backup a file
by using then new {\bf A} Accurate option in your FileSet. For example:

\begin{verbatim}
Job {
   Name = ...
   FileSet = FS_Example
   Accurate = yes
   ...
}

FileSet {
 Name = FS_Example
 Include {
   Options {
     Accurate = A
   }
   File = /file
   File = /file2
 }
 ...
}
\end{verbatim}

This project was funded by Bacula Systems based on an idea of James Harper and
is available with the Bacula Enterprise Edition.

\subsection{Setting Accurate Mode at Runtime}

You are now able to specify the Accurate mode on the \texttt{run} command and
in the Schedule resource.

\begin{verbatim}
* run accurate=yes job=Test
\end{verbatim}

\begin{verbatim}
Schedule {
  Name = WeeklyCycle
  Run = Full 1st sun at 23:05
  Run = Differential accurate=yes 2nd-5th sun at 23:05
  Run = Incremental  accurate=no  mon-sat at 23:05
}
\end{verbatim}

It can allow you to save memory and and CPU resources on the catalog server in
some cases.

\medskip
These advanced tuning options are available with the Bacula Enterprise Edition.

% Common with community
\subsection{Additions to RunScript variables}
You can have access to JobBytes, JobFiles and Director name using \%b, \%F and \%D
in your runscript command. The Client address is now available through \%h.

\begin{verbatim}
RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h Dir=%D"
\end{verbatim}

\subsection{LZO Compression}

LZO compression was added in the Unix File Daemon. From the user point of view,
it works like the GZIP compression (just replace {\bf compression=GZIP} with
{\bf compression=LZO}).

For example:
\begin{verbatim}
Include {
   Options { compression=LZO }
   File = /home
   File = /data
}
\end{verbatim}

LZO provides much faster compression and decompression speed but lower
compression ratio than GZIP. It is a good option when you backup to disk. For
tape, the built-in compression may be a better option.

LZO is a good alternative for GZIP1 when you don't want to slow down your
backup. On a modern CPU it should be able to run almost as fast as:

\begin{itemize}
\item your client can read data from disk. Unless you have very fast disks like
  SSD or large/fast RAID array.
\item the data transfers between the file daemon and the storage daemon even on
  a 1Gb/s link.
\end{itemize}

Note that bacula only use one compression level LZO1X-1.

\medskip
The code for this feature was contributed by Laurent Papier.

\subsection{Purge Migration Job}

The new {\bf Purge Migration Job} directive may be added to the Migration
Job definition in the Director's configuration file. When it is enabled
the Job that was migrated during a migration will be purged at
the end of the migration job.

For example:
\begin{verbatim}
Job {
  Name = "migrate-job"
  Type = Migrate
  Level = Full
  Client = localhost-fd
  FileSet = "Full Set"
  Messages = Standard
  Storage = DiskChanger
  Pool = Default
  Selection Type = Job
  Selection Pattern = ".*Save"
...
  Purge Migration Job = yes
}
\end{verbatim}

\medskip

This project was submitted by Dunlap Blake; testing and documentation was funded
by Bacula Systems.

\subsection{Changes in the Pruning Algorithm}

We rewrote the job pruning algorithm in this version.  Previously, in some
users reported that the pruning process at the end of jobs was very long.
It should not be longer the case.  Now, Bacula won't prune automatically a
Job if this particular Job is needed to restore data.  Example:

\begin{verbatim}
JobId: 1  Level: Full
JobId: 2  Level: Incremental
JobId: 3  Level: Incremental
JobId: 4  Level: Differential
.. Other incrementals up to now
\end{verbatim}

In this example, if the Job Retention defined in the Pool or in the Client
resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
detect that JobId 1 and 4 are essential to restore data at the current state
and will prune only JobId 2 and 3.

\texttt{Important}, this change affect only the automatic pruning step
after a Job and the \texttt{prune jobs} Bconsole command.  If a volume
expires after the \texttt{VolumeRetention} period, important jobs can be
pruned.

\subsection{Ability to Verify any specified Job}
You now have the ability to tell Bacula which Job should verify instead of
automatically verify just the last one.

This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.

To verify a given job, just specify the Job jobid in argument when starting the
job.
\begin{verbatim}
*run job=VerifyVolume jobid=1 level=VolumeToCatalog
Run Verify job
JobName:     VerifyVolume
Level:       VolumeToCatalog
Client:      127.0.0.1-fd
FileSet:     Full Set
Pool:        Default (From Job resource)
Storage:     File (From Job resource)
Verify Job:  VerifyVol.2010-09-08_14.17.17_03
Verify List: /tmp/regress/working/VerifyVol.bsr
When:        2010-09-08 14:17:31
Priority:    10
OK to run? (yes/mod/no):
\end{verbatim}



\chapter{New Features in 7.0.0}
This chapter presents the new features that have been added to
the various versions of Bacula.

\section{New Features in 7.0.0}

\subsection{Storage daemon to Storage daemon}
Bacula version 7.0 permits SD to SD transfer of Copy and Migration
Jobs. This permits what is commonly referred to as replication or
off-site transfer of Bacula backups.  It occurs automatically, if
the source SD and destination SD of a Copy or Migration job are
different. The following picture shows how this works.

\includegraphics[width=0.8\linewidth]{sd-to-sd}

\subsection{SD Calls Client}
If the {\bf SD Calls Client} directive is set to true in a Client resource
any Backup, Restore, Verify, Copy, or Migration Job where the client
is involved, the client will wait for the Storage daemon to contact it.
By default this directive is set to false, and the Client will call
the Storage daemon.  This directive can be useful if your Storage daemon
is behind a firewall that permits outgoing connections but not incoming
one. The following picture shows the communications connection paths in
both cases.

\includegraphics[width=0.8\linewidth]{sd-calls-client}

\subsection{Next Pool}
In previous versions of Bacula the Next Pool directive could be
specified in the Pool resource for use with Migration and Copy Jobs.
The Next Pool concept has been 
extended in Bacula version 7.0.0 to allow you to specify the 
Next Pool directive in the Job resource as well. If specified in
the Job resource, it will override any value specified in the Pool
resource.

In addition to being permitted in the Job resource, the 
{\bf nextpool=xxx} specification can be specified as a run
override in the {\bf run} directive of a Schedule resource.
Any {\bf nextpool} specification in a {\bf run}
directive will override any other specification in either
the Job or the Pool. 

In general, more information is displayed in the Job log
on exactly which Next Pool specification is ultimately used.

\subsection{status storage}
The bconsole {\bf status storage} has been modified to attempt to eliminate
duplicate storage resources and only show one that references any given
storage daemon.  This might be confusing at first, but tends to make a
much more compact list of storage resource from which to select if there
are multiple storage devices in the same storage daemon.

If you want the old behavior (always display all storage resources) simply 
add the keyword {\bf select} to the command -- i.e. use
{\bf status select storage}.





\subsection{status schedule}
A new status command option called {\bf scheduled} has been implemented
in bconsole. By default it will display 20 lines of the next scheduled
jobs.  For example, with the default bacula-dir.conf configuration file,
a bconsole command {\bf status scheduled} produces:

\begin{verbatim}
Scheduled Jobs:
Level        Type   Pri  Scheduled        Job Name     Schedule
======================================================================
Differential Backup 10  Sun 30-Mar 23:05 BackupClient1 WeeklyCycle
Incremental  Backup 10  Mon 24-Mar 23:05 BackupClient1 WeeklyCycle
Incremental  Backup 10  Tue 25-Mar 23:05 BackupClient1 WeeklyCycle
...
Full         Backup 11  Mon 24-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
Full         Backup 11  Wed 26-Mar 23:10 BackupCatalog WeeklyCycleAfterBackup
...
====
\end{verbatim}

Note, the output is listed by the Jobs found, and is not sorted
chronologically.

\smallskip
This command has a number of options, most of which act as filters:
\begin{itemize}
\item {\bf days=nn} This specifies the number of days to list. The default is
  10 but can be set from 0 to 500.
\item {\bf limit=nn} This specifies the limit to the number of lines to print.
  The default is 100 but can be any number in the range 0 to 2000.
\item {\bf time="YYYY-MM-DD HH:MM:SS"} Sets the start time for listing the
  scheduled jobs. The default is to use the current time. Note, the
  time value must be specified inside double quotes and must be in
  the exact form shown above.
\item {\bf schedule=schedule-name} This option restricts the output to
  the named schedule.
\item {\bf job=job-name} This option restricts the output to the specified
  Job name.
\end{itemize}

\subsection{Data Encryption Cipher Configuration}
Bacula version 7.0 and later now allows to configure the data
encryption cipher and the digest algorithm. The cipher was forced to AES
128, and it is now possible to choose between the following ciphers:

\begin{itemize}
\item AES128 (default)
\item AES192
\item AES256
\item blowfish
\end{itemize}

The digest algorithm was set to SHA1 or SHA256 depending on the local
OpenSSL
options. We advise you to not modify the PkiDigest default setting. Please,
refer to OpenSSL documentation to know about pro and cons on these options.

\begin{verbatim}
  FileDaemon {
    ...
    PkiCipher = AES256
  }
\end{verbatim}

\subsection{New Truncate Command}
We have added a new truncate command to bconsole, which
will truncate a Volume if the Volume is purged and if
the Volume is also marked {\bf Action On Purge = Truncate}.
This feature was originally added in Bacula version 5.0.1,
but the mechanism for actually doing the truncate required
the user to enter a command such as:

\begin{verbatim}
purge volume action=truncate storage=File pool=Default
\end{verbatim}

The above command is now simplified to be:

\begin{verbatim}
truncate storage=File pool=Default
\end{verbatim}

\subsection{Migration/Copy/VirtualFull Performance Enhancements}
The Bacula Storage daemon now permits multiple jobs to simultaneously read
the same disk Volume, which gives substantial performance enhancements when
running Migration, Copy, or VirtualFull jobs that read disk Volumes.  Our
testing shows that when running multiple simultaneous jobs, the jobs can
finish up to ten times faster with this version of Bacula.  This is
built-in to the Storage daemon, so it happens automatically and
transparently.

\subsection{VirtualFull Backup Consolidation Enhancements}
By default Bacula selects jobs automatically for a VirtualFull,
however, you may want to create the Virtual backup based on a
particular backup (point in time) that exists.

For example, if you have the following backup Jobs in your catalog:
\begin{verbatim}
+-------+---------+-------+----------+----------+-----------+
| JobId | Name    | Level | JobFiles | JobBytes | JobStatus |
+-------+---------+-------+----------+----------+-----------+
| 1     | Vbackup | F     | 1754     | 50118554 | T         |
| 2     | Vbackup | I     | 1        | 4        | T         |
| 3     | Vbackup | I     | 1        | 4        | T         |
| 4     | Vbackup | D     | 2        | 8        | T         |
| 5     | Vbackup | I     | 1        | 6        | T         |
| 6     | Vbackup | I     | 10       | 60       | T         |
| 7     | Vbackup | I     | 11       | 65       | T         |
| 8     | Save    | F     | 1758     | 50118564 | T         |
+-------+---------+-------+----------+----------+-----------+
\end{verbatim}

and you want to consolidate only the first 3 jobs and create a
virtual backup equivalent to Job 1 + Job 2 + Job 3, you will use
\texttt{jobid=3} in the \texttt{run} command, then Bacula will select the
previous Full backup, the previous Differential (if any) and all subsequent
Incremental jobs.

\begin{verbatim}
run job=Vbackup jobid=3 level=VirtualFull
\end{verbatim}

If you want to consolidate a specific job list, you must specify the exact
list of jobs to merge in the run command line.  For example, to consolidate
the last Differential and all subsequent Incremental, you will use
\texttt{jobid=4,5,6,7} or \texttt{jobid=4-7} on the run command line. As one
of the Job in the list is a Differential backup, Bacula will set the new job
level to Differential. If the list is composed only with Incremental jobs,
the new job will have a level set to Incremental.

\begin{verbatim}
run job=Vbackup jobid=4-7 level=VirtualFull
\end{verbatim}

When using this feature, Bacula will automatically discard jobs that are
not related to the current Job.  For example, specifying
\texttt{jobid=7,8}, Bacula will discard JobId 8 because it is not
part of the same backup Job.

We do not recommend it, but really want to consolidate jobs that have
different names (so probably different clients, filesets, etc...), you must
use \texttt{alljobid=} keyword instead of \texttt{jobid=}.

\begin{verbatim}
run job=Vbackup alljobid=1-3,6-8 level=VirtualFull
\end{verbatim}


\subsection{FD Storage Address}

When the Director is behind a NAT, in a WAN area, to connect to
% the FileDaemon or
the StorageDaemon, the Director uses an ``external'' ip address,
and the FileDaemon should use an ``internal'' IP address to contact the
StorageDaemon.

The normal way to handle this situation is to use a canonical name such as
``storage-server'' that will be resolved on the Director side as the WAN
address and on the Client side as the LAN address. This is now possible to
configure this parameter using the new directive \texttt{FDStorageAddress} in
the Storage or Client resource.


\includegraphics[width=0.8\linewidth]{BackupOverWan1}
\label{fig:fdstorageaddress}

\begin{verbatim}
Storage {
     Name = storage1
     Address = 65.1.1.1
     FD Storage Address = 10.0.0.1
     SD Port = 9103
     ...
}
\end{verbatim}

% # or in the Client resouce
%

\begin{verbatim}
 Client {
      Name = client1
      Address = 65.1.1.2
      FD Storage Address = 10.0.0.1
      FD Port = 9102
      ...
 }
\end{verbatim}

Note that using the Client \texttt{FDStorageAddress} directive will not allow
to use multiple Storage Daemon, all Backup or Restore requests will be sent to
the specified \texttt{FDStorageAddress}.

\subsection{Job Bandwidth Limitation}

The new {\bf Job Bandwidth Limitation} directive may be added to the File
daemon's and/or Director's configuration to limit the bandwidth used by a
Job on a Client.  It can be set in the File daemon's conf file for all Jobs
run in that File daemon, or it can be set for each Job in the Director's
conf file. The speed is always specified in bytes per second.

For example:
\begin{verbatim}
FileDaemon {
  Name = localhost-fd
  Working Directory = /some/path
  Pid Directory = /some/path
  ...
  Maximum Bandwidth Per Job = 5Mb/s
}
\end{verbatim}

The above example would cause any jobs running with the FileDaemon to not
exceed 5 megabytes per second of throughput when sending data to the
Storage Daemon. Note, the speed is always specified in bytes per second
(not in bits per second), and the case (upper/lower) of the specification
characters is ignored (i.e. 1MB/s = 1Mb/s).

You may specify the following speed parameter modifiers:
   k/s (1,000 bytes per second), kb/s (1,024 bytes per second),
   m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second).

For example:
\begin{verbatim}
Job {
  Name = locahost-data
  FileSet = FS_localhost
  Accurate = yes
  ...
  Maximum Bandwidth = 5Mb/s
  ...
}
\end{verbatim}

The above example would cause Job \texttt{localhost-data} to not exceed 5MB/s
of throughput when sending data from the File daemon to the Storage daemon.

A new console command \texttt{setbandwidth} permits to set dynamically the
maximum throughput of a running Job or for future jobs of a Client.

\begin{verbatim}
* setbandwidth limit=1000 jobid=10
\end{verbatim}

Please note that the value specified for the \texttt{limit} command
line parameter is always in units of 1024 bytes (i.e. the number
is multiplied by 1024 to give the number of bytes per second).  As 
a consequence, the above limit of 1000 will be interpreted as a
limit of 1000 * 1024 = 1,024,000 bytes per second.

\medskip
This project was funded by Bacula Systems.


\subsection{Maximum Concurrent Read Jobs}
This is a new directive that can be used in the {\bf bacula-dir.conf} file
in the Storage resource.  The main purpose is to limit the number
of concurrent Copy, Migration, and VirtualFull jobs so that
they don't monopolize all the Storage drives causing a deadlock situation
where all the drives are allocated for reading but none remain for
writing.  This deadlock situation can occur when running multiple
simultaneous Copy, Migration, and VirtualFull jobs.

\smallskip
The default value is set to 0 (zero), which means there is no
limit on the number of read jobs.  Note, limiting the read jobs
does not apply to Restore jobs, which are normally started by
hand.  A reasonable value for this directive is one half the number
of drives that the Storage resource has rounded down.  Doing so,
will leave the same number of drives for writing and will generally
avoid over committing drives and a deadlock.


\subsection{Director job Codes in Message Resource Commands}
Before submitting the specified mail command to the operating system, Bacula
performs character substitution like in Runscript commands. Bacula will now
perform also specific Director character substitution.

\smallskip{}
The code for this feature was contributed by Bastian Friedrich.

\subsection{Additions to RunScript variables}
The following variables are now available in runscripts:
\begin{itemize}
\item current PID using \%P
\item if the job is a clone job using \%C
\end{itemize}

\begin{verbatim}
RunAfterJob = "/bin/echo Pid=%P isCloned=%C" 

\end{verbatim}

\subsection{Read Only Storage Devices}
This version of Bacula permits defining a Storage daemon device
to be read-only. That is if the {\bf ReadOnly} directive is specified and
enabled, the drive can only be used for read operations.
The the {\bf ReadOnly} directive can be defined in any bacula-sd.conf
Device resource, and is most useful to reserve one or more 
drives for restores. An example is:

\begin{verbatim}
Read Only = yes
\end{verbatim}

\subsection{New Prune ``Expired'' Volume Command}
It is now possible to prune all volumes
(from a pool, or globally) that are ``expired''.  This option can be
scheduled after or before the backup of the Catalog and can be
combined with the Truncate On Purge option.  The Expired Prune option can
be used instead of the \texttt{manual\_prune.pl} script.

\begin{verbatim}
* prune expired volumes

* prune expired volumes pool=FullPool
\end{verbatim}

To schedule this option automatically, it can be added to the BackupCatalog job
definition.

\begin{verbatim}
 Job {
   Name = CatalogBackup
   ...
   RunScript {
     Console = "prune expired volume yes"
     RunsWhen = Before
   }
 }
\end{verbatim}

\subsection{Hardlink Performance Enhancements}
If you use a program such as Cyrus IMAP that creates very large numbers
of hardlinks, the time to build the interactive restore tree can be
excessively long. This version of Bacula has a new feature that
automatically keeps the hardlinks associated with the restore tree
in memory, which consumes a bit more memory but vastly speeds up 
building the tree.  If the memory usage is too big for your system, you
can reduce the amount of memory used during the restore command by
adding the option {\bf optimizespeed=false} on the bconsole run
command line.

This feature was developed by Josip Almasi, and enhanced to be runtime
dynamic by Kern Sibbald.

\subsection{DisableCommand Directive}
There is a new Directive named {\bf Disable Command} that
can be put in the File daemon Client or Director resource.
If it is in the Client, it applies globally, otherwise the
directive applies only to the Director in which it is found.
The Disable Command adds security to your File daemon by
disabling certain commands.  The commands that can be
disabled are:

\begin{verbatim}
backup       
cancel       
setdebug=    
setbandwidth=
estimate     
fileset      
JobId=       
level =      
restore      
endrestore   
session      
status       
.status      
storage      
verify       
RunBeforeNow 
RunBeforeJob 
RunAfterJob  
Run          
accurate
\end{verbatim}

On or more of these command keywords can be placed in quotes and separated
by spaces on the Disable Command directive line.  Note: the commands must
be written exactly as they appear above.

\subsection{Multiple Console Directors}
Support for multiple bconsole and bat Directors in the bconsole.conf and
bat.conf files has been implemented and/or improved.

\subsection{Restricted Consoles}
Better support for Restricted consoles has been implement for bconsole and
bat.

\subsection{Configuration Files}
In previous versions of Bacula the configuration files for each component
were limited to a maximum of 499 bytes per configuration file line. This
version of Bacula permits unlimited input line lengths.  This can be
especially useful for specifying more complicated Migration/Copy SQL
statements and in creating long restricted console ACL lists.

\subsection{Maximum Spawned Jobs}
The Job resource now permits specifying a number of {\bf Maximum Spawn
Jobs}. The default is 300.  This directive can be useful if you have
big hardware and you do a lot of Migration/Copy jobs which start
at the same time.  In prior versions of Bacula, Migration/Copy
was limited to spawning a maximum of 100 jobs at a time.

\subsection{Progress Meter}
The new File daemon has been enhanced to send its progress (files
processed and bytes written) to the Director every 30 seconds. These
figures can then be displayed with a bconsole {\bf status dir} 
command.

\subsection{Scheduling a 6th Week}
Prior version of Bacula permits specifying 1st through 5th week of 
a month (first through fifth) as a keyword on the {\bf run}
directive of a Schedule resource.  This version of Bacula also permits
specifying the 6th week of a month with the keyword {\bf sixth} or
{\bf 6th}.

\subsection{Scheduling the Last Day of a Month}
This version of Bacula now permits specifying the {\bf lastday}
keyword in the {\bf run} directive of a Schedule resource.
If {\bf lastday} is specified, it will apply only to those months
specified on the {\bf run} directive.  Note: by default all months
are specified.

\subsection{Improvements to Cancel and Restart bconsole Commands}
The Restart bconsole command now allow selection of either
canceled or failed jobs to be restarted.  In addition both the
{\bf cancel} and {\bf restart} bconsole commands permit entering
a number of JobIds separated by commas or a range of JobIds indicated
by a dash between the begin and end range (e.g. 3-10).  Finally the
two commands also allow one to enter the special keyword {\bf all}
to select all the appropriate Jobs.

\subsection{bconsole Performance Improvements}
In previous versions of Bacula certain bconsole commands could wait a long
time due to catalog lock contention.  This was especially noticeable 
when a large number of jobs were running and putting their attributes
into the catalog.  This version uses a separate catalog connection that
should significantly enhance performance.

\subsection{New .bvfs\_decode\_lstat Command}
There is a new bconsole command, which is
{\bf .bvfs\_decode\_lstat} it requires one argument, which
is {\bf lstat="lstat value to decode"}.  An example command
in bconsole and the output might be:

\small
\begin{verbatim}
.bvfs_decode_lstat lstat="A A EHt B A A A JP BAA B BTL/A7 BTL/A7 BTL/A7 A A C"

st_nlink=1
st_mode=16877
st_uid=0
st_gid=0
st_size=591
st_blocks=1
st_ino=0
st_ctime=1395650619
st_mtime=1395650619
st_mtime=1395650619
st_dev=0
LinkFI=0
\end{verbatim}
\normalsize


\subsection*{New Debug Options}

In Bacula Enterprise version 8.0 and later, we introduced new options to
the \texttt{setdebug} command.

\smallskip{}

If the \texttt{options} parameter is set, the following arguments can be
used to control debug functions.

\begin{itemize}
\item [0] clear debug flags
\item [i] Turn off, ignore bwrite() errors on restore on File Daemon
\item [d] Turn off decomp of BackupRead() streams on File Daemon
\item [t] Turn on timestamp in traces
\item [T] Turn off timestamp in traces
\item [c] Truncate trace file if trace file is activated
\item [l] Turn on recoding events on P() and V()
\item [p] Turn on the display of the event ring when doing a bactrace
\end{itemize}

\smallskip{}

The following command will truncate the trace file and will turn on timestamps
in the trace file.

\begin{verbatim}
* setdebug level=10 trace=1 options=ct fd
\end{verbatim}

\smallskip{}

It is now possible to use \textsl{class} of debug messages called \texttt{tags}
to control the debug output of Bacula daemons.

\begin{itemize}
\item [all] Display all debug messages
\item [bvfs] Display BVFS debug messages
\item [sql] Display SQL related debug messages
\item [memory] Display memory and poolmem allocation messages
\item [scheduler] Display scheduler related debug messages
\end{itemize}

\begin{verbatim}
* setdebug level=10 tags=bvfs,sql,memory
* setdebug level=10 tags=!bvfs

# bacula-dir -t -d 200,bvfs,sql
\end{verbatim}

The \texttt{tags} option is composed of a list of tags, tags are separated by
``,'' or ``+'' or ``-'' or ``!''. To disable a specific tag, use ``-'' or ``!''
in front of the tag. Note that more tags will come in future versions.

%\LTXtable{\linewidth}{table_debugtags}


\chapter{New Features in 5.2.13}
This chapter presents the new features that have been added to the current
Community version of Bacula that is now released.

\subsection{Additions to RunScript variables}
You can have access to Director name using \%D in your runscript
command.

\begin{verbatim}
RunAfterJob = "/bin/echo Director=%D 
\end{verbatim}

\section{New Features in 5.2.1}
This chapter presents the new features were added in the
Community release version 5.2.1.

There are additional features (plugins) available in the Enterprise version
that are described in another chapter. A subscription to Bacula Systems
is required for the Enterprise version.

\subsection{LZO Compression}

LZO compression has been to the File daemon. From the user's point of view,
it works like the GZIP compression (just replace {\bf compression=GZIP} with
{\bf compression=LZO}).

For example:
\begin{verbatim}
Include {
   Options {compression=LZO }
   File = /home
   File = /data
}
\end{verbatim}

LZO provides a much faster compression and decompression speed but lower
compression ratio than GZIP. It is a good option when you backup to disk. For
tape, the hardware compression is almost always a better option.

LZO is a good alternative for GZIP1 when you don't want to slow down your
backup. With a modern CPU it should be able to run almost as fast as:

\begin{itemize}
\item your client can read data from disk. Unless you have very fast disks like
  SSD or large/fast RAID array.
\item the data transfers between the file daemon and the storage daemon even on
  a 1Gb/s link.
\end{itemize}

Note, Bacula uses compression level LZO1X-1.

\medskip
The code for this feature was contributed by Laurent Papier.

\subsection{New Tray Monitor}

Since the old integrated Windows tray monitor doesn't work with
recent Windows versions, we have written a new Qt Tray Monitor that is available
for both Linux and Windows.  In addition to all the previous features,
this new version allows you to run Backups from 
the tray monitor menu.

\begin{figure}[htbp]
  \centering
  \includegraphics[width=0.8\linewidth]{tray-monitor}
  \label{fig:traymonitor}
  \caption{New tray monitor}
\end{figure}

\begin{figure}[htbp]
  \centering
  \includegraphics[width=0.8\linewidth]{tray-monitor1}
  \label{fig:traymonitor1}
  \caption{Run a Job through the new tray monitor}
\end{figure}


To be able to run a job from the tray monitor, you need to
allow specific commands in the Director monitor console:
\begin{verbatim}
Console {
    Name = win2003-mon
    Password = "xxx"
    CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
    ClientACL = *all*               # you can restrict to a specific host
    CatalogACL = *all*
    JobACL = *all*
    StorageACL = *all*
    ScheduleACL = *all*
    PoolACL = *all*
    FileSetACL = *all*
    WhereACL = *all*
}
\end{verbatim}

\medskip
This project was funded by Bacula Systems and is available with Bacula
the Enterprise Edition and the Community Edition.

\subsection{Purge Migration Job}

The new {\bf Purge Migration Job} directive may be added to the Migration
Job definition in the Director's configuration file. When it is enabled 
the Job that was migrated during a migration will be purged at
the end of the migration job.

For example:
\begin{verbatim}
Job {
  Name = "migrate-job"
  Type = Migrate
  Level = Full
  Client = localhost-fd
  FileSet = "Full Set"
  Messages = Standard
  Storage = DiskChanger
  Pool = Default
  Selection Type = Job
  Selection Pattern = ".*Save"
...
  Purge Migration Job = yes
}
\end{verbatim}

\medskip

This project was submitted by Dunlap Blake; testing and documentation was funded
by Bacula Systems.

\subsection{Changes in Bvfs (Bacula Virtual FileSystem)}

Bat has now a bRestore panel that uses Bvfs to display files and
directories.

\begin{figure}[htbp]
  \centering
  \includegraphics[width=0.8\linewidth]{bat-brestore}
  \label{fig:batbrestore}
  \caption{Bat Brestore Panel}
\end{figure}

the Bvfs module works correctly with BaseJobs, Copy and Migration jobs.

\medskip
This project was funded by Bacula Systems.

\subsubsection*{General notes}

\begin{itemize}
\item All fields are separated by a tab
\item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
  records in very big directories
\item All operations (except cache creation) are designed to run instantly
\item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
  can contribute new faster SQL queries we will be happy, else don't complain
  about speed.
\item The cache creation is dependent of the number of directories. As Bvfs
  shares information across jobs, the first creation can be slow
\item All fields are separated by a tab
\item Due to potential encoding problem, it's advised to always use pathid in
  queries.
\end{itemize}

\subsubsection*{Get dependent jobs from a given JobId}

Bvfs allows you to query the catalog against any combination of jobs. You
can combine all Jobs and all FileSet for a Client in a single session.

To get all JobId needed to restore a particular job, you can use the
\texttt{.bvfs\_get\_jobids} command.

\begin{verbatim}
.bvfs_get_jobids jobid=num [all]
\end{verbatim}

\begin{verbatim}
.bvfs_get_jobids jobid=10
1,2,5,10
.bvfs_get_jobids jobid=10 all
1,2,3,5,10
\end{verbatim}

In this example, a normal restore will need to use JobIds 1,2,5,10 to
compute a complete restore of the system.

With the \texttt{all} option, the Director will use all defined FileSet for
this client.

\subsubsection*{Generating Bvfs cache}

The \texttt{.bvfs\_update} command computes the directory cache for jobs
specified in argument, or for all jobs if unspecified.

\begin{verbatim}
.bvfs_update [jobid=numlist]
\end{verbatim}

Example:
\begin{verbatim}
.bvfs_update jobid=1,2,3
\end{verbatim}

You can run the cache update process in a RunScript after the catalog backup.

\subsubsection*{Get all versions of a specific file}

Bvfs allows you to find all versions of a specific file for a given Client with
the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
function uses only PathId and FilenameId. The jobid argument is mandatory but
unused.

\begin{verbatim}
.bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
...
\end{verbatim}

Example:

\begin{verbatim}
.bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
1  47  52  12  gD HRid IGk D Po Po A P BAA I A   /uPgWaxMgKZlnMti7LChyA  Vol1  1
\end{verbatim}

\subsubsection*{List directories}

Bvfs allows you to list directories in a specific path.
\begin{verbatim}
.bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
PathId  FilenameId  FileId  JobId  LStat  Path
PathId  FilenameId  FileId  JobId  LStat  Path
PathId  FilenameId  FileId  JobId  LStat  Path
...
\end{verbatim}

You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
``/'' on Unix and all drives on Windows.  If FilenameId is 0, the record
listed is a directory.

\begin{verbatim}
.bvfs_lsdirs pathid=4 jobid=1,11,12
4       0       0       0       A A A A A A A A A A A A A A     .
5       0       0       0       A A A A A A A A A A A A A A     ..
3       0       0       0       A A A A A A A A A A A A A A     regress/
\end{verbatim}

In this example, to list directories present in \texttt{regress/}, you can use
\begin{verbatim}
.bvfs_lsdirs pathid=3 jobid=1,11,12
3       0       0       0       A A A A A A A A A A A A A A     .
4       0       0       0       A A A A A A A A A A A A A A     ..
2       0       0       0       A A A A A A A A A A A A A A     tmp/
\end{verbatim}

\subsubsection*{List files}

Bvfs allows you to list files in a specific path.
\begin{verbatim}
.bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
PathId  FilenameId  FileId  JobId  LStat  Path
PathId  FilenameId  FileId  JobId  LStat  Path
PathId  FilenameId  FileId  JobId  LStat  Path
...
\end{verbatim}

You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
is a directory.

\begin{verbatim}
.bvfs_lsfiles pathid=4 jobid=1,11,12
4       0       0       0       A A A A A A A A A A A A A A     .
5       0       0       0       A A A A A A A A A A A A A A     ..
1       0       0       0       A A A A A A A A A A A A A A     regress/
\end{verbatim}

In this example, to list files present in \texttt{regress/}, you can use
\begin{verbatim}
.bvfs_lsfiles pathid=1 jobid=1,11,12
1   47   52   12    gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A     titi
1   49   53   12    gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B     toto
1   48   54   12    gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A     tutu
1   45   55   12    gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B     ficheriro1.txt
1   46   56   12    gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D     ficheriro2.txt
\end{verbatim}

\subsubsection*{Restore set of files}

Bvfs allows you to create a SQL table that contains files that you want to
restore. This table can be provided to a restore command with the file option.

\begin{verbatim}
.bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
OK
restore file=?b2num ...
\end{verbatim}

To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
select all files. This query could be time consuming.

\texttt{hardlink} list is always composed of a series of two numbers (jobid,
fileindex). This information can be found in the LinkFI field of the LStat
packet.

The \texttt{path} argument represents the name of the table that Bvfs will
store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
b2 and followed by digits).

Example:

\begin{verbatim}
.bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
OK
\end{verbatim}

\subsubsection*{Cleanup after Restore}

To drop the table used by the restore command, you can use the
\texttt{.bvfs\_cleanup} command.

\begin{verbatim}
.bvfs_cleanup path=b20001
\end{verbatim}

\subsubsection*{Clearing the BVFS Cache}

To clear the BVFS cache, you can use the \texttt{.bvfs\_clear\_cache} command.

\begin{verbatim}
.bvfs_clear_cache yes
OK
\end{verbatim}

\subsection{Changes in the Pruning Algorithm}

We rewrote the job pruning algorithm in this version. Previously, in some users
reported that the pruning process at the end of jobs was very long. It should
not be longer the case. Now, Bacula won't prune automatically a Job if this
particular Job is needed to restore data. Example:

\begin{verbatim}
JobId: 1  Level: Full
JobId: 2  Level: Incremental
JobId: 3  Level: Incremental
JobId: 4  Level: Differential
.. Other incrementals up to now
\end{verbatim}

In this example, if the Job Retention defined in the Pool or in the Client
resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
detect that JobId 1 and 4 are essential to restore data at the current state
and will prune only JobId 2 and 3.

\texttt{Important}, this change affect only the automatic pruning step after a
Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
\texttt{VolumeRetention} period, important jobs can be pruned.

\subsection{Ability to Verify any specified Job}
You now have the ability to tell Bacula which Job should verify instead of
automatically verify just the last one.

This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.

To verify a given job, just specify the Job jobid in argument when starting the
job.
\begin{verbatim}
*run job=VerifyVolume jobid=1 level=VolumeToCatalog
Run Verify job
JobName:     VerifyVolume
Level:       VolumeToCatalog
Client:      127.0.0.1-fd
FileSet:     Full Set
Pool:        Default (From Job resource)
Storage:     File (From Job resource)
Verify Job:  VerifyVol.2010-09-08_14.17.17_03
Verify List: /tmp/regress/working/VerifyVol.bsr
When:        2010-09-08 14:17:31
Priority:    10
OK to run? (yes/mod/no):
\end{verbatim}

\medskip
This project was funded by Bacula Systems and is available with Bacula
Enterprise Edition and Community Edition.

\subsection{Additions to RunScript variables}
You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
command. The Client address is now available through \%h.

\begin{verbatim}
RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
\end{verbatim}

%\subsection{Changes in drivetype.exe}
%
%Now the \texttt{drivetype.exe} program allows you to list all local hard
%drives. It can help to build dynamic FileSet on Windows.
%
%\begin{verbatim}
%File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
%\end{verbatim}
%

\subsection{Additions to the Plugin API}
The bfuncs structure has been extended to include a number of
new entrypoints.

\subsubsection{bfuncs}
The bFuncs structure defines the callback entry points within Bacula
that the plugin can use register events, get Bacula values, set
Bacula values, and send messages to the Job output or debug output.

The exact definition as of this writing is:
\begin{verbatim}
typedef struct s_baculaFuncs {
   uint32_t size;
   uint32_t version;
   bRC (*registerBaculaEvents)(bpContext *ctx, ...);
   bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
   bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
   bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
       int type, utime_t mtime, const char *fmt, ...);
   bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
       int level, const char *fmt, ...);
   void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
       size_t size);
   void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
   
   /* New functions follow */
   bRC (*AddExclude)(bpContext *ctx, const char *file);
   bRC (*AddInclude)(bpContext *ctx, const char *file);
   bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
   bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
   bRC (*AddWild)(bpContext *ctx, const char *item, int type);
   bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);

} bFuncs;
\end{verbatim}

\begin{description}
\item [AddExclude] can be called to exclude a file. The file
  string passed may include wildcards that will be interpreted by
  the {\bf fnmatch} subroutine. This function can be called 
  multiple times, and each time the file specified will be added
  to the list of files to be excluded. Note, this function only
  permits adding excludes of specific file or directory names,
  or files matched by the rather simple fnmatch mechanism.
  See below for information on doing wild-card and regex excludes.

\item [NewPreInclude] can be called to create a new Include block. This
  block will be added after the current defined Include block. This
  function can be called multiple times, but each time, it will create
  a new Include section (not normally needed). This function should
  be called only if you want to add an entirely new Include block.

\item [NewInclude] can be called to create a new Include block. This
  block will be added before any user defined Include blocks. This
  function can be called multiple times, but each time, it will create
  a new Include section (not normally needed). This function should
  be called only if you want to add an entirely new Include block.

\item [AddInclude] can be called to add new files/directories to
  be included.  They are added to the current Include block. If
  NewInclude has not been included, the current Include block is
  the last one that the user created. This function
  should be used only if you want to add totally new files/directories
  to be included in the backup. 

\item [NewOptions] adds a new Options block to the current Include
  in front of any other Options blocks. This permits the plugin to
  add exclude directives (wild-cards and regexes) in front of the
  user Options, and thus prevent certain files from being backed up.
  This can be useful if the plugin backs up files, and they should
  not be also backed up by the main Bacula code.  This function
  may be called multiple times, and each time, it creates a new
  prepended Options block. Note: normally you want to call this 
  entry point prior to calling AddOptions, AddRegex, or AddWild.
  
\item [AddOptions] allows the plugin it set options in
  the current Options block, which is normally created with the
  NewOptions call just prior to adding Include Options.
  The permitted options are passed as a character string, where
  each character has a specific meaning as defined below:

  \begin{description}
  \item [a] always replace files (default).
  \item [e] exclude rather than include.
  \item [h] no recursion into subdirectories.
  \item [H] do not handle hard links.
  \item [i] ignore case in wildcard and regex matches.
  \item [M] compute an MD5 sum.
  \item [p] use a portable data format on Windows (not recommended).
  \item [R] backup resource forks and Findr Info.
  \item [r] read from a fifo
  \item [S1] compute an SHA1 sum.
  \item [S2] compute an SHA256 sum.
  \item [S3] comput an SHA512 sum.
  \item [s] handle sparse files.
  \item [m] use st\_mtime only for file differences.
  \item [k] restore the st\_atime after accessing a file.
  \item [A] enable ACL backup.
  \item [Vxxx:] specify verify options. Must terminate with :
  \item [Cxxx:] specify accurate options. Must terminate with :
  \item [Jxxx:] specify base job Options. Must terminate with :
  \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
  \item [w] if newer
  \item [Zn] specify gzip compression level n.
  \item [K] do not use st\_atime in backup decision.
  \item [c] check if file changed during backup.
  \item [N] honor no dump flag.
  \item [X] enable backup of extended attributes.
  \end{description}

\item [AddRegex] adds a regex expression to the current Options block.
  The following options are permitted:
  \begin{description}
  \item [ ] (a blank) regex applies to whole path and filename.
  \item [F] regex applies only to the filename (directory or path stripped).
  \item [D] regex applies only to the directory (path) part of the name.
  \end{description}

\item [AddWild] adds a wildcard expression to the current Options block.
  The following options are permitted:
  \begin{description}
  \item [ ] (a blank) regex applies to whole path and filename.
  \item [F] regex applies only to the filename (directory or path stripped).
  \item [D] regex applies only to the directory (path) part of the name.
  \end{description}

\item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
  that can use Accurate code to compare the file information in argument with
  the previous file information. The \texttt{delta\_seq} attribute of the
  \texttt{save\_pkt} will be updated, and the call will return
  \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
  
\end{description}
  

\subsubsection{Bacula events}
The list of events has been extended to include:

\begin{verbatim}
typedef enum {
  bEventJobStart        = 1,
  bEventJobEnd          = 2,
  bEventStartBackupJob  = 3,
  bEventEndBackupJob    = 4,
  bEventStartRestoreJob = 5,
  bEventEndRestoreJob   = 6,
  bEventStartVerifyJob  = 7,
  bEventEndVerifyJob    = 8,
  bEventBackupCommand   = 9,
  bEventRestoreCommand  = 10,
  bEventLevel           = 11,
  bEventSince           = 12,
   
  /* New events */
  bEventCancelCommand                   = 13,
  bEventVssBackupAddComponents          = 14,
  bEventVssRestoreLoadComponentMetadata = 15,
  bEventVssRestoreSetComponentsSelected = 16,
  bEventRestoreObject                   = 17,
  bEventEndFileSet                      = 18,
  bEventPluginCommand                   = 19,
  bEventVssBeforeCloseRestore           = 20,
  bEventVssPrepareSnapshot              = 21

} bEventType;
\end{verbatim}

\begin{description}
\item [bEventCancelCommand] is called whenever the currently
  running Job is canceled */

\item [bEventVssBackupAddComponents] 

\item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
  provides a char[27] table where the plugin can add Windows drives that will
  be used during the Job. You need to add them without duplicates, and you can
  use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
  for this purpose.
\end{description}

\subsection{ACL enhancements}

The following enhancements are made to the Bacula Filed with regards to
Access Control Lists (ACLs)

\begin{itemize}
\item Added support for AIX 5.3 and later new aclx\_get interface which supports
  POSIX and NFSv4 ACLs.
\item Added support for new acl types on FreeBSD 8.1 and later which supports
  POSIX and NFSv4 ACLs.
\item Some generic cleanups for internal ACL handling.
\item Fix for acl storage on OSX
\item Cleanup of configure checks for ACL detection, now configure only
  tests for a certain interface type based on the operating system
  this should give less false positives on detection. Also when ACLs
  are detected no other acl checks are performed anymore.
\end{itemize}

\medskip
This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
and is available with Bacula Enterprise Edition and Community Edition.

\subsection{XATTR enhancements}

The following enhancements are made to the Bacula Filed with regards to
Extended Attributes (XATTRs)

\begin{itemize}
\item Added support for IRIX extended attributes using the attr\_get interface.
\item Added support for Tru64 (OSF1) extended attributes using the
  getproplist interface.
\item Added support for AIX extended attributes available in AIX 6.x
  and higher using the listea/getea/setea interface.
\item Added some debugging to generic xattr code so it easier to
  debug.
\item Cleanup of configure checks for XATTR detection, now configure only
  tests for a certain interface type based on the operating system
  this should give less false positives on detection. Also when xattrs
  are detected no other xattr checks are performed anymore.
\end{itemize}

\medskip
This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
and is available with Bacula Enterprise Edition and Community Edition.

\subsection{Class Based Database Backend Drivers}

The main Bacula Director code is independent of the SQL backend
in version 5.2.0 and greater.  This means that the Bacula Director can be
packaged by itself, then each of the different SQL backends supported can
be packaged separately.  It is possible to build all the DB backends at the
same time by including multiple database options at the same time.

./configure can be run with multiple database configure options.
\begin{verbatim}
   --with-sqlite3
   --with-mysql
   --with-postgresql
\end{verbatim}

Order of testing for databases is:
\begin{itemize}
\item postgresql
\item mysql
\item sqlite3
\end{itemize}

Each configured backend generates a file named:
\verb+libbaccats-<sql_backend_name>-<version>.so+
A dummy catalog library is created named libbaccats-version.so

At configure time the first detected backend is used as the so called
default backend and at install time the dummy
\verb+libbaccats-<version>.so+ is replaced with the default backend type.

If you configure all three backends you get three backend libraries and the
postgresql gets installed as the default.

When you want to switch to another database, first save any old catalog you
may have then you can copy one of the three backend libraries over the
\verb+libbaccats-<version>.so+ e.g.

An actual command, depending on your Bacula version might be:
\begin{verbatim}
   cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
\end{verbatim}

where the \verb+5.2.2+ must be replaced by the Bacula release
version number.

Then you must update the default backend in the following files:

\begin{verbatim}
  create_bacula_database
  drop_bacula_database
  drop_bacula_tables
  grant_bacula_privileges
  make_bacula_tables
  make_catalog_backup
  update_bacula_tables
\end{verbatim}

And re-run all the above scripts.  Please note, this means
you will have a new empty database and if you had a previous
one it will be lost.

All current database backend drivers for catalog information are rewritten
to use a set of multi inherited C++ classes which abstract the specific
database specific internals and make sure we have a more stable generic
interface with the rest of SQL code.  From now on there is a strict
boundary between the SQL code and the low-level database functions.  This
new interface should also make it easier to add a new backend for a
currently unsupported database.  As part of the rewrite the SQLite 2 code
was removed (e.g.  only SQLite 3 is now supported).  An extra bonus of the
new code is that you can configure multiple backends in the configure and
build all backends in one compile session and select the correct database
backend at install time.  This should make it a lot easier for packages
maintainers.



\medskip
We also added cursor support for PostgreSQL backend, this improves memory
usage for large installation.

\medskip
This project was implemented by Planets Communications B.V. and ELM
Consultancy B.V. and Bacula Systems and is available with both the Bacula
Enterprise Edition and the Community Edition.

\subsection{Hash List Enhancements}

The htable hash table class has been extended with extra hash functions for
handling next to char pointer hashes also 32 bits and 64 bits hash keys.
Also the hash table initialization routines have been enhanced with
support for passing a hint as to the number of initial pages to use
for the size of the hash table. Until now the hash table always used
a fixed value of 10 Mb. The private hash functions of the mountpoint entry
cache have been rewritten to use the new htable class with a small memory
footprint.

\medskip
This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
and Bacula Systems and is available with Bacula Enterprise Edition and
Community Edition.

%%
%%
%%% =====================================================================
%%
%%


\section{Release Version 5.0.3}

There are no new features in version 5.0.2.  This version simply fixes a
number of bugs found in version 5.0.1 during the ongoing development
process.

\section{Release Version 5.0.2}

There are no new features in version 5.0.2.  This version simply fixes a
number of bugs found in version 5.0.1 during the ongoing development
process.

%%
%%

\section{New Features in 5.0.1}

This chapter presents the new features that are in the released Bacula version
5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
the ongoing development process.

\subsection{Truncate Volume after Purge}
\label{sec:actiononpurge}

The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
the volume when it is purged with the new command \texttt{purge volume
  action}. It is useful to prevent disk based volumes from consuming too much
space.

\begin{verbatim}
Pool {
  Name = Default
  Action On Purge = Truncate
  ...
}
\end{verbatim}

As usual you can also set this property with the \texttt{update volume} command
\begin{verbatim}
*update volume=xxx ActionOnPurge=Truncate
*update volume=xxx actiononpurge=None
\end{verbatim}

To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
following command in interactive mode or in a RunScript as shown after:
\begin{verbatim}
*purge volume action=truncate storage=File allpools
# or by default, action=all
*purge volume action storage=File pool=Default
\end{verbatim}

This is possible to specify the volume name, the media type, the pool, the
storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
idle when you decide to run this command.

\begin{verbatim}
Job {
 Name = CatalogBackup
 ...
 RunScript {
   RunsWhen=After
   RunsOnClient=No
   Console = "purge volume action=all allpools storage=File"
 }
}
\end{verbatim}

\textbf{Important note}: This feature doesn't work as
expected in version 5.0.0. Please do not use it before version 5.0.1.

\subsection{Allow Higher Duplicates}
This directive did not work correctly and has been depreciated
(disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
file as it will be removed in a future release.

\subsection{Cancel Lower Level Duplicates}
This directive was added in Bacula version 5.0.1.  It compares the
level of a new backup job to old jobs of the same name, if any,
and will kill the job which has a lower level than the other one.
If the levels are the same (i.e. both are Full backups), then 
nothing is done and the other Cancel XXX Duplicate directives
will be examined.

\section{New Features in 5.0.0}

\subsection{Maximum Concurrent Jobs for Devices}
\label{sec:maximumconcurrentjobdevice}

{\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
Daemon configuration permits setting the maximum number of Jobs that can
run concurrently on a specified Device.  Using this directive, it is
possible to have different Jobs using multiple drives, because when the
Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
Jobs on any other available compatible drive.  This facilitates writing to
multiple drives with multiple Jobs that all use the same Pool.

This project was funded by Bacula Systems.

\subsection{Restore from Multiple Storage Daemons}
\index[general]{Restore}

Previously, you were able to restore from multiple devices in a single Storage
Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
example, if your full backup runs on a Storage Daemon with an autochanger, and
your incremental jobs use another Storage Daemon with lots of disks, Bacula
will switch automatically from one Storage Daemon to an other within the same
Restore job.

You must upgrade your File Daemon to version 3.1.3 or greater to use this
feature.

This project was funded by Bacula Systems with the help of Equiinet.

\subsection{File Deduplication using Base Jobs}
A base job is sort of like a Full save except that you will want the FileSet to
contain only files that are unlikely to change in the future (i.e.  a snapshot
of most of your system after installing it).  After the base job has been run,
when you are doing a Full save, you specify one or more Base jobs to be used.
All files that have been backed up in the Base job/jobs but not modified will
then be excluded from the backup.  During a restore, the Base jobs will be
automatically pulled in where necessary.

This is something none of the competition does, as far as we know (except
perhaps BackupPC, which is a Perl program that saves to disk only).  It is big
win for the user, it makes Bacula stand out as offering a unique optimization
that immediately saves time and money.  Basically, imagine that you have 100
nearly identical Windows or Linux machine containing the OS and user files.
Now for the OS part, a Base job will be backed up once, and rather than making
100 copies of the OS, there will be only one.  If one or more of the systems
have some files updated, no problem, they will be automatically restored.

See the \ilink{Base Job Chapter}{basejobs} for more information.

This project was funded by Bacula Systems.

\subsection{AllowCompression = \lt{}yes\vb{}no\gt{}}
\index[dir]{AllowCompression}

This new directive may be added to Storage resource within the Director's
configuration to allow users to selectively disable the client compression for
any job which writes to this storage resource.

For example:
\begin{verbatim}
Storage {
  Name = UltriumTape
  Address = ultrium-tape
  Password = storage_password # Password for Storage Daemon
  Device = Ultrium
  Media Type = LTO 3
  AllowCompression = No # Tape drive has hardware compression
}
\end{verbatim}
The above example would cause any jobs running with the UltriumTape storage
resource to run without compression from the client file daemons.  This
effectively overrides any compression settings defined at the FileSet level.

This feature is probably most useful if you have a tape drive which supports
hardware compression.  By setting the \texttt{AllowCompression = No} directive
for your tape drive storage resource, you can avoid additional load on the file
daemon and possibly speed up tape backups.

This project was funded by Collaborative Fusion, Inc.

\subsection{Accurate Fileset Options}
\label{sec:accuratefileset}

In previous versions, the accurate code used the file creation and modification
times to determine if a file was modified or not. Now you can specify which
attributes to use (time, size, checksum, permission, owner, group, \dots),
similar to the Verify options.

\begin{verbatim}
FileSet {
  Name = Full
  Include = {
    Options {
       Accurate = mcs
       Verify   = pin5
    }
    File = /
  }
}
\end{verbatim}

\begin{description}  
\item {\bf i}  compare the inodes  
\item {\bf p}  compare the permission bits  
\item {\bf n}  compare the number of links  
\item {\bf u}  compare the user id  
\item {\bf g}  compare the group id  
\item {\bf s}  compare the size  
\item {\bf a}  compare the access time  
\item {\bf m}  compare the modification time (st\_mtime)  
\item {\bf c}  compare the change time (st\_ctime)  
\item {\bf d}  report file size decreases  
\item {\bf 5}  compare the MD5 signature  
\item {\bf 1}  compare the SHA1 signature  
\end{description}

\textbf{Important note:} If you decide to use checksum in Accurate jobs,
the File Daemon will have to read all files even if they normally would not
be saved.  This increases the I/O load, but also the accuracy of the
deduplication.  By default, Bacula will check modification/creation time
and size.

This project was funded by Bacula Systems.

\subsection{Tab-completion for Bconsole}
\label{sec:tabcompletion}

If you build \texttt{bconsole} with readline support, you will be able to use
the new auto-completion mode. This mode supports all commands, gives help
inside command, and lists resources when required. It works also in the restore
mode.

To use this feature, you should have readline development package loaded on
your system, and use the following option in configure.
\begin{verbatim}
./configure --with-readline=/usr/include/readline --disable-conio ...
\end{verbatim}

The new bconsole won't be able to tab-complete with older directors.

This project was funded by Bacula Systems.

\subsection{Pool File and Job Retention}
\label{sec:poolfilejobretention}

We added two new Pool directives, \texttt{FileRetention} and
\texttt{JobRetention}, that take precedence over Client directives of the same
name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
example, you can decide to increase Retention times for Archive or OffSite Pool.

It seems obvious to us, but apparently not to some users, that given the
definition above that the Pool File and Job Retention periods is a global
override for the normal Client based pruning, which means that when the
Job is pruned, the pruning will apply globally to that particular Job.

Currently, there is a bug in the implementation that causes any Pool 
retention periods specified to apply to {\bf all} Pools for that
particular Client.  Thus we suggest that you avoid using these two
directives until this implementation problem is corrected.

\subsection{Read-only File Daemon using capabilities}
\label{sec:fdreadonly}
This feature implements support of keeping \textbf{ReadAll} capabilities after
UID/GID switch, this allows FD to keep root read but drop write permission.

It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
\textbf{ReadAll} capabilities should be kept after UID/GID switch.

\begin{verbatim}
root@localhost:~# bacula-fd -k -u nobody -g nobody
\end{verbatim}

The code for this feature was contributed by our friends at AltLinux.

\subsection{Bvfs API}
\label{sec:bvfs}

To help developers of restore GUI interfaces, we have added new \textsl{dot
  commands} that permit browsing the catalog in a very simple way.

\begin{itemize}
\item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
  the Bvfs cache in the catalog. You need to run it before any access to the
  Bvfs layer.

\item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
  will list all directories in the specified \texttt{path} or
  \texttt{pathid}. Using \texttt{pathid} avoids problems with character
  encoding of path/filenames.

\item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
  will list all files in the specified \texttt{path} or \texttt{pathid}. Using
  \texttt{pathid} avoids problems with character encoding.
\end{itemize}

You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
data that will be displayed.

\begin{verbatim}
* .bvfs_update jobid=1,2
* .bvfs_update
* .bvfs_lsdir path=/ jobid=1,2
\end{verbatim}

This project was funded by Bacula Systems.

\subsection{Testing your Tape Drive}
\label{sec:btapespeed}

To determine the best configuration of your tape drive, you can run the new
\texttt{speed} command available in the \texttt{btape} program.

This command can have the following arguments:
\begin{itemize}
\item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
  (between 1 and 5GB). This counter is in GB.
\item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
  of data should be greater than your memory ($file\_size*nb\_file$).
\item[\texttt{skip\_zero}] This flag permits to skip tests with constant
  data.
\item[\texttt{skip\_random}] This flag permits to skip tests with random
  data.
\item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
\item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
  access.
\end{itemize}

\begin{verbatim}
*speed file_size=3 skip_raw
btape.c:1078 Test with zero data and bacula block structure.
btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
++++++++++++++++++++++++++++++++++++++++++
btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
...
btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s

btape.c:1090 Test with random data, should give the minimum throughput.
btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
+++++++++++++++++++++++++++++++++++++++++++
btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
+++++++++++++++++++++++++++++++++++++++++++
...
btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s

\end{verbatim}

When using compression, the random test will give your the minimum throughput
of your drive . The test using constant string will give you the maximum speed
of your hardware chain. (CPU, memory, SCSI card, cable, drive, tape).

You can change the block size in the Storage Daemon configuration file.

\subsection{New {\bf Block Checksum} Device Directive}
You may now turn off the Block Checksum (CRC32) code
that Bacula uses when writing blocks to a Volume.  This is
done by adding:

\begin{verbatim}
Block Checksum = no
\end{verbatim}

doing so can reduce the Storage daemon CPU usage slightly.  It
will also permit Bacula to read a Volume that has corrupted data.

The default is {\bf yes} -- i.e. the checksum is computed on write
and checked on read. 

We do not recommend to turn this off particularly on older tape
drives or for disk Volumes where doing so may allow corrupted data
to go undetected.

\subsection{New Bat Features}

Those new features were funded by Bacula Systems.

\subsubsection{Media List View}

By clicking on ``Media'', you can see the list of all your volumes. You will be
able to filter by Pool, Media Type, Location,\dots And sort the result directly
in the table. The old ``Media'' view is now known as ``Pool''.
\begin{figure}[htbp]
  \centering
  \includegraphics[width=0.8\linewidth]{bat-mediaview}
  \label{fig:mediaview}
\end{figure}


\subsubsection{Media Information View}

By double-clicking on a volume (on the Media list, in the Autochanger content
or in the Job information panel), you can access a detailed overview of your
Volume. (cf figure \vref{fig:mediainfo}.)
\begin{figure}[htbp]
  \centering
  \includegraphics[width=0.8\linewidth]{bat11}  
  \caption{Media information}
  \label{fig:mediainfo}
\end{figure}

\subsubsection{Job Information View}

By double-clicking on a Job record (on the Job run list or in the Media
information panel), you can access a detailed overview of your Job. (cf
figure \vref{fig:jobinfo}.)
\begin{figure}[htbp]
  \centering
  \includegraphics[width=0.8\linewidth]{bat12}  
  \caption{Job information}
  \label{fig:jobinfo}
\end{figure}

\subsubsection{Autochanger Content View}

By double-clicking on a Storage record (on the Storage list panel), you can
access a detailed overview of your Autochanger. (cf figure \vref{fig:jobinfo}.)
\begin{figure}[htbp]
  \centering
  \includegraphics[width=0.8\linewidth]{bat13}  
  \caption{Autochanger content}
  \label{fig:achcontent}
\end{figure}

To use this feature, you need to use the latest mtx-changer script
version. (With new \texttt{listall} and \texttt{transfer} commands)

\subsection{Bat on Windows}
We have ported {\bf bat} to Windows and it is now installed 
by default when the installer is run.  It works quite well 
on Win32, but has not had a lot of testing there, so your
feedback would be welcome.  Unfortunately, even though it is
installed by default, it does not yet work on 64 bit Windows
operating systems.

\subsection{New Win32 Installer}
The Win32 installer has been modified in several very important
ways.  
\begin{itemize}
\item You must deinstall any current version of the
Win32 File daemon before upgrading to the new one. 
If you forget to do so, the new installation will fail.
To correct this failure, you must manually shutdown 
and deinstall the old File daemon. 
\item All files (other than menu links) are installed
in {\bf c:/Program Files/Bacula}.  
\item The installer no longer sets this
file to require administrator privileges by default. If you want
to do so, please do it manually using the {\bf cacls} program.
For example:
\begin{verbatim}
cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
\end{verbatim}
\item The server daemons (Director and Storage daemon) are
no longer included in the Windows installer.  If you want the
Windows servers, you will either need to build them yourself (note
they have not been ported to 64 bits), or you can contact 
Bacula Systems about this.
\end{itemize}

\subsection{Win64 Installer}
We have corrected a number of problems that required manual
editing of the conf files.  In most cases, it should now
install and work.  {\bf bat} is by default installed in
{\bf c:/Program Files/Bacula/bin32} rather than
{\bf c:/Program Files/Bacula} as is the case with the 32
bit Windows installer.

\subsection{Linux Bare Metal Recovery USB Key}
We have made a number of significant improvements in the
Bare Metal Recovery USB key.  Please see the README files
it the {\bf rescue} release for more details.  

We are working on an equivalent USB key for Windows bare
metal recovery, but it will take some time to develop it (best
estimate 3Q2010 or 4Q2010)


\subsection{bconsole Timeout Option}
You can now use the -u option of {\bf bconsole} to set a timeout in seconds
for commands. This is useful with GUI programs that use {\bf bconsole}
to interface to the Director.

\subsection{Important Changes}
\label{sec:importantchanges}

\begin{itemize}
\item You are now allowed to Migrate, Copy, and Virtual Full to read and write
  to the same Pool. The Storage daemon ensures that you do not read and
  write to the same Volume.
\item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
  poll by default).
\item Virtually all the features of {\bf mtx-changer} have
  now been parametrized, which allows you to configure
  mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf} 
  that contains variables that you can set to configure mtx-changer.
  This configuration file will not be overwritten during upgrades.
  We encourage you to submit any changes
  that are made to mtx-changer and to parametrize it all in
  mtx-changer.conf so that all configuration will be done by
  changing only mtx-changer.conf.
\item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
  and \texttt{transfer}. Please configure them as appropriate
  in mtx-changer.conf.
\item To enhance security of the \texttt{BackupCatalog} job, we provide a new
  script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
  password. If you want to use the new script, you will need to 
  manually change the \texttt{BackupCatalog} Job definition.
\item The \texttt{bconsole} \texttt{help} command now accepts
  an argument, which if provided produces information on that
  command (ex: \texttt{help run}).
\end{itemize}


\subsubsection*{Truncate volume after purge}

Note that the Truncate Volume after purge feature doesn't work as expected
in 5.0.0 version. Please, don't use it before version 5.0.1.

\subsubsection{Custom Catalog queries}

If you wish to add specialized commands that list the contents of the catalog,
you can do so by adding them to the \texttt{query.sql} file. This
\texttt{query.sql} file is now empty by default.  The file
\texttt{examples/sample-query.sql} has an a number of sample commands
you might find useful.

\subsubsection{Deprecated parts}

The following items have been \textbf{deprecated} for a long time, and are now
removed from the code.
\begin{itemize}
\item Gnome console
\item Support for SQLite 2
\end{itemize}

\subsection{Misc Changes}
\label{sec:miscchanges}

\begin{itemize}
\item Updated Nagios check\_bacula
\item Updated man files
\item Added OSX package generation script in platforms/darwin
\item Added Spanish and Ukrainian Bacula translations
\item Enable/disable command shows only Jobs that can change
\item Added \texttt{show disabled} command to show disabled Jobs
\item Many ACL improvements
\item Added Level to FD status Job output
\item Begin Ingres DB driver (not yet working)
\item Split RedHat spec files into bacula, bat, mtx, and docs
\item Reorganized the manuals (fewer separate manuals)
\item Added lock/unlock order protection in lock manager
\item Allow 64 bit sizes for a number of variables
\item Fixed several deadlocks or potential race conditions in the SD
\end{itemize}

\chapter{Released Version 3.0.3 and 3.0.3a}

There are no new features in version 3.0.3.  This version simply fixes a
number of bugs found in version 3.0.2 during the ongoing development
process.

\section{New Features in Released Version 3.0.2}

This chapter presents the new features added to the
Released Bacula Version 3.0.2.

\subsection{Full Restore from a Given JobId}
\index[general]{Restore menu}

This feature allows selecting a single JobId and having Bacula
automatically select all the other jobs that comprise a full backup up to
and including the selected date (through JobId).

Assume we start with the following jobs:
\begin{verbatim}
+-------+--------------+---------------------+-------+----------+------------+
| jobid | client       | starttime           | level | jobfiles | jobbytes   |
+-------+--------------+---------------------+-------+----------+------------
| 6     | localhost-fd | 2009-07-15 11:45:49 | I     | 2        | 0          |
| 5     | localhost-fd | 2009-07-15 11:45:45 | I     | 15       | 44143      |
| 3     | localhost-fd | 2009-07-15 11:45:38 | I     | 1        | 10         |
| 1     | localhost-fd | 2009-07-15 11:45:30 | F     | 1527     | 44143073   |
+-------+--------------+---------------------+-------+----------+------------+
\end{verbatim}

Below is an example of this new feature (which is number 12 in the
menu).

\begin{verbatim}
* restore
To select the JobIds, you have the following choices:
     1: List last 20 Jobs run
     2: List Jobs where a given File is saved
...
    12: Select full restore to a specified Job date
    13: Cancel

Select item:  (1-13): 12
Enter JobId to get the state to restore: 5
Selecting jobs to build the Full state at 2009-07-15 11:45:45
You have selected the following JobIds: 1,3,5

Building directory tree for JobId(s) 1,3,5 ...  +++++++++++++++++++
1,444 files inserted into the tree.
\end{verbatim}

This project was funded by Bacula Systems.

\subsection{Source Address}
\index[general]{Source Address}

A feature has been added which allows the administrator to specify the address
from which the Director and File daemons will establish connections.  This
may be used to simplify system configuration overhead when working in complex
networks utilizing multi-homing and policy-routing.

To accomplish this, two new configuration directives have been implemented:
\begin{verbatim}
FileDaemon {
  FDSourceAddress=10.0.1.20    # Always initiate connections from this address
}

Director {
  DirSourceAddress=10.0.1.10   # Always initiate connections from this address
}
\end{verbatim}

Simply adding specific host routes on the OS
would have an undesirable side-effect: any
application trying to contact the destination host would be forced to use the
more specific route possibly diverting management traffic onto a backup VLAN.
Instead of adding host routes for each client connected to a multi-homed backup
server (for example where there are management and backup VLANs), one can
use the new directives to specify a specific source address at the application
level.

Additionally, this allows the simplification and abstraction of firewall rules
when dealing with a Hot-Standby director or storage daemon configuration.  The
Hot-standby pair may share a CARP address, which connections must be sourced
from, while system services listen and act from the unique interface addresses.

This project was funded by Collaborative Fusion, Inc.

\subsection{Show volume availability when doing restore}

When doing a restore the selection dialog ends by displaying this
screen:

\begin{verbatim}
  The job will require the following
   Volume(s)                 Storage(s)                SD Device(s)
   ===========================================================================
   *000741L3                  LTO-4                     LTO3 
   *000866L3                  LTO-4                     LTO3 
   *000765L3                  LTO-4                     LTO3 
   *000764L3                  LTO-4                     LTO3 
   *000756L3                  LTO-4                     LTO3 
   *001759L3                  LTO-4                     LTO3 
   *001763L3                  LTO-4                     LTO3 
    001762L3                  LTO-4                     LTO3 
    001767L3                  LTO-4                     LTO3 

Volumes marked with ``*'' are online (in the autochanger).
\end{verbatim}

This should help speed up large restores by minimizing the time spent
waiting for the operator to discover that he must change tapes in the library.

This project was funded by Bacula Systems.

\subsection{Accurate estimate command}

The \texttt{estimate} command can now use the accurate code to detect changes
and give a better estimation.

You can set the accurate behavior on the command line by using
\texttt{accurate=yes\vb{}no} or use the Job setting as default value.

\begin{verbatim}
* estimate listing accurate=yes level=incremental job=BackupJob
\end{verbatim}

This project was funded by Bacula Systems.

\section{New Features in 3.0.0}
\label{NewFeaturesChapter}
\index[general]{New Features}

This chapter presents the new features added to the development 2.5.x
versions to be released as Bacula version 3.0.0 sometime in April 2009.

\subsection{Accurate Backup}
\index[general]{Accurate Backup}

As with most other backup programs, by default Bacula decides what files to
backup for Incremental and Differential backup by comparing the change
(st\_ctime) and modification (st\_mtime) times of the file to the time the last
backup completed.  If one of those two times is later than the last backup
time, then the file will be backed up.  This does not, however, permit tracking
what files have been deleted and will miss any file with an old time that may
have been restored to or moved onto the client filesystem.

\subsubsection{Accurate = \lt{}yes\vb{}no\gt{}}
If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
backup, there is no difference, but for {\bf Differential} and {\bf
  Incremental} backups, the Director will send a list of all previous files
backed up, and the File daemon will use that list to determine if any new files
have been added or or moved and if any files have been deleted. This allows
Bacula to make an accurate backup of your system to that point in time so that
if you do a restore, it will restore your system exactly.  

One note of caution
about using Accurate backup is that it requires more resources (CPU and memory)
on both the Director and the Client machines to create the list of previous
files backed up, to send that list to the File daemon, for the File daemon to
keep the list (possibly very big) in memory, and for the File daemon to do
comparisons between every file in the FileSet and the list.  In particular,
if your client has lots of files (more than a few million), you will need
lots of memory on the client machine.

Accurate must not be enabled when backing up with a plugin that is not
specially designed to work with Accurate. If you enable it, your restores
will probably not work correctly.

This project was funded by Bacula Systems.
                                       


\subsection{Copy Jobs}
\index[general]{Copy Jobs}

A new {\bf Copy} job type 'C' has been implemented. It is similar to the
existing Migration feature with the exception that the Job that is copied is
left unchanged.  This essentially creates two identical copies of the same
backup. However, the copy is treated as a copy rather than a backup job, and
hence is not directly available for restore.  The {\bf restore} command lists
copy jobs and allows selection of copies by using \texttt{jobid=}
option. If the keyword {\bf copies} is present on the command line, Bacula will
display the list of all copies for selected jobs.

\begin{verbatim}
* restore copies
[...]
These JobIds have copies as follows:
+-------+------------------------------------+-----------+------------------+
| JobId | Job                                | CopyJobId | MediaType        |
+-------+------------------------------------+-----------+------------------+
| 2     | CopyJobSave.2009-02-17_16.31.00.11 | 7         | DiskChangerMedia |
+-------+------------------------------------+-----------+------------------+
+-------+-------+----------+----------+---------------------+------------------+
| JobId | Level | JobFiles | JobBytes | StartTime           | VolumeName       |
+-------+-------+----------+----------+---------------------+------------------+
| 19    | F     | 6274     | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
| 2     | I     | 1        | 5        | 2009-02-17 16:30:51 | FileVolume001    |
+-------+-------+----------+----------+---------------------+------------------+
You have selected the following JobIds: 19,2

Building directory tree for JobId(s) 19,2 ...  ++++++++++++++++++++++++++++++++++++++++++++
5,611 files inserted into the tree.
...
\end{verbatim}


The Copy Job runs without using the File daemon by copying the data from the
old backup Volume to a different Volume in a different Pool. See the Migration
documentation for additional details. For copy Jobs there is a new selection
directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
not already copied to another Pool. 

As with Migration, the Client, Volume, Job, or SQL query, are
other possible ways of selecting the Jobs to be copied. Selection
types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
work, but are probably more suited for Migration Jobs. 

If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
it will promote the Copy to a \textsl{real} backup job and will make it available for
automatic restore. If more than one Copy is available, it will promote the copy
with the smallest JobId.

A nice solution which can be built with the new Copy feature is often
called disk-to-disk-to-tape backup (DTDTT). A sample config could
look something like the one below:

\begin{verbatim}
Pool {
  Name = FullBackupsVirtualPool
  Pool Type = Backup
  Purge Oldest Volume = Yes
  Storage = vtl
  NextPool = FullBackupsTapePool
}

Pool {
  Name = FullBackupsTapePool
  Pool Type = Backup
  Recycle = Yes
  AutoPrune = Yes
  Volume Retention = 365 days
  Storage = superloader
}

#
# Fake fileset for copy jobs
#
Fileset {
  Name = None
  Include {
    Options {
      signature = MD5
    }
  }
}

#
# Fake client for copy jobs
#
Client {
  Name = None
  Address = localhost
  Password = "NoNe"
  Catalog = MyCatalog
}

#
# Default template for a CopyDiskToTape Job
#
JobDefs {
  Name = CopyDiskToTape
  Type = Copy
  Messages = StandardCopy
  Client = None
  FileSet = None
  Selection Type = PoolUncopiedJobs
  Maximum Concurrent Jobs = 10
  SpoolData = No
  Allow Duplicate Jobs = Yes
  Cancel Queued Duplicates = No
  Cancel Running Duplicates = No
  Priority = 13
}

Schedule {
   Name = DaySchedule7:00
   Run = Level=Full daily at 7:00
}

Job {
  Name = CopyDiskToTapeFullBackups
  Enabled = Yes
  Schedule = DaySchedule7:00
  Pool = FullBackupsVirtualPool
  JobDefs = CopyDiskToTape
}
\end{verbatim}

The example above had 2 pool which are copied using the PoolUncopiedJobs
selection criteria. Normal Full backups go to the Virtual pool and are copied
to the Tape pool the next morning.

The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
\textbf{jobid}.

\begin{verbatim}
*list copies
+-------+------------------------------------+-----------+------------------+
| JobId | Job                                | CopyJobId | MediaType        |
+-------+------------------------------------+-----------+------------------+
|     9 | CopyJobSave.2008-12-20_22.26.49.05 |        11 | DiskChangerMedia |
+-------+------------------------------------+-----------+------------------+
\end{verbatim}

\subsection{ACL Updates}
\index[general]{ACL Updates}
The whole ACL code had been overhauled and in this version each platforms has
different streams for each type of acl available on such an platform. As ACLs
between platforms tend to be not that portable (most implement POSIX acls but
some use an other draft or a completely different format) we currently only
allow certain platform specific ACL streams to be decoded and restored on the
same platform that they were created on.  The old code allowed to restore ACL
cross platform but the comments already mention that not being to wise. For
backward compatibility the new code will accept the two old ACL streams and
handle those with the platform specific handler. But for all new backups it
will save the ACLs using the new streams.

Currently the following platforms support ACLs:

\begin{itemize}
 \item {\bf AIX}
 \item {\bf Darwin/OSX}
 \item {\bf FreeBSD}
 \item {\bf HPUX}
 \item {\bf IRIX}
 \item {\bf Linux}
 \item {\bf Tru64}
 \item {\bf Solaris}
\end{itemize}

Currently we support the following ACL types (these ACL streams use a reserved
part of the stream numbers):

\begin{itemize}
\item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
  acl\_get
 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
   string representation from acl\_to\_text (POSIX acl)
  \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
    string representation from acl\_to\_text (POSIX acl) for default acls.
  \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
    string representation from acl\_to\_text (POSIX acl) for access acls.
  \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
    string representation from acltostr (POSIX acl)
  \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
    representation from acl\_to\_text (POSIX acl) for default acls.
  \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
    representation from acl\_to\_text (POSIX acl) for access acls.
  \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
    string representation from acl\_to\_text (POSIX acl) for default acls.
  \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
    representation from acl\_to\_text (POSIX acl) for access acls.
  \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
    string representation from acl\_to\_text (POSIX acl) for default acls.
  \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
    string representation from acl\_to\_text (POSIX acl) for default acls.
  \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
    representation from acl\_to\_text (POSIX acl) for access acls.
  \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
    string representation from acltotext or acl\_totext (POSIX acl)
  \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
    representation from from acl\_totext (NFSv4 or ZFS acl)
\end{itemize}

In future versions we might support conversion functions from one type of acl
into an other for types that are either the same or easily convertible. For now
the streams are separate and restoring them on a platform that doesn't
recognize them will give you a warning.

\subsection{Extended Attributes}
\index[general]{Extended Attributes}
Something that was on the project list for some time is now implemented for
platforms that support a similar kind of interface. Its the support for backup
and restore of so called extended attributes. As extended attributes are so
platform specific these attributes are saved in separate streams for each
platform.  Restores of the extended attributes can only be performed on the
same platform the backup was done.  There is support for all types of extended
attributes, but restoring from one type of filesystem onto an other type of
filesystem on the same platform may lead to surprises.  As extended attributes
can contain any type of data they are stored as a series of so called
value-pairs.  This data must be seen as mostly binary and is stored as such.
As security labels from selinux are also extended attributes this option also
stores those labels and no specific code is enabled for handling selinux
security labels.

Currently the following platforms support extended attributes:
\begin{itemize}
 \item {\bf Darwin/OSX}
 \item {\bf FreeBSD}
 \item {\bf Linux}
 \item {\bf NetBSD}
\end{itemize}

On Linux acls are also extended attributes, as such when you enable ACLs on a
Linux platform it will NOT save the same data twice e.g. it will save the ACLs
and not the same extended attribute.

To enable the backup of extended attributes please add the following to your
fileset definition.
\begin{verbatim}
  FileSet {
    Name = "MyFileSet"
    Include {
      Options {
        signature = MD5
        xattrsupport = yes
      }
      File = ...
    }
  }
\end{verbatim}

\subsection{Shared objects}
\index[general]{Shared objects}
A default build of Bacula will now create the libraries as shared objects
(.so) rather than static libraries as was previously the case.  
The shared libraries are built using {\bf libtool} so it should be quite
portable.

An important advantage of using shared objects is that on a machine with the
Directory, File daemon, the Storage daemon, and a console, you will have only
one copy of the code in memory rather than four copies.  Also the total size of
the binary release is smaller since the library code appears only once rather
than once for every program that uses it; this results in significant reduction
in the size of the binaries particularly for the utility tools.
 
In order for the system loader to find the shared objects when loading the
Bacula binaries, the Bacula shared objects must either be in a shared object
directory known to the loader (typically /usr/lib) or they must be in the
directory that may be specified on the {\bf ./configure} line using the {\bf
  {-}{-}libdir} option as:

\begin{verbatim}
  ./configure --libdir=/full-path/dir
\end{verbatim}

the default is /usr/lib. If {-}{-}libdir is specified, there should be
no need to modify your loader configuration provided that
the shared objects are installed in that directory (Bacula
does this with the make install command). The shared objects
that Bacula references are:

\begin{verbatim}
libbaccfg.so
libbacfind.so
libbacpy.so
libbac.so
\end{verbatim}

These files are symbolically linked to the real shared object file,
which has a version number to permit running multiple versions of
the libraries if desired (not normally the case).

If you have problems with libtool or you wish to use the old
way of building static libraries, or you want to build a static
version of Bacula you may disable
libtool on the configure command line with:

\begin{verbatim}
  ./configure --disable-libtool
\end{verbatim}


\subsection{Building Static versions of Bacula}
\index[general]{Static linking}
In order to build static versions of Bacula, in addition
to configuration options that were needed you now must
also add --disable-libtool.  Example

\begin{verbatim}
  ./configure --enable-static-client-only --disable-libtool
\end{verbatim}


\subsection{Virtual Backup (Vbackup)}
\index[general]{Virtual Backup}
\index[general]{Vbackup}

Bacula's virtual backup feature is often called Synthetic Backup or
Consolidation in other backup products.  It permits you to consolidate the
previous Full backup plus the most recent Differential backup and any
subsequent Incremental backups into a new Full backup.  This new Full
backup will then be considered as the most recent Full for any future
Incremental or Differential backups.  The VirtualFull backup is
accomplished without contacting the client by reading the previous backup
data and writing it to a volume in a different pool.

In some respects the Vbackup feature works similar to a Migration job, in
that Bacula normally reads the data from the pool specified in the 
Job resource, and writes it to the {\bf Next Pool} specified in the 
Job resource. Note, this means that usually the output from the Virtual
Backup is written into a different pool from where your prior backups
are saved. Doing it this way guarantees that you will not get a deadlock
situation attempting to read and write to the same volume in the Storage
daemon. If you then want to do subsequent backups, you may need to
move the Virtual Full Volume back to your normal backup pool.
Alternatively, you can set your {\bf Next Pool} to point to the current
pool.  This will cause Bacula to read and write to Volumes in the
current pool. In general, this will work, because Bacula will
not allow reading and writing on the same Volume. In any case, once
a VirtualFull has been created, and a restore is done involving the
most current Full, it will read the Volume or Volumes by the VirtualFull 
regardless of in which Pool the Volume is found.

The Vbackup is enabled on a Job by Job in the Job resource by specifying
a level of {\bf VirtualFull}.

A typical Job resource definition might look like the following:

\begin{verbatim}
Job {
  Name = "MyBackup"
  Type = Backup
  Client=localhost-fd
  FileSet = "Full Set"
  Storage = File
  Messages = Standard
  Pool = Default
  SpoolData = yes
}

# Default pool definition
Pool {
  Name = Default
  Pool Type = Backup
  Recycle = yes            # Automatically recycle Volumes
  AutoPrune = yes          # Prune expired volumes
  Volume Retention = 365d  # one year
  NextPool = Full
  Storage = File
}

Pool {
  Name = Full
  Pool Type = Backup
  Recycle = yes            # Automatically recycle Volumes
  AutoPrune = yes          # Prune expired volumes
  Volume Retention = 365d  # one year
  Storage = DiskChanger
}

# Definition of file storage device
Storage {
  Name = File
  Address = localhost
  Password = "xxx"
  Device = FileStorage
  Media Type = File
  Maximum Concurrent Jobs = 5
}

# Definition of DDS Virtual tape disk storage device
Storage {
  Name = DiskChanger
  Address = localhost  # N.B. Use a fully qualified name here
  Password = "yyy"
  Device = DiskChanger
  Media Type = DiskChangerMedia
  Maximum Concurrent Jobs = 4
  Autochanger = yes
}
\end{verbatim}

Then in bconsole or via a Run schedule, you would run the job as:

\begin{verbatim}
run job=MyBackup level=Full
run job=MyBackup level=Incremental
run job=MyBackup level=Differential
run job=MyBackup level=Incremental
run job=MyBackup level=Incremental
\end{verbatim}

So providing there were changes between each of those jobs, you would end up
with a Full backup, a Differential, which includes the first Incremental
backup, then two Incremental backups.  All the above jobs would be written to
the {\bf Default} pool.

To consolidate those backups into a new Full backup, you would run the
following:

\begin{verbatim}
run job=MyBackup level=VirtualFull
\end{verbatim}

And it would produce a new Full backup without using the client, and the output
would be written to the {\bf Full} Pool which uses the Diskchanger Storage.

If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
fail with an error.

Note, the Start and End time of the Virtual Full backup is set to the
values for the last job included in the Virtual Full (in the above example,
it is an Increment). This is so that if another incremental is done, which
will be based on the Virtual Full, it will backup all files from the
last Job included in the Virtual Full rather than from the time the Virtual
Full was actually run.



\subsection{Catalog Format}
\index[general]{Catalog Format}
Bacula 3.0 comes with some changes to the catalog format.  The upgrade
operation will convert the FileId field of the File table from 32 bits (max 4
billion table entries) to 64 bits (very large number of items).  The
conversion process can take a bit of time and will likely DOUBLE THE SIZE of
your catalog during the conversion.  Also you won't be able to run jobs during
this conversion period.  For example, a 3 million file catalog will take 2
minutes to upgrade on a normal machine.  Please don't forget to make a valid
backup of your database before executing the upgrade script. See the 
ReleaseNotes for additional details.

\subsection{64 bit Windows Client}
\index[general]{Win64 Client}
Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
As a consequence, we are also releasing a 64 bit version of the Bacula 
Windows Client (win64bacula-3.0.0.exe) that does work with VSS. 
These binaries should only be installed on 64 bit Windows operating systems.
What is important is not your hardware but whether or not you have
a 64 bit version of the Windows OS.  

Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
\begin{enumerate}
\item Before installing the Win64 Bacula Client, you must totally
      deinstall any prior 2.4.x Client installation using the 
      Bacula deinstallation (see the menu item). You may want
      to save your .conf files first.
\item Only the Client (File daemon) is ported to Win64, the Director
      and the Storage daemon are not in the 64 bit Windows installer.
\item bwx-console is not yet ported.
\item bconsole is ported but it has not been tested.
\item The documentation is not included in the installer.
\item Due to Vista security restrictions imposed on a default installation
      of Vista, before upgrading the Client, you must manually stop
      any prior version of Bacula from running, otherwise the install
      will fail.
\item Due to Vista security restrictions imposed on a default installation
      of Vista, attempting to edit the conf files via the menu items
      will fail. You must directly edit the files with appropriate 
      permissions.  Generally double clicking on the appropriate .conf
      file will work providing you have sufficient permissions.
\item All Bacula files are now installed in 
      {\bf C:/Program Files/Bacula} except the main menu items,
      which are installed as before. This vastly simplifies the installation.
\item If you are running on a foreign language version of Windows, most
      likely {\bf C:/Program Files} does not exist, so you should use the
      Custom installation and enter an appropriate location to install
      the files.
\item The 3.0.0 Win32 Client continues to install files in the locations used
      by prior versions. For the next version we will convert it to use
      the same installation conventions as the Win64 version.
\end{enumerate}

This project was funded by Bacula Systems.


\subsection{Duplicate Job Control}
\index[general]{Duplicate Jobs}
The new version of Bacula provides four new directives that
give additional control over what Bacula does if duplicate jobs 
are started.  A duplicate job in the sense we use it here means
a second or subsequent job with the same name starts.  This
happens most frequently when the first job runs longer than expected because no 
tapes are available.

The four directives each take as an argument a {\bf yes} or {\bf no} value and
are specified in the Job resource.

They are:

\subsubsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
\index[general]{Allow Duplicate Jobs}
  If this directive is set to {\bf yes}, duplicate jobs will be run.  If
  the directive is set to {\bf no} (default) then only one job of a given name
  may run at one time, and the action that Bacula takes to ensure only
  one job runs is determined by the other directives (see below).
 
  If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
  are present and none of the three directives given below permit
  Canceling a job, then the current job (the second one started)
  will be canceled.

\subsubsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
\index[general]{Allow Higher Duplicates}
  This directive was in version 5.0.0, but does not work as
  expected. If used, it should always be set to no.  In later versions
  of Bacula the directive is disabled (disregarded).

\subsubsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
\index[general]{Cancel Running Duplicates}
  If {\bf Allow Duplicate Jobs} is set to {\bf no} and
  if this directive is set to {\bf yes} any job that is already running
  will be canceled.  The default is {\bf no}.

\subsubsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
\index[general]{Cancel Queued Duplicates}
  If {\bf Allow Duplicate Jobs} is set to {\bf no} and
  if this directive is set to {\bf yes} any job that is
  already queued to run but not yet running will be canceled.
  The default is {\bf no}. 


\subsection{TLS Authentication}
\index[general]{TLS Authentication}
In Bacula version 2.5.x and later, in addition to the normal Bacula
CRAM-MD5 authentication that is used to authenticate each Bacula
connection, you can specify that you want TLS Authentication as well,
which will provide more secure authentication.

This new feature uses Bacula's existing TLS code (normally used for
communications encryption) to do authentication.  To use it, you must
specify all the TLS directives normally used to enable communications
encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
a new directive:

\subsubsection{TLS Authenticate = yes}
\begin{verbatim}
TLS Authenticate = yes
\end{verbatim}

in the main daemon configuration resource (Director for the Director,
Client for the File daemon, and Storage for the Storage daemon).

When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
authentication, Bacula will also do TLS authentication, then TLS 
encryption will be turned off, and the rest of the communication between
the two Bacula daemons will be done without encryption.

If you want to encrypt communications data, use the normal TLS directives
but do not turn on {\bf TLS Authenticate}.

\subsection{bextract non-portable Win32 data}
\index[general]{bextract handles Win32 non-portable data}
{\bf bextract} has been enhanced to be able to restore
non-portable Win32 data to any OS.  Previous versions were 
unable to restore non-portable Win32 data to machines that
did not have the Win32 BackupRead and BackupWrite API calls.

\subsection{State File updated at Job Termination}
\index[general]{State File}
In previous versions of Bacula, the state file, which provides a
summary of previous jobs run in the {\bf status} command output was
updated only when Bacula terminated, thus if the daemon crashed, the
state file might not contain all the run data.  This version of
the Bacula daemons updates the state file on each job termination.

\subsection{MaxFullInterval = \lt{}time-interval\gt{}}
\index[general]{MaxFullInterval}
The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
can be used to specify the maximum time interval between {\bf Full} backup
jobs. When a job starts, if the time since the last Full backup is
greater than the specified interval, and the job would normally be an
{\bf Incremental} or {\bf Differential}, it will be automatically
upgraded to a {\bf Full} backup.

\subsection{MaxDiffInterval = \lt{}time-interval\gt{}}
\index[general]{MaxDiffInterval}
The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
can be used to specify the maximum time interval between {\bf Differential} backup
jobs. When a job starts, if the time since the last Differential backup is
greater than the specified interval, and the job would normally be an
{\bf Incremental}, it will be automatically
upgraded to a {\bf Differential} backup.

\subsection{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
\index[general]{MaxDiffInterval}
On FreeBSD systems, each file has a {\bf no dump flag} that can be set
by the user, and when it is set it is an indication to backup programs
to not backup that particular file.  This version of Bacula contains a
new Options directive within a FileSet resource, which instructs Bacula to
obey this flag.  The new directive is:

\begin{verbatim}
  Honor No Dump Flag = yes\vb{}no
\end{verbatim}

The default value is {\bf no}.


\subsection{Exclude Dir Containing = \lt{}filename-string\gt{}}
\index[general]{IgnoreDir}
The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
can be added to the Include section of the FileSet resource.  If the specified
filename ({\bf filename-string}) is found on the Client in any directory to be
backed up, the whole directory will be ignored (not backed up).  For example:

\begin{verbatim}
  # List of files to be backed up
  FileSet {
    Name = "MyFileSet"
    Include {
      Options {
        signature = MD5
      }
      File = /home
      Exclude Dir Containing = .excludeme
    }
  }
\end{verbatim}

But in /home, there may be hundreds of directories of users and some
people want to indicate that they don't want to have certain
directories backed up. For example, with the above FileSet, if
the user or sysadmin creates a file named {\bf .excludeme} in 
specific directories, such as

\begin{verbatim}
   /home/user/www/cache/.excludeme
   /home/user/temp/.excludeme
\end{verbatim}

then Bacula will not backup the two directories named:

\begin{verbatim}
   /home/user/www/cache
   /home/user/temp
\end{verbatim}

NOTE: subdirectories will not be backed up.  That is, the directive
applies to the two directories in question and any children (be they
files, directories, etc).


\subsection{Bacula Plugins}
\index[general]{Plugin}
Support for shared object plugins has been implemented in the Linux, Unix
and Win32 File daemons. The API will be documented separately in
the Developer's Guide or in a new document.  For the moment, there is
a single plugin named {\bf bpipe} that allows an external program to
get control to backup and restore a file.

Plugins are also planned (partially implemented) in the Director and the
Storage daemon.  

\subsubsection{Plugin Directory}
\index[general]{Plugin Directory}
Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
be added to the daemon definition resource. The directory takes a quoted 
string argument, which is the name of the directory in which the daemon can
find the Bacula plugins. If this directive is not specified, Bacula will not
load any plugins. Since each plugin has a distinctive name, all the daemons
can share the same plugin directory. 

\subsubsection{Plugin Options}
\index[general]{Plugin Options}
The {\bf Plugin Options} directive takes a quoted string
argument (after the equal sign) and may be specified in the
Job resource.  The options specified will be passed to all plugins
when they are run.  This each plugin must know what it is looking
for. The value defined in the Job resource can be modified
by the user when he runs a Job via the {\bf bconsole} command line 
prompts.

Note: this directive may be specified, and there is code to modify
the string in the run command, but the plugin options are not yet passed to
the plugin (i.e. not fully implemented).

\subsubsection{Plugin Options ACL}
\index[general]{Plugin Options ACL}
The {\bf Plugin Options ACL} directive may be specified in the
Director's Console resource. It functions as all the other ACL commands
do by permitting users running restricted consoles to specify a 
{\bf Plugin Options} that overrides the one specified in the Job
definition. Without this directive restricted consoles may not modify
the Plugin Options.

\subsubsection{Plugin = \lt{}plugin-command-string\gt{}}
\index[general]{Plugin}
The {\bf Plugin} directive is specified in the Include section of
a FileSet resource where you put your {\bf File = xxx} directives.
For example:

\begin{verbatim}
  FileSet {
    Name = "MyFileSet"
    Include {
      Options {
        signature = MD5
      }
      File = /home
      Plugin = "bpipe:..."
    }
  }
\end{verbatim}

In the above example, when the File daemon is processing the directives
in the Include section, it will first backup all the files in {\bf /home}
then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
the Plugin Directory.  The syntax and semantics of the Plugin directive
require the first part of the string up to the colon (:) to be the name
of the plugin. Everything after the first colon is ignored by the File daemon but
is passed to the plugin. Thus the plugin writer may define the meaning of the
rest of the string as he wishes.

Please see the next section for information about the {\bf bpipe} Bacula
plugin.

\subsection{The bpipe Plugin}
\index[general]{The bpipe Plugin}
The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
the Bacula source distribution. When the plugin is compiled and linking into
the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
Please note that this is a very simple plugin that was written for
demonstration and test purposes. It is and can be used in production, but
that was never really intended.

The purpose of the plugin is to provide an interface to any system program for
backup and restore. As specified above the {\bf bpipe} plugin is specified in
the Include section of your Job's FileSet resource.  The full syntax of the
plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
to specify the sytax as it wishes) is:

\begin{verbatim}
  Plugin = "<field1>:<field2>:<field3>:<field4>"
\end{verbatim}

where
\begin{description}
\item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
stripped off, so in this case, we would put {\bf bpipe} in this field.

\item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
pseudo path and filename under which the backup will be saved. This pseudo
path and filename will be seen by the user in the restore file tree.
For example, if the value is {\bf /MYSQL/regress.sql}, the data
backed up by the plugin will be put under that "pseudo" path and filename.
You must be careful to choose a naming convention that is unique to avoid
a conflict with a path and filename that actually exists on your system.

\item {\bf field3} for the {\bf bpipe} plugin 
specifies the "reader" program that is called by the plugin during
backup to read the data. {\bf bpipe} will call this program by doing a
{\bf popen} on it. 

\item {\bf field4} for the {\bf bpipe} plugin
specifies the "writer" program that is called by the plugin during
restore to write the data back to the filesystem.  
\end{description}

Please note that for two items above describing the "reader" and "writer"
fields, these programs are "executed" by Bacula, which
means there is no shell interpretation of any command line arguments
you might use.  If you want to use shell characters (redirection of input
or output, ...), then we recommend that you put your command or commands
in a shell script and execute the script. In addition if you backup a
file with the reader program, when running the writer program during
the restore, Bacula will not automatically create the path to the file.
Either the path must exist, or you must explicitly do so with your command
or in a shell script.

Putting it all together, the full plugin directive line might look
like the following:

\begin{verbatim}
Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f 
          --opt --databases bacula:mysql"
\end{verbatim}

The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
would be written on a single line.

This causes the File daemon to call the {\bf bpipe} plugin, which will write
its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the 
program {\bf mysqldump -f --opt --database bacula} to read the data during
backup. The mysqldump command outputs all the data for the database named
{\bf bacula}, which will be read by the plugin and stored in the backup.
During restore, the data that was backed up will be sent to the program
specified in the last field, which in this case is {\bf mysql}.  When
{\bf mysql} is called, it will read the data sent to it by the plugn
then write it back to the same database from which it came ({\bf bacula}
in this case).

The {\bf bpipe} plugin is a generic pipe program, that simply transmits 
the data from a specified program to Bacula for backup, and then from Bacula to 
a specified program for restore.

By using different command lines to {\bf bpipe},
you can backup any kind of data (ASCII or binary) depending
on the program called.

\subsection{Microsoft Exchange Server 2003/2007 Plugin}
\index[general]{Microsoft Exchange Server 2003/2007 Plugin}
\subsubsection{Background}
The Exchange plugin was made possible by a funded development project
between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
The code for the plugin was written by James Harper, and the Bacula core
code by Kern Sibbald.  All the code for this funded development has become
part of the Bacula project.  Thanks to everyone who made it happen.

\subsubsection{Concepts}
Although it is possible to backup Exchange using Bacula VSS the Exchange 
plugin adds a good deal of functionality, because while Bacula VSS
completes a full backup (snapshot) of Exchange, it does
not support Incremental or Differential backups, restoring is more
complicated, and a single database restore is not possible.

Microsoft Exchange organises its storage into Storage Groups with
Databases inside them. A default installation of Exchange will have a
single Storage Group called 'First Storage Group', with two Databases
inside it, "Mailbox Store (SERVER NAME)" and 
"Public Folder Store (SERVER NAME)", 
which hold user email and public folders respectively.

In the default configuration, Exchange logs everything that happens to
log files, such that if you have a backup, and all the log files since,
you can restore to the present time. Each Storage Group has its own set
of log files and operates independently of any other Storage Groups. At
the Storage Group level, the logging can be turned off by enabling a
function called "Enable circular logging". At this time the Exchange
plugin will not function if this option is enabled.

The plugin allows backing up of entire storage groups, and the restoring
of entire storage groups or individual databases. Backing up and
restoring at the individual mailbox or email item is not supported but
can be simulated by use of the "Recovery" Storage Group (see below).

\subsubsection{Installing}
The Exchange plugin requires a DLL that is shipped with Microsoft
Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
correctly the Exchange plugin should find this automatically and run
without any additional installation.

If the DLL can not be found automatically it will need to be copied into
the Bacula installation
directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
default Exchange installation.

\subsubsection{Backing Up}
To back up an Exchange server the Fileset definition must contain at
least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
the backup to work correctly. The 'exchange:' bit tells Bacula to look
for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
up files are prefixed with something that isn't going to share a name
with something outside the plugin, and the 'Microsoft Information Store'
bit is required also. It is also possible to add the name of a storage
group to the "Plugin =" line, eg \\
{\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
if you want only a single storage group backed up.

Additionally, you can suffix the 'Plugin =' directive with
":notrunconfull" which will tell the plugin not to truncate the Exchange
database at the end of a full backup.

An Incremental or Differential backup will backup only the database logs
for each Storage Group by inspecting the "modified date" on each
physical log file. Because of the way the Exchange API works, the last
logfile backed up on each backup will always be backed up by the next
Incremental or Differential backup too. This adds 5MB to each
Incremental or Differential backup size but otherwise does not cause any
problems.

By default, a normal VSS fileset containing all the drive letters will
also back up the Exchange databases using VSS. This will interfere with
the plugin and Exchange's shared ideas of when the last full backup was
done, and may also truncate log files incorrectly. It is important,
therefore, that the Exchange database files be excluded from the backup,
although the folders the files are in should be included, or they will
have to be recreated manually if a bare metal restore is done.

\begin{verbatim}
FileSet {
   Include {
      File = C:/Program Files/Exchsrvr/mdbdata
      Plugin = "exchange:..."
   }
   Exclude {
      File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
      File = C:/Program Files/Exchsrvr/mdbdata/E00.log
      File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
      File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
      File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
      File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
      File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
   }
}
\end{verbatim}

The advantage of excluding the above files is that you can significantly
reduce the size of your backup since all the important Exchange files
will be properly saved by the Plugin.


\subsubsection{Restoring}
The restore operation is much the same as a normal Bacula restore, with
the following provisos:

\begin{itemize}
\item  The {\bf Where} restore option must not be specified
\item Each Database directory must be marked as a whole. You cannot just
     select (say) the .edb file and not the others.
\item If a Storage Group is restored, the directory of the Storage Group
     must be marked too.
\item  It is possible to restore only a subset of the available log files,
     but they {\bf must} be contiguous. Exchange will fail to restore correctly
     if a log file is missing from the sequence of log files
\item Each database to be restored must be dismounted and marked as "Can be
    overwritten by restore"
\item If an entire Storage Group is to be restored (eg all databases and
   logs in the Storage Group), then it is best to manually delete the
   database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
   as Exchange can get confused by stray log files lying around.
\end{itemize}

\subsubsection{Restoring to the Recovery Storage Group}
The concept of the Recovery Storage Group is well documented by
Microsoft 
\elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126}, 
but to briefly summarize...

Microsoft Exchange allows the creation of an additional Storage Group
called the Recovery Storage Group, which is used to restore an older
copy of a database (e.g. before a mailbox was deleted) into without
messing with the current live data. This is required as the Standard and
Small Business Server versions of Exchange can not ordinarily have more
than one Storage Group.

To create the Recovery Storage Group, drill down to the Server in Exchange
System Manager, right click, and select
{\bf "New -> Recovery Storage Group..."}.  Accept or change the file
locations and click OK. On the Recovery Storage Group, right click and
select {\bf "Add Database to Recover..."} and select the database you will
be restoring.

Restore only the single database nominated as the database in the
Recovery Storage Group. Exchange will redirect the restore to the
Recovery Storage Group automatically.
Then run the restore.

\subsubsection{Restoring on Microsoft Server 2007}
Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2007, and hence you use a new procedure for recovering a single mail box.
This procedure is documented by Microsoft at:
\elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
and involves using the {\bf Restore-Mailbox} and {\bf
Get-Mailbox Statistics} shell commands.

\subsubsection{Caveats}
This plugin is still being developed, so you should consider it
currently in BETA test, and thus use in a production environment
should be done only after very careful testing.

When doing a full backup, the Exchange database logs are truncated by
Exchange as soon as the plugin has completed the backup. If the data
never makes it to the backup medium (eg because of spooling) then the
logs will still be truncated, but they will also not have been backed
up. A solution to this is being worked on. You will have to schedule a
new Full backup to ensure that your next backups will be usable.

The "Enable Circular Logging" option cannot be enabled or the plugin
will fail.

Exchange insists that a successful Full backup must have taken place if
an Incremental or Differential backup is desired, and the plugin will
fail if this is not the case. If a restore is done, Exchange will
require that a Full backup be done before an Incremental or Differential
backup is done.

The plugin will most likely not work well if another backup application
(eg NTBACKUP) is backing up the Exchange database, especially if the
other backup application is truncating the log files.

The Exchange plugin has not been tested with the {\bf Accurate} option, so
we recommend either carefully testing or that you avoid this option for
the current time.

The Exchange plugin is not called during processing the bconsole {\bf
estimate} command, and so anything that would be backed up by the plugin
will not be added to the estimate total that is displayed.


\subsection{libdbi Framework}
\index[general]{libdbi Framework}
As a general guideline, Bacula has support for a few catalog database drivers
(MySQL, PostgreSQL, SQLite)
coded natively by the Bacula team.  With the libdbi implementation, which is a
Bacula driver that uses libdbi to access the catalog, we have an open field to
use many different kinds database engines following the needs of users.

The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
implements a database-independent abstraction layer in C, similar to the
DBI/DBD layer in Perl. Writing one generic set of code, programmers can
leverage the power of multiple databases and multiple simultaneous database
connections by using this framework.

Currently the libdbi driver in Bacula project only supports the same drivers
natively coded in Bacula.  However the libdbi project has support for many
others database engines. You can view the list at
http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
supported by Bacula, however, they must be tested properly by the Bacula team.

Some of benefits of using libdbi are:
\begin{itemize}
\item The possibility to use proprietary databases engines in which your
  proprietary licenses prevent the Bacula team from developing the driver.
 \item The possibility to use the drivers written for the libdbi project.
 \item The possibility to use other database engines without recompiling Bacula
   to use them.  Just change one line in bacula-dir.conf
 \item Abstract Database access, this is, unique point to code and profiling
   catalog database access.
 \end{itemize}
 
 The following drivers have been tested:
 \begin{itemize}
 \item PostgreSQL, with and without batch insert
 \item Mysql, with and without batch insert
 \item SQLite
 \item SQLite3
 \end{itemize}

 In the future, we will test and approve to use others databases engines
 (proprietary or not) like DB2, Oracle, Microsoft SQL.

 To compile Bacula to support libdbi we need to configure the code with the
 --with-dbi and --with-dbi-driver=[database] ./configure options, where
 [database] is the database engine to be used with Bacula (of course we can
 change the driver in file bacula-dir.conf, see below).  We must configure the
 access port of the database engine with the option --with-db-port, because the
 libdbi framework doesn't know the default access port of each database.

The next phase is checking (or configuring) the bacula-dir.conf, example:
\begin{verbatim}
Catalog {
  Name = MyCatalog
  dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
  dbname = regress; user = regress; password = ""
}
\end{verbatim}

The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
mysql database.  Currently the drivers supported by Bacula are: postgresql,
mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".

The following limitations apply when Bacula is set to use the libdbi framework:
 - Not tested on the Win32 platform
 - A little performance is lost if comparing with native database driver. 
   The reason is bound with the database driver provided by libdbi and the 
   simple fact that one more layer of code was added.

It is important to remember, when compiling Bacula with libdbi, the
following packages are needed:
 \begin{itemize}
  \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
  \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
 \end{itemize}
 
 You can download them and compile them on your system or install the packages
 from your OS distribution.

\subsection{Console Command Additions and Enhancements}
\index[general]{Console Additions}                                 

\subsubsection{Display Autochanger Content}
\index[general]{StatusSlots}

The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
autochanger content.

\footnotesize
\begin{verbatim}
 Slot |  Volume Name  |  Status  |  Media Type       |   Pool     |
------+---------------+----------+-------------------+------------|
    1 |         00001 |   Append |  DiskChangerMedia |    Default |
    2 |         00002 |   Append |  DiskChangerMedia |    Default |
    3*|         00003 |   Append |  DiskChangerMedia |    Scratch |
    4 |               |          |                   |            |
\end{verbatim}
\normalsize

If you an asterisk ({\bf *}) appears after the slot number, you must run an
{\bf update slots} command to synchronize autochanger content with your
catalog.

\subsubsection{list joblog job=xxx or jobid=nnn}
\index[general]{list joblog}
A new list command has been added that allows you to list the contents
of the Job Log stored in the catalog for either a Job Name (fully qualified)
or for a particular JobId.  The {\bf llist} command will include a line with
the time and date of the entry.

Note for the catalog to have Job Log entries, you must have a directive 
such as:

\begin{verbatim}
  catalog = all
\end{verbatim}

In your Director's {\bf Messages} resource.

\subsubsection{Use separator for multiple commands}
\index[general]{Command Separator}
  When using bconsole with readline, you can set the command separator with 
  \textbf{@separator} command to one
  of those characters to write commands who require multiple input in one line.
\begin{verbatim}
  !$%&'()*+,-/:;<>?[]^`{|}~
\end{verbatim}

\subsubsection{Deleting Volumes}
The delete volume bconsole command has been modified to
require an asterisk (*) in front of a MediaId otherwise the
value you enter is a taken to be a Volume name. This is so that
users may delete numeric Volume names. The previous Bacula versions
assumed that all input that started with a number was a MediaId.

This new behavior is indicated in the prompt if you read it
carefully.

\subsection{Bare Metal Recovery}
The old bare metal recovery project is essentially dead. One
of the main features of it was that it would build a recovery
CD based on the kernel on your system. The problem was that
every distribution has a different boot procedure and different 
scripts, and worse yet, the boot procedures and scripts change
from one distribution to another.  This meant that maintaining
(keeping up with the changes) the rescue CD was too much work.

To replace it, a new bare metal recovery USB boot stick has been developed
by Bacula Systems.  This technology involves remastering a Ubuntu LiveCD to
boot from a USB key.  

Advantages: 
\begin{enumerate} 
\item Recovery can be done from within graphical environment.  
\item Recovery can be done in a shell.  
\item Ubuntu boots on a large number of Linux systems.  
\item The process of updating the system and adding new
   packages is not too difficult. 
\item The USB key can easily be upgraded to newer Ubuntu versions.
\item The USB key has writable partitions for modifications to
   the OS and for modification to your home directory.
\item You can add new files/directories to the USB key very easily.
\item You can save the environment from multiple machines on
   one USB key.
\item Bacula Systems is funding its ongoing development.
\end{enumerate}

The disadvantages are:
\begin{enumerate}
\item The USB key is usable but currently under development.
\item Not everyone may be familiar with Ubuntu (no worse
  than using Knoppix)
\item Some older OSes cannot be booted from USB. This can
   be resolved by first booting a Ubuntu LiveCD then plugging
   in the USB key.
\item Currently the documentation is sketchy and not yet added
   to the main manual. See below ...
\end{enumerate}

The documentation and the code can be found in the {\bf rescue} package
in the directory {\bf linux/usb}.

\subsection{Miscellaneous}
\index[general]{Misc New Features}

\subsubsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
\index[general]{Allow Mixed Priority}
   This directive is only implemented in version 2.5 and later.  When
   set to {\bf yes} (default {\bf no}), this job may run even if lower
   priority jobs are already running.  This means a high priority job
   will not have to wait for other jobs to finish before starting.
   The scheduler will only mix priorities when all running jobs have
   this set to true.

   Note that only higher priority jobs will start early.  Suppose the
   director will allow two concurrent jobs, and that two jobs with
   priority 10 are running, with two more in the queue.  If a job with
   priority 5 is added to the queue, it will be run as soon as one of
   the running jobs finishes.  However, new priority 10 jobs will not
   be run until the priority 5 job has finished.

\subsubsection{Bootstrap File Directive -- FileRegex}
\index[general]{Bootstrap File Directive}
  {\bf FileRegex} is a new command that can be added to the bootstrap
  (.bsr) file.  The value is a regular expression.  When specified, only
  matching filenames will be restored.

  During a restore, if all File records are pruned from the catalog
  for a Job, normally Bacula can restore only all files saved. That
  is there is no way using the catalog to select individual files.
  With this new feature, Bacula will ask if you want to specify a Regex
  expression for extracting only a part of the full backup.

\begin{verbatim}
  Building directory tree for JobId(s) 1,3 ...
  There were no files inserted into the tree, so file selection
  is not possible.Most likely your retention policy pruned the files
  
  Do you want to restore all the files? (yes\vb{}no): no
  
  Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
  Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
\end{verbatim}

\subsubsection{Bootstrap File Optimization Changes}
In order to permit proper seeking on disk files, we have extended the bootstrap
file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
address range and end address range respectively.  These two directives replace
the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
  VolEndBlock} directives.  Bootstrap files containing the old directives will
still work, but will not properly take advantage of proper disk seeking, and
may read completely to the end of a disk volume during a restore.  With the new
format (automatically generated by the new Director), restores will seek
properly and stop reading the volume when all the files have been restored.

\subsubsection{Solaris ZFS/NFSv4 ACLs}
This is an upgrade of the previous Solaris ACL backup code
to the new library format, which will backup both the old
POSIX(UFS) ACLs as well as the ZFS ACLs.

The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
(it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
be used to transfer from UFS to ZFS filesystems.


\subsubsection{Virtual Tape Emulation}
\index[general]{Virtual Tape Emulation}
We now have a Virtual Tape emulator that allows us to run though 99.9\% of
the tape code but actually reading and writing to a disk file. Used with the
\textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
and 700 slots. This feature is most useful in testing.  It is enabled
by using {\bf Device Type = vtape} in the Storage daemon's Device
directive. This feature is only implemented on Linux machines and should not be
used for production.

\subsubsection{Bat Enhancements}
\index[general]{Bat Enhancements}
Bat (the Bacula Administration Tool) GUI program has been significantly
enhanced and stabilized. In particular, there are new table based status 
commands; it can now be easily localized using Qt4 Linguist.

The Bat communications protocol has been significantly enhanced to improve
GUI handling. Note, you {\bf must} use a the bat that is distributed with
the Director you are using otherwise the communications protocol will not
work.

\subsubsection{RunScript Enhancements}
\index[general]{RunScript Enhancements}
The {\bf RunScript} resource has been enhanced to permit multiple
commands per RunScript.  Simply specify multiple {\bf Command} directives
in your RunScript.

\begin{verbatim}
Job {
  Name = aJob
  RunScript {
    Command = "/bin/echo test"
    Command = "/bin/echo an other test"
    Command = "/bin/echo 3 commands in the same runscript"
    RunsWhen = Before
  }
 ...
}
\end{verbatim}

A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
implemented, which runs the command after the Volume Shadow Copy has been made.

Console commands can be specified within a RunScript by using:
{\bf Console = \lt{}command\gt{}}, however, this command has not been 
carefully tested and debugged and is known to easily crash the Director.
We would appreciate feedback.  Due to the recursive nature of this command, we
may remove it before the final release.

\subsubsection{Status Enhancements}
\index[general]{Status Enhancements}
The bconsole {\bf status dir} output has been enhanced to indicate
Storage daemon job spooling and despooling activity.

\subsubsection{Connect Timeout}
\index[general]{Connect Timeout}
The default connect timeout to the File
daemon has been set to 3 minutes. Previously it was 30 minutes.

\subsubsection{ftruncate for NFS Volumes}
\index[general]{ftruncate for NFS Volumes}
If you write to a Volume mounted by NFS (say on a local file server),
in previous Bacula versions, when the Volume was recycled, it was not
properly truncated because NFS does not implement ftruncate (file 
truncate). This is now corrected in the new version because we have
written code (actually a kind user) that deletes and recreates the Volume,
thus accomplishing the same thing as a truncate.

\subsubsection{Support for Ubuntu}
The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
version of Linux, and thus now provides correct autostart routines.
Since Ubuntu officially supports Bacula, you can also obtain any
recent release of Bacula from the Ubuntu repositories.

\subsubsection{Recycle Pool = \lt{}pool-name\gt{}}
\index[general]{Recycle Pool}
The new \textbf{RecyclePool} directive defines to which pool the Volume will
be placed (moved) when it is recycled. Without this directive, a Volume will
remain in the same pool when it is recycled. With this directive, it can be
moved automatically to any existing pool during a recycle. This directive is
probably most useful when defined in the Scratch pool, so that volumes will
be recycled back into the Scratch pool.

\subsubsection{FD Version}
\index[general]{FD Version}
The File daemon to Director protocol now includes a version 
number, which although there is no visible change for users, 
will help us in future versions automatically determine
if a File daemon is not compatible.

\subsubsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
\index[general]{Max Run Sched Time}
The time specifies the maximum allowed time that a job may run, counted from
when the job was scheduled. This can be useful to prevent jobs from running
during working hours. We can see it like \texttt{Max Start Delay + Max Run
  Time}.

\subsubsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
\index[general]{Max Wait Time}
Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
of checking the maximum allowed time that a job may block for a resource,
those directives worked like \textbf{MaxRunTime}. Some users are reporting to
use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
their job depending on the level. Now, they have to use
\textbf{Incr/Diff/Full Max Run Time}.  \textbf{Incr/Diff/Full Max Wait Time}
directives are now deprecated.

\subsubsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}} 
\index[general]{Incremental Max Wait Time}
\index[general]{Differential Max Wait Time}

These directives have been deprecated in favor of
\texttt{Incremental|Differential Max Run Time}.

\subsubsection{Max Run Time directives}
\index[general]{Max Run Time directives}
Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
maximum allowed time that a job can run depending on the level.

\addcontentsline{lof}{figure}{Job time control directives}
\begin{center}
\includegraphics[width=\linewidth]{different_time}
\end{center}

\subsubsection{Statistics Enhancements}
\index[general]{Statistics Enhancements}
If you (or probably your boss) want to have statistics on your backups to
provide some \textit{Service Level Agreement} indicators, you could use a few
SQL queries on the Job table to report how many:

\begin{itemize}
\item jobs have run
\item jobs have been successful
\item files have been backed up
\item ...
\end{itemize}

However, these statistics are accurate only if your job retention is greater
than your statistics period. Ie, if jobs are purged from the catalog, you won't
be able to use them. 

Now, you can use the \textbf{update stats [days=num]} console command to fill
the JobHistory table with new Job records. If you want to be sure to take in
account only \textbf{good jobs}, ie if one of your important job has failed but
you have fixed the problem and restarted it on time, you probably want to
delete the first \textit{bad} job record and keep only the successful one. For
that simply let your staff do the job, and update JobHistory table after two or
three days depending on your organization using the \textbf{[days=num]} option.

These statistics records aren't used for restoring, but mainly for
capacity planning, billings, etc.

The Bweb interface provides a statistics module that can use this feature. You
can also use tools like Talend or extract information by yourself.

The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
the length of time that Bacula will keep statistics job records in the Catalog
database after the Job End time. (In \texttt{JobHistory} table) When this time
period expires, and if user runs \texttt{prune stats} command, Bacula will
prune (remove) Job records that are older than the specified period.

You can use the following Job resource in your nightly \textbf{BackupCatalog}
job to maintain statistics.
\begin{verbatim}
Job {
  Name = BackupCatalog
  ...
  RunScript {
    Console = "update stats days=3"
    Console = "prune stats yes"
    RunsWhen = After
    RunsOnClient = no
  }
}
\end{verbatim}

\subsubsection{ScratchPool = \lt{}pool-resource-name\gt{}}
\index[general]{ScratchPool}
This directive permits to specify a specific \textsl{Scratch} pool for the
current pool. This is useful when using multiple storage sharing the same
mediatype or when you want to dedicate volumes to a particular set of pool.

\subsubsection{Enhanced Attribute Despooling}
\index[general]{Attribute Despooling}
If the storage daemon and the Director are on the same machine, the spool file
that contains attributes is read directly by the Director instead of being
transmitted across the network. That should reduce load and speedup insertion.

\subsubsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
\index[general]{SpoolSize}
A new Job directive permits to specify the spool size per job. This is used
in advanced job tunning. {\bf SpoolSize={\it bytes}}

\subsubsection{MaximumConsoleConnections = \lt{}number\gt{}}
\index[general]{MaximumConsoleConnections}
A new director directive permits to specify the maximum number of Console
Connections that could run concurrently. The default is set to 20, but you may
set it to a larger number.

\subsubsection{VerId = \lt{}string\gt{}}
\index[general]{VerId}
A new director directive permits to specify a personnal identifier that will be
displayed in the \texttt{version} command.

\subsubsection{dbcheck enhancements}
\index[general]{dbcheck enhancements}
If you are using Mysql, dbcheck will now ask you if you want to create
temporary indexes to speed up orphaned Path and Filename elimination. 

A new \texttt{-B} option allows you to print catalog information in a simple
text based format. This is useful to backup it in a secure way.

\begin{verbatim}
 $ dbcheck -B 
 catalog=MyCatalog
 db_type=SQLite
 db_name=regress
 db_driver=
 db_user=regress
 db_password=
 db_address=
 db_port=0
 db_socket=
\end{verbatim} %$

You can now specify the database connection port in the command line.

\subsubsection{{-}{-}docdir configure option}
\index[general]{{-}{-}docdir configure option}
You can use {-}{-}docdir= on the ./configure command to
specify the directory where you want Bacula to install the
LICENSE, ReleaseNotes, ChangeLog, ... files.   The default is 
{\bf /usr/share/doc/bacula}.
      
\subsubsection{{-}{-}htmldir configure option}
\index[general]{{-}{-}htmldir configure option}
You can use {-}{-}htmldir= on the ./configure command to
specify the directory where you want Bacula to install the bat html help
files. The default is {\bf /usr/share/doc/bacula/html}

\subsubsection{{-}{-}with-plugindir configure option}
\index[general]{{-}{-}plugindir configure option}
You can use {-}{-}plugindir= on the ./configure command to
specify the directory where you want Bacula to install
the plugins (currently only bpipe-fd). The default is
/usr/lib.