Merge branch 'bareos-16.2'

4 files changed, 106 insertions, 41 deletions

diff --git a/manuals/en/main/bareos.sty b/manuals/en/main/bareos.sty
index df62af9..c82151d 100644
--- a/manuals/en/main/bareos.sty
+++ b/manuals/en/main/bareos.sty
@@ -177,6 +177,10 @@
 \elink{Bareos Regression Testing Base Configuration}{https://github.com/bareos/bareos-regress/tree/master/configs/BASE/}\xspace%
 }
 
+\newcommand{\externalReferenceIsilonNdmpEnvironmentVariables}{%
+\elink{Isilon OneFS 7.2.0 CLI Administration Guide}{https://www.emc.com/collateral/TechnicalDocument/docu56048.pdf}, section \bquote{NDMP environment variables}\xspace%
+}
+
 %
 % special characters
 %
diff --git a/manuals/en/main/dirdconf-fileset.tex b/manuals/en/main/dirdconf-fileset.tex
index 6abd517..2545bbe 100644
--- a/manuals/en/main/dirdconf-fileset.tex
+++ b/manuals/en/main/dirdconf-fileset.tex
@@ -506,30 +506,38 @@ The directives within an Options resource may be one of the following:
 
 
 
- \item [signature={\textless}SHA1{\textbar}MD5{\textgreater}] \hfill \\
+ \item [signature={\textless}MD5{\textbar}SHA1{\textbar}SHA256{\textbar}SHA512{\textgreater}] \hfill \\
+        \index[dir]{signature}%
+        \index[dir]{Directive!signature}%
+It is strongly recommend to use signatures for your backups.
+Note, only one type of signature can be computed per file.
+
     \begin{description}
+        \item [signature=MD5] \hfill \\
+        \index[dir]{MD5}%
+        \index[dir]{signature!MD5}%
+        An MD5 signature will be computed for each files saved.  Adding this
+        option generates about 5\% extra overhead for each file saved.  In
+        addition to the additional CPU time, the MD5 signature adds 16 more
+        bytes per file to your catalog.
+
         \item [signature=SHA1] \hfill \\
-        \index[dir]{signature}
-        \index[dir]{SHA1}
-        \index[dir]{Directive!signature}
-        An SHA1 signature will be computed for all The SHA1 algorithm is
+        \index[dir]{SHA1}%
+        \index[dir]{signature!SHA1}%
+        An SHA1 signature will be computed for each files saved.
+        The SHA1 algorithm is
         purported to be some what slower than the MD5 algorithm, but at the same
         time is significantly better from a cryptographic point of view (i.e.
-        much fewer collisions, much lower probability of being hacked.) It adds
-        four more bytes than the MD5 signature.  We strongly recommend that
-        either this option or MD5 be specified as a default for all files.
-        Note, only one of the two options MD5 or SHA1 can be computed for any
-        file.
+        much fewer collisions).
+        The SHA1 signature requires adds 20 bytes per file to your catalog.
 
-        \item [signature=MD5] \hfill \\
-        \index[dir]{signature}
-        \index[dir]{MD5}
-        \index[dir]{Directive!signature}
-        An MD5 signature will be computed for all files saved.  Adding this
-        option generates about 5\% extra overhead for each file saved.  In
-        addition to the additional CPU time, the MD5 signature adds 16 more
-        bytes per file to your catalog.  We strongly recommend that this option
-        or the SHA1 option be specified as a default for all files.
+        \item [signature=SHA256] \hfill \\
+        \index[dir]{SHA256}%
+        \index[dir]{signature!SHA256}%
+
+        \item [signature=SHA512] \hfill \\
+        \index[dir]{SHA512}%
+        \index[dir]{signature!SHA512}%
     \end{description}
 
 
diff --git a/manuals/en/main/ndmp.tex b/manuals/en/main/ndmp.tex
index dabf8f2..ec35cee 100644
--- a/manuals/en/main/ndmp.tex
+++ b/manuals/en/main/ndmp.tex
@@ -309,35 +309,75 @@ Fileset {
   Name = "NDMP Fileset"
   Include {
     Options {
-        meta = "USE_TBB_IF_AVAILABLE=y"
         meta = "BUTYPE=DUMP"
-        meta = "ENCODING=ISO_8859_1"
-        meta = "RESTORE_HARDLINK_BY_TABLE=y"
+        meta = "USE_TBB_IF_AVAILABLE=y"
         meta = "FH_REPORT_FULL_DIRENTS=y"
+        meta = "RESTORE_HARDLINK_BY_TABLE=y"
     }
     File = /ifs/home
   }
 }
 \end{bconfig}
 
-Use multiple \configdirective{File} directives in \linkResourceDirective{Dir}{FileSet}{Include} to backup multiple directories.
-
-\warning{Some NDMP environment variables are set automatically by the DMA in the director and should NOT be
-set by the user. The following environment variables are currently set automatically:
-\begin{itemize}
-    \item HIST
-    \item TYPE
-    \item DIRECT
-    \item LEVEL
-    \item UPDATE
-    \item EXCLUDE
-    \item INCLUDE
-    \item FILESYSTEM
-    \item PREFIX
-\end{itemize}}
+% meta = "ENCODING=ISO_8859_1"
 
 \warning{Normally (\linkResourceDirective{Dir}{Client}{Protocol}=Native) Filesets get handled by the \bareosFd. When connecting directly to a NDMP Clients (\linkResourceDirective{Dir}{Client}{Protocol}=NDMP*), no \bareosFd is involved and therefore most Fileset options can't be used. Instead, parameters are handled via \configdirective{Options - Meta} from \linkResourceDirective{Dir}{FileSet}{Include}.}
 
+\warning{Avoid using multiple \linkResourceDirective{Dir}{FileSet}{Include} \configdirective{File} directives.
+The \bareosDir would try to handle them by running multiple NDMP jobs in a single Bareos job.
+Even if this is working fine during backup, restore jobs will cause trouble.}
+
+Some NDMP environment variables are set automatically by the DMA in the \bareosDir.
+The following environment variables are currently set automatically:
+\begin{description}
+    \item[FILESYSTEM] is set to the \linkResourceDirective{Dir}{FileSet}{Include} \configdirective{File} directive.
+    \item[HIST] = Y \\
+        Specifies the file history format:
+        \begin{description}
+        \item[Y] Specifies the default file history format determined by your NDMP backup settings.
+        \item[N] Disables file history. Without file hostory, single file restore is not possible with Bareos.
+        \end{description}
+        Some NDMP environments (eg. Isilon OneFS) allow additional parameter:
+        \begin{description}
+        \item[F] Specifies path-based file history. This is the most efficient with Bareos.
+            % because it don't require to temporary store information in LMDB
+        \item[D] Specifies directory or node file history.
+        \end{description}
+    \item[LEVEL] is set accordingly to \nameref{sec:NdmpBackupLevel}.
+    \item[PREFIX]
+    \item[TYPE] is set accordingly to BUTYPE. Default \bquote{DUMP}.
+    \item[UPDATE] = Y
+\end{description}
+
+\subsubsection{Example NDMP Fileset to backup a subset of a NDMP filesystem}
+
+The following fileset is intended to backup all files and directories matching \path|/ifs/home/users/a*|.
+It has been tested against Isilon OneFS 7.2.0.1.
+See \externalReferenceIsilonNdmpEnvironmentVariables for details about the supported NDMP environment variables.
+Excludes are not used in this example.
+
+\begin{bconfig}{NDMP Fileset Isilon Include/Exclude}
+Fileset {
+  Name = "isilon_fileset_home_a"
+  Include {
+    Options {
+        meta = "BUTYPE=DUMP"
+        meta = "USE_TBB_IF_AVAILABLE=y"
+
+        #
+        # EXCLUDE
+        #
+        #meta = "EXCLUDE=[b-z]*"
+
+        #
+        # INCLUDE
+        #
+        meta = "FILES=a*"
+    }
+    File = /ifs/home/users
+  }
+}
+\end{bconfig}
 
 \subsection{Bareos Director: Configure NDMP Jobs}
 
@@ -523,6 +563,7 @@ One NDMP main backup file is created for every directory specified in the used F
 The other files show the file history and are hardlinks to the backup file.
 
 \subsection{NDMP Backup Level}
+\label{sec:NdmpBackupLevel}
 \index[general]{NDMP!Level}
 The trailing number in the main backup file (after the \path|%| character)
 indicates the NDMP backup level:
@@ -923,6 +964,16 @@ This will create a lot of debugging output that will help to find the problem du
 
 \section{Limitations}
 
+\subsection{NDMP Fileset limitations}
+
+\limitation*{NDMP}{A NDMP fileset should only contain a single File directive and Meta options}{%
+Using multiple \linkResourceDirective{Dir}{FileSet}{Include} \configdirective{File} directives should be avoided.
+The \bareosDir would try to handle them by running multiple NDMP jobs in a single Bareos job.
+Even if this is working fine during backup, restore jobs will cause trouble.
+
+Normally (\linkResourceDirective{Dir}{Client}{Protocol}=Native) Filesets get handled by the \bareosFd. When connecting directly to a NDMP Clients (\linkResourceDirective{Dir}{Client}{Protocol}=NDMP*), no \bareosFd is involved and therefore most Fileset options can't be used. Instead, parameters are handled via \configdirective{Options - Meta} from \linkResourceDirective{Dir}{FileSet}{Include}.
+}
+
 \subsection{NDMP Job limitations when scanning in volumes}
 \label{sec:ndmp-filehistory}
 \index[general]{NDMP!File History}
@@ -968,10 +1019,11 @@ Bareos NDMP support have been tested against:
 
 \begin{tabular}{l | l | l | l | l | l}
 \hline
-Vendor     & Product                       & NDMP Subsystem & Bareos version & Features & Remarks \\
+Vendor     & Product                       & NDMP Subsystem       & Bareos version & Features & Remarks \\
 \hline
-Isilon     & Isilon OneFS v7.1.1.5         & Isilon NDMP 2.2      & bareos-15.2.2 & & \\
-NetApp     &                               & Release 8.2.3 7-Mode & bareos-15.2.2 & & \\
-Oracle/Sun & ZFS Storage Appliance, OS 8.3 &                      & bareos-15.2.2 & & \\
+Isilon     & Isilon OneFS v7.2.0.1         & Isilon NDMP 2.2      & bareos-16.2.6  &          & \\
+Isilon     & Isilon OneFS v7.1.1.5         & Isilon NDMP 2.2      & bareos-15.2.2  &          & \\
+NetApp     &                               & Release 8.2.3 7-Mode & bareos-15.2.2  &          & \\
+Oracle/Sun & ZFS Storage Appliance, OS 8.3 &                      & bareos-15.2.2  &          & \\
 \hline
 \end{tabular}
diff --git a/manuals/en/main/webui.tex b/manuals/en/main/webui.tex
index 561196f..a235d0c 100644
--- a/manuals/en/main/webui.tex
+++ b/manuals/en/main/webui.tex
@@ -49,6 +49,7 @@ Since \sinceVersion{dir}{bareos-webui}{15.2.0} bareos-webui is part of the Bareo
 \item The \bareosWebui can be installed on any host. It does not have to be installed on the same as the \bareosDir.
 \item The default installation uses an Apache 2.x webserver with mod-rewrite, mod-php5 and mod-setenv.
 \item PHP $>$= 5.3.23
+\item On SUSE Linux Enterprise 12 you need the additional SUSE Linux Enterprise Module for Web Scripting 12.
 \end{itemize}
 
 \subsection{Version $<$ 16.2}