%% bacula.sty
%% Provides macros and other stuff for the bacula manual
-%%
+%%
%% Original Creation -- K. Cunningham 2005-01-09
-%%
-%%
-%%
+%%
+%%
+%%
%% New Commands Currently implemented:
-%%
+%%
%% \elink{target}{text}
%% Inserts the text indicated (highlighted) and provides
%% an external hyperlink to the target.
-%%
-%%
+%%
+%%
%% \ilink{target}{text}
%% Inserts the text indicated (highlighted) and provides
%% an internal hyperlink to the target. Target must be a
%% \label somewhere in the same document.
-%%
+%%
%% \lt
%% Inserts a less-than character (<).
%%
%% \idir
%% Inserts the path to the images
%%
-%%
-%%
+%%
+%%
\ProvidesPackage{bacula}[2008/10/03]
%%
%%
%% define images directory -- KES 15Aug08
-\def\idir{@BUILD_DIR@/images/} %% images directory
-
+\def\idir{}%%%@BUILD_DIR@/images/} %% images directory
+\graphicspath{{../../../images/pdf/}{../../../images/png/}{../../../images/}}
+\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}
+\usepackage{multirow}
+\def\arraystretch{1.5}
+\pdfminorversion=4
\def\version{@VERSION@}
+\newenvironment{bsysitemize}{\renewcommand\labelitemi{\textcolor{bsysredtwo}{\ensuremath{\filledsquare}}}\renewcommand\labelitemii{\textcolor{bsysredtwo}{--}}\begin{itemize}}{\end{itemize}}
%%%
%%% Philippe Chauvat
%%% 01-Oct-2012
\def\mbacula{Bacula Enterprise}
-\def\miscman{Misc \mbacula{} Manual}
-\def\consoleman{Console \mbacula{} Manual}
-\def\mainman{Main \mbacula{} Manual}
-\def\devman{Developers \mbacula{} Manual}
-\definecolor{bsysredtwo}{cmyk}{0., 1., 0.87, 0.06}
+\def\miscman{\mbacula{} Misc Manual}
+\def\consoleman{\mbacula{} Console Manual}
+\def\mainman{\mbacula{} Main Manual}
+\def\devman{\mbacula{} Developers Manual}
+\def\utilityman{\mbacula{} Utility programs}
+\def\problemsman{\mbacula{} Problem Resolution Guide}
+\definecolor{bsysred}{cmyk}{0., 0.8, 0.79, 0.36}
+\definecolor{bsysgrey}{cmyk}{0.03, 0.02, 0., 0.60 }
\definecolor{lightbsysgrey}{cmyk}{0.00, 0.00, 0., 0.10 }
+\definecolor{bsysdarkgrey}{cmyk}{0.0, 0.03, 0.01, 0.90 }
+\definecolor{bsysredtwo}{cmyk}{0., 1., 0.87, 0.06}
%%
%% A.1.b.ii enumerate
\newenvironment{Aenumerate}[0]{%
%%% will display
%%% Console Configuration chapter (chapter 30 on page 269)
\newcommand*{\bsysxrlink}[4]{%
- \href{../#3/#3}{#1 #4 (#4 \vref{#3-#2})}
+ \href{../#3/#3}{\textcolor{bsysgrey}{\textbf{#1}} #4 (#4 \vref{#3-#2})}
+}
+\newcommand*{\bsysxrlinkdocument}[4]{%
+ \href{../#3/#3}{\textcolor{bsysgrey}{\textbf{#1}} (#4 \vref{#3-#2})}
+}
+%%%
+%%% Include a graphic, horizontally
+%%% Parameters:
+%%% #1: image filename, witout extension
+%%% #2: Caption
+%%%
+%%% A label is automatically added. The name
+%%% bsysimg-image_filename
+\newcommand*{\bsysimageN}[3]{
+ \begin{figure}[htpb]
+ \begin{center}
+ \includegraphics{#1}
+ \caption{#2}\ifthenelse{\equal{#3}{}}{\label{bsysimg-#1}}{\label{#3}}
+ \end{center}
+ \end{figure}
+}
+\newcommand*{\bsysimageH}[3]{
+ \begin{figure}[htpb]
+ \begin{center}
+ \includegraphics[width=0.95\linewidth]{#1}
+ \caption{#2}\ifthenelse{\equal{#3}{}}{\label{bsysimg-#1}}{\label{#3}}
+ \end{center}
+ \end{figure}
+}
+%%%
+%%% Include a graphic, vertically
+%%% Parameters:
+%%% #1: image filename, witout extension
+%%% #2: Caption
+%%%
+%%% A label is automatically added. The name
+%%% bsysimg-image_filename
+\newcommand*{\bsysimageV}[3]{
+ \begin{figure}[htpb]
+ \begin{center}
+ \includegraphics[height=0.95\linewidth]{#1}
+ \caption{#2}\ifthenelse{\equal{#3}{}}{\label{bsysimg-#1}}{\label{#3}}
+ \end{center}
+ \end{figure}
}
%%%
%%% --- PCT
-
-
-%%
\newcommand*{\elink}[2]{%
- \htmladdnormallink{#1}{#2}%
+ %\htmladdnormallink{#1}{#2}%
+ \href{#2}{#1}
}
%%
\newcommand*{\ilink}[2]{%
- \htmlref{#1}{#2}%
+ \htmlref{\textcolor{bsysredtwo}{#1}}{#2}%
+% #1 (cf. \vref{#2})%\htmlref{#1}{#2}%
+}
+\newcommand*{\bsysref}[1]{%
+ \vref{#1}
}
%%
\newcommand{\dq}{\verb+"+}
\let\item\@idxitem}
{\if@restonecol\onecolumn\else\clearpage\fi} %% Is this needed???
-%%
+%%
\endinput
-%%
+%%
DOC=main
MAINDOC=Bacula_Main_Reference.html
+BSYSMANUALDIR=../../../bsysmanual
+COVERSDIR=../../../covers/pdf
+LICENSESDIR=../../licences
+COVERNAME=main-coverpage
+BSYSMANNAME=bsysmanual-coverpagebackground
+LICENCES=$(wildcard $(LICENSESDIR)/*.tex)
first_rule: all
all: tex web dvipdf mini-clean
-.SUFFIXES: .tex .html
+.SUFFIXES: .tex .html .svg
.PHONY:
.DONTCARE:
-tex:
+pdfcovers:
+ @echo -n "Linking coverpage and background PDF format..."
+ @ln -sf `pwd`/${COVERSDIR}/${COVERNAME}.pdf `pwd`/${BSYSMANUALDIR}/${BSYSMANNAME}.pdf
+ @echo "Done."
+
+pdfimages:
+ @echo "Generating PDF images..."
+ @(cd ${IMAGES}/svg ; make pdf)
+ @echo "Done."
+
+pngimages:
+ @echo "Generating PNG images..."
+ @(cd ${IMAGES}/svg ; make png)
+ @echo "Done."
+
+epsimages:
+ @echo "Generating EPS images..."
+ @(cd ${IMAGES}/svg ; make eps)
+ @echo "Done."
+
+epscovers:
+ @echo -n "Linking coverpage and background EPS format..."
+ @(if [ ! -e ${COVERNAME}.eps ]; then \
+ cd ${COVERSDIR} ;
+ pdf2ps ${COVERNAME}.pdf;
+ ps2eps ${COVERNAME}.ps;
+ rm ${COVERNAME}.ps;
+ fi)
+ @ln -sf `pwd`/${COVERSDIR}/${COVERNAME}.eps `pwd`/${BSYSMANUALDIR}/${BSYSMANNAME}.eps
+ @echo "Done."
+
+commonfiles:
+ @echo -n "Linking shared files..."
+ @(for L in $(LICENCES); do ln -sf $$L .; done)
+ @echo "Done"
+
+tex: epscovers
@../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@cp -fp ${IMAGES}/hires/*.eps .
dvipdfm -p a4 ${DOC}.dvi
+pdflatex: pdfcovers pdfimages commonfiles
+ pdflatex -interaction=batchmode ${DOC}.tex
+ makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null
+ makeindex ${DOC}.ddx -o ${DOC}.dnd >/dev/null 2>/dev/null
+ makeindex ${DOC}.fdx -o ${DOC}.fnd >/dev/null 2>/dev/null
+ makeindex ${DOC}.sdx -o ${DOC}.snd >/dev/null 2>/dev/null
+ makeindex ${DOC}.cdx -o ${DOC}.cnd >/dev/null 2>/dev/null
+ pdflatex -interaction=batchmode ${DOC}.tex
+ pdflatex -interaction=batchmode ${DOC}.tex
+
dvipdf:
@echo "Making dvi to pdf"
@cp -fp ${IMAGES}/hires/*.eps .
-
\chapter{ANSI and IBM Tape Labels}
\label{AnsiLabelsChapter}
-\index[general]{ANSI and IBM Tape Labels}
+\index[general]{ANSI and IBM Tape Labels}
\index[general]{Labels!Tape}
-Bacula supports ANSI or IBM tape labels as long as you
+\mbacula{} supports ANSI or IBM tape labels as long as you
enable it. In fact, with the proper configuration, you can
-force Bacula to require ANSI or IBM labels.
+force \mbacula{} to require ANSI or IBM labels.
-Bacula can create an ANSI or IBM label, but if Check Labels is
-enabled (see below), Bacula will look for an existing label, and
+\mbacula{} can create an ANSI or IBM label, but if Check Labels is
+enabled (see below), \mbacula{} will look for an existing label, and
if it is found, it will keep the label. Consequently, you
-can label the tapes with programs other than Bacula, and Bacula
+can label the tapes with programs other than \mbacula{}, and \mbacula{}
will recognize and support them.
-Even though Bacula will recognize and write ANSI and IBM labels,
+Even though \mbacula{} will recognize and write ANSI and IBM labels,
it always writes its own tape labels as well.
When using ANSI or IBM tape labeling, you must restrict your Volume
-names to a maximum of six characters.
+names to a maximum of six characters.
-If you have labeled your Volumes outside of Bacula, then the
-ANSI/IBM label will be recognized by Bacula only if you have created
+If you have labeled your Volumes outside of \mbacula{}, then the
+ANSI/IBM label will be recognized by \mbacula{} only if you have created
the HDR1 label with {\bf BACULA.DATA} in the Filename field (starting
-with character 5). If Bacula writes the labels, it will use
-this information to recognize the tape as a Bacula tape. This allows
+with character 5). If \mbacula{} writes the labels, it will use
+this information to recognize the tape as a \mbacula{} tape. This allows
ANSI/IBM labeled tapes to be used at sites with multiple machines
and multiple backup programs.
\section{Director Pool Directive}
\begin{description}
-\item [ Label Type = ANSI | IBM | Bacula]
+\item [ Label Type = ANSI | IBM | Bacula]
This directive is implemented in the Director Pool resource and in the SD Device
resource. If it is specified in the SD Device resource, it will take
precedence over the value passed from the Director to the SD. The default
\section{Storage Daemon Device Directives}
\begin{description}
-\item [ Label Type = ANSI | IBM | Bacula]
+\item [ Label Type = ANSI | IBM | Bacula]
This directive is implemented in the Director Pool resource and in the SD Device
resource. If it is specified in the the SD Device resource, it will take
precedence over the value passed from the Director to the SD.
-
+
\item [Check Labels = yes | no]
This directive is implemented in the the SD Device resource. If you intend
to read ANSI or IBM labels, this *must* be set. Even if the volume is
- not ANSI labeled, you can set this to yes, and Bacula will check the
- label type. Without this directive set to yes, Bacula will assume that
+ not ANSI labeled, you can set this to yes, and \mbacula{} will check the
+ label type. Without this directive set to yes, \mbacula{} will assume that
labels are of Bacula type and will not check for ANSI or IBM labels.
- In other words, if there is a possibility of Bacula encountering an
+ In other words, if there is a possibility of \mbacula{} encountering an
ANSI/IBM label, you must set this to yes.
\end{description}
\index[sd]{Resource!Autochanger}
The Autochanger resource supports single or multiple drive
-autochangers by grouping one or more Device resources
+autochangers by grouping one or more Device resources
into one unit called an autochanger in Bacula (often referred to
as a "tape library" by autochanger manufacturers).
conf file, and your Director's Storage directives that want to
use an Autochanger {\bf must} refer to the Autochanger resource name.
In previous versions of Bacula, the Director's Storage directives
-referred directly to Device resources that were autochangers.
+referred directly to Device resources that were autochangers.
In version 1.38.0 and later, referring directly to Device resources
will not work for Autochangers.
\end{description}
-The following is an example of a valid Autochanger resource definition:
+The following is an example of a valid Autochanger resource definition:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Autochanger {
Name = "DDS-4-changer"
Device = DDS-4-1, DDS-4-2, DDS-4-3
Autoselect = no
...
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Please note that it is important to include the {\bf Autochanger = yes} directive
for example, you want to reserve it for restores, you can add the directive:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Autoselect = no
-\end{verbatim}
+\end{lstlisting}
\normalsize
to the Device resource for that drive. In that case, Bacula will not automatically
order to work with an autochanger, Bacula requires a number of things, each of
which is explained in more detail after this list:
-\begin{itemize}
+\begin{bsysitemize}
\item A script that actually controls the autochanger according to commands
sent by Bacula. We furnish such a script that works with {\bf mtx} found in
- the {\bf depkgs} distribution.
+ the {\bf depkgs} distribution.
\item That each Volume (tape) to be used must be defined in the Catalog and
have a Slot number assigned to it so that Bacula knows where the Volume is
before using them.
\item Modifications to your Storage daemon's Device configuration resource to
- identify that the device is a changer, as well as a few other parameters.
+ identify that the device is a changer, as well as a few other parameters.
\item You should also modify your Storage resource definition in the
Director's configuration file so that you are automatically prompted for the
- Slot when labeling a Volume.
+ Slot when labeling a Volume.
\item You need to ensure that your Storage daemon (if not running as root)
has access permissions to both the tape drive and the control device.
\item You need to have {\bf Autochanger = yes} in your Storage resource
in your bacula-dir.conf file so that you will be prompted for the
slot number when you label Volumes.
-\end{itemize}
+\end{bsysitemize}
In version 1.37 and later, there is a new \ilink{Autochanger
resource}{AutochangerRes} that permits you to group Device resources thus
creating a multi-drive autochanger. If you have an autochanger,
-you {\bf must} use this new resource.
+you {\bf must} use this new resource.
Bacula uses its own {\bf mtx-changer} script to interface with a program
that actually does the tape changing. Thus in principle, {\bf mtx-changer}
Bacula also supports autochangers with barcode
readers. This support includes two Console commands: {\bf label barcodes}
and {\bf update slots}. For more details on these commands, see the "Barcode
-Support" section below.
+Support" section below.
Current Bacula autochanger support does not include cleaning, stackers, or
silos. Stackers and silos are not supported because Bacula expects to
be able to access the Slots randomly.
However, if you are very careful to setup Bacula to access the Volumes
in the autochanger sequentially, you may be able to make Bacula
-work with stackers (gravity feed and such).
+work with stackers (gravity feed and such).
Support for multi-drive
autochangers requires the \ilink{Autochanger resource}{AutochangerRes}
In principle, if {\bf mtx} will operate your changer correctly, then it is
just a question of adapting the {\bf mtx-changer} script (or selecting one
already adapted) for proper interfacing. You can find a list of autochangers
-supported by {\bf mtx} at the following link:
+supported by {\bf mtx} at the following link:
\elink{http://mtx.opensource-sw.net/compatibility.php}
{http://mtx.opensource-sw.net/compatibility.php}.
-The home page for the {\bf mtx} project can be found at:
-\elink{http://mtx.opensource-sw.net/}{http://mtx.opensource-sw.net/}.
+The home page for the {\bf mtx} project can be found at:
+\elink{http://mtx.opensource-sw.net/}{http://mtx.opensource-sw.net/}.
Note, we have feedback from some users that there are certain
incompatibilities between the Linux kernel and mtx. For example between
Bacula is running, please remember that for many distributions (e.g. FreeBSD,
Debian, ...) the Storage daemon runs as {\bf bacula.tape} rather than {\bf
root.root}, so you will need to ensure that the Storage daemon has sufficient
-permissions to access the autochanger.
+permissions to access the autochanger.
Some users have reported that the the Storage daemon blocks under certain
circumstances in trying to mount a volume on a drive that has a different
\index[general]{SCSI devices}
\index[general]{devices!SCSI}
-Under Linux, you can
+Under Linux, you can
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cat /proc/scsi/scsi
-\end{verbatim}
+\end{lstlisting}
\normalsize
-to see what SCSI devices you have available. You can also:
+to see what SCSI devices you have available. You can also:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cat /proc/scsi/sg/device_hdr /proc/scsi/sg/devices
-\end{verbatim}
+\end{lstlisting}
\normalsize
to find out how to specify their control address ({\bf /dev/sg0} for the
first, {\bf /dev/sg1} for the second, ...) on the {\bf Changer Device = }
-Bacula directive.
+Bacula directive.
You can also use the excellent {\bf lsscsi} tool.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
$ lsscsi -g
[1:0:2:0] tape SEAGATE ULTRIUM06242-XXX 1619 /dev/st0 /dev/sg9
[1:0:14:0] mediumx STK L180 0315 /dev/sch0 /dev/sg10
[2:0:3:0] tape HP Ultrium 3-SCSI G24S /dev/st1 /dev/sg11
[3:0:0:0] enclosu HP A6255A HP04 - /dev/sg3
[3:0:1:0] disk HP 36.4G ST336753FC HP00 /dev/sdd /dev/sg4
-\end{verbatim}
+\end{lstlisting}
\normalsize
For more detailed information on what SCSI devices you have please see
-the \ilink{Linux SCSI Tricks}{SCSITricks} section of the Tape Testing
-chapter of this manual.
+the \bsysxrlink{Linux SCSI Tricks}{SCSITricks}{problems}{section} of the
+ \bsysxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the
+ \problemsman{}.
-Under FreeBSD, you can use:
+Under FreeBSD, you can use:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
camcontrol devlist
-\end{verbatim}
+\end{lstlisting}
\normalsize
To list the SCSI devices as well as the {\bf /dev/passn} that you will use on
-the Bacula {\bf Changer Device = } directive.
+the Bacula {\bf Changer Device = } directive.
Please check that your Storage daemon has permission to access this
device.
The following tip for FreeBSD users comes from Danny Butroyd:
-on reboot Bacula will NOT have permission to
-control the device /dev/pass0 (assuming this is your changer device).
-To get around this just edit the /etc/devfs.conf file and add the
-following to the bottom:
+on reboot Bacula will NOT have permission to
+control the device /dev/pass0 (assuming this is your changer device).
+To get around this just edit the /etc/devfs.conf file and add the
+following to the bottom:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
own pass0 root:bacula
perm pass0 0666
own nsa0.0 root:bacula
perm nsa0.0 0666
-\end{verbatim}
+\end{lstlisting}
\normalsize
-This gives the bacula group permission to write to the nsa0.0 device
-too just to be on the safe side. To bring these changes into effect
+This gives the bacula group permission to write to the nsa0.0 device
+too just to be on the safe side. To bring these changes into effect
just run:-
/etc/rc.d/devfs restart
-Basically this will stop you having to manually change permissions on these
+Basically this will stop you having to manually change permissions on these
devices to make Bacula work when operating the AutoChanger after a reboot.
\label{scripts}
\lt{}bacula-src\gt{}/examples/devices} directory where you will find an
example {\bf HP-autoloader.conf} Bacula Device resource, and several {\bf
mtx-changer} scripts that have been modified to work with different
-autochangers.
+autochangers.
\label{Slots}
To properly address autochangers, Bacula must know which Volume is in each
{\bf slot} of the autochanger. Slots are where the changer cartridges reside
when not loaded into the drive. Bacula numbers these slots from one to the
-number of cartridges contained in the autochanger.
+number of cartridges contained in the autochanger.
Bacula will not automatically use a Volume in your autochanger unless it is
labeled and the slot number is stored in the catalog and the Volume is marked
volume. If no slot is given, or the slot is set to zero, Bacula will not
attempt to use the autochanger even if all the necessary configuration records
are present. When doing a {\bf mount} command on an autochanger, you must
-specify which slot you want mounted. If the drive is loaded with a tape
+specify which slot you want mounted. If the drive is loaded with a tape
from another slot, it will unload it and load the correct tape, but
normally, no tape will be loaded because an {\bf unmount} command causes
Bacula to unload the tape in the drive.
-
+
You can check if the Slot number and InChanger flag are set by doing a:
-\begin{verbatim}
+\begin{lstlisting}
list Volumes
-\end{verbatim}
+\end{lstlisting}
in the Console program.
Some autochangers have more than one read/write device (drive). The
new \ilink{Autochanger resource}{AutochangerRes} introduced in version
-1.37 permits you to group Device resources, where each device
+1.37 permits you to group Device resources, where each device
represents a drive. The Director may still reference the Devices (drives)
directly, but doing so, bypasses the proper functioning of the
drives together. Instead, the Director (in the Storage resource)
-should reference the Autochanger resource name. Doing so permits
+should reference the Autochanger resource name. Doing so permits
the Storage daemon to ensure that only one drive uses the mtx-changer
script at a time, and also that two drives don't reference the
same Volume.
need to define a second Device resource and set the Drive Index to 1 for
that device. In general, the second device will have the same {\bf Changer
Device} (control channel) as the first drive, but a different {\bf Archive
-Device}.
+Device}.
As a default, Bacula jobs will prefer to write to a Volume that is
already mounted. If you have a multiple drive autochanger and you want
Configuration of autochangers within Bacula is done in the Device resource of
the Storage daemon. Four records: {\bf Autochanger}, {\bf Changer Device},
{\bf Changer Command}, and {\bf Maximum Changer Wait} control how Bacula uses
-the autochanger.
+the autochanger.
These four records, permitted in {\bf Device} resources, are described in
-detail below. Note, however, that the {\bf Changer Device} and the
+detail below. Note, however, that the {\bf Changer Device} and the
{\bf Changer Command} directives are not needed in the Device resource
if they are present in the {\bf Autochanger} resource.
\item [Autochanger = {\it Yes|No} ]
\index[sd]{Autochanger }
The {\bf Autochanger} record specifies that the current device is or is not
-an autochanger. The default is {\bf no}.
+an autochanger. The default is {\bf no}.
\item [Changer Device = \lt{}device-name\gt{}]
\index[sd]{Changer Device }
writing the tapes. On Linux, for the {\bf Archive Device = /dev/nst0}, you
would typically have {\bf Changer Device = /dev/sg0}. Note, some of the more
advanced autochangers will locate the changer device on {\bf /dev/sg1}. Such
-devices typically have several drives and a large number of tapes.
+devices typically have several drives and a large number of tapes.
On FreeBSD systems, the changer device will typically be on {\bf /dev/pass0}
-through {\bf /dev/passn}.
+through {\bf /dev/passn}.
On Solaris, the changer device will typically be some file under {\bf
-/dev/rdsk}.
+/dev/rdsk}.
Please ensure that your Storage daemon has permission to access this
device.
shell script that can be executed by the operating system. This command is
invoked each time that Bacula wishes to manipulate the autochanger. The
following substitutions are made in the {\bf command} before it is sent to
-the operating system for execution:
+the operating system for execution:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
%% = %
%a = archive device name
%c = changer device name
%s = Slot base 0
%S = Slot base 1
%v = Volume name
-\end{verbatim}
+\end{lstlisting}
\normalsize
An actual example for using {\bf mtx} with the {\bf mtx-changer} script (part
-of the Bacula distribution) is:
+of the Bacula distribution) is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Changer Command = "/etc/bacula/mtx-changer %c %o %S %a %d"
-\end{verbatim}
+\end{lstlisting}
\normalsize
Where you will need to adapt the {\bf /etc/bacula} to be the actual path on
your system where the mtx-changer script resides. Details of the three
commands currently used by Bacula (loaded, load, unload) as well as the
-output expected by Bacula are give in the {\bf Bacula Autochanger Interface}
-section below.
+output expected by Bacula are give in the {\bf Bacula Autochanger Interface}
+section below.
\item [Maximum Changer Wait = \lt{}time\gt{}]
\index[sd]{Maximum Changer Wait }
want to set it longer.
If the autoloader program fails to respond in this time, it will be killed
-and Bacula will request operator intervention.
+and Bacula will request operator intervention.
\item [Drive Index = \lt{}number\gt{}]
\index[sd]{Drive Index }
numbered from zero, the second drive is defined by
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Device Index = 1
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
To use the second drive, you need a second Device resource definition in the
Bacula configuration file. See the Multiple Drive section above in this
-chapter for more information.
+chapter for more information.
\end{description}
-In addition, for proper functioning of the Autochanger, you must
+In addition, for proper functioning of the Autochanger, you must
define an Autochanger resource.
\input{autochangerres}
\index[general]{Example Configuration File }
\index[general]{File!Example Configuration }
-The following two resources implement an autochanger:
+The following two resources implement an autochanger:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Autochanger {
Name = "Autochanger"
Device = DDS-4
AutomaticMount = yes;
AlwaysOpen = yes;
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
where you will adapt the {\bf Archive Device}, the {\bf Changer Device}, and
the path to the {\bf Changer Command} to correspond to the values used on your
-system.
+system.
\section{A Multi-drive Example Configuration File}
\index[general]{Multi-drive Example Configuration File }
-The following resources implement a multi-drive autochanger:
+The following resources implement a multi-drive autochanger:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Autochanger {
Name = "Autochanger"
Device = Drive-1, Drive-2
AlwaysOpen = yes;
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
where you will adapt the {\bf Archive Device}, the {\bf Changer Device}, and
the path to the {\bf Changer Command} to correspond to the values used on your
-system.
+system.
\label{SpecifyingSlots}
\section{Specifying Slots When Labeling}
you {\bf add} or {\bf label} tapes for that Storage device. If your
{\bf mtx-changer} script is properly installed, Bacula will automatically
load the correct tape during the label command.
-
+
You must also set
-{\bf Autochanger = yes} in the Storage daemon's Device resource
+{\bf Autochanger = yes} in the Storage daemon's Device resource
as we have described above in
-order for the autochanger to be used. Please see the
+order for the autochanger to be used. Please see the
\ilink{Storage Resource}{Autochanger1} in the Director's chapter
-and the
+and the
\ilink{Device Resource}{Autochanger} in the Storage daemon
-chapter for more details on these records.
+chapter for more details on these records.
Thus all stages of dealing with tapes can be totally automated. It is also
possible to set or change the Slot using the {\bf update} command in the
-Console and selecting {\bf Volume Parameters} to update.
+Console and selecting {\bf Volume Parameters} to update.
Even though all the above configuration statements are specified and correct,
Bacula will attempt to access the autochanger only if a {\bf slot} is non-zero
-in the catalog Volume record (with the Volume name).
+in the catalog Volume record (with the Volume name).
If your autochanger has barcode labels, you can label all the Volumes in
your autochanger one after another by using the {\bf label barcodes} command.
and then label it with the same name as the barcode. An appropriate Media
record will also be created in the catalog. Any barcode that begins with the
same characters as specified on the "CleaningPrefix=xxx" command, will be
-treated as a cleaning tape, and will not be labeled. For example with:
+treated as a cleaning tape, and will not be labeled. For example with:
Please note that Volumes must be pre-labeled to be automatically used in
the autochanger during a backup. If you do not have a barcode reader, this
is done manually (or via a script).
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Pool {
Name ...
Cleaning Prefix = "CLN"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Any slot containing a barcode of CLNxxxx will be treated as a cleaning tape
to release the autochanger by doing:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
unmount
(change cartridges and/or run mtx)
mount
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you do not do the unmount before making such a change, Bacula
magazine, you should notify Bacula of this. By doing so, Bacula will as
a preference, use Volumes that it knows to be in the autochanger before
accessing Volumes that are not in the autochanger. This prevents unneeded
-operator intervention.
+operator intervention.
If your autochanger has barcodes (machine readable tape labels), the task of
informing Bacula is simple. Every time, you change a magazine, or add or
-remove a cartridge from the magazine, simply do
+remove a cartridge from the magazine, simply do
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
unmount
(remove magazine)
(insert new magazine)
update slots
mount
-\end{verbatim}
+\end{lstlisting}
\normalsize
in the Console program. This will cause Bacula to request the autochanger to
that any Volumes that are currently marked as being in the magazine are marked
as no longer in the magazine, and the new list of Volumes will be marked as
being in the magazine. In addition, the Slot numbers of the Volumes will be
-corrected in Bacula's catalog if they are incorrect (added or moved).
+corrected in Bacula's catalog if they are incorrect (added or moved).
If you do not have a barcode reader on your autochanger, you have several
-alternatives.
+alternatives.
\begin{enumerate}
\item You can manually set the Slot and InChanger flag using the {\bf update
- volume} command in the Console (quite painful).
+ volume} command in the Console (quite painful).
-\item You can issue a
+\item You can issue a
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
update slots scan
-\end{verbatim}
+\end{lstlisting}
\normalsize
command that will cause Bacula to read the label on each of the cartridges in
the magazine in turn and update the information (Slot, InChanger flag) in the
- catalog. This is quite effective but does take time to load each cartridge
- into the drive in turn and read the Volume label.
+ catalog. This is quite effective but does take time to load each cartridge
+ into the drive in turn and read the Volume label.
\item You can modify the mtx-changer script so that it simulates an
- autochanger with barcodes. See below for more details.
+ autochanger with barcodes. See below for more details.
\end{enumerate}
\label{simulating}
You can simulate barcodes in your autochanger by making the {\bf mtx-changer}
script return the same information that an autochanger with barcodes would do.
This is done by commenting out the one and only line in the {\bf list)} case,
-which is:
+which is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
${MTX} -f $ctl status | grep " *Storage Element [0-9]*:.*Full" | awk "{print \$3 \$4}" | sed "s/Full *\(:VolumeTag=\)*//"
-\end{verbatim}
+\end{lstlisting}
\normalsize
at approximately line 99 by putting a \# in column one of that line, or by
simply deleting it. Then in its place add a new line that prints the contents
-of a file. For example:
+of a file. For example:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cat /etc/bacula/changer.volumes
-\end{verbatim}
+\end{lstlisting}
\normalsize
Be sure to include a full path to the file, which can have any name. The
-contents of the file must be of the following format:
+contents of the file must be of the following format:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
1:Volume1
2:Volume2
3:Volume3
...
-\end{verbatim}
+\end{lstlisting}
\normalsize
Where the 1, 2, 3 are the slot numbers and Volume1, Volume2, ... are the
contents of the correct file into your {\bf /etc/bacula/changer.volumes} file.
There is no need to stop and start Bacula when you change magazines, simply
put the correct data in the file, then run the {\bf update slots} command, and
-your autochanger will appear to Bacula to be an autochanger with barcodes.
+your autochanger will appear to Bacula to be an autochanger with barcodes.
\label{updateslots}
\section{The Full Form of the Update Slots Command}
If you change only one cartridge in the magazine, you may not want to scan all
Volumes, so the {\bf update slots} command (as well as the {\bf update slots
-scan} command) has the additional form:
+scan} command) has the additional form:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
update slots=n1,n2,n3-n4, ...
-\end{verbatim}
+\end{lstlisting}
\normalsize
where the keyword {\bf scan} can be appended or not. The n1,n2, ... represent
Slot numbers to be updated and the form n3-n4 represents a range of Slot
-numbers to be updated (e.g. 4-7 will update Slots 4,5,6, and 7).
+numbers to be updated (e.g. 4-7 will update Slots 4,5,6, and 7).
This form is particularly useful if you want to do a scan (time expensive) and
-restrict the update to one or two slots.
+restrict the update to one or two slots.
-For example, the command:
+For example, the command:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
update slots=1,6 scan
-\end{verbatim}
+\end{lstlisting}
\normalsize
will cause Bacula to load the Volume in Slot 1, read its Volume label and
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
update slots=1-3,6
-\end{verbatim}
+\end{lstlisting}
\normalsize
will read the barcoded Volume names for slots 1,2,3 and 6 and make the
appropriate updates in the Catalog. If you don't have a barcode reader or have
not modified the mtx-changer script as described above, the above command will
-not find any Volume names so will do nothing.
+not find any Volume names so will do nothing.
\label{FreeBSD}
\section{FreeBSD Issues}
autochanger slot. As a consequence, Bacula is unable to open the device. The
solution to the problem is to make sure that some tape is loaded into the tape
drive before starting Bacula. This problem is corrected in Bacula versions
-1.32f-5 and later.
+1.32f-5 and later.
-Please see the
-\ilink{ Tape Testing}{FreeBSDTapes} chapter of this manual for
+Please see the
+\bsysxrlink{Tape Testing}{FreeBSDTapes}{problems}{chapter} of the \problemsman{} for
{\bf important} information concerning your tape drive before doing the
-autochanger testing.
+autochanger testing.
\label{AutochangerTesting}
\section{Testing Autochanger and Adapting mtx-changer script}
Before attempting to use the autochanger with Bacula, it is preferable to
"hand-test" that the changer works. To do so, we suggest you do the
following commands (assuming that the {\bf mtx-changer} script is installed in
-{\bf /etc/bacula/mtx-changer}):
+{\bf /etc/bacula/mtx-changer}):
\begin{description}
\item [/etc/bacula/mtx-changer \ /dev/sg0 \ list \ 0 \ /dev/nst0 \ 0]
\index[sd]{mtx-changer list}
-This command should print:
+This command should print:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
1:
2:
3:
...
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
or one number per line for each slot that is occupied in your changer, and
-the number should be terminated by a colon ({\bf :}). If your changer has
+the number should be terminated by a colon ({\bf :}). If your changer has
barcodes, the barcode will follow the colon. If an error message is printed,
you must resolve the problem (e.g. try a different SCSI control device name
if {\bf /dev/sg0} is incorrect). For example, on FreeBSD systems, the
-autochanger SCSI control device is generally {\bf /dev/pass2}.
+autochanger SCSI control device is generally {\bf /dev/pass2}.
\item [/etc/bacula/mtx-changer \ /dev/sg0 \ listall \ 0 \ /dev/nst0 \ 0]
\index[sd]{mtx-changer listall}
-This command should print:
+This command should print:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Drive content: D:Drive num:F:Slot loaded:Volume Name
D:0:F:2:vol2 or D:Drive num:E
- D:1:F:42:vol42
+ D:1:F:42:vol42
D:3:E
Slot content:
I:10:F:vol10 I:Slot num:F:Volume Name
I:11:E or I:Slot num:E
I:12:F:vol40
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
\item [/etc/bacula/mtx-changer \ /dev/sg0 \ transfer \ 1 \ 2]
\item [/etc/bacula/mtx-changer \ /dev/sg0 \ slots ]
\index[sd]{mtx-changer slots}
-This command should return the number of slots in your autochanger.
+This command should return the number of slots in your autochanger.
\item [/etc/bacula/mtx-changer \ /dev/sg0 \ unload \ 1 \ /dev/nst0 \ 0 ]
\index[sd]{mtx-changer unload}
- If a tape is loaded from slot 1, this should cause it to be unloaded.
+ If a tape is loaded from slot 1, this should cause it to be unloaded.
\item [/etc/bacula/mtx-changer \ /dev/sg0 \ load \ 3 \ /dev/nst0 \ 0 ]
\index[sd]{mtx-changer load}
Assuming you have a tape in slot 3, it will be loaded into drive (0).
-
+
\item [/etc/bacula/mtx-changer \ /dev/sg0 \ loaded \ 0 \ /dev/nst0 \ 0]
\index[sd]{mtx-changer loaded}
-It should print "3"
+It should print "3"
Note, we have used an "illegal" slot number 0. In this case, it is simply
ignored because the slot number is not used. However, it must be specified
because the drive parameter at the end of the command is needed to select
need to insert a {\bf sleep 20} after the {\bf mtx} command, but be careful to
exit the script with a zero status by adding {\bf exit 0} after any additional
commands you add to the script. This is because Bacula checks the return
-status of the script, which should be zero if all went well.
+status of the script, which should be zero if all went well.
You can test whether or not you need a {\bf sleep} by putting the following
-commands into a file and running it as a script:
+commands into a file and running it as a script:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#!/bin/sh
/etc/bacula/mtx-changer /dev/sg0 unload 1 /dev/nst0 0
/etc/bacula/mtx-changer /dev/sg0 load 3 /dev/nst0 0
mt -f /dev/st0 rewind
mt -f /dev/st0 weof
-\end{verbatim}
+\end{lstlisting}
\normalsize
If the above script runs, you probably have no timing problems. If it does not
-run, start by putting a {\bf sleep 30} or possibly a {\bf sleep 60} in the
+run, start by putting a {\bf sleep 30} or possibly a {\bf sleep 60} in the
script just after the mtx-changer load command. If that works, then you should
move the sleep into the actual {\bf mtx-changer} script so that it will be
-effective when Bacula runs.
+effective when Bacula runs.
A second problem that comes up with a small number of autochangers is that
they need to have the cartridge ejected before it can be removed. If this is
the case, the {\bf load 3} will never succeed regardless of how long you wait.
If this seems to be your problem, you can insert an eject just after the
-unload so that the script looks like:
+unload so that the script looks like:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#!/bin/sh
/etc/bacula/mtx-changer /dev/sg0 unload 1 /dev/nst0 0
mt -f /dev/st0 offline
/etc/bacula/mtx-changer /dev/sg0 load 3 /dev/nst0 0
mt -f /dev/st0 rewind
mt -f /dev/st0 weof
-\end{verbatim}
+\end{lstlisting}
\normalsize
Obviously, if you need the {\bf offline} command, you should move it into the
mtx-changer script ensuring that you save the status of the {\bf mtx} command
or always force an {\bf exit 0} from the script, because Bacula checks the
-return status of the script.
+return status of the script.
As noted earlier, there are several scripts in {\bf
\lt{}bacula-source\gt{}/examples/devices} that implement the above features,
-so they may be a help to you in getting your script to work.
+so they may be a help to you in getting your script to work.
If Bacula complains "Rewind error on /dev/nst0. ERR=Input/output error." you
most likely need more sleep time in your {\bf mtx-changer} before returning to
Let's assume that you have properly defined the necessary Storage daemon
Device records, and you have added the {\bf Autochanger = yes} record to the
-Storage resource in your Director's configuration file.
+Storage resource in your Director's configuration file.
-Now you fill your autochanger with say six blank tapes.
+Now you fill your autochanger with say six blank tapes.
-What do you do to make Bacula access those tapes?
+What do you do to make Bacula access those tapes?
One strategy is to prelabel each of the tapes. Do so by starting Bacula, then
-with the Console program, enter the {\bf label} command:
+with the Console program, enter the {\bf label} command:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
./bconsole
Connecting to Director rufus:8101
1000 OK: rufus-dir Version: 1.26 (4 October 2002)
*label
-\end{verbatim}
+\end{lstlisting}
\normalsize
-it will then print something like:
+it will then print something like:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Using default Catalog name=BackupDB DB=bacula
The defined Storage resources are:
1: Autochanger
2: File
Select Storage resource (1-2): 1
-\end{verbatim}
+\end{lstlisting}
\normalsize
-I select the autochanger (1), and it prints:
+I select the autochanger (1), and it prints:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Enter new Volume name: TestVolume1
Enter slot (0 for none): 1
-\end{verbatim}
+\end{lstlisting}
\normalsize
where I entered {\bf TestVolume1} for the tape name, and slot {\bf 1} for the
-slot. It then asks:
+slot. It then asks:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Defined Pools:
1: Default
2: File
Select the Pool (1-2): 1
-\end{verbatim}
+\end{lstlisting}
\normalsize
I select the Default pool. This will be automatically done if you only have a
single pool, then Bacula will proceed to unload any loaded volume, load the
volume in slot 1 and label it. In this example, nothing was in the drive, so
-it printed:
+it printed:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Connecting to Storage daemon Autochanger at localhost:9103 ...
Sending label command ...
3903 Issuing autochanger "load slot 1" command.
3001 Device /dev/nst0 is mounted with Volume TestVolume1
You have messages.
*
-\end{verbatim}
+\end{lstlisting}
\normalsize
You may then proceed to label the other volumes. The messages will change
slightly because Bacula will unload the volume (just labeled TestVolume1)
-before loading the next volume to be labeled.
+before loading the next volume to be labeled.
Once all your Volumes are labeled, Bacula will automatically load them as they
-are needed.
+are needed.
To "see" how you have labeled your Volumes, simply enter the {\bf list
volumes} command from the Console program, which should print something like
-the following:
+the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
*{\bf list volumes}
Using default Catalog name=BackupDB DB=bacula
Defined Pools:
| 3 | TestVol3 | DDS-4 | Append | 0 | 0 | 30672000 | 0 | 3 |
| ... |
+-------+----------+--------+---------+-------+--------+----------+-------+------+
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{Barcodes}
The {\bf label barcodes} will cause Bacula to read the barcodes of all the
cassettes that are currently installed in the magazine (cassette holder) using
the {\bf mtx-changer} {\bf list} command. Each cassette is mounted in turn and
-labeled with the same Volume name as the barcode.
+labeled with the same Volume name as the barcode.
The {\bf update slots} command will first obtain the list of cassettes and
their barcodes from {\bf mtx-changer}. Then it will find each volume in turn
The {\bf status slots storage=xxx} command displays autochanger content.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Slot | Volume Name | Status | Type | Pool | Loaded |
------+-----------------+----------+-------------------+----------------+---------|
1 | 00001 | Append | DiskChangerMedia | Default | 0 |
2 | 00002 | Append | DiskChangerMedia | Default | 0 |
3*| 00003 | Append | DiskChangerMedia | Scratch | 0 |
4 | | | | | 0 |
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you see a {\bf *} near the slot number, you have to run {\bf update slots}
Bacula uses, which are {\bf loaded}, {\bf load}, {\bf
unload}, {\bf list}, and {\bf slots}. In addition,
each of those commands must return the information in the precise format as
-specified below:
+specified below:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
- Currently the changer commands used are:
loaded -- returns number of the slot that is loaded, base 1,
in the drive or 0 if the drive is empty.
autoloader supports barcodes. Otherwise the barcode
field is blank.
slots -- returns total number of slots in the autochanger.
-\end{verbatim}
+\end{lstlisting}
\normalsize
Bacula checks the exit status of the program called, and if it is zero, the
A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
files that will be used during Full backup as base.
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = BackupLinux
Level= Base
Accurate = yes
...
}
-\end{verbatim}
+\end{lstlisting}
In this example, the job \texttt{BackupZog4} will use the most recent version
of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
\texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = Full
Include = {
File = /
}
}
-\end{verbatim}
+\end{lstlisting}
\textbf{Important note}: The current implementation doesn't permit to scan
-volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
\ No newline at end of file
+volume with \textbf{bscan}. The result wouldn't permit to restore files easily.
The information in this chapter is provided so that you may either create your
own bootstrap files, or so that you can edit a bootstrap file produced by {\bf
Bacula}. However, normally the bootstrap file will be automatically created
-for you during the
+for you during the
\ilink{restore\_command}{_ConsoleChapter} command in the Console program, or
-by using a
+by using a
\ilink{ Write Bootstrap}{writebootstrap} record in your Backup
-Jobs, and thus you will never need to know the details of this file.
+Jobs, and thus you will never need to know the details of this file.
The {\bf bootstrap} file contains ASCII information that permits precise
specification of what files should be restored, what volume they are on,
and where they are on the volume. It is a relatively compact
form of specifying the information, is human readable, and can be edited with
-any text editor.
+any text editor.
\section{Bootstrap File Format}
\index[general]{Format!Bootstrap}
\index[general]{Bootstrap File Format }
-The general format of a {\bf bootstrap} file is:
+The general format of a {\bf bootstrap} file is:
-{\bf \lt{}keyword\gt{}= \lt{}value\gt{}}
+{\bf \lt{}keyword\gt{}= \lt{}value\gt{}}
Where each {\bf keyword} and the {\bf value} specify which files to restore.
More precisely the {\bf keyword} and their {\bf values} serve to limit which
files will be restored and thus act as a filter. The absence of a keyword
-means that all records will be accepted.
+means that all records will be accepted.
Blank lines and lines beginning with a pound sign (\#) in the bootstrap file
-are ignored.
+are ignored.
There are keywords which permit filtering by Volume, Client, Job, FileIndex,
-Session Id, Session Time, ...
+Session Id, Session Time, ...
The more keywords that are specified, the more selective the specification of
which files to restore will be. In fact, each keyword is {\bf AND}ed with
-other keywords that may be present.
+other keywords that may be present.
-For example,
+For example,
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Volume = Test-001
VolSessionId = 1
VolSessionTime = 108927638
-\end{verbatim}
+\end{lstlisting}
\normalsize
directs the Storage daemon (or the {\bf bextract} program) to restore only
those files on Volume Test-001 {\bf AND} having VolumeSessionId equal to one
-{\bf AND} having VolumeSession time equal to 108927638.
+{\bf AND} having VolumeSession time equal to 108927638.
The full set of permitted keywords presented in the order in which they are
-matched against the Volume records are:
+matched against the Volume records are:
\begin{description}
\item [Count]
\index[general]{Count}
The value is the total number of files that will be restored for this Volume.
- This allows the Storage daemon to know when to stop reading the Volume.
+ This allows the Storage daemon to know when to stop reading the Volume.
This value is optional.
\item [VolFile]
\item [VolSessionTime]
\index[general]{VolSessionTime }
The value specifies a Volume Session Time to be matched from the current
- volume.
+ volume.
\item [VolSessionId]
\index[general]{VolSessionId }
The value specifies a JobId, list of JobIds, or range of JobIds to be
selected from the current Volume. Note, the JobId may not be unique if you
have multiple Directors, or if you have reinitialized your database. The
- JobId filter works only if you do not run multiple simultaneous jobs.
+ JobId filter works only if you do not run multiple simultaneous jobs.
This value is optional and not used by Bacula to restore files.
\item [Job]
VolSessionTime pair. However, the Job is perhaps a bit more readable by
humans. Standard regular expressions (wildcards) may be used to match Job
names. The Job filter works only if you do not run multiple simultaneous
- jobs.
+ jobs.
This value is optional and not used by Bacula to restore files.
\item [Client]
The value specifies a Client name or list of Clients to will be matched on
the current Volume. Standard regular expressions (wildcards) may be used to
match Client names. The Client filter works only if you do not run multiple
- simultaneous jobs.
+ simultaneous jobs.
This value is optional and not used by Bacula to restore files.
\item [FileIndex]
to be selected from the current Volume. Each file (data) stored on a Volume
within a Session has a unique FileIndex. For each Session, the first file
written is assigned FileIndex equal to one and incremented for each file
- backed up.
+ backed up.
This for a given Volume, the triple VolSessionId, VolSessionTime, and
FileIndex uniquely identifies a file stored on the Volume. Multiple copies of
the same file may be stored on the same Volume, but for each file, the triple
VolSessionId, VolSessionTime, and FileIndex will be unique. This triple is
- stored in the Catalog database for each file.
+ stored in the Catalog database for each file.
To restore a particular file, this value (or a range of FileIndexes) is
required.
-\item [FileRegex]
+\phantomsection
+\item [FileRegex]\label{FileRegex}
\index[general]{FileRegex}
The value is a regular expression. When specified, only matching
filenames will be restored.
-\begin{verbatim}
+\begin{lstlisting}
FileRegex=^/etc/passwd(.old)?
-\end{verbatim}
+\end{lstlisting}
\item [Slot]
\index[general]{Slot }
The value specifies the autochanger slot. There may be only a single {\bf
- Slot} specification for each Volume.
+ Slot} specification for each Volume.
\item [Stream]
\index[general]{Stream }
The value specifies a Stream, a list of Streams, or a range of Streams to be
selected from the current Volume. Unless you really know what you are doing
- (the internals of {\bf Bacula}), you should avoid this specification.
+ (the internals of {\bf Bacula}), you should avoid this specification.
This value is optional and not used by Bacula to restore files.
\item [*JobType]
\index[general]{*JobType }
- Not yet implemented.
+ Not yet implemented.
\item [*JobLevel]
\index[general]{*JobLevel }
- Not yet implemented.
+ Not yet implemented.
\end{description}
The {\bf Volume} record is a bit special in that it must be the first record.
The other keyword records may appear in any order and any number following a
-Volume record.
+Volume record.
Multiple Volume records may be specified in the same bootstrap file, but each
-one starts a new set of filter criteria for the Volume.
+one starts a new set of filter criteria for the Volume.
In processing the bootstrap file within the current Volume, each filter
-specified by a keyword is {\bf AND}ed with the next. Thus,
+specified by a keyword is {\bf AND}ed with the next. Thus,
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Volume = Test-01
Client = "My machine"
FileIndex = 1
-\end{verbatim}
+\end{lstlisting}
\normalsize
will match records on Volume {\bf Test-01} {\bf AND} Client records for {\bf
-My machine} {\bf AND} FileIndex equal to {\bf one}.
+My machine} {\bf AND} FileIndex equal to {\bf one}.
-Multiple occurrences of the same record are {\bf OR}ed together. Thus,
+Multiple occurrences of the same record are {\bf OR}ed together. Thus,
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Volume = Test-01
Client = "My machine"
Client = "Backup machine"
FileIndex = 1
-\end{verbatim}
+\end{lstlisting}
\normalsize
will match records on Volume {\bf Test-01} {\bf AND} (Client records for {\bf
My machine} {\bf OR} {\bf Backup machine}) {\bf AND} FileIndex equal to {\bf
-one}.
+one}.
For integer values, you may supply a range or a list, and for all other values
except Volumes, you may specify a list. A list is equivalent to multiple
-records of the same keyword. For example,
+records of the same keyword. For example,
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Volume = Test-01
Client = "My machine", "Backup machine"
FileIndex = 1-20, 35
-\end{verbatim}
+\end{lstlisting}
\normalsize
will match records on Volume {\bf Test-01} {\bf AND} {\bf (}Client records for
{\bf My machine} {\bf OR} {\bf Backup machine}{\bf )} {\bf AND} {\bf
-(}FileIndex 1 {\bf OR} 2 {\bf OR} 3 ... {\bf OR} 20 {\bf OR} 35{\bf )}.
+(}FileIndex 1 {\bf OR} 2 {\bf OR} 3 ... {\bf OR} 20 {\bf OR} 35{\bf )}.
As previously mentioned above, there may be multiple Volume records in the
same bootstrap file. Each new Volume definition begins a new set of filter
conditions that apply to that Volume and will be {\bf OR}ed with any other
-Volume definitions.
+Volume definitions.
As an example, suppose we query for the current set of tapes to restore all
files on Client {\bf Rufus} using the {\bf query} command in the console
-program:
+program:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Using default Catalog name=MySQL DB=bacula
*query
Available queries:
| 203 | 2002-06-15 11:12 | test-02 | 3 | 1 | 1024132350 |
| 204 | 2002-06-18 08:11 | test-02 | 4 | 1 | 1024380678 |
+-------+------------------+------------+-----------+----------+------------+
-\end{verbatim}
+\end{lstlisting}
\normalsize
The output shows us that there are four Jobs that must be restored. The first
-one is a Full backup, and the following three are all Incremental backups.
+one is a Full backup, and the following three are all Incremental backups.
-The following bootstrap file will restore those files:
+The following bootstrap file will restore those files:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Volume=test-02
VolSessionId=1
VolSessionTime=1022753312
Volume=test-02
VolSessionId=1
VolSessionTime=1024380678
-\end{verbatim}
+\end{lstlisting}
\normalsize
As a final example, assume that the initial Full save spanned two Volumes. The
-output from {\bf query} might look like:
+output from {\bf query} might look like:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
+-------+------------------+------------+-----------+----------+------------+
| JobId | StartTime | VolumeName | StartFile | VolSesId | VolSesTime |
+-------+------------------+------------+-----------+----------+------------+
| 243 | 2002-06-25 16:52 | File0005 | 0 | 2 | 1025016612 |
| 246 | 2002-06-25 19:19 | File0006 | 0 | 2 | 1025025494 |
+-------+------------------+------------+-----------+----------+------------+
-\end{verbatim}
+\end{lstlisting}
\normalsize
-and the following bootstrap file would restore those files:
+and the following bootstrap file would restore those files:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Volume=File0003
VolSessionId=1
VolSessionTime=1025016612
Volume=File0006
VolSessionId=2
VolSessionTime=1025025494
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{Automatic Generation of Bootstrap Files}
Job are appended to the end of the bootstrap file.
As consequence, all the files saved to an Incremental or Differential job will be
restored first by the Full save, then by any Incremental or Differential
-saves.
+saves.
When the bootstrap file is generated for the restore command, only one copy
-(the most recent) of each file is restored.
+(the most recent) of each file is restored.
So if you have spare cycles on your machine, you could optimize the bootstrap
-files by doing the following:
+files by doing the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
./bconsole
restore client=xxx select all
done
no
quit
Backup bootstrap file.
-\end{verbatim}
+\end{lstlisting}
\normalsize
The above will not work if you have multiple FileSets because that will be an
extra prompt. However, the {\bf restore client=xxx select all} builds the
-in-memory tree, selecting everything and creates the bootstrap file.
+in-memory tree, selecting everything and creates the bootstrap file.
-The {\bf no} answers the {\bf Do you want to run this (yes/mod/no)} question.
+The {\bf no} answers the {\bf Do you want to run this (yes/mod/no)} question.
\label{bscanBootstrap}
\section{Bootstrap for bscan}
volume names. An example might be:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Volume="Vol001"
Volume="Vol002"
Volume="Vol003"
Volume="Vol004"
Volume="Vol005"
-\end{verbatim}
+\end{lstlisting}
\normalsize
JobId (code not tested) or better yet, if you know the VolSessionTime and the
VolSessionId (printed on Job report and in Catalog), specifying this is by far
the best. Using the VolSessionTime and VolSessionId is the way Bacula does
-restores. A bsr file might look like the following:
+restores. A bsr file might look like the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Volume="Vol001"
VolSessionId=10
VolSessionTime=1080847820
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you know how many files are backed up (on the job report), you can
enormously speed up the selection by adding (let's assume there are 157
-files):
+files):
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileIndex=1-157
Count=157
-\end{verbatim}
+\end{lstlisting}
\normalsize
Finally, if you know the File number where the Job starts, you can also cause
-bcopy to forward space to the right file without reading every record:
+bcopy to forward space to the right file without reading every record:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
VolFile=20
-\end{verbatim}
+\end{lstlisting}
\normalsize
There is nothing magic or complicated about a BSR file. Parsing it and
properly applying it within Bacula *is* magic, but you don't need to worry
-about that.
+about that.
If you want to see a *real* bsr file, simply fire up the {\bf restore} command
in the console program, select something, then answer no when it prompts to
run the job. Then look at the file {\bf restore.bsr} in your working
-directory.
+directory.
-
\subsection{Include All Windows Drives in FileSet}
The \texttt{alldrives} Windows Plugin allows you to include all local drives
with a simple directive. This plugin is available in the Windows 64 and 32 bit
installer.
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = EverythingFS
...
Plugin = "alldrives"
}
}
-\end{verbatim}
+\end{lstlisting}
You exclude some specific drives with the \texttt{exclude} option.
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = EverythingFS
...
Plugin = "alldrives: exclude=D,E"
}
}
-\end{verbatim}
+\end{lstlisting}
\subsection{Microsoft VSS Writer Plugin}
Only the System State component is currently supported. The Sharepoint,
MSSQL, and Exchange components are available only for testing.
-\begin{itemize}
+\begin{bsysitemize}
\item System State writers
- \begin{itemize}
+ \begin{bsysitemize}
\item Registry
\item Event Logs
\item COM+ REGDB (COM Registration Database)
\item NTFRS (SYSVOL etc replication -- Windows 2003 domains)
\item DFS Replication (SYSVOLS etc replication -- Windows 2008 domains)
\item ASR Writer
- \end{itemize}
+ \end{bsysitemize}
This component is known to work.
\item Sharepoint writers \\
This component has not yet been tested. It is included so that you
use it in production without careful testing. \\ Bacula Systems has a
White Paper that describes backup and restore of MS Exchange 2010 in
detail.
-\end{itemize}
+\end{bsysitemize}
Each of the above specified Microsoft components can be backed up
by specifying a different plugin option within the Bacula FileSet.
(see below).
To activate each component you use the following:
-\begin{itemize}
+\begin{bsysitemize}
\item System State writers
- \begin{verbatim}
+ \begin{lstlisting}
Plugin = "vss:/@SYSTEMSTATE/"
- \end{verbatim}
+ \end{lstlisting}
Note, exactly which subcomponents will be backed up depends on
which ones you have enabled within Windows. For example, on a standard
default Vista system only ASR Writer, COM+ REGDB, System State, and WMI
are enabled.
\item Sharepoint writers
- \begin{verbatim}
+ \begin{lstlisting}
Plugin = "vss:/@SHAREPOINT/"
- \end{verbatim}
+ \end{lstlisting}
\item MSSQL databases (except those owned by Sharepoint if that plugin is
specified)
- \begin{verbatim}
+ \begin{lstlisting}
Plugin = "vss:/@MSSQL/"
- \end{verbatim}
+ \end{lstlisting}
To use the sharepoint writer you'll need to enable the mssql writer
which is not enabled by default (a Microsoft restriction). The Microsoft
literature says that the mssql writer is only good for snapshots
enabled via a registry tweak or else the older MSDE writer will be
invoked instead.
\item Exchange (all exchange databases)
- \begin{verbatim}
+ \begin{lstlisting}
Plugin = "vss:/@EXCHANGE/"
- \end{verbatim}
-\end{itemize}
+ \end{lstlisting}
+\end{bsysitemize}
The plugin directives must be specified exactly as shown above.
A Job may have one or more of the {\bf vss} plugins components specified.
include the system state. The system state files backed up will appear
in a {\bf bconsole} or {\bf bat} restore like:
-\begin{verbatim}
+\begin{lstlisting}
/@SYSTEMSTATE/
/@SYSTEMSTATE/ASR Writer/
/@SYSTEMSTATE/COM+ REGDB Writer/
etc
-\end{verbatim}
+\end{lstlisting}
Only a complete backup of the system state is supported at this time. That
is it is not currently possible to just back up the Registry or Active
\subsubsection{Example}
Suppose you have the following backup FileSet:
-\begin{verbatim}
+\begin{lstlisting}
@SYSTEMSTATE/
System Writer/
instance_{GUID}
NTDS/
instance_{GUID}
ntds/
-\end{verbatim}
+\end{lstlisting}
If only the Registry needs to be restored, then you could use the
following commands in {\bf bconsole}:
-\begin{verbatim}
+\begin{lstlisting}
markdir @SYSTEMSTATE
cd @SYSTEMSTATE
markdir "Registry Writer"
cd "Registry Writer"
mark instance*
mark "Registry"
-\end{verbatim}
+\end{lstlisting}
\subsubsection{Windows Plugins Items to Note}
-\begin{itemize}
+\begin{bsysitemize}
\item Reboot Required after a Plugin Restore\\
In general after any VSS plugin is used to restore a component, you will
need to reboot the system. This is required because in-use files cannot be
to restore your system, use the last Full non-VSS backup to restore your
system, and after rebooting do a restore with the VSS plugin to get
everything fully up to date.
-\end{itemize}
+\end{bsysitemize}
This plugin is available as an option. Please
contact Bacula Systems to get access to the VSS Plugin packages and the
the LAN to your Bacula server.
Accurate option should be turned on in the Job resource.
-\begin{verbatim}
+\begin{lstlisting}
Job {
Accurate = yes
FileSet = NDMPFS
Plugin = "ndmp:host=nasbox user=root pass=root file=/vol/vol1"
}
}
-\end{verbatim}
+\end{lstlisting}
This plugin is available as an option. Please
contact Bacula Systems to get access to the NDMP Plugin packages and the
-%%
-%%
-
\section{Bacula Bugs}
\label{BugsChapter}
-\index[general]{Bacula Bugs }
-\index[general]{Bugs!Bacula }
+\index[general]{Bacula Bugs}
+\index[general]{Bugs!Bacula}
Well fortunately there are not too many bugs, but thanks to Dan Langille, we
-have a
-\elink{bugs database}{http://bugs.bacula.org} where bugs are reported.
+have a \elink{bugs database}{http://bugs.bacula.org} where bugs are reported.
Generally, when a bug is fixed, a patch for the currently released version will
be attached to the bug report.
-The directory {\bf patches} in the current SVN always contains a list of
+The directory {\bf patches} in the current SVN always contains a list of
the patches that have been created for the previously released version
-of Bacula. In addition, the file {\bf patches-version-number} in the
+of Bacula. In addition, the file {\bf patches-version-number} in the
{\bf patches} directory contains a summary of each of the patches.
-A "raw" list of the current task list and known issues can be found in {\bf
-kernstodo} in the main Bacula source directory.
+A ``raw'' list of the current task list and known issues can be found in {\bf
+kernstodo} in the main Bacula source directory.
backup. By deleting records within the database, you can make space available
for the new records that will be added during the next Job. By constantly
deleting old expired records (dates older than the Retention period), your
-database size will remain constant.
+database size will remain constant.
If you started with the default configuration files, they already contain
reasonable defaults for a small number of machines (less than 5), so if you
fall into that case, catalog maintenance will not be urgent if you have a few
hundred megabytes of disk space free. Whatever the case may be, some knowledge
-of retention periods will be useful.
+of retention periods will be useful.
\label{Retention}
\section{Setting Retention Periods}
{\bf Bacula} uses three Retention periods: the {\bf File Retention} period,
the {\bf Job Retention} period, and the {\bf Volume Retention} period. Of
these three, the File Retention period is by far the most important in
-determining how large your database will become.
+determining how large your database will become.
The {\bf File Retention} and the {\bf Job Retention} are specified in each
Client resource as is shown below. The {\bf Volume Retention} period is
specified in the Pool resource, and the details are given in the next chapter
-of this manual.
+of this manual.
\begin{description}
occur at the end of a backup Job for the given Client. Note that the Client
database record contains a copy of the File and Job retention periods, but
Bacula uses the current values found in the Director's Client resource to do
-the pruning.
+the pruning.
-Since File records in the database account for probably 80 percent of the
+Since File records in the database account for probably 80 percent of the
size of the database, you should carefully determine exactly what File
Retention period you need. Once the File records have been removed from
the database, you will no longer be able to restore individual files
\ilink{ Configuration chapter}{Time} of this manual for additional details
of modifier specification.
-The default File retention period is 60 days.
+The default File retention period is 60 days.
\item [Job Retention = \lt{}time-period-specification\gt{}]
\index[general]{Job Retention }
As mentioned above, once the File records are removed from the database,
you will no longer be able to restore individual files from the Job.
However, as long as the Job record remains in the database, you will be
-able to restore all the files backuped for the Job (on version 1.37 and
+able to restore all the files backuped for the Job (on version 1.37 and
later). As a consequence, it is generally a good idea to retain the Job
records much longer than the File records.
Configuration chapter}{Time} of this manual for additional details of
modifier specification.
-The default Job Retention period is 180 days.
+The default Job Retention period is 180 days.
\item [AutoPrune = \lt{}yes/no\gt{}]
\index[general]{AutoPrune }
If AutoPrune is set to {\bf yes} (default), Bacula will automatically apply
the File retention period and the Job retention period for the Client at the
-end of the Job.
+end of the Job.
If you turn this off by setting it to {\bf no}, your Catalog will grow each
-time you run a Job.
+time you run a Job.
\end{description}
\label{CompactingMySQL}
as Oracle have commands that will compact a database to reclaim wasted file
space. MySQL has the {\bf OPTIMIZE TABLE} command that you can use, and SQLite
version 2.8.4 and greater has the {\bf VACUUM} command. We leave it to you to
-explore the utility of the {\bf OPTIMIZE TABLE} command in MySQL.
+explore the utility of the {\bf OPTIMIZE TABLE} command in MySQL.
All database programs have some means of writing the database out in ASCII
format and then reloading it. Doing so will re-create the database from
scratch producing a compacted result, so below, we show you how you can do
-this for MySQL, PostgreSQL and SQLite.
+this for MySQL, PostgreSQL and SQLite.
For a {\bf MySQL} database, you could write the Bacula database as an ASCII
-file (bacula.sql) then reload it by doing the following:
+file (bacula.sql) then reload it by doing the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysqldump -f --opt bacula > bacula.sql
mysql bacula < bacula.sql
rm -f bacula.sql
-\end{verbatim}
+\end{lstlisting}
\normalsize
Depending on the size of your database, this will take more or less time and a
fair amount of disk space. For example, if I cd to the location of the MySQL
-Bacula database (typically /opt/mysql/var or something similar) and enter:
+Bacula database (typically /opt/mysql/var or something similar) and enter:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
du bacula
-\end{verbatim}
+\end{lstlisting}
\normalsize
I get {\bf 620,644} which means there are that many blocks containing 1024
mysql} command to recreate the database, I ended up with a total of {\bf
210,464} blocks rather than the original {\bf 629,644}. In other words, the
compressed version of the database took approximately one third of the space
-of the database that had been in use for about a year.
+of the database that had been in use for about a year.
As a consequence, I suggest you monitor the size of your database and from
-time to time (once every six months or year), compress it.
+time to time (once every six months or year), compress it.
\label{DatabaseRepair}
\label{RepairingMySQL}
running MySQL's database check and repair routines. The program you need to
run depends on the type of database indexing you are using. If you are using
the default, you will probably want to use {\bf myisamchk}. For more details
-on how to do this, please consult the MySQL document at:
+on how to do this, please consult the MySQL document at:
\elink{
http://www.mysql.com/doc/en/Repair.html}
-{http://www.mysql.com/doc/en/Repair.html}.
+{http://www.mysql.com/doc/en/Repair.html}.
If the errors you are getting are simply SQL warnings, then you might try
running dbcheck before (or possibly after) using the MySQL database repair
program. It can clean up many of the orphaned record problems, and certain
-other inconsistencies in the Bacula database.
+other inconsistencies in the Bacula database.
A typical cause of MySQL database problems is if your partition fills. In
such a case, you will need to create additional space on the partition or
the following script did the trick for me:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#!/bin/sh
for i in *.MYD ; do
mv $i x${i}
chown mysql:mysql ${i}
myisamchk -r ${t}
done
-\end{verbatim}
+\end{lstlisting}
\normalsize
I invoked it with the following commands:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cd /var/lib/mysql/bacula
./repair
-\end{verbatim}
+\end{lstlisting}
\normalsize
Then after ensuring that the database was correctly fixed, I did:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cd /var/lib/mysql/bacula
rm -f x*.MYD
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{MySQL Table is Full}
\index[general]{Database!MySQL Table is Full}
\index[general]{MySQL Table is Full}
-If you are running into the error {\bf The table 'File' is full ...},
-it is probably because on version 4.x MySQL, the table is limited by
+If you are running into the error {\bf The table 'File' is full \ldots{}},
+it is probably because on version 4.x MySQL, the table is limited by
default to a maximum size of 4 GB and you have probably run into
the limit. The solution can be found at:
\elink{http://dev.mysql.com/doc/refman/5.0/en/full-table.html}
You can display the maximum length of your table with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysql bacula
SHOW TABLE STATUS FROM bacula like "File";
-\end{verbatim}
+\end{lstlisting}
\normalsize
If the column labeled "Max\_data\_length" is around 4Gb, this is likely
to be the source of your problem, and you can modify it with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysql bacula
ALTER TABLE File MAX_ROWS=281474976710656;
-\end{verbatim}
+\end{lstlisting}
\normalsize
Alternatively you can modify your /etc/my.conf file before creating the
Bacula tables, and in the [mysqld] section set:
-\footnotesize
-\begin{verbatim}
+\footnotesize
+\begin{lstlisting}
set-variable = myisam_data_pointer_size=6
-\end{verbatim}
+\end{lstlisting}
\normalsize
The above myisam data pointer size must be made before you create your
/tmp. Once that space fills up, Bacula daemons such as the Storage
daemon doing spooling can get strange errors. E.g.
-\footnotesize
-\begin{verbatim}
+\footnotesize
+\begin{lstlisting}
Fatal error: spool.c:402 Spool data read error.
Fatal error: backup.c:892 Network send error to SD. ERR=Connection reset by
peer
-\end{verbatim}
+\end{lstlisting}
\normalsize
What you need to do is setup MySQL to use a different (larger) temp
directory, which can be set in the /etc/my.cnf with these variables
set:
-\footnotesize
-\begin{verbatim}
+\footnotesize
+\begin{lstlisting}
tmpdir=/path/to/larger/tmpdir
bdb_tmpdir=/path/to/larger/tmpdir
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{RepairingPSQL}
The same considerations apply that are indicated above for MySQL. That is,
consult the PostgreSQL documents for how to repair the database, and also
consider using Bacula's dbcheck program if the conditions are reasonable for
-using (see above).
+using (see above).
\label{DatabasePerformance}
\section{Database Performance Issues}
indications as to what indexes may be appropriate. Please see below
for specific instructions on checking indexes.
-For MySQL, what is very important is to use the examine the
+For MySQL, what is very important is to use the examine the
my.cnf file (usually in /etc/my.cnf).
You may obtain significant performances by switching to
the my-large.cnf or my-huge.cnf files that come with the MySQL source
For SQLite3, one significant factor in improving the performance is
to ensure that there is a "PRAGMA synchronous = NORMAL;" statement.
This reduces the number of times that the database flushes the in memory
-cache to disk. There are other settings for this PRAGMA that can
+cache to disk. There are other settings for this PRAGMA that can
give even further performance improvements at the risk of a database
corruption if your system crashes.
{http://www.postgresql.org/docs/faqs.FAQ.html\#3.3}.
% TODO: verify above is correct. is this okay for book?
-Also for PostgreSQL, look at what "effective\_cache\_size". For a 2GB memory
+Also for PostgreSQL, look at what "effective\_cache\_size". For a 2GB memory
machine, you probably want to set it at 131072, but don't set it too high.
In addition, for a 2GB system, work\_mem = 256000 and
maintenance\_work\_mem = 256000 seem to be reasonable values. Make
the following commands:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
psql bacula
select * from pg_indexes where tablename='file';
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you do not see output that indicates that all three indexes
are created, you can create the two additional indexes using:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
psql bacula
CREATE INDEX file_jobid_idx on file (jobid);
CREATE INDEX file_jpf_idx on file (jobid, pathid, filenameid);
-\end{verbatim}
+\end{lstlisting}
\normalsize
Make sure that you doesn't have an index on File (filenameid, pathid).
On MySQL, you can check if you have the proper indexes by:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysql bacula
show index from File;
-\end{verbatim}
+\end{lstlisting}
\normalsize
If the indexes are not present, especially the JobId index, you can
create them with the following commands:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysql bacula
CREATE INDEX file_jobid_idx on File (JobId);
CREATE INDEX file_jpf_idx on File (JobId, FilenameId, PathId);
-\end{verbatim}
+\end{lstlisting}
\normalsize
-Though normally not a problem, you should ensure that the indexes
-defined for Filename and Path are both set to 255 characters. Some users
+Though normally not a problem, you should ensure that the indexes
+defined for Filename and Path are both set to 255 characters. Some users
reported performance problems when their indexes were set to 50 characters.
To check, do:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysql bacula
show index from Filename;
show index from Path;
-\end{verbatim}
+\end{lstlisting}
\normalsize
and what is important is that for Filename, you have an index with
index with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysql bacula
DROP INDEX Path on Path;
CREATE INDEX Path on Path (Path(255));
DROP INDEX Name on Filename;
CREATE INDEX Name on Filename (Name(255));
-\end{verbatim}
+\end{lstlisting}
\normalsize
On SQLite, you can check if you have the proper indexes by:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
sqlite <path>/bacula.db
select * from sqlite_master where type='index' and tbl_name='File';
-\end{verbatim}
+\end{lstlisting}
\normalsize
If the indexes are not present, especially the JobId index, you can
create them with the following commands:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
sqlite <path>/bacula.db
CREATE INDEX file_jobid_idx on File (JobId);
CREATE INDEX file_jfp_idx on File (JobId, PathId, FilenameId);
-\end{verbatim}
+\end{lstlisting}
\normalsize
Over time, as noted above, your database will tend to grow. I've noticed that
even though Bacula regularly prunes files, PostgreSQL has a {\bf VACUUM}
command that will compact your database for you. Alternatively you may want to
-use the {\bf vacuumdb} command, which can be run from a cron job.
+use the {\bf vacuumdb} command, which can be run from a cron job.
All database programs have some means of writing the database out in ASCII
format and then reloading it. Doing so will re-create the database from
scratch producing a compacted result, so below, we show you how you can do
-this for PostgreSQL.
+this for PostgreSQL.
For a {\bf PostgreSQL} database, you could write the Bacula database as an
-ASCII file (bacula.sql) then reload it by doing the following:
+ASCII file (bacula.sql) then reload it by doing the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
pg_dump -c bacula > bacula.sql
cat bacula.sql | psql bacula
rm -f bacula.sql
-\end{verbatim}
+\end{lstlisting}
\normalsize
Depending on the size of your database, this will take more or less time and a
fair amount of disk space. For example, you can {\bf cd} to the location of
the Bacula database (typically /usr/local/pgsql/data or possible
-/var/lib/pgsql/data) and check the size.
+/var/lib/pgsql/data) and check the size.
-There are certain PostgreSQL users who do not recommend the above
+There are certain PostgreSQL users who do not recommend the above
procedure. They have the following to say:
PostgreSQL does not
need to be dumped/restored to keep the database efficient. A normal
Finally, you might want to look at the PostgreSQL documentation on
this subject at
\elink{http://www.postgresql.org/docs/8.1/interactive/maintenance.html}
-{http://www.postgresql.org/docs/8.1/interactive/maintenance.html}.
+{http://www.postgresql.org/docs/8.1/interactive/maintenance.html}.
\section{Compacting Your SQLite Database}
\index[general]{Compacting Your SQLite Database }
First please read the previous section that explains why it is necessary to
compress a database. SQLite version 2.8.4 and greater have the {\bf Vacuum}
-command for compacting the database.
+command for compacting the database.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cd {\bf working-directory}
echo 'vacuum;' | sqlite bacula.db
-\end{verbatim}
+\end{lstlisting}
\normalsize
As an alternative, you can use the following commands, adapted to your system:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cd {\bf working-directory}
echo '.dump' | sqlite bacula.db > bacula.sql
rm -f bacula.db
sqlite bacula.db < bacula.sql
rm -f bacula.sql
-\end{verbatim}
+\end{lstlisting}
\normalsize
Where {\bf working-directory} is the directory that you specified in the
Director's configuration file. Note, in the case of SQLite, it is necessary to
completely delete (rm) the old database before creating a new compressed
-version.
+version.
\section{Migrating from SQLite to MySQL or PostgreSQL}
\index[general]{MySQL!Migrating from SQLite to }
database if it is specified in the FileSet, this is not a very good way to do
it, because the database will be saved while Bacula is modifying it. Thus the
database may be in an instable state. Worse yet, you will backup the database
-before all the Bacula updates have been applied.
+before all the Bacula updates have been applied.
To resolve these problems, you need to backup the database after all the backup
jobs have been run. In addition, you will want to make a copy while Bacula is
will be automatically generated along with all the other Bacula scripts. The
first script will make an ASCII copy of your Bacula database into {\bf
bacula.sql} in the working directory you specified in your configuration, and
-the second will delete the {\bf bacula.sql} file.
+the second will delete the {\bf bacula.sql} file.
-The basic sequence of events to make this work correctly is as follows:
+The basic sequence of events to make this work correctly is as follows:
-\begin{itemize}
-\item Run all your nightly backups
-\item After running your nightly backups, run a Catalog backup Job
-\item The Catalog backup job must be scheduled after your last nightly backup
+\begin{bsysitemize}
+\item Run all your nightly backups
+\item After running your nightly backups, run a Catalog backup Job
+\item The Catalog backup job must be scheduled after your last nightly backup
\item You use {\bf RunBeforeJob} to create the ASCII backup file and {\bf
- RunAfterJob} to clean up
-\end{itemize}
+ RunAfterJob} to clean up
+\end{bsysitemize}
Assuming that you start all your nightly backup jobs at 1:05 am (and that they
run one after another), you can do the catalog backup with the following
-additional Director configuration statements:
+additional Director configuration statements:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
# Backup the catalog database (after the nightly save)
Job {
Name = "BackupCatalog"
File = \lt{}working_directory\gt{}/bacula.sql
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Be sure to write a bootstrap file as in the above example. However, it is preferable
to write or copy the bootstrap file to another computer. It will allow
you to quickly recover the database backup should that be necessary. If
you do not have a bootstrap file, it is still possible to recover your
-database backup, but it will be more work and take longer.
+database backup, but it will be more work and take longer.
\label{BackingUpBaculaSecurityConsiderations}
\elink{
.pgpass}{http://www.postgresql.org/docs/8.2/static/libpq-pgpass.html}, and
we know MySQL has
-\elink{ .my.cnf}{http://dev.mysql.com/doc/refman/4.1/en/password-security.html}.
+\elink{.my.cnf}{http://dev.mysql.com/doc/refman/4.1/en/password-security.html}.
Only you can decide what is appropriate for your situation. We have provided
you with a starting point. We hope it helps.
If you are running a database in production mode on your machine, Bacula will
happily backup the files, but if the database is in use while Bacula is
-reading it, you may back it up in an unstable state.
+reading it, you may back it up in an unstable state.
The best solution is to shutdown your database before backing it up, or use
some tool specific to your database to make a valid live copy perhaps by
provide you advice on how to do this, but if you are unsure about how to
backup your database, you might try visiting the Backup Central site, which
has been renamed Storage Mountain (www.backupcentral.com). In particular,
-their
+their
\elink{ Free Backup and Recovery
Software}{http://www.backupcentral.com/toc-free-backup-software.html} page has
links to scripts that show you how to shutdown and backup most major
-databases.
+databases.
\label{Size}
\section{Database Size}
period to that time. Then you can either wait and see how big your Catalog
gets or make a calculation assuming approximately 154 bytes for each File
saved and knowing the number of Files that are saved during each backup and
-the number of Clients you backup.
+the number of Clients you backup.
For example, suppose you do a backup of two systems, each with 100,000 files.
Suppose further that you do a Full backup weekly and an Incremental every day,
and that the Incremental backup typically saves 4,000 files. The size of your
-database after a month can roughly be calculated as:
+database after a month can roughly be calculated as:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Size = 154 * No. Systems * (100,000 * 4 + 10,000 * 26)
-\end{verbatim}
+\end{lstlisting}
\normalsize
where we have assumed four weeks in a month and 26 incremental backups per month.
-This would give the following:
+This would give the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Size = 154 * 2 * (100,000 * 4 + 10,000 * 26)
or
Size = 308 * (400,000 + 260,000)
or
Size = 203,280,000 bytes
-\end{verbatim}
+\end{lstlisting}
\normalsize
So for the above two systems, we should expect to have a database size of
approximately 200 Megabytes. Of course, this will vary according to how many
-files are actually backed up.
+files are actually backed up.
Below are some statistics for a MySQL database containing Job records for five
Clients beginning September 2001 through May 2002 (8.5 months) and File
In the list below, the files (corresponding to Bacula Tables) with the
extension .MYD contain the data records whereas files with the extension .MYI
-contain indexes.
+contain indexes.
You will note that the File records (containing the file attributes) make up
the large bulk of the number of records as well as the space used (459 Mega
Bytes including the indexes). As a consequence, the most important Retention
period will be the {\bf File Retention} period. A quick calculation shows that
-for each File that is saved, the database grows by approximately 150 bytes.
+for each File that is saved, the database grows by approximately 150 bytes.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Size in
Bytes Records File
============ ========= ===========
3,072 Pool.MYI
5 1 Version.MYD
1,024 Version.MYI
-\end{verbatim}
+\end{lstlisting}
\normalsize
-This database has a total size of approximately 450 Megabytes.
+This database has a total size of approximately 450 Megabytes.
If we were using SQLite, the determination of the total database size would be
much easier since it is a single file, but we would have less insight to the
-size of the individual tables as we have in this case.
+size of the individual tables as we have in this case.
Note, SQLite databases may be as much as 50\% larger than MySQL databases due
to the fact that all data is stored as ASCII strings. That is even binary
integers are stored as ASCII strings, and this seems to increase the space
-needed.
+needed.
specified on the command line or the default {\bf bacula-dir.conf}, {\bf
bacula-fd.conf}, {\bf bacula-sd.conf}, or {\bf console.conf} for the Director
daemon, the File daemon, the Storage daemon, and the Console program
-respectively.
+respectively.
Each service (Director, Client, Storage, Console) has its own configuration
file containing a set of Resource definitions. These resources are very
file, the {\bf Director} resource defines the name of the Director, a number
of global Director parameters and his password. In the File daemon
configuration file, the {\bf Director} resource specifies which Directors are
-permitted to use the File daemon.
+permitted to use the File daemon.
Before running Bacula for the first time, you must customize the configuration
files for each daemon. Default configuration files will have been created by
the installation process, but you will need to modify them to correspond to
-your system. An overall view of the resources can be seen in the following:
+your system. An overall view of the resources can be seen in the following:
-\addcontentsline{lof}{figure}{Bacula Objects}
-\includegraphics{\idir bacula-objects.eps}
+%% \addcontentsline{lof}{figure}{Bacula Objects}
+%% \includegraphics{\idir bacula-objects}
+\bsysimageH{bacula-objects}{Bacula Objects}{figconfig:baculaobjects}
\label{ResFormat}
\section{Character Sets}
(including those read on Win32 machines) to be in UTF-8 format.
UTF-8 is typically the default on Linux machines, but not on all
Unix machines, nor on Windows, so you must take some care to ensure
-that your locale is set properly before starting Bacula.
+that your locale is set properly before starting Bacula.
To ensure that Bacula configuration files can be correctly read including
foreign characters the {bf LANG} environment variable
within the resource (within the braces) is composed of a keyword followed by
an equal sign (=) followed by one or more values. The keywords must be one of
the known Bacula resource record keywords, and it may be composed of upper or
-lower case characters and spaces.
+lower case characters and spaces.
Each resource definition MUST contain a Name directive, and may optionally
contain a Description directive. The Name directive is used to
uniquely identify the resource. The Description directive is (will be) used
during display of the Resource to provide easier human recognition. For
-example:
+example:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = "MyDir"
Description = "Main Bacula Director"
WorkingDirectory = "$HOME/bacula/bin/working"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Defines the Director resource with the name "MyDir" and a working directory
semicolon (;) is a logical end of line, and anything after the semicolon is
considered as the next statement. If a statement appears on a line by itself,
a semicolon is not necessary to terminate it, so generally in the examples in
-this manual, you will not see many semicolons.
+this manual, you will not see many semicolons.
\label{Case1}
\subsection{Upper and Lower Case and Spaces}
\index[general]{Upper and Lower Case and Spaces}
Case (upper/lower) and spaces are totally ignored in the resource directive
-keywords (the part before the equal sign).
+keywords (the part before the equal sign).
Within the keyword (i.e. before the equal sign), spaces are not significant.
Thus the keywords: {\bf name}, {\bf Name}, and {\bf N a m e} are all
-identical.
+identical.
Spaces after the equal sign and before the first character of the value are
-ignored.
+ignored.
In general, spaces within a value are significant (not ignored), and if the
value is a name, you must enclose the name in double quotes for the spaces to
Please note, however, that Bacula resource names as well as certain other
names (e.g. Volume names) must contain only letters (including ISO accented
-letters), numbers, and a few special characters (space, underscore, ...).
+letters), numbers, and a few special characters (space, underscore, ...).
All other characters and punctuation are invalid.
\label{Includes}
specification can be given anywhere a primitive token would appear.
If you wish include all files in a specific directory, you can use the following:
-\begin{verbatim}
+\begin{lstlisting}
# Include subfiles associated with configuration of clients.
# They define the bulk of the Clients, Jobs, and FileSets.
# Remember to "reload" the Director after adding a client file.
#
@|"sh -c 'for f in /etc/bacula/clientdefs/*.conf ; do echo @${f} ; done'"
-\end{verbatim}
+\end{lstlisting}
\label{DataTypes}
\subsection{Recognized Primitive Data Types}
When parsing the resource directives, Bacula classifies the data according to
the types listed below. The first time you read this, it may appear a bit
-overwhelming, but in reality, it is all pretty logical and straightforward.
+overwhelming, but in reality, it is all pretty logical and straightforward.
\begin{description}
name} must be a letter. A name has a maximum length currently set to 127
bytes. Typically keywords appear on the left side of an equal (i.e. they are
Bacula keywords -- i.e. Resource names or directive names). Keywords may not
-be quoted.
+be quoted.
\item [name-string]
\index[fd]{name-string}
values that correspond to filenames, directories, or system command names. A
backslash (\textbackslash{}) turns the next character into itself, so to
include a double quote in a string, you precede the double quote with a
-backslash. Likewise to include a backslash.
+backslash. Likewise to include a backslash.
\item [directory]
\index[dir]{directory}
A directory is either a quoted or non-quoted string. A directory will be
-passed to your standard shell for expansion when it is scanned. Thus
-constructs such as {\bf \$HOME} are interpreted to be their correct values.
+passed to your standard shell for expansion when it is scanned. Thus
+constructs such as {\bf \$HOME} are interpreted to be their correct values.
\item [password]
\index[dir]{password}
- This is a Bacula password and it is stored internally in MD5 hashed format.
+ This is a Bacula password and it is stored internally in MD5 hashed format.
\item [integer]
\index[dir]{integer}
- A 32 bit integer value. It may be positive or negative.
+ A 32 bit integer value. It may be positive or negative.
\item [positive integer]
\index[dir]{positive integer }
- A 32 bit positive integer value.
+ A 32 bit positive integer value.
\item [long integer]
\index[dir]{long integer}
A 64 bit integer value. Typically these are values such as bytes that can
-exceed 4 billion and thus require a 64 bit value.
+exceed 4 billion and thus require a 64 bit value.
\item [yes\vb{}no]
\index[dir]{yes or no }
- Either a {\bf yes} or a {\bf no}.
+ Either a {\bf yes} or a {\bf no}.
\label{Size1}
\item [size]
input format followed by an optional modifier. The floating point input is
stored as a 64 bit integer value. If a modifier is present, it must
immediately follow the value with no intervening spaces. The following
-modifiers are permitted:
+modifiers are permitted:
\begin{description}
\item [k]
- 1,024 (kilobytes)
+ 1,024 (kilobytes)
\item [kb]
- 1,000 (kilobytes)
+ 1,000 (kilobytes)
\item [m]
- 1,048,576 (megabytes)
+ 1,048,576 (megabytes)
\item [mb]
- 1,000,000 (megabytes)
+ 1,000,000 (megabytes)
\item [g]
- 1,073,741,824 (gigabytes)
+ 1,073,741,824 (gigabytes)
\item [gb]
- 1,000,000,000 (gigabytes)
+ 1,000,000,000 (gigabytes)
\end{description}
\label{Time}
\item [seconds]
\index[dir]{seconds}
- seconds
+ seconds
\item [minutes]
\index[dir]{minutes}
- minutes (60 seconds)
+ minutes (60 seconds)
\item [hours]
\index[dir]{hours }
- hours (3600 seconds)
+ hours (3600 seconds)
\item [days]
\index[dir]{days}
- days (3600*24 seconds)
+ days (3600*24 seconds)
\item [weeks]
\index[dir]{weeks}
\item [months]
\index[dir]{months }
- months (3600*24*30 seconds)
+ months (3600*24*30 seconds)
\item [quarters]
\index[dir]{quarters }
- quarters (3600*24*91 seconds)
+ quarters (3600*24*91 seconds)
\item [years]
\index[dir]{years }
- years (3600*24*365 seconds)
+ years (3600*24*365 seconds)
\end{description}
Any abbreviation of these modifiers is also permitted (i.e. {\bf seconds}
wish. For example:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
1 week 2 days 3 hours 10 mins
1 month 2 days 30 sec
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
are valid date specifications.
The following table lists all current Bacula resource types. It shows what
resources must be defined for each service (daemon). The default configuration
files will already contain at least one example of each permitted resource, so
-you need not worry about creating all these kinds of resources from scratch.
-
-\addcontentsline{lot}{table}{Resource Types}
-\begin{longtable}{|l|l|l|l|l|}
- \hline
-\multicolumn{1}{|c| }{\bf Resource } & \multicolumn{1}{c| }{\bf Director } &
-\multicolumn{1}{c| }{\bf Client } & \multicolumn{1}{c| }{\bf Storage } &
-\multicolumn{1}{c| }{\bf Console } \\
- \hline
-{Autochanger } & {No } & {No } & {Yes } & {No } \\
-\hline
-{Catalog } & {Yes } & {No } & {No } & {No } \\
- \hline
-{Client } & {Yes } & {Yes } & {No } & {No } \\
- \hline
-{Console } & {Yes } & {No } & {No } & {Yes } \\
- \hline
-{Device } & {No } & {No } & {Yes } & {No } \\
- \hline
-{Director } & {Yes } & {Yes } & {Yes } & {Yes } \\
- \hline
-{FileSet } & {Yes } & {No } & {No } & {No } \\
- \hline
-{Job } & {Yes } & {No } & {No } & {No } \\
- \hline
-{JobDefs } & {Yes } & {No } & {No } & {No } \\
- \hline
-{Message } & {Yes } & {Yes } & {Yes } & {No } \\
- \hline
-{Pool } & {Yes } & {No } & {No } & {No } \\
- \hline
-{Schedule } & {Yes } & {No } & {No } & {No } \\
- \hline
-{Storage } & {Yes } & {No } & {Yes } & {No }
-\\ \hline
-
-\end{longtable}
+you need not worry about creating all these kinds of resources from scratch.
+%\addcontentsline{lot}{table}{Resource Types}
+\LTXtable{0.95\linewidth}{table_resources}
\section{Names, Passwords and Authorization}
\label{Names}
\index[general]{Authorization!Names Passwords and }
The default configuration files are automatically defined for correct
authorization with random passwords. If you add to or modify these files, you
-will need to take care to keep them consistent.
+will need to take care to keep them consistent.
Here is sort of a picture of what names/passwords in which files/Resources
-must match up:
+must match up:
-\includegraphics{\idir Conf-Diagram.eps}
+%\includegraphics{\idir Conf-Diagram}
+\bsysimageH{Conf-Diagram}{Configuration diagram}{figconfig:configdiagram}
In the left column, you will find the Director, Storage, and Client resources,
with their names and passwords -- these are all in {\bf bacula-dir.conf}. In
the right column are where the corresponding values should be found in the
-Console, Storage daemon (SD), and File daemon (FD) configuration files.
+Console, Storage daemon (SD), and File daemon (FD) configuration files.
Please note that the Address, {\bf fd-sd}, that appears in the Storage
resource of the Director, preceded with and asterisk in the above example, is
daemon, which is most likely not what is desired. The password used for the
File daemon to authorize with the Storage daemon is a temporary password
unique to each Job created by the daemons and is not specified in any .conf
-file.
+file.
\section{Detailed Information for each Daemon}
\index[general]{Detailed Information for each Daemon }
\index[general]{Daemon!Detailed Information for each }
The details of each Resource and the directives permitted therein are
-described in the following chapters.
+described in the following chapters.
-The following configuration files must be defined:
+The following configuration files must be defined:
-\begin{itemize}
-\item
- \ilink{Console}{ConsoleConfChapter} -- to define the resources for
+\begin{bsysitemize}
+\item
+ \ilink{Console}{ConsoleConfChapter} -- to define the resources for
the Console program (user interface to the Director). It defines which
-Directors are available so that you may interact with them.
-\item
- \ilink{Director}{DirectorChapter} -- to define the resources
+Directors are available so that you may interact with them.
+\item
+ \ilink{Director}{DirectorChapter} -- to define the resources
necessary for the Director. You define all the Clients and Storage daemons
-that you use in this configuration file.
-\item
- \ilink{Client}{FiledConfChapter} -- to define the resources for
+that you use in this configuration file.
+\item
+ \ilink{Client}{FiledConfChapter} -- to define the resources for
each client to be backed up. That is, you will have a separate Client
-resource file on each machine that runs a File daemon.
-\item
- \ilink{Storage}{StoredConfChapter} -- to define the resources to
+resource file on each machine that runs a File daemon.
+\item
+ \ilink{Storage}{StoredConfChapter} -- to define the resources to
be used by each Storage daemon. Normally, you will have a single Storage
daemon that controls your tape drive or tape drives. However, if you have
tape drives on several machines, you will have at least one Storage daemon
-per machine.
-\end{itemize}
+per machine.
+\end{bsysitemize}
-%%
-%%
-
\chapter{Console Configuration}
\label{ConsoleConfChapter}
\index[general]{Configuration!Console}
The Console configuration file is the simplest of all the configuration files,
and in general, you should not need to change it except for the password. It
simply contains the information necessary to contact the Director or
-Directors.
+Directors.
For a general discussion of the syntax of configuration files and their
resources including the data types recognized by {\bf Bacula}, please see
the \ilink{Configuration}{ConfigureChapter} chapter of this manual.
-The following Console Resource definition must be defined:
+The following Console Resource definition must be defined:
\section{The Director Resource}
\label{DirectorResource3}
The Director resource defines the attributes of the Director running on the
network. You may have multiple Director resource specifications in a single
Console configuration file. If you have more than one, you will be prompted to
-choose one when you start the {\bf Console} program.
+choose one when you start the {\bf Console} program.
\begin{description}
\item [Director]
\item [Name = \lt{}name\gt{}]
\index[console]{Name}
The director name used to select among different Directors, otherwise, this
- name is not used.
+ name is not used.
\item [DIRPort = \lt{}port-number\gt{}]
\index[dir]{DIRPort}
\verb:--:with-baseport} option of the {\bf ./configure} command. This port must be
identical to the {\bf DIRport} specified in the {\bf Director} resource of
the \ilink{Director's configuration}{DirectorChapter} file. The
- default is 9101 so this directive is not normally specified.
+ default is 9101 so this directive is not normally specified.
\item [Address = \lt{}address\gt{}]
\index[dir]{Address}
Where the address is a host name, a fully qualified domain name, or a network
- address used to connect to the Director.
+ address used to connect to the Director.
\item [Password = \lt{}password\gt{}]
\index[dir]{Password}
Where the password is the password needed for the Director to accept the
Console connection. This password must be identical to the {\bf Password}
- specified in the {\bf Director} resource of the
- \ilink{Director's configuration}{DirectorChapter} file. This
- directive is required.
+ specified in the {\bf Director} resource of the
+ \ilink{Director's configuration}{DirectorChapter} file. This
+ directive is required.
\end{description}
-An actual example might be:
+An actual example might be:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = HeadMan
address = rufus.cats.com
password = xyz1erploit
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{The ConsoleFont Resource}
The ConsoleFont resource is available only in the GNOME version of the
console. It permits you to define the font that you want used to display in
-the main listing window.
+the main listing window.
\begin{description}
\item [ConsoleFont]
\index[console]{ConsoleFont}
- Start of the ConsoleFont directives.
+ Start of the ConsoleFont directives.
\item [Name = \lt{}name\gt{}]
\index[console]{Name}
- The name of the font.
+ The name of the font.
\item [Font = \lt{}Pango Font Name\gt{}]
\index[console]{Font}
The string value given here defines the desired font. It is specified in the
- Pango format. For example, the default specification is:
+ Pango format. For example, the default specification is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Font = "LucidaTypewriter 9"
-\end{verbatim}
+\end{lstlisting}
\normalsize
\end{description}
-Thanks to Phil Stracchino for providing the code for this feature.
+Thanks to Phil Stracchino for providing the code for this feature.
-An different example might be:
+An different example might be:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
ConsoleFont {
Name = Default
Font = "Monospace 10"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{The Console Resource}
user can use to interact with the Director. These three kinds of consoles
comprise three different security levels.
-\begin{itemize}
+\begin{bsysitemize}
\item The first console type is an {\bf anonymous} or {\bf default}
console, which has full privileges. There is no console resource
necessary for this type since the password is specified in the Director
This second type of console begins with absolutely no privileges except
those explicitly specified in the Director's Console resource. Note,
- the definition of what these restricted consoles can do is determined
+ the definition of what these restricted consoles can do is determined
by the Director's conf file.
Thus you may define within the Director's conf file multiple Consoles
DHCP (non-fixed IP addresses) to "notify" the Director of their current
IP address.
-\end{itemize}
+\end{bsysitemize}
The Console resource is optional and need not be specified. However, if it is
specified, you can use ACLs (Access Control Lists) in the Director's
configuration file to restrict the particular console (or user) to see only
-information pertaining to his jobs or client machine.
+information pertaining to his jobs or client machine.
You may specify as many Console resources in the console's conf file. If
you do so, generally the first Console resource will be used. However, if
The following configuration files were supplied by Phil Stracchino. For
example, if we define the following in the user's bconsole.conf file (or
-perhaps the bwx-console.conf file):
+perhaps the bwx-console.conf file):
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = MyDirector
DIRport = 9101
Password = "XXXXXXXXXXX" # no, really. this is not obfuscation.
}
-
+
Console {
Name = restricted-user
Password = "UntrustedUser"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Where the Password in the Director section is deliberately incorrect, and the
Console resource is given a name, in this case {\bf restricted-user}. Then
in the Director's bacula-dir.conf file (not directly accessible by the user),
-we define:
+we define:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Console {
Name = restricted-user
Password = "UntrustedUser"
CatalogACL = DefaultCatalog
CommandACL = run
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
the user logging into the Director from his Console will get logged in as {\bf
a FileSet named {\bf Restricted Client's FileSet}, a Catalog named {\bf
DefaultCatalog}, and the only command he can use in the Console is the {\bf
run} command. In other words, this user is rather limited in what he can see
-and do with Bacula.
+and do with Bacula.
The following is an example of a bconsole conf file that can access
several Directors and has different Consoles depending on the director:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = MyDirector
DIRport = 9101
Password = "A different UntrustedUser"
Director = SecondDirector
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
The second Director referenced at "secondserver" might look
like the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Console {
Name = restricted-user
Password = "A different UntrustedUser"
CommandACL = run, restore
WhereACL = "/"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\index[general]{Console Commands}
\index[general]{Commands!Console}
-For more details on running the console and its commands, please see the
-\ilink{Bacula Console}{_ConsoleChapter} chapter of this manual.
+For more details on running the console and its commands, please see the
+\bsysxrlink{Bacula Console}{_ConsoleChapter}{console}{chapter} of the \consoleman{}.
\section{Sample Console Configuration File}
\label{SampleConfiguration2}
\index[general]{File!Sample Console Configuration}
\index[general]{Sample Console Configuration File}
-An example Console configuration file might be the following:
+An example Console configuration file might be the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# Bacula Console Configuration File
#
address = "my_machine.my_domain.com"
Password = Console_password
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
+++ /dev/null
-
-\newfont{\bighead}{cmr17 at 36pt}
-\parskip 10pt
-\parindent 0pt
-
-\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip
- \Huge{Bacula}$^{\normalsize \textregistered}$ \Huge{Bacula Main Reference}
- \begin{center}
- \large{The Leading Open Source Backup Solution. }
- \end{center}
-}
-
-
-\author{Kern Sibbald}
-\date{\vspace{1.0in}\today \\
- This manual documents Bacula version \input{version} \\
- \vspace{0.2in}
- Copyright {\copyright} 1999-2010, Free Software Foundation Europe
- e.V. \\
- Bacula {\textregistered} is a registered trademark of Kern Sibbald.\\
- \vspace{0.2in}
- Permission is granted to copy, distribute and/or modify this document under the terms of the
- GNU Free Documentation License, Version 1.2 published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU Free Documentation License".
-}
-
-\maketitle
--- /dev/null
+../../licences/coverpage.tex
\ No newline at end of file
If you follow the instructions in this chapter, you will have covered most of
the major problems that can occur. It goes without saying that if you ever
find that we have left out an important point, please inform us, so
-that we can document it to the benefit of everyone.
+that we can document it to the benefit of everyone.
+
-\label{Critical}
\section{Critical Items}
+\label{Critical}
\index[general]{Critical Items }
\index[general]{Items!Critical }
would use in setting up a production system (if you already are in
production, use the checklist anyway).
-\begin{itemize}
+\begin{bsysitemize}
\item Test your tape drive for compatibility with Bacula by using the test
- command in the \ilink{btape}{btape} program.
-\item Better than doing the above is to walk through the nine steps in the
- \ilink{Tape Testing}{TapeTestingChapter} chapter of the manual. It
- may take you a bit of time, but it will eliminate surprises.
+ command in the See the \bsysxrlink{btape}{btape}{utility}{section} of the \utilityman{}.
+\item Better than doing the above is to walk through the nine steps in the
+ \bsysxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}. It
+ may take you a bit of time, but it will eliminate surprises.
\item Test the end of tape handling of your tape drive by using the
- fill command in the \ilink{btape}{btape} program.
+ \texttt{fill} command in the \bsysxrlink{btape program}{btape}{utility}{section} (Part of the \utilityman{})
\item If you are using a Linux 2.4 kernel, make sure that /lib/tls is disabled. Bacula
- does not work with this library. See the second point under
- \ilink{ Supported Operating Systems.}{SupportedOSes}
+ does not work with this library. See the second point under
+ \ilink{ Supported Operating Systems.}{SupportedOSes}
\item Do at least one restore of files. If you backup multiple OS types
(Linux, Solaris, HP, MacOS, FreeBSD, Win32, ...),
- restore files from each system type. The
- \ilink{Restoring Files}{RestoreChapter} chapter shows you how.
+ restore files from each system type. The
+ \ilink{Restoring Files}{RestoreChapter} chapter shows you how.
\item Write a bootstrap file to a separate system for each backup job. The
- Write Bootstrap directive is described in the
+ Write Bootstrap directive is described in the
\ilink{Director Configuration}{writebootstrap} chapter of the
- manual, and more details are available in the
+ manual, and more details are available in the
\ilink{Bootstrap File}{BootstrapChapter} chapter. Also, the default
bacula-dir.conf comes with a Write Bootstrap directive defined. This allows
- you to recover the state of your system as of the last backup.
+ you to recover the state of your system as of the last backup.
\item Backup your catalog. An example of this is found in the default
bacula-dir.conf file. The backup script is installed by default and
should handle any database, though you may want to make your own local
\item Write a bootstrap file for the catalog. An example of this is found in
the default bacula-dir.conf file. This will allow you to quickly restore your
catalog in the event it is wiped out -- otherwise it is many excruciating
- hours of work.
+ hours of work.
\item Make a copy of the bacula-dir.conf, bacula-sd.conf, and
bacula-fd.conf files that you are using on your server. Put it in a safe
place (on another machine) as these files can be difficult to
reconstruct if your server dies.
-\item Make a Bacula Rescue CDROM! See the
+\item Make a Bacula Rescue CDROM! See the
\ilink{Disaster Recovery Using a Bacula Rescue
CDROM}{RescueChapter} chapter. It is trivial to make such a CDROM,
and it can make system recovery in the event of a lost hard disk infinitely
- easier.
-\item Bacula assumes all filenames are in UTF-8 format. This is important
+ easier.
+\item Bacula assumes all filenames are in UTF-8 format. This is important
when saving the filenames to the catalog. For Win32 machine, Bacula will
automatically convert from Unicode to UTF-8, but on Unix, Linux, *BSD,
and MacOS X machines, you must explicitly ensure that your locale is set
On most modern Win32 machines, you can edit the conf files with {\bf
notepad} and choose output encoding UTF-8.
-\end{itemize}
+\end{bsysitemize}
\section{Recommended Items}
\index[general]{Items!Recommended }
\index[general]{Recommended Items }
Although these items may not be critical, they are recommended and will help
-you avoid problems.
+you avoid problems.
-\begin{itemize}
-\item Read the \ilink{Quick Start Guide to Bacula}{QuickStartChapter}
-\item After installing and experimenting with Bacula, read and work carefully
- through the examples in the
- \ilink{Tutorial}{TutorialChapter} chapter of this manual.
-\item Learn what each of the \ilink{Bacula Utility Programs}{_UtilityChapter}
- does.
+\begin{bsysitemize}
+\item Read the \ilink{Quick Start Guide to Bacula}{QuickStartChapter}
+\item After installing and experimenting with Bacula, read and work carefully
+ through the examples in the
+ \ilink{Tutorial}{TutorialChapter} chapter of this manual.
+\item Learn what each of the \bsysxrlinkdocument{Bacula Utility Programs}{_UtilityChapter}{utility}{chapter}
+ does.
\item Set up reasonable retention periods so that your catalog does not grow
- to be too big. See the following three chapters:\\
- \ilink{Recycling your Volumes}{RecyclingChapter},\\
- \ilink{Basic Volume Management}{DiskChapter},\\
- \ilink{Using Pools to Manage Volumes}{PoolsChapter}.
-\item Perform a bare metal recovery using the Bacula Rescue CDROM. See the
+ to be too big. See the following three chapters:
+ \begin{bsysitemize}
+ \item \ilink{Recycling your Volumes}{RecyclingChapter},
+ \item \ilink{Basic Volume Management}{DiskChapter},
+ \item \ilink{Using Pools to Manage Volumes}{PoolsChapter}.
+ \end{bsysitemize}
+\item Perform a bare metal recovery using the Bacula Rescue CDROM. See the
\ilink{Disaster Recovery Using a Bacula Rescue CDROM}{RescueChapter}
- chapter.
-\end{itemize}
+ chapter.
+\end{bsysitemize}
-If you absolutely must implement a system where you write a different
-tape each night and take it offsite in the morning. We recommend that you do
+If you absolutely must implement a system where you write a different
+tape each night and take it offsite in the morning. We recommend that you do
several things:
-\begin{itemize}
+\begin{bsysitemize}
\item Write a bootstrap file of your backed up data and a bootstrap file
of your catalog backup to a floppy disk or a CDROM, and take that with
- the tape. If this is not possible, try to write those files to another
+ the tape. If this is not possible, try to write those files to another
computer or offsite computer, or send them as email to a friend. If none
of that is possible, at least print the bootstrap files and take that
offsite with the tape. Having the bootstrap files will make recovery
select any tape from that list. Bacula may propose a particular tape
for use that it considers optimal, but it will accept any valid tape
from the correct pool.
-\end{itemize}
+\end{bsysitemize}
It is very important to specify what this implementation does NOT
do:
-\begin{itemize}
+\begin{bsysitemize}
\item There is one important restore problem to be aware of, namely, it's
possible for the director to restore new keys or a Bacula configuration
file to the client, and thus force later backups to be made with a
\item The implementation does not encrypt file metadata such as file path
names, permissions, and ownership. Extended attributes are also currently
not encrypted. However, Mac OS X resource forks are encrypted.
-\end{itemize}
+\end{bsysitemize}
Encryption and signing are implemented using RSA private keys coupled with
self-signed x509 public certificates. This is also sometimes known as PKI
-or Public Key Infrastructure.
+or Public Key Infrastructure.
Each File Daemon should be given its own unique private/public key pair.
In addition to this key pair, any number of "Master Keys" may be specified
The basic algorithm used for each backup session (Job) is:
\begin{enumerate}
\item The File daemon generates a session key.
-\item The FD encrypts that session key via PKE for all recipients (the file
+\item The FD encrypts that session key via PKE for all recipients (the file
daemon, any master keys).
\item The FD uses that session key to perform symmetric encryption on the data.
\end{enumerate}
since Bacula 1.38. To build Bacula with encryption support, you will need
the OpenSSL libraries and headers installed. When configuring Bacula, use:
-\begin{verbatim}
+\begin{lstlisting}
./configure --with-openssl ...
-\end{verbatim}
+\end{lstlisting}
\section{Encryption Technical Details}
\index[general]{Encryption Technical Details}
digest algorithms for future extensibility, and the back-end
implementation currently supports:
-\begin{verbatim}
+\begin{lstlisting}
Symmetric Encryption:
- 128, 192, and 256-bit AES-CBC
- Blowfish-CBC
- SHA1
- SHA256
- SHA512
-\end{verbatim}
+\end{lstlisting}
The various algorithms are exposed via an entirely re-usable,
OpenSSL-agnostic API (ie, it is possible to drop in a new encryption
\section{Decrypting with a Master Key}
\index[general]{Decrypting with a Master Key}
-It is preferable to retain a secure, non-encrypted copy of the
-client's own encryption keypair. However, should you lose the
+It is preferable to retain a secure, non-encrypted copy of the
+client's own encryption keypair. However, should you lose the
client's keypair, recovery with the master keypair is possible.
You must:
-\begin{itemize}
-\item Concatenate the master private and public key into a single
+\begin{bsysitemize}
+\item Concatenate the master private and public key into a single
keypair file, ie:
cat master.key master.cert \gt master.keypair
\item Set the PKI Keypair statement in your bacula configuration file:
-\begin{verbatim}
+\begin{lstlisting}
PKI Keypair = master.keypair
-\end{verbatim}
+\end{lstlisting}
\item Start the restore. The master keypair will be used to decrypt
the file data.
-
-\end{itemize}
+
+\end{bsysitemize}
\section{Generating Private/Public Encryption Keys}
Generate a Master Key Pair with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
openssl genrsa -out master.key 2048
openssl req -new -key master.key -x509 -out master.cert
-\end{verbatim}
+\end{lstlisting}
\normalsize
Generate a File Daemon Key Pair for each FD:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
openssl genrsa -out fd-example.key 2048
openssl req -new -key fd-example.key -x509 -out fd-example.cert
cat fd-example.key fd-example.cert >fd-example.pem
-\end{verbatim}
+\end{lstlisting}
\normalsize
Note, there seems to be a lot of confusion around the file extensions given
to these keys. For example, a .pem file can contain all the following:
-private keys (RSA and DSA), public keys (RSA and DSA) and (x509) certificates.
+private keys (RSA and DSA), public keys (RSA and DSA) and (x509) certificates.
It is the default format for OpenSSL. It stores data Base64 encoded DER format,
surrounded by ASCII headers, so is suitable for text mode transfers between
systems. A .pem file may contain any number of keys either public or
{\bf bacula-fd.conf}
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileDaemon {
Name = example-fd
FDport = 9102 # where we listen for the director
WorkingDirectory = /var/bacula/working
Pid Directory = /var/run
Maximum Concurrent Jobs = 20
-
+
PKI Signatures = Yes # Enable Data Signing
PKI Encryption = Yes # Enable Data Encryption
PKI Keypair = "/etc/bacula/fd-example.pem" # Public and Private Keys
PKI Master Key = "/etc/bacula/master.cert" # ONLY the Public Key
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Of all the configuration files needed to run {\bf Bacula}, the Director's is
the most complicated, and the one that you will need to modify the most often
-as you add clients or modify the FileSets.
+as you add clients or modify the FileSets.
For a general discussion of configuration files and resources including the
-data types recognized by {\bf Bacula}. Please see the
-\ilink{Configuration}{ConfigureChapter} chapter of this manual.
+data types recognized by {\bf Bacula}. Please see the
+\ilink{Configuration}{ConfigureChapter} chapter of this manual.
\section{Director Resource Types}
\index[general]{Types!Director Resource}
\index[general]{Director Resource Types}
-Director resource type may be one of the following:
+Director resource type may be one of the following:
Job, JobDefs, Client, Storage, Catalog, Schedule, FileSet, Pool, Director, or
-Messages. We present them here in the most logical order for defining them:
+Messages. We present them here in the most logical order for defining them:
Note, everything revolves around a job and is tied to a job in one
way or another.
-\begin{itemize}
-\item
+\begin{bsysitemize}
+\item
\ilink{Director}{DirectorResource4} -- to define the Director's
name and its access password used for authenticating the Console program.
- Only a single Director resource definition may appear in the Director's
+ Only a single Director resource definition may appear in the Director's
configuration file. If you have either {\bf /dev/random} or {\bf bc} on your
machine, Bacula will generate a random password during the configuration
- process, otherwise it will be left blank.
-\item
- \ilink{Job}{JobResource} -- to define the backup/restore Jobs
+ process, otherwise it will be left blank.
+\item
+ \ilink{Job}{JobResource} -- to define the backup/restore Jobs
and to tie together the Client, FileSet and Schedule resources to be used
for each Job. Normally, you will Jobs of different names corresponding
to each client (i.e. one Job per client, but a different one with a different name
for each client).
-\item
- \ilink{JobDefs}{JobDefsResource} -- optional resource for
- providing defaults for Job resources.
-\item
- \ilink{Schedule}{ScheduleResource} -- to define when a Job is to
- be automatically run by {\bf Bacula's} internal scheduler. You
+\item
+ \ilink{JobDefs}{JobDefsResource} -- optional resource for
+ providing defaults for Job resources.
+\item
+ \ilink{Schedule}{ScheduleResource} -- to define when a Job is to
+ be automatically run by {\bf Bacula's} internal scheduler. You
may have any number of Schedules, but each job will reference only
one.
-\item
- \ilink{FileSet}{FileSetResource} -- to define the set of files
+\item
+ \ilink{FileSet}{FileSetResource} -- to define the set of files
to be backed up for each Client. You may have any number of
FileSets but each Job will reference only one.
-\item
+\item
\ilink{Client}{ClientResource2} -- to define what Client is to be
- backed up. You will generally have multiple Client definitions. Each
+ backed up. You will generally have multiple Client definitions. Each
Job will reference only a single client.
-\item
+\item
\ilink{Storage}{StorageResource2} -- to define on what physical
device the Volumes should be mounted. You may have one or
more Storage definitions.
-\item
+\item
\ilink{Pool}{PoolResource} -- to define the pool of Volumes
that can be used for a particular Job. Most people use a
single default Pool. However, if you have a large number
of clients or volumes, you may want to have multiple Pools.
Pools allow you to restrict a Job (or a Client) to use
only a particular set of Volumes.
-\item
+\item
\ilink{Catalog}{CatalogResource} -- to define in what database to
- keep the list of files and the Volume names where they are backed up.
+ keep the list of files and the Volume names where they are backed up.
Most people only use a single catalog. However, if you want to
scale the Director to many clients, multiple catalogs can be helpful.
Multiple catalogs require a bit more management because in general
- you must know what catalog contains what data. Currently, all
+ you must know what catalog contains what data. Currently, all
Pools are defined in each catalog. This restriction will be removed
in a later release.
-\item
+\item
\ilink{Messages}{MessagesChapter} -- to define where error and
information messages are to be sent or logged. You may define
multiple different message resources and hence direct particular
- classes of messages to different users or locations (files, ...).
-\end{itemize}
+ classes of messages to different users or locations (files, \ldots{}).
+\end{bsysitemize}
\label{DirectorResource4}
\section{The Director Resource}
The Director resource defines the attributes of the Directors running on the
network. In the current implementation, there is only a single Director
resource, but the final design will contain multiple Directors to maintain
-index and media database redundancy.
+index and media database redundancy.
\begin{description}
\item [Director]
\index[dir]{Director}
Start of the Director resource. One and only one director resource must be
-supplied.
+supplied.
\label{Director:Name}
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
The director name used by the system administrator. This directive is
-required.
+required.
\label{Director:Description}
\item [Description = \lt{}text\gt{}]
\index[dir]{Description}
\index[dir]{Directive!Description}
The text field contains a description of the Director that will be displayed
-in the graphical user interface. This directive is optional.
+in the graphical user interface. This directive is optional.
\label{Director:Password}
\item [Password = \lt{}UA-password\gt{}]
it.
The password is plain text. It is not generated through any special
- process but as noted above, it is better to use random text for
+ process but as noted above, it is better to use random text for
security reasons.
\label{Director:Messages}
\index[dir]{Directive!Messages}
The messages resource specifies where to deliver Director messages that are
not associated with a specific Job. Most messages are specific to a job and
- will be directed to the Messages resource specified by the job. However,
+ will be directed to the Messages resource specified by the job. However,
there are a few messages that can occur when no job is running. This
- directive is required.
+ directive is required.
\label{Director:WorkingDirectory}
\item [Working Directory = \lt{}Directory\gt{}]
\index[dir]{Working Directory}
\index[dir]{Directive!Working Directory}
- This directive is mandatory and specifies a directory in which the Director
+ This directive is mandatory and specifies a directory in which the Director
may put its status files. This directory should be used only by Bacula but
may be shared by other Bacula daemons. However, please note, if this
directory is shared with other Bacula daemons (the File daemon and Storage
unique so that the temporary filenames used do not collide. By default
the Bacula configure process creates unique daemon names by postfixing them
with -dir, -fd, and -sd. Standard shell expansion of the {\bf
- Directory} is done when the configuration file is read so that values such
+ Directory} is done when the configuration file is read so that values such
as {\bf \$HOME} will be properly expanded. This directive is required.
The working directory specified must already exist and be
readable and writable by the Bacula daemon referencing it.
If you have specified a Director user and/or a Director group on your
- ./configure line with {\bf {-}{-}with-dir-user} and/or
+ ./configure line with {\bf {-}{-}with-dir-user} and/or
{\bf {-}{-}with-dir-group} the Working Directory owner and group will
be set to those values.
\item [Pid Directory = \lt{}Directory\gt{}]
\index[dir]{Pid Directory}
\index[dir]{Directive!Pid Directory}
- This directive is mandatory and specifies a directory in which the Director
+ This directive is mandatory and specifies a directory in which the Director
may put its process Id file. The process Id file is used to shutdown
- Bacula and to prevent multiple copies of Bacula from running simultaneously.
+ Bacula and to prevent multiple copies of Bacula from running simultaneously.
Standard shell expansion of the {\bf Directory} is done when the
configuration file is read so that values such as {\bf \$HOME} will be
- properly expanded.
+ properly expanded.
The PID directory specified must already exist and be
readable and writable by the Bacula daemon referencing it
Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
not installing Bacula in the system directories, you can use the {\bf Working
- Directory} as defined above. This directive is required.
+ Directory} as defined above. This directive is required.
\label{Director:ScriptsDirectory}
\item [Scripts Directory = \lt{}Directory\gt{}]
set a keepalive interval (heartbeat) in seconds on each of the sockets
it opens for the Client resource. This value will override any
specified at the Director level. It is implemented only on systems
- (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
+ (Linux, \ldots{}) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
The default value is zero, which means no change is made to the socket.
\label{DirMaxConJobs}
\index[general]{Simultaneous Jobs}
\index[general]{Concurrent Jobs}
where \lt{}number\gt{} is the maximum number of total Director Jobs that
- should run concurrently. The default is set to 1, but you may set it to a
- larger number.
+ should run concurrently. The default is set to 1, but you may set it to a
+ larger number.
- The Volume format becomes more complicated with
+ The Volume format becomes more complicated with
multiple simultaneous jobs, consequently, restores may take longer if
Bacula must sort through interleaved volume blocks from multiple simultaneous
jobs. This can be avoided by having each simultaneous job write to
this is to show an example:
\footnotesize
-\begin{verbatim}
- DirAddresses = {
+\begin{lstlisting}
+ DirAddresses = {
ip = { addr = 1.2.3.4; port = 1205;}
ipv4 = {
addr = 1.2.3.4; port = http;}
addr = bluedot.thun.net
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
as a number or as the mnemonic value from the /etc/services file. If a port
is not specified, the default will be used. If an ip section is specified,
the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
-only IPv4 resolutions will be permitted, and likewise with ip6.
+only IPv4 resolutions will be permitted, and likewise with ip6.
Please note that if you use the DirAddresses directive, you must
-not use either a DirPort or a DirAddress directive in the same
+not use either a DirPort or a DirAddress directive in the same
resource.
\label{Director:DirPort}
specified. If this record is not specified, the Director server will source
its outgoing connections according to the system routing table (the default).
- \label{Director:StatisticsRetention}
+\phantomsection
+\label{Director:StatisticsRetention}
\item[Statistics Retention = \lt{}time\gt{}]
\index[dir]{StatisticsRetention}
\label{PruneStatistics}
Job records that are older than the specified period.
Theses statistics records aren't use for restore purpose, but mainly for
- capacity planning, billings, etc. See \ilink{Statistics chapter} for
+ capacity planning, billings, etc. See \ilink{Statistics chapter}{UseBaculaCatalogToExtractInformationChapter} for
additional information.
See the \ilink{ Configuration chapter}{Time} of this manual for additional
This string is displayed using the \texttt{version} command.
\label{Director:MaximumConsoleConnections}
-\item[MaximumConsoleConnections = \lt{}number\gt{}]
+\item[MaximumConsoleConnections = \lt{}number\gt{}]
\index[dir]{MaximumConsoleConnections}
\index[dir]{Directive!MaximumConsoleConnections}
\index[dir]{Console}
where \lt{}number\gt{} is the maximum number of Console Connections that
- could run concurrently. The default is set to 20, but you may set it to a
+ could run concurrently. The default is set to 20, but you may set it to a
larger number.
\label{Director:MaximumReloadRequests}
sufficient.
% \label{Director:SharedStorage}
-%\item[SharedStorage = \lt{}yes\vb{}no\gt{}]
+%\item[SharedStorage = \lt{}yes\vb{}no\gt{}]
% \index[dir]{SharedStorage}
% \index[dir]{Directive!SharedStorage}
-%
+%
% The \texttt{Shared Storage} directive is a Bacula Enterprise feature that
% allows you to share volumes between different Storage resources. This
% directive should be used \textbf{only} if all \texttt{Media Type} are
% \texttt{update slots} command. This script can be scheduled once a day in
% an Admin job.
%
-%\begin{verbatim}
+%\begin{lstlisting}
% $ /opt/bacula/scripts/reset-storageid MediaType StorageName
% $ bconsole
% * update slots storage=StorageName drive=0
-%\end{verbatim}
+%\end{lstlisting}
%
% Please contact Bacula Systems support to get help on this advanced
% configuration.
\end{description}
-The following is an example of a valid Director resource definition:
+The following is an example of a valid Director resource definition:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = HeadMan
WorkingDirectory = "$HOME/bacula/bin/working"
QueryFile = "$HOME/bacula/bin/query.sql"
Messages = Standard
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{JobResource}
\index[general]{Resource!Job}
\index[general]{Job Resource}
-The Job resource defines a Job (Backup, Restore, ...) that Bacula must
+The Job resource defines a Job (Backup, Restore, \ldots{}) that Bacula must
perform. Each Job resource definition contains the name of a Client and
a FileSet to backup, the Schedule for the Job, where the data
are to be stored, and what media Pool can be used. In effect, each Job
Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
be specified for a restore job for historical reasons, but it is no longer used.
-Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any
+Only a single type ({\bf Backup}, {\bf Restore}, \ldots{}) can be specified for any
job. If you want to backup multiple FileSets on the same Client or multiple
-Clients, you must define a Job for each one.
+Clients, you must define a Job for each one.
Note, you define only a single Job to do the Full, Differential, and
-Incremental backups since the different backup levels are tied together by
-a unique Job name. Normally, you will have only one Job per Client, but
+Incremental backups since the different backup levels are tied together by
+a unique Job name. Normally, you will have only one Job per Client, but
if a client has a really huge number of files (more than several million),
you might want to split it into to Jobs each with a different FileSet
covering only part of the total files.
restore will not work. This problem can be resolved by defining multiple
FileSet definitions (the names must be different, but the contents of
the FileSets may be the same).
-
+
\begin{description}
\item [Job]
\index[dir]{Job}
\index[dir]{Directive!Job}
- Start of the Job resource. At least one Job resource is required.
+ Start of the Job resource. At least one Job resource is required.
\label{Job:Name}
\item [Name = \lt{}name\gt{}]
console program to start a job. If the name contains spaces, it must be
specified between quotes. It is generally a good idea to give your job the
same name as the Client that it will backup. This permits easy
- identification of jobs.
+ identification of jobs.
When the job actually runs, the unique Job Name will consist of the name you
specify here followed by the date and time the job was scheduled for
- execution. This directive is required.
+ execution. This directive is required.
\label{Job:Enable}
\item [Enabled = \lt{}yes\vb{}no\gt{}]
\index[dir]{Directive!Type}
The {\bf Type} directive specifies the Job type, which may be one of the
following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
- directive is required. Within a particular Job Type, there are also Levels
- as discussed in the next item.
+ directive is required. Within a particular Job Type, there are also Levels
+ as discussed in the next item.
\begin{description}
Run a backup Job. Normally you will have at least one Backup job for each
client you want to save. Normally, unless you turn off cataloging, most all
the important statistics and data concerning files backed up will be placed
- in the catalog.
+ in the catalog.
\item [Restore]
\index[dir]{Restore}
Run a verify Job. In general, {\bf verify} jobs permit you to compare the
contents of the catalog to the file system, or to what was backed up. In
addition, to verifying that a tape that was written can be read, you can
- also use {\bf verify} as a sort of tripwire intrusion detection.
+ also use {\bf verify} as a sort of tripwire intrusion detection.
\item [Admin]
\index[dir]{Admin}
Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
pruning, if you do not want to do it at the end of each {\bf Backup} Job.
- Although an Admin job is recorded in the catalog, very little data is saved.
+ Although an Admin job is recorded in the catalog, very little data is saved.
\end{description}
\label{Level}
\index[dir]{Level}
\index[dir]{Directive!Level}
The Level directive specifies the default Job level to be run. Each
- different Job Type (Backup, Restore, ...) has a different set of Levels
+ different Job Type (Backup, Restore, \ldots{}) has a different set of Levels
that can be specified. The Level is normally overridden by a different
value that is specified in the {\bf Schedule} resource. This directive
is not required, but must be specified either by a {\bf Level} directive
or as an override specified in the {\bf Schedule} resource.
-For a {\bf Backup} Job, the Level may be one of the following:
+For a {\bf Backup} Job, the Level may be one of the following:
\begin{description}
into a Full backup. When the Director looks for a valid backup record
in the catalog database, it looks for a previous Job with:
-\begin{itemize}
-\item The same Job name.
-\item The same Client name.
+\begin{bsysitemize}
+\item The same Job name.
+\item The same Client name.
\item The same FileSet (any change to the definition of the FileSet such as
adding or deleting a file in the Include or Exclude sections constitutes a
- different FileSet.
-\item The Job was a Full, Differential, or Incremental backup.
-\item The Job terminated normally (i.e. did not fail or was not canceled).
+ different FileSet.
+\item The Job was a Full, Differential, or Incremental backup.
+\item The Job terminated normally (i.e. did not fail or was not canceled).
\item The Job started no longer ago than {\bf Max Full Interval}.
-\end{itemize}
+\end{bsysitemize}
If all the above conditions do not hold, the Director will upgrade the
Incremental to a Full save. Otherwise, the Incremental backup will be
- performed as requested.
+ performed as requested.
The File daemon (Client) decides which files to backup for an
Incremental backup by comparing start time of the prior Job (Full,
Differential, or Incremental) against the time each file was last
- "modified" (st\_mtime) and the time its attributes were last
- "changed"(st\_ctime). If the file was modified or its attributes
+ ``modified'' (st\_mtime) and the time its attributes were last
+ ``changed''(st\_ctime). If the file was modified or its attributes
changed on or after this start time, it will then be backed up.
Some virus scanning software may change st\_ctime while
When the Director looks for a valid Full backup record in the catalog
database, it looks for a previous Job with:
-\begin{itemize}
-\item The same Job name.
-\item The same Client name.
+\begin{bsysitemize}
+\item The same Job name.
+\item The same Client name.
\item The same FileSet (any change to the definition of the FileSet such as
adding or deleting a file in the Include or Exclude sections constitutes a
- different FileSet.
-\item The Job was a FULL backup.
-\item The Job terminated normally (i.e. did not fail or was not canceled).
+ different FileSet.
+\item The Job was a FULL backup.
+\item The Job terminated normally (i.e. did not fail or was not canceled).
\item The Job started no longer ago than {\bf Max Full Interval}.
-\end{itemize}
+\end{bsysitemize}
If all the above conditions do not hold, the Director will upgrade the
Differential to a Full save. Otherwise, the Differential backup will be
- performed as requested.
+ performed as requested.
The File daemon (Client) decides which files to backup for a
differential backup by comparing the start time of the prior Full backup
- Job against the time each file was last "modified" (st\_mtime) and the
- time its attributes were last "changed" (st\_ctime). If the file was
+ Job against the time each file was last ``modified'' (st\_mtime) and the
+ time its attributes were last ``changed'' (st\_ctime). If the file was
modified or its attributes were changed on or after this start time, it
will then be backed up. The start time used is displayed after the {\bf
Since} on the Job report. In rare cases, using the start time of the
delete the original. Alternatively, you can move the directory, then
use the {\bf touch} program to update the timestamps.
-%% TODO: merge this with incremental
+%% TODO: merge this with incremental
However, to manage deleted files or directories changes in the
catalog during an Differential backup you can use \texttt{accurate}
mode. This is quite memory consuming process. See \ilink{Accurate
\end{description}
-For a {\bf Restore} Job, no level needs to be specified.
+For a {\bf Restore} Job, no level needs to be specified.
-For a {\bf Verify} Job, the Level may be one of the following:
+For a {\bf Verify} Job, the Level may be one of the following:
\begin{description}
have been modified or deleted and if any new files have been added.
This can be used to detect system intrusion. Typically you would
specify a {\bf FileSet} that contains the set of system files that
- should not change (e.g. /sbin, /boot, /lib, /bin, ...). Normally, you
+ should not change (e.g. /sbin, /boot, /lib, /bin, \ldots{}). Normally, you
run the {\bf InitCatalog} level verify one time when your system is
first setup, and then once again after each modification (upgrade) to
your system. Thereafter, when your want to check the state of your
In accurate mode, the File daemon knowns exactly which files were present
after the last backup. So it is able to handle deleted or renamed files.
- When restoring a FileSet for a specified date (including "most
- recent"), Bacula is able to restore exactly the files and
+ When restoring a FileSet for a specified date (including ``most
+ recent''), Bacula is able to restore exactly the files and
directories that existed at the time of the last backup prior to
that date including ensuring that deleted files are actually deleted,
and renamed directories are restored properly.
script that emails you the bootstrap record.
On versions 1.39.22 or greater, before opening the file or executing the
- specified command, Bacula performs
+ specified command, Bacula performs
\ilink{character substitution}{character substitution} like in RunScript
directive. To automatically manage your bootstrap files, you can use
this in your {\bf JobDefs} resources:
-\begin{verbatim}
+\begin{lstlisting}
JobDefs {
Write Bootstrap = "%c_%n.bsr"
...
}
-\end{verbatim}
+\end{lstlisting}
For more details on using this file, please see the chapter entitled
\ilink{The Bootstrap File}{BootstrapChapter} of this manual.
the current Job. Only a single Client may be specified in any one Job. The
Client runs on the machine to be backed up, and sends the requested files to
the Storage daemon for backup, or receives them when restoring. For
- additional details, see the
+ additional details, see the
\ilink{Client Resource section}{ClientResource2} of this chapter.
- This directive is required.
+ This directive is required.
\label{Job:FileSet}
\item [FileSet = \lt{}FileSet-resource-name\gt{}]
\index[dir]{Directive!FileSet}
The FileSet directive specifies the FileSet that will be used in the
current Job. The FileSet specifies which directories (or files) are to
- be backed up, and what options to use (e.g. compression, ...). Only a
+ be backed up, and what options to use (e.g. compression, \ldots{}). Only a
single FileSet resource may be specified in any one Job. For additional
details, see the \ilink{FileSet Resource section}{FileSetResource} of
this chapter. This directive is required.
\label{Job:Base}
-\item [Base = \lt{}job-resource-name, ...\gt{}]
+\item [Base = \lt{}job-resource-name, \ldots{}\gt{}]
\index[dir]{Base}
\index[dir]{Directive!Base}
The Base directive permits to specify the list of jobs that will be used during
The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
It will override any Pool specification during a Full backup. This
directive is optional.
-
+
\label{Job:DifferentialBackupPool}
-\item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
+\item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
\index[dir]{Differential Backup Pool}
\index[dir]{Directive!Differential Backup Pool}
The {\it Differential Backup Pool} specifies a Pool to be used for
Differential backups. It will override any Pool specification during a
Differential backup. This directive is optional.
-
+
\label{Job:IncrementalBackupPool}
-\item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
+\item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
\index[dir]{Incremental Backup Pool}
\index[dir]{Directive!Incremental Backup Pool}
The {\it Incremental Backup Pool} specifies a Pool to be used for
\index[dir]{Directive!Schedule}
The Schedule directive defines what schedule is to be used for the Job.
The schedule in turn determines when the Job will be automatically
- started and what Job level (i.e. Full, Incremental, ...) is to be run.
+ started and what Job level (i.e. Full, Incremental, \ldots{}) is to be run.
This directive is optional, and if left out, the Job can only be started
manually using the Console program. Although you may specify only a
single Schedule resource for any one job, the Schedule resource may
considerable flexibility in what can be done with a single Job. For
additional details, see the \ilink{Schedule Resource
Chapter}{ScheduleResource} of this manual.
-
+
\label{Job:Storage}
\item [Storage = \lt{}storage-resource-name\gt{}]
\index[dir]{Directive!Max Run Time}
The time specifies the maximum allowed time that a job may run, counted
from when the job starts, ({\bf not} necessarily the same as when the
- job was scheduled).
+ job was scheduled).
By default, the the watchdog thread will kill any Job that has run more
than 6 days. The maximum watchdog timeout is independent of MaxRunTime
\begin{figure}[htbp]
\centering
- \includegraphics[width=13cm]{\idir different_time.eps}
+ \includegraphics[width=13cm]{\idir different_time}
\label{fig:differenttime}
\caption{Job time control directives}
\end{figure}
yes), the Storage daemon is requested to select either an Autochanger or
a drive with a valid Volume already mounted in preference to a drive
that is not ready. This means that all jobs will attempt to append
- to the same Volume (providing the Volume is appropriate -- right Pool,
- ... for that job), unless you are using multiple pools.
+ to the same Volume (providing the Volume is appropriate -- right Pool,
+ \ldots{} for that job), unless you are using multiple pools.
If no drive with a suitable Volume is available, it
will select the first available drive. Note, any Volume that has
been requested to be mounted, will be considered valid as a mounted
same Volume (assuming the Pool is the same for all jobs). Setting
Prefer Mounted Volumes to no can be useful for those sites
with multiple drive autochangers that prefer to maximize backup
- throughput at the expense of using additional drives and Volumes.
+ throughput at the expense of using additional drives and Volumes.
This means that the job will prefer to use an unused drive rather
than use a drive that is already in use.
more information. You need to specify needed information on command line, nothing
will be prompted. Example :
-\begin{verbatim}
+\begin{lstlisting}
Console = "prune files client=%c"
Console = "update stats age=3"
-\end{verbatim}
+\end{lstlisting}
You can specify more than one Command/Console option per RunScript.
You can use following options may be specified in the body
of the runscript:\\
-
-\begin{tabular}{|c|c|c|l}
-Options & Value & Default & Information \\
-\hline
-\hline
-Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
-\hline
-Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
-\hline
-Runs On Client & Yes/No & {\it Yes} & Run command on client\\
-\hline
-Runs When & Before|After|Always|\textsl{AfterVSS} & {\it Never} & When run commands\\
-\hline
-Fail Job On Error & Yes/No & {\it Yes} & Fail job if script returns
- something different from 0 \\
-\hline
-Command & & & Path to your script\\
-\hline
-Console & & & Console command\\
-\hline
-\end{tabular}
- \\
+ \LTXtable{0.95\linewidth}{table_runscript}
Any output sent by the command to standard output will be included in the
Bacula job report. The command string must be a valid program name or name
command, but there is no shell interpretation, as a consequence, if you
invoke complicated commands or want any shell features such as redirection
or piping, you must call a shell script and do it inside that script.
-
+
Before submitting the specified command to the operating system, Bacula
performs character substitution of the following characters:
\label{character substitution}
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
%% = %
%b = Job Bytes
%c = Client's name
%v = Volume name (Only on director side)
%w = Storage name (Only on director side)
%x = Spooling enabled? ("yes" or "no")
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
Some character substitutions are not available in all situations. The Job Exit
\index[dir]{Exit Status}
-\begin{itemize}
+\begin{bsysitemize}
\item OK
\item Error
\item Fatal Error
\item Canceled
\item Differences
\item Unknown term code
-\end{itemize}
+\end{bsysitemize}
- Thus if you edit it on a command line, you will need to enclose
+ Thus if you edit it on a command line, you will need to enclose
it within some sort of quotes.
You can use these following shortcuts:\\
-\begin{tabular}{|c|c|c|c|c|c}
-Keyword & RunsOnSuccess & RunsOnFailure & FailJobOnError & Runs On Client & RunsWhen \\
-\hline
-Run Before Job & & & Yes & No & Before \\
-\hline
-Run After Job & Yes & No & & No & After \\
-\hline
-Run After Failed Job & No & Yes & & No & After \\
-\hline
-Client Run Before Job & & & Yes & Yes & Before \\
-\hline
-Client Run After Job & Yes & No & & Yes & After \\
-\end{tabular}
-
+\LTXtable{0.95\linewidth}{table_runscriptshortcuts}
Examples:
-\begin{verbatim}
+\begin{lstlisting}
RunScript {
RunsWhen = Before
FailJobOnError = No
RunsOnFailure = yes
Command = "/etc/init.d/apache start"
}
-\end{verbatim}
+\end{lstlisting}
{\bf Notes about ClientRunBeforeJob}
(current directory, Bacula bin directory, and PATH). It will even try the
different extensions in the same order as cmd.exe.
The command can be anything that cmd.exe or command.com will recognize
- as an executable file.
+ as an executable file.
However, if you have slashes in the program name then Bacula figures you
are fully specifying the name, so you must also explicitly add the three
The command is run in a Win32 environment, so Unix like commands will not
work unless you have installed and properly configured Cygwin in addition
to and separately from Bacula.
-
+
The System \%Path\% will be searched for the command. (under the
environment variable dialog you have have both System Environment and
User Environment, we believe that only the System environment will be
available to bacula-fd, if it is running as a service.)
-
+
System environment variables can be referenced with \%var\% and
- used as either part of the command name or arguments.
+ used as either part of the command name or arguments.
So if you have a script in the Bacula\\bin directory then the following lines
should work fine:
-
+
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Client Run Before Job = systemstate
or
Client Run Before Job = systemstate.bat
Client Run Before Job = "systemstate.bat"
or
ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
-\end{verbatim}
+\end{lstlisting}
\normalsize
The outer set of quotes is removed when the configuration file is parsed.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
ClientRunBeforeJob = "\"C:/Program Files/Software
Vendor/Executable\" /arg1 /arg2 \"foo bar\""
-\end{verbatim}
+\end{lstlisting}
\normalsize
- The special characters
-\begin{verbatim}
+ The special characters
+\begin{lstlisting}
&<>()@^|
-\end{verbatim}
+\end{lstlisting}
will need to be quoted,
if they are part of a filename or argument.
-
- If someone is logged in, a blank "command" window running the commands
+
+ If someone is logged in, a blank ``command'' window running the commands
will be present during the execution of the command.
-
+
Some Suggestions from Phil Stracchino for running on Win32 machines with
the native Win32 File daemon:
\item You might want the ClientRunBeforeJob directive to specify a .bat
file which runs the actual client-side commands, rather than trying
to run (for example) regedit /e directly.
- \item The batch file should explicitly 'exit 0' on successful completion.
- \item The path to the batch file should be specified in Unix form:
-
- ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
-
- rather than DOS/Windows form:
-
+ \item The batch file should explicitly 'exit 0' on successful completion.
+ \item The path to the batch file should be specified in Unix form:
+
+ ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
+
+ rather than DOS/Windows form:
+
ClientRunBeforeJob =
"c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
- INCORRECT
+ INCORRECT
\end{enumerate}
-For Win32, please note that there are certain limitations:
+For Win32, please note that there are certain limitations:
ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
then put quotes around the whole thing when putting it in
the director's .conf file. You either need to have only one set of quotes
or else use the short name and don't put quotes around the command path.
-
+
Below is the output from cmd's help as it relates to the command line
passed to the /c option.
-
-
+
+
If /C or /K is specified, then the remainder of the command line after
the switch is processed as a command line, where the following logic is
used to process quote (") characters:
-
+
\begin{enumerate}
-\item
+\item
If all of the following conditions are met, then quote characters
on the command line are preserved:
- \begin{itemize}
+ \begin{bsysitemize}
\item no /S switch.
\item exactly two quote characters.
\item no special characters between the two quote characters,
- where special is one of:
-\begin{verbatim}
-&<>()@^|
-\end{verbatim}
+ where special is one of:
+\begin{lstlisting}
+&<>()@^|
+\end{lstlisting}
\item there are one or more whitespace characters between the
the two quote characters.
\item the string between the two quote characters is the name
of an executable file.
- \end{itemize}
-
+ \end{bsysitemize}
+
\item Otherwise, old behavior is to see if the first character is
a quote character and if so, strip the leading character and
remove the last quote character on the command line, preserving
- any text after the last quote character.
-
+ any text after the last quote character.
+
\end{enumerate}
-
-The following example of the use of the Client Run Before Job directive was
+
+The following example of the use of the Client Run Before Job directive was
submitted by a user:\\
You could write a shell script to back up a DB2 database to a FIFO. The shell
script is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#!/bin/sh
# ===== backupdb.sh
DIR=/u01/mercuryd
-
+
mkfifo $DIR/dbpipe
db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
sleep 1
-\end{verbatim}
+\end{lstlisting}
\normalsize
-
+
The following line in the Job resource in the bacula-dir.conf file:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
'%l'\""
-\end{verbatim}
+\end{lstlisting}
\normalsize
When the job is run, you will get messages from the output of the script
stating that the backup has started. Even though the command being run is
-backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
+backgrounded with \&, the job will block until the ``db2 BACKUP DATABASE''
command, thus the backup stalls.
-
-To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
+
+To remedy this situation, the ``db2 BACKUP DATABASE'' line should be changed to
the following:
-
+
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
2>&1 < /dev/null &
-\end{verbatim}
+\end{lstlisting}
\normalsize
It is important to redirect the input and outputs of a backgrounded command to
exit code of the program run is non-zero, the current Bacula job will be
canceled.
-\begin{verbatim}
+\begin{lstlisting}
Run Before Job = "echo test"
-\end{verbatim}
+\end{lstlisting}
it's equivalent to :
-\begin{verbatim}
+\begin{lstlisting}
RunScript {
Command = "echo test"
RunsOnClient = No
RunsWhen = Before
}
-\end{verbatim}
+\end{lstlisting}
Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
simple way to modify your schedules during a holiday. For example, suppose
non-zero, Bacula will print a warning message. Before submitting the
specified command to the operating system, Bacula performs character
substitution as described above for the {\bf RunScript} directive.
-
- An example of the use of this directive is given in the
- \ilink{Tips Chapter}{JobNotification} of this manual.
+
+ An example of the use of this directive is given in the
+ \bsysxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}.
See the {\bf Run After Failed Job} if you
want to run a script after the job has terminated with any
operating system, Bacula performs character substitution as described above
for the {\bf RunScript} directive. Note, if you wish that your script
will run regardless of the exit status of the Job, you can use this :
-\begin{verbatim}
+\begin{lstlisting}
RunScript {
Command = "echo test"
RunsWhen = After
RunsOnClient = no
RunsOnSuccess = yes # default, you can drop this line
}
-\end{verbatim}
+\end{lstlisting}
+
+ An example of the use of this directive is given in the
+ \bsysxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}.
- An example of the use of this directive is given in the
- \ilink{Tips Chapter}{JobNotification} of this manual.
-
\label{Job:ClientRunBeforeJob}
\item [Client Run Before Job = \lt{}command\gt{}]
as data spooling is complete in order to allow restarting applications
on the client as soon as possible. .
- Note, please see the notes above in {\bf RunScript}
+ Note, please see the notes above in {\bf RunScript}
concerning Windows clients.
\label{Job:RerunFailedLevels}
directive: first, a failed job is defined as one that has not terminated
normally, which includes any running job of the same name (you need to
ensure that two jobs of the same name do not run simultaneously);
- secondly, the {\bf Ignore FileSet Changes} directive is not considered
+ secondly, the {\bf Ignore FileSet Changes} directive is not considered
when checking for failed levels, which means that any FileSet change will
trigger a rerun.
\index[dir]{Directive!Spool Data}
If this directive is set to {\bf yes} (default no), the Storage daemon will
- be requested to spool the data for this Job to disk rather than write it
- directly to the Volume (normally a tape).
+ be requested to spool the data for this Job to disk rather than write it
+ directly to the Volume (normally a tape).
Thus the data is written in large blocks to the Volume rather than small
blocks. This directive is particularly useful when running multiple
to tape.
Spooling data prevents interleaving date from several job and reduces or
- eliminates tape drive stop and start commonly known as "shoe-shine".
-
+ eliminates tape drive stop and start commonly known as ``shoe-shine''.
+
We don't recommend using this option if you are writing to a disk file
using this option will probably just slow down the backup jobs.
\index[dir]{SpoolData}
\index[dir]{Directive!SpoolData}
tells Bacula to request the Storage daemon to spool data to a disk file
- before writing it to the Volume (normally a tape).
+ before writing it to the Volume (normally a tape).
\label{Job:SpoolAttributes}
\item [Spool Attributes = \lt{}yes\vb{}no\gt{}]
\index[dir]{SpoolSize}
\index[dir]{Directive!SpoolSize}
where the bytes specify the maximum spool size for this job.
- The default is take from Device Maximum Spool Size limit.
- This directive is available only in Bacula version 2.3.5 or
+ The default is take from Device Maximum Spool Size limit.
+ This directive is available only in Bacula version 2.3.5 or
later.
\index[dir]{Directive!AddPrefix}
This directive applies only to a Restore job and specifies a prefix to the
directory name of all files being restored. This will use \ilink{File
- Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
+ Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
\label{Job:AddSuffix}
\item [Add Suffix = \lt{}extention\gt{}]
\index[dir]{Directive!StripPrefix}
This directive applies only to a Restore job and specifies a prefix to remove
from the directory name of all files being restored. This will use the
- \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
+ \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
or later.
Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
you can use :
-\begin{verbatim}
+\begin{lstlisting}
Strip Prefix = c:
Add Prefix = d:
-\end{verbatim}
+\end{lstlisting}
\label{Job:RegexWhere}
\item [RegexWhere = \lt{}expressions\gt{}]
\item [never]
\index[dir]{never}
- if the backed up file already exists, Bacula skips restoring this file.
+ if the backed up file already exists, Bacula skips restoring this file.
\end{description}
\label{Job:PrefixLinks}
\item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}]
\index[general]{Allow Duplicate Jobs}
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=13cm]{\idir duplicate-real.eps}
- \label{fig:allowduplicatejobs}
- \caption{Allow Duplicate Jobs usage}
-\end{figure}
+%\begin{figure}[htbp]
+% \centering
+% \includegraphics[width=13cm]{\idir duplicate-real}
+% \label{fig:allowduplicatejobs}
+% \caption{Allow Duplicate Jobs usage}
+%\end{figure}
+\bsysimageH{duplicate-real}{Allow Duplicate Jobs usage}{fig:allowduplicatejobs}
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
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
cancelling a job, then the current job (the second one started)
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}.
+ The default is {\bf no}.
\label{Job:CancelRunningDuplicates}
\item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}]
\index[dir]{Run}
\index[dir]{Directive!Run}
\index[dir]{Clone a Job}
- The Run directive (not to be confused with the Run option in a
+ The Run directive (not to be confused with the Run option in a
Schedule) allows you to start other jobs or to clone jobs. By using the
cloning keywords (see below), you can backup
the same data (or almost the same data) to two or more drives
The part after the equal sign must be enclosed in double quotes,
and can contain any string or set of options (overrides) that you
can specify when entering the Run command from the console. For
- example {\bf storage=DDS-4 ...}. In addition, there are two special
+ example {\bf storage=DDS-4 \ldots{}}. In addition, there are two special
keywords that permit you to clone the current job. They are {\bf level=\%l}
- and {\bf since=\%s}. The \%l in the level keyword permits
+ and {\bf since=\%s}. The \%l in the level keyword permits
entering the actual level of the current job and the \%s in the since
keyword permits putting the same time for comparison as used on the
current job. Note, in the case of the since keyword, the \%s must be
enclosed in double quotes, and thus they must be preceded by a backslash
since they are already inside quotes. For example:
-\begin{verbatim}
+\begin{lstlisting}
run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
-\end{verbatim}
+\end{lstlisting}
A cloned job will not start additional clones, so it is not
possible to recurse.
running priority 2 jobs must complete before the priority 1 job is
run, unless Allow Mixed Priority is set.
- The default priority is 10.
+ The default priority is 10.
If you want to run concurrent jobs you should
keep these points in mind:
-\begin{itemize}
-\item See \ilink{Running Concurrent Jobs}{ConcurrentJobs} on how to setup
- concurrent jobs.
+\begin{bsysitemize}
+\item See \bsysxrlink{Running Concurrent Jobs}{ConcurrentJobs}{problems}{section} on how to setup
+ concurrent jobs in the \problemsman{}.
\item Bacula concurrently runs jobs of only one priority at a time. It
will not simultaneously run a priority 1 and a priority 2 job.
start even if the Maximum Concurrent Jobs settings would normally allow
them to run. This ensures that higher priority jobs will be run as soon
as possible.
-\end{itemize}
+\end{bsysitemize}
If you have several jobs of different priority, it may not best to start
them at exactly the same time, because Bacula must examine them one at a
\index[dir]{Directive!Write Part After Job}
This directive is only implemented in version 1.37 and later.
If this directive is set to {\bf yes} (default {\bf no}), a new part file
- will be created after the job is finished.
+ will be created after the job is finished.
It should be set to {\bf yes} when writing to devices that require mount
(for example DVD), so you are sure that the current part, containing
wasting too much space, but to ensure that the data is written to the
medium when all jobs are finished.
- This directive is ignored with tape and FIFO devices.
+ This directive is ignored with tape and FIFO devices.
\end{description}
-The following is an example of a valid Job resource definition:
+The following is an example of a valid Job resource definition:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = "Minou"
Type = Backup
Schedule = "MinouWeeklyCycle"
Messages = Standard
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{JobDefsResource}
referenced within a Job to provide defaults for that Job. This permits you to
concisely define several nearly identical Jobs, each one referencing a JobDefs
resource which contains the defaults. Only the changes from the defaults need to
-be mentioned in each Job.
+be mentioned in each Job.
\label{ScheduleResource}
\section{The Schedule Resource}
The Schedule resource provides a means of automatically scheduling a Job as
well as the ability to override the default Level, Pool, Storage and Messages
resources. If a Schedule resource is not referenced in a Job, the Job can only
-be run manually. In general, you specify an action to be taken and when.
+be run manually. In general, you specify an action to be taken and when.
\begin{description}
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
- The name of the schedule being defined. The Name directive is required.
+ The name of the schedule being defined. The Name directive is required.
\label{Schdedule:Run}
\item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
\item [Level=Full]
\index[dir]{Level}
\index[dir]{Directive!Level}
- is all files in the FileSet whether or not they have changed.
+ is all files in the FileSet whether or not they have changed.
\item [Level=Incremental]
\index[dir]{Level}
\index[dir]{Directive!Level}
- is all files that have changed since the last backup.
+ is all files that have changed since the last backup.
\item [Pool=Weekly]
\index[dir]{Pool}
\index[dir]{Directive!Pool}
- specifies to use the Pool named {\bf Weekly}.
+ specifies to use the Pool named {\bf Weekly}.
\item [Storage=DLT\_Drive]
\index[dir]{Storage}
\index[dir]{Directive!Storage}
- specifies to use {\bf DLT\_Drive} for the storage device.
+ specifies to use {\bf DLT\_Drive} for the storage device.
\item [Messages=Verbose]
\index[dir]{Messages}
\index[dir]{Directive!Messages}
- specifies to use the {\bf Verbose} message resource for the Job.
+ specifies to use the {\bf Verbose} message resource for the Job.
\item [FullPool=Full]
\index[dir]{FullPool}
\index[dir]{Directive!FullPool}
specifies to use the Pool named {\bf Full} if the job is a full backup, or
is
-upgraded from another type to a full backup.
+upgraded from another type to a full backup.
\item [DifferentialPool=Differential]
\index[dir]{DifferentialPool}
\index[dir]{Directive!DifferentialPool}
specifies to use the Pool named {\bf Differential} if the job is a
- differential backup.
+ differential backup.
\item [IncrementalPool=Incremental]
\index[dir]{IncrementalPool}
\index[dir]{Directive!IncrementalPool}
specifies to use the Pool named {\bf Incremental} if the job is an
-incremental backup.
+incremental backup.
\item [WritePartAfterJob=yes\vb{}no]
repetition. This is done by specifying masks or times for the hour, day of the
month, day of the week, week of the month, week of the year, and month when
you want the job to run. By specifying one or more of the above, you can
-define a schedule to repeat at almost any frequency you want.
+define a schedule to repeat at almost any frequency you want.
Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
minute} the Job is to be run. Of these four items to be specified, {\bf day}
is special in that you may either specify a day of the month such as 1, 2,
-... 31, or you may specify a day of the week such as Monday, Tuesday, ...
+\ldots{} 31, or you may specify a day of the week such as Monday, Tuesday, \ldots{}
Sunday. Finally, you may also specify a week qualifier to restrict the
-schedule to the first, second, third, fourth, or fifth week of the month.
+schedule to the first, second, third, fourth, or fifth week of the month.
For example, if you specify only a day of the week, such as {\bf Tuesday} the
Job will be run every hour of every Tuesday of every Month. That is the {\bf
month} and {\bf hour} remain set to the defaults of every month and all
-hours.
+hours.
Note, by default with no other specification, your job will run at the
beginning of every hour. If you wish your job to run more than once in any
given hour, you will need to specify multiple {\bf run} specifications each
-with a different minute.
+with a different minute.
The date/time to run the Job can be specified in the following way in
-pseudo-BNF:
+pseudo-BNF:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
<void-keyword> = on
<at-keyword> = at
<week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
<month-spec> = <month-keyword> | <month-range> |
<monthly-keyword>
<date-time-spec> = <month-spec> <day-spec> <time-spec>
-\end{verbatim}
+\end{lstlisting}
\normalsize
\end{description}
January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
precedes the first ISO week (i.e. has the first few days of the year if any
occur before Thursday). w00 is not defined by the ISO specification. A week
-starts with Monday and ends with Sunday.
+starts with Monday and ends with Sunday.
According to the NIST (US National Institute of Standards and Technology),
12am and 12pm are ambiguous and can be defined to anything. However,
An example schedule resource that is named {\bf WeeklyCycle} and runs a job
with level full each Sunday at 2:05am and an incremental job Monday through
-Saturday at 2:05am is:
+Saturday at 2:05am is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Schedule {
Name = "WeeklyCycle"
Run = Level=Full sun at 2:05
Run = Level=Incremental mon-sat at 2:05
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
-An example of a possible monthly cycle is as follows:
+An example of a possible monthly cycle is as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Schedule {
Name = "MonthlyCycle"
Run = Level=Full Pool=Monthly 1st sun at 2:05
Run = Level=Differential 2nd-5th sun at 2:05
Run = Level=Incremental Pool=Daily mon-sat at 2:05
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
-The first of every month:
+The first of every month:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Schedule {
Name = "First"
Run = Level=Full on 1 at 2:05
Run = Level=Incremental on 2-31 at 2:05
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
-Every 10 minutes:
+Every 10 minutes:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Schedule {
Name = "TenMinutes"
Run = Level=Full hourly at 0:05
Run = Level=Full hourly at 0:45
Run = Level=Full hourly at 0:55
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{Technical Notes on Schedules}
current time, your job will run only in the two months you have set. Likewise,
if you set a time (hour), the hour mask will be cleared, and the hour you
specify will be set in the bit mask and the minutes will be stored in the
-minute field.
+minute field.
For any schedule you have defined, you can see how these bits are set by doing
a {\bf show schedules} command in the Console program. Please note that the
-bit mask is zero based, and Sunday is the first day of the week (bit zero).
+bit mask is zero based, and Sunday is the first day of the week (bit zero).
\input{fileset}
\input{bsplugins}
The Client resource defines the attributes of the Clients that are served by
this Director; that is the machines that are to be backed up. You will need
-one Client resource definition for each machine to be backed up.
+one Client resource definition for each machine to be backed up.
\begin{description}
\item [Client (or FileDaemon)]
\index[dir]{Client (or FileDaemon)}
\index[dir]{Directive!Client (or FileDaemon)}
- Start of the Client directives.
+ Start of the Client directives.
\label{Client:Name}
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
The client name which will be used in the Job resource directive or in the
-console run command. This directive is required.
+console run command. This directive is required.
\label{Client:Address}
\item [Address = \lt{}address\gt{}]
\index[dir]{FD Port}
\index[dir]{Directive!FD Port}
Where the port is a port number at which the Bacula File server daemon can
- be contacted. The default is 9102.
+ be contacted. The default is 9102.
\label{Client:Catalog}
\item [Catalog = \lt{}Catalog-resource-name\gt{}]
\index[dir]{Catalog}
\index[dir]{Directive!Catalog}
- This specifies the name of the catalog resource to be used for this Client.
- This directive is required.
+ This specifies the name of the catalog resource to be used for this Client.
+ This directive is required.
\label{Client:Password}
\item [Password = \lt{}password\gt{}]
\index[dir]{Directive!Password}
This is the password to be used when establishing a connection with the File
services, so the Client configuration file on the machine to be backed up
- must have the same password defined for this Director. This directive is
+ must have the same password defined for this Director. This directive is
required. If you have either {\bf /dev/random} {\bf bc} on your machine,
Bacula will generate a random password during the configuration process,
- otherwise it will be left blank.
+ otherwise it will be left blank.
The password is plain text. It is not generated through any special
process, but it is preferable for security reasons to make the text
{\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
that are older than the specified File Retention period. Note, this affects
only records in the catalog database. It does not affect your archive
- backups.
+ backups.
File records may actually be retained for a shorter period than you specify
on this directive if you specify either a shorter {\bf Job Retention} or a
shorter {\bf Volume Retention} period. The shortest retention period of the
- three takes precedence. The time may be expressed in seconds, minutes,
- hours, days, weeks, months, quarters, or years. See the
+ three takes precedence. The time may be expressed in seconds, minutes,
+ hours, days, weeks, months, quarters, or years. See the
\ilink{ Configuration chapter}{Time} of this manual for
- additional details of time specification.
+ additional details of time specification.
- The default is 60 days.
+ The default is 60 days.
\label{JobRetention}
\label{Client:JobRetention}
independently applied, so the smaller of the two takes precedence.
The Job retention period is specified as seconds, minutes, hours, days,
- weeks, months, quarters, or years. See the
+ weeks, months, quarters, or years. See the
\ilink{ Configuration chapter}{Time} of this manual for
- additional details of time specification.
+ additional details of time specification.
- The default is 180 days.
+ The default is 180 days.
\label{AutoPrune}
\label{Client:AutoPrune}
will automatically apply the File retention period and the Job retention
period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
pruning will not be done, and your Catalog will grow in size each time you
- run a Job. Pruning affects only information in the catalog and not data
- stored in the backup archives (on Volumes).
+ run a Job. Pruning affects only information in the catalog and not data
+ stored in the backup archives (on Volumes).
\label{Client:MaximumConcurrentJobs}
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
when started for this Client. The speed parameter should be specified in
k/s, Kb/s, m/s or Mb/s.
-% \item [FD Storage Address = \lt{}address\gt{}]
+% \item [FD Storage Address = \lt{}address\gt{}]
% \index[dir]{FDStorageAddress}
% \index[dir]{Directive!FD Storage Address}
-% \index[dir]{Storage daemon Address}
-%
+% \index[dir]{Storage daemon Address}
+%
% Where the address is a host name, a {\bf fully qualified domain name}, or an
% {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
% will be transmitted to the File daemon instead of the Storage
% directive can be used in NAT environment where the configuration of the
% Client resolver is not possible. Note that using this directive will not allow
% to use multiple Storage Daemon for Backup/Restore jobs.
-%
+%
% \begin{figure}[htbp]
% \centering
% \includegraphics[width=10cm]{\idir BackupOverWan1}
The number specifies the priority of this client relative to other clients
that the Director is processing simultaneously. The priority can range from
1 to 1000. The clients are ordered such that the smaller number priorities
- are performed first (not currently implemented).
+ are performed first (not currently implemented).
\end{description}
- The following is an example of a valid Client resource definition:
+ The following is an example of a valid Client resource definition:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Client {
Name = Minimatou
FDAddress = minimatou
Catalog = MySQL
Password = very_good
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{StorageResource2}
\index[general]{Storage Resource}
The Storage resource defines which Storage daemons are available for use by
-the Director.
+the Director.
\begin{description}
\index[dir]{Storage}
\index[dir]{Directive!Storage}
Start of the Storage resources. At least one storage resource must be
- specified.
+ specified.
\label{Storage:Name}
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
The name of the storage resource. This name appears on the Storage directive
- specified in the Job resource and is required.
+ specified in the Job resource and is required.
\label{Storage:Address}
\item [Address = \lt{}address\gt{}]
will be transmitted to the File daemon who will then use it to contact the
Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
the name but rather a fully qualified machine name or an IP address. This
- directive is required.
+ directive is required.
\label{Storage:FDStorageAddress}
- \item [FD Storage Address = \lt{}address\gt{}]
+ \item [FD Storage Address = \lt{}address\gt{}]
\index[dir]{FDStorageAddress}
\index[dir]{Directive!FD Storage Address} \index[dir]{Storage daemon
Address} Where the address is a host name, a {\bf fully qualified domain
\index[dir]{Directive!SD Port}
Where port is the port to use to contact the storage daemon for information
and to start jobs. This same port number must appear in the Storage resource
- of the Storage daemon's configuration file. The default is 9103.
+ of the Storage daemon's configuration file. The default is 9103.
\label{Storage:Password}
\item [Password = \lt{}password\gt{}]
resource of the Storage daemon's configuration file. This directive is
required. If you have either {\bf /dev/random} {\bf bc} on your machine,
Bacula will generate a random password during the configuration process,
- otherwise it will be left blank.
+ otherwise it will be left blank.
The password is plain text. It is not generated through any special
process, but it is preferable for security reasons to use random text.
This directive specifies the Media Type to be used to store the data.
This is an arbitrary string of characters up to 127 maximum that you
define. It can be anything you want. However, it is best to make it
- descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
- ...). In addition, it is essential that you make the {\bf Media Type}
+ descriptive of the storage media (e.g. File, DAT, ``HP DLT8000'', 8mm,
+ \ldots{}). In addition, it is essential that you make the {\bf Media Type}
specification unique for each storage media type. If you have two DDS-4
drives that have incompatible formats, or if you have a DDS-4 drive and
a DDS-4 autochanger, you almost certainly should specify different {\bf
cannot mount a Volume in any directory -- this can be done by creating
an appropriate soft link.
- Currently Bacula permits only a single Media Type per Storage
+ Currently Bacula permits only a single Media Type per Storage
and Device definition. Consequently, if
you have a drive that supports more than one Media Type, you can
- give a unique string to Volumes with different intrinsic Media
+ give a unique string to Volumes with different intrinsic Media
Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
those volumes will only be mounted on drives indicated with the
dual type (DDS-3-4).
\label{Autochanger1}
\label{Storage:Autochanger}
-\item [Autochanger = \lt{}yes\vb{}no\gt{}]
+\item [Autochanger = \lt{}yes\vb{}no\gt{}]
\index[dir]{Autochanger}
\index[dir]{Directive!Autochanger}
If you specify {\bf yes} for this command (the default is {\bf no}),
algorithm used by Bacula to search for available volumes will be
modified to consider only Volumes that are known to be in the
autochanger's magazine. If no {\bf in changer} volume is found, Bacula
- will attempt recycling, pruning, ..., and if still no volume is found,
+ will attempt recycling, pruning, \ldots{}, and if still no volume is found,
Bacula will search for any volume whether or not in the magazine. By
privileging in changer volumes, this procedure minimizes operator
intervention. The default is {\bf no}.
set a keepalive interval (heartbeat) in seconds on each of the sockets
it opens for the Storage resource. This value will override any
specified at the Director level. It is implemented only on systems
- (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
+ (Linux, \ldots{}) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
The default value is zero, which means no change is made to the socket.
\end{description}
-The following is an example of a valid Storage resource definition:
+The following is an example of a valid Storage resource definition:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
# Definition of tape storage device
Storage {
Name = DLTDrive
Device = "HP DLT 80" # same as Device in Storage daemon
Media Type = DLT8000 # same as MediaType in Storage daemon
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{PoolResource}
for example, to store all full backup data on one set of Volumes and all
incremental backups on another set of Volumes. Alternatively, you could assign
a different set of Volumes to each machine that you backup. This is most
-easily done by defining multiple Pools.
+easily done by defining multiple Pools.
Another important aspect of a Pool is that it contains the default attributes
-(Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
+(Maximum Jobs, Retention Period, Recycle flag, \ldots{}) that will be given to a
Volume when it is created. This avoids the need for you to answer a large
number of questions when labeling a new Volume. Each of these attributes can
later be changed on a Volume by Volume basis using the {\bf update} command in
the console program. Note that you must explicitly specify which Pool Bacula
is to use with each Job. Bacula will not automatically search for the correct
-Pool.
+Pool.
Most often in Bacula installations all backups for all machines (Clients) go
to a single set of Volumes. In this case, you will probably only use the {\bf
Default} Pool. If your backup strategy calls for you to mount a different tape
each day, you will probably want to define a separate Pool for each day. For
-more information on this subject, please see the
+more information on this subject, please see the
\ilink{Backup Strategies}{StrategiesChapter} chapter of this
-manual.
+manual.
To use a Pool, there are three distinct steps. First the Pool must be defined
image. It is this database image rather than the Director's resource image
that is used for the default Volume attributes. Note, for the pool to be
automatically created or updated, it must be explicitly referenced by a Job
-resource.
+resource.
Next the physical media must be labeled. The labeling can either be done with
the {\bf label} command in the {\bf console} program or using the {\bf btape}
program. The preferred method is to use the {\bf label} command in the {\bf
-console} program.
+console} program.
Finally, you must add Volume names (and their attributes) to the Pool. For
Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
Pool to use. Bacula will then automatically select the next Volume to use from
the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
from the Pool is identical to that required by the Storage resource you have
-specified for the Job.
+specified for the Job.
If you use the {\bf label} command in the console program to label the
Volumes, they will automatically be added to the Pool, so this last step is
-not normally required.
+not normally required.
It is also possible to add Volumes to the database without explicitly labeling
-the physical volume. This is done with the {\bf add} console command.
+the physical volume. This is done with the {\bf add} console command.
As previously mentioned, each time Bacula starts, it scans all the Pools
associated with each Catalog, and if the database record does not already
exist, it will be created from the Pool Resource definition. {\bf Bacula}
probably should do an {\bf update pool} if you change the Pool definition, but
currently, you must do this manually using the {\bf update pool} command in
-the Console program.
+the Console program.
The Pool Resource defined in the Director's configuration file
-(bacula-dir.conf) may contain the following directives:
+(bacula-dir.conf) may contain the following directives:
\begin{description}
This directive defines the pool type, which corresponds to the type of
Job being run. It is required and may be one of the following:
-\begin{itemize}
- \item [Backup]
- \item [*Archive]
- \item [*Cloned]
- \item [*Migration]
- \item [*Copy]
- \item [*Save]
-\end{itemize}
+\begin{bsysitemize}
+ \item [Backup]
+ \item [*Archive]
+ \item [*Cloned]
+ \item [*Migration]
+ \item [*Copy]
+ \item [*Save]
+\end{bsysitemize}
Note, only Backup is current implemented.
\label{Pool:Storage}
file is the default value used when a Volume is created. Once the volume is
created, changing the value in the bacula-dir.conf file will not change what
is stored for the Volume. To change the value for an existing Volume you
- must use the {\bf update} command in the Console.
+ must use the {\bf update} command in the Console.
If you are running multiple simultaneous jobs, this directive may not
work correctly because when a drive is reserved for a job, this
- directive is not taken into account, so multiple jobs may try to
+ directive is not taken into account, so multiple jobs may try to
start writing to the Volume. At some point, when the Media record is
updated, multiple simultaneous jobs may fail since the Volume can no
longer be written.
during such a command, the Volume status may also be changed.
Once the Volume is
recycled, it will be available for use again.
-
+
You might use this directive, for example, if you have a Volume used for
Incremental backups, and Volumes used for Weekly Full backups. Once the
Full backup is done, you will want to use a different Incremental
hours, or you might experience problems of Bacula waiting for a tape
over the weekend only to complete the backups Monday morning when an
operator mounts a new tape.
-
+
The use duration is checked and the {\bf Used} status is set only at the
end of a job that writes to the particular volume, which means that even
though the use duration may have expired, the catalog entry will not be
and will not work correctly (i.e. will fail jobs) if the use
duration expires while multiple simultaneous jobs are writing
to the volume.
-
+
Please note that the value defined by this directive in the bacula-dir.conf
file is the default value used when a Volume is created. Once the volume is
created, changing the value in the bacula-dir.conf file will not change what
is stored for the Volume. To change the value for an existing Volume you
- must use the
- \ilink{\bf update volume}{UpdateCommand} command in the Console.
+ must use the
+ \bsysxrlink{update volume}{UpdateCommand}{console}{command} in the \consoleman{}.
\label{Pool:CatalogFiles}
\item [Catalog Files = \lt{}yes\vb{}no\gt{}]
entries in the catalog, you will not be able to use the Console {\bf
restore} command nor any other command that references File entries.
\label{PoolAutoPrune}
-
+
\label{Pool:AutoPrune}
\item [AutoPrune = \lt{}yes\vb{}no\gt{}]
\index[dir]{AutoPrune}
period) to be deleted from the Catalog and permits possible recycling of
the Volume.
\label{VolRetention}
-
+
\label{Pool:VolumeRetention}
\item [Volume Retention = \lt{}time-period-specification\gt{}]
\index[dir]{Volume Retention}
pruning could also occur during a {\bf status dir} command because it
uses similar algorithms for finding the next available Volume.
- It is important to know that when the Volume Retention period expires,
+ It is important to know that when the Volume Retention period expires,
Bacula does not automatically recycle a Volume. It attempts to keep the
Volume data intact as long as possible before over writing the Volume.
-
+
By defining multiple Pools with different Volume Retention periods, you
may effectively have a set of tapes that is recycled weekly, another
Pool of tapes that is recycled monthly and so on. However, one must
Retention} period should be at twice the interval of your Full backups.
This means that if you do a Full backup once a month, the minimum Volume
retention period should be two months.
-
+
The default Volume retention period is 365 days, and either the default
or the value defined by this directive in the bacula-dir.conf file is
the default value used when a Volume is created. Once the volume is
command. It is useful to prevent disk based volumes from consuming too much
space.
-\begin{verbatim}
+\begin{lstlisting}
Pool {
Name = Default
Action On Purge = Truncate
...
}
-\end{verbatim}
+\end{lstlisting}
You can schedule the truncate operation at the end of your CatalogBackup job
like in this example:
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = CatalogBackup
...
Console = "purge volume action=all allpools storage=File"
}
}
-\end{verbatim}
+\end{lstlisting}
\label{PoolScratchPool}
\label{Pool:ScrachPool}
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. For more on the see the
+ be recycled back into the Scratch pool. For more on the see the
\ilink{Scratch Pool}{TheScratchPool} section of this manual.
Although this directive is called RecyclePool, the Volume in
you specify on this directive when Bacula prunes the Volume and
discovers that there are no records left in the catalog and hence
marks it as {\bf Purged}.
-
+
\label{PoolRecycle}
-
+
\label{Pool:Recycle}
\item [Recycle = \lt{}yes\vb{}no\gt{}]
\index[dir]{Recycle}
for an existing Volume you must use the {\bf update} command in the
Console.
- When all Job and File records have been pruned or purged from the
+ When all Job and File records have been pruned or purged from the
catalog for a particular Volume, if that Volume is marked as
Append, Full, Used, or Error, it will then be marked as Purged. Only
Volumes marked as Purged will be considered to be converted to the
This directive can be useful if you have a fixed number of Volumes in the
Pool and you want to cycle through them and you have specified the correct
- retention periods.
+ retention periods.
However, if you use this directive and have only one
Volume in the Pool, you will immediately recycle your Volume if you fill
\index[dir]{Directive!File Retention}
The File Retention directive defines the length of time that Bacula will
keep File records in the Catalog database after the End time of the
- Job corresponding to the File records.
+ Job corresponding to the File records.
This directive takes precedence over Client directives of the same name. For
example, you can decide to increase Retention times for Archive or OffSite
begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
specify variable expansion characters, you should always enclose the
format with double quote characters ({\bf "}). For more details on
- variable expansion, please see the \ilink{Variable
- Expansion}{VarsChapter} Chapter of this manual.
+ variable expansion, please see the \bsysxrlink{Variable
+ Expansion}{VarsChapter}{misc}{chapter} of the \miscman{}.
If no variable expansion characters are found in the string, the Volume
name will be formed from the {\bf format} string appended with the
is not guaranteed. The unique number will be edited as four
digits with leading zeros. For example, with a {\bf Label Format =
"File-"}, the first volumes will be named {\bf File-0001}, {\bf
- File-0002}, ...
+ File-0002}, \ldots{}
With the exception of Job specific variables, you can test your {\bf
- LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
- of this manual.
+ LabelFormat} by using the \bsysxrlink{var}{var}{console}{command} in the
+ \consoleman{}.
In almost all cases, you should enclose the format specification (part
after the equal sign) in double quotes. Please note that this directive
command. Bacula can automatically label Volumes if instructed to do so,
but this feature is not yet fully implemented.
-The following is an example of a valid Pool resource definition:
+The following is an example of a valid Pool resource definition:
\footnotesize
-\begin{verbatim}
-
+\begin{lstlisting}
+
Pool {
Name = Default
Pool Type = Backup
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{TheScratchPool}
\subsection{The Scratch Pool}
\index[general]{Scratch Pool}
-In general, you can give your Pools any name you wish, but there is one
-important restriction: the Pool named {\bf Scratch}, if it exists behaves
-like a scratch pool of Volumes in that when Bacula needs a new Volume for
+In general, you can give your Pools any name you wish, but there is one
+important restriction: the Pool named {\bf Scratch}, if it exists behaves
+like a scratch pool of Volumes in that when Bacula needs a new Volume for
writing and it cannot find one, it will look in the Scratch pool, and if
it finds an available Volume, it will move it out of the Scratch pool into
the Pool currently being used by the job.
may be as many Catalogs (databases) defined as you wish. For example, you
may want each Client to have its own Catalog database, or you may want
backup jobs to use one database and verify or restore jobs to use another
-database.
+database.
Since SQLite is compiled in, it always runs on the same machine
as the Director and the database must be directly accessible (mounted) from
This is the host address of the database server. Normally, you would specify
this instead of {\bf DB Socket} if the database server is on another machine.
In that case, you will also specify {\bf DB Port}. This directive is used
- only by MySQL and PostgreSQL and is ignored by SQLite if provided.
- This directive is optional.
+ only by MySQL and PostgreSQL and is ignored by SQLite if provided.
+ This directive is optional.
\label{Catalog:DbPort}
\item [DB Port = \lt{}port\gt{}]
%% and Bacula will allow only one Job at a time to communicate. If you set this
%% directive to yes, Bacula will permit multiple connections to the database,
%% and the database must be multi-thread capable. For SQLite and PostgreSQL,
-%% this is no problem. For MySQL, you must be *very* careful to have the
+%% this is no problem. For MySQL, you must be *very* careful to have the
%% multi-thread version of the client library loaded on your system. When this
%% directive is set yes, each Job will have a separate connection to the
%% database, and the database will control the interaction between the
%% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
%% Bacula will automatically enable transactions. This can significantly speed
%% up insertion of attributes in the database either for a single Job or
-%% multiple simultaneous Jobs.
+%% multiple simultaneous Jobs.
%% This directive has not been tested. Please test carefully before running it
-%% in production and report back your results.
+%% in production and report back your results.
\end{description}
-The following is an example of a valid Catalog resource definition:
+The following is an example of a valid Catalog resource definition:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Catalog
{
Name = SQLite
user = bacula;
password = "" # no password = no security
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
-or for a Catalog on another machine:
+or for a Catalog on another machine:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Catalog
{
Name = MySQL
DB Address = remote.acme.com
DB Port = 1234
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{MessagesResource2}
\index[general]{Resource!Messages}
\index[general]{Messages Resource}
-For the details of the Messages Resource, please see the
+For the details of the Messages Resource, please see the
\ilink{Messages Resource Chapter}{MessagesChapter} of this
-manual.
+manual.
\label{ConsoleResource1}
\section{The Console Resource}
As of Bacula version 1.33 and higher, there are three different kinds of
consoles, which the administrator or user can use to interact with the
Director. These three kinds of consoles comprise three different security
-levels.
+levels.
-\begin{itemize}
+\begin{bsysitemize}
\item The first console type is an {\bf anonymous} or {\bf default} console,
which has full privileges. There is no console resource necessary for
this type since the password is specified in the Director's resource and
consequently such consoles do not have a name as defined on a {\bf Name
=} directive. This is the kind of console that was initially
implemented in versions prior to 1.33 and remains valid. Typically you
- would use it only for administrators.
+ would use it only for administrators.
\item The second type of console, and new to version 1.33 and higher is a
- "named" console defined within a Console resource in both the Director's
+ ``named'' console defined within a Console resource in both the Director's
configuration file and in the Console's configuration file. Both the
names and the passwords in these two entries must match much as is the
case for Client programs.
use the {\bf SetIP} command to change the Address directive in the
Director's client resource to the IP address of the Console. This
permits portables or other machines using DHCP (non-fixed IP addresses)
- to "notify" the Director of their current IP address.
-\end{itemize}
+ to ``notify'' the Director of their current IP address.
+\end{bsysitemize}
The Console resource is optional and need not be specified. The following
-directives are permitted within the Director's configuration resource:
+directives are permitted within the Director's configuration resource:
\begin{description}
\index[dir]{Directive!Name}
The name of the console. This name must match the name specified in the
Console's configuration resource (much as is the case with Client
-definitions).
+definitions).
\label{Console:Password}
\item [Password = \lt{}password\gt{}]
process, otherwise it will be left blank.
The password is plain text. It is not generated through any special
- process. However, it is preferable for security reasons to choose
- random text.
+ process. However, it is preferable for security reasons to choose
+ random text.
\label{Console:JobAcl}
\item [JobACL = \lt{}name-list\gt{}]
as:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
JobACL = kernsave, "Backup client 1", "Backup client 2"
JobACL = "RestoreFiles"
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
With the above specification, the console can access the Director's resources
-for the four jobs named on the JobACL directives, but for no others.
+for the four jobs named on the JobACL directives, but for no others.
\label{Console:ClientAcl}
\item [ClientACL = \lt{}name-list\gt{}]
\index[dir]{Directive!ClientACL}
This directive is used to specify a list of Client resource names that can
be
-accessed by the console.
+accessed by the console.
\label{Console:StorageAcl}
\item [StorageACL = \lt{}name-list\gt{}]
\index[dir]{StorageACL}
\index[dir]{Directive!StorageACL}
This directive is used to specify a list of Storage resource names that can
-be accessed by the console.
+be accessed by the console.
\label{Console:ScheduleAcl}
\item [ScheduleACL = \lt{}name-list\gt{}]
user enters will be accepted (not very secure), any other
value specified (there may be multiple WhereACL directives) will
restrict the user to use that path. For example, on a Unix system,
- if you specify "/", the file will be restored to the original
+ if you specify ``/'', the file will be restored to the original
location. This directive is untested.
\end{description}
keyword {\bf *all*} can be specified in any of the above access control lists.
When this keyword is present, any resource or command name (which ever is
appropriate) will be accepted. For an example configuration file, please see
-the
+the
\ilink{Console Configuration}{ConsoleConfChapter} chapter of this
-manual.
+manual.
\label{CounterResource}
\section{The Counter Resource}
The Counter Resource defines a counter variable that can be accessed by
variable expansion used for creating Volume labels with the {\bf LabelFormat}
-directive. See the
+directive. See the
\ilink{LabelFormat}{Label} directive in this chapter for more
-details.
+details.
\begin{description}
-\item [Counter]
+\item [Counter]
\index[dir]{Counter}
\index[dir]{Directive!Counter}
- Start of the Counter resource. Counter directives are optional.
+ Start of the Counter resource. Counter directives are optional.
\label{Counter:Name}
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
The name of the Counter. This is the name you will use in the variable
-expansion to reference the counter value.
+expansion to reference the counter value.
\label{Counter:Minimum}
\item [Minimum = \lt{}integer\gt{}]
\index[dir]{Minimum}
\index[dir]{Directive!Minimum}
This specifies the minimum value that the counter can have. It also becomes
-the default. If not supplied, zero is assumed.
+the default. If not supplied, zero is assumed.
\label{Counter:Maximum}
\item [Maximum = \lt{}integer\gt{}]
This is the maximum value value that the counter can have. If not specified
or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
the 31 power). When the counter is incremented past this value, it is reset
-to the Minimum.
+to the Minimum.
\label{Counter:*WrapCounter}
\item [*WrapCounter = \lt{}counter-name\gt{}]
\index[dir]{*WrapCounter}
\index[dir]{Directive!*WrapCounter}
If this value is specified, when the counter is incremented past the
-maximum
+maximum
and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
-is incremented. (This is not currently implemented).
+is incremented. (This is not currently implemented).
\label{Counter:Catalog}
\item [Catalog = \lt{}catalog-name\gt{}]
\index[dir]{Catalog}
\index[dir]{Directive!Catalog}
- If this directive is specified, the counter and its values will be saved in
+ If this directive is specified, the counter and its values will be saved in
the specified catalog. If this directive is not present, the counter will be
-redefined each time that Bacula is started.
+redefined each time that Bacula is started.
\end{description}
\label{SampleDirectorConfiguration}
\index[general]{File!Example Director Configuration}
\index[general]{Example Director Configuration File}
-An example Director configuration file might be the following:
+An example Director configuration file might be the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# Default Bacula Director Configuration file
#
Messages = Standard
Pool = Default
}
-
+
# List of files to be backed up
FileSet {
Name = "Full Set"
operator = root@localhost = mount
console = all, !skipped, !saved
}
-
+
# Default pool definition
Pool {
Name = Default
Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
CommandACL = status, .status
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
-%%
-%%
-
\chapter{Basic Volume Management}
\label{DiskChapter}
\index[general]{Basic Volume Management}
Most of the concepts apply equally well to both tape and disk Volumes.
However, the chapter was originally written to explain backing up to disk, so
you will see it is slanted in that direction, but all the directives
-presented here apply equally well whether your volume is disk or tape.
+presented here apply equally well whether your volume is disk or tape.
If you have a lot of hard disk storage or you absolutely must have your
backups run within a small time window, you may want to direct Bacula to
backup to disk Volumes rather than tape Volumes. This chapter is intended to
give you some of the options that are available to you so that you can manage
-either disk or tape volumes.
+either disk or tape volumes.
\label{Concepts}
\section{Key Concepts and Resource Records}
rather easy. In the Storage daemon's configuration file, you simply define an
{\bf Archive Device} to be a directory. For example, if you want your disk
backups to go into the directory {\bf /home/bacula/backups}, you could use the
-following:
+following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Device {
Name = FileBackup
Media Type = File
RemovableMedia = no;
AlwaysOpen = no;
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Assuming you have the appropriate {\bf Storage} resource in your Director's
-configuration file that references the above Device resource,
+configuration file that references the above Device resource,
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Storage {
Name = FileStorage
Address = ...
Device = FileBackup
Media Type = File
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Bacula will then write the archive to the file {\bf
another directory, you should not rename it or it will become unreadable by
Bacula. This is because each archive has the filename as part of the internal
label, and the internal label must agree with the system filename before
-Bacula will use it.
+Bacula will use it.
Although this is quite simple, there are a number of problems. The first is
that unless you specify otherwise, Bacula will always write to the same volume
\index[general]{Pool Options to Limit the Volume Usage }
Some of the options you have, all of which are specified in the Pool record,
-are:
+are:
-\begin{itemize}
+\begin{bsysitemize}
\item To write each Volume only once (i.e. one Job per Volume or file in this
case), use:
-{\bf UseVolumeOnce = yes}.
+{\bf UseVolumeOnce = yes}.
\item To write nnn Jobs to each Volume, use:
- {\bf Maximum Volume Jobs = nnn}.
+ {\bf Maximum Volume Jobs = nnn}.
\item To limit the maximum size of each Volume, use:
- {\bf Maximum Volume Bytes = mmmm}.
+ {\bf Maximum Volume Bytes = mmmm}.
Note, if you use disk volumes, with all versions up to and including
- 1.39.28, you should probably limit the Volume size to some reasonable
+ 1.39.28, you should probably limit the Volume size to some reasonable
value such as say 5GB. This is because during a restore, Bacula is
currently unable to seek to the proper place in a disk volume to restore
a file, which means that it must read all records up to where the
\item To limit the use time (i.e. write the Volume for a maximum of five days),
use:
-{\bf Volume Use Duration = ttt}.
-\end{itemize}
+{\bf Volume Use Duration = ttt}.
+\end{bsysitemize}
Note that although you probably would not want to limit the number of bytes on
a tape as you would on a disk Volume, the other options can be very useful in
limiting the time Bacula will use a particular Volume (be it tape or disk).
For example, the above directives can allow you to ensure that you rotate
-through a set of daily Volumes if you wish.
+through a set of daily Volumes if you wish.
As mentioned above, each of those directives is specified in the Pool or
Pools that you use for your Volumes. In the case of {\bf Maximum Volume Job},
changing the Pool will have no effect on existing Volumes. You can either
manually change the Volume values, or refresh them from the Pool defaults using
the {\bf update volume} command in the Console. As an example
-of the use of one of the above, suppose your Pool resource contains:
+of the use of one of the above, suppose your Pool resource contains:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Pool {
Name = File
Pool Type = Backup
Volume Use Duration = 23h
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
then if you run a backup once a day (every 24 hours), Bacula will use a new
Volume for each backup, because each Volume it writes can only be used for 23 hours
-after the first write. Note, setting the use duration to 23 hours is not a very
+after the first write. Note, setting the use duration to 23 hours is not a very
good solution for tapes unless you have someone on-site during the weekends,
because Bacula will want a new Volume and no one will be present to mount it,
so no weekend backups will be done until Monday morning.
needed. While, the automatic Volume labeling in version 1.30 and prior is a
bit simplistic, but it does allow for automation, the features added in
version 1.31 permit automatic creation of a wide variety of labels including
-information from environment variables and special Bacula Counter variables.
-In version 1.37 and later, it is probably much better to use Python scripting
+information from environment variables and special Bacula Counter variables.
+In version 1.37 and later, it is probably much better to use Python scripting
and the NewVolume event since generating Volume labels in a Python script is
much easier than trying to figure out Counter variables. See the
-\ilink{Python Scripting}{PythonChapter} chapter of this manual for more
-details.
+\bsysxrlink{Python Scripting}{PythonChapter}{misc}{chapter} of the \miscman{}
+ for more details.
Please note that automatic Volume labeling can also be used with tapes, but
it is not nearly so practical since the tapes must be pre-mounted. This
requires some user interaction. Automatic labeling from templates does NOT
work with autochangers since Bacula will not access unknown slots. There
are several methods of labeling all volumes in an autochanger magazine.
-For more information on this, please see the \ilink{
-Autochanger}{AutochangersChapter} chapter of this manual.
+For more information on this, please see the \ilink{Autochanger}
+{AutochangersChapter} chapter of this manual.
Automatic Volume labeling is enabled by making a change to both the Pool
resource (Director) and to the Device resource (Storage daemon) shown above.
that it will use to create new names. In the simplest form, the label format
is simply the Volume name, to which Bacula will append a four digit number.
This number starts at 0001 and is incremented for each Volume the catalog
-contains. Thus if you modify your Pool resource to be:
+contains. Thus if you modify your Pool resource to be:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Pool {
Name = File
Pool Type = Backup
Volume Use Duration = 23h
LabelFormat = "Vol"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Bacula will create Volume names Vol0001, Vol0002, and so on when new Volumes
are needed. Much more complex and elaborate labels can be created using
-variable expansion defined in the
-\ilink{Variable Expansion}{VarsChapter} chapter of this manual.
+variable expansion defined in the
+\bsysxrlink{Variable Expansion}{VarsChapter}{misc}{chapter} of the \miscman{}.
The second change that is necessary to make automatic labeling work is to give
the Storage daemon permission to automatically label Volumes. Do so by adding
-{\bf LabelMedia = yes} to the Device resource as follows:
+{\bf LabelMedia = yes} to the Device resource as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Device {
Name = File
Media Type = File
AlwaysOpen = no;
LabelMedia = yes
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
-You can find more details of the {\bf Label Format} Pool record in
+You can find more details of the {\bf Label Format} Pool record in
\ilink{Label Format}{Label} description of the Pool resource
-records.
+records.
\label{Recycling1}
\subsection{Restricting the Number of Volumes and Recycling}
With the above scheme, a new Volume will be created every day. If you have not
specified Retention periods, your Catalog will continue to fill keeping track
of all the files Bacula has backed up, and this procedure will create one new
-archive file (Volume) every day.
+archive file (Volume) every day.
The tools Bacula gives you to help automatically manage these problems are the
-following:
+following:
\begin{enumerate}
-\item Catalog file record retention periods, the
+\item Catalog file record retention periods, the
\ilink{File Retention = ttt}{FileRetention} record in the Client
- resource.
-\item Catalog job record retention periods, the
+ resource.
+\item Catalog job record retention periods, the
\ilink{Job Retention = ttt}{JobRetention} record in the Client
- resource.
-\item The
+ resource.
+\item The
\ilink{ AutoPrune = yes}{AutoPrune} record in the Client resource
- to permit application of the above two retention periods.
-\item The
+ to permit application of the above two retention periods.
+\item The
\ilink{ Volume Retention = ttt}{VolRetention} record in the Pool
- resource.
-\item The
+ resource.
+\item The
\ilink{ AutoPrune = yes}{PoolAutoPrune} record in the Pool
- resource to permit application of the Volume retention period.
-\item The
+ resource to permit application of the Volume retention period.
+\item The
\ilink{ Recycle = yes}{PoolRecycle} record in the Pool resource
- to permit automatic recycling of Volumes whose Volume retention period has
- expired.
-\item The
+ to permit automatic recycling of Volumes whose Volume retention period has
+ expired.
+\item The
\ilink{ Recycle Oldest Volume = yes}{RecycleOldest} record in the
Pool resource tells Bacula to Prune the oldest volume in the Pool, and if all
- files were pruned to recycle this volume and use it.
-\item The
+ files were pruned to recycle this volume and use it.
+\item The
\ilink{ Recycle Current Volume = yes}{RecycleCurrent} record in
the Pool resource tells Bacula to Prune the currently mounted volume in the
- Pool, and if all files were pruned to recycle this volume and use it.
-\item The
+ Pool, and if all files were pruned to recycle this volume and use it.
+\item The
\ilink{ Purge Oldest Volume = yes}{PurgeOldest} record in the
Pool resource permits a forced recycling of the oldest Volume when a new one
is needed. {\bf N.B. This record ignores retention periods! We highly
- recommend not to use this record, but instead use Recycle Oldest Volume}
-\item The
+ recommend not to use this record, but instead use Recycle Oldest Volume}
+\item The
\ilink{ Maximum Volumes = nnn}{MaxVolumes} record in the Pool
- resource to limit the number of Volumes that can be created.
+ resource to limit the number of Volumes that can be created.
\end{enumerate}
The first three records (File Retention, Job Retention, and AutoPrune)
determine the amount of time that Job and File records will remain in your
-Catalog, and they are discussed in detail in the
+Catalog, and they are discussed in detail in the
\ilink{Automatic Volume Recycling}{RecyclingChapter} chapter of
-this manual.
+this manual.
Volume Retention, AutoPrune, and Recycle determine how long Bacula will keep
your Volumes before reusing them, and they are also discussed in detail in the
\ilink{Automatic Volume Recycling}{RecyclingChapter} chapter of
-this manual.
+this manual.
The Maximum Volumes record can also be used in conjunction with the Volume
Retention period to limit the total number of archive Volumes (files) that
through a fixed set of Volumes. Cycling through a fixed set of Volumes can
also be done by setting {\bf Recycle Oldest Volume = yes} or {\bf Recycle
Current Volume = yes}. In this case, when Bacula needs a new Volume, it will
-prune the specified volume.
+prune the specified volume.
\label{ConcurrentDiskJobs}
\section{Concurrent Disk Jobs}
\index[general]{Concurrent Disk Jobs}
Above, we discussed how you could have a single device named {\bf
-FileBackup} that writes to volumes in {\bf /home/bacula/backups}.
-You can, in fact, run multiple concurrent jobs using the
+FileBackup} that writes to volumes in {\bf /home/bacula/backups}.
+You can, in fact, run multiple concurrent jobs using the
Storage definition given with this example, and all the jobs will
simultaneously write into the Volume that is being written.
Storage resources in your bacula-dir.conf.
OK, so now you should understand that you need multiple Device definitions
-in the case of different directories or different Pools, but you also
+in the case of different directories or different Pools, but you also
need to know that the catalog data that Bacula keeps contains only
-the Media Type and not the specific storage device. This permits a tape
+the Media Type and not the specific storage device. This permits a tape
for example to be re-read on any compatible tape drive. The compatibility
being determined by the Media Type. The same applies to disk storage.
Since a volume that is written by a Device in say directory {\bf
/home/bacula/backups} cannot be read by a Device with an Archive Device
definition of {\bf /home/bacula/client1}, you will not be able to
-restore all your files if you give both those devices
-{\bf Media Type = File}. During the restore, Bacula will simply choose
+restore all your files if you give both those devices
+{\bf Media Type = File}. During the restore, Bacula will simply choose
the first available device, which may not be the correct one. If this
is confusing, just remember that the Directory has only the Media Type
and the Volume name. It does not know the {\bf Archive Device} (or the
The example shown below shows a case where there are two clients, each
using its own Pool and storing their Volumes in different directories.
-
+
\label{Example2}
\section{An Example}
machine. Each Volume is used (written) only once, and there are four Full
saves done every hour (so the whole thing cycles around after three hours).
-What is key here is that each physical device on the Storage daemon
+What is key here is that each physical device on the Storage daemon
has a different Media Type. This allows the Director to choose the
correct device for restores ...
-The Director's configuration file is as follows:
+The Director's configuration file is as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = my-dir
QueryFile = "~/bacula/bin/query.sql"
Recycle = yes
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
-and the Storage daemon's configuration file is:
+and the Storage daemon's configuration file is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Storage {
Name = my-sd
WorkingDirectory = "~/bacula/working"
Name = Standard
director = my-dir = all
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
With a little bit of work, you can change the above example into a weekly or
-monthly cycle (take care about the amount of archive disk space used).
+monthly cycle (take care about the amount of archive disk space used).
\label{MultipleDisks}
\section{Backing up to Multiple Disks}
For example, assume that you have two disks named {\bf /disk1} and {\bf
/disk2}. If you then create a standard Storage daemon Device resource for
-backing up to the first disk, it will look like the following:
+backing up to the first disk, it will look like the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Device {
Name = client1
Media Type = File
RemovableMedia = no;
AlwaysOpen = no;
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Since there is no way to get the above Device resource to reference both {\bf
/disk1} and {\bf /disk2} we do it by pre-creating Volumes on /disk2 with the
-following:
+following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
ln -s /disk2/Disk2-vol001 /disk1/Disk2-vol001
ln -s /disk2/Disk2-vol002 /disk1/Disk2-vol002
ln -s /disk2/Disk2-vol003 /disk1/Disk2-vol003
...
-\end{verbatim}
+\end{lstlisting}
\normalsize
At this point, you can label the Volumes as Volume {\bf Disk2-vol001}, {\bf
actually write the data to /disk2. The only minor inconvenience with this
method is that you must explicitly name the disks and cannot use automatic
labeling unless you arrange to have the labels exactly match the links you
-have created.
+have created.
An important thing to know is that Bacula treats disks like tape drives
as much as it can. This means that you can only have a single Volume
mounted at one time on a disk as defined in your Device resource in
-the Storage daemon's conf file. You can have multiple concurrent
+the Storage daemon's conf file. You can have multiple concurrent
jobs running that all write to the one Volume that is being used, but
if you want to have multiple concurrent jobs that are writing to
-separate disks drives (or partitions), you will need to define
+separate disks drives (or partitions), you will need to define
separate Device resources for each one, exactly as you would do for
two different tape drives. There is one fundamental difference, however.
The Volumes that you create on the two drives cannot be easily exchanged
An example would be the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Device {
Name = Disk1
Media Type = File1
RemovableMedia = no;
AlwaysOpen = no;
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
With the above device definitions, you can run two concurrent
\index[general]{Multiple Clients}
If we take the above example and add a second Client, here are a few
-considerations:
+considerations:
-\begin{itemize}
+\begin{bsysitemize}
\item Although the second client can write to the same set of Volumes, you
- will probably want to write to a different set.
+ will probably want to write to a different set.
\item You can write to a different set of Volumes by defining a second Pool,
- which has a different name and a different {\bf LabelFormat}.
+ which has a different name and a different {\bf LabelFormat}.
\item If you wish the Volumes for the second client to go into a different
directory (perhaps even on a different filesystem to spread the load), you
would do so by defining a second Device resource in the Storage daemon. The
{\bf Name} must be different, and the {\bf Archive Device} could be
different. To ensure that Volumes are never mixed from one pool to another,
-you might also define a different MediaType (e.g. {\bf File1}).
-\end{itemize}
+you might also define a different MediaType (e.g. {\bf File1}).
+\end{bsysitemize}
In this example, we have two clients, each with a different Pool and a
different number of archive files retained. They also write to different
-directories with different Volume labeling.
+directories with different Volume labeling.
-The Director's configuration file is as follows:
+The Director's configuration file is as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = my-dir
QueryFile = "~/bacula/bin/query.sql"
Include {
Options {
compression=GZIP
- signature=SHA1
+ signature=SHA1
}
File = /home/kern/bacula/bin
}
Maximum Volumes = 8
Recycle = yes
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
-and the Storage daemon's configuration file is:
+and the Storage daemon's configuration file is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Storage {
Name = my-sd
WorkingDirectory = "~/bacula/working"
Name = Standard
director = my-dir = all
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
+++ /dev/null
-% TODO: maybe get rid of centering
-
-\chapter{GNU Free Documentation License}
-\index[general]{GNU Free Documentation License}
-\index[general]{License!GNU Free Documentation}
-
-\label{label_fdl}
-
- \begin{center}
-
- Version 1.2, November 2002
-
-
- Copyright \copyright 2000,2001,2002 Free Software Foundation, Inc.
-
- \bigskip
-
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
- \bigskip
-
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-\end{center}
-
-
-\begin{center}
-{\bf\large Preamble}
-\end{center}
-
-The purpose of this License is to make a manual, textbook, or other
-functional and useful document "free" in the sense of freedom: to
-assure everyone the effective freedom to copy and redistribute it,
-with or without modifying it, either commercially or noncommercially.
-Secondarily, this License preserves for the author and publisher a way
-to get credit for their work, while not being considered responsible
-for modifications made by others.
-
-This License is a kind of "copyleft", which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
-
-\begin{center}
-{\Large\bf 1. APPLICABILITY AND DEFINITIONS}
-\end{center}
-
-This License applies to any manual or other work, in any medium, that
-contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License. Such a notice grants a
-world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein. The \textbf{"Document"}, below,
-refers to any such manual or work. Any member of the public is a
-licensee, and is addressed as \textbf{"you"}. You accept the license if you
-copy, modify or distribute the work in a way requiring permission
-under copyright law.
-
-A \textbf{"Modified Version"} of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A \textbf{"Secondary Section"} is a named appendix or a front-matter section of
-the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall subject
-(or to related matters) and contains nothing that could fall directly
-within that overall subject. (Thus, if the Document is in part a
-textbook of mathematics, a Secondary Section may not explain any
-mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The \textbf{"Invariant Sections"} are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License. If a
-section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant. The Document may contain zero
-Invariant Sections. If the Document does not identify any Invariant
-Sections then there are none.
-
-The \textbf{"Cover Texts"} are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License. A Front-Cover Text may
-be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
-A \textbf{"Transparent"} copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, that is suitable for revising the document
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup, or absence of markup, has been arranged to thwart
-or discourage subsequent modification by readers is not Transparent.
-An image format is not Transparent if used for any substantial amount
-of text. A copy that is not "Transparent" is called \textbf{"Opaque"}.
-
-Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
-or XML using a publicly available DTD, and standard-conforming simple
-HTML, PostScript or PDF designed for human modification. Examples of
-transparent image formats include PNG, XCF and JPG. Opaque formats
-include proprietary formats that can be read and edited only by
-proprietary word processors, SGML or XML for which the DTD and/or
-processing tools are not generally available, and the
-machine-generated HTML, PostScript or PDF produced by some word
-processors for output purposes only.
-
-The \textbf{"Title Page"} means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, "Title Page" means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
-A section \textbf{"Entitled XYZ"} means a named subunit of the Document whose
-title either is precisely XYZ or contains XYZ in parentheses following
-text that translates XYZ in another language. (Here XYZ stands for a
-specific section name mentioned below, such as \textbf{"Acknowledgements"},
-\textbf{"Dedications"}, \textbf{"Endorsements"}, or \textbf{"History"}.)
-To \textbf{"Preserve the Title"}
-of such a section when you modify the Document means that it remains a
-section "Entitled XYZ" according to this definition.
-
-The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document. These Warranty
-Disclaimers are considered to be included by reference in this
-License, but only as regards disclaiming warranties: any other
-implication that these Warranty Disclaimers may have is void and has
-no effect on the meaning of this License.
-
-
-\begin{center}
-{\Large\bf 2. VERBATIM COPYING}
-\end{center}
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
-
-\begin{center}
-{\Large\bf 3. COPYING IN QUANTITY}
-\end{center}
-
-
-If you publish printed copies (or copies in media that commonly have
-printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a computer-network location from which the general network-using
-public has access to download using public-standard network protocols
-a complete Transparent copy of the Document, free of added material.
-If you use the latter option, you must take reasonably prudent steps,
-when you begin distribution of Opaque copies in quantity, to ensure
-that this Transparent copy will remain thus accessible at the stated
-location until at least one year after the last time you distribute an
-Opaque copy (directly or through your agents or retailers) of that
-edition to the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
-
-\begin{center}
-{\Large\bf 4. MODIFICATIONS}
-\end{center}
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
-\begin{itemize}
-\item[A.]
- Use in the Title Page (and on the covers, if any) a title distinct
- from that of the Document, and from those of previous versions
- (which should, if there were any, be listed in the History section
- of the Document). You may use the same title as a previous version
- if the original publisher of that version gives permission.
-
-\item[B.]
- List on the Title Page, as authors, one or more persons or entities
- responsible for authorship of the modifications in the Modified
- Version, together with at least five of the principal authors of the
- Document (all of its principal authors, if it has fewer than five),
- unless they release you from this requirement.
-
-\item[C.]
- State on the Title page the name of the publisher of the
- Modified Version, as the publisher.
-
-\item[D.]
- Preserve all the copyright notices of the Document.
-
-\item[E.]
- Add an appropriate copyright notice for your modifications
- adjacent to the other copyright notices.
-
-\item[F.]
- Include, immediately after the copyright notices, a license notice
- giving the public permission to use the Modified Version under the
- terms of this License, in the form shown in the Addendum below.
-
-\item[G.]
- Preserve in that license notice the full lists of Invariant Sections
- and required Cover Texts given in the Document's license notice.
-
-\item[H.]
- Include an unaltered copy of this License.
-
-\item[I.]
- Preserve the section Entitled "History", Preserve its Title, and add
- to it an item stating at least the title, year, new authors, and
- publisher of the Modified Version as given on the Title Page. If
- there is no section Entitled "History" in the Document, create one
- stating the title, year, authors, and publisher of the Document as
- given on its Title Page, then add an item describing the Modified
- Version as stated in the previous sentence.
-
-\item[J.]
- Preserve the network location, if any, given in the Document for
- public access to a Transparent copy of the Document, and likewise
- the network locations given in the Document for previous versions
- it was based on. These may be placed in the "History" section.
- You may omit a network location for a work that was published at
- least four years before the Document itself, or if the original
- publisher of the version it refers to gives permission.
-
-\item[K.]
- For any section Entitled "Acknowledgements" or "Dedications",
- Preserve the Title of the section, and preserve in the section all
- the substance and tone of each of the contributor acknowledgements
- and/or dedications given therein.
-
-\item[L.]
- Preserve all the Invariant Sections of the Document,
- unaltered in their text and in their titles. Section numbers
- or the equivalent are not considered part of the section titles.
-
-\item[M.]
- Delete any section Entitled "Endorsements". Such a section
- may not be included in the Modified Version.
-
-\item[N.]
- Do not retitle any existing section to be Entitled "Endorsements"
- or to conflict in title with any Invariant Section.
-
-\item[O.]
- Preserve any Warranty Disclaimers.
-\end{itemize}
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section Entitled "Endorsements", provided it contains
-nothing but endorsements of your Modified Version by various
-parties--for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
-
-\begin{center}
-{\Large\bf 5. COMBINING DOCUMENTS}
-\end{center}
-
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice, and that you preserve all their Warranty Disclaimers.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections Entitled "History"
-in the various original documents, forming one section Entitled
-"History"; likewise combine any sections Entitled "Acknowledgements",
-and any sections Entitled "Dedications". You must delete all sections
-Entitled "Endorsements".
-
-\begin{center}
-{\Large\bf 6. COLLECTIONS OF DOCUMENTS}
-\end{center}
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
-
-\begin{center}
-{\Large\bf 7. AGGREGATION WITH INDEPENDENT WORKS}
-\end{center}
-
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an "aggregate" if the copyright
-resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
-When the Document is included in an aggregate, this License does not
-apply to the other works in the aggregate which are not themselves
-derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
-covers that bracket the Document within the aggregate, or the
-electronic equivalent of covers if the Document is in electronic form.
-Otherwise they must appear on printed covers that bracket the whole
-aggregate.
-
-
-\begin{center}
-{\Large\bf 8. TRANSLATION}
-\end{center}
-
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License, and all the license notices in the
-Document, and any Warranty Disclaimers, provided that you also include
-the original English version of this License and the original versions
-of those notices and disclaimers. In case of a disagreement between
-the translation and the original version of this License or a notice
-or disclaimer, the original version will prevail.
-
-If a section in the Document is Entitled "Acknowledgements",
-"Dedications", or "History", the requirement (section 4) to Preserve
-its Title (section 1) will typically require changing the actual
-title.
-
-
-\begin{center}
-{\Large\bf 9. TERMINATION}
-\end{center}
-
-
-You may not copy, modify, sublicense, or distribute the Document except
-as expressly provided for under this License. Any other attempt to
-copy, modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However,
-parties who have received copies, or rights, from you under this
-License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-
-\begin{center}
-{\Large\bf 10. FUTURE REVISIONS OF THIS LICENSE}
-\end{center}
-
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
-http://www.gnu.org/copyleft/.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License "or any later version" applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation.
-
-
-\begin{center}
-{\Large\bf ADDENDUM: How to use this License for your documents}
-% TODO: this is too long for table of contents
-\end{center}
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
-\bigskip
-\begin{quote}
- Copyright \copyright YEAR YOUR NAME.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.2
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU
- Free Documentation License".
-\end{quote}
-\bigskip
-
-If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the "with...Texts." line with this:
-
-\bigskip
-\begin{quote}
- with the Invariant Sections being LIST THEIR TITLES, with the
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
-\end{quote}
-\bigskip
-
-If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
-
-%---------------------------------------------------------------------
--- /dev/null
+../../licences/fdl.tex
\ No newline at end of file
The Client (or File Daemon) Configuration is one of the simpler ones to
specify. Generally, other than changing the Client name so that error messages
are easily identified, you will not need to modify the default Client
-configuration file.
+configuration file.
For a general discussion of configuration file and resources including the
-data types recognized by {\bf Bacula}, please see the
+data types recognized by {\bf Bacula}, please see the
\ilink{Configuration}{ConfigureChapter} chapter of this manual. The
-following Client Resource definitions must be defined:
+following Client Resource definitions must be defined:
-\begin{itemize}
-\item
+\begin{bsysitemize}
+\item
\ilink{Client}{ClientResource} -- to define what Clients are to
- be backed up.
-\item
+ be backed up.
+\item
\ilink{Director}{DirectorResource} -- to define the Director's
- name and its access password.
-\item
+ name and its access password.
+\item
\ilink{Messages}{MessagesChapter} -- to define where error and
- information messages are to be sent.
-\end{itemize}
+ information messages are to be sent.
+\end{bsysitemize}
\section{The Client Resource}
\label{ClientResource}
The Client Resource (or FileDaemon) resource defines the name of the Client
(as used by the Director) as well as the port on which the Client listens for
-Director connections.
+Director connections.
\begin{description}
\index[fd]{Directive!Client (or FileDaemon)}
Start of the Client records. There must be one and only one Client resource
in the configuration file, since it defines the properties of the current
- client program.
+ client program.
\item [Name = \lt{}name\gt{}]
\index[fd]{Name}
The client name that must be used by the Director when connecting. Generally,
it is a good idea to use a name related to the machine so that error messages
can be easily identified if you have multiple Clients. This directive is
- required.
+ required.
\item [Working Directory = \lt{}Directory\gt{}]
\index[fd]{Working Directory}
daemon may put its status files. This directory should be used only by {\bf
Bacula}, but may be shared by other Bacula daemons provided the daemon
names on the {\bf Name} definition are unique for each daemon. This directive
- is required.
+ is required.
On Win32 systems, in some circumstances you may need to specify a drive
letter in the specified working directory path. Also, please be sure
\item [Pid Directory = \lt{}Directory\gt{}]
\index[fd]{Pid Directory}
\index[fd]{Directive!Pid Directory}
- This directive is mandatory and specifies a directory in which the Director
+ This directive is mandatory and specifies a directory in which the Director
may put its process Id file files. The process Id file is used to shutdown
- Bacula and to prevent multiple copies of Bacula from running simultaneously.
+ Bacula and to prevent multiple copies of Bacula from running simultaneously.
This record is required. Standard shell expansion of the {\bf Directory} is
done when the configuration file is read so that values such as {\bf \$HOME}
- will be properly expanded.
+ will be properly expanded.
Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
not installing Bacula in the system directories, you can use the {\bf Working
- Directory} as defined above.
+ Directory} as defined above.
\item [Heartbeat Interval = \lt{}time-interval\gt{}]
\index[fd]{Heartbeat Interval}
signal to the Director and to the Storage daemon to keep the channels
active. The default interval is zero which disables the heartbeat.
This feature is particularly useful if you have a router such as 3Com
- that does not follow Internet standards and times out a valid
+ that does not follow Internet standards and times out a valid
connection after a short duration despite the fact that keepalive is
set. This usually results in a broken pipe error message.
Browse to:
Start \gt{} Control Panel \gt{} Network Connections
- Right click the connection for the nvidia adapter and select properties.
- Under the General tab, click "Configure...". Under the Advanced tab set
- "Checksum Offload" to disabled and click OK to save the change.
-
+ Right click the connection for the nvidia adapter and select properties.
+ Under the General tab, click "Configure...". Under the Advanced tab set
+ "Checksum Offload" to disabled and click OK to save the change.
+
Lack of communications, or communications that get interrupted can
also be caused by Linux firewalls where you have a rule that throttles
connections or traffic.
an example:
\footnotesize
-\begin{verbatim}
- FDAddresses = {
+\begin{lstlisting}
+ FDAddresses = {
ip = { addr = 1.2.3.4; port = 1205; }
ipv4 = {
addr = 1.2.3.4; port = http; }
addr = bluedot.thun.net
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
as a number or as the mnemonic value from the /etc/services file. If a port
is not specified, the default will be used. If an ip section is specified,
the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
-only IPv4 resolutions will be permitted, and likewise with ip6.
+only IPv4 resolutions will be permitted, and likewise with ip6.
\item [FDPort = \lt{}port-number\gt{}]
\index[fd]{FDPort}
\index[fd]{Directive!FDPort}
This specifies the port number on which the Client listens for Director
connections. It must agree with the FDPort specified in the Client resource
- of the Director's configuration file. The default is 9102.
+ of the Director's configuration file. The default is 9102.
\item [FDAddress = \lt{}IP-Address\gt{}]
\index[fd]{FDAddress}
\index[fd]{Directive!FDAddress}
This record is optional, and if it is specified, it will cause the File
daemon server (for Director connections) to bind to the specified {\bf
- IP-Address}, which is either a domain name or an IP address specified as a
+ IP-Address}, which is either a domain name or an IP address specified as a
dotted quadruple. If this record is not specified, the File daemon will bind
- to any available address (the default).
+ to any available address (the default).
\item [FDSourceAddress = \lt{}IP-Address\gt{}]
\index[fd]{FDSourceAddress}
This record is optional, and if it is specified, it will cause the File
daemon server (for Storage connections) to bind to the specified {\bf
IP-Address}, which is either a domain name or an IP address specified as a
- dotted quadruple. If this record is not specified, the kernel will choose
+ dotted quadruple. If this record is not specified, the kernel will choose
the best address according to the routing table (the default).
\item [SDConnectTimeout = \lt{}time-interval\gt{}]
\index[fd]{SDConnectTimeout}
\index[fd]{Directive!SDConnectTimeout}
This record defines an interval of time that the File daemon will try to
- connect to the Storage daemon. The default is 30 minutes. If no connection
- is made in the specified time interval, the File daemon cancels the Job.
+ connect to the Storage daemon. The default is 30 minutes. If no connection
+ is made in the specified time interval, the File daemon cancels the Job.
-\item [Maximum Network Buffer Size = \lt{}bytes\gt{}]
+\item [Maximum Network Buffer Size = \lt{}bytes\gt{}]
\index[fd]{Maximum Network Buffer Size}
\index[fd]{Directive!Maximum Network Buffer Size}
where \lt{}bytes\gt{} specifies the initial network buffer size to use with
the File daemon. This size will be adjusted down if it is too large until it
is accepted by the OS. Please use care in setting this value since if it is
too large, it will be trimmed by 512 bytes until the OS is happy, which may
- require a large number of system calls. The default value is 65,536 bytes.
+ require a large number of system calls. The default value is 65,536 bytes.
Note, on certain Windows machines, there are reports that the
transfer rates are very slow and this seems to be related to
\item [PKI Encryption]
- See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
+ See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
\item [PKI Signatures]
- See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
+ See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
\item [PKI Keypair]
- See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
+ See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
\item [PKI Master Key]
- See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
+ See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
\end{description}
-The following is an example of a valid Client resource definition:
+The following is an example of a valid Client resource definition:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Client { # this is me
Name = rufus-fd
WorkingDirectory = $HOME/bacula/bin/working
Pid Directory = $HOME/bacula/bin/working
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{The Director Resource}
\index[general]{Resource!Director }
The Director resource defines the name and password of the Directors that are
-permitted to contact this Client.
+permitted to contact this Client.
\begin{description}
\index[fd]{Directive!Director}
Start of the Director records. There may be any number of Director resources
in the Client configuration file. Each one specifies a Director that is
- allowed to connect to this Client.
+ allowed to connect to this Client.
\item [Name = \lt{}name\gt{}]
\index[fd]{Name}
\index[fd]{Directive!Name}
- The name of the Director that may contact this Client. This name must be the
+ The name of the Director that may contact this Client. This name must be the
same as the name specified on the Director resource in the Director's
configuration file. Note, the case (upper/lower) of the characters in
the name are significant (i.e. S is not the same as s). This directive
- is required.
+ is required.
\item [Password = \lt{}password\gt{}]
\index[fd]{Password}
\index[fd]{Directive!Password}
Specifies the password that must be supplied for a Director to be authorized.
This password must be the same as the password specified in the Client
-resource in the Director's configuration file. This directive is required.
+resource in the Director's configuration file. This directive is required.
\item [Maximum Bandwidth Per Job = \lt{}speed\gt{}]
\index[fd]{Maximum Bandwidth Per Job}
to this Client. If Monitor is set to {\bf yes}, this director will only be
able to fetch the current status of this Client.
- Please note that if this director is being used by a Monitor, we highly
- recommend to set this directive to {\bf yes} to avoid serious security
- problems.
+ Please note that if this director is being used by a Monitor, we highly
+ recommend to set this directive to {\bf yes} to avoid serious security
+ problems.
\end{description}
Thus multiple Directors may be authorized to use this Client's services. Each
Director will have a different name, and normally a different password as
-well.
+well.
-The following is an example of a valid Director resource definition:
+The following is an example of a valid Director resource definition:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# List Directors who are permitted to contact the File daemon
#
Password = not_as_good
Monitor = Yes
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{The Message Resource}
\index[general]{Message Resource}
\index[general]{Resource!Message }
-Please see the
+Please see the
\ilink{Messages Resource}{MessagesChapter} Chapter of this
-manual for the details of the Messages Resource.
+manual for the details of the Messages Resource.
-There must be at least one Message resource in the Client configuration file.
+There must be at least one Message resource in the Client configuration file.
\section{Example Client Configuration File}
\label{SampleClientConfiguration}
\index[general]{Example Client Configuration File }
\index[general]{File!Example Client Configuration }
-An example File Daemon configuration file might be the following:
+An example File Daemon configuration file might be the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# Default Bacula File Daemon Configuration file
#
Name = Standard
director = rufus-dir = all, !skipped
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
--%
-%%
-
\section{The FileSet Resource}
\label{FileSetResource}
\index[general]{Resource!FileSet}
Bacula will ensure that the next backup is always a Full save.
Bacula is designed to handle most character sets of the world,
-US ASCII, German, French, Chinese, ... However, it does this by
+US ASCII, German, French, Chinese, \ldots{} However, it does this by
encoding everything in UTF-8, and it expects all configuration files
(including those read on Win32 machines) to be in UTF-8 format.
UTF-8 is typically the default on Linux machines, but not on all
Unix machines, nor on Windows, so you must take some care to ensure
-that your locale is set properly before starting Bacula.
+that your locale is set properly before starting Bacula.
On most modern Win32 machines, you can edit the conf files with {\bf
notebook} and choose output encoding UTF-8.
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
\index[dir]{Directive!Name}
- The name of the FileSet resource. This directive is required.
+ The name of the FileSet resource. This directive is required.
\item [Ignore FileSet Changes = \lt{}yes\vb{}no\gt{}]
\index[dir]{Ignore FileSet Changes}
the next backup will be forced to a Full so that Bacula can
guarantee that any additions or deletions are properly saved.
- We strongly recommend against setting this directive to yes,
+ We strongly recommend against setting this directive to yes,
since doing so may cause you to have an incomplete set of backups.
If this directive is set to {\bf yes}, any changes you make to the
- FileSet Include or Exclude lists, will not force a Full during
+ FileSet Include or Exclude lists, will not force a Full during
subsequent backups.
The default is {\bf no}, in which case, if you change the Include or
of open files to be made for cooperating writer applications, and for
applications that are not VSS away, Bacula can at least copy open files.
The Volume Shadow Copy will only be done on Windows drives where the
- drive (e.g. C:, D:, ...) is explicitly mentioned in a {\bf File}
+ drive (e.g. C:, D:, \ldots{}) is explicitly mentioned in a {\bf File}
directive.
For more information, please see the
\ilink{Windows}{VSS} chapter of this manual.
-\item [Include \{ Options \{\lt{}file-options\gt{}\} ...;
+\item [Include \{ Options \{\lt{}file-options\gt{}\} \ldots{};
\lt{}file-list\gt{} \} ]
-\index[dir]{Include \{ [ Options \{\lt{}file-options\gt{}\} ...]
+\index[dir]{Include \{ [ Options \{\lt{}file-options\gt{}\} \ldots{}]
\lt{}file-list\gt{} \} }
\index[dir]{Directive!Include}
consists of one file or directory name per line. Directory names should be
specified without a trailing slash with Unix path notation.
-Windows users, please take note to specify directories (even c:/...) in
+Windows users, please take note to specify directories (even c:/\ldots{}) in
Unix path notation. If you use Windows conventions, you will most likely
not be able to restore your files due to the fact that the Windows
path separator was defined as an escape character long before Windows
only the root partition and not any of the other mounted filesystems.
Similarly on Windows systems, you must explicitly specify each of the
drives you want saved (e.g.
-{\bf c:/} and {\bf d:/} ...). In addition, at least for Windows systems, you
+{\bf c:/} and {\bf d:/} \ldots{}). In addition, at least for Windows systems, you
will most likely want to enclose each specification within double quotes
particularly if the directory (or file) name contains spaces. The {\bf df}
command on Unix systems will show you which mount points you must specify to
-save everything. See below for an example.
+save everything. See below for an example.
Take special care not to include a directory twice or Bacula will backup
the same files two times wasting a lot of space on your archive device.
Including a directory twice is very easy to do. For example:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Include {
Options { compression=GZIP }
File = /
File = /usr
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
on a Unix system where /usr is a subdirectory (rather than a mounted
filesystem) will cause /usr to be backed up twice.
-Please take note of the following items in the FileSet syntax:
+Please take note of the following items in the FileSet syntax:
\begin{enumerate}
\item There is no equal sign (=) after the Include and before the opening
- brace (\{). The same is true for the Exclude.
+ brace (\{). The same is true for the Exclude.
\item Each directory (or filename) to be included or excluded is preceded by a {\bf File
- =}. Previously they were simply listed on separate lines.
+ =}. Previously they were simply listed on separate lines.
\item The options that previously appeared on the Include line now must be
specified within their own Options resource.
-\item The Exclude resource does not accept Options.
+\item The Exclude resource does not accept Options.
\item When using wild-cards or regular expressions, directory names are
always terminated with a slash (/) and filenames have no trailing slash.
\end{enumerate}
The Options resource is optional, but when specified, it will contain a
list of {\bf keyword=value} options to be applied to the file-list.
-See below for the definition of file-list.
+See below for the definition of file-list.
Multiple Options resources may be specified one after another. As the
files are found in the specified directories, the Options will applied to
the filenames to determine if and how the file should be backed up. The
It is a good idea to put all your wild-card and regex expressions inside
double quotes to prevent conf file scanning problems.
-This is perhaps a bit overwhelming, so there are a number of examples included
+This is perhaps a bit overwhelming, so there are a number of examples included
below to illustrate how this works.
You find yourself using a lot of Regex statements, which will cost quite a lot
of CPU time, we recommend you simplify them if you can, or better yet
convert them to Wild statements which are much more efficient.
-The directives within an Options resource may be one of the following:
+The directives within an Options resource may be one of the following:
\begin{description}
or the SHA1 option be specified as a default for all files.
-\item[basejob=\lt{}options\gt{}]
+\item[basejob=\lt{}options\gt{}]
\index[dir]{basejob}
\index[dir]{Directive!basejob}
with BaseJobs. The options letters are the same than in the \textbf{verify=}
option below.
-\item[accurate=\lt{}options\gt{}]
+\item[accurate=\lt{}options\gt{}]
\index[dir]{accurate}
\index[dir]{Directive!accurate}
The options letters specified are used when running a {\bf Backup
Level=Incremental/Differential} in Accurate mode. The options
- letters are the same than in the \textbf{verify=} option below.
+ letters are the same than in the \textbf{verify=} option below.
\item [verify=\lt{}options\gt{}]
\index[dir]{verify}
\index[dir]{Directive!verify}
The options letters specified are used when running a {\bf Verify
Level=Catalog} as well as the {\bf DiskToCatalog} level job. The options
- letters may be any combination of the following:
+ letters may be any combination of the following:
\begin{description}
\item {\bf i}
- compare the inodes
+ compare the inodes
\item {\bf p}
- compare the permission bits
+ compare the permission bits
\item {\bf n}
- compare the number of links
+ compare the number of links
\item {\bf u}
- compare the user id
+ compare the user id
\item {\bf g}
- compare the group id
+ compare the group id
\item {\bf s}
- compare the size
+ compare the size
\item {\bf a}
- compare the access time
+ compare the access time
\item {\bf m}
- compare the modification time (st\_mtime)
+ compare the modification time (st\_mtime)
\item {\bf c}
- compare the change time (st\_ctime)
+ compare the change time (st\_ctime)
\item {\bf d}
- report file size decreases
+ report file size decreases
\item {\bf 5}
- compare the MD5 signature
+ compare the MD5 signature
\item {\bf 1}
- compare the SHA1 signature
+ compare the SHA1 signature
\end{description}
A useful set of general options on the {\bf Level=Catalog} or {\bf
Level=DiskToCatalog} verify is {\bf pins5} i.e. compare permission bits,
- inodes, number of links, size, and MD5 changes.
+ inodes, number of links, size, and MD5 changes.
\item [onefs=yes\vb{}no]
\index[dir]{onefs}
file system. That is it will not backup file systems that are mounted
on a subdirectory. If you are using a *nix system, you may not even be
aware that there are several different filesystems as they are often
- automatically mounted by the OS (e.g. /dev, /net, /sys, /proc, ...).
+ automatically mounted by the OS (e.g. /dev, /net, /sys, /proc, \ldots{}).
With Bacula 1.38.0 or later, it will inform you when it decides not to
traverse into another filesystem. This can be very useful if you forgot
to backup a particular partition. An example of the informational
message in the job report is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
rufus-fd: /misc is a different filesystem. Will not descend from / into /misc
rufus-fd: /net is a different filesystem. Will not descend from / into /net
rufus-fd: /var/lib/nfs/rpc_pipefs is a different filesystem. Will not descend from /var/lib/nfs into /var/lib/nfs/rpc_pipefs
rufus-fd: /sys is a different filesystem. Will not descend from / into /sys
rufus-fd: /dev is a different filesystem. Will not descend from / into /dev
rufus-fd: /home is a different filesystem. Will not descend from / into /home
-\end{verbatim}
+\end{lstlisting}
\normalsize
- Note: in previous versions of Bacula, the above message was of the form:
+ Note: in previous versions of Bacula, the above message was of the form:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Filesystem change prohibited. Will not descend into /misc
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you wish to backup multiple filesystems, you can explicitly
also be backed up. Normally, it is preferable to set {\bf onefs=yes} and to
explicitly name each filesystem you want backed up. Explicitly naming the
filesystems you want backed up avoids the possibility of getting into a
- infinite loop recursing filesystems. Another possibility is to
- use {\bf onefs=no} and to set {\bf fstype=ext2, ...}.
- See the example below for more details.
+ infinite loop recursing filesystems. Another possibility is to
+ use {\bf onefs=no} and to set {\bf fstype=ext2, \ldots{}}.
+ See the example below for more details.
If you think that Bacula should be backing up a particular directory
and it is not, and you have {\bf onefs=no} set, before you complain,
please do:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
stat /
stat <filesystem>
-\end{verbatim}
+\end{lstlisting}
\normalsize
-where you replace {\bf filesystem} with the one in question. If the
+where you replace {\bf filesystem} with the one in question. If the
{\bf Device:} number is different for / and for your filesystem, then they
are on different filesystems. E.g.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
stat /
File: `/'
Size: 4096 Blocks: 16 IO Block: 4096 directory
Access: 2005-11-10 12:28:02.000000000 +0100
Modify: 2005-11-06 12:36:48.000000000 +0100
Change: 2005-11-06 12:36:48.000000000 +0100
-\end{verbatim}
+\end{lstlisting}
\normalsize
Also be aware that even if you include {\bf /home} in your list
of files to backup, as you most likely should, you will get the
- informational message that "/home is a different filesystem" when
+ informational message that "/home is a different filesystem" when
Bacula is processing the {\bf /} directory. This message does not
- indicate an error. This message means that while examining the
- {\bf File =} referred to in the second part of the message, Bacula will
+ indicate an error. This message means that while examining the
+ {\bf File =} referred to in the second part of the message, Bacula will
not descend into the directory mentioned in the first part of the message.
- However, it is possible that the separate filesystem will be backed up
+ However, it is possible that the separate filesystem will be backed up
despite the message. For example, consider the following FileSet:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
File = /
File = /var
-\end{verbatim}
+\end{lstlisting}
\normalsize
where {\bf /var} is a separate filesystem. In this example, you will get a
- message saying that Bacula will not decend from {\bf /} into {\bf /var}. But
- it is important to realise that Bacula will descend into {\bf /var} from the
+ message saying that Bacula will not decend from {\bf /} into {\bf /var}. But
+ it is important to realise that Bacula will descend into {\bf /var} from the
second File directive shown above. In effect, the warning is bogus,
- but it is supplied to alert you to possible omissions from your FileSet. In
- this example, {\bf /var} will be backed up. If you changed the FileSet such
+ but it is supplied to alert you to possible omissions from your FileSet. In
+ this example, {\bf /var} will be backed up. If you changed the FileSet such
that it did not specify {\bf /var}, then {\bf /var} will not be backed up.
-
+
\item [honor nodump flag=\lt{}yes\vb{}no\gt{}]
\index[dir]{honornodumpflag}
\index[dir]{Directive!honornodumpflag}
directory entry for the FIFO.
Unfortunately, when Bacula runs a RunBeforeJob, it waits until that
- script terminates, and if the script accesses the FIFO to write
+ script terminates, and if the script accesses the FIFO to write
into the it, the Bacula job will block and everything will stall.
- However, Vladimir Stavrinov as supplied tip that allows this feature
+ However, Vladimir Stavrinov as supplied tip that allows this feature
to work correctly. He simply adds the following to the beginning
of the RunBeforeJob script:
-\begin{verbatim}
+\begin{lstlisting}
exec > /dev/null
-\end{verbatim}
+\end{lstlisting}
\item [noatime=yes\vb{}no]
\index[dir]{noatime}
\item [checkfilechanges=yes\vb{}no]
\index[dir]{checkfilechanges}
\index[dir]{Directive!checkfilechanges}
- On versions 2.0.4 or greater,
- if enabled, the Client will check size, age of each file after
- their backup to see if they have changed during backup. If time
+ On versions 2.0.4 or greater,
+ if enabled, the Client will check size, age of each file after
+ their backup to see if they have changed during backup. If time
or size mismatch, an error will raise.
-\begin{verbatim}
+\begin{lstlisting}
zog-fd: Client1.2007-03-31_09.46.21 Error: /tmp/test mtime changed during backup.
-\end{verbatim}
+\end{lstlisting}
In general, it is recommended to use this option.
\item [hardlinks=yes\vb{}no]
\index[dir]{hardlinks}
\index[dir]{Directive!hardlinks}
- When enabled (default), this directive will cause hard links to be
+ When enabled (default), this directive will cause hard links to be
backed up. However, the File daemon keeps track of hard linked files and
- will backup the data only once. The process of keeping track of the
+ will backup the data only once. The process of keeping track of the
hard links can be quite expensive if you have lots of them (tens of
thousands or more). This doesn't occur on normal Unix systems, but if
you use a program like BackupPC, it can create hundreds of thousands, or
You may want to test your expressions prior to running your
backup by using the bwild program. Please see the
- \ilink{Utilities}{bwild} chapter of this manual for
- more. You can also test your full FileSet definition by using
- the \ilink{estimate}{estimate} command in the Console
- chapter of this manual.
+ \bsysxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
+ more information. You can also test your full FileSet definition by using
+ the \bsysxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
It is recommended to enclose the string in double quotes.
\item [wilddir=\lt{}string\gt{}]
You may want to test your expressions prior to running your
backup by using the bwild program. Please see the
- \ilink{Utilities}{bwild} chapter of this manual for
- more. You can also test your full FileSet definition by using
- the \ilink{estimate}{estimate} command in the Console
- chapter of this manual.
- An example of excluding with the WildDir option on Win32 machines is
+ \bsysxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
+ more information. You can also test your full FileSet definition by using
+ the \bsysxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
+ An example of excluding with the WildDir option on Win32 machines is
presented below.
\item [wildfile=\lt{}string\gt{}]
You may want to test your expressions prior to running your
backup by using the bwild program. Please see the
- \ilink{Utilities}{bwild} chapter of this manual for
- more. You can also test your full FileSet definition by using
- the \ilink{estimate}{estimate} command in the Console
- chapter of this manual.
- An example of excluding with the WildFile option on Win32 machines is
+ \bsysxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
+ more information. You can also test your full FileSet definition by using
+ the \bsysxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
+ An example of excluding with the WildFile option on Win32 machines is
presented below.
another, and in addition, regular expressions are complicated,
so you may want to test your expressions prior to running your
backup by using the bregex program. Please see the
- \ilink{Utilities}{bwild} chapter of this manual for
- more. You can also test your full FileSet definition by using
- the \ilink{estimate}{estimate} command in the Console
- chapter of this manual.
+ \bsysxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
+ more information. You can also test your full FileSet definition by using
+ the \bsysxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
+
- You find yourself using a lot of Regex statements, which will cost quite a lot
- of CPU time, we recommend you simplify them if you can, or better yet
+ You find yourself using a lot of Regex statements, which will cost quite a
+ lot of CPU time, we recommend you simplify them if you can, or better yet
convert them to Wild statements which are much more efficient.
\index[dir]{regexfile}
\index[dir]{Directive!regexfile}
Specifies a POSIX extended regular expression to be applied to
- non-directories. No directories will be matched by this directive.
+ non-directories. No directories will be matched by this directive.
However, note that the match is done against the full path and
filename, so your regex string must take into account that filenames
are preceded by the full path.
another, and in addition, regular expressions are complicated,
so you may want to test your expressions prior to running your
backup by using the bregex program. Please see the
- \ilink{Utilities}{bregex} chapter of this manual for
- more.
+ \bsysxrlink{bregex}{bregex}{utility}{command} of the \utilityman{} more.
\item [regexdir=\lt{}string\gt{}]
another, and in addition, regular expressions are complicated,
so you may want to test your expressions prior to running your
backup by using the bregex program. Please see the
- \ilink{Utilities}{bregex} chapter of this manual for
- more.
+ \bsysxrlink{bregex}{bregex}{utility}{command} of the \utilityman{} more.
\item [exclude=yes\vb{}no]
\item [hfsplussupport=yes\vb{}no]
\index[dir]{hfsplussupport}
\index[dir]{Directive!hfsplussupport}
- This option allows you to turn on support for Mac OSX HFS plus
+ This option allows you to turn on support for Mac OSX HFS plus
finder information.
\item [strippath=\lt{}integer\gt{}]
in file-lists. They can only be specified in Options resources.
There are a number of special cases when specifying directories and files in a
-{\bf file-list}. They are:
+{\bf file-list}. They are:
-\begin{itemize}
+\begin{bsysitemize}
\item Any name preceded by an at-sign (@) is assumed to be the name of a
file, which contains a list of files each preceded by a "File =". The
named file is read once when the configuration file is parsed during the
specified in the conf file. For example:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Include {
Options { compression=GZIP }
@/home/files/my-files
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\item Any name beginning with a vertical bar (\vb) is assumed to be the name of
a program. This program will be executed on the Director's machine at
the time the Job starts (not when the Director reads the configuration
file), and any output from that program will be assumed to be a list of
- files or directories, one per line, to be included. Before submitting the
- specified command bacula will performe
+ files or directories, one per line, to be included. Before submitting the
+ specified command bacula will performe
\ilink{character substitution}{character substitution}.
This allows you to have a job that, for example, includes all the local
examples below show you how to do this. However, please note two
things: \\
1. if you want the local filesystems, you probably should be
- using the new {\bf fstype} directive, which was added in version 1.36.3
+ using the new {\bf fstype} directive, which was added in version 1.36.3
and set {\bf onefs=no}.
\\
{\bf sh -c} will not be necessary providing the first line of the file
is {\bf \#!/bin/sh}.
- As an example:
+ As an example:
\footnotesize
-\begin{verbatim}
-
+\begin{lstlisting}
+
Include {
Options { signature = SHA1 }
File = "|sh -c 'df -l | grep \"^/dev/hd[ab]\" | grep -v \".*/tmp\" \
| awk \"{print \\$6}\"'"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
will produce a list of all the local partitions on a Red Hat Linux system.
- Note, the above line was split, but should normally be written on one line.
+ Note, the above line was split, but should normally be written on one line.
Quoting is a real problem because you must quote for Bacula which consists of
- preceding every \textbackslash{} and every " with a \textbackslash{}, and
+ preceding every \textbackslash{} and every " with a \textbackslash{}, and
you must also quote for the shell command. In the end, it is probably easier
- just to execute a small file with:
+ just to execute a small file with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Include {
Options {
signature=MD5
}
File = "|my_partitions"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
- where my\_partitions has:
+ where my\_partitions has:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#!/bin/sh
df -l | grep "^/dev/hd[ab]" | grep -v ".*/tmp" \
| awk "{print \$6}"
-\end{verbatim}
+\end{lstlisting}
\normalsize
If the vertical bar (\verb+|+) in front of my\_partitions is preceded by a
that backs up all the local UFS partitions on a remote system is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "All local partitions"
Include {
File = "\\|bash -c \"df -klF ufs | tail +2 | awk '{print \$6}'\""
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
The above requires two backslash characters after the double quote (one
preserves the next one). If you are a Linux user, just change the {\bf ufs}
- to {\bf ext3} (or your preferred filesystem type), and you will be in
- business.
+ to {\bf ext3} (or your preferred filesystem type), and you will be in
+ business.
- If you know what filesystems you have mounted on your system, e.g.
+ If you know what filesystems you have mounted on your system, e.g.
for Red Hat Linux normally only ext2 and ext3, you can backup
all local filesystems using something like:
\footnotesize
-\begin{verbatim}
-
+\begin{lstlisting}
+
Include {
Options { signature = SHA1; onfs=no; fstype=ext2 }
File = /
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
the Job starts, and the data will be assumed to be a list of directories or
files, one per line, to be included. The names should start in column 1 and
should not be quoted even if they contain spaces. This feature allows you to
- modify the external file and change what will be saved without stopping and
+ modify the external file and change what will be saved without stopping and
restarting Bacula as would be necessary if using the @ modifier noted above.
- For example:
+ For example:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Include {
Options { signature = SHA1 }
File = "</home/files/local-filelist"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you precede the less-than sign (\lt{}) with a backslash as in
is given within quotes, you will need to use two slashes.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Include {
Options { signature = SHA1 }
File = "\\</home/xxx/filelist-on-client"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\item If you explicitly specify a block device such as {\bf /dev/hda1}, then
Bacula (starting with version 1.28) will assume that this is a raw partition
to be backed up. In this case, you are strongly urged to specify a {\bf
sparse=yes} include option, otherwise, you will save the whole partition
- rather than just the actual data that the partition contains. For example:
+ rather than just the actual data that the partition contains. For example:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Include {
Options { signature=MD5; sparse=yes }
File = /dev/hd6
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
will backup the data in device /dev/hd6. Note, the {bf /dev/hd6} must be
Ludovic Strappazon has pointed out that this feature can be used to backup a
full Microsoft Windows disk. Simply boot into the system using a Linux Rescue
- disk, then load a statically linked Bacula as described in the
+ disk, then load a statically linked Bacula as described in the
\ilink{ Disaster Recovery Using Bacula}{RescueChapter} chapter of
this manual. Then save the whole disk partition. In the case of a disaster,
you can then restore the desired partition by again booting with the rescue
- disk and doing a restore of the partition.
+ disk and doing a restore of the partition.
\item If you explicitly specify a FIFO device name (created with mkfifo), and
you add the option {\bf readfifo=yes} as an option, Bacula will read the FIFO
- and back its data up to the Volume. For example:
+ and back its data up to the Volume. For example:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Include {
Options {
signature=SHA1
}
File = /home/abc/fifo
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
if {\bf /home/abc/fifo} is a fifo device, Bacula will open the fifo,
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}
+\begin{lstlisting}
# List of files to be backed up
FileSet {
Name = "MyFileSet"
Exclude Dir Containing = .excludeme
}
}
-\end{verbatim}
+\end{lstlisting}
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
+the user or sysadmin creates a file named {\bf .excludeme} in
specific directories, such as
-\begin{verbatim}
+\begin{lstlisting}
/home/user/www/cache/.excludeme
/home/user/temp/.excludeme
-\end{verbatim}
+\end{lstlisting}
then Bacula will not backup the two directories named:
-\begin{verbatim}
+\begin{lstlisting}
/home/user/www/cache
/home/user/temp
-\end{verbatim}
+\end{lstlisting}
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).
-\end{itemize}
+\end{bsysitemize}
\section{FileSet Examples}
\index[general]{Examples!FileSet }
to be backed up preceded by a {\bf File =} and on a separate line.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "Full Set"
Include {
File = /usr/lib/another_file
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
In the above example, all the files contained in /etc/backup.list will
be compressed with GZIP compression, an SHA1 signature will be computed on the
-file's contents (its data), and sparse file handling will apply.
+file's contents (its data), and sparse file handling will apply.
The two directories /root/myfile and /usr/lib/another\_file will also be saved
without any options, but all files in those directories with the extensions
-{\bf .o} and {\bf .exe} will be excluded.
+{\bf .o} and {\bf .exe} will be excluded.
Let's say that you now want to exclude the directory /tmp. The simplest way
to do so is to add an exclude directive that lists /tmp. The example
above would then become:
-\footnotesize
-\begin{verbatim}
+\footnotesize
+\begin{lstlisting}
FileSet {
Name = "Full Set"
Include {
File = /tmp # don't add trailing /
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
it and all files and directories below it will also be excluded.
Now lets take a slight variation on the above and suppose
-you want to save all your whole filesystem except {\bf /tmp}.
+you want to save all your whole filesystem except {\bf /tmp}.
The problem that comes up is that Bacula will not normally
cross from one filesystem to another.
-Doing a {\bf df} command, you get the following output:
+Doing a {\bf df} command, you get the following output:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
[kern@rufus k]$ df
Filesystem 1k-blocks Used Available Use% Mounted on
/dev/hda5 5044156 439232 4348692 10% /
deuter:/ 4806936 97684 4465064 3% /mnt/deuter
deuter:/home 4806904 280100 4282620 7% /mnt/deuter/home
deuter:/files 44133352 27652876 14238608 67% /mnt/deuter/files
-\end{verbatim}
+\end{lstlisting}
\normalsize
And we see that there are a number of separate filesystems (/ /boot
Filesystem {\bf /dev/hda5}. To save all filesystems except {\bf /tmp} with
out including any of the Samba or NFS mounted systems, and explicitly
excluding a /tmp, /proc, .journal, and .autofsck, which you will not want to
-be saved and restored, you can use the following:
+be saved and restored, you can use the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = Include_example
Include {
File = /usr
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Since /tmp is on its own filesystem and it was not explicitly named in the
Include list, it is not really needed in the exclude list. It is better to
list it in the Exclude list for clarity, and in case the disks are changed so
-that it is no longer in its own partition.
+that it is no longer in its own partition.
-Now, lets assume you only want to backup .Z and .gz files and nothing
-else. This is a bit trickier because Bacula by default will select
+Now, lets assume you only want to backup .Z and .gz files and nothing
+else. This is a bit trickier because Bacula by default will select
everything to backup, so we must exclude everything but .Z and .gz files.
If we take the first example above and make the obvious modifications
to it, we might come up with a FileSet that looks like this:
-\footnotesize
-\begin{verbatim}
+\footnotesize
+\begin{lstlisting}
FileSet {
Name = "Full Set"
Include { !!!!!!!!!!!!
File = /myfile
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
The *.Z and *.gz files will indeed be backed up, but all other files
We do this with the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "Full Set"
Include {
File = /myfile
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
The "trick" here was to add a RegexFile expression that matches
Regex code to avoid such system dependencies.
Please be aware that allowing Bacula to traverse or change file systems can be
-{\bf very} dangerous. For example, with the following:
+{\bf very} dangerous. For example, with the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "Bad example"
Include {
File = /mnt/matou
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
you will be backing up an NFS mounted partition ({\bf /mnt/matou}), and since
{\bf onefs} is set to {\bf no}, Bacula will traverse file systems. Now if {\bf
/mnt/matou} has the current machine's file systems mounted, as is often the
case, you will get yourself into a recursive loop and the backup will never
-end.
+end.
-As a final example, let's say that you have only one or two
+As a final example, let's say that you have only one or two
subdirectories of /home that you want to backup. For example,
you want to backup only subdirectories beginning with the letter
a and the letter b -- i.e. /home/a* and /home/b*. Now, you might first
try:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "Full Set"
Include {
File = /home
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
The problem is that the above will include everything in /home. To get
instead of inclusion. So, you could simply exclude all directories
except the two you want to use:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "Full Set"
Include {
File = /home
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
And assuming that all subdirectories start with a lowercase letter, this
An alternative would be to include the two subdirectories desired and
exclude everything else:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "Full Set"
Include {
File = /home
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
directories and files and excluding everything else.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "AllPictures"
}
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{Backing up Raw Partitions}
\index[general]{Backing up!Partitions }
\index[general]{Backing up Raw Partitions }
-The following FileSet definition will backup a raw partition:
+The following FileSet definition will backup a raw partition:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "RawPartition"
Include {
File = /dev/hda2
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
While backing up and restoring a raw partition, you should ensure that no
other process including the system is writing to that partition. As a
precaution, you are strongly urged to ensure that the raw partition is not
mounted or is mounted read-only. If necessary, this can be done using the {\bf
-RunBeforeJob} directive.
+RunBeforeJob} directive.
\section{Excluding Files and Directories}
/. For example:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = Exclusion_example
Include {
File = .autofsck
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{win32}
specified in Unix convention (i.e. forward slash (/)). If you wish to include
a quote in a file name, precede the quote with a backslash
(\textbackslash{}). For example you might use the following
-for a Windows machine to backup the "My Documents" directory:
+for a Windows machine to backup the "My Documents" directory:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "Windows Set"
Include {
File = "c:/My Documents"
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
For exclude lists to work correctly on Windows, you must observe the following
-rules:
+rules:
-\begin{itemize}
-\item Filenames are case sensitive, so you must use the correct case.
-\item To exclude a directory, you must not have a trailing slash on the
- directory name.
-\item If you have spaces in your filename, you must enclose the entire name
+\begin{bsysitemize}
+\item Filenames are case sensitive, so you must use the correct case.
+\item To exclude a directory, you must not have a trailing slash on the
+ directory name.
+\item If you have spaces in your filename, you must enclose the entire name
in double-quote characters ("). Trying to use a backslash before the space
- will not work.
+ will not work.
\item If you are using the old Exclude syntax (noted below), you may not
specify a drive letter in the exclude. The new syntax noted above
should work fine including driver letters.
-\end{itemize}
+\end{bsysitemize}
Thanks to Thiago Lima for summarizing the above items for us. If you are
having difficulties getting includes or excludes to work, you might want to
-try using the {\bf estimate job=xxx listing} command documented in the
-\ilink{Console chapter}{estimate} of this manual.
+try using the {\bf estimate job=xxx listing} command documented in the
+\bsysxrlink{estimate}{estimate}{console}{command} of \consoleman{}.
On Win32 systems, if you move a directory or file or rename a file into the
set of files being backed up, and a Full backup has already been made, Bacula
Differential backup (blame Microsoft, not me). To avoid this problem, please
{\bf copy} any new directory or files into the backup area. If you do not have
enough disk to copy the directory or files, move them, but then initiate a
-Full backup.
+Full backup.
\paragraph*{A Windows Example FileSet}
\index[general]{Windows Example FileSet }
The following example was contributed by Russell Howe. Please note that
-for presentation purposes, the lines beginning with Data and Internet
+for presentation purposes, the lines beginning with Data and Internet
have been wrapped and should included on the previous line with one
space.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
This is my Windows 2000 fileset:
FileSet {
Name = "Windows 2000"
Exclude = yes
IgnoreCase = yes
# Exclude Mozilla-based programs' file caches
- WildDir = "[A-Z]:/Documents and Settings/*/Application
+ WildDir = "[A-Z]:/Documents and Settings/*/Application
Data/*/Profiles/*/*/Cache"
- WildDir = "[A-Z]:/Documents and Settings/*/Application
+ WildDir = "[A-Z]:/Documents and Settings/*/Application
Data/*/Profiles/*/*/Cache.Trash"
WildDir = "[A-Z]:/Documents and Settings/*/Application
Data/*/Profiles/*/*/ImapMail"
File = "D:/"
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Note, the three line of the above Exclude were split to fit on the document
-page, they should be written on a single line in real use.
+page, they should be written on a single line in real use.
\paragraph*{Windows NTFS Naming Considerations}
\index[general]{Windows NTFS Naming Considerations }
If you wish to get an idea of what your FileSet will really backup or if your
exclusion rules will work correctly, you can test it by using the {\bf
-estimate} command in the Console program. See the
-\ilink{estimate}{estimate} in the Console chapter of this
-manual.
+estimate} command in the Console program. See the
+\bsysxrlink{estimate}{estimate}{console}{command} of \consoleman{}.
As an example, suppose you add the following test FileSet:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = Test
Include {
}
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
You could then add some test files to the directory {\bf /home/xxx/test}
and use the following command in the console:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
estimate job=<any-job-name> listing client=<desired-client> fileset=Test
-\end{verbatim}
+\end{lstlisting}
\normalsize
to give you a listing of all files that match. In the above
-example, it should be only files with names ending in \bf{.c}.
+example, it should be only files with names ending in \textbf{.c}.
%%
%%
-\chapter{What is Bacula?}
+\chapter{What is Bacula Enterprise?}
\label{GeneralChapter}
-\index[general]{Bacula!What is }
-\index[general]{What is Bacula? }
+\index[general]{Bacula!What is}
+\index[general]{What is Bacula?}
-Bacula is a set of computer programs that permits the system
+\mbacula{} is a set of computer programs that permits the system
administrator to manage backup, recovery, and verification of computer data
-across a network of computers of different kinds. Bacula can also run entirely
+across a network of computers of different kinds. \mbacula{} can also run entirely
upon a single computer and can backup to various types of media, including tape
and disk.
In technical terms, it is a
-network Client/Server based backup program. Bacula is relatively easy to use
+network Client/Server based backup program. \mbacula{} is relatively easy to use
and efficient, while offering many advanced storage management features that
make it easy to find and recover lost or damaged files. Due to its modular
-design, Bacula is scalable from small single computer systems to systems
-consisting of hundreds of computers located over a large network.
+design, \mbacula{} is scalable from small single computer systems to systems
+consisting of hundreds of computers located over a large network.
\section{Who Needs Bacula?}
-\index[general]{Who Needs Bacula? }
-\index[general]{Bacula!Who Needs }
+\index[general]{Who needs Bacula?}
+\index[general]{Bacula!Who needs}
If you are currently using a program such as tar, dump, or
bru to backup your computer data, and you would like a network solution, more
-flexibility, or catalog services, Bacula will most likely provide the
+flexibility, or catalog services, \mbacula{} will most likely provide the
additional features you want. However, if you are new to Unix systems or do
-not have offsetting experience with a sophisticated backup package, the Bacula project does not
-recommend using Bacula as it is much more difficult to setup and use than
-tar or dump.
+not have offsetting experience with a sophisticated backup package, the \mbacula{}
+ project does not recommend using \mbacula{} as it is much more difficult to setup and use than
+tar or dump.
-If you want Bacula to behave like the above mentioned simple
+If you want \mbacula{} to behave like the above mentioned simple
programs and write over any tape that you put in the drive, then you will find
-working with Bacula difficult. Bacula is designed to protect your data
+working with \mbacula{} difficult. \mbacula{} is designed to protect your data
following the rules you specify, and this means reusing a tape only
-as the last resort. It is possible to "force" Bacula to write
+as the last resort. It is possible to "force" \mbacula{} to write
over any tape in the drive, but it is easier and more efficient to use a
simpler program for that kind of operation.
If you would like a backup program that can write
-to multiple volumes (i.e. is not limited by your tape drive capacity), Bacula
-can most likely fill your needs. In addition, quite a number of Bacula users
-report that Bacula is simpler to setup and use than other equivalent programs.
+to multiple volumes (i.e. is not limited by your tape drive capacity), \mbacula{}
+can most likely fill your needs. In addition, quite a number of \mbacula{} users
+report that \mbacula{} is simpler to setup and use than other equivalent programs.
If you are currently using a sophisticated commercial package such as Legato
Networker. ARCserveIT, Arkeia, or PerfectBackup+, you may be interested in
-Bacula, which provides many of the same features and is free software
-available under the GNU Version 2 software license.
+\mbacula{}, which provides many of the same features and is free software
+available under the GNU Version 2 software license.
\section{Bacula Components or Services}
-\index[general]{Bacula Components or Services }
-\index[general]{Services!Bacula Components or }
+\index[general]{Bacula components or services}
+\index[general]{Services!Bacula components or}
-Bacula is made up of the following five major components or services:
+\mbacula{} is made up of the following five major components or services:
Director, Console, File, Storage, and Monitor services.
-\addcontentsline{lof}{figure}{Bacula Applications}
-\includegraphics{\idir bacula-applications.eps}
-(thanks to Aristedes Maniatis for this graphic and the one below)
+%\addcontentsline{lof}{figure}{Bacula Applications}
+\bsysimageH{bacula-applications}{Bacula Applications}{figgeneral:bacula-applications}
+
+(thanks to Aristedes Maniatis for this graphic and the one below)
% TODO: move the thanks to Credits section in preface
\subsection*{Bacula Director}
with an interactive file restore. It also has most of the capabilities
of the shell console, allows command completion with tabulation, and
gives you instant help about the command you are typing. For more
- details see the \ilink{Bacula Console Design Document}{_ConsoleChapter}.
+ details see the \bsysxrlinkdocument{Bacula Console Design Document}{_ConsoleChapter}{console}{Chapter}.
\subsection*{Bacula File}
\label{FDDef}
The packages for MySQL and PostgreSQL are available for several operating
systems.
Alternatively, installing from the
- source is quite easy, see the \ilink{ Installing and Configuring
+ source is quite easy, see the \ilink{Installing and Configuring
MySQL}{MySqlChapter} chapter of this document for the details. For
more information on MySQL, please see:
- \elink{www.mysql.com}{http://www.mysql.com}. Or see the \ilink{
- Installing and Configuring PostgreSQL}{PostgreSqlChapter} chapter of this
+ \elink{www.mysql.com}{http://www.mysql.com}. Or see the \ilink{Installing
+ and Configuring PostgreSQL}{PostgreSqlChapter} chapter of this
document for the details. For more information on PostgreSQL, please
see: \elink{www.postgresql.org}{http://www.postgresql.org}.
configuring SQLite, please see the \ilink{ Installing and Configuring
SQLite}{SqlLiteChapter} chapter of this document.
-\subsection*{Bacula Monitor}
+\subsection*{Bacula Monitor}
\label{MonDef}
A Bacula Monitor service is the program that allows the
administrator or user to watch current status of Bacula Directors,
Bacula File Daemons and Bacula Storage Daemons.
Currently, only a GTK+ version is available, which works with GNOME,
KDE, or any window manager that supports the FreeDesktop.org system tray
- standard.
+ standard.
To perform a successful save or restore, the following four daemons must be
configured and running: the Director daemon, the File daemon, the Storage
- daemon, and the Catalog service (MySQL, PostgreSQL or SQLite).
+ daemon, and the Catalog service (MySQL, PostgreSQL or SQLite).
\section{Bacula Configuration}
-\index[general]{Configuration!Bacula }
-\index[general]{Bacula Configuration }
+\index[general]{Configuration!Bacula}
+\index[general]{Bacula configuration}
In order for Bacula to understand your system, what clients you want backed
up and how, you must create a number of configuration files containing
-resources (or objects). The following presents an overall picture of this:
+resources (or objects). The following presents an overall picture of this:
-\addcontentsline{lof}{figure}{Bacula Objects}
-\includegraphics{\idir bacula-objects.eps}
+%\addcontentsline{lof}{figure}{Bacula Objects}
+\bsysimageH{bacula-objects}{Bacula Objects}{figgeneral:baculaojects}
+%\includegraphics{\idir bacula-objects}
\section{Conventions Used in this Document}
-\index[general]{Conventions Used in this Document }
-\index[general]{Document!Conventions Used in this }
+\index[general]{Conventions used in this document}
+\index[general]{Document!Conventions used in this}
Bacula is in a state of evolution, and as a consequence, this manual
will not always agree with the code. If an item in this manual is preceded by
an asterisk (*), it indicates that the particular feature is not implemented.
If it is preceded by a plus sign (+), it indicates that the feature may be
-partially implemented.
+partially implemented.
% TODO: search for plus sign and asterisk and "IMPLEMENTED" and fix for printed book
If you are reading this manual as supplied in a released version of the
software, the above paragraph holds true. If you are reading the online
-version of the manual,
+version of the manual,
\elink{ www.bacula.org}{http://www.bacula.org}, please bear in
mind that this version describes the current version in development (in the
CVS) that may contain features not in the released version. Just the same, it
-generally lags behind the code a bit.
+generally lags behind the code a bit.
% TODO: is this still true? there are separate websites
\section{Quick Start}
-\index[general]{Quick Start }
-\index[general]{Start!Quick }
+\index[general]{Quick Start}
+\index[general]{Start!Quick}
To get Bacula up and running quickly, the author recommends
that you first scan the
-Terminology section below, then quickly review the next chapter entitled
-\ilink{The Current State of Bacula}{StateChapter}, then the
+Terminology section below, then quickly review the next chapter entitled
+\ilink{The Current State of Bacula}{StateChapter}, then the
\ilink{Getting Started with Bacula}{QuickStartChapter}, which will
give you a quick overview of getting Bacula running. After which, you should
-proceed to the chapter on
-\ilink{Installing Bacula}{InstallChapter}, then
+proceed to the chapter on
+\ilink{Installing Bacula}{InstallChapter}, then
\ilink{How to Configure Bacula}{ConfigureChapter}, and finally the
-chapter on
-\ilink{ Running Bacula}{TutorialChapter}.
+chapter on
+\ilink{ Running Bacula}{TutorialChapter}.
\section{Terminology}
-\index[general]{Terminology }
+\index[general]{Terminology}
\begin{description}
\item [Administrator]
- \index[fd]{Administrator }
- The person or persons responsible for administrating the Bacula system.
+ \index[fd]{Administrator}
+ The person or persons responsible for administrating the Bacula system.
\item [Backup]
- \index[fd]{Backup }
- The term Backup refers to a Bacula Job that saves files.
+ \index[fd]{Backup}
+ The term Backup refers to a Bacula Job that saves files.
\item [Bootstrap File]
- \index[fd]{Bootstrap File }
+ \index[fd]{Bootstrap file}
The bootstrap file is an ASCII file containing a compact form of
commands that allow Bacula or the stand-alone file extraction utility
(bextract) to restore the contents of one or more Volumes, for
a bootstrap file from a Catalog to extract any file or files you wish.
\item [Catalog]
- \index[fd]{Catalog }
+ \index[fd]{Catalog}
The Catalog is used to store summary information about the Jobs,
Clients, and Files that were backed up and on what Volume or Volumes.
The information saved in the Catalog permits the administrator or user
simple backup and archive programs such as dump and tar.
\item [Client]
- \index[fd]{Client }
+ \index[fd]{Client}
In Bacula's terminology, the word Client refers to the machine being
backed up, and it is synonymous with the File services or File daemon,
and quite often, it is referred to it as the FD. A Client is defined in a
configuration file resource.
\item [Console]
- \index[fd]{Console }
+ \index[fd]{Console}
The program that interfaces to the Director allowing the user or system
- administrator to control Bacula.
+ administrator to control Bacula.
\item [Daemon]
- \index[fd]{Daemon }
+ \index[fd]{Daemon}
Unix terminology for a program that is always present in the background to
carry out a designated task. On Windows systems, as well as some Unix
- systems, daemons are called Services.
+ systems, daemons are called Services.
\item [Directive]
- \index[fd]{Directive }
+ \index[fd]{Directive}
The term directive is used to refer to a statement or a record within a
Resource in a configuration file that defines one specific setting. For
example, the {\bf Name} directive defines the name of the Resource.
\item [Director]
- \index[fd]{Director }
+ \index[fd]{Director}
The main Bacula server daemon that schedules and directs all Bacula
- operations. Occasionally, the project refers to the Director as DIR.
+ operations. Occasionally, the project refers to the Director as DIR.
\item [Differential]
- \index[fd]{Differential }
+ \index[fd]{Differential}
A backup that includes all files changed since the last Full save started.
- Note, other backup programs may define this differently.
+ Note, other backup programs may define this differently.
\item [File Attributes]
- \index[fd]{File Attributes }
+ \index[fd]{File attributes}
The File Attributes are all the information necessary about a file to
identify it and all its properties such as size, creation date, modification
date, permissions, etc. Normally, the attributes are handled entirely by
Bacula so that the user never needs to be concerned about them. The
- attributes do not include the file's data.
+ attributes do not include the file's data.
\item [File Daemon]
- \index[fd]{File Daemon }
+ \index[fd]{File daemon}
The daemon running on the client computer to be backed up. This is also
referred to as the File services, and sometimes as the Client services or the
- FD.
+ FD.
+\phantomsection
\label{FileSetDef}
\item [FileSet]
-\index[fd]{a name }
+\index[fd]{FileSet}
A FileSet is a Resource contained in a configuration file that defines
the files to be backed up. It consists of a list of included files or
directories, a list of excluded files, and how the file is to be stored
chapter of this document.
\item [Incremental]
- \index[fd]{Incremental }
+ \index[fd]{Incremental}
A backup that includes all files changed since the last Full, Differential,
or Incremental backup started. It is normally specified on the {\bf Level}
- directive within the Job resource definition, or in a Schedule resource.
+ directive within the Job resource definition, or in a Schedule resource.
-\label{JobDef}
-\item [Job]
-\index[fd]{a name }
+\phantomsection
+\item [Job]\label{JobDef}
+\index[fd]{Job}
A Bacula Job is a configuration resource that defines the work that
Bacula must perform to backup or restore a particular Client. It
consists of the {\bf Type} (backup, restore, verify, etc), the {\bf
- Level} (full, incremental,...), the {\bf FileSet}, and {\bf Storage} the
+ Level} (full, incremental,\ldots{}), the {\bf FileSet}, and {\bf Storage} the
files are to be backed up (Storage device, Media Pool). For more
details, see the \ilink{Job Resource definition}{JobResource} in the
Director chapter of this document.
% TODO: clean up "..." for book
\item [Monitor]
- \index[fd]{Monitor }
+ \index[fd]{Monitor}
The program that interfaces to all the daemons allowing the user or
- system administrator to monitor Bacula status.
+ system administrator to monitor Bacula status.
\item [Resource]
- \index[fd]{Resource }
+ \index[fd]{Resource}
A resource is a part of a configuration file that defines a specific
unit of information that is available to Bacula. It consists of several
directives (individual configuration statements). For example, the {\bf
Job} resource defines all the properties of a specific Job: name,
- schedule, Volume pool, backup type, backup level, ...
+ schedule, Volume pool, backup type, backup level, \ldots{}
% TODO: clean up "..." for book
\item [Restore]
- \index[fd]{Restore }
+ \index[fd]{Restore}
A restore is a configuration resource that describes the operation of
recovering a file from backup media. It is the inverse of a save,
except that in most cases, a restore will normally have a small set of
% TODO: define "Full"
\item [Schedule]
- \index[fd]{Schedule }
+ \index[fd]{Schedule}
A Schedule is a configuration resource that defines when the Bacula Job
will be scheduled for execution. To use the Schedule, the Job resource
will refer to the name of the Schedule. For more details, see the
chapter of this document.
\item [Service]
- \index[fd]{Service }
+ \index[fd]{Service}
This is a program that remains permanently in memory awaiting
instructions. In Unix environments, services are also known as
- {\bf daemons}.
+ {\bf daemons}.
\item [Storage Coordinates]
- \index[fd]{Storage Coordinates }
+ \index[fd]{Storage coordinates}
The information returned from the Storage Services that uniquely locates
a file on a backup medium. It consists of two parts: one part pertains
to each file saved, and the other part pertains to the whole Job.
location of the information on the backup Volume.
\item [Storage Daemon]
- \index[fd]{Storage Daemon }
+ \index[fd]{Storage daemon}
The Storage daemon, sometimes referred to as the SD, is the code that
writes the attributes and data to a storage Volume (usually a tape or
disk).
\item [Session]
- \index[sd]{Session }
+ \index[sd]{Session}
Normally refers to the internal conversation between the File daemon and
the Storage daemon. The File daemon opens a {\bf session} with the
Storage daemon to save a FileSet or to restore it. A session has a
one-to-one correspondence to a Bacula Job (see above).
\item [Verify]
- \index[sd]{Verify }
+ \index[sd]{Verify}
A verify is a job that compares the current file attributes to the
attributes that have previously been stored in the Bacula Catalog. This
feature can be used for detecting changes to critical system files
original files on disk.
\item [*Archive]
- \index[fd]{*Archive }
+ \index[fd]{Archive}
An Archive operation is done after a Save, and it consists of removing the
Volumes on which data is saved from active use. These Volumes are marked as
Archived, and may no longer be used to save files. All the files contained
- on an Archived Volume are removed from the Catalog. NOT YET IMPLEMENTED.
+ on an Archived Volume are removed from the Catalog. NOT YET IMPLEMENTED.
\item [Retention Period]
- \index[fd]{Retention Period }
+ \index[fd]{Retention period}
There are various kinds of retention periods that Bacula recognizes.
The most important are the {\bf File} Retention Period, {\bf Job}
Retention Period, and the {\bf Volume} Retention Period. Each of these
Period is because the volume of
the database File records use the most storage space in the
database. As a consequence, you must ensure that regular "pruning" of
- the database file records is done to keep your database from growing
+ the database file records is done to keep your database from growing
too large. (See the Console {\bf prune}
command for more details on this subject).
retention periods defined.
\item [Scan]
- \index[sd]{Scan }
+ \index[sd]{Scan}
A Scan operation causes the contents of a Volume or a series of Volumes
to be scanned. These Volumes with the information on which files they
contain are restored to the Bacula Catalog. Once the information is
easily restored. This function is particularly useful if certain
Volumes or Jobs have exceeded their retention period and have been
pruned or purged from the Catalog. Scanning data from Volumes into the
- Catalog is done by using the {\bf bscan} program. See the \ilink{ bscan
- section}{bscan} of the Bacula Utilities Chapter of this manual for more
+ Catalog is done by using the {\bf bscan} program. See the \bsysxrlink{bscan}
+{bscan}{utility}{section} of the \utilityman{} for more
details.
\item [Volume]
- \index[sd]{Volume }
+ \index[sd]{Volume}
A Volume is an archive unit, normally a tape or a named disk file where
Bacula stores the data from one or more backup jobs. All Bacula Volumes
have a software label written to the Volume by Bacula so that it
\end{description}
\section{What Bacula is Not}
-\index[general]{What Bacula is Not}
+\index[general]{What Bacula is not}
Bacula is a backup, restore and verification program and is not a
complete disaster recovery system in itself, but it can be a key part of one
-if you plan carefully and follow the instructions included in the
-\ilink{ Disaster Recovery}{RescueChapter} Chapter of this manual.
+if you plan carefully and follow the instructions included in the
+\ilink{ Disaster Recovery}{RescueChapter} Chapter of this manual.
With proper planning, as mentioned in the Disaster Recovery chapter,
Bacula can be a central component of your disaster recovery system. For
example, if you have created an emergency boot disk, and/or a Bacula Rescue disk to
save the current partitioning information of your hard disk, and maintain a
complete Bacula backup, it is possible to completely recover your system from
-"bare metal" that is starting from an empty disk.
+"bare metal" that is starting from an empty disk.
If you have used the {\bf WriteBootstrap} record in your job or some other
means to save a valid bootstrap file, you will be able to use it to extract
the necessary files (without using the catalog or manually searching for the
-files to restore).
+files to restore).
\section{Interactions Between the Bacula Services}
-\index[general]{Interactions Between the Bacula Services}
-\index[general]{Services!Interactions Between the Bacula}
+\index[general]{Interactions between the Bacula services}
+\index[general]{Services!Interactions between the Bacula}
-The following block diagram shows the typical interactions between the Bacula
+The block diagram \vref{figgeneral:interactions} shows the typical interactions between the Bacula
Services for a backup job. Each block represents in general a separate process
(normally a daemon). In general, the Director oversees the flow of
-information. It also maintains the Catalog.
+information. It also maintains the Catalog.
-\addcontentsline{lof}{figure}{Interactions between Bacula Services}
-\includegraphics{\idir flow.eps}
+%\addcontentsline{lof}{figure}{Interactions between Bacula Services}
+\bsysimageH{flow}{Interactions between Bacula Services}{figgeneral:interactions}
+%includegraphics{\idir flow}
+++ /dev/null
-%%
-%%
-
-\section*{GNU General Public License}
-\label{GplChapter}
-\index[general]{GNU General Public License }
-\index[general]{License!GNU General Public }
-
-\elink{image of a Philosophical
-GNU}{http://www.gnu.org/graphics/philosophicalgnu.html}
-
-\begin{itemize}
-\item
- \elink{What to do if you see a possible GPL
- violation}{http://www.gnu.org/copyleft/gpl-violation.html}
-\item
- \elink{Translations of the
- GPL}{http://www.gnu.org/copyleft/copyleft.html\#translations}
-\end{itemize}
-
-
-\section{Table of Contents}
-\index[general]{Table of Contents }
-\index[general]{Contents!Table of }
-
-\begin{itemize}
-\item
- \label{TOC1}
- \ilink{GNU GENERAL PUBLIC LICENSE}{SEC1}
-
-\begin{itemize}
-\item
- \label{TOC2}
- \ilink{Preamble}{SEC2}
-\item
- \label{TOC3}
- \ilink{TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
-MODIFICATION}{SEC3}
-\item
- \label{TOC4}
- \ilink{How to Apply These Terms to Your New Programs}{SEC4}
-\end{itemize}
-
-\end{itemize}
-
-
-\section{GNU GENERAL PUBLIC LICENSE}
-\label{SEC1}
-\index[general]{GNU GENERAL PUBLIC LICENSE }
-\index[general]{LICENSE!GNU GENERAL PUBLIC }
-
-Version 2, June 1991
-
-\footnotesize
-\begin{verbatim}
-Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-\end{verbatim}
-\normalsize
-
-\section{Preamble}
-\label{SEC2}
-\index[general]{Preamble }
-
-The licenses for most software are designed to take away your freedom to share
-and change it. By contrast, the GNU General Public License is intended to
-guarantee your freedom to share and change free software\verb:--:to make sure the
-software is free for all its users. This General Public License applies to
-most of the Free Software Foundation's software and to any other program whose
-authors commit to using it. (Some other Free Software Foundation software is
-covered by the GNU Library General Public License instead.) You can apply it
-to your programs, too.
-
-When we speak of free software, we are referring to freedom, not price. Our
-General Public Licenses are designed to make sure that you have the freedom to
-distribute copies of free software (and charge for this service if you wish),
-that you receive source code or can get it if you want it, that you can change
-the software or use pieces of it in new free programs; and that you know you
-can do these things.
-
-To protect your rights, we need to make restrictions that forbid anyone to
-deny you these rights or to ask you to surrender the rights. These
-restrictions translate to certain responsibilities for you if you distribute
-copies of the software, or if you modify it.
-
-For example, if you distribute copies of such a program, whether gratis or for
-a fee, you must give the recipients all the rights that you have. You must
-make sure that they, too, receive or can get the source code. And you must
-show them these terms so they know their rights.
-
-We protect your rights with two steps: (1) copyright the software, and (2)
-offer you this license which gives you legal permission to copy, distribute
-and/or modify the software.
-
-Also, for each author's protection and ours, we want to make certain that
-everyone understands that there is no warranty for this free software. If the
-software is modified by someone else and passed on, we want its recipients to
-know that what they have is not the original, so that any problems introduced
-by others will not reflect on the original authors' reputations.
-
-Finally, any free program is threatened constantly by software patents. We
-wish to avoid the danger that redistributors of a free program will
-individually obtain patent licenses, in effect making the program proprietary.
-To prevent this, we have made it clear that any patent must be licensed for
-everyone's free use or not licensed at all.
-
-The precise terms and conditions for copying, distribution and modification
-follow.
-
-\section{TERMS AND CONDITIONS}
-\label{SEC3}
-\index[general]{CONDITIONS!TERMS AND }
-\index[general]{TERMS AND CONDITIONS }
-
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-{\bf 0.} This License applies to any program or other work which contains a
-notice placed by the copyright holder saying it may be distributed under the
-terms of this General Public License. The "Program", below, refers to any
-such program or work, and a "work based on the Program" means either the
-Program or any derivative work under copyright law: that is to say, a work
-containing the Program or a portion of it, either verbatim or with
-modifications and/or translated into another language. (Hereinafter,
-translation is included without limitation in the term "modification".) Each
-licensee is addressed as "you".
-
-Activities other than copying, distribution and modification are not covered
-by this License; they are outside its scope. The act of running the Program is
-not restricted, and the output from the Program is covered only if its
-contents constitute a work based on the Program (independent of having been
-made by running the Program). Whether that is true depends on what the Program
-does.
-
-{\bf 1.} You may copy and distribute verbatim copies of the Program's source
-code as you receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice and
-disclaimer of warranty; keep intact all the notices that refer to this License
-and to the absence of any warranty; and give any other recipients of the
-Program a copy of this License along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and you may
-at your option offer warranty protection in exchange for a fee.
-
-{\bf 2.} You may modify your copy or copies of the Program or any portion of
-it, thus forming a work based on the Program, and copy and distribute such
-modifications or work under the terms of Section 1 above, provided that you
-also meet all of these conditions:
-
-\begin{itemize}
-\item {\bf a)} You must cause the modified files to carry prominent notices
- stating that you changed the files and the date of any change.
-
-\item {\bf b)} You must cause any work that you distribute or publish, that
- in whole or in part contains or is derived from the Program or any part
- thereof, to be licensed as a whole at no charge to all third parties under
- the terms of this License.
-
-\item {\bf c)} If the modified program normally reads commands interactively
- when run, you must cause it, when started running for such interactive use in
- the most ordinary way, to print or display an announcement including an
- appropriate copyright notice and a notice that there is no warranty (or else,
- saying that you provide a warranty) and that users may redistribute the
- program under these conditions, and telling the user how to view a copy of
- this License. (Exception: if the Program itself is interactive but does not
- normally print such an announcement, your work based on the Program is not
- required to print an announcement.)
-\end{itemize}
-
-These requirements apply to the modified work as a whole. If identifiable
-sections of that work are not derived from the Program, and can be reasonably
-considered independent and separate works in themselves, then this License,
-and its terms, do not apply to those sections when you distribute them as
-separate works. But when you distribute the same sections as part of a whole
-which is a work based on the Program, the distribution of the whole must be on
-the terms of this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest your
-rights to work written entirely by you; rather, the intent is to exercise the
-right to control the distribution of derivative or collective works based on
-the Program.
-
-In addition, mere aggregation of another work not based on the Program with
-the Program (or with a work based on the Program) on a volume of a storage or
-distribution medium does not bring the other work under the scope of this
-License.
-
-{\bf 3.} You may copy and distribute the Program (or a work based on it, under
-Section 2) in object code or executable form under the terms of Sections 1 and
-2 above provided that you also do one of the following:
-
-\begin{itemize}
-\item {\bf a)} Accompany it with the complete corresponding machine-readable
- source code, which must be distributed under the terms of Sections 1 and 2
- above on a medium customarily used for software interchange; or,
-
-\item {\bf b)} Accompany it with a written offer, valid for at least three
- years, to give any third party, for a charge no more than your cost of
- physically performing source distribution, a complete machine-readable copy of
- the corresponding source code, to be distributed under the terms of Sections
- 1 and 2 above on a medium customarily used for software interchange; or,
-
-\item {\bf c)} Accompany it with the information you received as to the offer
- to distribute corresponding source code. (This alternative is allowed only
- for noncommercial distribution and only if you received the program in object
- code or executable form with such an offer, in accord with Subsection b
- above.)
-\end{itemize}
-
-The source code for a work means the preferred form of the work for making
-modifications to it. For an executable work, complete source code means all
-the source code for all modules it contains, plus any associated interface
-definition files, plus the scripts used to control compilation and
-installation of the executable. However, as a special exception, the source
-code distributed need not include anything that is normally distributed (in
-either source or binary form) with the major components (compiler, kernel, and
-so on) of the operating system on which the executable runs, unless that
-component itself accompanies the executable.
-
-If distribution of executable or object code is made by offering access to
-copy from a designated place, then offering equivalent access to copy the
-source code from the same place counts as distribution of the source code,
-even though third parties are not compelled to copy the source along with the
-object code.
-
-{\bf 4.} You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License. Any attempt otherwise to
-copy, modify, sublicense or distribute the Program is void, and will
-automatically terminate your rights under this License. However, parties who
-have received copies, or rights, from you under this License will not have
-their licenses terminated so long as such parties remain in full compliance.
-
-{\bf 5.} You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or distribute
-the Program or its derivative works. These actions are prohibited by law if
-you do not accept this License. Therefore, by modifying or distributing the
-Program (or any work based on the Program), you indicate your acceptance of
-this License to do so, and all its terms and conditions for copying,
-distributing or modifying the Program or works based on it.
-
-{\bf 6.} Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the original
-licensor to copy, distribute or modify the Program subject to these terms and
-conditions. You may not impose any further restrictions on the recipients'
-exercise of the rights granted herein. You are not responsible for enforcing
-compliance by third parties to this License.
-
-{\bf 7.} If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or otherwise)
-that contradict the conditions of this License, they do not excuse you from
-the conditions of this License. If you cannot distribute so as to satisfy
-simultaneously your obligations under this License and any other pertinent
-obligations, then as a consequence you may not distribute the Program at all.
-For example, if a patent license would not permit royalty-free redistribution
-of the Program by all those who receive copies directly or indirectly through
-you, then the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply and
-the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any patents or
-other property right claims or to contest validity of any such claims; this
-section has the sole purpose of protecting the integrity of the free software
-distribution system, which is implemented by public license practices. Many
-people have made generous contributions to the wide range of software
-distributed through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing to
-distribute software through any other system and a licensee cannot impose that
-choice.
-
-This section is intended to make thoroughly clear what is believed to be a
-consequence of the rest of this License.
-
-{\bf 8.} If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the original
-copyright holder who places the Program under this License may add an explicit
-geographical distribution limitation excluding those countries, so that
-distribution is permitted only in or among countries not thus excluded. In
-such case, this License incorporates the limitation as if written in the body
-of this License.
-
-{\bf 9.} The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time. Such new versions will be
-similar in spirit to the present version, but may differ in detail to address
-new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program
-specifies a version number of this License which applies to it and "any later
-version", you have the option of following the terms and conditions either of
-that version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of this License,
-you may choose any version ever published by the Free Software Foundation.
-
-{\bf 10.} If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author to
-ask for permission. For software which is copyrighted by the Free Software
-Foundation, write to the Free Software Foundation; we sometimes make
-exceptions for this. Our decision will be guided by the two goals of
-preserving the free status of all derivatives of our free software and of
-promoting the sharing and reuse of software generally.
-
-{\bf NO WARRANTY}
-
-{\bf 11.} BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE
-THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
-IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
-THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
-PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
-CORRECTION.
-
-{\bf 12.} IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
-LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
-THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
-END OF TERMS AND CONDITIONS
-
-\section{How to Apply These Terms to Your New Programs}
-\label{SEC4}
-\index[general]{Programs!How to Apply These Terms to Your New }
-\index[general]{How to Apply These Terms to Your New Programs }
-
-If you develop a new program, and you want it to be of the greatest possible
-use to the public, the best way to achieve this is to make it free software
-which everyone can redistribute and change under these terms.
-
-To do so, attach the following notices to the program. It is safest to attach
-them to the start of each source file to most effectively convey the exclusion
-of warranty; and each file should have at least the "copyright" line and a
-pointer to where the full notice is found.
-
-\footnotesize
-\begin{verbatim}
-{\em one line to give the program's name and an idea of what it does.}
-Copyright (C) {\em yyyy} {\em name of author}
-This program is free software; you can redistribute it and/or
-modify it under the terms of the GNU General Public License
-as published by the Free Software Foundation; either version 2
-of the License, or (at your option) any later version.
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-02110-1301 USA
-\end{verbatim}
-\normalsize
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this when it
-starts in an interactive mode:
-
-\footnotesize
-\begin{verbatim}
-Gnomovision version 69, Copyright (C) {\em year} {\em name of author}
-Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
-type `show w'. This is free software, and you are welcome
-to redistribute it under certain conditions; type `show c'
-for details.
-\end{verbatim}
-\normalsize
-
-The hypothetical commands {\tt `show w'} and {\tt `show c'} should show the
-appropriate parts of the General Public License. Of course, the commands you
-use may be called something other than {\tt `show w'} and {\tt `show c'}; they
-could even be mouse-clicks or menu items\verb:--:whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary. Here is a sample; alter the names:
-
-\footnotesize
-\begin{verbatim}
-Yoyodyne, Inc., hereby disclaims all copyright
-interest in the program `Gnomovision'
-(which makes passes at compilers) written
-by James Hacker.
-{\em signature of Ty Coon}, 1 April 1989
-Ty Coon, President of Vice
-\end{verbatim}
-\normalsize
-
-This General Public License does not permit incorporating your program into
-proprietary programs. If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library. If this is what you want to do, use the GNU Library General Public
-License instead of this License.
-Return to
-\elink{GNU's home page}{http://www.gnu.org/home.html}.
-
-FSF \& GNU inquiries \& questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}. Other
-\elink{ways to contact}{http://www.gnu.org/home.html\#ContactInfo} the FSF.
-
-Comments on these web pages to
-\elink{webmasters@www.gnu.org}{mailto:webmasters@www.gnu.org}, send other
-questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}.
-
-Copyright notice above.
-Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
-Boston, MA 02110-1301 USA
-
-Updated: 3 Jan 2000 rms
--- /dev/null
+../../licences/gpl.tex
\ No newline at end of file
the Windows client (File daemon) on a Windows machine.
This client will also run on 64 bit Windows machines, but
VSS support is not available if you are running a 64 bit
- version of Windows. This installer installs only the FD,
+ version of Windows. This installer installs only the FD,
the Director and Storage daemon are not included.
\end{description}
-\label{upgrading1}
-\section{Upgrading Bacula}
+
+\section{Upgrading Bacula}\label{upgrading1}
\index[general]{Bacula!Upgrading}
\index[general]{Upgrading Bacula}
\index[general]{Upgrading}
With version 3.0.0 and later, you {\bf must} ensure that on any one
machine that all components of Bacula are running on exactly the
-same version. Prior to version 3.0.0, it was possible to run a
+same version. Prior to version 3.0.0, it was possible to run a
lower level FD with a newer Director and SD. This is no longer the
-case.
+case.
As always, we attempt to support older File daemons. This avoids the
need to do a simultaneous upgrade of many machines. For exactly what
-older versions of the FD are supported, please see the ReleaseNotes
+older versions of the FD are supported, please see the ReleaseNotes
for the new version. In any case, you must always upgrade both the
Director and the Storage daemon at the same time, and you must also
upgrade any File daemon that is running on the same machine as a Director
Upgrading the catalog is normally done after Bacula is build and installed
by:
-\begin{verbatim}
+\begin{lstlisting}
cd <installed-scripts-dir> (default /etc/bacula)
./update_bacula_tables
-\end{verbatim}
+\end{lstlisting}
This update script can also be find in the Bacula source src/cats
directory.
protocol will change. However, within any particular release (e.g. version
1.32.x) unless there is an oversight or bug, the daemon protocol will not
change. If this is confusing, simply read the ReleaseNotes very carefully as
-they will note if all daemons must be upgraded at the same time.
+they will note if all daemons must be upgraded at the same time.
Finally, please note that in general it is not necessary or desirable
to do a {\bf make uninstall} before doing an upgrade providing you are careful
-not to change the installation directories. In fact, if you do so, you will
+not to change the installation directories. In fact, if you do so, you will
most likely delete all your conf files, which could be disastrous.
The normal procedure during an upgrade is simply:
-\begin{verbatim}
+\begin{lstlisting}
./configure (your options)
make
make install
-\end{verbatim}
+\end{lstlisting}
In general none of your existing .conf or .sql files will be overwritten,
and you must do both the {\bf make} and {\bf make install} commands, a
{\bf make install} without the preceding {\bf make} will not work.
-
-For additional information on upgrading, please see the \ilink{Upgrading Bacula
-Versions}{upgrading} in the Tips chapter of this manual.
+
+For additional information on upgrading, please see the \bsysxrlink{Upgrading Bacula Versions}{upgrading}{problems}{section} of the \problemsman{}.
\section{Releases Numbering}
\index[general]{Release Numbering}
\index[general]{Version Numbering}
-Every Bacula release whether beta or production has a different number
+Every Bacula release whether beta or production has a different number
as well as the date of the release build. The numbering system follows
traditional Open Source conventions in that it is of the form.
-\begin{verbatim}
+\begin{lstlisting}
major.minor.release
-\end{verbatim}
+\end{lstlisting}
For example:
-\begin{verbatim}
+\begin{lstlisting}
1.38.11
-\end{verbatim}
+\end{lstlisting}
where each component (major, minor, patch) is a number.
The major number is currently 1 and normally does not change
the current Bacula version is 1.38.11, versions 1.38.0, 1.38.1, ... 1.38.10
have all been previously released.
-When the minor number is odd, it indicates that the package is under
-development and thus may not be stable. For example, while the current
+When the minor number is odd, it indicates that the package is under
+development and thus may not be stable. For example, while the current
production release of Bacula is currently 1.38.11, the current development
-version is 1.39.22. All patch versions of the development code are
+version is 1.39.22. All patch versions of the development code are
available in the SVN (source repository). However, not all patch versions
of the development code (odd minor version) are officially released. When
they are released, they are released as beta versions (see below for a
-definition of what beta means for Bacula releases).
+definition of what beta means for Bacula releases).
In general when the minor number increases from one production release
to the next (i.e. 1.38.x to 1.40.0), the catalog database must be upgraded,
\index[general]{Beta Releases}
Towards the end of the development cycle, which typically runs
one year from a major release to another, there will be several beta
-releases of the development code prior to a production release.
+releases of the development code prior to a production release.
As noted above, beta versions always have odd minor version numbers
-(e.g 1.37.x or 1.39.x).
+(e.g 1.37.x or 1.39.x).
The purpose of the beta releases is to allow early adopter users to test
the new code. Beta releases are made with the following considerations:
-\begin{itemize}
+\begin{bsysitemize}
\item The code passes the regression testing on FreeBSD, Linux, and Solaris
machines.
-\item There are no known major bugs, or on the rare occasion that
+\item There are no known major bugs, or on the rare occasion that
there are, they will be documented or already in the bugs database.
\item Some of the new code/features may not yet be tested.
\item Beta code is not generally recommended for everyone, but
rather for early adopters.
-\end{itemize}
+\end{bsysitemize}
\label{Dependency}
As discussed above, we have combined a number of third party packages that
Bacula might need into the {\bf depkgs} release. You can,
-of course, get the latest packages from the original authors or
+of course, get the latest packages from the original authors or
from your operating system supplier. The locations of
where we obtained the packages are in the README file in each package.
However, be aware that the packages in the depkgs files have been tested by us
-for compatibility with Bacula.
+for compatibility with Bacula.
Typically, a dependency package will be named {\bf depkgs-ddMMMyy.tar.gz}
where {\bf dd} is the day we release it, {\bf MMM}
is the abbreviated month (e.g. Jan), and {\bf yy} is the year. An actual
example is: {\bf depkgs-18Dec.tar.gz}. To install and build this package (if
-needed), you do the following:
+needed), you do the following:
\begin{enumerate}
\item Create a {\bf bacula} directory, into which you will place both the
- Bacula source as well as the dependency package.
-\item Detar the {\bf depkgs} into the {\bf bacula} directory.
-\item cd bacula/depkgs
-\item make
+ Bacula source as well as the dependency package.
+\item Detar the {\bf depkgs} into the {\bf bacula} directory.
+\item cd bacula/depkgs
+\item make
\end{enumerate}
Although the exact composition of the dependency packages may change from time
-to time, the current makeup is the following:
-
-\addcontentsline{lot}{table}{Dependency Packages}
-\begin{longtable}{|l|l|l|}
- \hline
-\multicolumn{1}{|c| }{\bf 3rd Party Package} & \multicolumn{1}{c| }{\bf depkgs}
- & \multicolumn{1}{c| }{\bf depkgs-qt} \\
- \hline {SQLite3 } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ }\\
- \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ } \\
- \hline {qt4 } & \multicolumn{1}{c| }{ } & \multicolumn{1}{c| }{X } \\
- \hline
-\end{longtable}
+to time, the current makeup is the following:
+%\addcontentsline{lot}{table}{Dependency Packages}
+\LTXtable{0.95\linewidth}{table_dependencies}
Note, some of these packages are quite large, so that building them can be a
bit time consuming. The above instructions will build all the packages
contained in the directory. However, when building Bacula, it will take only
-those pieces that it actually needs.
+those pieces that it actually needs.
-Alternatively, you can make just the packages that are needed. For example,
+Alternatively, you can make just the packages that are needed. For example,
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cd bacula/depkgs
make sqlite
-\end{verbatim}
+\end{lstlisting}
\normalsize
-will configure and build only the SQLite package.
+will configure and build only the SQLite package.
-You should build the packages that you will require in {\bf depkgs} a
+You should build the packages that you will require in {\bf depkgs} a
prior to configuring and building Bacula, since Bacula will need
-them during the build process.
+them during the build process.
-Note, the {\bf depkgs-qt} package is required for building bat, because
+Note, the {\bf depkgs-qt} package is required for building bat, because
bat is currently built with Qt version 4.3.4. It can be built with other
Qt versions, but that almost always creates problems or introduces
instabilities.
You can build the depkgs-qt with the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cd bacula
tar xfvz depkgs-qt-28Jul09.tar.gz
cd depkgs-qt
make qt4
source qt4-path
-\end{verbatim}
+\end{lstlisting}
\normalsize
Doing the {\bf source qt4-path} defines the following environment
variables:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
QTDIR
QTLIB
QTINC
-\end{verbatim}
+\end{lstlisting}
\normalsize
Each one should point to a specific location in the depkgs-qt package
that you loaded. It also puts the depkgs-qt/qt4/bin directory
on your path before all other directories. This ensures that
-the bat build will use your Qt 4.3.4 library rather than any that
+the bat build will use your Qt 4.3.4 library rather than any that
might be on your system.
Before running your Bacula build, please make sure that
file before attempting to rebuild the bat part of Bacula.
For more information on the {\bf depkgs-qt} package, please read the
-INSTALL file in the main directory of that package. If you are going to
+INSTALL file in the main directory of that package. If you are going to
build Qt4 using {\bf depkgs-qt}, you must source the {\bf qt4-paths} file
included in the package prior to building Bacula. Please read the INSTALL
file for more details.
Even if you do not use SQLite, you might find it worthwhile to build {\bf mtx}
because the {\bf tapeinfo} program that comes with it can often provide you
with valuable information about your SCSI tape drive (e.g. compression,
-min/max block sizes, ...). Note, most distros provide {\bf mtx} as part of
+min/max block sizes, ...). Note, most distros provide {\bf mtx} as part of
their release.
The {\bf depkgs1} package is depreciated and previously contained
readline, which should be available on all operating systems.
-The {\bf depkgs-win32} package is deprecated and no longer used in
+The {\bf depkgs-win32} package is deprecated and no longer used in
Bacula version 1.39.x and later. It was previously used to build
the native Win32 client program, but this program is now built on Linux
systems using cross-compiling. All the tools and third party libraries
\index[general]{Systems!Supported Operating}
\index[general]{Supported Operating Systems}
-Please see the
+Please see the
\ilink{ Supported Operating Systems}{SupportedOSes} section
-of the QuickStart chapter of this manual.
+of the QuickStart chapter of this manual.
\section{Building Bacula from Source}
\label{Building}
\index[general]{Source!Building Bacula from}
\index[general]{Building Bacula from Source}
-The basic installation is rather simple.
+The basic installation is rather simple.
\begin{enumerate}
\item Install and build any {\bf depkgs} as noted above. This
should be unnecessary on most modern Operating Systems.
-\item Configure and install MySQL or PostgreSQL (if desired).
- \ilink{Installing and Configuring MySQL Phase I}{MySqlChapter} or
+\item Configure and install MySQL or PostgreSQL (if desired).
+ \ilink{Installing and Configuring MySQL Phase I}{MySqlChapter} or
\ilink{Installing and Configuring PostgreSQL Phase
I}{PostgreSqlChapter}. If you are installing from rpms, and are
using MySQL, please be sure to install {\bf mysql-devel}, so that the MySQL
libz.a} or {\bf libz.so}. If you are using rpm packages, these libraries are
in the {\bf libz-devel} package. On Debian systems, you will need to load the
{\bf zlib1g-dev} package. If you are not using rpms or debs, you will need to
- find the appropriate package for your system.
+ find the appropriate package for your system.
- Note, if you already have a running MySQL or PostgreSQL on your system, you
+ Note, if you already have a running MySQL or PostgreSQL on your system, you
can skip this phase provided that you have built the thread safe libraries.
- And you have already installed the additional rpms noted above.
+ And you have already installed the additional rpms noted above.
SQLite is not supported on Solaris. This is because it
frequently fails with bus errors. However SQLite3 may work.
\item Detar the Bacula source code preferably into the {\bf bacula} directory
- discussed above.
+ discussed above.
-\item {\bf cd} to the directory containing the source code.
+\item {\bf cd} to the directory containing the source code.
\item ./configure (with appropriate options as described below). Any
path names you specify as options on the ./configure command line
binaries and Install config directories. If they are not correct,
please rerun ./configure until they are. The output from ./configure is
stored in {\bf config.out} and can be re-displayed at any time without
- rerunning the ./configure by doing {\bf cat config.out}.
+ rerunning the ./configure by doing {\bf cat config.out}.
\item If after running ./configure once, you decide to change options and
- re-run it, that is perfectly fine, but before re-running it, you should run:
+ re-run it, that is perfectly fine, but before re-running it, you should run:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
make distclean
-\end{verbatim}
+\end{lstlisting}
\normalsize
so that you are sure to start from scratch and not have a mixture of the two
options. This is because ./configure caches much of the information. The {\bf
-make distclean} is also critical if you move the source directory from one
+make distclean} is also critical if you move the source directory from one
machine to another. If the {\bf make distclean} fails, just ignore it and
-continue on.
+continue on.
-\item make
+\item make
If you get errors while linking in the Storage daemon directory
(src/stored), it is probably because you have not loaded the static
libraries on your system. I noticed this problem on a Solaris system.
fail because Bacula requires a {\bf make} before a {\bf make install}.
2. you are depriving yourself of the chance to make sure there are no
errors before beginning to write files to your system directories.
-
-\item make install
+
+\item make install
Please be sure you have done a {\bf make} before entering this command,
and that everything has properly compiled and linked without errors.
example program in the next chapter, then come back and modify your
configuration files to suit your particular needs.
-\item Customize the configuration files for each of the three daemons
+\item Customize the configuration files for each of the three daemons
(Directory, File, Storage) and for the Console program. For the details
of how to do this, please see \ilink{Setting Up Bacula Configuration
Files}{ConfigureChapter} in the Configuration chapter of this manual. We
can be done after you have Bacula up and running. Please take care when
modifying passwords, which were randomly generated, and the {\bf Name}s
as the passwords and names must agree between the configuration files
- for security reasons.
+ for security reasons.
\label{CreateDatabase}
\item Create the Bacula MySQL database and tables
(if using MySQL)
- \ilink{Installing and Configuring MySQL Phase II}{mysql_phase2} or
- create the Bacula PostgreSQL database and tables
+ \ilink{Installing and Configuring MySQL Phase II}{mysql_phase2} or
+ create the Bacula PostgreSQL database and tables
\ilink{Configuring PostgreSQL
II}{PostgreSQL_configure} or alternatively if you are using
- SQLite \ilink{Installing and Configuring SQLite Phase II}{phase2}.
+ SQLite \ilink{Installing and Configuring SQLite Phase II}{phase2}.
\item Start Bacula ({\bf ./bacula start}) Note. the next chapter shows you
- how to do this in detail.
+ how to do this in detail.
-\item Interface with Bacula using the Console program
+\item Interface with Bacula using the Console program
-\item For the previous two items, please follow the instructions in the
+\item For the previous two items, please follow the instructions in the
\ilink{Running Bacula}{TutorialChapter} chapter of this manual,
where you will run a simple backup and do a restore. Do this before you make
heavy modifications to the configuration files so that you are sure that
- Bacula works and are familiar with it. After that changing the conf files
- will be easier.
+ Bacula works and are familiar with it. After that changing the conf files
+ will be easier.
\item If after installing Bacula, you decide to "move it", that is to
- install it in a different set of directories, proceed as follows:
+ install it in a different set of directories, proceed as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
make uninstall
make distclean
./configure (your-new-options)
make
make install
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
\end{enumerate}
If all goes well, the {\bf ./configure} will correctly determine which
operating system you are running and configure the source code appropriately.
Currently, FreeBSD, Linux (Red Hat), and Solaris are supported. The Bacula
-client (File daemon) is reported to work with MacOS X 10.3 is if
-readline support is not enabled (default) when building the client.
+client (File daemon) is reported to work with MacOS X 10.3 is if
+readline support is not enabled (default) when building the client.
If you install Bacula on more than one system, and they are identical, you can
simply transfer the source tree to that other system and do a "make
install". However, if there are differences in the libraries or OS versions,
or you wish to install on a different OS, you should start from the original
compress tar file. If you do transfer the source tree, and you have previously
-done a ./configure command, you MUST do:
+done a ./configure command, you MUST do:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
make distclean
-\end{verbatim}
+\end{lstlisting}
\normalsize
prior to doing your new ./configure. This is because the GNU autoconf tools
cache the configuration, and if you re-use a configuration for a Linux machine
on a Solaris, you can be sure your build will fail. To avoid this, as
-mentioned above, either start from the tar file, or do a "make distclean".
+mentioned above, either start from the tar file, or do a "make distclean".
In general, you will probably want to supply a more complicated {\bf
configure} statement to ensure that the modules you want are built and that
-everything is placed into the correct directories.
+everything is placed into the correct directories.
-For example, on Fedora, Red Hat, or SuSE one could use the following:
+For example, on Fedora, Red Hat, or SuSE one could use the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
CFLAGS="-g -Wall" \
./configure \
--sbindir=$HOME/bacula/bin \
--with-mysql \
--with-working-dir=$HOME/bacula/bin/working \
--with-dump-email=$USER
-\end{verbatim}
+\end{lstlisting}
\normalsize
The advantage of using the above configuration to start is that
everything will be put into a single directory, which you can later delete
once you have run the examples in the next chapter and learned how Bacula
-works. In addition, the above can be installed and run as non-root.
+works. In addition, the above can be installed and run as non-root.
For the developer's convenience, I have added a {\bf defaultconfig} script to
the {\bf examples} directory. This script contains the statements that you
would normally use, and each developer/user may modify them to suit his needs.
-You should find additional useful examples in this directory as well.
+You should find additional useful examples in this directory as well.
The {\bf \verb:--:enable-conio} or {\bf \verb:--:enable-readline} options are
useful because they provide a command line history, editing capability for the
error message such as:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
/usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld:
cannot find -ltermcap
collect2: ld returned 1 exit status
-\end{verbatim}
+\end{lstlisting}
\normalsize
while building the Bacula Console. In that case, you will need to set the {\bf
-LDFLAGS} environment variable prior to building.
+LDFLAGS} environment variable prior to building.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
export LDFLAGS="-L/usr/lib/termcap"
-\end{verbatim}
+\end{lstlisting}
\normalsize
The same library requirements apply if you wish to use the readline subroutines
alternatively, you can include them directly on the ./configure line as in:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
LDFLAGS="-lssl -lcyrpto" \
./configure <your-options>
-\end{verbatim}
+\end{lstlisting}
\normalsize
On some systems such as Mandriva, readline tends to
the disable option, or if you are using version 1.33 and above try using {\bf
\verb:--:enable-conio} to use a built-in readline replacement. You will still need
either the termcap or the ncurses library, but it is unlikely that the {\bf conio}
-package will gobble up prompts.
+package will gobble up prompts.
readline is no longer supported after version 1.34. The code within Bacula
remains, so it should be usable, and if users submit patches for it, we will
the Director). It's possible to switch from MySQL/SQLite to PostgreSQL, but it
requires some DBA knowledge.
-If you wish to use SQLite as the Bacula catalog, please see
+If you wish to use SQLite as the Bacula catalog, please see
\ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
this manual. SQLite is not supported on Solaris.
There are a number of options and important considerations given below
that you can skip for the moment if you have not had any problems building
-Bacula with a simplified configuration as shown above.
-
-If the ./configure process is unable to find specific libraries (e.g.
+Bacula with a simplified configuration as shown above.
+
+If the ./configure process is unable to find specific libraries (e.g.
libintl, you should ensure that the appropriate package is installed on
your system. Alternatively, if the package is installed in a non-standard
location (as far as Bacula is concerned), then there is generally an
option listed below (or listed with "./configure {-} {-}help" that will
permit you to specify the directory that should be searched. In other
-cases, there are options that will permit you to disable to feature
+cases, there are options that will permit you to disable to feature
(e.g. {-} {-}disable-nls).
If you want to dive right into it, we recommend you skip to the next chapter,
and run the example program. It will teach you a lot about Bacula and as an
example can be installed into a single directory (for easy removal) and run as
non-root. If you have any problems or when you want to do a real installation,
-come back to this chapter and read the details presented below.
+come back to this chapter and read the details presented below.
\section{Configure Options}
\label{Options}
\index[general]{Configure Options}
The following command line options are available for {\bf configure} to
-customize your installation.
+customize your installation.
\begin{description}
\item [ \--prefix=\lt{}patch\gt{}]
\item [ {-}{\-}sbindir=\lt{}binary-path\gt{}]
\index[general]{{-}{\-}sbindir}
Defines where the Bacula binary (executable) files will be placed during a
- {\bf make install} command.
+ {\bf make install} command.
\item [ {-}{\-}sysconfdir=\lt{}config-path\gt{}]
\index[general]{{-}{\-}sysconfdir}
For the install to succeed you must have {\bf gzip} installed
on your system.
- By default, Bacula will install the Unix man pages in
- /usr/share/man/man1 and /usr/share/man/man8.
+ By default, Bacula will install the Unix man pages in
+ /usr/share/man/man1 and /usr/share/man/man8.
If you wish the man page to be installed in
a different location, use this option to specify the path.
Note, the main HTML and PDF Bacula documents are in a separate
Bacula, you must specify this option. Doing so will build everything in
the {\bf src/qt-console} directory. The build with enable-bat will work
only with a full Bacula build (i.e. it will not work with a client-only
- build).
+ build).
Qt4 is available on OpenSUSE 10.2, CentOS 5, Fedora, and Debian. If it
is not available on your system, you can download the {\bf depkgs-qt}
(change the path to point to your particular installed libpq.a;
these commands were issued on FreeBSD 6.2):
-\begin{verbatim}
+\begin{lstlisting}
$ nm /usr/local/lib/libpq.a | grep PQputCopyData
00001b08 T PQputCopyData
$ nm /usr/local/lib/libpq.a | grep mutex
U pthread_mutex_init
U pthread_mutex_lock
U pthread_mutex_unlock
-\end{verbatim}
+\end{lstlisting}
The above example shows a libpq that contains the required function
PQputCopyData and is thread enabled (i.e. the pthread\_mutex* entries).
Bacula always links to the thread safe MySQL libraries.
Running with Batch Insert turned on is recommended because it can
- significantly improve attribute insertion times. However, it does
+ significantly improve attribute insertion times. However, it does
put a significantly larger part of the work on your SQL engine, so
- you may need to pay more attention to tuning it. In particular,
+ you may need to pay more attention to tuning it. In particular,
Batch Insert can require large temporary table space, and consequently,
the default location (often /tmp) may run out of space causing errors.
For MySQL, the location is set in my.conf with "tmpdir". You may also
environment or a window manager compatible with the FreeDesktop system
tray standard (like KDE and GNOME) and you want to use a GUI to monitor
Bacula daemons, you must specify this option. Doing so will build
- everything in the {\bf src/tray-monitor} directory. Note, due to
+ everything in the {\bf src/tray-monitor} directory. Note, due to
restrictions on what can be linked with GPLed code, we were forced to
remove the egg code that dealt with the tray icons and replace it by
calls to the GTK+ API, and unfortunately, the tray icon API necessary
from with in the {\bf src/filed} directory. Also, the {\bf
\verb:--:enable-client-only} option described below is useful for just
building a client so that all the other parts of the program are not
- compiled.
-
+ compiled.
+
When linking a static binary, the linker needs the static versions
- of all the libraries that are used, so frequently users will
- experience linking errors when this option is used. The first
- thing to do is to make sure you have the static glibc library
+ of all the libraries that are used, so frequently users will
+ experience linking errors when this option is used. The first
+ thing to do is to make sure you have the static glibc library
installed on your system. The second thing to do is the make sure
you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
on your ./configure statement as these options require additional
Metal recovery.
When linking a static binary, the linker needs the static versions
- of all the libraries that are used, so frequently users will
- experience linking errors when this option is used. The first
- thing to do is to make sure you have the static glibc library
+ of all the libraries that are used, so frequently users will
+ experience linking errors when this option is used. The first
+ thing to do is to make sure you have the static glibc library
installed on your system. The second thing to do is the make sure
you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
on your ./configure statement as these options require additional
recovery.
When linking a static binary, the linker needs the static versions
- of all the libraries that are used, so frequently users will
- experience linking errors when this option is used. The first
- thing to do is to make sure you have the static glibc library
+ of all the libraries that are used, so frequently users will
+ experience linking errors when this option is used. The first
+ thing to do is to make sure you have the static glibc library
installed on your system. The second thing to do is the make sure
you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
on your ./configure statement as these options require additional
recovery.
When linking a static binary, the linker needs the static versions
- of all the libraries that are used, so frequently users will
- experience linking errors when this option is used. The first
- thing to do is to make sure you have the static glibc library
+ of all the libraries that are used, so frequently users will
+ experience linking errors when this option is used. The first
+ thing to do is to make sure you have the static glibc library
installed on your system. The second thing to do is the make sure
you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
on your ./configure statement as these options require additional
greatly facilitates building a Client on a client only machine.
When linking a static binary, the linker needs the static versions
- of all the libraries that are used, so frequently users will
- experience linking errors when this option is used. The first
- thing to do is to make sure you have the static glibc library
+ of all the libraries that are used, so frequently users will
+ experience linking errors when this option is used. The first
+ thing to do is to make sure you have the static glibc library
installed on your system. The second thing to do is the make sure
you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
on your ./configure statement as these options require additional
\item [ {-}{\-}enable-largefile]
\index[general]{{-}{\-}enable-largefile}
This option (default) causes Bacula to be built with 64 bit file address
- support if it is available on your system. This permits Bacula to read and
+ support if it is available on your system. This permits Bacula to read and
write files greater than 2 GBytes in size. You may disable this feature and
- revert to 32 bit file addresses by using {\bf \verb:--:disable-largefile}.
+ revert to 32 bit file addresses by using {\bf \verb:--:disable-largefile}.
\item [ {-}{\-}disable-nls]
\index[general]{{-}{\-}disable-nls}
By default, Bacula uses the GNU Native Language Support (NLS) libraries. On
- some machines, these libraries may not be present or may not function
+ some machines, these libraries may not be present or may not function
correctly (especially on non-Linux implementations). In such cases, you
may specify {\bf {-}{\-}disable-nls} to disable use of those libraries.
In such a case, Bacula will revert to using English.
\item [ {-}{\-}with-openssl=\lt{}path\gt{}]
This configuration option is necessary if you want to enable TLS (ssl),
- which encrypts the communications within
+ which encrypts the communications within
Bacula or if you want to use File Daemon PKI data encryption.
Normally, the {\bf path} specification is not necessary since
the configuration searches for the OpenSSL libraries in standard system
For more information on using PKI data encryption, please see the
\ilink{Bacula PKI -- Data Encryption}{DataEncryption}
chapter of this manual.
-
+
If you get errors linking, you need to load the development libraries,
or you need to disable SSL by setting without-openssl.
configure will search the standard library locations for Python 2.2,
2.3, 2.4, or 2.5. If it cannot find the library, you will need to
supply a path to your Python library directory. Please see the
- \ilink{Python chapter}{PythonChapter} for the details of using Python
+ \bsysxrlink{Python Scripting}
+ {PythonChapter}{misc}{chapter} of the \miscman{} for the details of using Python
scripting.
\item [ {-}{\-}with-libintl-prefix=\lt{}DIR\gt{}]
\index[general]{{-}{\-}enable-readline}
Tells Bacula to enable readline support. It is normally disabled due to the
large number of configuration problems and the fact that the package seems to
- change in incompatible ways from version to version.
+ change in incompatible ways from version to version.
\item [ {-}{\-}with-tcp-wrappers=\lt{}path\gt{}]
\index[general]{{-}{\-}with-tcp-wrappers}
or {\bf /etc/hosts.deny}, you must identify the Bacula daemon in
question with the name you give it in your conf file rather than the
name of the executable.
-
- For more information on configuring and testing TCP wrappers, please see the
+
+ For more information on configuring and testing TCP wrappers, please see the
\ilink{Configuring and Testing TCP Wrappers}{wrappers} section
- in the Security Chapter.
+ in the Security Chapter.
On SuSE, the libwrappers libraries needed to link Bacula are
contained in the tcpd-devel package. On Red Hat, the package is named
\item [ {-}{\-}with-working-dir=\lt{}working-directory-path\gt{} ]
\index[general]{{-}{\-}with-working-dir}
This option is mandatory and specifies a directory into which Bacula may
- safely place files that will remain between Bacula executions. For example,
+ safely place files that will remain between Bacula executions. For example,
if the internal database is used, Bacula will keep those files in this
directory. This option is only used to modify the daemon configuration
files. You may also accomplish the same thing by directly editing them later.
The working directory is not automatically created by the install process, so
- you must ensure that it exists before using Bacula for the first time.
+ you must ensure that it exists before using Bacula for the first time.
\item [ {-}{\-}with-baseport=\lt{}port=number\gt{}]
\index[general]{{-}{\-}with-baseport}
- In order to run, Bacula needs three TCP/IP ports (one for the Bacula
+ In order to run, Bacula needs three TCP/IP ports (one for the Bacula
Console, one for the Storage daemon, and one for the File daemon). The {\bf
\verb:--:with-baseport} option will automatically assign three ports beginning at
the base port address specified. You may also change the port number in the
resulting configuration files. However, you need to take care that the
- numbers correspond correctly in each of the three daemon configuration
+ numbers correspond correctly in each of the three daemon configuration
files. The default base port is 9101, which assigns ports 9101 through 9103.
These ports (9101, 9102, and 9103) have been officially assigned to Bacula by
IANA. This option is only used to modify the daemon configuration files. You
- may also accomplish the same thing by directly editing them later.
+ may also accomplish the same thing by directly editing them later.
\item [ {-}{\-}with-dump-email=\lt{}email-address\gt{}]
\index[general]{{-}{\-}with-dump-email}
This option specifies the email address where any core dumps should be set.
- This option is normally only used by developers.
+ This option is normally only used by developers.
\item [ {-}{\-}with-pid-dir=\lt{}PATH\gt{} ]
\index[general]{{-}{\-}with-pid-dir}
This specifies where Bacula should place the process id file during
execution. The default is: {\bf /var/run}. This directory is not created by
the install process, so you must ensure that it exists before using Bacula
- the first time.
+ the first time.
\item [ {-}{\-}with-subsys-dir=\lt{}PATH\gt{}]
\index[general]{{-}{\-}with-subsys-dir}
not specify the same directory for this directory and for the {\bf sbindir}
directory. This directory is used only within the autostart scripts. The
subsys directory is not created by the Bacula install, so you must be sure to
- create it before using Bacula.
+ create it before using Bacula.
\item [ {-}{\-}with-dir-password=\lt{}Password\gt{}]
\index[general]{{-}{\-}with-dir-password}
This option allows you to specify the password used to access the Director
(normally from the Console program). If it is not specified, configure will
- automatically create a random password.
+ automatically create a random password.
\item [ {-}{\-}with-fd-password=\lt{}Password\gt{} ]
\index[general]{{-}{\-}with-fd-password}
This option allows you to specify the password used to access the File daemon
(normally called from the Director). If it is not specified, configure will
- automatically create a random password.
+ automatically create a random password.
\item [ {-}{\-}with-sd-password=\lt{}Password\gt{} ]
\index[general]{{-}{\-}with-sd-password}
This option allows you to specify the password used to access the Storage daemon
(normally called from the Director). If it is not specified, configure will
- automatically create a random password.
+ automatically create a random password.
\item [ {-}{\-}with-dir-user=\lt{}User\gt{} ]
\index[general]{{-}{\-}with-dir-user}
This option allows you to specify the Userid used to run the Director. The
Director must be started as root, but doesn't need to run as root, and
after doing preliminary initializations, it can "drop" to the UserId
- specified on this option.
+ specified on this option.
If you specify this option, you must
create the User prior to running {\bf make install}, because the
working directory owner will be set to {\bf User}.
-
+
\item [ {-}{\-}with-dir-group=\lt{}Group\gt{} ]
\index[general]{{-}{\-}with-dir-group}
This option allows you to specify the GroupId used to run the Director. The
Director must be started as root, but doesn't need to run as root, and after
doing preliminary initializations, it can "drop" to the GroupId specified
- on this option.
+ on this option.
If you specify this option, you must
create the Group prior to running {\bf make install}, because the
working directory group will be set to {\bf Group}.
and after doing preliminary initializations, it can "drop" to the UserId
specified on this option. If you use this option, you will need to take care
that the Storage daemon has access to all the devices (tape drives, ...) that
- it needs.
+ it needs.
\item [ {-}{\-}with-sd-group=\lt{}Group\gt{} ]
\index[general]{{-}{\-}with-sd-group}
This option allows you to specify the GroupId used to run the Storage daemon.
The Storage daemon must be started as root, but doesn't need to run as root,
and after doing preliminary initializations, it can "drop" to the GroupId
- specified on this option.
+ specified on this option.
\item [ {-}{\-}with-fd-user=\lt{}User\gt{} ]
\index[general]{{-}{\-}with-fd-user}
File daemon must be started as root, and in most cases, it needs to run as
root, so this option is used only in very special cases, after doing
preliminary initializations, it can "drop" to the UserId specified on this
- option.
+ option.
\item [ {-}{\-}with-fd-group=\lt{}Group\gt{} ]
\index[general]{{-}{\-}with-fd-group}
This option allows you to specify the GroupId used to run the File daemon.
The File daemon must be started as root, and in most cases, it must be run as
root, however, after doing preliminary initializations, it can "drop" to
- the GroupId specified on this option.
+ the GroupId specified on this option.
\item [ {-}{\-}with-mon-dir-password=\lt{}Password\gt{}]
\index[general]{{-}{\-}with-mon-dir-password}
This option allows you to specify the password used to access the Directory
from the monitor. If it is not specified, configure will
- automatically create a random password.
+ automatically create a random password.
\item [ {-}{\-}with-mon-fd-password=\lt{}Password\gt{} ]
\index[general]{{-}{\-}with-mon-fd-password}
This option allows you to specify the password used to access the File daemon
from the Monitor. If it is not specified, configure will
- automatically create a random password.
+ automatically create a random password.
\item [ {-}{\-}with-mon-sd-password=\lt{}Password\gt{} ]
\index[general]{{-}{\-}with-mon-sd-password}
This option allows you to specify the password used to access the
Storage daemon from the Monitor. If it is not specified, configure will
- automatically create a random password.
+ automatically create a random password.
\item [ {-}{\-}with-db-name=\lt{}database-name\gt{} ]
\index[general]{{-}{\-}with-db-name}
\index[general]{Systems!Recommended Options for Most}
\index[general]{Recommended Options for Most Systems}
-For most systems, we recommend starting with the following options:
+For most systems, we recommend starting with the following options:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
./configure \
--enable-smartalloc \
--sbindir=$HOME/bacula/bin \
--with-subsys-dir=$HOME/bacula/bin/working \
--with-mysql=$HOME/mysql \
--with-working-dir=$HOME/bacula/working
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you want to install Bacula in an installation directory rather than run it
\section{Red Hat}
\index[general]{Red Hat}
-Using SQLite:
+Using SQLite:
\footnotesize
-\begin{verbatim}
-
+\begin{lstlisting}
+
CFLAGS="-g -Wall" ./configure \
--sbindir=$HOME/bacula/bin \
--sysconfdir=$HOME/bacula/bin \
--with-subsys-dir=$HOME/bacula/bin/working \
--enable-bat \
--enable-conio
-\end{verbatim}
+\end{lstlisting}
\normalsize
-or
+or
\footnotesize
-\begin{verbatim}
-
+\begin{lstlisting}
+
CFLAGS="-g -Wall" ./configure \
--sbindir=$HOME/bacula/bin \
--sysconfdir=$HOME/bacula/bin \
--with-pid-dir=$HOME/bacula/bin/working \
--with-subsys-dir=$HOME/bacula/bin/working
--enable-conio
-\end{verbatim}
+\end{lstlisting}
\normalsize
-or finally, a completely traditional Red Hat Linux install:
+or finally, a completely traditional Red Hat Linux install:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
CFLAGS="-g -Wall" ./configure \
--sbindir=/usr/sbin \
--sysconfdir=/etc/bacula \
--with-working-dir=/var/bacula \
--with-pid-dir=/var/run \
--enable-conio
-\end{verbatim}
+\end{lstlisting}
\normalsize
Note, Bacula assumes that /var/bacula, /var/run, and /var/lock/subsys exist so
-it will not automatically create them during the install process.
+it will not automatically create them during the install process.
\section{Solaris}
\index[general]{Solaris}
To build Bacula from source, you will need the following installed on your
system (they are not by default): libiconv, gcc 3.3.2, stdc++, libgcc (for
-stdc++ and gcc\_s libraries), make 3.8 or later.
+stdc++ and gcc\_s libraries), make 3.8 or later.
You will probably also need to: Add /usr/local/bin to PATH and Add
-/usr/ccs/bin to PATH for ar.
+/usr/ccs/bin to PATH for ar.
It is possible to build Bacula on Solaris with the Solaris compiler, but
-we recommend using GNU C++ if possible.
+we recommend using GNU C++ if possible.
A typical configuration command might look like:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#!/bin/sh
CFLAGS="-g" ./configure \
--sbindir=$HOME/bacula/bin \
--with-pid-dir=$HOME/bacula/bin/working \
--with-subsys-dir=$HOME/bacula/bin/working \
--with-working-dir=$HOME/bacula/working
-\end{verbatim}
+\end{lstlisting}
\normalsize
As mentioned above, the install process will create the sbindir and sysconfdir
Note, you may need to install the following packages to build Bacula
from source:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
SUNWbinutils,
SUNWarc,
SUNWhea,
SUNWGmakeS
SUNWlibm
-export
+export
PATH=/usr/bin::/usr/ccs/bin:/etc:/usr/openwin/bin:/usr/local/bin:/usr/sfw/bin:/opt/sfw/bin:/usr/ucb:/usr/sbin
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you have installed special software not normally in the Solaris
simplest way to do so is to run:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
setenv LDFLAGS "-L/usr/sfw/lib -R/usr/sfw/lib"
-\end{verbatim}
+\end{lstlisting}
\normalsize
Prior to running the ./configure command.
\section{FreeBSD}
\index[general]{FreeBSD}
-Please see:
+Please see:
\elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} for a
detailed description on how to make Bacula work on your system. In addition,
users of FreeBSD prior to 4.9-STABLE dated Mon Dec 29 15:18:01 2003 UTC who
-plan to use tape devices, please see the
-\ilink{Tape Testing Chapter}{FreeBSDTapes} of this manual for
+plan to use tape devices, please see the
+\bsysxrlink{Tape Testing}{FreeBSDTapes}{problems}{section} of \problemsman{} for
{\bf important} information on how to configure your tape drive for
-compatibility with Bacula.
+compatibility with \mbacula{}.
If you are using Bacula with MySQL, you should take care to compile MySQL with
FreeBSD native threads rather than LinuxThreads, since Bacula is normally built
with FreeBSD native threads rather than LinuxTreads. Mixing the two will
-probably not work.
+probably not work.
\section{Win32}
\index[general]{Win32}
-To install the binary Win32 version of the File daemon please see the
-\ilink{Win32 Installation Chapter}{Win32Chapter} in this document.
+To install the binary Win32 version of the File daemon please see the
+\ilink{Win32 Installation Chapter}{Win32Chapter} in this document.
\section{One File Configure Script}
\index[general]{Script!One File Configure}
in a single file:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#!/bin/sh
CFLAGS="-g -Wall" \
./configure \
--with-job-email=$USER@your-site.com \
--with-smtp-host=mail.your-site.com
exit 0
-\end{verbatim}
+\end{lstlisting}
\normalsize
You may also want to put the following entries in your {\bf /etc/services}
file as it will make viewing the connections made by Bacula easier to
-recognize (i.e. netstat -a):
+recognize (i.e. netstat -a):
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
bacula-dir 9101/tcp
bacula-fd 9102/tcp
bacula-sd 9103/tcp
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{Installing Bacula}
\index[general]{Installing Bacula}
Before setting up your configuration files, you will want to install Bacula in
-its final location. Simply enter:
+its final location. Simply enter:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
make install
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you have previously installed Bacula, the old binaries will be overwritten,
but the old configuration files will remain unchanged, and the "new"
configuration files will be appended with a {\bf .new}. Generally if you have
previously installed and run Bacula you will want to discard or ignore the
-configuration files with the appended {\bf .new}.
+configuration files with the appended {\bf .new}.
\section{Building a File Daemon or Client}
\index[general]{Client!Building a File Daemon or}
copy the Bacula File daemon binary file {\bf bacula-fd} as well as its
configuration file {\bf bacula-fd.conf} then modify the name and password in
the conf file to be unique. Be sure to make corresponding additions to the
-Director's configuration file ({\bf bacula-dir.conf}).
+Director's configuration file ({\bf bacula-dir.conf}).
If the architecture or the OS level are different, you will need to build a
File daemon on the Client machine. To do so, you can use the same {\bf
./configure} command as you did for your main program, starting either from a
fresh copy of the source tree, or using {\bf make\ distclean} before the {\bf
-./configure}.
+./configure}.
Since the File daemon does not access the Catalog database, you can remove
the {\bf \verb:--:with-mysql} or {\bf \verb:--:with-sqlite} options, then
system is booted (a good idea), one more step is necessary. First, the
./configure process must recognize your system -- that is it must be a
supported platform and not {\bf unknown}, then you must install the platform
-dependent files by doing:
+dependent files by doing:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
(become root)
make install-autostart
-\end{verbatim}
+\end{lstlisting}
\normalsize
Please note, that the auto-start feature is implemented only on systems
/etc/rc.d/init.d/bacula-fd}, and {\bf /etc/rc.d/init.d/bacula-sd}. However
the exact location depends on what operating system you are using.
-If you only wish to install the File daemon, you may do so with:
+If you only wish to install the File daemon, you may do so with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
make install-autostart-fd
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{Other Make Notes}
\index[general]{Notes!Other Make}
\index[general]{Other Make Notes}
-To simply build a new executable in any directory, enter:
+To simply build a new executable in any directory, enter:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
make
-\end{verbatim}
+\end{lstlisting}
\normalsize
To clean out all the objects and binaries (including the files named 1, 2, or
-3, which are development temporary files), enter:
+3, which are development temporary files), enter:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
make clean
-\end{verbatim}
+\end{lstlisting}
\normalsize
-To really clean out everything for distribution, enter:
+To really clean out everything for distribution, enter:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
make distclean
-\end{verbatim}
+\end{lstlisting}
\normalsize
note, this cleans out the Makefiles and is normally done from the top level
directory to prepare for distribution of the source. To recover from this
state, you must redo the {\bf ./configure} in the top level directory, since
-all the Makefiles will be deleted.
+all the Makefiles will be deleted.
To add a new file in a subdirectory, edit the Makefile.in in that directory,
then simply do a {\bf make}. In most cases, the make will rebuild the Makefile
from the new Makefile.in. In some case, you may need to issue the {\bf make} a
second time. In extreme cases, cd to the top level directory and enter: {\bf
-make Makefiles}.
+make Makefiles}.
-To add dependencies:
+To add dependencies:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
make depend
-\end{verbatim}
+\end{lstlisting}
\normalsize
The {\bf make depend} appends the header file dependencies for each of the
object files to Makefile and Makefile.in. This command should be done in each
directory where you change the dependencies. Normally, it only needs to be run
when you add or delete source or header files. {\bf make depend} is normally
-automatically invoked during the configuration process.
+automatically invoked during the configuration process.
-To install:
+To install:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
make install
-\end{verbatim}
+\end{lstlisting}
\normalsize
This not normally done if you are developing Bacula, but is used if you are
-going to run it to backup your system.
+going to run it to backup your system.
After doing a {\bf make install} the following files will be installed on your
system (more or less). The exact files and location (directory) for each file
starting point.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
bacula
bacula-dir
bacula-dir.conf
bwx-console
bwx-console.conf
9 man pages
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{monitor}
{\bf bacula-tray-monitor} as your user, and see if a cassette icon appears
somewhere on the screen, usually on the task bar.
If it doesn't, follow the instructions below related to your environment or
-window manager.
+window manager.
\subsection{GNOME}
\index[general]{GNOME}
System tray, or notification area if you use the GNOME terminology, has been
supported in GNOME since version 2.2. To activate it, right-click on one of
your panels, open the menu {\bf Add to this Panel}, then {\bf Utility} and
-finally click on {\bf Notification Area}.
+finally click on {\bf Notification Area}.
\subsection{KDE}
\index[general]{KDE}
System tray has been supported in KDE since version 3.1. To activate it,
right-click on one of your panels, open the menu {\bf Add}, then {\bf Applet}
-and finally click on {\bf System Tray}.
+and finally click on {\bf System Tray}.
\subsection{Other window managers}
\index[general]{Managers!Other window}
\index[general]{Other window managers}
Read the documentation to know if the Freedesktop system tray standard is
-supported by your window manager, and if applicable, how to activate it.
+supported by your window manager, and if applicable, how to activate it.
\section{Modifying the Bacula Configuration Files}
\index[general]{Modifying the Bacula Configuration Files}
\index[general]{Files!Modifying the Bacula Configuration}
-See the chapter
+See the chapter
\ilink{Configuring Bacula}{ConfigureChapter} in this manual for
-instructions on how to set Bacula configuration files.
+instructions on how to set Bacula configuration files.
+++ /dev/null
-%%
-%%
-
-\section*{GNU Lesser General Public License}
-\label{LesserChapter}
-\index[general]{GNU Lesser General Public License }
-\index[general]{License!GNU Lesser General Public }
-
-\elink{image of a Philosophical GNU}
-{http://www.gnu.org/graphics/philosophicalgnu.html} [
-\elink{English}{http://www.gnu.org/copyleft/lesser.html} |
-\elink{Japanese}{http://www.gnu.org/copyleft/lesser.ja.html} ]
-
-\begin{itemize}
-\item
- \elink{Why you shouldn't use the Lesser GPL for your next
- library}{http://www.gnu.org/philosophy/why-not-lgpl.html}
-\item
- \elink{What to do if you see a possible LGPL
- violation}{http://www.gnu.org/copyleft/gpl-violation.html}
-\item
- \elink{Translations of the LGPL}
-{http://www.gnu.org/copyleft/copyleft.html\#translationsLGPL}
-\item The GNU Lesser General Public License as a
- \elink{text file}{http://www.gnu.org/copyleft/lesser.txt}
-\item The GNU Lesser General Public License as a
- \elink{Texinfo}{http://www.gnu.org/copyleft/lesser.texi} file
- \end{itemize}
-
-
-This GNU Lesser General Public License counts as the successor of the GNU
-Library General Public License. For an explanation of why this change was
-necessary, read the
-\elink{Why you shouldn't use the Lesser GPL for your next
-library}{http://www.gnu.org/philosophy/why-not-lgpl.html} article.
-
-\section{Table of Contents}
-\index[general]{Table of Contents }
-\index[general]{Contents!Table of }
-
-\begin{itemize}
-\item
- \label{TOC12}
- \ilink{GNU LESSER GENERAL PUBLIC LICENSE}{SEC12}
-
-\begin{itemize}
-\item
- \label{TOC23}
- \ilink{Preamble}{SEC23}
-\item
- \label{TOC34}
- \ilink{TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
-MODIFICATION}{SEC34}
-\item
- \label{TOC45}
- \ilink{How to Apply These Terms to Your New Libraries}{SEC45}
-\end{itemize}
-
-\end{itemize}
-
-
-\section{GNU LESSER GENERAL PUBLIC LICENSE}
-\label{SEC12}
-\index[general]{LICENSE!GNU LESSER GENERAL PUBLIC }
-\index[general]{GNU LESSER GENERAL PUBLIC LICENSE }
-
-Version 2.1, February 1999
-
-\footnotesize
-\begin{verbatim}
-Copyright (C) 1991, 1999 Free Software Foundation, Inc.
-51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-[This is the first released version of the Lesser GPL. It also counts
- as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
-\end{verbatim}
-\normalsize
-
-\section{Preamble}
-\label{SEC23}
-\index[general]{Preamble }
-
-The licenses for most software are designed to take away your freedom to share
-and change it. By contrast, the GNU General Public Licenses are intended to
-guarantee your freedom to share and change free software\verb:--:to make sure the
-software is free for all its users.
-
-This license, the Lesser General Public License, applies to some specially
-designated software packages\verb:--:typically libraries\verb:--:of the Free Software
-Foundation and other authors who decide to use it. You can use it too, but we
-suggest you first think carefully about whether this license or the ordinary
-General Public License is the better strategy to use in any particular case,
-based on the explanations below.
-
-When we speak of free software, we are referring to freedom of use, not price.
-Our General Public Licenses are designed to make sure that you have the
-freedom to distribute copies of free software (and charge for this service if
-you wish); that you receive source code or can get it if you want it; that you
-can change the software and use pieces of it in new free programs; and that
-you are informed that you can do these things.
-
-To protect your rights, we need to make restrictions that forbid distributors
-to deny you these rights or to ask you to surrender these rights. These
-restrictions translate to certain responsibilities for you if you distribute
-copies of the library or if you modify it.
-
-For example, if you distribute copies of the library, whether gratis or for a
-fee, you must give the recipients all the rights that we gave you. You must
-make sure that they, too, receive or can get the source code. If you link
-other code with the library, you must provide complete object files to the
-recipients, so that they can relink them with the library after making changes
-to the library and recompiling it. And you must show them these terms so they
-know their rights.
-
-We protect your rights with a two-step method: (1) we copyright the library,
-and (2) we offer you this license, which gives you legal permission to copy,
-distribute and/or modify the library.
-
-To protect each distributor, we want to make it very clear that there is no
-warranty for the free library. Also, if the library is modified by someone
-else and passed on, the recipients should know that what they have is not the
-original version, so that the original author's reputation will not be
-affected by problems that might be introduced by others.
-
-Finally, software patents pose a constant threat to the existence of any free
-program. We wish to make sure that a company cannot effectively restrict the
-users of a free program by obtaining a restrictive license from a patent
-holder. Therefore, we insist that any patent license obtained for a version of
-the library must be consistent with the full freedom of use specified in this
-license.
-
-Most GNU software, including some libraries, is covered by the ordinary GNU
-General Public License. This license, the GNU Lesser General Public License,
-applies to certain designated libraries, and is quite different from the
-ordinary General Public License. We use this license for certain libraries in
-order to permit linking those libraries into non-free programs.
-
-When a program is linked with a library, whether statically or using a shared
-library, the combination of the two is legally speaking a combined work, a
-derivative of the original library. The ordinary General Public License
-therefore permits such linking only if the entire combination fits its
-criteria of freedom. The Lesser General Public License permits more lax
-criteria for linking other code with the library.
-
-We call this license the "Lesser" General Public License because it does
-Less to protect the user's freedom than the ordinary General Public License.
-It also provides other free software developers Less of an advantage over
-competing non-free programs. These disadvantages are the reason we use the
-ordinary General Public License for many libraries. However, the Lesser
-license provides advantages in certain special circumstances.
-
-For example, on rare occasions, there may be a special need to encourage the
-widest possible use of a certain library, so that it becomes a de-facto
-standard. To achieve this, non-free programs must be allowed to use the
-library. A more frequent case is that a free library does the same job as
-widely used non-free libraries. In this case, there is little to gain by
-limiting the free library to free software only, so we use the Lesser General
-Public License.
-
-In other cases, permission to use a particular library in non-free programs
-enables a greater number of people to use a large body of free software. For
-example, permission to use the GNU C Library in non-free programs enables many
-more people to use the whole GNU operating system, as well as its variant, the
-GNU/Linux operating system.
-
-Although the Lesser General Public License is Less protective of the users'
-freedom, it does ensure that the user of a program that is linked with the
-Library has the freedom and the wherewithal to run that program using a
-modified version of the Library.
-
-The precise terms and conditions for copying, distribution and modification
-follow. Pay close attention to the difference between a "work based on the
-library" and a "work that uses the library". The former contains code
-derived from the library, whereas the latter must be combined with the library
-in order to run.
-
-\section{TERMS AND CONDITIONS}
-\label{SEC34}
-\index[general]{CONDITIONS!TERMS AND }
-\index[general]{TERMS AND CONDITIONS }
-
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-{\bf 0.} This License Agreement applies to any software library or other
-program which contains a notice placed by the copyright holder or other
-authorized party saying it may be distributed under the terms of this Lesser
-General Public License (also called "this License"). Each licensee is
-addressed as "you".
-
-A "library" means a collection of software functions and/or data prepared so
-as to be conveniently linked with application programs (which use some of
-those functions and data) to form executables.
-
-The "Library", below, refers to any such software library or work which has
-been distributed under these terms. A "work based on the Library" means
-either the Library or any derivative work under copyright law: that is to say,
-a work containing the Library or a portion of it, either verbatim or with
-modifications and/or translated straightforwardly into another language.
-(Hereinafter, translation is included without limitation in the term
-"modification".)
-
-"Source code" for a work means the preferred form of the work for making
-modifications to it. For a library, complete source code means all the source
-code for all modules it contains, plus any associated interface definition
-files, plus the scripts used to control compilation and installation of the
-library.
-
-Activities other than copying, distribution and modification are not covered
-by this License; they are outside its scope. The act of running a program
-using the Library is not restricted, and output from such a program is covered
-only if its contents constitute a work based on the Library (independent of
-the use of the Library in a tool for writing it). Whether that is true depends
-on what the Library does and what the program that uses the Library does.
-
-{\bf 1.} You may copy and distribute verbatim copies of the Library's complete
-source code as you receive it, in any medium, provided that you conspicuously
-and appropriately publish on each copy an appropriate copyright notice and
-disclaimer of warranty; keep intact all the notices that refer to this License
-and to the absence of any warranty; and distribute a copy of this License
-along with the Library.
-
-You may charge a fee for the physical act of transferring a copy, and you may
-at your option offer warranty protection in exchange for a fee.
-
-{\bf 2.} You may modify your copy or copies of the Library or any portion of
-it, thus forming a work based on the Library, and copy and distribute such
-modifications or work under the terms of Section 1 above, provided that you
-also meet all of these conditions:
-
-\begin{itemize}
-\item {\bf a)} The modified work must itself be a software library.
-\item {\bf b)} You must cause the files modified to carry prominent notices
- stating that you changed the files and the date of any change.
-\item {\bf c)} You must cause the whole of the work to be licensed at no
- charge to all third parties under the terms of this License.
-\item {\bf d)} If a facility in the modified Library refers to a function or
- a table of data to be supplied by an application program that uses the
- facility, other than as an argument passed when the facility is invoked, then
-you must make a good faith effort to ensure that, in the event an application
-does not supply such function or table, the facility still operates, and
-performs whatever part of its purpose remains meaningful.
-
-(For example, a function in a library to compute square roots has a purpose
-that is entirely well-defined independent of the application. Therefore,
-Subsection 2d requires that any application-supplied function or table used
-by this function must be optional: if the application does not supply it, the
-square root function must still compute square roots.)
-
-These requirements apply to the modified work as a whole. If identifiable
-sections of that work are not derived from the Library, and can be reasonably
-considered independent and separate works in themselves, then this License,
-and its terms, do not apply to those sections when you distribute them as
-separate works. But when you distribute the same sections as part of a whole
-which is a work based on the Library, the distribution of the whole must be
-on the terms of this License, whose permissions for other licensees extend to
-the entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest your
-rights to work written entirely by you; rather, the intent is to exercise the
-right to control the distribution of derivative or collective works based on
-the Library.
-
-In addition, mere aggregation of another work not based on the Library with
-the Library (or with a work based on the Library) on a volume of a storage or
-distribution medium does not bring the other work under the scope of this
-License.
-\end{itemize}
-
-{\bf 3.} You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library. To do this,
-you must alter all the notices that refer to this License, so that they refer
-to the ordinary GNU General Public License, version 2, instead of to this
-License. (If a newer version than version 2 of the ordinary GNU General Public
-License has appeared, then you can specify that version instead if you wish.)
-Do not make any other change in these notices.
-
-Once this change is made in a given copy, it is irreversible for that copy, so
-the ordinary GNU General Public License applies to all subsequent copies and
-derivative works made from that copy.
-
-This option is useful when you wish to copy part of the code of the Library
-into a program that is not a library.
-
-{\bf 4.} You may copy and distribute the Library (or a portion or derivative
-of it, under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you accompany it with the complete
-corresponding machine-readable source code, which must be distributed under
-the terms of Sections 1 and 2 above on a medium customarily used for software
-interchange.
-
-If distribution of object code is made by offering access to copy from a
-designated place, then offering equivalent access to copy the source code from
-the same place satisfies the requirement to distribute the source code, even
-though third parties are not compelled to copy the source along with the
-object code.
-
-{\bf 5.} A program that contains no derivative of any portion of the Library,
-but is designed to work with the Library by being compiled or linked with it,
-is called a "work that uses the Library". Such a work, in isolation, is not
-a derivative work of the Library, and therefore falls outside the scope of
-this License.
-
-However, linking a "work that uses the Library" with the Library creates an
-executable that is a derivative of the Library (because it contains portions
-of the Library), rather than a "work that uses the library". The executable
-is therefore covered by this License. Section 6 states terms for distribution
-of such executables.
-
-When a "work that uses the Library" uses material from a header file that is
-part of the Library, the object code for the work may be a derivative work of
-the Library even though the source code is not. Whether this is true is
-especially significant if the work can be linked without the Library, or if
-the work is itself a library. The threshold for this to be true is not
-precisely defined by law.
-
-If such an object file uses only numerical parameters, data structure layouts
-and accessors, and small macros and small inline functions (ten lines or less
-in length), then the use of the object file is unrestricted, regardless of
-whether it is legally a derivative work. (Executables containing this object
-code plus portions of the Library will still fall under Section 6.)
-
-Otherwise, if the work is a derivative of the Library, you may distribute the
-object code for the work under the terms of Section 6. Any executables
-containing that work also fall under Section 6, whether or not they are linked
-directly with the Library itself.
-
-{\bf 6.} As an exception to the Sections above, you may also combine or link a
-"work that uses the Library" with the Library to produce a work containing
-portions of the Library, and distribute that work under terms of your choice,
-provided that the terms permit modification of the work for the customer's own
-use and reverse engineering for debugging such modifications.
-
-You must give prominent notice with each copy of the work that the Library is
-used in it and that the Library and its use are covered by this License. You
-must supply a copy of this License. If the work during execution displays
-copyright notices, you must include the copyright notice for the Library among
-them, as well as a reference directing the user to the copy of this License.
-Also, you must do one of these things:
-
-\begin{itemize}
-\item {\bf a)} Accompany the work with the complete corresponding
- machine-readable source code for the Library including whatever changes were
- used in the work (which must be distributed under Sections 1 and 2 above);
-and, if the work is an executable linked with the Library, with the complete
-machine-readable "work that uses the Library", as object code and/or source
-code, so that the user can modify the Library and then relink to produce a
-modified executable containing the modified Library. (It is understood that
-the user who changes the contents of definitions files in the Library will
-not necessarily be able to recompile the application to use the modified
-definitions.)
-\item {\bf b)} Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (1) uses at run time a copy of the
- library already present on the user's computer system, rather than copying
-library functions into the executable, and (2) will operate properly with a
-modified version of the library, if the user installs one, as long as the
-modified version is interface-compatible with the version that the work was
-made with.
-\item {\bf c)} Accompany the work with a written offer, valid for at least
- three years, to give the same user the materials specified in Subsection 6a,
- above, for a charge no more than the cost of performing this distribution.
-\item {\bf d)} If distribution of the work is made by offering access to copy
- from a designated place, offer equivalent access to copy the above specified
- materials from the same place.
-\item {\bf e)} Verify that the user has already received a copy of these
- materials or that you have already sent this user a copy.
- \end{itemize}
-
-For an executable, the required form of the "work that uses the Library"
-must include any data and utility programs needed for reproducing the
-executable from it. However, as a special exception, the materials to be
-distributed need not include anything that is normally distributed (in either
-source or binary form) with the major components (compiler, kernel, and so on)
-of the operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-It may happen that this requirement contradicts the license restrictions of
-other proprietary libraries that do not normally accompany the operating
-system. Such a contradiction means you cannot use both them and the Library
-together in an executable that you distribute.
-
-{\bf 7.} You may place library facilities that are a work based on the Library
-side-by-side in a single library together with other library facilities not
-covered by this License, and distribute such a combined library, provided that
-the separate distribution of the work based on the Library and of the other
-library facilities is otherwise permitted, and provided that you do these two
-things:
-
-\begin{itemize}
-\item {\bf a)} Accompany the combined library with a copy of the same work
- based on the Library, uncombined with any other library facilities. This must
- be distributed under the terms of the Sections above.
-\item {\bf b)} Give prominent notice with the combined library of the fact
- that part of it is a work based on the Library, and explaining where to find
- the accompanying uncombined form of the same work.
-\end{itemize}
-
-{\bf 8.} You may not copy, modify, sublicense, link with, or distribute the
-Library except as expressly provided under this License. Any attempt otherwise
-to copy, modify, sublicense, link with, or distribute the Library is void, and
-will automatically terminate your rights under this License. However, parties
-who have received copies, or rights, from you under this License will not have
-their licenses terminated so long as such parties remain in full compliance.
-
-{\bf 9.} You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or distribute
-the Library or its derivative works. These actions are prohibited by law if
-you do not accept this License. Therefore, by modifying or distributing the
-Library (or any work based on the Library), you indicate your acceptance of
-this License to do so, and all its terms and conditions for copying,
-distributing or modifying the Library or works based on it.
-
-{\bf 10.} Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the original
-licensor to copy, distribute, link with or modify the Library subject to these
-terms and conditions. You may not impose any further restrictions on the
-recipients' exercise of the rights granted herein. You are not responsible for
-enforcing compliance by third parties with this License.
-
-{\bf 11.} If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or otherwise)
-that contradict the conditions of this License, they do not excuse you from
-the conditions of this License. If you cannot distribute so as to satisfy
-simultaneously your obligations under this License and any other pertinent
-obligations, then as a consequence you may not distribute the Library at all.
-For example, if a patent license would not permit royalty-free redistribution
-of the Library by all those who receive copies directly or indirectly through
-you, then the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Library.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply, and
-the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any patents or
-other property right claims or to contest validity of any such claims; this
-section has the sole purpose of protecting the integrity of the free software
-distribution system which is implemented by public license practices. Many
-people have made generous contributions to the wide range of software
-distributed through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing to
-distribute software through any other system and a licensee cannot impose that
-choice.
-
-This section is intended to make thoroughly clear what is believed to be a
-consequence of the rest of this License.
-
-{\bf 12.} If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the original
-copyright holder who places the Library under this License may add an explicit
-geographical distribution limitation excluding those countries, so that
-distribution is permitted only in or among countries not thus excluded. In
-such case, this License incorporates the limitation as if written in the body
-of this License.
-
-{\bf 13.} The Free Software Foundation may publish revised and/or new versions
-of the Lesser General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Library
-specifies a version number of this License which applies to it and "any later
-version", you have the option of following the terms and conditions either of
-that version or of any later version published by the Free Software
-Foundation. If the Library does not specify a license version number, you may
-choose any version ever published by the Free Software Foundation.
-
-{\bf 14.} If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these, write to
-the author to ask for permission. For software which is copyrighted by the
-Free Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this. Our decision will be guided by the two goals of
-preserving the free status of all derivatives of our free software and of
-promoting the sharing and reuse of software generally.
-
-{\bf NO WARRANTY}
-
-{\bf 15.} BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE
-THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
-IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
-THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY
-PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
-CORRECTION.
-
-{\bf 16.} IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO
-LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
-THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
-END OF TERMS AND CONDITIONS
-
-\section{How to Apply These Terms to Your New Libraries}
-\label{SEC45}
-\index[general]{Libraries!How to Apply These Terms to Your New }
-\index[general]{How to Apply These Terms to Your New Libraries }
-
-
-If you develop a new library, and you want it to be of the greatest possible
-use to the public, we recommend making it free software that everyone can
-redistribute and change. You can do so by permitting redistribution under
-these terms (or, alternatively, under the terms of the ordinary General Public
-License).
-
-To apply these terms, attach the following notices to the library. It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
-\footnotesize
-\begin{verbatim}
-{\it one line to give the library's name and an idea of what it does.}
-Copyright (C) {\it year} {\it name of author}
-This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public
-License as published by the Free Software Foundation; either
-version 2.1 of the License, or (at your option) any later version.
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-Lesser General Public License for more details.
-You should have received a copy of the GNU Lesser General Public
-License along with this library; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
-USA
-\end{verbatim}
-\normalsize
-
-Also add information on how to contact you by electronic and paper mail.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the library, if
-necessary. Here is a sample; alter the names:
-
-\footnotesize
-\begin{verbatim}
-Yoyodyne, Inc., hereby disclaims all copyright interest in
-the library "Frob" (a library for tweaking knobs) written
-by James Random Hacker.
-{\it signature of Ty Coon}, 1 April 1990
-Ty Coon, President of Vice
-\end{verbatim}
-\normalsize
-
-That's all there is to it!
-Return to
-\elink{GNU's home page}{http://www.gnu.org/home.html}.
-
-FSF \& GNU inquiries \& questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}. Other
-\elink{ways to contact}{http://www.gnu.org/home.html\#ContactInfo} the FSF.
-
-Comments on these web pages to
-\elink{webmasters@www.gnu.org}{mailto:webmasters@www.gnu.org}, send other
-questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}.
-
-Copyright notice above.
-Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
-Boston, MA 02110-1301 USA
-USA
-
-Updated: 27 Nov 2000 paulv
--- /dev/null
+../../licences/lesser.tex
\ No newline at end of file
-%%
-%%
-
\chapter{Bacula Copyright, Trademark, and Licenses}
\label{LicenseChapter}
\index[general]{Licenses!Bacula Copyright Trademark}
\index[general]{Bacula Copyright, Trademark, and Licenses}
-There are a number of different licenses that are used in Bacula.
+There are a number of different licenses that are used in Bacula.
If you have a printed copy of this manual, the details of each of
the licenses referred to in this chapter can be found in the
online version of the manual at
\elink{http://www.bacula.org}{http://www.bacula.org}.
\section{FDL}
-\index[general]{FDL }
+\index[general]{FDL}
The GNU Free Documentation License (FDL) is used for this manual,
-which is a free and open license. This means that you may freely
+which is a free and open license. This means that you may freely
reproduce it and even make changes to it. However, rather than
distribute your own version of this manual, we would much prefer
if you would send any corrections or changes to the Bacula project.
-
+
The most recent version of the manual can always be found online
at \elink{http://www.bacula.org}{http://www.bacula.org}.
\section{GPL}
-\index[general]{GPL }
+\index[general]{GPL}
-The vast bulk of the source code is released under the
+The vast bulk of the source code is released under the
\ilink{GNU General Public License version 2.}{GplChapter}.
Most of this code is copyrighted: Copyright \copyright 2000-2009
under different licenses which are compatible with the Bacula GPLv2 license.
\section{LGPL}
-\index[general]{LGPL }
+\index[general]{LGPL}
-Some of the Bacula library source code is released under the
+Some of the Bacula library source code is released under the
\ilink{GNU Lesser General Public License.}{LesserChapter} This
permits third parties to use these parts of our code in their proprietary
-programs to interface to Bacula.
+programs to interface to Bacula.
\section{Public Domain}
-\index[general]{Domain!Public }
-\index[general]{Public Domain }
+\index[general]{Domain!Public}
+\index[general]{Public Domain}
Some of the Bacula code, or code that Bacula references, has been released
to the public domain. E.g. md5.c, SQLite.
\section{Trademark}
-\index[general]{Trademark }
+\index[general]{Trademark}
-Bacula\raisebox{.6ex}{\textsuperscript{\textregistered}} is a registered
+Bacula\raisebox{.3ex}{\textsuperscript{\textregistered}} is a registered
trademark of Kern Sibbald.
\section{Fiduciary License Agreement}
-\index[general]{Fiduciary License Agreement }
+\index[general]{Fiduciary License Agreement}
Developers who have contributed significant changes to the Bacula code
-should have signed a Fiduciary License Agreement (FLA), which
+should have signed a Fiduciary License Agreement (FLA), which
guarantees them the right to use the code they have developed, and also
ensures that the Free Software Foundation Europe (and thus the Bacula
project) has the rights to the code. This Fiduciary License Agreement
\section{Disclaimer}
-\index[general]{Disclaimer }
+\index[general]{Disclaimer}
-NO WARRANTY
+NO WARRANTY
BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE
PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
-YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE
OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR
DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR
A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
-HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
%% # $ % & ~ _ ^ \ { }
%%
-\documentclass[10pt,a4paper]{book}
-
-\topmargin -0.5in
-\oddsidemargin 0.0in
-\evensidemargin 0.0in
-\textheight 10in
-\textwidth 6.5in
-
-
-\usepackage{html}
+\documentclass[10pt,bsyspaper,english,logo,titlepage,openright]{bsysmanual}
+
+%% \topmargin -0.5in
+%% \oddsidemargin 0.0in
+%% \evensidemargin 0.0in
+%% \textheight 10in
+%% \textwidth 6.5in
+\renewcommand{\familydefault}{\sfdefault}
+\usepackage[utf8]{inputenc}
+\usepackage[toc,title,header,page]{appendix}
+\usepackage[T1]{fontenc}
+\usepackage{longtable,graphicx,fancyhdr,lastpage,eurosym,dcolumn,ltxtable,textcomp,varioref,
+lscape,pdfpages,ifthen,setspace,colortbl,diagbox}
+\usepackage{lmodern,minitoc}
+\usepackage{MnSymbol}
+\usepackage{bbding,multirow}
+\usepackage[hyphens]{url}
+\usepackage[plainpages=true,bookmarks=false,bookmarksopen=false,filecolor=black,linkcolor=black,urlcolor=bsysredtwo,filebordercolor={0. 0. 0.},menubordercolor={0. 0. 0.},urlbordercolor={0. 0. 0.},linkbordercolor={0. 0. 0.},hyperindex=false,colorlinks=true]{hyperref}
+\usepackage{babel,xr,xr-hyper}
+\usepackage[font={sf,bf},textfont=md]{caption}
+\usepackage[printonlyused]{acronym}
+\setlength\arrayrulewidth{0.4pt}
+%\include{bsysincludes}
+\include{bsyscommondefs}
+\usepackage[left=4cm,right=3cm,bottom=2cm,top=2.5cm]{geometry}
+\usepackage{moreverb,fancyvrb}
+\usepackage{listings}
+\input{external-references}
+\pdfminorversion=4
+
+%\usepackage{html}
\usepackage{float}
\usepackage{graphicx}
\usepackage{bacula}
\usepackage{makeidx}
\usepackage{index}
\usepackage{setspace}
-\usepackage{hyperref}
+%\usepackage{hyperref}
% \usepackage[linkcolor=black,colorlinks=true]{hyperref}
\usepackage{url}
\newindex{general}{idx}{ind}{General Index}
\sloppy
-
+\def\bsystitle{Main Reference Manual}
\begin{document}
+\lstset{escapechar=,breaklines=true,basicstyle=\ttfamily\scriptsize,backgroundcolor=\color{lightbsysgrey}}
\sloppy
-\include{coverpage}
+\input{coverpage}
-\clearpage
-\pagenumbering{roman}
+\frontmatter%\clearpage
+%\pagenumbering{roman}
+\dominitoc
\tableofcontents
-\clearpage
+\listoffigures
+\listoftables
+\mainmatter
-\pagestyle{myheadings}
-\markboth{Bacula Version \version}{Bacula Version \version}
-\pagenumbering{arabic}
+%\pagestyle{myheadings}
+%\markboth{Bacula Version \version}{Bacula Version \version}
+%\pagenumbering{arabic}
\include{general}
\include{newbsfeatures}
\include{newbs4.0features}
\include{security} % install
\include{bootstrap}
+%\backmatter
+%\appendix
+\begin{appendices}
+\begin{small}
\include{license}
\include{fdl}
\include{gpl}
\include{projects}
\include{thanks}
\include{bugs}
-
+\end{small}
+\end{appendices}
% pull in the index
-\clearpage
+%\clearpage
+%\backmatter
+\part*{Indexes}
\printindex[general]
\printindex[dir]
\printindex[fd]
\index[general]{Messages Resource}
The Messages resource defines how messages are to be handled and destinations
-to which they should be sent.
+to which they should be sent.
Even though each daemon has a full message handler, within the File daemon and
the Storage daemon, you will normally choose to send all the appropriate
For example, you may want all error messages both logged as well as sent to
you in an email. By defining multiple messages resources, you can have
different message handling for each type of Job (e.g. Full backups versus
-Incremental backups).
+Incremental backups).
In general, messages are attached to a Job and are included in the Job report.
There are some rare cases, where this is not possible, e.g. when no job is
flushed at the end of the next Job. However, since such messages are not
attached to a Job, any that are mailed will be sent to {\bf
/usr/lib/sendmail}. On some systems, such as FreeBSD, if your sendmail is in a
-different place, you may want to link it to the the above location.
+different place, you may want to link it to the the above location.
The records contained in a Messages resource consist of a {\bf destination}
-specification followed by a list of {\bf message-types} in the format:
+specification followed by a list of {\bf message-types} in the format:
\begin{description}
\index[dir]{destination}
\end{description}
-or for those destinations that need and address specification (e.g. email):
+or for those destinations that need and address specification (e.g. email):
\begin{description}
message-type} is one of a predefined set of keywords that define the type of
message generated by {\bf Bacula} ({\bf ERROR}, {\bf WARNING}, {\bf FATAL},
...), and {\bf address} varies according to the {\bf destination} keyword, but
- is typically an email address or a filename.
+ is typically an email address or a filename.
\end{description}
The following are the list of the possible record definitions that can be used
-in a message resource.
+in a message resource.
\begin{description}
\item [Messages]
\index[dir]{Messages}
- Start of the Messages records.
+ Start of the Messages records.
\item [Name = \lt{}name\gt{}]
\index[dir]{Name}
The name of the Messages resource. The name you specify here will be used to
- tie this Messages resource to a Job and/or to the daemon.
+ tie this Messages resource to a Job and/or to the daemon.
\label{mailcommand}
\item [MailCommand = \lt{}command\gt{}]
\index[dir]{MailCommand}
In the absence of this resource, Bacula will send all mail using the
- following command:
+ following command:
-{\bf mail -s "Bacula Message" \lt{}recipients\gt{}}
+{\bf mail -s "Bacula Message" \lt{}recipients\gt{}}
-In many cases, depending on your machine, this command may not work.
+In many cases, depending on your machine, this command may not work.
However, by using the {\bf MailCommand}, you can specify exactly how to
send the mail. During the processing of the {\bf command} part, normally
specified as a quoted string, the following substitutions will be used:
-\begin{itemize}
-\item \%\% = \%
-\item \%c = Client's name
-\item \%d = Director's name
-\item \%e = Job Exit code (OK, Error, ...)
+\begin{bsysitemize}
+\item \%\% = \%
+\item \%c = Client's name
+\item \%d = Director's name
+\item \%e = Job Exit code (OK, Error, ...)
\item \%h = Client address
-\item \%i = Job Id
-\item \%j = Unique Job name
-\item \%l = Job level
-\item \%n = Job name
-\item \%r = Recipients
+\item \%i = Job Id
+\item \%j = Unique Job name
+\item \%l = Job level
+\item \%n = Job name
+\item \%r = Recipients
\item \%s = Since time
-\item \%t = Job type (e.g. Backup, ...)
+\item \%t = Job type (e.g. Backup, ...)
\item \%v = Volume name (Only on director side)
-\end{itemize}
+\end{bsysitemize}
-Please note: any {\bf MailCommand} directive must be specified
+Please note: any {\bf MailCommand} directive must be specified
in the {\bf Messages} resource {\bf before} the desired
{\bf Mail}, {\bf MailOnSuccess}, or {\bf MailOnError}
directive. In fact, each of those directives may be preceded by
The following is the command I (Kern) use. Note, the whole command should
appear on a single line in the configuration file rather than split as is
-done here for presentation:
+done here for presentation:
{\bf mailcommand = "/home/kern/bacula/bin/bsmtp -h mail.example.com -f
\textbackslash{}"\textbackslash{}(Bacula\textbackslash{})
\%l\textbackslash{}" \%r"}
The {\bf bsmtp} program is provided as part of {\bf Bacula}. For
-additional details, please see the
-\ilink{ bsmtp -- Customizing Your Email Messages}{bsmtp} section of
-the Bacula Utility Programs chapter of this manual. Please test any {\bf
+additional details, please see the
+\bsysxrlink{bsmtp -- Customizing Your Email Messages}{bsmtp}{utility}{section} of
+the \utilityman{}. Please test any {\bf
mailcommand} that you use to ensure that your bsmtp gateway accepts the
-addressing form that you use. Certain programs such as Exim can be very
-selective as to what forms are permitted particularly in the from part.
+addressing form that you use. Certain programs such as Exim can be very
+selective as to what forms are permitted particularly in the from part.
\item [OperatorCommand = \lt{}command\gt{}]
\index[fd]{OperatorCommand}
This resource specification is similar to the {\bf MailCommand} except that
it is used for Operator messages. The substitutions performed for the {\bf
MailCommand} are also done for this command. Normally, you will set this
- command to the same value as specified for the {\bf MailCommand}.
+ command to the same value as specified for the {\bf MailCommand}.
The {\bf OperatorCommand} directive must appear in the {\bf Messages}
resource before the {\bf Operator} directive.
\lt{}message-type2\gt{}, ...]
\index[fd]{\lt{}destination\gt{}}
-Where {\bf destination} may be one of the following:
+Where {\bf destination} may be one of the following:
\begin{description}
\item [stdout]
\index[fd]{stdout}
- Send the message to standard output.
+ Send the message to standard output.
\item [stderr]
\index[fd]{stderr}
- Send the message to standard error.
+ Send the message to standard error.
\item [console]
\index[console]{console}
Send the message to the console (Bacula Console). These messages are held
-until the console program connects to the Director.
+until the console program connects to the Director.
\end{description}
\item {\bf \lt{}destination\gt{} = \lt{}address\gt{} =
\lt{}message-type1\gt{}, \lt{}message-type2\gt{}, ...}
\index[console]{\lt{}destination\gt{}}
-Where {\bf address} depends on the {\bf destination}.
+Where {\bf address} depends on the {\bf destination}.
-The {\bf destination} may be one of the following:
+The {\bf destination} may be one of the following:
\begin{description}
\index[general]{director}
Send the message to the Director whose name is given in the {\bf address}
field. Note, in the current implementation, the Director Name is ignored, and
- the message is sent to the Director that started the Job.
+ the message is sent to the Director that started the Job.
\item [file]
\index[dir]{file}
\index[general]{file}
Send the message to the filename given in the {\bf address} field. If the
- file already exists, it will be overwritten.
+ file already exists, it will be overwritten.
\item [append]
\index[dir]{append}
\index[general]{append}
Append the message to the filename given in the {\bf address} field. If the
file already exists, it will be appended to. If the file does not exist, it
- will be created.
+ will be created.
\item [syslog]
\index[general]{syslog}
ignored and the message is always sent to the LOG\_DAEMON facility with
level LOG\_ERR. See {\bf man 3 syslog} for more details. Example:
-\begin{verbatim}
+\begin{lstlisting}
syslog = all, !skipped
-\end{verbatim}
+\end{lstlisting}
Although the {\bf syslog} destination is not used in the default Bacula
config files, in certain cases where Bacula encounters errors in trying
separated list in the {\bf address} field. This is similar to {\bf
mail} above, except that each message is sent as received. Thus there
is one email per message. This is most useful for {\bf mount} messages
- (see below).
+ (see below).
\item [console]
\index[general]{console}
also be added. This permits Job Reports and other messages to
be recorded in the Catalog so that they can be accessed by
reporting software. Bacula will prune the Log records associated
- with a Job when the Job records are pruned. Otherwise, Bacula
+ with a Job when the Job records are pruned. Otherwise, Bacula
never uses these records internally, so this destination is only
used for special purpose programs (e.g. {\bf bweb}).
\item [info]
\index[general]{info}
- General information messages.
+ General information messages.
\item [warning]
\index[general]{warning}
Warning messages. Generally this is some unusual condition but not expected
- to be serious.
+ to be serious.
\item [error]
\index[general]{error}
Non-fatal error messages. The job continues running. Any error message should
- be investigated as it means that something went wrong.
+ be investigated as it means that something went wrong.
\item [fatal]
\index[general]{fatal}
- Fatal error messages. Fatal errors cause the job to terminate.
+ Fatal error messages. Fatal errors cause the job to terminate.
\item [terminate]
\index[general]{terminate}
- Message generated when the daemon shuts down.
+ Message generated when the daemon shuts down.
\item [notsaved]
\index[fd]{notsaved}
\index[general]{notsaved}
Files not saved because of some error. Usually because the file cannot be
- accessed (i.e. it does not exist or is not mounted).
+ accessed (i.e. it does not exist or is not mounted).
\item [skipped]
\index[fd]{skipped}
\item [all]
\index[general]{all}
- All message types.
+ All message types.
\item [security]
\index[general]{security}
- Security info/warning messages principally from unauthorized
+ Security info/warning messages principally from unauthorized
connection attempts.
\item [alert]
to the console:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Messages {
Name = Standard
mail = enforcement@sec.com = all, !skipped, !terminate
operator = enforcement@sec.com = mount
console = all, !skipped, !saved
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
With the exception of the email address (changed to avoid junk mail from
robot's), an example Director's Messages resource is as follows. Note, the {\bf
mailcommand} and {\bf operatorcommand} are on a single line -- they had to be
-split for this manual:
+split for this manual:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Messages {
Name = Standard
mailcommand = "bacula/bin/bsmtp -h mail.example.com \
operator = security@example.com = mount
console = all, !skipped, !saved
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\chapter{Migration and Copy}
\label{MigrationChapter}
-\index[general]{Migration}
-\index[general]{Copy}
+\index[general]{Migration}
+\index[general]{Copy}
The term Migration, as used in the context of Bacula, means moving data from
one Volume to another. In particular it refers to a Job (similar to a backup
as a copy rather than a backup job, and hence is not directly available for
restore. If bacula founds a copy when a job record is purged (deleted) from the
catalog, it will promote the copy as \textsl{real} backup and will make it
-available for automatic restore.
+available for automatic restore.
The Copy and the Migration jobs run without using the File daemon by copying
the data from the old backup Volume to a different Volume in a different Pool.
The selection process for which Job or Jobs are migrated
can be based on quite a number of different criteria such as:
-\begin{itemize}
+\begin{bsysitemize}
\item a single previous Job
\item a Volume
\item a Client
\item the time a Job has been on a Volume
\item high and low water marks (usage or occupation) of a Pool
\item Volume size
-\end{itemize}
+\end{bsysitemize}
The details of these selection criteria will be defined below.
To run a Migration job, you must first define a Job resource very similar
to a Backup Job but with {\bf Type = Migrate} instead of {\bf Type =
-Backup}. One of the key points to remember is that the Pool that is
+Backup}. One of the key points to remember is that the Pool that is
specified for the migration job is the only pool from which jobs will
be migrated, with one exception noted below. In addition, the Pool to
which the selected Job or Jobs will be migrated is defined by the {\bf
However, when doing migration, this is a very undesirable condition. For
migration to work properly, you should use Pools containing only Volumes of
the same Media Type for all migration jobs.
-
+
The migration job normally is either manually started or starts
from a Schedule much like a backup job. It searches
for a previous backup Job or Jobs that match the parameters you have
done nothing, but normally at a minimum, three jobs are involved during a
migration:
-\begin{itemize}
+\begin{bsysitemize}
\item The currently running Migration control Job. This is only
a control job for starting the migration child jobs.
\item The previous Backup Job (already run). The File records
for this Job are purged if the Migration job successfully
terminates. The original data remains on the Volume until
it is recycled and rewritten.
-\item A new Migration Backup Job that moves the data from the
+\item A new Migration Backup Job that moves the data from the
previous Backup job to the new Volume. If you subsequently
do a restore, the data will be read from this Job.
-\end{itemize}
+\end{bsysitemize}
-If the Migration control job finds a number of JobIds to migrate (e.g.
+If the Migration control job finds a number of JobIds to migrate (e.g.
it is asked to migrate one or more Volumes), it will start one new
migration backup job for each JobId found on the specified Volumes.
Please note that Migration doesn't scale too well since Migrations are
\section{Migration and Copy Job Resource Directives}
The following directives can appear in a Director's Job resource, and they
-are used to define a Migration job.
+are used to define a Migration job.
\begin{description}
\item [Pool = \lt{}Pool-name\gt{}] The Pool specified in the Migration
for finding JobIds to migrate. The exception to this is when {\bf
Selection Type = SQLQuery}, and although a Pool directive must still be
specified, no Pool is used, unless you specifically include it in the
- SQL query. Note, in any case, the Pool resource defined by the Pool
+ SQL query. Note, in any case, the Pool resource defined by the Pool
directove must contain a {\bf Next Pool = ...} directive to define the
Pool to which the data will be migrated.
If you subsequently delete a JobId that has a copy, the copy will be
automatically upgraded to a Backup rather than a Copy, and it will
subsequently be used for restoration.
-
-\item [Selection Type = \lt{}Selection-type-keyword\gt{}]
+
+\item [Selection Type = \lt{}Selection-type-keyword\gt{}]
The \lt{}Selection-type-keyword\gt{} determines how the migration job
will go about selecting what JobIds to migrate. In most cases, it is
used in conjunction with a {\bf Selection Pattern} to give you fine
database
entries. The bytes calculate for Migration is based on the value stored
in the Job records of the Jobs to be migrated. These do not include the
- Storage daemon overhead as is in the total Pool size. As a consequence,
+ Storage daemon overhead as is in the total Pool size. As a consequence,
normally, the migration will migrate more bytes than strictly necessary.
\item [PoolTime] The PoolTime selection type will cause the Migration job to
look at the time each JobId has been in the Pool since the job ended.
- All Jobs in the Pool longer than the time specified on {\bf Migration Time}
+ All Jobs in the Pool longer than the time specified on {\bf Migration Time}
directive in the Pool resource will be migrated.
\item [PoolUncopiedJobs] This selection which copies all jobs from a pool
\item [Selection Pattern = \lt{}Quoted-string\gt{}]
The Selection Patterns permitted for each Selection-type-keyword are
- described above.
+ described above.
For the OldestVolume and SmallestVolume, this
- Selection pattern is not used (ignored).
+ Selection pattern is not used (ignored).
For the Client, Volume, and Job
keywords, this pattern must be a valid regular expression that will filter
\begin{description}
\item [Migration Time = \lt{}time-specification\gt{}]
If a PoolTime migration is done, the time specified here in seconds (time
- modifiers are permitted -- e.g. hours, ...) will be used. If the
+ modifiers are permitted -- e.g. hours, ...) will be used. If the
previous Backup Job or Jobs selected have been in the Pool longer than
the specified PoolTime, then they will be migrated.
trigger a migration if a {\bf PoolOccupancy} migration selection
type has been specified. The fact that the Pool
usage goes above this level does not automatically trigger a migration
- job. However, if a migration job runs and has the PoolOccupancy selection
+ job. However, if a migration job runs and has the PoolOccupancy selection
type set, the Migration High Bytes will be applied. Bacula does not
currently restrict a pool to have only a single Media Type, so you
must keep in mind that if you mix Media Types in a Pool, the results
This directive specifies the number of bytes in the Pool which will
stop a migration if a {\bf PoolOccupancy} migration selection
type has been specified and triggered by more than Migration High
- Bytes being in the pool. In other words, once a migration job
+ Bytes being in the pool. In other words, once a migration job
is started with {\bf PoolOccupancy} migration selection and it
- determines that there are more than Migration High Bytes, the
+ determines that there are more than Migration High Bytes, the
migration job will continue to run jobs until the number of
bytes in the Pool drop to or below Migration Low Bytes.
\item [Storage = \lt{}storage-specification\gt{}]
The Storage directive specifies what Storage resource will be used
for all Jobs that use this Pool. It takes precedence over any other
- Storage specifications that may have been given such as in the
+ Storage specifications that may have been given such as in the
Schedule Run directive, or in the Job resource. We highly recommend
that you define the Storage resource to be used in the Pool rather
than elsewhere (job, schedule run, ...).
\section{Important Migration Considerations}
\index[general]{Important Migration Considerations}
-\begin{itemize}
+\begin{bsysitemize}
\item Each Pool into which you migrate Jobs or Volumes {\bf must}
- contain Volumes of only one Media Type.
+ contain Volumes of only one Media Type.
\item Migration takes place on a JobId by JobId basis. That is
each JobId is migrated in its entirety and independently
indicate that the job was migrated.
\item Jobs on Volumes will be Migration only if the Volume is
- marked, Full, Used, or Error. Volumes that are still
+ marked, Full, Used, or Error. Volumes that are still
marked Append will not be considered for migration. This
prevents Bacula from attempting to read the Volume at
the same time it is writing it. It also reduces other deadlock
\item Migration is done only when you run a Migration job. If you set a
Migration High Bytes and that number of bytes is exceeded in the Pool
- no migration job will automatically start. You must schedule the
+ no migration job will automatically start. You must schedule the
migration jobs, and they must run for any migration to take place.
\item If you migrate a number of Volumes, a very large number of Migration
- jobs may start.
+ jobs may start.
\item Figuring out what jobs will actually be migrated can be a bit complicated
- due to the flexibility provided by the regex patterns and the number of
- different options. Turning on a debug level of 100 or more will provide
- a limited amount of debug information about the migration selection
+ due to the flexibility provided by the regex patterns and the number of
+ different options. Turning on a debug level of 100 or more will provide
+ a limited amount of debug information about the migration selection
process.
\item Bacula currently does only minimal Storage conflict resolution, so you
same device or Bacula may block waiting to reserve a drive that it
will never find. In general, ensure that all your migration
pools contain only one Media Type, and that you always
- migrate to pools with different Media Types.
+ migrate to pools with different Media Types.
\item The {\bf Next Pool = ...} directive must be defined in the Pool
referenced in the Migration Job to define the Pool into which the
potential bottle neck and does not scale very well to large numbers
of jobs.
-\item Only migration of Selection Types of Job and Volume have
+\item Only migration of Selection Types of Job and Volume have
been carefully tested. All the other migration methods (time,
occupancy, smallest, oldest, ...) need additional testing.
\item Migration is only implemented for a single Storage daemon. You
cannot read on one Storage daemon and write on another.
-\end{itemize}
+\end{bsysitemize}
\section{Example Migration Jobs}
by the migration job).
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
# Define the backup Job
Job {
Name = "NightlySave"
Media Type = DLT8000 # same as MediaType in Storage daemon
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
-Where we have included only the essential information -- i.e. the
+Where we have included only the essential information -- i.e. the
Director, FileSet, Catalog, Client, Schedule, and Messages resources are
omitted.
Now, if we add the following Job resource to this conf file.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = "migrate-volume"
Type = Migrate
Level = Full
- Client = rufus-fd
+ Client = rufus-fd
FileSet = "Full Set"
Messages = Standard
Pool = Default
Selection Type = Volume
Selection Pattern = "File"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
and then run the job named {\bf migrate-volume}, all volumes in the Pool
-named Default (as specified in the migrate-volume Job that match the
-regular expression pattern {\bf File} will be migrated to tape storage
+named Default (as specified in the migrate-volume Job that match the
+regular expression pattern {\bf File} will be migrated to tape storage
DLTDrive because the {\bf Next Pool} in the Default Pool specifies that
Migrations should go to the pool named {\bf Tape}, which uses
Storage {\bf DLTDrive}.
If instead, we use a Job resource as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = "migrate"
Type = Migrate
Messages = Standard
Pool = Default
Maximum Concurrent Jobs = 4
- Selection Type = Job
+ Selection Type = Job
Selection Pattern = ".*Save"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
All jobs ending with the name Save will be migrated from the File Default to
The Monitor configuration file is a stripped down version of the Director
configuration file, mixed with a Console configuration file. It simply
contains the information necessary to contact Directors, Clients, and Storage
-daemons you want to monitor.
+daemons you want to monitor.
For a general discussion of configuration file and resources including the
-data types recognized by {\bf Bacula}, please see the
-\ilink{Configuration}{ConfigureChapter} chapter of this manual.
+data types recognized by {\bf Bacula}, please see the
+\ilink{Configuration}{ConfigureChapter} chapter of this manual.
-The following Monitor Resource definition must be defined:
+The following Monitor Resource definition must be defined:
-\begin{itemize}
-\item
+\begin{bsysitemize}
+\item
\ilink{Monitor}{MonitorResource} -- to define the Monitor's
name used to connect to all the daemons and the password used to connect to
the Directors. Note, you must not define more than one Monitor resource in
-the Monitor configuration file.
-\item At least one
- \ilink{Client}{ClientResource1},
- \ilink{Storage}{StorageResource1} or
-\ilink{Director}{DirectorResource2} resource, to define the
-daemons to monitor.
-\end{itemize}
+the Monitor configuration file.
+\item At least one
+ \ilink{Client}{ClientResource1},
+ \ilink{Storage}{StorageResource1} or
+\ilink{Director}{DirectorResource2} resource, to define the
+daemons to monitor.
+\end{bsysitemize}
\section{The Monitor Resource}
\label{MonitorResource}
The Monitor resource defines the attributes of the Monitor running on the
network. The parameters you define here must be configured as a Director
resource in Clients and Storages configuration files, and as a Console
-resource in Directors configuration files.
+resource in Directors configuration files.
\begin{description}
\item [Monitor]
\index[fd]{Monitor }
- Start of the Monitor records.
+ Start of the Monitor records.
\item [Name = \lt{}name\gt{}]
\index[fd]{Name }
Specify the Director name used to connect to Client and Storage, and the
-Console name used to connect to Director. This record is required.
+Console name used to connect to Director. This record is required.
\item [Password = \lt{}password\gt{}]
\index[fd]{Password }
Where the password is the password needed for Directors to accept the Console
connection. This password must be identical to the {\bf Password} specified
-in the {\bf Console} resource of the
-\ilink{Director's configuration}{DirectorChapter} file. This
-record is required if you wish to monitor Directors.
+in the {\bf Console} resource of the
+\ilink{Director's configuration}{DirectorChapter} file. This
+record is required if you wish to monitor Directors.
\item [Refresh Interval = \lt{}time\gt{}]
\index[fd]{Refresh Interval }
Specifies the time to wait between status requests to each daemon. It can't
be set to less than 1 second, or more than 10 minutes, and the default value
-is 5 seconds.
+is 5 seconds.
% TODO: what is format of the time?
% TODO: should the digits in this definition be spelled out? should
% TODO: this say "time-period-specification" above??)
monitored by this Monitor.
As you are not permitted to define a Password in this resource, to avoid
-obtaining full Director privileges, you must create a Console resource in the
+obtaining full Director privileges, you must create a Console resource in the
\ilink{Director's configuration}{DirectorChapter} file, using the
Console Name and Password defined in the Monitor resource. To avoid security
problems, you should configure this Console resource to allow access to no
.status} (see below for an example).
You may have multiple Director resource specifications in a single Monitor
-configuration file.
+configuration file.
\begin{description}
\item [Director]
\index[fd]{Director }
- Start of the Director records.
+ Start of the Director records.
\item [Name = \lt{}name\gt{}]
\index[fd]{Name }
The Director name used to identify the Director in the list of monitored
daemons. It is not required to be the same as the one defined in the Director's
-configuration file. This record is required.
+configuration file. This record is required.
\item [DIRPort = \lt{}port-number\gt{}]
\index[fd]{DIRPort }
likely already be set to the value you specified on the {\bf
\verb:--:with-baseport} option of the {\bf ./configure} command. This port must be
identical to the {\bf DIRport} specified in the {\bf Director} resource of
-the
+the
\ilink{Director's configuration}{DirectorChapter} file. The
-default is 9101 so this record is not normally specified.
+default is 9101 so this record is not normally specified.
\item [Address = \lt{}address\gt{}]
\index[fd]{Address }
Where the address is a host name, a fully qualified domain name, or a network
-address used to connect to the Director. This record is required.
+address used to connect to the Director. This record is required.
\end{description}
\section{The Client Resource}
The Client resource defines the attributes of the Clients that are monitored
by this Monitor.
-You must create a Director resource in the
+You must create a Director resource in the
\ilink{Client's configuration}{FiledConfChapter} file, using the
Director Name defined in the Monitor resource. To avoid security problems, you
should set the {\bf Monitor} directive to {\bf Yes} in this Director resource.
You may have multiple Director resource specifications in a single Monitor
-configuration file.
+configuration file.
\begin{description}
\item [Client (or FileDaemon)]
\index[fd]{Client (or FileDaemon) }
- Start of the Client records.
+ Start of the Client records.
\item [Name = \lt{}name\gt{}]
\index[fd]{Name }
The Client name used to identify the Director in the list of monitored
daemons. It is not required to be the same as the one defined in the Client's
-configuration file. This record is required.
+configuration file. This record is required.
\item [Address = \lt{}address\gt{}]
\index[fd]{Address }
Where the address is a host name, a fully qualified domain name, or a network
address in dotted quad notation for a Bacula File daemon. This record is
-required.
+required.
\item [FD Port = \lt{}port-number\gt{}]
\index[fd]{FD Port }
Where the port is a port number at which the Bacula File daemon can be
-contacted. The default is 9102.
+contacted. The default is 9102.
\item [Password = \lt{}password\gt{}]
\index[fd]{Password }
This is the password to be used when establishing a connection with the File
services, so the Client configuration file on the machine to be backed up
-must have the same password defined for this Director. This record is
-required.
+must have the same password defined for this Director. This record is
+required.
\end{description}
\section{The Storage Resource}
The Storage resource defines the attributes of the Storages that are monitored
by this Monitor.
-You must create a Director resource in the
+You must create a Director resource in the
\ilink{Storage's configuration}{StoredConfChapter} file, using the
Director Name defined in the Monitor resource. To avoid security problems, you
should set the {\bf Monitor} directive to {\bf Yes} in this Director resource.
You may have multiple Director resource specifications in a single Monitor
-configuration file.
+configuration file.
\begin{description}
\item [Storage]
\index[fd]{Storage }
- Start of the Storage records.
+ Start of the Storage records.
\item [Name = \lt{}name\gt{}]
\index[fd]{Name }
The Storage name used to identify the Director in the list of monitored
daemons. It is not required to be the same as the one defined in the Storage's
-configuration file. This record is required.
+configuration file. This record is required.
\item [Address = \lt{}address\gt{}]
\index[fd]{Address }
Where the address is a host name, a fully qualified domain name, or a network
address in dotted quad notation for a Bacula Storage daemon. This record is
-required.
+required.
\item [SD Port = \lt{}port\gt{}]
\index[fd]{SD Port }
Where port is the port to use to contact the storage daemon for information
and to start jobs. This same port number must appear in the Storage resource
-of the Storage daemon's configuration file. The default is 9103.
+of the Storage daemon's configuration file. The default is 9103.
\item [Password = \lt{}password\gt{}]
\index[sd]{Password }
\label{SampleConfiguration1}
\index[general]{Sample Tray Monitor configuration}
-An example Tray Monitor configuration file might be the following:
+An example Tray Monitor configuration file might be the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# Bacula Tray Monitor Configuration File
#
Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
RefreshInterval = 10 seconds
}
-
+
Client {
Name = rufus-fd
Address = rufus
DIRport = 9101
address = rufus
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\subsection{Sample File daemon's Director record.}
\index[general]{Sample File daemon's Director record. }
\index[general]{Record!Sample File daemon's Director }
-Click
+Click
\ilink{here to see the full example.}{SampleClientConfiguration}
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# Restricted Director, used by tray-monitor to get the
# status of the file daemon
Password = "FYpq4yyI1y562EMS35bA0J0QC0M2L3t5cZObxT3XQxgxppTn"
Monitor = yes
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\subsection{Sample Storage daemon's Director record.}
\index[general]{Record!Sample Storage daemon's Director }
\index[general]{Sample Storage daemon's Director record. }
-Click
-\ilink{here to see the full example.}{SampleConfiguration}
+Click
+\ilink{here to see the full example.}{SampleConfiguration}
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# Restricted Director, used by tray-monitor to get the
# status of the storage daemon
Password = "9usxgc307dMbe7jbD16v0PXlhD64UVasIDD0DH2WAujcDsc6"
Monitor = yes
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\subsection{Sample Director's Console record.}
\index[general]{Record!Sample Director's Console }
\index[general]{Sample Director's Console record. }
-Click
+Click
\ilink{here to see the full
-example.}{SampleDirectorConfiguration}
+example.}{SampleDirectorConfiguration}
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# Restricted console used by tray-monitor to get the status of the director
#
Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
CommandACL = status, .status
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
first time. As a consequence, below, we list the steps that we used to install
it on our machines. Please note that our configuration leaves MySQL without
any user passwords. This may be an undesirable situation if you have other
-users on your system.
+users on your system.
The notes below describe how to build MySQL from the source tar files. If
you have a pre-installed MySQL, you can return to complete the installation
the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysql-<version>.rpm
mysql-server-<version>.rpm
mysql-devel-<version>.rpm
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you wish to install them from debs, you will probably need the
following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysql-server-<version>.deb
mysql-client-<version>.deb
libmysqlclient15-dev-<version>.deb
libmysqlclient15off-<version>.deb
-\end{verbatim}
+\end{lstlisting}
\normalsize
The names of the packages may vary from distribution to
distribution. It is important to have the {\bf devel} or {\bf dev} package loaded as
it contains the libraries and header files necessary to build
-Bacula. There may be additional packages that are required to
-install the above, for example, zlib and openssl.
+Bacula. There may be additional packages that are required to
+install the above, for example, zlib and openssl.
Once these packages are installed, you will be able to build Bacula (using
the files installed with the mysql package, then run MySQL using the
./configure} as shown below:
\begin{enumerate}
-\item Download MySQL source code from
- \elink{www.mysql.com/downloads}{http://www.mysql.com/downloads}
+\item Download MySQL source code from
+ \elink{www.mysql.com/downloads}{http://www.mysql.com/downloads}
\item Detar it with something like:
- {\bf tar xvfz mysql-filename}
+ {\bf tar xvfz mysql-filename}
Note, the above command requires GNU tar. If you do not have GNU tar, a
command such as:
-{\bf zcat mysql-filename \verb+|+ tar xvf - }
+{\bf zcat mysql-filename \verb+|+ tar xvf - }
-will probably accomplish the same thing.
+will probably accomplish the same thing.
\item cd {\bf mysql-source-directory}
where you replace {\bf mysql-source-directory} with the directory name where
- you put the MySQL source code.
+ you put the MySQL source code.
\item ./configure \verb:--:enable-thread-safe-client \verb:--:prefix=mysql-directory
where you replace {\bf mysql-directory} with the directory name where you
want to install mysql. Normally for system wide use this is /usr/local/mysql.
- In my case, I use \~{}kern/mysql.
+ In my case, I use \~{}kern/mysql.
\item make
- This takes a bit of time.
+ This takes a bit of time.
\item make install
This will put all the necessary binaries, libraries and support files into
- the {\bf mysql-directory} that you specified above.
+ the {\bf mysql-directory} that you specified above.
\item ./scripts/mysql\_install\_db
This will create the necessary MySQL databases for controlling user access.
Note, this script can also be found in the {\bf bin} directory in the
-installation directory
+installation directory
\end{enumerate}
library {\bf libz.a} or {\bf libz.so}. If you are using rpm packages, these
libraries are in the {\bf libz-devel} package. On Debian systems, you will
need to load the {\bf zlib1g-dev} package. If you are not using rpms or debs,
-you will need to find the appropriate package for your system.
+you will need to find the appropriate package for your system.
At this point, you should return to completing the installation of {\bf
Bacula}. Later after Bacula is installed, come back to this chapter to
complete the installation. Please note, the installation files used in the
second phase of the MySQL installation are created during the Bacula
-Installation.
+Installation.
\label{mysql_phase2}
\section{Installing and Configuring MySQL -- Phase II}
At this point, you should have built and installed MySQL, or already have a
running MySQL, and you should have configured, built and installed {\bf
-Bacula}. If not, please complete these items before proceeding.
+Bacula}. If not, please complete these items before proceeding.
Please note that the {\bf ./configure} used to build {\bf Bacula} will need to
include {\bf \verb:--:with-mysql=mysql-directory}, where {\bf mysql-directory} is the
directory name that you specified on the ./configure command for configuring
MySQL. This is needed so that Bacula can find the necessary include headers
-and library files for interfacing to MySQL.
+and library files for interfacing to MySQL.
{\bf Bacula} will install scripts for manipulating the database (create,
delete, make tables etc) into the main installation directory. These files
running ./configure. If you inspect create\_bacula\_database, you will see
that it calls create\_mysql\_database. The *\_bacula\_* files are provided for
convenience. It doesn't matter what database you have chosen;
-create\_bacula\_database will always create your database.
+create\_bacula\_database will always create your database.
Now you will create the Bacula MySQL database and the tables that Bacula uses.
\begin{enumerate}
\item Start {\bf mysql}. You might want to use the {\bf startmysql} script
- provided in the Bacula release.
+ provided in the Bacula release.
\item cd \lt{}install-directory\gt{}
- This directory contains the Bacula catalog interface routines.
+ This directory contains the Bacula catalog interface routines.
\item ./grant\_mysql\_privileges
- This script creates unrestricted access rights for the user {\bf bacula}.
+ This script creates unrestricted access rights for the user {\bf bacula}.
You may want to modify it to suit your situation. Please
- note that none of the userids, including root, are password protected.
+ note that none of the userids, including root, are password protected.
If you need more security, please assign a password to the root user
and to bacula. The program {\bf mysqladmin} can be used for this.
check its size.
\item ./make\_mysql\_tables
- This script creates the MySQL tables used by {\bf Bacula}.
+ This script creates the MySQL tables used by {\bf Bacula}.
\end{enumerate}
Each of the three scripts (grant\_mysql\_privileges, create\_mysql\_database
and make\_mysql\_tables) allows the addition of a command line argument. This
can be useful for specifying the user and or password. For example, you might
need to add {\bf -u root} to the command line to have sufficient privilege to
-create the Bacula tables.
+create the Bacula tables.
To take a closer look at the access privileges that you have setup with the
-above, you can do:
+above, you can do:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysql-directory/bin/mysql -u root mysql
select * from user;
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{Re-initializing the Catalog Database}
After you have done some initial testing with {\bf Bacula}, you will probably
want to re-initialize the catalog database and throw away all the test Jobs
-that you ran. To do so, you can do the following:
+that you ran. To do so, you can do the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cd <install-directory>
./drop_mysql_tables
./make_mysql_tables
-\end{verbatim}
+\end{lstlisting}
\normalsize
Please note that all information in the database will be lost and you will be
starting from scratch. If you have written on any Volumes, you must write an
-end of file mark on the volume so that Bacula can reuse it. Do so with:
+end of file mark on the volume so that Bacula can reuse it. Do so with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
(stop Bacula or unmount the drive)
mt -f /dev/nst0 rewind
mt -f /dev/nst0 weof
-\end{verbatim}
+\end{lstlisting}
\normalsize
Where you should replace {\bf /dev/nst0} with the appropriate tape drive
-device name for your machine.
+device name for your machine.
\section{Linking Bacula with MySQL}
\index[general]{Linking Bacula with MySQL }
\index[general]{MySQL!Linking Bacula with }
\index[general]{Upgrading}
-After configuring Bacula with
+After configuring Bacula with
./configure \verb:--:enable-thread-safe-client \verb:--:prefix=\lt{}mysql-directory\gt{}
where \lt{}mysql-directory\gt{} is in my case {\bf /home/kern/mysql}, you may
ldconfig} program shown below. If you put MySQL in a standard place such as
{\bf /usr/lib} or {\bf /usr/local/lib} this will not be necessary, but in my
case it is. The description that follows is Linux specific. For other
-operating systems, please consult your manuals on how to do the same thing:
+operating systems, please consult your manuals on how to do the same thing:
First edit: {\bf /etc/ld.so.conf} and add a new line to the end of the file
-with the name of the mysql-directory. In my case, it is:
+with the name of the mysql-directory. In my case, it is:
-/home/kern/mysql/lib/mysql then rebuild the loader's cache with:
+/home/kern/mysql/lib/mysql then rebuild the loader's cache with:
/sbin/ldconfig If you upgrade to a new version of {\bf MySQL}, the shared
library names will probably change, and you must re-run the {\bf
-/sbin/ldconfig} command so that the runtime loader can find them.
+/sbin/ldconfig} command so that the runtime loader can find them.
Alternatively, your system my have a loader environment variable that can be
set. For example, on a Solaris system where I do not have root permission, I
-use:
+use:
-LD\_LIBRARY\_PATH=/home/kern/mysql/lib/mysql
+LD\_LIBRARY\_PATH=/home/kern/mysql/lib/mysql
Finally, if you have encryption enabled in MySQL, you may need to add {\bf
-lssl -lcrypto} to the link. In that case, you can either export the
appropriate LDFLAGS definition, or alternatively, you can include them
-directly on the ./configure line as in:
+directly on the ./configure line as in:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
LDFLAGS="-lssl -lcyrpto" \
./configure \
<your-options>
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{Installing MySQL from RPMs}
install:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysql
mysql-devel
-\end{verbatim}
+\end{lstlisting}
\normalsize
This will be the same with most other package managers too.
\index[general]{Upgrading MySQL }
\index[general]{Upgrading!MySQL }
\index[general]{Upgrading}
-If you upgrade MySQL, you must reconfigure, rebuild, and re-install
+If you upgrade MySQL, you must reconfigure, rebuild, and re-install
Bacula otherwise you are likely to get bizarre failures. If you
install from rpms and you upgrade MySQL, you must also rebuild Bacula.
You can do so by rebuilding from the source rpm. To do so, you may need
\chapter{New Features in Enterprise 4.0.x}
There are new features in the Bacula Enterprise version.
-This is an older version and this documentation remains
-for historical reasons.
+This is an older version and this documentation remains
+for historical reasons.
\section{New Features in Version 4.0.8}
When the Accurate mode is turned on, you can decide to always backup a file
by using the following option:
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = ...
FileSet = FS_Example
}
...
}
-\end{verbatim}
+\end{lstlisting}
\section{New Features in 4.0.5}
the LAN to your Bacula server.
Accurate option should be turned on in the Job resource.
-\begin{verbatim}
+\begin{lstlisting}
Job {
Accurate = yes
FileSet = NDMPFS
Plugin = "ndmp:host=nasbox user=root pass=root file=/vol/vol1"
}
}
-\end{verbatim}
+\end{lstlisting}
This plugin is available as an option. Please
contact Bacula Systems to get access to the NDMP Plugin packages and the
with a simple directive. This plugin is available in the Windows 64 and 32 bit
installer.
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = EverythingFS
...
Plugin = "alldrives"
}
}
-\end{verbatim}
+\end{lstlisting}
You exclude some specific drives with the \texttt{exclude} option.
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = EverythingFS
...
Plugin = "alldrives: exclude=D,E"
}
}
-\end{verbatim}
+\end{lstlisting}
This project was funded by Bacula Systems and is available with Bacula
You can have access to JobBytes and JobFiles using \%b and \%f in your runscript
command.
-\begin{verbatim}
+\begin{lstlisting}
RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%f"
-\end{verbatim}
+\end{lstlisting}
\section{Release Version 4.0.1 to 4.0.4}
versions.
\subsection{Microsoft VSS Writer Plugin}
-\index[general]{Microsoft VSS Writer Plugin}
+\index[general]{Microsoft VSS writer plugin}
We provide a single plugin named {\bf vss-fd.dll} that
permits you to backup a number of different components
on Windows machines. This plugin is available from Bacula Systems
Only the System State component is currently supported. The Sharepoint,
MSSQL, and Exchange components are available only for testing.
-\begin{itemize}
+\begin{bsysitemize}
\item System State writers
- \begin{itemize}
+ \begin{bsysitemize}
\item Registry
\item Event Logs
\item COM+ REGDB (COM Registration Database)
\item NTFRS (SYSVOL etc replication -- Windows 2003 domains)
\item DFS Replication (SYSVOLS etc replication -- Windows 2008 domains)
\item ASR Writer
- \end{itemize}
+ \end{bsysitemize}
This component is known to work.
\item Sharepoint writers \\
This component has not yet been tested. It is included so that you
use it in production without careful testing. \\ Bacula Systems has a
White Paper that describes backup and restore of MS Exchange 2010 in
detail.
-\end{itemize}
+\end{bsysitemize}
Each of the above specified Microsoft components can be backed up
by specifying a different plugin option within the Bacula FileSet.
All specifications must start with {\bf vss:} and be followed
-with a keyword which indicates the writer, such as {\bf /@SYSTEMSTATE/}
+with a keyword which indicates the writer, such as {\bf /@SYSTEMSTATE/}
(see below).
To activate each component you use the following:
-\begin{itemize}
+\begin{bsysitemize}
\item System State writers
- \begin{verbatim}
+ \begin{lstlisting}
Plugin = "vss:/@SYSTEMSTATE/"
- \end{verbatim}
+ \end{lstlisting}
Note, exactly which subcomponents will be backed up depends on
which ones you have enabled within Windows. For example, on a standard
default Vista system only ASR Writer, COM+ REGDB, System State, and WMI
are enabled.
\item Sharepoint writers
- \begin{verbatim}
+ \begin{lstlisting}
Plugin = "vss:/@SHAREPOINT/"
- \end{verbatim}
+ \end{lstlisting}
\item MSSQL databases (except those owned by Sharepoint if that plugin is
specified)
- \begin{verbatim}
+ \begin{lstlisting}
Plugin = "vss:/@MSSQL/"
- \end{verbatim}
+ \end{lstlisting}
To use the sharepoint writer you'll need to enable the mssql writer
which is not enabled by default (a Microsoft restriction). The Microsoft
literature says that the mssql writer is only good for snapshots
enabled via a registry tweak or else the older MSDE writer will be
invoked instead.
\item Exchange (all exchange databases)
- \begin{verbatim}
+ \begin{lstlisting}
Plugin = "vss:/@EXCHANGE/"
- \end{verbatim}
-\end{itemize}
+ \end{lstlisting}
+\end{bsysitemize}
The plugin directives must be specified exactly as shown above.
A Job may have one or more of the {\bf vss} plugins components specified.
include the system state. The system state files backed up will appear
in a {\bf bconsole} or {\bf bat} restore like:
-\begin{verbatim}
+\begin{lstlisting}
/@SYSTEMSTATE/
/@SYSTEMSTATE/ASR Writer/
/@SYSTEMSTATE/COM+ REGDB Writer/
etc
-\end{verbatim}
+\end{lstlisting}
Only a complete backup of the system state is supported at this time. That
is it is not currently possible to just back up the Registry or Active
Directory by itself. In almost all cases a complete backup is a good idea
anyway as most of the components are interconnected in some way. Also, if
an incremental or differential backup is specified on the backup Job then a
-full backup of the system state will still be done. The size varies
+full backup of the system state will still be done. The size varies
according to your installation. We have seen up to 6GB
under Windows 2008, mostly because of the "System" writer, and
up to 20GB on Vista. The actual size depends on how many Windows
in the FilesNotToBackup registry key, which includes things like \%TEMP\%,
pagefile.sys, hiberfil.sys, etc. Each plugin may additionally specify
files to exclude, eg the VSS Registry Writer will tell Bacula to not back
-up the registry hives under \verb+C:\WINDOWS\system32\config+ because they
+up the registry hives under \lstinline+C:\WINDOWS\system32\config+ because they
are backed up as part of the system state.
\subsubsection{Restore}
\subsubsection{Example}
Suppose you have the following backup FileSet:
-\begin{verbatim}
+\begin{lstlisting}
@SYSTEMSTATE/
System Writer/
instance_{GUID}
NTDS/
instance_{GUID}
ntds/
-\end{verbatim}
+\end{lstlisting}
If only the Registry needs to be restored, then you could use the
following commands in {\bf bconsole}:
-\begin{verbatim}
+\begin{lstlisting}
markdir @SYSTEMSTATE
cd @SYSTEMSTATE
markdir "Registry Writer"
cd "Registry Writer"
mark instance*
mark "Registry"
-\end{verbatim}
+\end{lstlisting}
\subsubsection{Windows Plugins Items to Note}
-\begin{itemize}
+\begin{bsysitemize}
\item Reboot Required after a Plugin Restore\\
In general after any VSS plugin is used to restore a component, you will
need to reboot the system. This is required because in-use files cannot be
up, you must explicitly mention it in a Bacula "File" directive in your
FileSet.
\item When doing a backup that is to be used as a Bare Metal Recovery, do
-not use the VSS plugin. The reason is that during a Bare Metal Recovery,
+not use the VSS plugin. The reason is that during a Bare Metal Recovery,
VSS is not available nor are the writers from the various components that
are needed to do the restore. You might do full backup to be used with
a Bare Metal Recovery once a month or once a week, and all other days,
to restore your system, use the last Full non-VSS backup to restore your
system, and after rebooting do a restore with the VSS plugin to get
everything fully up to date.
-\end{itemize}
+\end{bsysitemize}
\subsubsection{Bare Metal Restore}
Depending on the bare metal restore environment, the VSS writers may not
action}. It is useful to prevent disk based volumes from consuming too much
space.
-\begin{verbatim}
+\begin{lstlisting}
Pool {
Name = Default
Action On Purge = Truncate
...
}
-\end{verbatim}
+\end{lstlisting}
As usual you can also set this property with the \texttt{update volume} command
-\begin{verbatim}
+\begin{lstlisting}
*update volume=xxx ActionOnPurge=Truncate
*update volume=xxx actiononpurge=None
-\end{verbatim}
+\end{lstlisting}
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}
+\begin{lstlisting}
*purge volume action=truncate storage=File allpools
# or by default, action=all
*purge volume action storage=File pool=Default
-\end{verbatim}
+\end{lstlisting}
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}
+\begin{lstlisting}
Job {
Name = CatalogBackup
...
Console = "purge volume action=all allpools storage=File"
}
}
-\end{verbatim}
+\end{lstlisting}
\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.
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
+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.
any job which writes to this storage resource.
For example:
-\begin{verbatim}
+\begin{lstlisting}
Storage {
Name = UltriumTape
Address = ultrium-tape
Media Type = LTO 3
AllowCompression = No # Tape drive has hardware compression
}
-\end{verbatim}
+\end{lstlisting}
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.
attributes to use (time, size, checksum, permission, owner, group, \dots),
similar to the Verify options.
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = Full
Include = {
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{lstlisting}
+
+\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,
To use this feature, you should have readline development package loaded on
your system, and use the following option in configure.
-\begin{verbatim}
+\begin{lstlisting}
./configure --with-readline=/usr/include/readline --disable-conio ...
-\end{verbatim}
+\end{lstlisting}
The new bconsole won't be able to tab-complete with older directors.
It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
\textbf{ReadAll} capabilities should be kept after UID/GID switch.
-\begin{verbatim}
+\begin{lstlisting}
root@localhost:~# bacula-fd -k -u nobody -g nobody
-\end{verbatim}
+\end{lstlisting}
The code for this feature was contributed by our friends at AltLinux.
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}
+\begin{bsysitemize}
\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\_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}
+\end{bsysitemize}
You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
data that will be displayed.
-\begin{verbatim}
+\begin{lstlisting}
* .bvfs_update jobid=1,2
* .bvfs_update
* .bvfs_lsdir path=/ jobid=1,2
-\end{verbatim}
+\end{lstlisting}
This project was funded by Bacula Systems.
\texttt{speed} command available in the \texttt{btape} program.
This command can have the following arguments:
-\begin{itemize}
+\begin{bsysitemize}
\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
\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}
+\end{bsysitemize}
-\begin{verbatim}
+\begin{lstlisting}
*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:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
-\end{verbatim}
+\end{lstlisting}
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
that Bacula uses when writing blocks to a Volume. This is
done by adding:
-\begin{verbatim}
+\begin{lstlisting}
Block Checksum = no
-\end{verbatim}
+\end{lstlisting}
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.
+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
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=13cm]{\idir bat-mediaview.eps}
- \label{fig:mediaview}
-\end{figure}
+%\begin{figure}[htbp]
+% \centering
+% \includegraphics[width=13cm]{\idir
+\bsysimageH{bat-mediaview}{List volumes with BAT}{figbs4: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 \ref{fig:mediainfo}.)
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=13cm]{\idir bat11.eps}
- \caption{Media information}
- \label{fig:mediainfo}
-\end{figure}
+Volume. (cf. figure \bsysref{figbs4:mediainfo}.)
+%\begin{figure}[htbp]
+% \centering
+% \includegraphics[width=13cm]{\idir
+\bsysimageH{bat11}{Media information}{figbs4:mediainfo}
+% \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
-\ref{fig:jobinfo}.)
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=13cm]{\idir bat12.eps}
- \caption{Job information}
- \label{fig:jobinfo}
-\end{figure}
+information panel), you can access a detailed overview of your Job. (cf. figure
+\bsysref{figbs4:jobinfo}.)
+%\begin{figure}[htbp]
+% \centering
+% \includegraphics[width=13cm]{\idir
+\bsysimageH{bat12}{Job information}{figbs4:jobinfo}
+% \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 \ref{fig:jobinfo}.)
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=13cm]{\idir bat13.eps}
- \caption{Autochanger content}
- \label{fig:achcontent}
-\end{figure}
+access a detailed overview of your Autochanger. (cf. figure \bsysref{figbs4:jobinfo}.)
+%\begin{figure}[htbp]
+% \centering
+% \includegraphics[width=13cm]{\idir
+\bsysimageH{bat13}{Autochanger content}{figbs4:achcontent}
+% \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
+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, eventhough it is
installed by default, it does not yet work on 64 bit Windows
\subsection{New Win32 Installer}
The Win32 installer has been modified in several very important
-ways.
-\begin{itemize}
+ways.
+\begin{bsysitemize}
\item You must deinstall any current version of the
-Win32 File daemon before upgrading to the new one.
+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.
+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}.
+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}
+\begin{lstlisting}
cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
-\end{verbatim}
+\end{lstlisting}
\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
+they have not been ported to 64 bits), or you can contact
Bacula Systems about this.
-\end{itemize}
+\end{bsysitemize}
\subsection{Win64 Installer}
We have corrected a number of problems that required manual
\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.
+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
\subsection{Important Changes}
\label{sec:importantchanges}
-\begin{itemize}
+\begin{bsysitemize}
\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.
poll by default).
\item Virtually all the features of {\bf mtx-changer} have
now been parameterized, which allows you to configure
- mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
+ 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
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
+ 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}
+\end{bsysitemize}
\subsubsection*{Truncate volume after purge}
The following items have been \textbf{deprecated} for a long time, and are now
removed from the code.
-\begin{itemize}
+\begin{bsysitemize}
\item Gnome console
\item Support for SQLite 2
-\end{itemize}
+\end{bsysitemize}
\subsection{Misc Changes}
\label{sec:miscchanges}
-\begin{itemize}
+\begin{bsysitemize}
\item Updated Nagios check\_bacula
\item Updated man files
\item Added OSX package generation script in platforms/darwin
\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}
+\end{bsysitemize}
\subsection{Full Restore from a Given JobId}
\index[general]{Restore menu}
and including the selected date (through JobId).
Assume we start with the following jobs:
-\begin{verbatim}
+\begin{lstlisting}
+-------+--------------+---------------------+-------+----------+------------+
| 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}
+\end{lstlisting}
Below is an example of this new feature (which is number 12 in the
menu).
-\begin{verbatim}
+\begin{lstlisting}
* restore
To select the JobIds, you have the following choices:
1: List last 20 Jobs run
Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1,444 files inserted into the tree.
-\end{verbatim}
+\end{lstlisting}
This project was funded by Bacula Systems.
\subsection{Source Address}
-\index[general]{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
networks utilizing multi-homing and policy-routing.
To accomplish this, two new configuration directives have been implemented:
-\begin{verbatim}
+\begin{lstlisting}
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}
+\end{lstlisting}
Simply adding specific host routes on the OS
would have an undesirable side-effect: any
When doing a restore the selection dialog ends by displaying this
screen:
-\begin{verbatim}
+\begin{lstlisting}
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
+ *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}
+\end{lstlisting}
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.
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}
+\begin{lstlisting}
* estimate listing accurate=yes level=incremental job=BackupJob
-\end{verbatim}
+\end{lstlisting}
This project was funded by Bacula Systems.
\subsection{Accurate Backup}
-\index[general]{Accurate Backup}
+\index[general]{Accurate backup}
As with most other backup programs, by default Bacula decides what files to
backup for Incremental and Differental backup by comparing the change
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.
+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)
will probably not work correctly.
This project was funded by Bacula Systems.
-
+
\subsection{Copy Jobs}
-\index[general]{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
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}
+\begin{lstlisting}
* restore copies
[...]
These JobIds have copies as follows:
Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
5,611 files inserted into the tree.
...
-\end{verbatim}
+\end{lstlisting}
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.
+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.
+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
called disk-to-disk-to-tape backup (DTDTT). A sample config could
look something like the one below:
-\begin{verbatim}
+\begin{lstlisting}
Pool {
Name = FullBackupsVirtualPool
Pool Type = Backup
Pool = FullBackupsVirtualPool
JobDefs = CopyDiskToTape
}
-\end{verbatim}
+\end{lstlisting}
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
The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
\textbf{jobid}.
-\begin{verbatim}
+\begin{lstlisting}
*list copies
+-------+------------------------------------+-----------+------------------+
| JobId | Job | CopyJobId | MediaType |
+-------+------------------------------------+-----------+------------------+
| 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
+-------+------------------------------------+-----------+------------------+
-\end{verbatim}
+\end{lstlisting}
\subsection{ACL Updates}
-\index[general]{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
Currently the following platforms support ACLs:
-\begin{itemize}
+\begin{bsysitemize}
\item {\bf AIX}
\item {\bf Darwin/OSX}
\item {\bf FreeBSD}
\item {\bf Linux}
\item {\bf Tru64}
\item {\bf Solaris}
-\end{itemize}
+\end{bsysitemize}
Currently we support the following ACL types (these ACL streams use a reserved
part of the stream numbers):
-\begin{itemize}
+\begin{bsysitemize}
\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 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}
+\end{bsysitemize}
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 convertable. For now
recognize them will give you a warning.
\subsection{Extended Attributes}
-\index[general]{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
security labels.
Currently the following platforms support extended attributes:
-\begin{itemize}
+\begin{bsysitemize}
\item {\bf Darwin/OSX}
\item {\bf FreeBSD}
\item {\bf Linux}
\item {\bf NetBSD}
-\end{itemize}
+\end{bsysitemize}
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
To enable the backup of extended attributes please add the following to your
fileset definition.
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "MyFileSet"
Include {
File = ...
}
}
-\end{verbatim}
+\end{lstlisting}
\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.
+(.so) rather than static libraries as was previously the case.
The shared libraries are built using {\bf libtool} so it should be quite
portable.
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}
+\begin{lstlisting}
./configure --libdir=/full-path/dir
-\end{verbatim}
+\end{lstlisting}
the default is /usr/lib. If {-}{-}libdir is specified, there should be
no need to modify your loader configuration provided that
does this with the make install command). The shared objects
that Bacula references are:
-\begin{verbatim}
+\begin{lstlisting}
libbaccfg.so
libbacfind.so
libbacpy.so
libbac.so
-\end{verbatim}
+\end{lstlisting}
These files are symbolically linked to the real shared object file,
which has a version number to permit running multiple versions of
version of Bacula you may disable
libtool on the configure command line with:
-\begin{verbatim}
+\begin{lstlisting}
./configure --disable-libtool
-\end{verbatim}
+\end{lstlisting}
\subsection{Building Static versions of Bacula}
to configuration options that were needed you now must
also add --disable-libtool. Example
-\begin{verbatim}
+\begin{lstlisting}
./configure --enable-static-client-only --disable-libtool
-\end{verbatim}
+\end{lstlisting}
\subsection{Virtual Backup (Vbackup)}
-\index[general]{Virtual Backup}
+\index[general]{Virtual backup}
\index[general]{Vbackup}
Bacula's virtual backup feature is often called Synthetic Backup or
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
+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
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
+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 typical Job resource definition might look like the following:
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = "MyBackup"
Type = Backup
Maximum Concurrent Jobs = 4
Autochanger = yes
}
-\end{verbatim}
+\end{lstlisting}
Then in bconsole or via a Run schedule, you would run the job as:
-\begin{verbatim}
+\begin{lstlisting}
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}
+\end{lstlisting}
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
To consolidate those backups into a new Full backup, you would run the
following:
-\begin{verbatim}
+\begin{lstlisting}
run job=MyBackup level=VirtualFull
-\end{verbatim}
+\end{lstlisting}
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.
\subsection{Catalog Format}
-\index[general]{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
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
+backup of your database before executing the upgrade script. See the
ReleaseNotes for additional details.
\subsection{64 bit Windows Client}
-\index[general]{Win64 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.
+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.
+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
+ 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
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
+ 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
+\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
\subsection{Duplicate Job Control}
-\index[general]{Duplicate Jobs}
+\index[general]{Duplicate jobs}
The new version of Bacula provides four new directives that
-give additional control over what Bacula does if duplicate jobs
+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
+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
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
cancelling a job, then the current job (the second one started)
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}.
+ The default is {\bf no}.
\subsection{TLS Authentication}
-\index[general]{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,
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
+encryption (TLS Enable, TLS Verify Peer, TLS Certificate, \ldots{}) and
a new directive:
\subsubsection{TLS Authenticate = yes}
-\begin{verbatim}
+\begin{lstlisting}
TLS Authenticate = yes
-\end{verbatim}
+\end{lstlisting}
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
+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.
\subsection{bextract non-portable Win32 data}
\index[general]{bextract handles Win32 non-portable data}
+\index[general]{Win32!bextract handles non-portable data}
{\bf bextract} has been enhanced to be able to restore
-non-portable Win32 data to any OS. Previous versions were
+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}
+\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
new Options directive within a FileSet resource, which instructs Bacula to
obey this flag. The new directive is:
-\begin{verbatim}
+\begin{lstlisting}
Honor No Dump Flag = yes\vb{}no
-\end{verbatim}
+\end{lstlisting}
The default value is {\bf no}.
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}
+\begin{lstlisting}
# List of files to be backed up
FileSet {
Name = "MyFileSet"
Exclude Dir Containing = .excludeme
}
}
-\end{verbatim}
+\end{lstlisting}
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
+the user or sysadmin creates a file named {\bf .excludeme} in
specific directories, such as
-\begin{verbatim}
+\begin{lstlisting}
/home/user/www/cache/.excludeme
/home/user/temp/.excludeme
-\end{verbatim}
+\end{lstlisting}
then Bacula will not backup the two directories named:
-\begin{verbatim}
+\begin{lstlisting}
/home/user/www/cache
/home/user/temp
-\end{verbatim}
+\end{lstlisting}
NOTE: subdirectories will not be backed up. That is, the directive
applies to the two directories in question and any children (be they
Bacula values, and send messages to the Job output or debug output.
The exact definition as of this writing is:
-\begin{verbatim}
+\begin{lstlisting}
typedef struct s_baculaFuncs {
uint32_t size;
uint32_t version;
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 (*AddWildToInclude)(bpContext *ctx, const char *item, int type);
} bFuncs;
-\end{verbatim}
+\end{lstlisting}
\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
+ 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,
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.
+ 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
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
+ 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.
\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}
-
+
\end{description}
-
+
\subsubsection{Bacula events}
The list of events has been extended to include:
-\begin{verbatim}
+\begin{lstlisting}
typedef enum {
bEventJobStart = 1,
bEventJobEnd = 2,
bEventRestoreCommand = 10,
bEventLevel = 11,
bEventSince = 12,
-
+
/* New events */
bEventCancelCommand = 13,
bEventVssBackupAddComponents = 14,
bEventPluginCommand = 19
} bEventType;
-\end{verbatim}
+\end{lstlisting}
\begin{description}
\item [bEventCancelCommand] is called whenever the currently
running Job is cancelled
-\item [bEventVssBackupAddComponents]
+\item [bEventVssBackupAddComponents]
\item [bEventPluginCommand] is called for each PluginCommand present in the
current FileSet. The event will be sent only on plugin specifed in the
- command. The argument is the PluginCommand (read-only).
+ command. The argument is the PluginCommand (read-only).
\end{description}
get control to backup and restore a file.
Plugins are also planned (partially implemented) in the Director and the
-Storage daemon.
+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
+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.
+can share the same plugin directory.
\subsubsection{Plugin Options}
\index[general]{Plugin Options}
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
+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
\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
+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.
a FileSet resource where you put your {\bf File = xxx} directives.
For example:
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "MyFileSet"
Include {
Plugin = "bpipe:..."
}
}
-\end{verbatim}
+\end{lstlisting}
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}
plugin.
\subsection{The bpipe Plugin}
-\index[general]{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}.
plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
to specify the sytax as it wishes) is:
-\begin{verbatim}
+\begin{lstlisting}
Plugin = "<field1>:<field2>:<field3>:<field4>"
-\end{verbatim}
+\end{lstlisting}
where
\begin{description}
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
+\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.
+{\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.
+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
+or output, \ldots{}), 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.
Putting it all together, the full plugin directive line might look
like the following:
-\begin{verbatim}
-Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
+\begin{lstlisting}
+Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
--opt --databases bacula:mysql"
-\end{verbatim}
+\end{lstlisting}
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
+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.
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
+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},
on the program called.
\subsection{Microsoft Exchange Server 2003/2007 Plugin}
-\index[general]{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.
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
+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
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)",
+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
although the folders the files are in should be included, or they will
have to be recreated manually if a baremetal restore is done.
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Include {
File = C:/Program Files/Exchsrvr/mdbdata
File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
}
}
-\end{verbatim}
+\end{lstlisting}
The advantage of excluding the above files is that you can significantly
reduce the size of your backup since all the important Exchange files
The restore operation is much the same as a normal Bacula restore, with
the following provisos:
-\begin{itemize}
+\begin{bsysitemize}
\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.
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}
+\end{bsysitemize}
\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
+\elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
+but to briefly summarize\ldots{}
Microsoft Exchange allows the creation of an additional Storage Group
called the Recovery Storage Group, which is used to restore an older
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
+{\bf "New -> Recovery Storage Group\ldots{}"}. 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
+select {\bf "Add Database to Recover\ldots{}"} and select the database you will
be restoring.
Restore only the single database nominated as the database in the
\subsection{libdbi Framework}
-\index[general]{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
supported by Bacula, however, they must be tested properly by the Bacula team.
Some of benefits of using libdbi are:
-\begin{itemize}
+\begin{bsysitemize}
\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.
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}
-
+ \end{bsysitemize}
+
The following drivers have been tested:
- \begin{itemize}
+ \begin{bsysitemize}
\item PostgreSQL, with and without batch insert
\item Mysql, with and without batch insert
\item SQLite
\item SQLite3
- \end{itemize}
+ \end{bsysitemize}
In the future, we will test and approve to use others databases engines
(proprietary or not) like DB2, Oracle, Microsoft SQL.
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}
+\begin{lstlisting}
Catalog {
Name = MyCatalog
dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
dbname = regress; user = regress; password = ""
}
-\end{verbatim}
+\end{lstlisting}
The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
mysql database. Currently the drivers supported by Bacula are: postgresql,
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
+ - 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}
+ \begin{bsysitemize}
\item libdbi version 1.0.0, http://libdbi.sourceforge.net/
\item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
- \end{itemize}
-
+ \end{bsysitemize}
+
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}
+\index[general]{Console additions}
\subsubsection{Display Autochanger Content}
\index[general]{StatusSlots}
autochanger content.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
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}
+\end{lstlisting}
\normalsize
If you an asterisk ({\bf *}) appears after the slot number, you must run an
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
+Note for the catalog to have Job Log entries, you must have a directive
such as:
-\begin{verbatim}
+\begin{lstlisting}
catalog = all
-\end{verbatim}
+\end{lstlisting}
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
+\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}
+\begin{lstlisting}
!$%&'()*+,-/:;<>?[]^`{|}~
-\end{verbatim}
+\end{lstlisting}
\subsubsection{Deleting Volumes}
The delete volume bconsole command has been modified to
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
+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.
+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.
+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.
+ 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.
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 ...
+ to the main manual. See below \ldots{}
\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}
+\index[general]{Misc new features}
\subsubsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
\index[general]{Allow Mixed Priority}
be run until the priority 5 job has finished.
\subsubsection{Bootstrap File Directive -- FileRegex}
-\index[general]{Bootstrap File Directive}
+\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.
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}
+\begin{lstlisting}
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}
+\end{lstlisting}
\subsubsection{Bootstrap File Optimization Changes}
In order to permit proper seeking on disk files, we have extended the bootstrap
\subsubsection{Virtual Tape Emulation}
-\index[general]{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
used for production.
\subsubsection{Bat Enhancements}
-\index[general]{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
+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
work.
\subsubsection{RunScript Enhancements}
-\index[general]{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}
+\begin{lstlisting}
Job {
Name = aJob
RunScript {
}
...
}
-\end{verbatim}
+\end{lstlisting}
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
+{\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}
+\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}
+\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}
+\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
+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.
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,
+\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.
\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{}}
+\subsubsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
\index[general]{Incremental Max Wait Time}
\index[general]{Differential Max Wait Time}
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}
-\includegraphics{\idir different_time.eps}
+%\addcontentsline{lof}{figure}{Job time control directives}
+\bsysimageH{different_time}{Job time control directives}{}
+%\includegraphics{\idir different_time}
\subsubsection{Statistics Enhancements}
-\index[general]{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}
+\begin{bsysitemize}
\item jobs have run
\item jobs have been successful
\item files have been backed up
-\item ...
-\end{itemize}
+\item \ldots{}
+\end{bsysitemize}
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.
+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
You can use the following Job resource in your nightly \textbf{BackupCatalog}
job to maintain statistics.
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = BackupCatalog
...
RunsOnClient = no
}
}
-\end{verbatim}
+\end{lstlisting}
\subsubsection{ScratchPool = \lt{}pool-resource-name\gt{}}
-\index[general]{ScratchPool}
+\index[general]{Scratch Pool}
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}
+\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}
+\index[general]{Spool Size}
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}
+\index[general]{Maximum Console Connections}
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{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.
+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
+\begin{lstlisting}
+ $ dbcheck -B
catalog=MyCatalog
db_type=SQLite
db_name=regress
db_address=
db_port=0
db_socket=
-\end{verbatim} %$
+\end{lstlisting} %$
You can now specify the database connection port in the command line.
\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
+LICENSE, ReleaseNotes, ChangeLog, \ldots{} 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
configure the number of reload requests that can be done while jobs are
running.
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = localhost-dir
Maximum Reload Requests = 64
...
}
-\end{verbatim}
+\end{lstlisting}
\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
+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
+``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 \texttt{FDStorageAddress} Storage
+this parameter using the new \texttt{FDStorageAddress} Storage
% or Client
directive.
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=10cm]{\idir BackupOverWan1}
- \label{fig:fdstorageaddress}
- \caption{Backup over WAN}
-\end{figure}
+\bsysimageH{BackupOverWan1}{Backup Over WAN}{figbs6:fdstorageaddress}
+% \label{fig:fdstorageaddress}
-\begin{verbatim}
+\begin{lstlisting}
Storage {
Name = storage1
Address = 65.1.1.1
SD Port 9103
...
}
-\end{verbatim}
+\end{lstlisting}
% # or in the Client resouce
-%
+%
% Client {
% Name = client1
% Address = 65.1.1.2
% FD Port 9103
% ...
% }
-% \end{verbatim}
-%
+% \end{lstlisting}
+%
% 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}.
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.
+simultaneous Copy, Migration, and VirtualFull jobs.
\smallskip
The default value is set to 0 (zero), which means there is no
list of running jobs allowing you to select one, which might
look like the following:
-\begin{verbatim}
+\begin{lstlisting}
*stop
Select Job:
1: JobId=3 Job=Incremental.2012-03-26_12.04.26_07
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}
+\end{lstlisting}
\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 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.
If you enter the {\bf restart} command in bconsole, you will get the
following prompts:
-\begin{verbatim}
+\begin{lstlisting}
*restart
You have the following choices:
1: Incomplete
2: Canceled
3: Failed
4: All
-Select termination code: (1-4):
-\end{verbatim}
+Select termination code: (1-4):
+\end{lstlisting}
If you select the {\bf All} option, you may see something like:
-\begin{verbatim}
+\begin{lstlisting}
Select termination code: (1-4): 4
+-------+-------------+---------------------+------+-------+----------+-----------+-----------+
| jobid | name | starttime | type | level | jobfiles |
| 4 | Incremental | 2012-03-26 12:18:38 | B | F | 331 |
3,548,058 | I |
+-------+-------------+---------------------+------+-------+----------+-----------+-----------+
-Enter the JobId list to select:
-\end{verbatim}
+Enter the JobId list to select:
+\end{lstlisting}
-Then you may enter one or more JobIds to be restarted, which may
+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.
Enterprise Edition.
\subsection{Support for MSSQL Block Level Backups}
-With the addition of block level backup support to the
+With the addition of block level backup support to the
Bacula Enterprise VSS MSSQL component, you can now do
Differential backups in addition to Full backups.
Differential backups use Microsoft's partial block backup
This partial block backup permits backing up only those
blocks that have changed. Database restores can be made while
the MSSQL server is running, but any databases selected for
-restore will be automatically taken offline by the MSSQL
+restore will be automatically taken offline by the MSSQL
server during the restore process.
Incremental backups for MSSQL are not support by
Microsoft. We strongly recommend that you not perform Incremental
backups with MSSQL as they will probably produce a situation
-where restore will no longer work correctly.
+where restore will no longer work correctly.
\smallskip
We are currently working on producing a white paper that will give more
\smallskip
It is possible to restore the {\bf master} database, but you must
-first shutdown the MSSQL server, then you must perform special
+first shutdown the MSSQL server, then you must perform special
recovery commands. Please see Microsoft documentation on how
to restore the master database.
that File daemon, or it can be set for each Job in the Director's conf file.
For example:
-\begin{verbatim}
+\begin{lstlisting}
FileDaemon {
Name = localhost-fd
Working Directory = /some/path
...
Maximum Bandwidth Per Job = 5Mb/s
}
-\end{verbatim}
+\end{lstlisting}
The above example would cause any jobs running with the FileDaemon to not
exceed 5Mb/s of throughput when sending data to the Storage Daemon.
You can specify the speed parameter in k/s, Kb/s, m/s, Mb/s.
For example:
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = locahost-data
FileSet = FS_localhost
Maximum Bandwidth = 5Mb/s
...
}
-\end{verbatim}
+\end{lstlisting}
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}
+\begin{lstlisting}
* setbandwidth limit=1000000 jobid=10
-\end{verbatim}
+\end{lstlisting}
The \texttt{limit} parameter is in Kb/s.
platform including Windows 32 and 64bit.
Accurate option should be turned on in the Job resource.
-\begin{verbatim}
+\begin{lstlisting}
Job {
Accurate = yes
FileSet = DeltaFS
}
}
-\end{verbatim}
+\end{lstlisting}
Please contact Bacula Systems support to get Delta Plugin specific
documentation.
\texttt{update slots} command. This script can be scheduled once a day in
an Admin job.
-\begin{verbatim}
+\begin{lstlisting}
$ /opt/bacula/scripts/reset-storageid MediaType StorageName
$ bconsole
* update slots storage=StorageName drive=0
-\end{verbatim}
+\end{lstlisting}
Please contact Bacula Systems support to get help on this advanced
configuration.
On some NDMP devices such as Celera or Blueray, the administrator can use arbitrary
volume structure name, ex:
-\begin{verbatim}
+\begin{lstlisting}
/dev/volume_home
/rootvolume/volume_tmp
/VG/volume_var
-\end{verbatim}
+\end{lstlisting}
The NDMP plugin should be aware of the structure organization in order to
detect if the administrator wants to restore in a new volume
(\texttt{where=/dev/vol\_tmp}) or inside a subdirectory of the targeted volume
(\texttt{where=/tmp}).
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = NDMPFS
...
Plugin = "ndmp:host=nasbox user=root pass=root file=/dev/vol1 volume_format=/dev/"
}
}
-\end{verbatim}
+\end{lstlisting}
Please contact Bacula Systems support to get NDMP Plugin specific
documentation.
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}
+\begin{lstlisting}
Job {
Name = ...
FileSet = FS_Example
}
...
}
-\end{verbatim}
+\end{lstlisting}
This project was funded by Bacula Systems based on an idea of James Harper and
is available with the Bacula Enterprise Edition.
You are now able to specify the Accurate mode on the \texttt{run} command and
in the Schedule resource.
-\begin{verbatim}
+\begin{lstlisting}
* run accurate=yes job=Test
-\end{verbatim}
+\end{lstlisting}
-\begin{verbatim}
+\begin{lstlisting}
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}
+\end{lstlisting}
It can allow you to save memory and and CPU resources on the catalog server in
some cases.
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}
+\begin{lstlisting}
RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h Dir=%D"
-\end{verbatim}
+\end{lstlisting}
\subsection{LZO Compression}
{\bf compression=LZO}).
For example:
-\begin{verbatim}
+\begin{lstlisting}
Include {
Options { compression=LZO }
File = /home
File = /data
}
-\end{verbatim}
+\end{lstlisting}
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
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}
+\begin{bsysitemize}
\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}
+\end{bsysitemize}
Note that bacula only use one compression level LZO1X-1.
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
+this new version allows you to run Backups from
the tray monitor menu.
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=10cm]{\idir tray-monitor}
- \label{fig:traymonitor}
- \caption{New tray monitor}
-\end{figure}
+%\begin{figure}[htbp]
+% \centering
+% \includegraphics[width=10cm]{\idir
+\bsysimageH{tray-monitor}{New tray monitor}{figbs6:traymonitor}
+% \label{fig:traymonitor}
+% \caption{New tray monitor}
+%\end{figure}
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=10cm]{\idir tray-monitor1}
- \label{fig:traymonitor1}
- \caption{Run a Job through the new tray monitor}
-\end{figure}
+%\begin{figure}[htbp]
+% \centering
+\bsysimageH{tray-monitor1}{Run a Job through the new tray monitor}{figbs6:traymonitor1}
+% \includegraphics[width=10cm]{\idir 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}
+\begin{lstlisting}
Console {
Name = win2003-mon
Password = "xxx"
FileSetACL = *all*
WhereACL = *all*
}
-\end{verbatim}
+\end{lstlisting}
\medskip
This project was funded by Bacula Systems and is available with Bacula
\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
+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}
+\begin{lstlisting}
Job {
Name = "migrate-job"
Type = Migrate
...
Purge Migration Job = yes
}
-\end{verbatim}
+\end{lstlisting}
\medskip
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}
+\begin{lstlisting}
JobId: 1 Level: Full
JobId: 2 Level: Incremental
JobId: 3 Level: Incremental
JobId: 4 Level: Differential
.. Other incrementals up to now
-\end{verbatim}
+\end{lstlisting}
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
To verify a given job, just specify the Job jobid in argument when starting the
job.
-\begin{verbatim}
+\begin{lstlisting}
*run job=VerifyVolume jobid=1 level=VolumeToCatalog
Run Verify job
JobName: VerifyVolume
When: 2010-09-08 14:17:31
Priority: 10
OK to run? (yes/mod/no):
-\end{verbatim}
+\end{lstlisting}
\medskip
This project was funded by Bacula Systems and is available with Bacula
\chapter{New Features in 5.2.x}
This chapter presents the new features that have been added to the next
-Community version of Bacula that is not yet released.
+Community version of \mbacula{} that is not yet released.
\section{New Features in 5.2.2}
This chapter presents the new features that have been added to the current
-Community version of Bacula that is now released.
+Community version of \mbacula{} 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}
+\begin{lstlisting}
+RunAfterJob = "/bin/echo Director=%D
+\end{lstlisting}
\section{New Features in 5.2.1}
This chapter presents the new features were added in the
{\bf compression=LZO}).
For example:
-\begin{verbatim}
+\begin{lstlisting}
Include {
Options { compression=LZO }
File = /home
File = /data
}
-\end{verbatim}
+\end{lstlisting}
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
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}
+\begin{bsysitemize}
\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}
+\end{bsysitemize}
-Note, Bacula uses compression level LZO1X-1.
+Note, \mbacula{} uses compression level LZO1X-1.
\medskip
The code for this feature was contributed by Laurent Papier.
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
+this new version allows you to run Backups from
the tray monitor menu.
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=10cm]{\idir tray-monitor}
- \label{fig:traymonitor}
- \caption{New tray monitor}
-\end{figure}
-
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=10cm]{\idir tray-monitor1}
- \label{fig:traymonitor1}
- \caption{Run a Job through the new tray monitor}
-\end{figure}
-
+%\begin{figure}[htbp]
+% \centering
+% \includegraphics[width=10cm]{\idir tray-monitor}
+\bsysimageH{tray-monitor}{New tray monitor}{figcom:traymonitor}
+% \label{figcom:traymonitor}
+% \caption{New tray monitor}
+%\end{figure}
+
+%% \begin{figure}[htbp]
+%% \centering
+%% \includegraphics[width=10cm]{\idir tray-monitor1}
+%% \label{figcom:traymonitor1}
+%% \caption{Run a Job through the new tray monitor}
+%% \end{figure}
+\bsysimageH{tray-monitor1}{Run a Job through the new tray monitor}{figcom:traymonitor1}
To be able to run a job from the tray monitor, you need to
allow specific commands in the Director monitor console:
-\begin{verbatim}
+\begin{lstlisting}
Console {
Name = win2003-mon
Password = "xxx"
FileSetACL = *all*
WhereACL = *all*
}
-\end{verbatim}
+\end{lstlisting}
\medskip
This project was funded by Bacula Systems and is available with Bacula
\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
+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}
+\begin{lstlisting}
Job {
Name = "migrate-job"
Type = Migrate
...
Purge Migration Job = yes
}
-\end{verbatim}
+\end{lstlisting}
\medskip
Bat has now a bRestore panel that uses Bvfs to display files and
directories.
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=12cm]{\idir bat-brestore}
- \label{fig:batbrestore}
- \caption{Bat Brestore Panel}
-\end{figure}
+%% \begin{figure}[htbp]
+%% \centering
+%% \includegraphics[width=12cm]{\idir
+%% \label{figcom:batbrestore}
+%% \caption{Bat Brestore Panel}
+%% \end{figure}
+\bsysimageH{bat-brestore}{Bat Brestore Panel}{figcom:batbrestore}
the Bvfs module works correctly with BaseJobs, Copy and Migration jobs.
\subsubsection*{General notes}
-\begin{itemize}
+\begin{bsysitemize}
\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 fields are separated by a tab
\item Due to potential encoding problem, it's advised to always use pathid in
queries.
-\end{itemize}
+\end{bsysitemize}
\subsubsection*{Get dependent jobs from a given JobId}
To get all JobId needed to restore a particular job, you can use the
\texttt{.bvfs\_get\_jobids} command.
-\begin{verbatim}
+\begin{lstlisting}
.bvfs_get_jobids jobid=num [all]
-\end{verbatim}
+\end{lstlisting}
-\begin{verbatim}
+\begin{lstlisting}
.bvfs_get_jobids jobid=10
1,2,5,10
.bvfs_get_jobids jobid=10 all
1,2,3,5,10
-\end{verbatim}
+\end{lstlisting}
In this example, a normal restore will need to use JobIds 1,2,5,10 to
compute a complete restore of the system.
The \texttt{.bvfs\_update} command computes the directory cache for jobs
specified in argument, or for all jobs if unspecified.
-\begin{verbatim}
+\begin{lstlisting}
.bvfs_update [jobid=numlist]
-\end{verbatim}
+\end{lstlisting}
Example:
-\begin{verbatim}
+\begin{lstlisting}
.bvfs_update jobid=1,2,3
-\end{verbatim}
+\end{lstlisting}
You can run the cache update process in a RunScript after the catalog backup.
function uses only PathId and FilenameId. The jobid argument is mandatory but
unused.
-\begin{verbatim}
+\begin{lstlisting}
.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}
+\end{lstlisting}
Example:
-\begin{verbatim}
+\begin{lstlisting}
.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}
+\end{lstlisting}
\subsubsection*{List directories}
Bvfs allows you to list directories in a specific path.
-\begin{verbatim}
+\begin{lstlisting}
.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}
+\end{lstlisting}
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}
+\begin{lstlisting}
.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}
+\end{lstlisting}
In this example, to list directories present in \texttt{regress/}, you can use
-\begin{verbatim}
+\begin{lstlisting}
.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}
+\end{lstlisting}
\subsubsection*{List files}
Bvfs allows you to list files in a specific path.
-\begin{verbatim}
+\begin{lstlisting}
.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}
+\end{lstlisting}
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}
+\begin{lstlisting}
.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}
+\end{lstlisting}
In this example, to list files present in \texttt{regress/}, you can use
-\begin{verbatim}
+\begin{lstlisting}
.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}
+\end{lstlisting}
\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}
+\begin{lstlisting}
.bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
OK
restore file=?b2num ...
-\end{verbatim}
+\end{lstlisting}
To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
select all files. This query could be time consuming.
Example:
-\begin{verbatim}
+\begin{lstlisting}
.bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
OK
-\end{verbatim}
+\end{lstlisting}
\subsubsection*{Cleanup after Restore}
To drop the table used by the restore command, you can use the
\texttt{.bvfs\_cleanup} command.
-\begin{verbatim}
+\begin{lstlisting}
.bvfs_cleanup path=b20001
-\end{verbatim}
+\end{lstlisting}
\subsubsection*{Clearing the BVFS Cache}
To clear the BVFS cache, you can use the \texttt{.bvfs\_clear\_cache} command.
-\begin{verbatim}
+\begin{lstlisting}
.bvfs_clear_cache yes
OK
-\end{verbatim}
+\end{lstlisting}
\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
+not be longer the case. Now, \mbacula{} won't prune automatically a Job if this
particular Job is needed to restore data. Example:
-\begin{verbatim}
+\begin{lstlisting}
JobId: 1 Level: Full
JobId: 2 Level: Incremental
JobId: 3 Level: Incremental
JobId: 4 Level: Differential
.. Other incrementals up to now
-\end{verbatim}
+\end{lstlisting}
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
+resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, \mbacula{} 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{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
+You now have the ability to tell \mbacula{} 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}
+\begin{lstlisting}
*run job=VerifyVolume jobid=1 level=VolumeToCatalog
Run Verify job
JobName: VerifyVolume
When: 2010-09-08 14:17:31
Priority: 10
OK to run? (yes/mod/no):
-\end{verbatim}
+\end{lstlisting}
\medskip
This project was funded by Bacula Systems and is available with Bacula
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}
+\begin{lstlisting}
RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
-\end{verbatim}
+\end{lstlisting}
%\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}
+%\begin{lstlisting}
%File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
-%\end{verbatim}
+%\end{lstlisting}
%
\subsection{Additions to the Plugin API}
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 bFuncs structure defines the callback entry points within \mbacula{}
+that the plugin can use register events, get \mbacula{} values, set
+\mbacula{} values, and send messages to the Job output or debug output.
The exact definition as of this writing is:
-\begin{verbatim}
+\begin{lstlisting}
typedef struct s_baculaFuncs {
uint32_t size;
uint32_t version;
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 (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
} bFuncs;
-\end{verbatim}
+\end{lstlisting}
\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
+ 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,
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.
+ 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
+ not be also backed up by the main \mbacula{} 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
+ 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.
\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
+\item [checkChanges] call the \texttt{check\_changes()} function in \mbacula{} 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}
+\begin{lstlisting}
typedef enum {
bEventJobStart = 1,
bEventJobEnd = 2,
bEventRestoreCommand = 10,
bEventLevel = 11,
bEventSince = 12,
-
+
/* New events */
bEventCancelCommand = 13,
bEventVssBackupAddComponents = 14,
bEventVssPrepareSnapshot = 21
} bEventType;
-\end{verbatim}
+\end{lstlisting}
\begin{description}
\item [bEventCancelCommand] is called whenever the currently
running Job is canceled */
-\item [bEventVssBackupAddComponents]
+\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
\subsection{ACL enhancements}
-The following enhancements are made to the Bacula Filed with regards to
+The following enhancements are made to the \mbacula{} Filed with regards to
Access Control Lists (ACLs)
-\begin{itemize}
+\begin{bsysitemize}
\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
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}
+\end{bsysitemize}
\medskip
This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
\subsection{XATTR enhancements}
-The following enhancements are made to the Bacula Filed with regards to
+The following enhancements are made to the \mbacula{} Filed with regards to
Extended Attributes (XATTRs)
-\begin{itemize}
+\begin{bsysitemize}
\item Added support for IRIX extended attributes using the attr\_get interface.
\item Added support for Tru64 (OSF1) extended attributes using the
getproplist interface.
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}
+\end{bsysitemize}
\medskip
This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
\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
+The main \mbacula{} Director code is independent of the SQL backend
+in version 5.2.0 and greater. This means that the \mbacula{} 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}
+\begin{lstlisting}
--with-sqlite3
--with-mysql
--with-postgresql
-\end{verbatim}
+\end{lstlisting}
Order of testing for databases is:
-\begin{itemize}
+\begin{bsysitemize}
\item postgresql
\item mysql
\item sqlite3
-\end{itemize}
+\end{bsysitemize}
Each configured backend generates a file named:
\verb+libbaccats-<sql_backend_name>-<version>.so+
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}
+An actual command, depending on your \mbacula{} version might be:
+\begin{lstlisting}
cp libbaccats-postgresql-5.2.2.so libbaccats-5.2.2.so
-\end{verbatim}
+\end{lstlisting}
-where the \verb+5.2.2+ must be replaced by the Bacula release
+where the \verb+5.2.2+ must be replaced by the \mbacula{} release
version number.
Then you must update the default backend in the following files:
-\begin{verbatim}
+\begin{lstlisting}
create_bacula_database
drop_bacula_database
drop_bacula_tables
make_bacula_tables
make_catalog_backup
update_bacula_tables
-\end{verbatim}
+\end{lstlisting}
And re-run all the above scripts. Please note, this means
you will have a new empty database and if you had a previous
the ongoing development process.
\subsection{Truncate Volume after Purge}
-\label{sec:actiononpurge}
+\label{seccom: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}
+\begin{lstlisting}
Pool {
Name = Default
Action On Purge = Truncate
...
}
-\end{verbatim}
+\end{lstlisting}
As usual you can also set this property with the \texttt{update volume} command
-\begin{verbatim}
+\begin{lstlisting}
*update volume=xxx ActionOnPurge=Truncate
*update volume=xxx actiononpurge=None
-\end{verbatim}
+\end{lstlisting}
-To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
+To ask \mbacula{} 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}
+\begin{lstlisting}
*purge volume action=truncate storage=File allpools
# or by default, action=all
*purge volume action storage=File pool=Default
-\end{verbatim}
+\end{lstlisting}
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}
+\begin{lstlisting}
Job {
Name = CatalogBackup
...
Console = "purge volume action=all allpools storage=File"
}
}
-\end{verbatim}
+\end{lstlisting}
\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.
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
+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}
+\label{seccom:maximumconcurrentjobdevice}
{\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
Daemon configuration permits setting the maximum number of Jobs that can
\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
+Daemon. Now, \mbacula{} 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
+your incremental jobs use another Storage Daemon with lots of disks, \mbacula{}
will switch automatically from one Storage Daemon to an other within the same
Restore job.
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
+win for the user, it makes \mbacula{} 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
any job which writes to this storage resource.
For example:
-\begin{verbatim}
+\begin{lstlisting}
Storage {
Name = UltriumTape
Address = ultrium-tape
Media Type = LTO 3
AllowCompression = No # Tape drive has hardware compression
}
-\end{verbatim}
+\end{lstlisting}
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 project was funded by Collaborative Fusion, Inc.
\subsection{Accurate Fileset Options}
-\label{sec:accuratefileset}
+\label{seccom: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}
+\begin{lstlisting}
FileSet {
Name = Full
Include = {
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{lstlisting}
+
+\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
+deduplication. By default, \mbacula{} will check modification/creation time
and size.
This project was funded by Bacula Systems.
\subsection{Tab-completion for Bconsole}
-\label{sec:tabcompletion}
+\label{seccom: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
To use this feature, you should have readline development package loaded on
your system, and use the following option in configure.
-\begin{verbatim}
+\begin{lstlisting}
./configure --with-readline=/usr/include/readline --disable-conio ...
-\end{verbatim}
+\end{lstlisting}
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}
+\label{seccom:poolfilejobretention}
We added two new Pool directives, \texttt{FileRetention} and
\texttt{JobRetention}, that take precedence over Client directives of the same
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
+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}
+\label{seccom: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}
+\begin{lstlisting}
root@localhost:~# bacula-fd -k -u nobody -g nobody
-\end{verbatim}
+\end{lstlisting}
The code for this feature was contributed by our friends at AltLinux.
\subsection{Bvfs API}
-\label{sec:bvfs}
+\label{seccom: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}
+\begin{bsysitemize}
\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\_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}
+\end{bsysitemize}
You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
data that will be displayed.
-\begin{verbatim}
+\begin{lstlisting}
* .bvfs_update jobid=1,2
* .bvfs_update
* .bvfs_lsdir path=/ jobid=1,2
-\end{verbatim}
+\end{lstlisting}
This project was funded by Bacula Systems.
\subsection{Testing your Tape Drive}
-\label{sec:btapespeed}
+\label{seccom: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}
+\begin{bsysitemize}
\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
\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
+\item[\texttt{skip\_block}] This flag permits to skip tests with \mbacula{} block
access.
-\end{itemize}
+\end{bsysitemize}
-\begin{verbatim}
+\begin{lstlisting}
*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:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
-\end{verbatim}
+\end{lstlisting}
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
\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
+that \mbacula{} uses when writing blocks to a Volume. This is
done by adding:
-\begin{verbatim}
+\begin{lstlisting}
Block Checksum = no
-\end{verbatim}
+\end{lstlisting}
doing so can reduce the Storage daemon CPU usage slightly. It
-will also permit Bacula to read a Volume that has corrupted data.
+will also permit \mbacula{} 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.
+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
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=13cm]{\idir bat-mediaview.eps}
- \label{fig:mediaview}
-\end{figure}
-
+%% \begin{figure}[htbp]
+%% \centering
+%% \includegraphics[width=13cm]{\idir bat-mediaview}
+%% \label{figcom:mediaview}
+%% \end{figure}
+\bsysimageH{bat-mediaview}{List of all Volumes}{figcom:mediaview}
\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 \ref{fig:mediainfo}.)
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=13cm]{\idir bat11.eps}
- \caption{Media information}
- \label{fig:mediainfo}
-\end{figure}
-
+Volume. (cf. figure \bsysref{figcom:mediainfo}.)
+%% \begin{figure}[htbp]
+%% \centering
+%% \includegraphics[width=13cm]{\idir bat11}
+%% \caption{Media information}
+%% \label{figcom:mediainfo}
+%% \end{figure}
+\bsysimageH{bat11}{Media information}{figcom:mediainfo}
\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
-\ref{fig:jobinfo}.)
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=13cm]{\idir bat12.eps}
- \caption{Job information}
- \label{fig:jobinfo}
-\end{figure}
+\bsysref{figcom:jobinfo}.)
+%% \begin{figure}[htbp]
+%% \centering
+%% \includegraphics[width=13cm]{\idir bat12}
+%% \caption{Job information}
+%% \label{figcom:jobinfo}
+%% \end{figure}
+\bsysimageH{bat12}{Job information}{figcom:jobinfo}
\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 \ref{fig:jobinfo}.)
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=13cm]{\idir bat13.eps}
- \caption{Autochanger content}
- \label{fig:achcontent}
-\end{figure}
+access a detailed overview of your Autochanger. (cf. figure \bsysref{figcom:jobinfo}.)
+%% \begin{figure}[htbp]
+%% \centering
+%% \includegraphics[width=13cm]{\idir bat13}
+%% \caption{Autochanger content}
+%% \label{figcom:achcontent}
+%% \end{figure}
+\bsysimageH{bat13}{Autochanger content}{figcom:achcontent}
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
+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
\subsection{New Win32 Installer}
The Win32 installer has been modified in several very important
-ways.
-\begin{itemize}
+ways.
+\begin{bsysitemize}
\item You must deinstall any current version of the
-Win32 File daemon before upgrading to the new one.
+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.
+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}.
+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}
+\begin{lstlisting}
cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
-\end{verbatim}
+\end{lstlisting}
\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
+they have not been ported to 64 bits), or you can contact
Bacula Systems about this.
-\end{itemize}
+\end{bsysitemize}
\subsection{Win64 Installer}
We have corrected a number of problems that required manual
\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.
+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
to interface to the Director.
\subsection{Important Changes}
-\label{sec:importantchanges}
+\label{seccom:importantchanges}
-\begin{itemize}
+\begin{bsysitemize}
\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.
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}
+ 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
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
+ 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}
+\end{bsysitemize}
\subsubsection*{Truncate volume after purge}
The following items have been \textbf{deprecated} for a long time, and are now
removed from the code.
-\begin{itemize}
+\begin{bsysitemize}
\item Gnome console
\item Support for SQLite 2
-\end{itemize}
+\end{bsysitemize}
\subsection{Misc Changes}
-\label{sec:miscchanges}
+\label{seccom:miscchanges}
-\begin{itemize}
+\begin{bsysitemize}
\item Updated Nagios check\_bacula
\item Updated man files
\item Added OSX package generation script in platforms/darwin
\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}
+\end{bsysitemize}
\chapter{Released Version 3.0.3 and 3.0.3a}
\subsection{Full Restore from a Given JobId}
\index[general]{Restore menu}
-This feature allows selecting a single JobId and having Bacula
+This feature allows selecting a single JobId and having \mbacula{}
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}
+\begin{lstlisting}
+-------+--------------+---------------------+-------+----------+------------+
| jobid | client | starttime | level | jobfiles | jobbytes |
+-------+--------------+---------------------+-------+----------+------------
| 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}
+\end{lstlisting}
Below is an example of this new feature (which is number 12 in the
menu).
-\begin{verbatim}
+\begin{lstlisting}
* restore
To select the JobIds, you have the following choices:
1: List last 20 Jobs run
Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1,444 files inserted into the tree.
-\end{verbatim}
+\end{lstlisting}
This project was funded by Bacula Systems.
\subsection{Source Address}
-\index[general]{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
networks utilizing multi-homing and policy-routing.
To accomplish this, two new configuration directives have been implemented:
-\begin{verbatim}
+\begin{lstlisting}
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}
+\end{lstlisting}
Simply adding specific host routes on the OS
would have an undesirable side-effect: any
When doing a restore the selection dialog ends by displaying this
screen:
-\begin{verbatim}
+\begin{lstlisting}
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
+ *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}
+\end{lstlisting}
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.
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}
+\begin{lstlisting}
* estimate listing accurate=yes level=incremental job=BackupJob
-\end{verbatim}
+\end{lstlisting}
This project was funded by Bacula Systems.
\section{New Features in 3.0.0}
-\label{NewFeaturesChapter}
-\index[general]{New Features}
+\label{3: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}
+\subsection{Accurate Backup}\label{accuratemode}
+\index[general]{Accurate backup}
-As with most other backup programs, by default Bacula decides what files to
+As with most other backup programs, by default \mbacula{} 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
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.
+\mbacula{} 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)
will probably not work correctly.
This project was funded by Bacula Systems.
-
+
\subsection{Copy Jobs}
-\index[general]{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
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
+option. If the keyword {\bf copies} is present on the command line, \mbacula{} will
display the list of all copies for selected jobs.
-\begin{verbatim}
+\begin{lstlisting}
* restore copies
[...]
These JobIds have copies as follows:
Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
5,611 files inserted into the tree.
...
-\end{verbatim}
+\end{lstlisting}
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.
+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.
+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,
+If \mbacula{} 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.
called disk-to-disk-to-tape backup (DTDTT). A sample config could
look something like the one below:
-\begin{verbatim}
+\begin{lstlisting}
Pool {
Name = FullBackupsVirtualPool
Pool Type = Backup
Pool = FullBackupsVirtualPool
JobDefs = CopyDiskToTape
}
-\end{verbatim}
+\end{lstlisting}
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
The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
\textbf{jobid}.
-\begin{verbatim}
+\begin{lstlisting}
*list copies
+-------+------------------------------------+-----------+------------------+
| JobId | Job | CopyJobId | MediaType |
+-------+------------------------------------+-----------+------------------+
| 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
+-------+------------------------------------+-----------+------------------+
-\end{verbatim}
+\end{lstlisting}
\subsection{ACL Updates}
-\index[general]{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
Currently the following platforms support ACLs:
-\begin{itemize}
+\begin{bsysitemize}
\item {\bf AIX}
\item {\bf Darwin/OSX}
\item {\bf FreeBSD}
\item {\bf Linux}
\item {\bf Tru64}
\item {\bf Solaris}
-\end{itemize}
+\end{bsysitemize}
Currently we support the following ACL types (these ACL streams use a reserved
part of the stream numbers):
-\begin{itemize}
+\begin{bsysitemize}
\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 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}
+\end{bsysitemize}
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
recognize them will give you a warning.
\subsection{Extended Attributes}
-\index[general]{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
security labels.
Currently the following platforms support extended attributes:
-\begin{itemize}
+\begin{bsysitemize}
\item {\bf Darwin/OSX}
\item {\bf FreeBSD}
\item {\bf Linux}
\item {\bf NetBSD}
-\end{itemize}
+\end{bsysitemize}
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
To enable the backup of extended attributes please add the following to your
fileset definition.
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "MyFileSet"
Include {
File = ...
}
}
-\end{verbatim}
+\end{lstlisting}
\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.
+A default build of \mbacula{} 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.
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
+\mbacula{} binaries, the \mbacula{} 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}
+\begin{lstlisting}
./configure --libdir=/full-path/dir
-\end{verbatim}
+\end{lstlisting}
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
+the shared objects are installed in that directory (\mbacula{}
does this with the make install command). The shared objects
-that Bacula references are:
+that \mbacula{} references are:
-\begin{verbatim}
+\begin{lstlisting}
libbaccfg.so
libbacfind.so
libbacpy.so
libbac.so
-\end{verbatim}
+\end{lstlisting}
These files are symbolically linked to the real shared object file,
which has a version number to permit running multiple versions of
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
+version of \mbacula{} you may disable
libtool on the configure command line with:
-\begin{verbatim}
+\begin{lstlisting}
./configure --disable-libtool
-\end{verbatim}
+\end{lstlisting}
\subsection{Building Static versions of Bacula}
\index[general]{Static linking}
-In order to build static versions of Bacula, in addition
+In order to build static versions of \mbacula{}, in addition
to configuration options that were needed you now must
also add --disable-libtool. Example
-\begin{verbatim}
+\begin{lstlisting}
./configure --enable-static-client-only --disable-libtool
-\end{verbatim}
+\end{lstlisting}
\subsection{Virtual Backup (Vbackup)}
\index[general]{Virtual Backup}
\index[general]{Vbackup}
-Bacula's virtual backup feature is often called Synthetic Backup or
+\mbacula{}'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
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
+that \mbacula{} 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
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
+pool. This will cause \mbacula{} to read and write to Volumes in the
+current pool. In general, this will work, because \mbacula{} 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
+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 typical Job resource definition might look like the following:
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = "MyBackup"
Type = Backup
Maximum Concurrent Jobs = 4
Autochanger = yes
}
-\end{verbatim}
+\end{lstlisting}
Then in bconsole or via a Run schedule, you would run the job as:
-\begin{verbatim}
+\begin{lstlisting}
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}
+\end{lstlisting}
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
To consolidate those backups into a new Full backup, you would run the
following:
-\begin{verbatim}
+\begin{lstlisting}
run job=MyBackup level=VirtualFull
-\end{verbatim}
+\end{lstlisting}
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.
\subsection{Catalog Format}
-\index[general]{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
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
+backup of your database before executing the upgrade script. See the
ReleaseNotes for additional details.
\subsection{64 bit Windows Client}
-\index[general]{Win64 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.
+their 64 bit OS versions is not compatible with a 32 bit \mbacula{} Client.
+As a consequence, we are also releasing a 64 bit version of the \mbacula{}
+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.
+a 64 bit version of the Windows OS.
-Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
+Compared to the Win32 \mbacula{} 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
+\item Before installing the Win64 \mbacula{} Client, you must totally
+ deinstall any prior 2.4.x Client installation using the
+ \mbacula{} 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 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
+ any prior version of \mbacula{} 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
+ 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
+\item All \mbacula{} 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
\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
+\index[general]{Duplicate jobs}
+The new version of \mbacula{} provides four new directives that
+give additional control over what \mbacula{} 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
+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
\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
+ may run at one time, and the action that \mbacula{} 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)
\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).
+ of \mbacula{} 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 queued to run but not yet running will be canceled.
- The default is {\bf no}.
+ 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
+\index[general]{TLS authentication}
+In Bacula version 2.5.x and later, in addition to the normal \mbacula{}
+CRAM-MD5 authentication that is used to authenticate each \mbacula{}
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
+This new feature uses \mbacula{}'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
+encryption (TLS Enable, TLS Verify Peer, TLS Certificate, \ldots{}) and
a new directive:
\subsubsection{TLS Authenticate = yes}
-\begin{verbatim}
+\begin{lstlisting}
TLS Authenticate = yes
-\end{verbatim}
+\end{lstlisting}
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
+authentication, \mbacula{} 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.
+the two \mbacula{} 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}
+\index[general]{Win32!bextract handles non-portable data}
{\bf bextract} has been enhanced to be able to restore
-non-portable Win32 data to any OS. Previous versions were
+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
+\index[general]{State file}
+In previous versions of \mbacula{}, 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
+updated only when \mbacula{} 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.
+the \mbacula{} daemons updates the state file on each job termination.
\subsection{MaxFullInterval = \lt{}time-interval\gt{}}
\index[general]{MaxFullInterval}
\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
+to not backup that particular file. This version of \mbacula{} contains a
+new Options directive within a FileSet resource, which instructs \mbacula{} to
obey this flag. The new directive is:
-\begin{verbatim}
+\begin{lstlisting}
Honor No Dump Flag = yes\vb{}no
-\end{verbatim}
+\end{lstlisting}
The default value is {\bf no}.
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}
+\begin{lstlisting}
# List of files to be backed up
FileSet {
Name = "MyFileSet"
Exclude Dir Containing = .excludeme
}
}
-\end{verbatim}
+\end{lstlisting}
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
+the user or sysadmin creates a file named {\bf .excludeme} in
specific directories, such as
-\begin{verbatim}
+\begin{lstlisting}
/home/user/www/cache/.excludeme
/home/user/temp/.excludeme
-\end{verbatim}
+\end{lstlisting}
-then Bacula will not backup the two directories named:
+then \mbacula{} will not backup the two directories named:
-\begin{verbatim}
+\begin{lstlisting}
/home/user/www/cache
/home/user/temp
-\end{verbatim}
+\end{lstlisting}
NOTE: subdirectories will not be backed up. That is, the directive
applies to the two directories in question and any children (be they
get control to backup and restore a file.
Plugins are also planned (partially implemented) in the Director and the
-Storage daemon.
+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
+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
+find the \mbacula{} plugins. If this directive is not specified, \mbacula{} will not
load any plugins. Since each plugin has a distinctive name, all the daemons
-can share the same plugin directory.
+can share the same plugin directory.
\subsubsection{Plugin Options}
\index[general]{Plugin Options}
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
+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
\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
+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.
a FileSet resource where you put your {\bf File = xxx} directives.
For example:
-\begin{verbatim}
+\begin{lstlisting}
FileSet {
Name = "MyFileSet"
Include {
Plugin = "bpipe:..."
}
}
-\end{verbatim}
+\end{lstlisting}
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}
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
+Please see the next section for information about the {\bf bpipe} \mbacula{}
plugin.
\subsection{The bpipe Plugin}
-\index[general]{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 \mbacula{} 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
plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
to specify the sytax as it wishes) is:
-\begin{verbatim}
+\begin{lstlisting}
Plugin = "<field1>:<field2>:<field3>:<field4>"
-\end{verbatim}
+\end{lstlisting}
where
\begin{description}
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
+\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.
+{\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.
+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
+fields, these programs are "executed" by \mbacula{}, 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
+or output, \ldots{}), 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.
+the restore, \mbacula{} 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
+\begin{lstlisting}
+Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
--opt --databases bacula:mysql"
-\end{verbatim}
+\end{lstlisting}
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
+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.
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
+The {\bf bpipe} plugin is a generic pipe program, that simply transmits
+the data from a specified program to \mbacula{} for backup, and then from \mbacula{} to
a specified program for restore.
By using different command lines to {\bf bpipe},
on the program called.
\subsection{Microsoft Exchange Server 2003/2007 Plugin}
-\index[general]{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
+The code for the plugin was written by James Harper, and the \mbacula{} 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.
+part of the \mbacula{} 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
+Although it is possible to backup Exchange using \mbacula{} VSS the Exchange
+plugin adds a good deal of functionality, because while \mbacula{} 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)",
+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
without any additional installation.
If the DLL can not be found automatically it will need to be copied into
-the Bacula installation
+the \mbacula{} 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
+the backup to work correctly. The 'exchange:' bit tells \mbacula{} 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'
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}
+\begin{lstlisting}
FileSet {
Include {
File = C:/Program Files/Exchsrvr/mdbdata
File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
}
}
-\end{verbatim}
+\end{lstlisting}
The advantage of excluding the above files is that you can significantly
reduce the size of your backup since all the important Exchange files
\subsubsection{Restoring}
-The restore operation is much the same as a normal Bacula restore, with
+The restore operation is much the same as a normal \mbacula{} restore, with
the following provisos:
-\begin{itemize}
+\begin{bsysitemize}
\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.
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}
+\end{bsysitemize}
\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
+\elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
+but to briefly summarize\ldots{}
Microsoft Exchange allows the creation of an additional Storage Group
called the Recovery Storage Group, which is used to restore an older
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
+{\bf "New -> Recovery Storage Group\ldots{}"}. 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
+select {\bf "Add Database to Recover\ldots{}"} and select the database you will
be restoring.
Restore only the single database nominated as the database in the
\subsection{libdbi Framework}
-\index[general]{libdbi Framework}
-As a general guideline, Bacula has support for a few catalog database drivers
+\index[general]{libdbi framework}
+As a general guideline, \mbacula{} 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
+\mbacula{} 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
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
+natively coded in \mbacula{}. 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}
+\begin{bsysitemize}
\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
+ \item The possibility to use other database engines without recompiling \mbacula{}
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}
-
+ \end{bsysitemize}
+
The following drivers have been tested:
- \begin{itemize}
+ \begin{bsysitemize}
\item PostgreSQL, with and without batch insert
\item Mysql, with and without batch insert
\item SQLite
\item SQLite3
- \end{itemize}
+ \end{bsysitemize}
In the future, we will test and approve to use others databases engines
(proprietary or not) like DB2, Oracle, Microsoft SQL.
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}
+\begin{lstlisting}
Catalog {
Name = MyCatalog
dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
dbname = regress; user = regress; password = ""
}
-\end{verbatim}
+\end{lstlisting}
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 database. Currently the drivers supported by \mbacula{} 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:
+The following limitations apply when \mbacula{} 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
+ - 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
+It is important to remember, when compiling \mbacula{} with libdbi, the
following packages are needed:
- \begin{itemize}
+ \begin{bsysitemize}
\item libdbi version 1.0.0, http://libdbi.sourceforge.net/
\item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
- \end{itemize}
-
+ \end{bsysitemize}
+
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}
+\index[general]{Console additions}
\subsubsection{Display Autochanger Content}
\index[general]{StatusSlots}
autochanger content.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
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}
+\end{lstlisting}
\normalsize
If you an asterisk ({\bf *}) appears after the slot number, you must run an
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
+Note for the catalog to have Job Log entries, you must have a directive
such as:
-\begin{verbatim}
+\begin{lstlisting}
catalog = all
-\end{verbatim}
+\end{lstlisting}
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
+\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}
+\begin{lstlisting}
!$%&'()*+,-/:;<>?[]^`{|}~
-\end{verbatim}
+\end{lstlisting}
\subsubsection{Deleting Volumes}
The delete volume bconsole command has been modified to
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
+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.
+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.
+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.
+ 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.
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 ...
+ to the main manual. See below \ldots{}
\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}
+\index[general]{Misc new features}
\subsubsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
\index[general]{Allow Mixed Priority}
be run until the priority 5 job has finished.
\subsubsection{Bootstrap File Directive -- FileRegex}
-\index[general]{Bootstrap File Directive}
+\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
+ for a Job, normally \mbacula{} 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
+ With this new feature, \mbacula{} will ask if you want to specify a Regex
expression for extracting only a part of the full backup.
-\begin{verbatim}
+\begin{lstlisting}
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}
+\end{lstlisting}
\subsubsection{Bootstrap File Optimization Changes}
In order to permit proper seeking on disk files, we have extended the bootstrap
\subsubsection{Virtual Tape Emulation}
-\index[general]{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
used for production.
\subsubsection{Bat Enhancements}
-\index[general]{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
+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
work.
\subsubsection{RunScript Enhancements}
-\index[general]{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}
+\begin{lstlisting}
Job {
Name = aJob
RunScript {
}
...
}
-\end{verbatim}
+\end{lstlisting}
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
+{\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}
+\index[general]{Status enhancements}
The bconsole {\bf status dir} output has been enhanced to indicate
Storage daemon job spooling and despooling activity.
daemon has been set to 3 minutes. Previously it was 30 minutes.
\subsubsection{ftruncate for NFS Volumes}
-\index[general]{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
+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)
+The new version of \mbacula{} 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
+Since Ubuntu officially supports \mbacula{}, you can also obtain any
recent release of Bacula from the Ubuntu repositories.
\subsubsection{Recycle Pool = \lt{}pool-name\gt{}}
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,
+\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.
\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{}}
+\subsubsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
\index[general]{Incremental Max Wait Time}
\index[general]{Differential Max Wait Time}
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}
-\includegraphics{\idir different_time.eps}
+%\addcontentsline{lof}{figure}{Job time control directives}
+%\includegraphics{\idir different_time}
+\bsysimageH{different_time}{Job time control directives}{figcom:different_time}
\subsubsection{Statistics Enhancements}
-\index[general]{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}
+\begin{bsysitemize}
\item jobs have run
\item jobs have been successful
\item files have been backed up
-\item ...
-\end{itemize}
+\item \ldots{}
+\end{bsysitemize}
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.
+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
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
+the length of time that \mbacula{} 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
+period expires, and if user runs \texttt{prune stats} command, \mbacula{} 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}
+\begin{lstlisting}
Job {
Name = BackupCatalog
...
RunsOnClient = no
}
}
-\end{verbatim}
+\end{lstlisting}
\subsubsection{ScratchPool = \lt{}pool-resource-name\gt{}}
\index[general]{ScratchPool}
\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.
+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
+\begin{lstlisting}
+ $ dbcheck -B
catalog=MyCatalog
db_type=SQLite
db_name=regress
db_address=
db_port=0
db_socket=
-\end{verbatim} %$
+\end{lstlisting} %$
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
+specify the directory where you want \mbacula{} to install the
+LICENSE, ReleaseNotes, ChangeLog, \ldots{} 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
+specify the directory where you want \mbacula{} 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
+specify the directory where you want \mbacula{} to install
the plugins (currently only bpipe-fd). The default is
/usr/lib.
Pools, and you may wonder what they are good for. In this chapter, you will
see that Pools can help you optimize disk storage space. The same techniques
can be applied to a shop that has multiple tape drives, or that wants to mount
-various different Volumes to meet their needs.
+various different Volumes to meet their needs.
The rest of this chapter will give an example involving backup to disk
-Volumes, but most of the information applies equally well to tape Volumes.
+Volumes, but most of the information applies equally well to tape Volumes.
\label{TheProblem}
\section{The Problem}
drive that was failing. The exact reason for the failure is still unknown.
Worse yet, their full backup size is about 15GB whereas the capacity of their
broken DDS-3 was at best 8GB (rated 6/12). A new DDS-4 tape drive and the
-necessary cassettes was more expensive than their budget could handle.
+necessary cassettes was more expensive than their budget could handle.
\label{TheSolution}
\section{The Solution}
files on a daily basis for a week, a weekly basis for a month, then monthly
for six months. In addition, offsite capability was not needed (well perhaps
it really is, but it was never used). Their daily changes amount to about
-300MB on the average, or about 2GB per week.
+300MB on the average, or about 2GB per week.
As a consequence, the total volume of data they need to keep to meet their
-needs is about 100GB (15GB x 6 + 2GB x 5 + 0.3 x 7) = 102.1GB.
+needs is about 100GB (15GB x 6 + 2GB x 5 + 0.3 x 7) = 102.1GB.
The chosen solution was to buy a 120GB hard disk for next to nothing -- far
less than 1/10th the price of a tape drive and the cassettes to handle the
-same amount of data, and to have Bacula write to disk files.
+same amount of data, and to have Bacula write to disk files.
The rest of this chapter will explain how to setup Bacula so that it would
automatically manage a set of disk files with the minimum sysadmin
intervention. The system has been running since 22 January 2004 until today
-(23 June 2007) with no intervention, with the exception of adding
+(23 June 2007) with no intervention, with the exception of adding
a second 120GB hard disk after a year because their needs grew
over that time to more than the 120GB (168GB to be exact). The only other
intervention I have made is a periodic (about once a year) Bacula upgrade.
directives discussed here are explained in that chapter. We'll leave it to you
to look at the details there. If you haven't read it and are not familiar with
Pools, you probably should at least read it once quickly for the ideas before
-continuing here.
+continuing here.
One needs to consider about what happens if we have only a single large Bacula
Volume defined on our hard disk. Everything works fine until the Volume fills,
automatically recycle them so that the disk storage space can be reused. The
other problem with a single Volume, is that until version 2.0.0,
Bacula did not seek within a disk Volume, so restoring a single file can take
-more time than one would expect.
+more time than one would expect.
As mentioned, the solution is to have multiple Volumes, or files on the disk.
To do so, we need to limit the use and thus the size of a single Volume, by
once a month, a Differential save once a week, and Incremental saves daily.
Now since each of these different kinds of saves needs to remain valid for
differing periods, the simplest way to do this (and possibly the only) is to
-have a separate Pool for each backup type.
+have a separate Pool for each backup type.
The decision was to use three Pools: one for Full saves, one for Differential
saves, and one for Incremental saves, and each would have a different number
-of volumes and a different Retention period to accomplish the requirements.
+of volumes and a different Retention period to accomplish the requirements.
\label{FullPool}
\subsection{Full Pool}
\index[general]{Full Pool}
Putting a single Full backup on each Volume, will require six Full save
-Volumes, and a retention period of six months. The Pool needed to do that is:
+Volumes, and a retention period of six months. The Pool needed to do that is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Pool {
Name = Full-Pool
Pool Type = Backup
Label Format = Full-
Maximum Volumes = 9
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Since these are disk Volumes, no space is lost by having separate Volumes for
retention period of six months (i.e. they are recycled after six months), that
there is one job per volume (Maximum Volume Jobs = 1), the volumes will be
labeled Full-0001, ... Full-0006 automatically. One could have labeled these
-manually from the start, but why not use the features of Bacula.
+manually from the start, but why not use the features of Bacula.
Six months after the first volume is used, it will be subject to pruning
and thus recycling, so with a maximum of 9 volumes, there should always be
marked purged and recycled as needed).
If you have two clients, you would want to set {\bf Maximum Volume Jobs} to
-2 instead of one, or set a limit on the size of the Volumes, and possibly
+2 instead of one, or set a limit on the size of the Volumes, and possibly
increase the maximum number of Volumes.
For the Differential backup Pool, we choose a retention period of a bit longer
than a month and ensure that there is at least one Volume for each of the
-maximum of five weeks in a month. So the following works:
+maximum of five weeks in a month. So the following works:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Pool {
Name = Diff-Pool
Pool Type = Backup
Label Format = Diff-
Maximum Volumes = 10
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
As you can see, the Differential Pool can grow to a maximum of 9 volumes,
and the Volumes are retained 40 days and thereafter they can be recycled. Finally
there is one job per volume. This, of course, could be tightened up a lot, but
-the expense here is a few GB which is not too serious.
+the expense here is a few GB which is not too serious.
If a new volume is used every week, after 40 days, one will have used 7
volumes, and there should then always be 3 volumes that can be purged and
\index[general]{Incremental Pool}
\index[general]{Pool!Incremental}
-Finally, here is the resource for the Incremental Pool:
+Finally, here is the resource for the Incremental Pool:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Pool {
Name = Inc-Pool
Pool Type = Backup
Label Format = Inc-
Maximum Volumes = 7
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
We keep the data for 20 days rather than just a week as the needs require. To
be set to just a bit more than a week and keep only two or three volumes
instead of five. Again, the lost is very little and as the system reaches the
full steady state, we can adjust these values so that the total disk usage
-doesn't exceed the disk capacity.
+doesn't exceed the disk capacity.
If you have two clients, the simplest thing to do is to increase the
maximum volume jobs from 6 to 12. As mentioned above, it is also possible
\index[general]{Actual Conf Files}
The following example shows you the actual files used, with only a few minor
-modifications to simplify things.
+modifications to simplify things.
-The Director's configuration file is as follows:
+The Director's configuration file is as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director { # define myself
Name = bacula-dir
DIRport = 9101
console = all, !skipped, !saved
append = "/home/bacula/bin/log" = all, !skipped
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
-and the Storage daemon's configuration file is:
+and the Storage daemon's configuration file is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Storage { # definition of myself
Name = bacula-sd
SDPort = 9103 # Director's port
Name = Standard
director = bacula-dir = all
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\index[general]{Upgrading}
If you are considering using PostreSQL, you should be aware
-of their philosophy of upgrades, which could be
+of their philosophy of upgrades, which could be
destabilizing for a production shop. Basically at every major version
-upgrade, you are required to dump your database in an ASCII format,
+upgrade, you are required to dump your database in an ASCII format,
do the upgrade, and then reload your database (or databases). This is
-because they frequently update the "data format" from version to
+because they frequently update the "data format" from version to
version, and they supply no tools to automatically do the conversion.
If you forget to do the ASCII dump, your database may become totally
useless because none of the new tools can access it due to the format
If you are building PostgreSQL from source, please be sure to add
the {\bf \verb:--:enable-thread-safety} option when doing the ./configure
-for PostgreSQL.
+for PostgreSQL.
\section{Installing PostgreSQL}
\index[general]{PostgreSQL!Installing }
need only enter {\bf \verb:--:with-postgresql} since the configure program will
search all the standard locations. If you install PostgreSQL in your home
directory or some other non-standard directory, you will need to provide the
-full path with the {\bf \verb:--:with-postgresql} option.
+full path with the {\bf \verb:--:with-postgresql} option.
Installing and configuring PostgreSQL is not difficult but can be confusing
the first time. If you prefer, you may want to use a package provided by your
chosen operating system. Binary packages are available on most PostgreSQL
-mirrors.
+mirrors.
If you prefer to install from source, we recommend following the instructions
-found in the
-\elink{PostgreSQL documentation}{http://www.postgresql.org/docs/}.
+found in the
+\elink{PostgreSQL documentation}{http://www.postgresql.org/docs/}.
-If you are using FreeBSD,
+If you are using FreeBSD,
\elink{this FreeBSD Diary article}{http://www.freebsddiary.org/postgresql.php}
will be useful. Even if you are not using FreeBSD, the article will contain
-useful configuration and setup information.
+useful configuration and setup information.
If you configure the Batch Insert code in Bacula (attribute inserts are
10 times faster), you {\bf must} be using a PostgreSQL that was built with
with a command such as:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
nm /usr/lib/libpq.a | grep pthread_mutex_lock
-\end{verbatim}
+\end{lstlisting}
\normalsize
The above command should print a line that looks like:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
U pthread_mutex_lock
-\end{verbatim}
+\end{lstlisting}
\normalsize
if does, then everything is OK. If it prints nothing, do not enable batch
of {\bf Bacula}. Later, after Bacula is installed, come back to this chapter
to complete the installation. Please note, the installation files used in the
second phase of the PostgreSQL installation are created during the Bacula
-Installation. You must still come back to complete the second phase of the
+Installation. You must still come back to complete the second phase of the
PostgreSQL installation even if you installed binaries (e.g. rpm, deb,
-...).
+\ldots{}).
\label{PostgreSQL_configure}
At this point, you should have built and installed PostgreSQL, or already have
a running PostgreSQL, and you should have configured, built and installed {\bf
-Bacula}. If not, please complete these items before proceeding.
+Bacula}. If not, please complete these items before proceeding.
Please note that the {\bf ./configure} used to build {\bf Bacula} will need to
include {\bf \verb:--:with-postgresql=PostgreSQL-directory}, where {\bf
./configure command for configuring PostgreSQL (if you didn't specify a
directory or PostgreSQL is installed in a default location, you do not need to
specify the directory). This is needed so that Bacula can find the necessary
-include headers and library files for interfacing to PostgreSQL.
+include headers and library files for interfacing to PostgreSQL.
An important thing to note here is that {\bf Bacula} makes two connections
to the PostgreSQL server for each backup job that is currently running. If
running ./configure. If you inspect create\_bacula\_database, you will see
that it calls create\_postgresql\_database. The *\_bacula\_* files are
provided for convenience. It doesn't matter what database you have chosen;
-create\_bacula\_database will always create your database.
+create\_bacula\_database will always create your database.
Now you will create the Bacula PostgreSQL database and the tables that Bacula
uses. These instructions assume that you already have PostgreSQL running. You
will need to perform these steps as a user that is able to create new
databases. This can be the PostgreSQL user (on most systems, this is the pgsql
-user).
+user).
\begin{enumerate}
\item cd \lt{}install-directory\gt{}
- This directory contains the Bacula catalog interface routines.
+ This directory contains the Bacula catalog interface routines.
\item Create the database owner ({\bf bacula})
- On many systems, the PostreSQL master
+ On many systems, the PostreSQL master
owner is {\bf pgsql} and on others such as Red Hat and Fedora it is {\bf
postgres}. You can find out which it is by examining your /etc/passwd
file. To create a new user under either your name or with say the name
{\bf bacula}, you can do the following:
-\begin{verbatim}
+\begin{lstlisting}
su
(enter root password)
su pgsql (or postgres)
Shall the new user be allowed to create more new users? (y/n) (choose
what you want)
exit
-\end{verbatim}
+\end{lstlisting}
Normally the {\bf bacula} user must be able to create new databases,
- if you use the script in the next item,
- or you will have to create one for it, but it does not need to
+ if you use the script in the next item,
+ or you will have to create one for it, but it does not need to
create new users.
\item ./create\_bacula\_database
- This script creates the PostgreSQL {\bf bacula} database.
+ This script creates the PostgreSQL {\bf bacula} database.
Before running this command, you should carefully think about
- what encoding sequence you want for the text fields (paths, files, ...).
+ what encoding sequence you want for the text fields (paths, files, \ldots{}).
We strongly recommend that you use the default value of SQL\_ASCII
that is in the create\_bacula\_database script. Please be warned
that if you change this value, your backups may fail. After running
the script, you can check with the command:
-\begin{verbatim}
+\begin{lstlisting}
psql -l
-\end{verbatim}
+\end{lstlisting}
and the column marked {\bf Encoding} should be {\bf SQL\_ASCII} for
all your Bacula databases (normally {\bf bacula}).
\item ./make\_bacula\_tables
- This script creates the PostgreSQL tables used by {\bf Bacula}.
+ This script creates the PostgreSQL tables used by {\bf Bacula}.
\item ./grant\_bacula\_privileges
This script creates the database user {\bf bacula} with restricted access
-rights. You may want to modify it to suit your situation. Please note that
-this database is not password protected.
+rights. You may want to modify it to suit your situation. Please note that
+this database is not password protected.
\end{enumerate}
grant\_bacula\_privileges) allows the addition of a command line argument.
This can be useful for specifying the user name. For example, you might need
to add {\bf -h hostname} to the command line to specify a remote database
-server.
+server.
To take a closer look at the access privileges that you have setup with the
-above, you can do:
+above, you can do:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
PostgreSQL-directory/bin/psql --command \\dp bacula
-\end{verbatim}
+\end{lstlisting}
\normalsize
Also, I had an authorization problem with the password. In the end,
still others -- what a mess!) from:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
local all all ident sameuser
to
local all all trust
-\end{verbatim}
+\end{lstlisting}
\normalsize
This solved the problem for me, but it is not always a good thing
above the existing ``local'' and ``host'' lines, add the line:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
local bacula bacula md5
-\end{verbatim}
+\end{lstlisting}
\normalsize
then restart the Postgres database server (frequently, this can be done
Next, become the Postgres administrator, postgres, either by logging
on as the postgres user, or by using su to become root and then using
-{\bf su - postgres} or {\bf su - pgsql} to become postgres.
+{\bf su - postgres} or {\bf su - pgsql} to become postgres.
Add a password to the {\bf bacula} database for the {\bf bacula} user using:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
\$ psql bacula
bacula=# alter user bacula with password 'secret';
ALTER USER
bacula=# \\q
-\end{verbatim}
+\end{lstlisting}
\normalsize
You'll have to add this password to two locations in the
password in place, these two lines should look something like:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
dbname = bacula; user = bacula; password = "secret"
... and ...
# WARNING!!! Passing the password via the command line is insecure.
# see comments in make_catalog_backup for details.
RunBeforeJob = "/etc/make_catalog_backup bacula bacula secret"
-\end{verbatim}
+\end{lstlisting}
\normalsize
Naturally, you should choose your own significantly more random
line:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
localhost:5432:bacula:bacula:secret
-\end{verbatim}
+\end{lstlisting}
\normalsize
This file should be copied into the home directory of all accounts
After you have done some initial testing with {\bf Bacula}, you will probably
want to re-initialize the catalog database and throw away all the test Jobs
-that you ran. To do so, you can do the following:
+that you ran. To do so, you can do the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cd <install-directory>
./drop_bacula_tables
./make_bacula_tables
./grant_bacula_privileges
-\end{verbatim}
+\end{lstlisting}
\normalsize
Please note that all information in the database will be lost and you will be
starting from scratch. If you have written on any Volumes, you must write an
-end of file mark on the volume so that Bacula can reuse it. Do so with:
+end of file mark on the volume so that Bacula can reuse it. Do so with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
(stop Bacula or unmount the drive)
mt -f /dev/nst0 rewind
mt -f /dev/nst0 weof
-\end{verbatim}
+\end{lstlisting}
\normalsize
Where you should replace {\bf /dev/nst0} with the appropriate tape drive
-device name for your machine.
+device name for your machine.
\section{Installing PostgreSQL from RPMs}
\index[general]{PostgreSQL!Installing from RPMs}
install the following for rpms:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
postgresql
postgresql-devel
postgresql-server
postgresql-libs
-\end{verbatim}
+\end{lstlisting}
\normalsize
and the following for debs:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
postgresql
postgresql-common
postgresql-client
postgresql-client-common
libpq5
libpq-dev
-\end{verbatim}
+\end{lstlisting}
\normalsize
\index[general]{Converting from MySQL to PostgreSQL }
The conversion procedure presented here was worked out by Norm Dressler
-\lt{}ndressler at dinmar dot com\gt{}
+\lt{}ndressler at dinmar dot com\gt{}
-This process was tested using the following software versions:
+This process was tested using the following software versions:
-\begin{itemize}
+\begin{bsysitemize}
\item Linux Ubuntu Lucid
\item Mysql Ver 5.0.83
\item PostgreSQL 8.4.4
\item Bacula 5.0
- \end{itemize}
+ \end{bsysitemize}
WARNING: Always as a precaution, take a complete backup of your databases
-before proceeding with this process!
+before proceeding with this process!
\begin{enumerate}
-\item Shutdown bacula (cd /etc/bacula;./bacula stop)
-\item Run the following command to dump your Mysql database:
+\item Shutdown bacula (cd /etc/bacula;./bacula stop)
+\item Run the following command to dump your Mysql database:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mysqldump -t -n -c --compatible=postgresql --skip-quote-names --skip-opt \
--disable-keys --lock-tables -u bacula -ppassword bacula \
| grep -v "INSERT INTO Status" \
| sed -e 's/0000-00-00 00:00:00/1970-01-01 00:00:00/g' \
- | sed -e 's/\\0//' > bacula-backup.sql
-\end{verbatim}
+ | sed -e 's/\\0//' > bacula-backup.sql
+\end{lstlisting}
\normalsize
\item Make a backup of your /etc/bacula directory (but leave the original in
- place).
+ place).
\item Go to your Bacula source directory and rebuild it to include PostgreSQL
support rather then Mysql support. Check the config.log file for your
- original configure command and replace enable-mysql with enable-postgresql.
+ original configure command and replace enable-mysql with enable-postgresql.
\item Recompile Bacula with a make and if everything compiles completely,
- perform a make install.
-\item Shutdown Mysql.
-\item Start PostgreSQL on your system.
+ perform a make install.
+\item Shutdown Mysql.
+\item Start PostgreSQL on your system.
\item Create a bacula user in Postgres with the createuser command. Depending on
your Postgres install, you may have to SU to the user who has privileges to
create a user, you can also have to change permissions on catalog scripts
- to fit your situation.
+ to fit your situation.
\item Verify your pg\_hba.conf file contains sufficient permissions to allow
bacula to access the server. Mine has the following since it's on a secure
- network:
+ network:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
local all all trust
-
+
host all all 127.0.0.1 255.255.255.255 trust
-
+
NOTE: you should reload (or restart) your postgres server if you made changes
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
\item Change into the /etc/bacula directory and prepare the database and
- tables with the following commands:
+ tables with the following commands:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
./create_postgresql_database
-
+
./make_postgresql_tables
-
+
./grant_postgresql_privileges
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
-\item Verify you have access to the database:
+\item Verify you have access to the database:
\footnotesize
-\begin{verbatim}
-
+\begin{lstlisting}
+
psql -Ubacula bacula
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
-You should not get any errors.
-\item Load your database from the Mysql database dump with:
+You should not get any errors.
+\item Load your database from the Mysql database dump with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
psql -Ubacula bacula <bacula-backup.dmp>
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
-\item Resequence your tables with the following commands:
+\item Resequence your tables with the following commands:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
psql -Ubacula bacula
-
+
SELECT SETVAL('basefiles_baseid_seq', (SELECT MAX(baseid) FROM basefiles));
SELECT SETVAL('client_clientid_seq', (SELECT MAX(clientid) FROM client));
SELECT SETVAL('file_fileid_seq', (SELECT MAX(fileid) FROM file));
SELECT SETVAL('locationlog_loclogid_seq', (SELECT MAX(loclogid) FROM locationlog));
SELECT SETVAL('log_logid_seq', (SELECT MAX(logid) FROM log));
SELECT SETVAL('mediatype_mediatypeid_seq', (SELECT MAX(mediatypeid) FROM mediatype));
-SELECT SETVAL('storage_storageid_seq', (SELECT MAX(storageid) FROM storage));
-\end{verbatim}
+SELECT SETVAL('storage_storageid_seq', (SELECT MAX(storageid) FROM storage));
+\end{lstlisting}
\normalsize
\item At this point, start up Bacula, verify your volume library and perform
- a test backup to make sure everything is working properly.
+ a test backup to make sure everything is working properly.
\end{enumerate}
\section{Upgrading PostgreSQL}
\index[general]{Upgrading PostgreSQL }
\index[general]{Upgrading!PostgreSQL }
\index[general]{Upgrading}
-If you upgrade PostgreSQL, you must reconfigure, rebuild, and re-install
+If you upgrade PostgreSQL, you must reconfigure, rebuild, and re-install
Bacula otherwise you are likely to get bizarre failures. If you
to modify the bacula.spec file to account for the new PostgreSQL version.
You can do so by rebuilding from the source rpm. To do so, you may need
install from rpms and you upgrade PostgreSQL, you must also rebuild Bacula.
\section{Tuning PostgreSQL}
-\index[general]{Tuning}
+\index[general]{Tuning}
If you despool attributes for many jobs at the same time, you can tune the
sequence object for the \texttt{FileId} field.
-\begin{verbatim}
+\begin{lstlisting}
psql -Ubacula bacula
ALTER SEQUENCE file_fileid_seq CACHE 1000;
-\end{verbatim}
+\end{lstlisting}
\section{Credits}
\index[general]{Credits }
Many thanks to Dan Langille for writing the PostgreSQL driver. This will
-surely become the most popular database that Bacula supports.
+surely become the most popular database that Bacula supports.
chapter attempts to accomplish just that: get you going quickly without all
the details. If you want to skip the section on Pools, Volumes and Labels, you
can always come back to it, but please read to the end of this chapter, and in
-particular follow the instructions for testing your tape drive.
+particular follow the instructions for testing your tape drive.
We assume that you have managed to build and install Bacula, if not, you might
-want to first look at the
-\ilink{System Requirements}{SysReqs} then at the
+want to first look at the
+\ilink{System Requirements}{SysReqs} then at the
\ilink{Compiling and Installing Bacula}{InstallChapter} chapter of
-this manual.
+this manual.
\label{JobsandSchedules}
\section{Understanding Jobs and Schedules}
\index[general]{Jobs!Understanding}
\index[general]{Schedules!Understanding}
-In order to make Bacula as flexible as possible, the directions given
-to Bacula are specified in several pieces. The main instruction is the
-job resource, which defines a job. A backup job generally consists of a
-FileSet, a Client, a Schedule for one or several levels or times of backups,
+In order to make Bacula as flexible as possible, the directions given
+to Bacula are specified in several pieces. The main instruction is the
+job resource, which defines a job. A backup job generally consists of a
+FileSet, a Client, a Schedule for one or several levels or times of backups,
a Pool, as well as additional instructions. Another way of looking
at it is the FileSet is what to backup; the Client is who to backup; the
Schedule defines when, and the Pool defines where (i.e. what Volume).
identical parameters for each job. In addition to the FileSets you want to
back up, you should also have a job that backs up your catalog.
-Finally, be aware that in addition to the backup jobs there are
+Finally, be aware that in addition to the backup jobs there are
restore, verify, and admin jobs, which have different requirements.
\label{PoolsVolsLabels}
your backup data. Pools group together Volumes so that a backup is not
restricted to the length of a single Volume (tape). Consequently, rather than
explicitly naming Volumes in your Job, you specify a Pool, and Bacula will
-select the next appendable Volume from the Pool and request you to mount it.
+select the next appendable Volume from the Pool and request you to mount it.
% TODO: can't it mount it itself if already available?
Although the basic Pool options are specified in the Director's Pool resource,
information taken from the Pool resource (bacula-dir.conf) as well as
information on all the Volumes that have been added to the Pool. Adding
Volumes to a Pool is usually done manually with the Console program using the
-{\bf label} command.
+{\bf label} command.
For each Volume, Bacula maintains a fair amount of catalog information such as
the first write date/time, the last write date/time, the number of files on
-the Volume, the number of bytes on the Volume, the number of Mounts, etc.
+the Volume, the number of bytes on the Volume, the number of Mounts, etc.
Before Bacula will read or write a Volume, the physical Volume must have a
Bacula software label so that Bacula can be sure the correct Volume is
mounted. This is usually done using the {\bf label} command in the Console
-program.
+program.
The steps for creating a Pool, adding Volumes to it, and writing software
labels to the Volumes, may seem tedious at first, but in fact, they are quite
backups. By specifying the appropriate Pool in the daily and weekly backup
Jobs, you thereby insure that no daily Job ever writes to a Volume in the
Weekly Pool and vice versa, and Bacula will tell you what tape is needed and
-when.
+when.
-For more on Pools, see the
+For more on Pools, see the
\ilink{Pool Resource}{PoolResource} section of the Director
Configuration chapter, or simply read on, and we will come back to this
-subject later.
+subject later.
\section{Setting Up Bacula Configuration Files}
\label{config}
entail starting and stopping Bacula a number of times until you get everything
right. Please do not despair. Once you have created your configuration files,
you will rarely need to change them nor will you stop and start Bacula very
-often. Most of the work will simply be in changing the tape when it is full.
+often. Most of the work will simply be in changing the tape when it is full.
\subsection{Configuring the Console Program}
\index[general]{Configuring the Console Program }
\index[general]{Program!Configuring the Console }
The Console program is used by the administrator to interact with the Director
-and to manually start/stop Jobs or to obtain Job status information.
+and to manually start/stop Jobs or to obtain Job status information.
The Console configuration file is found in the directory specified on the
{\bf \verb:--:sysconfdir} option that you specified on the {\bf
configuration file is, in this case, {\bf bwx-console.conf}.
Normally, for first time users, no change is needed to these files. Reasonable
-defaults are set.
+defaults are set.
Further details are in the
\ilink{Console configuration}{ConsoleConfChapter} chapter.
The Monitor program is typically an icon in the system tray. However, once the
icon is expanded into a full window, the administrator or user can obtain
status information about the Director or the backup status on the local
-workstation or any other Bacula daemon that is configured.
+workstation or any other Bacula daemon that is configured.
-\addcontentsline{lof}{figure}{Bacula Tray Monitor}
-\includegraphics{\idir Bacula-tray-monitor.eps}
+%% \addcontentsline{lof}{figure}{Bacula Tray Monitor}
+%% \includegraphics{\idir Bacula-tray-monitor}
+\bsysimageH{Bacula-tray-monitor}{Bacula Tray Monitor}{figstart:baculatray}
% TODO: image may be too wide for 6" wide printed page.
The image shows a tray-monitor configured for three daemons. By clicking on
the radio buttons in the upper left corner of the image, you can see the
status for each of the daemons. The image shows the status for the Storage
-daemon (MainSD) that is currently selected.
+daemon (MainSD) that is currently selected.
The Monitor configuration file is found in the directory specified on the {\bf
\verb:--:sysconfdir} option that you specified on the {\bf ./configure} command
run the Monitor, as this application must run as the same user as the
graphical environment (don't forget to allow non-root users to execute {\bf
bacula-tray-monitor}). This is not a security problem as long as you use the
-default settings.
+default settings.
More information is in the
\ilink{Monitor configuration}{_MonitorChapter} chapter.
The File daemon is a program that runs on each (Client) machine. At the
request of the Director, finds the files to be backed up and sends them (their
-data) to the Storage daemon.
+data) to the Storage daemon.
The File daemon configuration file is found in the directory specified on
the {\bf \verb:--:sysconfdir} option that you specified on the {\bf ./configure}
file. Reasonable defaults are set. However, if you are going to back up more
than one machine, you will need to install the File daemon with a unique
configuration file on each machine to be backed up. The information about each
-File daemon must appear in the Director's configuration file.
+File daemon must appear in the Director's configuration file.
% TODO: point to section about how to install just the File daemon
% TODO: and creating the unique configuration file.
-Further details are in the
+Further details are in the
\ilink{File daemon configuration}{FiledConfChapter} chapter.
\subsection{Configuring the Director}
\index[general]{Configuring the Director }
The Director is the central control program for all the other daemons. It
-schedules and monitors all jobs to be backed up.
+schedules and monitors all jobs to be backed up.
The Director configuration file is found in the directory specified on the
{\bf \verb:--:sysconfdir} option that you specified on the {\bf ./configure}
-command. Normally the Director's configuration file is named {\bf bacula-dir.conf}.
+command. Normally the Director's configuration file is named {\bf bacula-dir.conf}.
In general, the only change you must make is modify the FileSet resource so
that the {\bf Include} configuration directive contains at least one line with
-a valid name of a directory (or file) to be saved.
+a valid name of a directory (or file) to be saved.
% TODO: is DLT still the default config?
If you do not have a DLT tape drive, you will probably want to edit the
Storage resource to contain names that are more representative of your actual
storage device. You can always use the existing names as you are free to
arbitrarily assign them, but they must agree with the corresponding names in
-the Storage daemon's configuration file.
+the Storage daemon's configuration file.
You may also want to change the email address for notification from the
-default {\bf root} to your email address.
+default {\bf root} to your email address.
Finally, if you have multiple systems to be backed up, you will need a
separate File daemon or Client specification for each system, specifying its
name as your system but post fixed with {\bf -fd} helps a lot in debugging.
That is, if your system name is {\bf foobaz}, you would give the File daemon
the name {\bf foobaz-fd}. For the Director, you should use {\bf foobaz-dir},
-and for the storage daemon, you might use {\bf foobaz-sd}.
+and for the storage daemon, you might use {\bf foobaz-sd}.
Each of your Bacula components {\bf must} have a unique name. If you
make them all the same, aside from the fact that you will not
know what daemon is sending what message, if they share the same
The Storage daemon is responsible, at the Director's request, for accepting
data from a File daemon and placing it on Storage media, or in the case of a
-restore request, to find the data and send it to the File daemon.
+restore request, to find the data and send it to the File daemon.
The Storage daemon's configuration file is found in the directory specified on
the {\bf \verb:--:sysconfdir} option that you specified on the {\bf ./configure}
Media Type must be the same as the corresponding ones in the Director's
configuration file {\bf bacula-dir.conf}. If you want to backup to a file
instead of a tape, the Archive device must point to a directory in which the
-Volumes will be created as files when you label the Volume.
+Volumes will be created as files when you label the Volume.
\label{ConfigTesting}
Further information is in the
the appropriate daemon with the {\bf -t} option. The daemon will process the
configuration file and print any error messages then terminate. For example,
assuming you have installed your binaries and configuration files in the same
-directory.
+directory.
% TODO: why assume that? common default install has the executable
% TODO: is in ./sbin and the configs are in ./etc. So maybe just have
% TODO: example correct or change default install to be same.
system. If you have installed the binaries in traditional Unix locations
rather than a single file, you will need to modify the above commands
appropriately (no ./ in front of the command name, and a path in front of the
-conf file name).
+conf file name).
\label{TapeTesting}
\section{Testing Compatibility with Your Tape Drive}
override rather than removing /lib/tls. Please see \ilink{ Supported
Operating Systems}{SupportedOSes} for more information on this problem.
-This problem does not occur on systems running Linux 2.6.x kernels.
+This problem does not occur on systems running Linux 2.6.x kernels.
\label{Running1}
Probably the most important part of running Bacula is being able to restore
files. If you haven't tried recovering files at least once, when you actually
have to do it, you will be under a lot more pressure, and prone to make
-errors, than if you had already tried it once.
+errors, than if you had already tried it once.
To get a good idea how to use Bacula in a short time, we {\bf strongly}
-recommend that you follow the example in the
+recommend that you follow the example in the
\ilink{Running Bacula Chapter}{TutorialChapter} of this manual where
-you will get detailed instructions on how to run Bacula.
+you will get detailed instructions on how to run Bacula.
\section{Log Rotation}
\index[general]{Rotation!Log }
\index[general]{Log Watch}
Some systems such as Red Hat and Fedora run the logwatch program
every night, which does an analysis of your log file and sends an
-email report. If you wish to include the output from your Bacula
+email report. If you wish to include the output from your Bacula
jobs in that report, please look in the {\bf scripts/logwatch}
directory. The {\bf README} file in that directory gives a brief
explanation on how to install it and what kind of output to expect.
\index[general]{Disaster Recovery }
If you intend to use Bacula as a disaster recovery tool rather than simply a
-program to restore lost or damaged files, you will want to read the
+program to restore lost or damaged files, you will want to read the
\ilink{Disaster Recovery Using Bacula Chapter}{RescueChapter} of
-this manual.
+this manual.
In any case, you are strongly urged to carefully test restoring some files
that you have saved rather than wait until disaster strikes. This way, you
Most people prefer to have a Pool of tapes that are used for daily backups and
recycled once a week, another Pool of tapes that are used for Full backups
once a week and recycled monthly, and finally a Pool of tapes that are used
-once a month and recycled after a year or two. With a scheme like this, the
+once a month and recycled after a year or two. With a scheme like this, the
number of tapes in your pool or pools remains constant.
By properly defining your Volume Pools with appropriate Retention periods,
-Bacula can manage the recycling (such as defined above) automatically.
+Bacula can manage the recycling (such as defined above) automatically.
Automatic recycling of Volumes is controlled by four records in the {\bf
Pool} resource definition in the Director's configuration file. These four
-records are:
+records are:
-\begin{itemize}
-\item AutoPrune = yes
-\item VolumeRetention = \lt{}time\gt{}
+\begin{bsysitemize}
+\item AutoPrune = yes
+\item VolumeRetention = \lt{}time\gt{}
\item Recycle = yes
\item RecyclePool = \lt{}APool\gt{} %(\textit{This require bacula 2.1.4 or greater})
-\end{itemize}
+\end{bsysitemize}
The above three directives are all you need assuming that you fill
-each of your Volumes then wait the Volume Retention period before
+each of your Volumes then wait the Volume Retention period before
reusing them. If you want Bacula to stop using a Volume and recycle
-it before it is full, you will need to use one or more additional
+it before it is full, you will need to use one or more additional
directives such as:
-\begin{itemize}
+\begin{bsysitemize}
\item Use Volume Once = yes
\item Volume Use Duration = ttt
\item Maximum Volume Jobs = nnn
\item Maximum Volume Bytes = mmm
-\end{itemize}
-Please see below and
+\end{bsysitemize}
+Please see below and
the \ilink{Basic Volume Management}{DiskChapter} chapter
-of this manual for more complete examples.
+of this manual for more complete examples.
Automatic recycling of Volumes is performed by Bacula only when it wants a
new Volume and no appendable Volumes are available in the Pool. It will then
-search the Pool for any Volumes with the {\bf Recycle} flag set and the
-Volume Status is {\bf Purged}. At that point, it will choose the oldest
+search the Pool for any Volumes with the {\bf Recycle} flag set and the
+Volume Status is {\bf Purged}. At that point, it will choose the oldest
purged volume and recycle it.
-If there are no volumes with Status {\bf Purged}, then
+If there are no volumes with Status {\bf Purged}, then
the recycling occurs in two steps:
The first is that the Catalog for a Volume must be pruned of all Jobs (i.e.
Purged). Files contained on that Volume, and the second step is the actual
catalog entries for a volume. You'd usually do this when you want to reuse a
Bacula volume, because there's no point in keeping a list of files that USED TO
BE on a tape. Or, if the catalog is starting to get too big, you could prune
-the oldest jobs to save space. Manual pruning is done with the \ilink{ prune
- command}{ManualPruning} in the console. (thanks to Bryce Denney for the
-above explanation).
+the oldest jobs to save space. Manual pruning is done with the
+\bsysxrlink{prune}{ManualPruning}{console}{command} in the \consoleman{}
+ (thanks to Bryce Denney for the above explanation).
\section{Pruning Directives}
\index[general]{Pruning Directives }
The durations inter-depend a bit because if Bacula prunes a Volume, it
automatically removes all the Job records, and all the File records. Also when
a Job record is pruned, all the File records for that Job are also pruned
-(deleted) from the catalog.
+(deleted) from the catalog.
Having the File records in the database means that you can examine all the
files backed up for a particular Job. They take the most space in the catalog
(probably 90-95\% of the total). When the File records are pruned, the Job
records can remain, and you can still examine what Jobs ran, but not the
details of the Files backed up. In addition, without the File records, you
-cannot use the Console restore command to restore the files.
+cannot use the Console restore command to restore the files.
When a Job record is pruned, the Volume (Media record) for that Job can still
remain in the database, and if you do a "list volumes", you will see the
volume information, but the Job records (and its File records) will no longer
-be available.
+be available.
In each case, pruning removes information about where older files are, but it
also prevents the catalog from growing to be too large. You choose the
time periods you want to keep those records online, and the size of the
database. You can always re-insert the records (with 98\% of the original data)
by using "bscan" to scan in a whole Volume or any part of the volume that
-you want.
+you want.
By setting {\bf AutoPrune} to {\bf yes} you will permit {\bf Bacula} to
automatically prune all Volumes in the Pool when a Job needs another Volume.
change to the physical data on the Volume occurs during the pruning process.
When all files are pruned from a Volume (i.e. no records in the catalog), the
Volume will be marked as {\bf Purged} implying that no Jobs remain on the
-volume. The Pool records that control the pruning are described below.
+volume. The Pool records that control the pruning are described below.
\begin{description}
Bacula will prune all Volumes that can be pruned (i.e. AutoPrune set) in an
attempt to find a usable volume. If during the autoprune, all files are
pruned from the Volume, it will be marked with VolStatus {\bf Purged}. The
- default is {\bf yes}. Note, that although the File and Job records may be
- pruned from the catalog, a Volume will be marked Purged (and hence
+ default is {\bf yes}. Note, that although the File and Job records may be
+ pruned from the catalog, a Volume will be marked Purged (and hence
ready for recycling) if the Volume status is Append, Full, Used, or Error.
If the Volume has another status, such as Archive, Read-Only, Disabled,
Busy, or Cleaning, the Volume status will not be changed to Purged.
When all file catalog entries are removed from the volume, its VolStatus is
set to {\bf Purged}. The files remain physically on the Volume until the
- volume is overwritten.
+ volume is overwritten.
Retention periods are specified in seconds, minutes, hours, days, weeks,
- months, quarters, or years on the record. See the
+ months, quarters, or years on the record. See the
\ilink{Configuration chapter}{Time} of this manual for
- additional details of time specification.
+ additional details of time specification.
-The default is 1 year.
+The default is 1 year.
% TODO: if that is the format, should it be in quotes? decide on a style
\item [Recycle = \lt{}yes|no\gt{}]
\end{description}
It is also possible to "force" pruning of all Volumes in the Pool
- associated with a Job by adding {\bf Prune Files = yes} to the Job resource.
+ associated with a Job by adding {\bf Prune Files = yes} to the Job resource.
\label{Recycling}
\label{RecyclingAlgorithm}
when a Job needs a new Volume and no appendable Volumes are available), Bacula
will look for the oldest Volume that is Purged (all Jobs and Files expired),
and if the {\bf Recycle} flag is on (Recycle=yes) for that Volume, Bacula will
-relabel it and write new data on it.
+relabel it and write new data on it.
As mentioned above, there are two key points for getting a Volume
to be recycled. First, the Volume must no longer be marked Append (there
that reference that Volume. Once both those conditions are satisfied,
the volume can be marked Purged and hence recycled.
-The full algorithm that Bacula uses when it needs a new Volume is:
+The full algorithm that Bacula uses when it needs a new Volume is:
\index[general]{New Volume Algorithm}
\index[general]{Algorithm!New Volume}
The algorithm described below assumes that AutoPrune is enabled,
that Recycling is turned on, and that you have defined
appropriate Retention periods, or used the defaults for all these
-items.
+items.
-\begin{itemize}
+\begin{bsysitemize}
\item If the request is for an Autochanger device, look only
for Volumes in the Autochanger (i.e. with InChanger set and that have
- the correct Storage device).
+ the correct Storage device).
\item Search the Pool for a Volume with VolStatus=Append (if there is more
than one, the Volume with the oldest date last written is chosen. If
two have the same date then the one with the lowest MediaId is chosen).
date last written is chosen. If two have the same date then the one
with the lowest MediaId is chosen).
\item Try recycling any purged Volumes.
-\item Prune volumes applying Volume retention period (Volumes with VolStatus
+\item Prune volumes applying Volume retention period (Volumes with VolStatus
Full, Used, or Append are pruned). Note, even if all the File and Job
records are pruned from a Volume, the Volume will not be marked Purged
until the Volume retention period expires.
-\item Search the Pool for a Volume with VolStatus=Purged
+\item Search the Pool for a Volume with VolStatus=Purged
\item If a Pool named "Scratch" exists, search for a Volume and if found
move it to the current Pool for the Job and use it. Note, when
the Scratch Volume is moved into the current Pool, the basic
(equivalent to an {\bf update volume from pool} command).
\item If we were looking for Volumes in the Autochanger, go back to
step 2 above, but this time, look for any Volume whether or not
- it is in the Autochanger.
-\item Attempt to create a new Volume if automatic labeling enabled
+ it is in the Autochanger.
+\item Attempt to create a new Volume if automatic labeling enabled
If Python is enabled, a Python NewVolume event is generated before
the Label Format directve is used. If the maximum number of Volumes
specified for the pool is reached, a new Volume will not be created.
\item Prune the oldest Volume if RecycleOldestVolume=yes (the Volume with the
oldest LastWritten date and VolStatus equal to Full, Recycle, Purged, Used,
or Append is chosen). This record ensures that all retention periods are
- properly respected.
+ properly respected.
\item Purge the oldest Volume if PurgeOldestVolume=yes (the Volume with the
oldest LastWritten date and VolStatus equal to Full, Recycle, Purged, Used,
or Append is chosen). We strongly recommend against the use of {\bf
PurgeOldestVolume} as it can quite easily lead to loss of current backup
- data.
-\item Give up and ask operator.
-\end{itemize}
+ data.
+\item Give up and ask operator.
+\end{bsysitemize}
The above occurs when Bacula has finished writing a Volume or when no Volume
-is present in the drive.
+is present in the drive.
On the other hand, if you have inserted a different Volume after the last job,
and Bacula recognizes the Volume as valid, it will request authorization from
the Director to use this Volume. In this case, if you have set {\bf Recycle
Current Volume = yes} and the Volume is marked as Used or Full, Bacula will
prune the volume and if all jobs were removed during the pruning (respecting
-the retention periods), the Volume will be recycled and used.
+the retention periods), the Volume will be recycled and used.
-The recycling algorithm in this case is:
-\begin{itemize}
-\item If the VolStatus is {\bf Append} or {\bf Recycle}
- is set, the volume will be used.
+The recycling algorithm in this case is:
+\begin{bsysitemize}
+\item If the VolStatus is {\bf Append} or {\bf Recycle}
+ is set, the volume will be used.
\item If {\bf Recycle Current Volume} is set and the volume is marked {\bf
Full} or {\bf Used}, Bacula will prune the volume (applying the retention
- period). If all Jobs are pruned from the volume, it will be recycled.
-\end{itemize}
+ period). If all Jobs are pruned from the volume, it will be recycled.
+\end{bsysitemize}
This permits users to manually change the Volume every day and load tapes in
an order different from what is in the catalog, and if the volume does not
-contain a current copy of your backup data, it will be used.
+contain a current copy of your backup data, it will be used.
A few points from Alan Brown to keep in mind:
\begin{enumerate}
-\item If a pool doesn't have maximum volumes defined then Bacula will prefer to
+\item If a pool doesn't have maximum volumes defined then Bacula will prefer to
demand new volumes over forcibly purging older volumes.
\item If volumes become free through pruning and the Volume retention period has
record when the Media record is created (normally when the Volume is labeled).
This Recycle status is stored in the Media record of the Catalog. Using
the Console program, you may subsequently change the Recycle status for each
-Volume. For example in the following output from {\bf list volumes}:
+Volume. For example in the following output from {\bf list volumes}:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
+----------+-------+--------+---------+------------+--------+-----+
| VolumeNa | Media | VolSta | VolByte | LastWritte | VolRet | Rec |
+----------+-------+--------+---------+------------+--------+-----+
| File0006 | File | Full | 1896460 | 2002-05-26 | 14400 | 1 |
| File0007 | File | Purged | 1896466 | 2002-05-26 | 14400 | 1 |
+----------+-------+--------+---------+------------+--------+-----+
-\end{verbatim}
+\end{lstlisting}
\normalsize
all the volumes are marked as recyclable, and the last Volume, {\bf File0007}
is still recoverable. A purged Volume simply means that there are no entries
in the Catalog. Even if the Volume Status is changed to {\bf Recycle}, the
data on the Volume will be recoverable. The data is lost only when the Volume
-is re-labeled and re-written.
+is re-labeled and re-written.
To modify Volume {\bf File0001} so that it cannot be recycled, you use the
{\bf update volume pool=File} command in the console program, or simply {\bf
-update} and Bacula will prompt you for the information.
+update} and Bacula will prompt you for the information.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
+----------+------+-------+---------+-------------+-------+-----+
| VolumeNa | Media| VolSta| VolByte | LastWritten | VolRet| Rec |
+----------+------+-------+---------+-------------+-------+-----+
| File0006 | File | Full | 1896460 | 2002-05-26 | 14400 | 1 |
| File0007 | File | Purged| 1896466 | 2002-05-26 | 14400 | 1 |
+----------+------+-------+---------+-------------+-------+-----+
-\end{verbatim}
+\end{lstlisting}
\normalsize
In this case, {\bf File0001} will never be automatically recycled. The same
-effect can be achieved by setting the Volume Status to Read-Only.
+effect can be achieved by setting the Volume Status to Read-Only.
-As you have noted, the Volume Status (VolStatus) column in the
+As you have noted, the Volume Status (VolStatus) column in the
catalog database contains the current status of the Volume, which
is normally maintained automatically by Bacula. To give you an
idea of some of the values it can take during the life cycle of
a Volume, here is a picture created by Arno Lehmann:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
A typical volume life cycle is like this:
because job count or size limit exceeded
Recycled <-------------------------------------- Purged
Volume is selected for reuse
-\end{verbatim}
+\end{lstlisting}
\normalsize
first time it is written, Bacula will simply append to the tape and eventually
request another volume. Using the tape only once, forces the tape to be marked
{\bf Full} after each use, and the next time {\bf Bacula} runs, it will
-recycle the tape.
+recycle the tape.
-An example Pool resource that does this is:
+An example Pool resource that does this is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Pool {
Name = DDS-4
Use Volume Once = yes
VolumeRetention = 12h # expire after 12 hours
Recycle = yes
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{Daily, Weekly, Monthly Tape Usage Example}
This example is meant to show you how one could define a fixed set of volumes
that Bacula will rotate through on a regular schedule. There are an infinite
number of such schemes, all of which have various advantages and
-disadvantages.
+disadvantages.
-We start with the following assumptions:
+We start with the following assumptions:
-\begin{itemize}
-\item A single tape has more than enough capacity to do a full save.
+\begin{bsysitemize}
+\item A single tape has more than enough capacity to do a full save.
\item There are ten tapes that are used on a daily basis for incremental
- backups. They are prelabeled Daily1 ... Daily10.
+ backups. They are prelabeled Daily1 ... Daily10.
\item There are four tapes that are used on a weekly basis for full backups.
- They are labeled Week1 ... Week4.
+ They are labeled Week1 ... Week4.
\item There are 12 tapes that are used on a monthly basis for full backups.
- They are numbered Month1 ... Month12
+ They are numbered Month1 ... Month12
\item A full backup is done every Saturday evening (tape inserted Friday
- evening before leaving work).
-\item No backups are done over the weekend (this is easy to change).
+ evening before leaving work).
+\item No backups are done over the weekend (this is easy to change).
\item The first Friday of each month, a Monthly tape is used for the Full
- backup.
+ backup.
\item Incremental backups are done Monday - Friday (actually Tue-Fri
- mornings).
+ mornings).
% TODO: why this "actually"? does this need to be explained?
- \end{itemize}
+ \end{bsysitemize}
We start the system by doing a Full save to one of the weekly volumes or one
of the monthly volumes. The next morning, we remove the tape and insert a
tape in the series rather than a Weekly tape, then continue. When a Daily tape
finally fills up, {\bf Bacula} will request the next one in the series, and
the next day when you notice the email message, you will mount it and {\bf
-Bacula} will finish the unfinished incremental backup.
+Bacula} will finish the unfinished incremental backup.
What does this give? Well, at any point, you will have the last complete
Full save plus several Incremental saves. For any given file you want to
for at least the last 14 days. For older versions, you will have at least three
and probably four Friday full saves of that file, and going back further, you
will have a copy of that file made on the beginning of the month for at least
-a year.
+a year.
So you have copies of any file (or your whole system) for at least a year, but
as you go back in time, the time between copies increases from daily to weekly
-to monthly.
+to monthly.
-What would the Bacula configuration look like to implement such a scheme?
+What would the Bacula configuration look like to implement such a scheme?
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Schedule {
Name = "NightlySave"
Run = Level=Full Pool=Monthly 1st sat at 03:05
}
FileSet {
Name = "File Set"
- Include {
+ Include {
Options { signature=MD5 }
File = fffffffffffffffff
}
VolumeRetention = 365d # recycle in 1 year
Recycle = yes
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{ Automatic Pruning and Recycling Example}
Perhaps the best way to understand the various resource records that come into
play during automatic pruning and recycling is to run a Job that goes through
the whole cycle. If you add the following resources to your Director's
-configuration file:
+configuration file:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Schedule {
Name = "30 minute cycle"
Run = Level=Full Pool=File Messages=Standard Storage=File
}
FileSet {
Name = "File Set"
- Include {
+ Include {
Options { signature=MD5 }
File = fffffffffffffffff
}
Maximum Volumes = 12
Recycle = yes
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Where you will need to replace the {\bf ffffffffff}'s by the appropriate files
to be saved for your configuration. For the FileSet Include, choose a
directory that has one or two megabytes maximum since there will probably be
-approximately eight copies of the directory that {\bf Bacula} will cycle through.
+approximately eight copies of the directory that {\bf Bacula} will cycle through.
In addition, you will need to add the following to your Storage daemon's
-configuration file:
+configuration file:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Device {
Name = FileStorage
Media Type = File
RemovableMedia = no;
AlwaysOpen = no;
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
With the above resources, Bacula will start a Job every half hour that saves a
copy of the directory you chose to /tmp/File0001 ... /tmp/File0012. After 4
hours, Bacula will start recycling the backup Volumes (/tmp/File0001 ...). You
should see this happening in the output produced. Bacula will automatically
-create the Volumes (Files) the first time it uses them.
+create the Volumes (Files) the first time it uses them.
To turn it off, either delete all the resources you've added, or simply
-comment out the {\bf Schedule} record in the {\bf Job} resource.
+comment out the {\bf Schedule} record in the {\bf Job} resource.
\section{Manually Recycling Volumes}
\label{manualrecycling}
\index[general]{Manually Recycling Volumes }
Although automatic recycling of Volumes is implemented in version 1.20 and
-later (see the
+later (see the
\ilink{Automatic Recycling of Volumes}{RecyclingChapter} chapter of
-this manual), you may want to manually force reuse (recycling) of a Volume.
+this manual), you may want to manually force reuse (recycling) of a Volume.
Assuming that you want to keep the Volume name, but you simply want to write
-new data on the tape, the steps to take are:
+new data on the tape, the steps to take are:
-\begin{itemize}
+\begin{bsysitemize}
\item Use the {\bf update volume} command in the Console to ensure that the
- {\bf Recycle} field is set to {\bf 1}
+ {\bf Recycle} field is set to {\bf 1}
\item Use the {\bf purge jobs volume} command in the Console to mark the
- Volume as {\bf Purged}. Check by using {\bf list volumes}.
-\end{itemize}
+ Volume as {\bf Purged}. Check by using {\bf list volumes}.
+\end{bsysitemize}
Once the Volume is marked Purged, it will be recycled the next time a Volume
-is needed.
+is needed.
If you wish to reuse the tape by giving it a new name, follow the following
-steps:
+steps:
-\begin{itemize}
+\begin{bsysitemize}
\item Use the {\bf purge jobs volume} command in the Console to mark the
- Volume as {\bf Purged}. Check by using {\bf list volumes}.
+ Volume as {\bf Purged}. Check by using {\bf list volumes}.
\item In Bacula version 1.30 or greater, use the Console {\bf relabel}
- command to relabel the Volume.
-\end{itemize}
+ command to relabel the Volume.
+\end{bsysitemize}
-Please note that the relabel command applies only to tape Volumes.
+Please note that the relabel command applies only to tape Volumes.
For Bacula versions prior to 1.30 or to manually relabel the Volume, use the
-instructions below:
+instructions below:
-\begin{itemize}
+\begin{bsysitemize}
\item Use the {\bf delete volume} command in the Console to delete the Volume
- from the Catalog.
+ from the Catalog.
\item If a different tape is mounted, use the {\bf unmount} command,
- remove the tape, and insert the tape to be renamed.
-\item Write an EOF mark in the tape using the following commands:
+ remove the tape, and insert the tape to be renamed.
+\item Write an EOF mark in the tape using the following commands:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
mt -f /dev/nst0 rewind
mt -f /dev/nst0 weof
-\end{verbatim}
+\end{lstlisting}
\normalsize
where you replace {\bf /dev/nst0} with the appropriate device name on your
-system.
+system.
\item Use the {\bf label} command to write a new label to the tape and to
- enter it in the catalog.
-\end{itemize}
+ enter it in the catalog.
+\end{bsysitemize}
Please be aware that the {\bf delete} command can be dangerous. Once it is
done, to recover the File records, you must either restore your database as it
was before the {\bf delete} command, or use the {\bf bscan} utility program to
-scan the tape and recreate the database entries.
+scan the tape and recreate the database entries.
\index[general]{System Requirements }
\index[general]{Requirements!System }
-\begin{itemize}
+\begin{bsysitemize}
\item {\bf Bacula} has been compiled and run on OpenSuSE Linux, FreeBSD, and
Solaris systems.
\item It requires GNU C++ version 2.95 or higher to compile. You can try with
\item The minimum versions for each of the databases supported by Bacula
are:
- \begin{itemize}
+ \begin{bsysitemize}
\item MySQL 4.1
\item PostgreSQL 7.4
\item SQLite 3
- \end{itemize}
+ \end{bsysitemize}
\item If you want to build the Win32 binaries, please see the
README.mingw32 file in the src/win32 directory. We cross-compile the
are sure it contains the patch. dvd+rw-tools without the patch will not
work with Bacula. DVD media is not recommended for serious or important
backups because of its low reliability.
-\end{itemize}
+\end{bsysitemize}
Here are a few important considerations concerning disaster recovery that
you should take into account before a disaster strikes.
-\begin{itemize}
-\item If the building which houses your computers burns down or is otherwise
- destroyed, do you have off-site backup data?
+\begin{bsysitemize}
+\item If the building which houses your computers burns down or is otherwise
+ destroyed, do you have off-site backup data?
\item Disaster recovery is much easier if you have several machines. If you
have a single machine, how will you handle unforeseen events if your only
- machine is down?
+ machine is down?
\item Do you want to protect your whole system and use Bacula to recover
everything? or do you want to try to restore your system from the original
- installation disks and apply any other updates and only restore user files?
-\end{itemize}
+ installation disks and apply any other updates and only restore user files?
+\end{bsysitemize}
\label{steps1}
\section{Steps to Take Before Disaster Strikes}
\index[general]{Steps to Take Before Disaster Strikes}
\index[general]{Strikes!Steps to Take Before Disaster}
-\begin{itemize}
+\begin{bsysitemize}
\item Create a rescue or CDROM for each of your Linux systems. Generally,
- they are offered by each distribution, and there are many good
+ they are offered by each distribution, and there are many good
rescue disks on the Web (Knoppix, sysrescuecd, PLD Linux rescue CD,
tomsrtbt, RIP ...
-\item Create a bacula-hostname directory on
+\item Create a bacula-hostname directory on
each machine and save it somewhere -- possibly on a USB key.
-\item Ensure that you always have a valid bootstrap file for your backup and
+\item Ensure that you always have a valid bootstrap file for your backup and
that it is saved to an alternate machine. This will permit you to
easily do a full restore of your system.
\item If possible copy your catalog nightly to an alternate machine. If you
have a valid bootstrap file, this is not necessary, but can be very useful if
- you do not want to reload everything. .
+ you do not want to reload everything. .
\item Ensure that you always have a valid bootstrap file for your catalog
backup that is saved to an alternate machine. This will permit you to restore
- your catalog more easily if needed.
+ your catalog more easily if needed.
\item Test using the Rescue CDROM before you are forced to use it in
an emergency situation.
\item Make a copy of your Bacula .conf files, particularly your
bacula-dir.conf, and your bacula-sd.conf files, because if your server
goes down, these files will be needed to get it back up and running,
and they can be difficult to rebuild from memory.
-\end{itemize}
+\end{bsysitemize}
\label{rescueCDROM}
\section{Bare Metal Recovery on Linux with a Rescue CD}
Bacula previously had a Rescue CD. Unfortunately, this CD did not work
on every Linux Distro, and in addition, Linux is evolving with different
-boot methods, more and more complex hardware configurations (LVM, RAID,
+boot methods, more and more complex hardware configurations (LVM, RAID,
WiFi, USB, ...). As a consequence, the Bacula Rescue CD as it was
originally envisioned no longer exists.
A so called "Bare Metal" recovery is one where you start with an empty hard
disk and you restore your machine. There are also cases where you may lose a
file or a directory and want it restored. Please see the previous chapter for
-more details for those cases.
+more details for those cases.
Bare Metal Recovery assumes that you have the following items for your system:
-\begin{itemize}
+\begin{bsysitemize}
\item A Rescue CDROM containing a copy of your OS.
\item Perhaps a copy of your
hard disk information, as well as a statically linked version of the
- Bacula File daemon.
+ Bacula File daemon.
\item A full Bacula backup of your system possibly including Incremental or
- Differential backups since the last Full backup
+ Differential backups since the last Full backup
\item A second system running the Bacula Director, the Catalog, and the
Storage daemon. (this is not an absolute requirement, but how to get
around it is not yet documented here)
-\end{itemize}
+\end{bsysitemize}
\section{Requirements}
\index[general]{Requirements}
\index[general]{System!Restoring a Client}
Now, let's assume that your hard disk has just died and that you have replaced
-it with an new identical drive. In addition, we assume that you have:
+it with an new identical drive. In addition, we assume that you have:
\begin{enumerate}
-\item A recent Bacula backup (Full plus Incrementals)
-\item A Rescue CDROM.
+\item A recent Bacula backup (Full plus Incrementals)
+\item A Rescue CDROM.
\item Your Bacula Director, Catalog, and Storage daemon running on another
- machine on your local network.
+ machine on your local network.
\end{enumerate}
This is a relatively simple case, and later in this chapter, as time permits,
we will discuss how you might recover from a situation where the machine that
crashes is your main Bacula server (i.e. has the Director, the Catalog, and
-the Storage daemon).
+the Storage daemon).
-You will take the following steps to get your system back up and running:
+You will take the following steps to get your system back up and running:
\begin{enumerate}
-\item Boot with your Rescue CDROM.
-\item Start the Network (local network)
-\item Re-partition your hard disk(s) as it was before
-\item Re-format your partitions
-\item Restore the Bacula File daemon (static version)
-\item Perform a Bacula restore of all your files
-\item Re-install your boot loader
-\item Reboot
+\item Boot with your Rescue CDROM.
+\item Start the Network (local network)
+\item Re-partition your hard disk(s) as it was before
+\item Re-format your partitions
+\item Restore the Bacula File daemon (static version)
+\item Perform a Bacula restore of all your files
+\item Re-install your boot loader
+\item Reboot
\end{enumerate}
-Now for the details ...
+Now for the details ...
\section{Boot with your Rescue CDROM}
\index[general]{CDROM!Boot with your Rescue}
\normalsize
You can test it by pinging another machine, or pinging your broken machine
-machine from another machine. Do not proceed until your network is up.
+machine from another machine. Do not proceed until your network is up.
\paragraph*{Partition Your Hard Disk(s):}
\paragraph*{Restore and Start the File Daemon:}
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
chroot /mnt/disk /tmp/bacula-fd -c /tmp/bacula-fd.conf
-\end{verbatim}
+\end{lstlisting}
\normalsize
The above command starts the Bacula File daemon with the proper root disk
location (i.e. {\bf /mnt/disk/tmp}. If Bacula does not start, correct the
-problem and start it. You can check if it is running by entering:
+problem and start it. You can check if it is running by entering:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
ps fax
-\end{verbatim}
+\end{lstlisting}
\normalsize
-You can kill Bacula by entering:
+You can kill Bacula by entering:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
kill -TERM <pid>
-\end{verbatim}
+\end{lstlisting}
\normalsize
where {\bf pid} is the first number printed in front of the first occurrence
-of {\bf bacula-fd} in the {\bf ps fax} command.
+of {\bf bacula-fd} in the {\bf ps fax} command.
Now, you should be able to use another computer with Bacula installed to check
-the status by entering:
+the status by entering:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
status client=xxxx
-\end{verbatim}
+\end{lstlisting}
\normalsize
into the Console program, where xxxx is the name of the client you are
-restoring.
+restoring.
One common problem is that your {\bf bacula-dir.conf} may contain machine
addresses that are not properly resolved on the stripped down system to be
resolved on the Director's machine, but not on the machine being restored and
running the File daemon. In that case, be prepared to edit {\bf
bacula-dir.conf} to replace the name of the Storage daemon's domain name with
-its IP address.
+its IP address.
\paragraph*{Restore Your Files:}
starting the restore, there is one final change you must make using the {\bf
mod} option. You must change the {\bf Where} directory to be the root by using
the {\bf mod} option just before running the job and selecting {\bf Where}.
-Set it to:
+Set it to:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
/
-\end{verbatim}
+\end{lstlisting}
\normalsize
-then run the restore.
+then run the restore.
You might be tempted to avoid using {\bf chroot} and running Bacula directly
and then using a {\bf Where} to specify a destination of {\bf /mnt/disk}. This
the new location, and thus any soft links that have been specified with
absolute paths will end up with {\bf /mnt/disk} prefixed to them. In general
this is not fatal to getting your system running, but be aware that you will
-have to fix these links if you do not use {\bf chroot}.
+have to fix these links if you do not use {\bf chroot}.
\paragraph*{Final Step:}
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
/sbin/grub-install --root-directory=/mnt/disk /dev/hda
-\end{verbatim}
+\end{lstlisting}
\normalsize
Note, in this case, you omit the chroot command, and you must
message:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
/dev/hdx does not have any corresponding BIOS drive.
-\end{verbatim}
+\end{lstlisting}
\normalsize
The solution is to insure that all your disks are properly mounted on
/mnt/disk, then do the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
chroot /mnt/disk
mount /dev/pts
-\end{verbatim}
+\end{lstlisting}
\normalsize
Then edit the file {\bf /boot/grub/grub.conf} and uncomment the line
that reads:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#boot=/dev/hda
-\end{verbatim}
+\end{lstlisting}
\normalsize
So that it reads:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
boot=/dev/hda
-\end{verbatim}
+\end{lstlisting}
\normalsize
Note, the /dev/hda may be /dev/sda or possibly some other drive depending
Then, enter the following commands:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
grub --batch --device-map=/boot/grub/device.map \
--config-file=/boot/grub/grub.conf --no-floppy
root (hd0,0)
setup (hd0)
quit
-\end{verbatim}
+\end{lstlisting}
\normalsize
-If the {\bf grub} call worked, you will get a prompt of {\bf grub\gt{}}
-before the {\bf root}, {\bf setup}, and {\bf quit} commands, and after
+If the {\bf grub} call worked, you will get a prompt of {\bf grub\gt{}}
+before the {\bf root}, {\bf setup}, and {\bf quit} commands, and after
entering the {\bf setup} command, it should indicate that it successfully
wrote the MBR (master boot record).
shutdown, then reboot your machine by entering {\bf exit} until you get to the
main prompt then enter {\bf Ctrl-d}. Once back to the main CDROM prompt, you
will need to turn the power off, then back on to your machine to get it to
-reboot.
+reboot.
If everything went well, you should now be back up and running. If not,
-re-insert the emergency boot CDROM, boot, and figure out what is wrong.
+re-insert the emergency boot CDROM, boot, and figure out what is wrong.
\label{restore_server}
\section{Restoring a Server}
Above, we considered how to recover a client machine where a valid Bacula
server was running on another machine. However, what happens if your server
goes down and you no longer have a running Director, Catalog, or Storage
-daemon? There are several solutions:
+daemon? There are several solutions:
\begin{enumerate}
-\item Bring up static versions of your Director, Catalog, and Storage daemon
+\item Bring up static versions of your Director, Catalog, and Storage daemon
on the damaged machine.
-\item Move your server to another machine.
+\item Move your server to another machine.
\item Use a Hot Spare Server on another Machine.
\end{enumerate}
static version of the Director and the Storage daemon as well as the Catalog.
If the Catalog uses MySQL or PostgreSQL, this may or may not be possible. In
addition, to loading all these programs on a bare system (quite possible), you
-will need to make sure you have a valid driver for your tape drive.
+will need to make sure you have a valid driver for your tape drive.
The second suggestion is probably a much simpler solution, and one I have done
-myself. To do so, you might want to consider the following steps:
+myself. To do so, you might want to consider the following steps:
-\begin{itemize}
+\begin{bsysitemize}
\item If you are using MySQL or PostgreSQL, configure, build and install it
- from source (or use rpms) on your new system.
+ from source (or use rpms) on your new system.
\item Load the Bacula source code onto your new system, configure, install
- it, and create the Bacula database.
+ it, and create the Bacula database.
\item Ideally, you will have a copy of all the Bacula conf files that
were being used on your server. If not, you will at a minimum need
create a bacula-dir.conf that has the same Client resource that
the yes/mod/no prompt, selecting {\bf mod} then specifying the path to
the bootstrap file.
\item If you have the Bootstrap file, you should now be back up and running,
- if you do not have a Bootstrap file, continue with the suggestions below.
+ if you do not have a Bootstrap file, continue with the suggestions below.
\item Using {\bf bscan} scan the last set of backup tapes into your MySQL,
- PostgreSQL or SQLite database.
+ PostgreSQL or SQLite database.
\item Start Bacula, and using the Console {\bf restore} command, restore the
last valid copy of the Bacula database and the Bacula configuration
- files.
-\item Move the database to the correct location.
+ files.
+\item Move the database to the correct location.
\item Start the database, and restart Bacula. Then use the Console {\bf
restore} command, restore all the files on the damaged machine, where you
- have loaded a Bacula File daemon using the Rescue disk.
-\end{itemize}
+ have loaded a Bacula File daemon using the Rescue disk.
+\end{bsysitemize}
For additional details of restoring your database, please see the
\ilink{Restoring When Things Go Wrong}{database_restore} section
to be some small difficulties with the scripts, so please be prepared to edit
them in a minimal environment. A rudimentary knowledge of {\bf vi} is very
useful. Also, these scripts do not do everything. You will need to reformat
-Windows partitions by hand, for example.
+Windows partitions by hand, for example.
Getting the boot loader back can be a problem if you are using {\bf grub}
because it is so complicated. If all else fails, reboot your system from your
floppy but using the restored disk image, then proceed to a reinstallation of
grub (looking at the run-grub script can help). By contrast, lilo is a piece
-of cake.
+of cake.
\label{LiveCD}
\section{Bare Metal Recovery using a LiveCD}
you remember your exact hard disk partitioning.
This lack can be easily corrected by running the part of the
-Bacula Rescue code that creates a directory containing a
+Bacula Rescue code that creates a directory containing a
static-bacula-fd, a snapshot of your current system disk
configuration, and scripts that help restoring it.
\begin{enumerate}
\item Run only the {\bf make bacula} part of the
Bacula Rescue procedure to create the static Bacula
- File daemon, and system disk snapshot.
+ File daemon, and system disk snapshot.
\item Save the directory generated (more details below)
preferrably on a CDROM or alternatively to some other
system.
\begin{enumerate}
\item Boot with your system rescue disk or LiveCD
(e.g. Knoppix).
-\item Start the Network (local network).
-\item Copy the Bacula recovery directory to the
+\item Start the Network (local network).
+\item Copy the Bacula recovery directory to the
damaged system using ftp, scp, wget or if your
boot disk permits it reading it directly from a
CDROM.
\item Continue as documented above.
-\item Re-partition your hard disk(s) as it was before,
+\item Re-partition your hard disk(s) as it was before,
if necessary.
-\item Re-format your partitions, if necessary.
-\item Restore the Bacula File daemon (static version).
-\item Perform a Bacula restore of all your files.
-\item Re-install your boot loader.
-\item Reboot.
+\item Re-format your partitions, if necessary.
+\item Restore the Bacula File daemon (static version).
+\item Perform a Bacula restore of all your files.
+\item Re-install your boot loader.
+\item Reboot.
\end{enumerate}
In order to create the Bacula recovery directory, you need
to create the Bacula recovery directory:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cd <bacula-rescue-source>/linux/cdrom
su (become root)
make bacula
-\end{verbatim}
+\end{lstlisting}
\normalsize
The directory you want to save will be created in
The same basic techniques described above also apply to FreeBSD. Although we
don't yet have a fully automated procedure, Alex Torres Molina has provided us
with the following instructions with a few additions from Jesse Guardiani and
-Dan Langille:
+Dan Langille:
\begin{enumerate}
-\item Boot with the FreeBSD installation disk
-\item Go to Custom, Partition and create your slices and go to Label and
- create the partitions that you want. Apply changes.
-\item Go to Fixit to start an emergency console.
+\item Boot with the FreeBSD installation disk
+\item Go to Custom, Partition and create your slices and go to Label and
+ create the partitions that you want. Apply changes.
+\item Go to Fixit to start an emergency console.
\item Create devs ad0 .. .. if they don't exist under /mnt2/dev (in my situation)
with MAKEDEV. The device or devices you create depend on what hard drives you
have. ad0 is your first ATA drive. da0 would by your first SCSI drive. Under
OS version 5 and greater, your device files are most likely automatically
-created for you.
+created for you.
\item mkdir /mnt/disk
- this is the root of the new disk
+ this is the root of the new disk
\item mount /mnt2/dev/ad0s1a /mnt/disk
mount /mnt2/dev/ad0s1c /mnt/disk/var
mount /mnt2/dev/ad0s1d /mnt/disk/usr
.....
The same hard drive issues as above apply here too. Note, under OS version 5
-or higher, your disk devices may be in /dev not /mnt2/dev.
-\item Network configuration (ifconfig xl0 ip/mask + route add default
- ip-gateway)
-\item mkdir /mnt/disk/tmp
-\item cd /mnt/disk/tmp
-\item Copy bacula-fd and bacula-fd.conf to this path
+or higher, your disk devices may be in /dev not /mnt2/dev.
+\item Network configuration (ifconfig xl0 ip/mask + route add default
+ ip-gateway)
+\item mkdir /mnt/disk/tmp
+\item cd /mnt/disk/tmp
+\item Copy bacula-fd and bacula-fd.conf to this path
\item If you need to, use sftp to copy files, after which you must do this:
- ln -s /mnt2/usr/bin /usr/bin
-\item chmod u+x bacula-fd
-\item Modify bacula-fd.conf to fit this machine
-\item Copy /bin/sh to /mnt/disk, necessary for chroot
+ ln -s /mnt2/usr/bin /usr/bin
+\item chmod u+x bacula-fd
+\item Modify bacula-fd.conf to fit this machine
+\item Copy /bin/sh to /mnt/disk, necessary for chroot
\item Don't forget to put your bacula-dir's IP address and domain name in
/mnt/disk/etc/hosts if it's not on a public net. Otherwise the FD on the
machine you are restoring to won't be able to contact the SD and DIR on the
-remote machine.
-\item mkdir -p /mnt/disk/var/db/bacula
+remote machine.
+\item mkdir -p /mnt/disk/var/db/bacula
\item chroot /mnt/disk /tmp/bacula-fd -c /tmp/bacula-fd.conf
- to start bacula-fd
-\item Now you can go to bacula-dir and restore the job with the entire
- contents of the broken server.
-\item You must create /proc
+ to start bacula-fd
+\item Now you can go to bacula-dir and restore the job with the entire
+ contents of the broken server.
+\item You must create /proc
\end{enumerate}
\label{solaris}
\index[general]{Solaris Bare Metal Recovery}
\index[general]{Recovery!Solaris Bare Metal}
-The same basic techniques described above apply to Solaris:
+The same basic techniques described above apply to Solaris:
-\begin{itemize}
-\item the same restrictions as those given for Linux apply
-\item you will need to create a Rescue disk
- \end{itemize}
+\begin{bsysitemize}
+\item the same restrictions as those given for Linux apply
+\item you will need to create a Rescue disk
+ \end{bsysitemize}
However, during the recovery phase, the boot and disk preparation procedures
-are different:
+are different:
-\begin{itemize}
+\begin{bsysitemize}
\item there is no need to create an emergency boot disk since it is an
- integrated part of the Solaris boot.
+ integrated part of the Solaris boot.
\item you must partition and format your hard disk by hand following manual
procedures as described in W. Curtis Preston's book "Unix Backup \&
- Recovery"
-\end{itemize}
+ Recovery"
+\end{bsysitemize}
Once the disk is partitioned, formatted and mounted, you can continue with
-bringing up the network and reloading Bacula.
+bringing up the network and reloading Bacula.
\section{Preparing Solaris Before a Disaster}
\index[general]{Preparing Solaris Before a Disaster}
As mentioned above, before a disaster strikes, you should prepare the
information needed in the case of problems. To do so, in the {\bf
-rescue/solaris} subdirectory enter:
+rescue/solaris} subdirectory enter:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
su
./getdiskinfo
./make_rescue_disk
-\end{verbatim}
+\end{lstlisting}
\normalsize
The {\bf getdiskinfo} script will, as in the case of Linux described above,
diskinfo/sysaudit.bsi} will contain the disk partitioning information that
will allow you to manually follow the procedures in the "Unix Backup \&
Recovery" book to repartition and format your hard disk. In addition, the
-{\bf getdiskinfo} script will create a {\bf start\_network} script.
+{\bf getdiskinfo} script will create a {\bf start\_network} script.
-Once you have your disks repartitioned and formatted, do the following:
+Once you have your disks repartitioned and formatted, do the following:
-\begin{itemize}
-\item Start Your Network with the {\bf start\_network} script
-\item Restore the Bacula File daemon as documented above
+\begin{bsysitemize}
+\item Start Your Network with the {\bf start\_network} script
+\item Restore the Bacula File daemon as documented above
\item Perform a Bacula restore of all your files using the same commands as
- described above for Linux
+ described above for Linux
\item Re-install your boot loader using the instructions outlined in the
- "Unix Backup \& Recovery" book using installboot
-\end{itemize}
+ "Unix Backup \& Recovery" book using installboot
+\end{bsysitemize}
\label{genbugs}
\index[general]{Considerations!Bugs and Other}
\index[general]{Bugs and Other Considerations}
-\paragraph*{Directory Modification and Access Times are Modified on pre-1.30
-Baculas :}
+\paragraph*{Directory Modification and Access Times are Modified on pre-1.30 Bacula:}
When a pre-1.30 version of Bacula restores a directory, it first must create
the directory, then it populates the directory with its files and
subdirectories. The act of creating the files and subdirectories updates both
the modification and access times associated with the directory itself. As a
consequence, all modification and access times of all directories will be
-updated to the time of the restore.
+updated to the time of the restore.
This has been corrected in Bacula version 1.30 and later. The directory
modification and access times are reset to the value saved in the backup after
all the files and subdirectories have been restored. This has been tested and
verified on normal restore operations, but not verified during a bare metal
-recovery.
+recovery.
\paragraph*{Strange Bootstrap Files:}
not include all the files saved to the tape. This is because in some instances
there are duplicates (especially in the case of an Incremental save), and in
such circumstances, {\bf Bacula} restores only the last of multiple copies of
-a file or directory.
+a file or directory.
\label{Win3233}
\section{Disaster Recovery of Win32 Systems}
\index[general]{Disaster Recovery of Win32 Systems}
Due to open system files, and registry problems, Bacula cannot save and
-restore a complete Win2K/XP/NT environment.
+restore a complete Win2K/XP/NT environment.
A suggestion by Damian Coutts using Microsoft's NTBackup utility in
conjunction with Bacula should permit a Full bare metal restore of Win2K/XP
(and possibly NT systems). His suggestion is to do an NTBackup of the critical
-system state prior to running a Bacula backup with the following command:
+system state prior to running a Bacula backup with the following command:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
ntbackup backup systemstate /F c:\systemstate.bkf
-\end{verbatim}
+\end{lstlisting}
\normalsize
The {\bf backup} is the command, the {\bf systemstate} says to backup only the
you would use Bacula to restore all the users files and to recover the {\bf
c:\textbackslash{}systemstate.bkf} file, and finally, run {\bf NTBackup} and
{\bf catalogue} the system statefile, and then select it for restore. The
-documentation says you can't run a command line restore of the systemstate.
+documentation says you can't run a command line restore of the systemstate.
This procedure has been confirmed to work by Ludovic Strappazon -- many
-thanks!
+thanks!
A new tool is provided in the form of a bacula plugin for the BartPE rescue
CD. BartPE is a self-contained WindowsXP boot CD which you can make using the
-PeBuilder tools available at
+PeBuilder tools available at
\elink{http://www.nu2.nu/pebuilder/}{http://www.nu2.nu/pebuilder/} and a valid
Windows XP SP1 CDROM. The plugin is provided as a zip archive. Unzip the file
and copy the bacula directory into the plugin directory of your BartPE
booted CD contains entries to install the file client service, start the file
client service, and start the WX-Console. You can also open a command line
window and CD Programs\textbackslash{}Bacula and run the command line console
-bconsole.
+bconsole.
\section{Ownership and Permissions on Win32 Systems}
\index[general]{Systems!Resetting Directory and File Ownership and Permissions
on all WinNT/XP/2K systems. If you do experience problems, generally in
restores to alternate directories because higher level directories were not
backed up by Bacula, you can correct any problems with the {\bf SetACL}
-available under the GPL license at:
+available under the GPL license at:
\elink{http://sourceforge.net/projects/setacl/}{http://sourceforge.net/project%
-s/setacl/}.
+s/setacl/}.
\section{Alternate Disaster Recovery Suggestion for Win32 Systems}
\index[general]{Systems!Alternate Disaster Recovery Suggestion for Win32}
disk as described above for Linux, install a statically linked Bacula, and
backup any of the raw partitions you want. Then to restore the system, you
simply restore the raw partition or partitions. Here is the email that Ludovic
-recently sent on that subject:
+recently sent on that subject:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
I've just finished testing my brand new cd LFS/Bacula
with a raw Bacula backup and restore of my portable.
I can't resist sending you the results: look at the rates !!!
hunt-dir: Begin pruning Files.
hunt-dir: No Files found to prune.
hunt-dir: End auto prune.
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{running}
overwrite the following files:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
/etc/grub.conf
/etc/X11/Conf
/etc/fstab
/usr/modules
/usr/X11R6
/etc/modules.conf
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{Resources}
\index[general]{Additional Resources}
\index[general]{Resources!Additional}
-Many thanks to Charles Curley who wrote
+Many thanks to Charles Curley who wrote
\elink{Linux Complete Backup and Recovery HOWTO}
{http://www.tldp.org/HOWTO/Linux-Complete-Backup-and-Recovery-HOWTO/index.html%
-} for the
+} for the
\elink{The Linux Documentation Project}{http://www.tldp.org/}. This is an
excellent document on how to do Bare Metal Recovery on Linux systems, and it
-was this document that made me realize that Bacula could do the same thing.
+was this document that made me realize that Bacula could do the same thing.
-You can find quite a few additional resources, both commercial and free at
+You can find quite a few additional resources, both commercial and free at
\elink{Storage Mountain}{http://www.backupcentral.com}, formerly known as
-Backup Central.
+Backup Central.
And finally, the O'Reilly book, "Unix Backup \& Recovery" by W. Curtis
Preston covers virtually every backup and recovery topic including bare metal
-recovery for a large range of Unix systems.
+recovery for a large range of Unix systems.
Below, we will discuss restoring files with the Console {\bf restore} command,
which is the recommended way of doing restoring files. It is not possible
to restore files by automatically starting a job as you do with Backup,
-Verify, ... jobs. However, in addition to the console restore command,
+Verify, \ldots{} jobs. However, in addition to the console restore command,
there is a standalone program named {\bf bextract}, which also permits
restoring files. For more information on this program, please see the
-\ilink{Bacula Utility Programs}{bextract} chapter of this manual. We
+\bsysxrlink{bextract}{bextract}{utility}{command} in the \utilityman{}. We
don't particularly recommend the {\bf bextract} program because it
-lacks many of the features of the normal Bacula restore, such as the
+lacks many of the features of the normal Bacula restore, such as the
ability to restore Win32 files to Unix systems, and the ability to
restore access control lists (ACL). As a consequence, we recommend,
wherever possible to use Bacula itself for restores as described below.
which allows you to list the contents of your Volumes. Finally, if you
have an old Volume that is no longer in the catalog, you can restore the
catalog entries using the program named {\bf bscan}, documented in the same
-\ilink{Bacula Utility Programs}{bscan} chapter.
+\bsysxrlink{bscan}{bscan}{utility}{command} in the \utilityman{}.
In general, to restore a file or a set of files, you must run a {\bf restore}
job. That is a job with {\bf Type = Restore}. As a consequence, you will need
a predefined {\bf restore} job in your {\bf bacula-dir.conf} (Director's
-config) file. The exact parameters (Client, FileSet, ...) that you define are
+config) file. The exact parameters (Client, FileSet, \ldots{}) that you define are
not important as you can either modify them manually before running the job or
-if you use the {\bf restore} command, explained below, Bacula will
+if you use the {\bf restore} command, explained below, Bacula will
automatically set them for you. In fact, you can no longer simply run a restore
-job. You must use the restore command.
+job. You must use the restore command.
Since Bacula is a network backup program, you must be aware that when you
restore files, it is up to you to ensure that you or Bacula have selected the
{\bf Bacula} will quite willingly backup client A, and restore it by sending
the files to a different directory on client B. Normally, you will want to
avoid this, but assuming the operating systems are not too different in their
-file structures, this should work perfectly well, if so desired.
+file structures, this should work perfectly well, if so desired.
By default, Bacula will restore data to the same Client that was backed
up, and those data will be restored not to the original places but to
{\bf /tmp/bacula-restores}. You may modify any of these defaults when the
Since Bacula maintains a catalog of your files and on which Volumes (disk or
tape), they are stored, it can do most of the bookkeeping work, allowing you
simply to specify what kind of restore you want (current, before a particular
-date), and what files to restore. Bacula will then do the rest.
+date), and what files to restore. Bacula will then do the rest.
This is accomplished using the {\bf restore} command in the Console. First you
select the kind of restore you want, then the JobIds are selected,
tree, and the restore enters a file selection mode that allows you to
interactively walk up and down the file tree selecting individual files to be
restored. This mode is somewhat similar to the standard Unix {\bf restore}
-program's interactive file selection mode.
+program's interactive file selection mode.
If a Job's file records have been pruned from the catalog, the {\bf restore}
command will be unable to find any files to restore. Bacula will ask if you
option}{FileRegex} and below for more details on this.
Within the Console program, after entering the {\bf restore} command, you are
-presented with the following selection prompt:
+presented with the following selection prompt:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
First you select one or more JobIds that contain files
to be restored. You will be presented several methods
of specifying the JobIds. Then you will be allowed to
11: Enter a list of directories to restore for found JobIds
12: Cancel
Select item: (1-12):
-\end{verbatim}
+\end{lstlisting}
\normalsize
There are a lot of options, and as a point of reference, most people will
want to slect item 5 (the most recent backup for a client). The details
of the above options are:
-\begin{itemize}
+\begin{bsysitemize}
\item Item 1 will list the last 20 jobs run. If you find the Job you want,
you can then select item 3 and enter its JobId(s).
\item Item 2 will list all the Jobs where a specified file is saved. If you
find the Job you want, you can then select item 3 and enter the JobId.
-\item Item 3 allows you the enter a list of comma separated JobIds whose
+\item Item 3 allows you the enter a list of comma separated JobIds whose
files will be put into the directory tree. You may then select which
files from those JobIds to restore. Normally, you would use this option
if you have a particular version of a file that you want to restore and
you know its JobId. The most common options (5 and 6) will not select
- a job that did not terminate normally, so if you know a file is
+ a job that did not terminate normally, so if you know a file is
backed up by a Job that failed (possibly because of a system crash), you
- can access it through this option by specifying the JobId.
+ can access it through this option by specifying the JobId.
\item Item 4 allows you to enter any arbitrary SQL command. This is
probably the most primitive way of finding the desired JobIds, but at
you will need to explicitly enter the JobId in item 3, then choose the
files to restore.
- If some of the Jobs that are needed to do the restore have had their
+ If some of the Jobs that are needed to do the restore have had their
File records pruned, the restore will be incomplete. Bacula currently
does not correctly detect this condition. You can however, check for
this by looking carefully at the list of Jobs that Bacula selects and
\item Item 6 allows you to specify a date and time, after which Bacula will
automatically select the most recent Full backup and all subsequent
incremental and differential backups that started before the specified date
- and time.
+ and time.
\item Item 7 allows you to specify one or more filenames (complete path
required) to be restored. Each filename is entered one at a time or if you
- prefix a filename with the less-than symbol (\lt{}) Bacula will read that
+ prefix a filename with the less-than symbol (\lt{}) Bacula will read that
file and assume it is a list of filenames to be restored. If you
prefix the filename with a question mark (?), then the filename will
be interpreted as an SQL table name, and Bacula will include the rows
of that table in the list to be restored. The table must contain the
- JobId in the first column and the FileIndex in the second column.
+ JobId in the first column and the FileIndex in the second column.
This table feature is intended for external programs that want to build
their own list of files to be restored.
The filename entry mode is terminated by entering a blank line.
will be restored in the subdirectory unless you explicitly enter its
name.
-\item Item 12 allows you to cancel the restore command.
-\end{itemize}
+\item Item 12 allows you to cancel the restore command.
+\end{bsysitemize}
As an example, suppose that we select item 5 (restore to most recent state).
If you have not specified a client=xxx on the command line, it
it will then ask for the desired Client, which on my system, will print all
-the Clients found in the database as follows:
+the Clients found in the database as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Defined clients:
1: Rufus
2: Matou
8: RufusVerify
9: Watchdog
Select Client (File daemon) resource (1-9):
-\end{verbatim}
+\end{lstlisting}
\normalsize
You will probably have far fewer Clients than this example, and if you have
only one Client, it will be automatically selected. In this case, I enter
{\bf Rufus} to select the Client. Then Bacula needs to know what FileSet is
-to be restored, so it prompts with:
+to be restored, so it prompts with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
The defined FileSet resources are:
1: Full Set
2: Other Files
Select FileSet resource (1-2):
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you have only one FileSet defined for the Client, it will be selected
At this point, {\bf Bacula} has all the information it needs to find the most
recent set of backups. It will then query the database, which may take a bit
of time, and it will come up with something like the following. Note, some of
-the columns are truncated here for presentation:
+the columns are truncated here for presentation:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
+-------+------+----------+-------------+-------------+------+-------+------------+
| JobId | Levl | JobFiles | StartTime | VolumeName | File | SesId |VolSesTime |
+-------+------+----------+-------------+-------------+------+-------+------------+
Building directory tree for JobId 1798 ...
cwd is: /
$
-\end{verbatim}
+\end{lstlisting}
\normalsize
Depending on the number of {\bf JobFiles} for each JobId, the {\bf Building
-directory tree ..."} can take a bit of time. If you notice ath all the
+directory tree \ldots{}"} can take a bit of time. If you notice ath all the
JobFiles are zero, your Files have probably been pruned and you will not be
able to select any individual files -- it will be restore everything or
nothing.
that Job wrote on two different Volumes. The third Job was an incremental
backup to the previous Full backup, and it only saved 254 Files compared to
128,374 for the Full backup. The fourth Job was also an incremental backup
-that saved 15 files.
+that saved 15 files.
Next Bacula entered those Jobs into the directory tree, with no files marked
to be restored as a default, tells you how many files are in the tree, and
tells you that the current working directory ({\bf cwd}) is /. Finally, Bacula
prompts with the dollar sign (\$) to indicate that you may enter commands to
-move around the directory tree and to select files.
-
+move around the directory tree and to select files.
+
If you want all the files to automatically be marked when the directory
tree is built, you could have entered the command {\bf restore all}, or
at the \$ prompt, you can simply enter {\bf mark *}.
Instead of choosing item 5 on the first menu (Select the most recent backup
for a client), if we had chosen item 3 (Enter list of JobIds to select) and we
had entered the JobIds {\bf 1792,1797,1798} we would have arrived at the same
-point.
+point.
One point to note, if you are manually entering JobIds, is that you must enter
them in the order they were run (generally in increasing JobId order). If you
enter them out of order and the same file was saved in two or more of the
Jobs, you may end up with an old version of that file (i.e. not the most
-recent).
+recent).
Directly entering the JobIds can also permit you to recover data from
a Job that wrote files to tape but that terminated with an error status.
While in file selection mode, you can enter {\bf help} or a question mark (?)
-to produce a summary of the available commands:
+to produce a summary of the available commands:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Command Description
======= ===========
cd change current directory
unmarkdir unmark directory name only no recursion
quit quit and do not do restore
? print help
-\end{verbatim}
+\end{lstlisting}
\normalsize
As a default no files have been selected for restore (unless you
added {\bf all} to the command line. If you want to restore
everything, at this point, you should enter {\bf mark *}, and then {\bf done}
and {\bf Bacula} will write the bootstrap records to a file and request your
-approval to start a restore job.
+approval to start a restore job.
If you do not enter the above mentioned {\bf mark *} command, you will start
with an empty slate. Now you can simply start looking at the tree and {\bf
a mistake in specifying a file to mark or unmark, and Bacula's error handling
is not perfect, so please check your work by using the {\bf ls} or {\bf dir}
commands to see what files are actually selected. Any selected file has its
-name preceded by an asterisk.
+name preceded by an asterisk.
To check what is marked or not marked, enter the {\bf count} command, which
-displays:
+displays:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
128401 total files. 128401 marked to be restored.
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
Each of the above commands will be described in more detail in the next
section. We continue with the above example, having accepted to restore all
files as Bacula set by default. On entering the {\bf done} command, Bacula
-prints:
+prints:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Bootstrap records written to /home/kern/bacula/working/restore.bsr
-The job will require the following
+The job will require the following
Volume(s) Storage(s) SD Device(s)
===========================================================================
Catalog: MyCatalog
Priority: 10
OK to run? (yes/mod/no):
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
Please examine each of the items very carefully to make sure that they are
Director's configuration file. Normally, you will only need one Restore Job
resource definition because by its nature, restoring is a manual operation,
and using the Console interface, you will be able to modify the Restore Job to
-do what you want.
+do what you want.
-An example Restore Job resource definition is given below.
+An example Restore Job resource definition is given below.
Returning to the above example, you should verify that the Client name is
correct before running the Job. However, you may want to modify some of the
The restore will choose the files to be restored either by reading the {\bf
Bootstrap} file, or if not specified, it will restore all files associated
with the specified backup {\bf JobId} (i.e. the JobId of the Job that
-originally backed up the files).
+originally backed up the files).
Finally before running the job, please note that the default location for
restoring files is {\bf not} their original locations, but rather the directory
{\bf /tmp/bacula-restores}. You can change this default by modifying your {\bf
bacula-dir.conf} file, or you can modify it using the {\bf mod} option. If you
want to restore the files to their original location, you must have {\bf
-Where} set to nothing or to the root, i.e. {\bf /}.
+Where} set to nothing or to the root, i.e. {\bf /}.
If you now enter {\bf yes}, Bacula will run the restore Job. The Storage
daemon will first request Volume {\bf DLT-19Jul02} and after the appropriate
files have been restored from that volume, it will request Volume {\bf
-DLT-04Aug02}.
+DLT-04Aug02}.
\subsection{Restore a pruned job using a pattern}
During a restore, if all File records are pruned from the catalog
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}
+\begin{lstlisting}
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|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}
+\end{lstlisting}
See also \ilink{FileRegex bsr option}{FileRegex} for more information.
If you have a small number of files to restore, and you know the filenames,
you can either put the list of filenames in a file to be read by Bacula, or
you can enter the names one at a time. The filenames must include the full
-path and filename. No wild cards are used.
+path and filename. No wild cards are used.
To enter the files, after the {\bf restore}, you select item number 7 from the
-prompt list:
+prompt list:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
To select the JobIds, you have the following choices:
1: List last 20 Jobs run
2: List Jobs where a given File is saved
11: Enter a list of directories to restore for found JobIds
12: Cancel
Select item: (1-12):
-\end{verbatim}
+\end{lstlisting}
\normalsize
-which then prompts you for the client name:
+which then prompts you for the client name:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Defined Clients:
1: Timmy
2: Tibs
3: Rufus
Select the Client (1-3): 3
-\end{verbatim}
+\end{lstlisting}
\normalsize
Of course, your client list will be different, and if you have only one
client, it will be automatically selected. And finally, Bacula requests you to
-enter a filename:
+enter a filename:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Enter filename:
-\end{verbatim}
+\end{lstlisting}
\normalsize
-At this point, you can enter the full path and filename
+At this point, you can enter the full path and filename
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Enter filename: /home/kern/bacula/k/Makefile.in
Enter filename:
-\end{verbatim}
+\end{lstlisting}
\normalsize
as you can see, it took the filename. If Bacula cannot find a copy of the
-file, it prints the following:
+file, it prints the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Enter filename: junk filename
No database record found for: junk filename
Enter filename:
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you want Bacula to read the filenames from a file, you simply precede the
filename with a less-than symbol (\lt{}). When you have entered all the
filenames, you enter a blank line, and Bacula will write the bootstrap file,
-tells you what tapes will be used, and proposes a Restore job to be run:
+tells you what tapes will be used, and proposes a Restore job to be run:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Enter filename:
Automatically selected Storage: DDS-4
Bootstrap records written to /home/kern/bacula/working/restore.bsr
The restore job will require the following Volumes:
-
+
test1
1 file selected to restore.
Run Restore job
When: 2003-09-11 10:20:53
Priority: 10
OK to run? (yes/mod/no):
-\end{verbatim}
+\end{lstlisting}
\normalsize
It is possible to automate the selection by file by putting your list of files
-in say {\bf /tmp/file-list}, then using the following command:
+in say {\bf /tmp/file-list}, then using the following command:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
restore client=Rufus file=</tmp/file-list
-\end{verbatim}
+\end{lstlisting}
\normalsize
If in modifying the parameters for the Run Restore job, you find that Bacula
asks you to enter a Job number, this is because you have not yet specified
either a Job number or a Bootstrap file. Simply entering zero will allow you
-to continue and to select another option to be modified.
+to continue and to select another option to be modified.
\label{Replace}
\section{Replace Options}
-When restoring, you have the option to specify a Replace option. This
-directive determines the action to be taken when restoring a file or
-directory that already exists. This directive can be set by selecting
+When restoring, you have the option to specify a Replace option. This
+directive determines the action to be taken when restoring a file or
+directory that already exists. This directive can be set by selecting
the {\bf mod} option. You will be given a list of parameters to choose
from. Full details on this option can be found in the Job Resource section
of the Director documentation.
If all the above sounds complicated, you will probably agree that it really
isn't after trying it a few times. It is possible to do everything that was
shown above, with the exception of selecting the FileSet, by using command
-line arguments with a single command by entering:
+line arguments with a single command by entering:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
restore client=Rufus select current all done yes
-\end{verbatim}
+\end{lstlisting}
\normalsize
The {\bf client=Rufus} specification will automatically select Rufus as the
client, the {\bf current} tells Bacula that you want to restore the system to
the most current state possible, and the {\bf yes} suppresses the final {\bf
-yes/mod/no} prompt and simply runs the restore.
+yes/mod/no} prompt and simply runs the restore.
-The full list of possible command line arguments are:
+The full list of possible command line arguments are:
-\begin{itemize}
-\item {\bf all} -- select all Files to be restored.
-\item {\bf select} -- use the tree selection method.
-\item {\bf done} -- do not prompt the user in tree mode.
+\begin{bsysitemize}
+\item {\bf all} -- select all Files to be restored.
+\item {\bf select} -- use the tree selection method.
+\item {\bf done} -- do not prompt the user in tree mode.
\item {\bf current} -- automatically select the most current set of backups
- for the specified client.
+ for the specified client.
\item {\bf client=xxxx} -- initially specifies the client from which the
backup was made and the client to which the restore will be make. See also
"restoreclient" keyword.
\item {\bf restoreclient=xxxx} -- if the keyword is specified, then the
restore is written to that client.
\item {\bf jobid=nnn} -- specify a JobId or comma separated list of JobIds to
- be restored.
+ be restored.
\item {\bf before=YYYY-MM-DD HH:MM:SS} -- specify a date and time to which
the system should be restored. Only Jobs started before the specified
date/time will be selected, and as is the case for {\bf current} Bacula will
automatically find the most recent prior Full save and all Differential and
Incremental saves run before the date you specify. Note, this command is not
- too user friendly in that you must specify the date/time exactly as shown.
+ too user friendly in that you must specify the date/time exactly as shown.
\item {\bf file=filename} -- specify a filename to be restored. You must
specify the full path and filename. Prefixing the entry with a less-than
sign
(\lt{}) will cause Bacula to assume that the filename is on your system and
contains a list of files to be restored. Bacula will thus read the list from
that file. Multiple file=xxx specifications may be specified on the command
- line.
-\item {\bf jobid=nnn} -- specify a JobId to be restored.
+ line.
+\item {\bf jobid=nnn} -- specify a JobId to be restored.
\item {\bf pool=pool-name} -- specify a Pool name to be used for selection of
Volumes when specifying options 5 and 6 (restore current system, and restore
current system before given date). This permits you to have several Pools,
- possibly one offsite, and to select the Pool to be used for restoring.
+ possibly one offsite, and to select the Pool to be used for restoring.
\item {\bf where=/tmp/bacula-restore} -- restore files in {\bf where} directory.
\item {\bf yes} -- automatically run the restore without prompting for
- modifications (most useful in batch scripts).
+ modifications (most useful in batch scripts).
\item {\bf strip\_prefix=/prod} -- remove a part of the filename when restoring.
\item {\bf add\_prefix=/test} -- add a prefix to all files when restoring (like
where) (can't be used with {\bf where=}).
\item {\bf add\_suffix=.old} -- add a suffix to all your files.
\item {\bf regexwhere=!a.pdf!a.bkp.pdf!} -- do complex filename manipulation
like with sed unix command. Will overwrite other filename manipulation.
-\end{itemize}
+\end{bsysitemize}
\label{restorefilerelocation}
\section{Using File Relocation}
\texttt{/.snap/home/eric/mbox}, which can complicate restores. If you use
\textbf{where=/tmp}, the file will be restored to
\texttt{/tmp/.snap/home/eric/mbox} and you will have to move the file to
-\texttt{/home/eric/mbox.bkp} by hand.
+\texttt{/home/eric/mbox.bkp} by hand.
However, case, you could use the
\textbf{strip\_prefix=/.snap} and \textbf{add\_suffix=.bkp} options and
Bacula will restore the file to its original location -- that is
\texttt{/home/eric/mbox}.
-To use this feature, there are command line options as described in
+To use this feature, there are command line options as described in
the \ilink{restore section}{restorefilerelocation} of this manual;
you can modify your restore job before running it; or you can
-add options to your restore job in as described in
+add options to your restore job in as described in
\ilink{bacula-dir.conf}{confaddprefix}.
-\begin{verbatim}
+\begin{lstlisting}
Parameters to modify:
1: Level
2: Storage
4: Enter a regexp
5: Test filename manipulation
6: Use this ?
-Select parameter to modify (1-6):
-\end{verbatim}
+Select parameter to modify (1-6):
+\end{lstlisting}
-\subsection{RegexWhere Format}
+\subsection{RegexWhere Format}\label{useregexwhere}
The format is very close to that used by sed or Perl (\texttt{s/replace this/by
that/}) operator. A valid regexwhere expression has three fields :
-\begin{itemize}
+\begin{bsysitemize}
\item a search expression (with optionnal submatch)
\item a replacement expression (with optionnal back references \$1 to \$9)
\item a set of search options (only case-insensitive ``i'' at this time)
-\end{itemize}
+\end{bsysitemize}
Each field is delimited by a separator specified by the user as the first
character of the expression. The separator can be one of the following:
-\begin{verbatim}
+\begin{lstlisting}
<separator-keyword> = / ! ; % : , ~ # = &
-\end{verbatim}
+\end{lstlisting}
You can use several expressions separated by a commas.
\subsection*{Examples}
-\begin{tabular}{|c|c|c|l|}
-\hline
-Orignal filename & New filename & RegexWhere & Comments \\
-\hline
-\hline
-\texttt{c:/system.ini} & \texttt{c:/system.old.ini} & \texttt{/.ini\$/.old.ini/} & \$ matches end of name\\
-\hline
-\texttt{/prod/u01/pdata/} & \texttt{/rect/u01/rdata} & \texttt{/prod/rect/,/pdata/rdata/} & uses two regexp\\
-\hline
-\texttt{/prod/u01/pdata/} & \texttt{/rect/u01/rdata} & \texttt{!/prod/!/rect/!,/pdata/rdata/} & use \texttt{!} as separator\\
-\hline
-\texttt{C:/WINNT} & \texttt{d:/WINNT} & \texttt{/c:/d:/i} & case insensitive pattern match \\
-\hline
-
-\end{tabular}
+\LTXtable{0.95\linewidth}{table_regexp}
%\subsubsection{Using group}
%
-%Like with Perl or Sed, you can make submatch with \texttt{()},
+%Like with Perl or Sed, you can make submatch with \texttt{()},
%
%\subsubsection*{Examples}
Depending how you do the restore, you may or may not get the directory entries
back to their original state. Here are a few of the problems you can
-encounter, and for same machine restores, how to avoid them.
+encounter, and for same machine restores, how to avoid them.
-\begin{itemize}
-\item You backed up on one machine and are restoring to another that is
+\begin{bsysitemize}
+\item You backed up on one machine and are restoring to another that is
either a different OS or doesn't have the same users/groups defined. Bacula
does the best it can in these situations. Note, Bacula has saved the
user/groups in numeric form, which means on a different machine, they
\item The {\bf bextract} program does not restore access control lists
(ACLs) to Unix machines.
-\end{itemize}
+\end{bsysitemize}
\label{Windows}
\section{Restoring on Windows}
directories being restored (i.e. written to tape).
The default restore location is {\bf /tmp/bacula-restores/} and if you are
-restoring from drive {\bf E:}, the default will be
+restoring from drive {\bf E:}, the default will be
{\bf /tmp/bacula-restores/e/}, so you should ensure that this directory
exists before doing the restore, or use the {\bf mod} option to
select a different {\bf where} directory that does exist.
positioned and Bacula only needs to write. On the other hand, because restoring
files is done so rarely, Bacula keeps only the start file and block on the
tape for the whole job rather than on a file by file basis which would use
-quite a lot of space in the catalog.
+quite a lot of space in the catalog.
Bacula will forward space to the correct file mark on the tape for the Job,
then forward space to the correct block, and finally sequentially read each
record until it gets to the correct one(s) for the file or files you want to
restore. Once the desired files are restored, Bacula will stop reading the
-tape.
+tape.
Finally, instead of just reading a file for backup, during the restore, Bacula
must create the file, and the operating system must allocate disk space for
-the file as Bacula is restoring it.
+the file as Bacula is restoring it.
For all the above reasons the restore process is generally much slower than
backing up (sometimes it takes three times as long).
\index[general]{Problems Restoring Files }
The most frequent problems users have restoring files are error messages such
-as:
+as:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
04-Jan 00:33 z217-sd: RestoreFiles.2005-01-04_00.31.04 Error:
block.c:868 Volume data error at 20:0! Short block of 512 bytes on
device /dev/tape discarded.
-\end{verbatim}
+\end{lstlisting}
\normalsize
-or
+or
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
04-Jan 00:33 z217-sd: RestoreFiles.2005-01-04_00.31.04 Error:
block.c:264 Volume data error at 20:0! Wanted ID: "BB02", got ".".
Buffer discarded.
-\end{verbatim}
+\end{lstlisting}
\normalsize
Both these kinds of messages indicate that you were probably running your tape
Bacula repositions the tape on a block basis when restoring files because this
will speed up the restore by orders of magnitude when only a few files are being
restored. There are several ways that you can attempt to recover from this
-unfortunate situation.
+unfortunate situation.
Try the following things, each separately, and reset your Device resource to
-what it is now after each individual test:
+what it is now after each individual test:
\begin{enumerate}
\item Set "Block Positioning = no" in your Device resource and try the
- restore. This is a new directive and untested.
+ restore. This is a new directive and untested.
\item Set "Minimum Block Size = 512" and "Maximum Block Size = 512" and
try the restore. If you are able to determine the block size your drive
to continue backing up your data without correcting this condition.
Please see the Tape Testing chapter for more on this.
-\item Try editing the restore.bsr file at the Run xxx yes/mod/no prompt
+\item Try editing the restore.bsr file at the Run xxx yes/mod/no prompt
before starting the restore job and remove all the VolBlock statements.
These are what causes Bacula to reposition the tape, and where problems
occur if you have a fixed block size set for your drive. The VolFile
\item [file count mismatch]
This can occur for the following reasons:
- \begin{itemize}
+ \begin{bsysitemize}
\item You requested Bacula not to overwrite existing or newer
files.
\item A Bacula miscount of files/directories. This is an
on-going problem due to the complications of directories,
soft/hard link, and such. Simply check that all the files you
wanted were actually restored.
- \end{itemize}
+ \end{bsysitemize}
\item [file size error]
When Bacula restores files, it checks that the size of the
- restored file is the same as the file status data it saved
+ restored file is the same as the file status data it saved
when starting the backup of the file. If the sizes do not
agree, Bacula will print an error message. This size mismatch
most often occurs because the file was being written as Bacula
\index[general]{Resource!Example Restore Job }
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = "RestoreFiles"
Type = Restore
Messages = Standard
Pool = Default
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
If {\bf Where} is not specified, the default location for restoring files will
-be their original locations.
+be their original locations.
\label{Selection}
\section{File Selection Commands}
restored. As a default no files are marked to be restored. If you wish to
start with all files, simply enter: {\bf cd /} and {\bf mark *}. Otherwise
proceed to select the files you wish to restore by marking them with the {\bf
-mark} command. The available commands are:
+mark} command. The available commands are:
\begin{description}
It operates much like the Unix {\bf cd} command. Wildcard specifications are
not permitted.
- Note, on Windows systems, the various drives (c:, d:, ...) are treated like a
+ Note, on Windows systems, the various drives (c:, d:, \ldots{}) are treated like a
directory within the file tree while in the file selection mode. As a
consequence, you must do a {\bf cd c:} or possibly in some cases a {\bf cd
C:} (note upper case) to get down to the first directory.
\index[dir]{find}
The {\bf find} command accepts one or more arguments and displays all files
in the tree that match that argument. The argument may have wildcards. It is
- somewhat similar to the Unix command {\bf find / -name arg}.
+ somewhat similar to the Unix command {\bf find / -name arg}.
\item [ls]
The {\bf ls} command produces a listing of all the files contained in the
Any file that is marked to be restored will have its name preceded by an
asterisk ({\bf *}). Directory names will be terminated with a forward slash
- ({\bf /}) to distinguish them from filenames.
+ ({\bf /}) to distinguish them from filenames.
\item [lsmark]
\index[fd]{lsmark}
The {\bf lsmark} command is the same as the {\bf ls} except that it will
print only those files marked for extraction. The other distinction is that
- it will recursively descend into any directory selected.
+ it will recursively descend into any directory selected.
\item [mark]
\index[dir]{mark}
specification, in which case all files that match in the current directory
are marked to be restored. If the argument matches a directory rather than a
file, then the directory and all the files contained in that directory
- (recursively) are marked to be restored. Any marked file will have its name
+ (recursively) are marked to be restored. Any marked file will have its name
preceded with an asterisk ({\bf *}) in the output produced by the {\bf ls}
or
{\bf dir} commands. Note, supplying a full path on the mark command does not
work as expected to select a file or directory in the current directory.
Also, the {\bf mark} command works on the current and lower directories but
- does not touch higher level directories.
+ does not touch higher level directories.
- After executing the {\bf mark} command, it will print a brief summary:
+ After executing the {\bf mark} command, it will print a brief summary:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
No files marked.
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
- If no files were marked, or:
+ If no files were marked, or:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
nn files marked.
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
- if some files are marked.
+ if some files are marked.
\item [unmark]
\index[dir]{unmark }
unmarks the specified file or files so that they will not be restored. Note:
the {\bf unmark} command works from the current directory, so it does not
unmark any files at a higher level. First do a {\bf cd /} before the {\bf
- unmark *} command if you want to unmark everything.
+ unmark *} command if you want to unmark everything.
\item [pwd]
\index[dir]{pwd }
The {\bf pwd} command prints the current working directory. It accepts no
- arguments.
+ arguments.
\item [count]
\index[dir]{count }
The {\bf count} command prints the total files in the directory tree and the
- number of files marked to be restored.
+ number of files marked to be restored.
\item [done]
\index[dir]{done }
- This command terminates file selection mode.
+ This command terminates file selection mode.
\item [exit]
\index[fd]{exit }
- This command terminates file selection mode (the same as done).
+ This command terminates file selection mode (the same as done).
\item [quit]
\index[fd]{quit }
This command terminates the file selection and does not run the restore
-job.
+job.
\item [help]
\index[fd]{help }
- This command prints a summary of the commands available.
+ This command prints a summary of the commands available.
\item [?]
- This command is the same as the {\bf help} command.
+ This command is the same as the {\bf help} command.
\end{description}
If your filename contains some weird caracters, you can use \texttt{?},
contains a \textbackslash{}, you can use
\textbackslash{}\textbackslash{}\textbackslash{}\textbackslash{}.
-\begin{verbatim}
+\begin{lstlisting}
* mark weird_file\\\\with-backslash
-\end{verbatim}
+\end{lstlisting}
\label{database_restore}
\section{Restoring When Things Go Wrong}
For SQLite, use the vacuum command to try to fix the database. For either
MySQL or PostgreSQL, see the vendor's documentation. They have specific tools
that check and repair databases, see the \ilink{database
- repair}{DatabaseRepair} sections of this manual for links to vendor
+ repair}{DatabaseRepair} sections of this manual for links to vendor
information.
Assuming the above does not resolve the problem, you will need to restore
or rebuild your catalog. Note, if it is a matter of some
inconsistencies in the Bacula tables rather than a broken database, then
- running \ilink{dbcheck}{dbcheck} might help, but you will need to ensure
+ running the \bsysxrlink{dbcheck}{dbcheck}{utility}{command}\footnote{\utilityman{}}
+might help, but you will need to ensure
that your database indexes are properly setup. Please see
the \ilink{Database Performance Issues}{DatabasePerformance} sections
of this manual for more details.
have made a bootstrap file, you can immediately load back your
database (or the ASCII SQL output). Make a copy of your current
database, then re-initialize it, by running the following scripts:
-\begin{verbatim}
+\begin{lstlisting}
./drop_bacula_tables
./make_bacula_tables
-\end{verbatim}
- After re-initializing the database, you should be able to run
- Bacula. If you now try to use the restore command, it will not
+\end{lstlisting}
+ After re-initializing the database, you should be able to run
+ Bacula. If you now try to use the restore command, it will not
work because the database will be empty. However, you can manually
run a restore job and specify your bootstrap file. You do so
by entering the {bf run} command in the console and selecting the
you with something such as:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Run Restore job
JobName: RestoreFiles
Bootstrap: /home/kern/bacula/working/restore.bsr
When: 2005-07-10 17:33:40
Catalog: MyCatalog
Priority: 10
-OK to run? (yes/mod/no):
-\end{verbatim}
+OK to run? (yes/mod/no):
+\end{lstlisting}
\normalsize
A number of the items will be different in your case. What you want to
Client, Storage, Catalog, and Where are correct. The FileSet is not
used when you specify a bootstrap file. Once you have set all the
correct values, run the Job and it will restore the backup of your
- database, which is most likely an ASCII dump.
+ database, which is most likely an ASCII dump.
You will then need to follow the instructions for your
database type to recreate the database from the ASCII backup file.
See the \ilink {Catalog Maintenance}{CatMaintenanceChapter} chapter of
- this manual for examples of the command needed to restore a
+ this manual for examples of the command needed to restore a
database from an ASCII dump (they are shown in the Compacting Your
XXX Database sections).
-
+
Also, please note that after you restore your database from an ASCII
backup, you do NOT want to do a {\bf make\_bacula\_tables} command, or
you will probably erase your newly restored database tables.
-
+
\item[Solution with a Job listing]
If you did save your database but did not make a bootstrap file, then
recovering the database is more difficult. You will probably need to
Catalog.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
22-Apr 10:22 HeadMan: Start Backup JobId 7510,
Job=CatalogBackup.2005-04-22_01.10.0
22-Apr 10:23 HeadMan: Bacula 1.37.14 (21Apr05): 22-Apr-2005 10:23:06
FD termination status: OK
SD termination status: OK
Termination: Backup OK
-\end{verbatim}
+\end{lstlisting}
\normalsize
From the above information, you can manually create a bootstrap file,
like the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Volume="DLT-22Apr05"
VolSessionId=11
VolSessionTime=1114075126
FileIndex=1-1
-\end{verbatim}
-\normalsize
+\end{lstlisting}
+\normalsize
Where we have inserted the Volume name, Volume Session Id, and Volume
Session Time that correspond to the values in the job report. We've also
used a FileIndex of one, which will always be the case providing that
there was only one file backed up in the job.
-
+
The disadvantage of this bootstrap file compared to what is created when
you ask for one to be written, is that there is no File and Block
specified, so the restore code must search all data in the Volume to find
and Blocks specified as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Volume="DLT-22Apr05"
VolSessionId=11
VolSessionTime=1114075126
VolFile=118-118
VolBlock=0-4053
FileIndex=1-1
-\end{verbatim}
+\end{lstlisting}
\normalsize
Once you have restored the ASCII dump of the database,
you will then to follow the instructions for your
database type to recreate the database from the ASCII backup file.
See the \ilink {Catalog Maintenance}{CatMaintenanceChapter} chapter of
- this manual for examples of the command needed to restore a
+ this manual for examples of the command needed to restore a
database from an ASCII dump (they are shown in the Compacting Your
XXX Database sections).
-
+
Also, please note that after you restore your database from an ASCII
backup, you do NOT want to do a {\bf make\_bacula\_tables} command, or
you will probably erase your newly restored database tables.
\item [Solution without a Job Listing]
If you do not have a job listing, then it is a bit more difficult.
- Either you use the \ilink{bscan}{bscan} program to scan the contents
- of your tape into a database, which can be very time consuming
- depending on the size of the tape, or you can use the \ilink{bls}{bls}
- program to list everything on the tape, and reconstruct a bootstrap
- file from the bls listing for the file or files you want following
+ Either you use the \bsysxrlink{bscan}{bscan}{utility}{program} to scan the contents
+ of your tape into a database, which can be very time consuming
+ depending on the size of the tape, or you can use the \bsysxrlink{bls}{bls}
+ {utility}{program} to list everything on the tape, and reconstruct a
+ bootstrap file from the bls listing for the file or files you want following
the instructions given above.
There is a specific example of how to use {\bf bls} below.
\item [Problem]
I try to restore the last known good full backup by specifying
- item 3 on the restore menu then the JobId to restore. Bacula
+ item 3 on the restore menu then the JobId to restore. Bacula
then reports:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
1 Job 0 Files
-\end{verbatim}
+\end{lstlisting}
\normalsize
and restores nothing.
important information about the job:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
llist jobid=120
JobId: 120
Job: save.2005-12-05_18.27.33
Pool.Name: Full
Job.FileSetId: 1
FileSet.FileSet: BackupSet
-\end{verbatim}
+\end{lstlisting}
\normalsize
Then you can find the Volume(s) used by doing:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
sql
select VolumeName from JobMedia,Media where JobId=1 and JobMedia.MediaId=Media.MediaId;
-\end{verbatim}
+\end{lstlisting}
\normalsize
Finally, you can create a bootstrap file as described in the previous
You don't have a bootstrap file, and you don't have the Job report for
the backup of your database, but you did backup the database, and you
know the Volume to which it was backed up.
-
+
\item [Solution]
Either bscan the tape (see below for bscanning), or better use {\bf bls}
- to find where it is on the tape, then use {\bf bextract} to
+ to find where it is on the tape, then use {\bf bextract} to
restore the database. For example,
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
./bls -j -V DLT-22Apr05 /dev/nst0
-\end{verbatim}
+\end{lstlisting}
\normalsize
Might produce the following output:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
bls: butil.c:258 Using device: "/dev/nst0" for reading.
21-Jul 18:34 bls: Ready to read from volume "DLT-22Apr05" on device "DLTDrive"
(/dev/nst0).
21-Jul 18:34 bls: End of Volume at file 201 on device "DLTDrive" (/dev/nst0),
Volume "DLT-22Apr05"
21-Jul 18:34 bls: End of all volumes.
-\end{verbatim}
+\end{lstlisting}
\normalsize
Of course, there will be many more records printed, but we have indicated
- the essential lines of output. From the information on the Begin Job and End
+ the essential lines of output. From the information on the Begin Job and End
Job Session Records, you can reconstruct a bootstrap file such as the one
shown above.
If you would like to know the JobId where a file was saved, select
restore menu option 2.
- You can also use the {\bf query} command to find information such as:
+ You can also use the {\bf query} command to find information such as:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
*query
Available queries:
1: List up to 20 places where a File is saved regardless of the
15: List Volumes Bacula thinks are in changer
16: List Volumes likely to need replacement from age or errors
Choose a query (1-16):
-\end{verbatim}
+\end{lstlisting}
\normalsize
\item[Problem]
\end{enumerate}
When the above is complete, you can begin bscanning your Volumes. Please
-see the \ilink{bscan}{bscan} section of the Volume Utility Tools of this
-chapter for more details.
+see the \bsysxrlink{bscan}{bscan}{utility}{section} of the \utilityman{}.
\end{description}
\index[general]{Security}
\index[general]{Issues!Bacula Security}
-\begin{itemize}
-\item Security means being able to restore your files, so read the
+\begin{bsysitemize}
+\item Security means being able to restore your files, so read the
\ilink{Critical Items Chapter}{Critical} of this manual.
\item The Clients ({\bf bacula-fd}) must run as root to be able to access all
- the system files.
-\item It is not necessary to run the Director as root.
+ the system files.
+\item It is not necessary to run the Director as root.
\item It is not necessary to run the Storage daemon as root, but you must
ensure that it can open the tape drives, which are often restricted to root
access by default. In addition, if you do not run the Storage daemon as root,
the passwords are not world-readable. The {\bf Bacula} daemons are password
protected using CRAM-MD5 (i.e. the password is not sent across the network).
This will ensure that not everyone can access the daemons. It is a reasonably
- good protection, but can be cracked by experts.
+ good protection, but can be cracked by experts.
\item If you are using the recommended ports 9101, 9102, and 9103, you will
probably want to protect these ports from external access using a firewall
- and/or using tcp wrappers ({\bf etc/hosts.allow}).
+ and/or using tcp wrappers ({\bf etc/hosts.allow}).
\item By default, all data that is sent across the network is unencrypted.
However, Bacula does support TLS (transport layer security) and can
encrypt transmitted data. Please read the
\ilink{TLS (SSL) Communications Encryption}{CommEncryption}
section of this manual.
\item You should ensure that the Bacula working directories are readable and
- writable only by the Bacula daemons.
+ writable only by the Bacula daemons.
\item If you are using {\bf MySQL} it is not necessary for it to run with
- {\bf root} permission.
+ {\bf root} permission.
\item The default Bacula {\bf grant-mysql-permissions} script grants all
permissions to use the MySQL database without a password. If you want
- security, please tighten this up!
+ security, please tighten this up!
\item Don't forget that Bacula is a network program, so anyone anywhere on
the network with the console program and the Director's password can access
- Bacula and the backed up data.
-\item You can restrict what IP addresses Bacula will bind to by using the
+ Bacula and the backed up data.
+\item You can restrict what IP addresses Bacula will bind to by using the
appropriate {\bf DirAddress}, {\bf FDAddress}, or {\bf SDAddress} records in
- the respective daemon configuration files.
+ the respective daemon configuration files.
\item Be aware that if you are backing up your database using the default
script, if you have a password on your database, it will be passed as
a command line option to that script, and any user will be able to see
by an environment variable or a secure file.
See also \ilink{Backing Up Your Bacula
- Database - Security Considerations }{BackingUpBaculaSecurityConsiderations}
+ Database - Security Considerations}{BackingUpBaculaSecurityConsiderations}
for more information.
-\end{itemize}
+\end{bsysitemize}
\section{Backward Compatibility}
One of the major goals of Bacula is to ensure that you can restore
tapes (I'll use the word tape to include disk Volumes) that you wrote years
ago. This means that each new version of Bacula should be able to read old
-format tapes. The first problem you will have is to ensure that the
+format tapes. The first problem you will have is to ensure that the
hardware is still working some years down the road, and the second
-problem will be to ensure that the media will still be good, then
+problem will be to ensure that the media will still be good, then
your OS must be able to interface to the device, and finally Bacula
must be able to recognize old formats. All the problems except the
last are ones that we cannot solve, but by careful planning you can.
2005), there have been two major Bacula tape formats. The second format
was introduced in version 1.27 in November of 2002, and it has not
changed since then. In principle, Bacula can still read the original
-format, but I haven't tried it lately so who knows ...
+format, but I haven't tried it lately so who knows \ldots{}
Though the tape format is fixed, the kinds of data that we can put on the
tapes are extensible, and that is how we added new features
-such as ACLs, Win32 data, encrypted data, ... Obviously, an older
+such as ACLs, Win32 data, encrypted data, \ldots{} Obviously, an older
version of Bacula would not know how to read these newer data streams,
-but each newer version of Bacula should know how to read all the
+but each newer version of Bacula should know how to read all the
older streams.
If you want to be 100% sure that you can read old tapes, you
2. Keep statically linked copies of every version of Bacula that you use
in production then if for some reason, we botch up old tape compatibility, you
-can always pull out an old copy of Bacula ...
+can always pull out an old copy of Bacula \ldots{}
The second point is probably overkill but if you want to be sure, it may
save you someday.
\index[general]{libwrappers}
TCP Wrappers are implemented if you turn them on when configuring
-({\bf ./configure \verb:--:with-tcp-wrappers}).
+({\bf ./configure \verb:--:with-tcp-wrappers}).
With this code enabled, you may control who may access your
daemons. This control is done by modifying the file: {\bf
/etc/hosts.allow}. The program name that {\bf Bacula} uses when
tcp\_wrappers.
Dan Langille has provided the following information on configuring and
-testing TCP wrappers with Bacula.
+testing TCP wrappers with Bacula.
If you read hosts\_options(5), you will see an option called twist. This
option replaces the current process by an instance of the specified shell
-command. Typically, something like this is used:
+command. Typically, something like this is used:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
ALL : ALL \
: severity auth.info \
: twist /bin/echo "You are not welcome to use %d from %h."
-\end{verbatim}
+\end{lstlisting}
\normalsize
The libwrap code tries to avoid {\bf twist} if it runs in a resident process,
invoked. The potential, and I stress potential, exists for an attacker to
prevent the daemons from running. This situation is eliminated if your
/etc/hosts.allow file contains an appropriate rule set. The following example
-is sufficient:
+is sufficient:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
undef-fd : localhost : allow
undef-sd : localhost : allow
undef-dir : localhost : allow
undef-fd : ALL : deny
undef-sd : ALL : deny
undef-dir : ALL : deny
-\end{verbatim}
+\end{lstlisting}
\normalsize
You must adjust the names to be the same as the Name directives found
in each of the daemon configuration files. They are, in general, not the
-same as the binary daemon names. It is not possible to use the
+same as the binary daemon names. It is not possible to use the
daemon names because multiple daemons may be running on the same machine
but with different configurations.
Storage Daemon is undef-sd, and the File Daemon is undef-fd. Adjust to suit
your situation. The above example rules assume that the SD, FD, and DIR all
reside on the same box. If you have a remote FD client, then the following
-rule set on the remote client will suffice:
+rule set on the remote client will suffice:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
undef-fd : director.example.org : allow
undef-fd : ALL : deny
-\end{verbatim}
+\end{lstlisting}
\normalsize
where director.example.org is the host which will be contacting the client
deny" ensures that the twist option (if present) is not invoked. To properly
test your configuration, start the daemon(s), then attempt to connect from an
IP address which should be able to connect. You should see something like
-this:
+this:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
$ telnet undef 9103
Trying 192.168.0.56...
Connected to undef.example.org.
Escape character is '^]'.
Connection closed by foreign host.
$
-\end{verbatim}
+\end{lstlisting}
\normalsize
-This is the correct response. If you see this:
+This is the correct response. If you see this:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
$ telnet undef 9103
Trying 192.168.0.56...
Connected to undef.example.org.
You are not welcome to use undef-sd from xeon.example.org.
Connection closed by foreign host.
$
-\end{verbatim}
+\end{lstlisting}
\normalsize
then twist has been invoked and your configuration is not correct and you need
to add the deny statement. It is important to note that your testing must
include restarting the daemons after each connection attempt. You can also
tcpdchk(8) and tcpdmatch(8) to validate your /etc/hosts.allow rules. Here is a
-simple test using tcpdmatch:
+simple test using tcpdmatch:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
$ tcpdmatch undef-dir xeon.example.org
warning: undef-dir: no such process name in /etc/inetd.conf
client: hostname xeon.example.org
matched: /etc/hosts.allow line 40
option: allow
access: granted
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you are running Bacula as a standalone daemon, the warning above can be
safely ignored. Here is an example which indicates that your rules are missing
-a deny statement and the twist option has been invoked.
+a deny statement and the twist option has been invoked.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
$ tcpdmatch undef-dir 10.0.0.1
warning: undef-dir: no such process name in /etc/inetd.conf
client: address 10.0.0.1
option: twist /bin/echo "You are not welcome to use
undef-dir from 10.0.0.1."
access: delegated
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{Running as non-root}
-\index[general]{Running as non-root }
+\index[general]{Running as non-root}
-Security advice from Dan Langille:
+Security advice from Dan Langille:
% TODO: don't use specific name
% TODO: don't be too specific on operating system
The File Daemon needs to be root in order to access all files on your system.
In order to run as non-root, you need to create a user and a group. Choosing
{\tt bacula} as both the user name and the group name sounds like a good idea
-to me.
+to me.
The FreeBSD port creates this user and group for you.
-Here is what those entries looked like on my FreeBSD laptop:
+Here is what those entries looked like on my FreeBSD laptop:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
bacula:*:1002:1002::0:0:Bacula Daemon:/var/db/bacula:/sbin/nologin
-\end{verbatim}
+\end{lstlisting}
\normalsize
I used vipw to create this entry. I selected a User ID and Group ID of 1002
-as they were unused on my system.
+as they were unused on my system.
-I also created a group in /etc/group:
+I also created a group in /etc/group:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
bacula:*:1002:
-\end{verbatim}
+\end{lstlisting}
\normalsize
The bacula user (as opposed to the Bacula daemon) will have a home directory
of {\tt /var/db/bacula} which is the default location for the Bacula
-database.
+database.
Now that you have both a bacula user and a bacula group, you can secure the
-bacula home directory by issuing this command:
+bacula home directory by issuing this command:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
chown -R bacula:bacula /var/db/bacula/
-\end{verbatim}
+\end{lstlisting}
\normalsize
This ensures that only the bacula user can access this directory. It also
means that if we run the Director and the Storage daemon as bacula, those
daemons also have restricted access. This would not be the case if they were
-running as root.
+running as root.
It is important to note that the storage daemon actually needs to be in the
operator group for normal access to tape drives etc (at least on a FreeBSD
system, that's how things are set up by default) Such devices are normally
chown root:operator. It is easier and less error prone to make Bacula a
-member of that group than it is to play around with system permissions.
+member of that group than it is to play around with system permissions.
-Starting the Bacula daemons
+Starting the Bacula daemons
-To start the bacula daemons on a FreeBSD system, issue the following command:
+To start the bacula daemons on a FreeBSD system, issue the following command:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
/usr/local/etc/rc.d/bacula-dir start
/usr/local/etc/rc.d/bacula-sd start
/usr/local/etc/rc.d/bacula-fd start
-\end{verbatim}
+\end{lstlisting}
\normalsize
-To confirm they are all running:
+To confirm they are all running:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
$ ps auwx | grep bacula
root 63418 0.0 0.3 1856 1036 ?? Ss 4:09PM 0:00.00
/usr/local/sbin/bacula-fd -v -c /usr/local/etc/bacula-fd.conf
/usr/local/sbin/bacula-sd -v -c /usr/local/etc/bacula-sd.conf
bacula 63422 0.0 0.4 2360 1440 ?? Ss 4:09PM 0:00.00
/usr/local/sbin/bacula-dir -v -c /usr/local/etc/bacula-dir.conf
-\end{verbatim}
+\end{lstlisting}
\normalsize
Bacula allows you to specify that you want the Storage daemon to initially
write your data to disk and then subsequently to tape. This serves several
-important purposes.
+important purposes.
-\begin{itemize}
+\begin{bsysitemize}
\item It takes a long time for data to come in from the File daemon during
an Incremental backup. If it is directly written to tape, the tape will
start and stop or shoe-shine as it is often called causing tape wear.
thus reducing downtime, and/or interference with users. Of course, if
your spool device is not large enough to hold all the data from your
File daemon, you may actually slow down the overall backup.
-\end{itemize}
+\end{bsysitemize}
Data spooling is exactly that "spooling". It is not a way to first write a
"backup" to a disk file and then to a tape. When the backup has only been
spooled to disk, it is not complete yet and cannot be restored until it is
-written to tape.
+written to tape.
Bacula version 1.39.x and later supports writing a backup
to disk then later {\bf Migrating} or moving it to a tape (or any
of this manual for more details.
The remainder of this chapter explains the various directives that you can use
-in the spooling process.
+in the spooling process.
\label{directives}
\section{Data Spooling Directives}
\index[general]{Directives!Data Spooling }
\index[general]{Data Spooling Directives }
-The following directives can be used to control data spooling.
+The following directives can be used to control data spooling.
-\begin{itemize}
+\begin{bsysitemize}
\item To turn data spooling on/off at the Job level in the Job resource in
the Director's conf file (default {\bf no}).
-{\bf SpoolData = yes\vb{}no}
+{\bf SpoolData = yes\vb{}no}
\item To override the Job specification in a Schedule Run directive in the
Director's conf file.
-{\bf SpoolData = yes\vb{}no}
+{\bf SpoolData = yes\vb{}no}
\item To override the Job specification in a bconsole session using the \texttt{run}
command. Please note that this does {\bf not } refer to a configuration
statement, but to an argument for the run command.
-{\bf SpoolData=yes\vb{}no}
+{\bf SpoolData=yes\vb{}no}
\item To limit the the maximum spool file size for a particular job in the Job
resource
{\bf Spool Size = size}
- Where size is a the maximum spool size for this job specified in bytes.
+ Where size is a the maximum spool size for this job specified in bytes.
\item To limit the maximum total size of the spooled data for a particular
device. Specified in the Device resource of the Storage daemon's conf file
(default unlimited).
{\bf Maximum Spool Size = size}
- Where size is a the maximum spool size for all jobs specified in bytes.
+ Where size is a the maximum spool size for all jobs specified in bytes.
\item To limit the maximum total size of the spooled data for a particular
device for a single job. Specified in the Device Resource of the Storage
{\bf Maximum Job Spool Size = size}
Where size is the maximum spool file size for a single job specified in
- bytes.
+ bytes.
\item To specify the spool directory for a particular device. Specified in
the Device Resource of the Storage daemon's conf file (default, the working
directory).
-{\bf Spool Directory = directory}
-\end{itemize}
+{\bf Spool Directory = directory}
+\end{bsysitemize}
\label{warning}
otherwise, your job will write enormous amounts of data to the Volume, and
most probably terminate in error. This is because in attempting to backup the
spool file, the backup data will be written a second time to the spool file,
-and so on ad infinitum.
+and so on ad infinitum.
Another advice is to always specify the maximum spool size so that your disk
doesn't completely fill up. In principle, data spooling will properly detect a
full disk, and despool data allowing the job to continue. However, attribute
spooling is not so kind to the user. If the disk on which attributes are being
-spooled fills, the job will be canceled. In addition, if your working
+spooled fills, the job will be canceled. In addition, if your working
directory is on the same partition as the spool directory, then Bacula jobs
will fail possibly in bizarre ways when the spool fills.
\index[general]{Points!Other }
\index[general]{Other Points }
-\begin{itemize}
+\begin{bsysitemize}
\item When data spooling is enabled, Bacula automatically turns on attribute
spooling. In other words, it also spools the catalog entries to disk. This is
done so that in case the job fails, there will be no catalog entries
- pointing to non-existent tape backups.
+ pointing to non-existent tape backups.
\item Attribute despooling occurs near the end of a job. The Storage daemon
accumulates file attributes during the backup and sends them to the
Director at the end of the job. The Director then inserts the file
attributes into the catalog. During this insertion, the tape drive may
be inactive. When the file attribute insertion is completed, the job
- terminates.
-\item Attribute spool files are always placed in the working directory of
+ terminates.
+\item Attribute spool files are always placed in the working directory of
the Storage daemon.
\item When Bacula begins despooling data spooled to disk, it takes exclusive
use of the tape. This has the major advantage that in running multiple
- simultaneous jobs at the same time, the blocks of several jobs will not be
- intermingled.
+ simultaneous jobs at the same time, the blocks of several jobs will not be
+ intermingled.
\item It probably does not make a lot of sense to enable data spooling if you
- are writing to disk files.
+ are writing to disk files.
\item It is probably best to provide as large a spool file as possible to
avoid repeatedly spooling/despooling. Also, while a job is despooling to
- tape, the File daemon must wait (i.e. spooling stops for the job while it is
- despooling).
+ tape, the File daemon must wait (i.e. spooling stops for the job while it is
+ despooling).
\item If you are running multiple simultaneous jobs, Bacula will continue
spooling other jobs while one is despooling to tape, provided there is
- sufficient spool file space.
-\end{itemize}
+ sufficient spool file space.
+\end{bsysitemize}
Bacula}, you will need SQLite version 2.8.16 or later installed. Our standard
location (for the moment) for SQLite is in the dependency package {\bf
depkgs/sqlite-2.8.16}. Please note that the version will be updated as new
-versions are available and tested.
+versions are available and tested.
-Installing and Configuring is quite easy.
+Installing and Configuring is quite easy.
\begin{enumerate}
-\item Download the Bacula dependency packages
+\item Download the Bacula dependency packages
\item Detar it with something like:
-\begin{verbatim}
+\begin{lstlisting}
tar xvfz depkgs.tar.gz
-\end{verbatim}
+\end{lstlisting}
Note, the above command requires GNU tar. If you do not have GNU tar, a
command such as:
-\begin{verbatim}
+\begin{lstlisting}
zcat depkgs.tar.gz | tar xvf -
-\end{verbatim}
+\end{lstlisting}
- will probably accomplish the same thing.
+ will probably accomplish the same thing.
\item {\bf cd depkgs}
-\item {\bf make sqlite}
+\item {\bf make sqlite}
\end{enumerate}
one which version of SQLite you are using. You should not use the {\bf
\verb:--:enable-batch-insert} configuration parameter for Bacula if you
are using SQLite version 2 as it is probably not thread safe. If you
-are using SQLite version 3, you may use the {\bf \verb:--:enable-batch-insert}
+are using SQLite version 3, you may use the {\bf \verb:--:enable-batch-insert}
configuration option with Bacula, but when building SQLite3 you MUST
-configure it with {\bf \verb:--:enable-threadsafe} and
+configure it with {\bf \verb:--:enable-threadsafe} and
{\bf \verb:--:enable-cross-thread-connections}.
By default, SQLite3 is now run with {\bf PRAGMA synchronous=OFF} this
-increases the speed by more than 30 time, but it also increases the
+increases the speed by more than 30 time, but it also increases the
possibility of a corrupted database if your server crashes (power failure
or kernel bug). If you want more security, you can change the PRAGMA
that is used in the file src/version.h.
At this point, you should return to completing the installation of {\bf
-Bacula}.
+Bacula}.
\section{Installing and Configuring SQLite -- Phase II}
\index[general]{Installing and Configuring SQLite -- Phase II }
This phase is done {\bf after} you have run the {\bf ./configure} command to
-configure {\bf Bacula}.
+configure {\bf Bacula}.
{\bf Bacula} will install scripts for manipulating the database (create,
delete, make tables etc) into the main installation directory. These files
running ./configure. If you inspect create\_bacula\_database, you will see
that it calls create\_sqlite\_database. The *\_bacula\_* files are provided
for convenience. It doesn't matter what database you have chosen;
-create\_bacula\_database will always create your database.
+create\_bacula\_database will always create your database.
-At this point, you can create the SQLite database and tables:
+At this point, you can create the SQLite database and tables:
\begin{enumerate}
\item cd \lt{}install-directory\gt{}
- This directory contains the Bacula catalog interface routines.
+ This directory contains the Bacula catalog interface routines.
\item ./make\_sqlite\_tables
This script creates the SQLite database as well as the tables used by {\bf
Bacula}. This script will be automatically setup by the {\bf ./configure}
program to create a database named {\bf bacula.db} in {\bf Bacula's} working
- directory.
+ directory.
\end{enumerate}
\section{Linking Bacula with SQLite}
\index[general]{Linking Bacula with SQLite }
If you have followed the above steps, this will all happen automatically and
-the SQLite libraries will be linked into {\bf Bacula}.
+the SQLite libraries will be linked into {\bf Bacula}.
\section{Testing SQLite}
\index[general]{SQLite!Testing }
If Bacula crashes with the following type of error when it is started:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Using default Catalog name=MyCatalog DB=bacula
Could not open database "bacula".
sqlite.c:151 Unable to open Database=/var/lib/bacula/bacula.db.
ERR=malformed database schema - unable to open a temporary database file
for storing temporary tables
-\end{verbatim}
+\end{lstlisting}
\normalsize
this is most likely caused by the fact that some versions of
After you have done some initial testing with {\bf Bacula}, you will probably
want to re-initialize the catalog database and throw away all the test Jobs
-that you ran. To do so, you can do the following:
+that you ran. To do so, you can do the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
cd <install-directory>
./drop_sqlite_tables
./make_sqlite_tables
-\end{verbatim}
+\end{lstlisting}
\normalsize
Please note that all information in the database will be lost and you will be
starting from scratch. If you have written on any Volumes, you must write an
-end of file mark on the volume so that Bacula can reuse it. Do so with:
+end of file mark on the volume so that Bacula can reuse it. Do so with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
(stop Bacula or unmount the drive)
mt -f /dev/nst0 rewind
mt -f /dev/nst0 weof
-\end{verbatim}
+\end{lstlisting}
\normalsize
Where you should replace {\bf /dev/nst0} with the appropriate tape drive
-device name for your machine.
+device name for your machine.
\chapter{The Current State of Bacula}
\label{StateChapter}
-\index[general]{Current State of Bacula }
+\index[general]{Current state of Bacula}
-In other words, what is and what is not currently implemented and functional.
+In other words, what is and what is not currently implemented and functional.
\section{What is Implemented}
\index[general]{Implemented!What}
\index[general]{What is Implemented}
-\begin{itemize}
+\begin{bsysitemize}
\item Job Control
- \begin{itemize}
- \item Network backup/restore with centralized Director.
- \item Internal scheduler for automatic
- \ilink{Job}{JobDef} execution.
- \item Scheduling of multiple Jobs at the same time.
+ \begin{bsysitemize}
+ \item Network backup/restore with centralized Director.
+ \item Internal scheduler for automatic
+ \ilink{Job}{JobDef} (cf. \S\bsysref{JobDef}) execution.
+ \item Scheduling of multiple Jobs at the same time.
\item You may run one Job at a time or multiple simultaneous Jobs
(sometimes called multiplexing).
- \item Job sequencing using priorities.
+ \item Job sequencing using priorities.
\item \ilink{Console}{UADef} interface to the Director allowing complete
control. A shell, Qt4 GUI, wxWidgets GUI and Web versions of
the Console program are available. Note, the Qt4 GUI program called
the Bacula Administration tool or bat, offers many additional
features over the shell program.
- \end{itemize}
+ \end{bsysitemize}
\item Security
- \begin{itemize}
- \item Verification of files previously cataloged, permitting a Tripwire like
- capability (system break-in detection).
+ \begin{bsysitemize}
+ \item Verification of files previously cataloged, permitting a Tripwire like
+ capability (system break-in detection).
\item CRAM-MD5 password authentication between each component (daemon).
- \item Configurable
- \ilink{TLS (SSL) communications encryption}{CommEncryption} between each
+ \item Configurable
+ \ilink{TLS (SSL) communications encryption}{CommEncryption} between each
component.
\item Configurable
\ilink{Data (on Volume) encryption}{DataEncryption}
on a Client by Client basis.
- \item Computation of MD5 or SHA1 signatures of the file data if requested.
- \end{itemize}
+ \item Computation of MD5 or SHA1 signatures of the file data if requested.
+ \end{bsysitemize}
\item Restore Features
- \begin{itemize}
+ \begin{bsysitemize}
\item Restore of one or more files selected interactively either for the
- current backup or a backup prior to a specified time and date.
+ current backup or a backup prior to a specified time and date.
\item Restore of a complete system starting from bare metal. This is mostly
- automated for Linux systems and partially automated for Solaris. See
+ automated for Linux systems and partially automated for Solaris. See
\ilink{Disaster Recovery Using Bacula}{RescueChapter}. This is also
- reported to work on Win2K/XP systems.
+ reported to work on Win2K/XP systems.
\item Listing and Restoration of files using stand-alone {\bf bls} and {\bf
bextract} tool programs. Among other things, this permits extraction of
files when Bacula and/or the catalog are not available. Note, the
Console. These programs are designed for use as a last resort.
\item Ability to restore the catalog database rapidly by using bootstrap
files (previously saved).
- \item Ability to recreate the catalog database by scanning backup Volumes
- using the {\bf bscan} program.
- \end{itemize}
+ \item Ability to recreate the catalog database by scanning backup Volumes
+ using the {\bf bscan} program.
+ \end{bsysitemize}
\item SQL Catalog
- \begin{itemize}
+ \begin{bsysitemize}
\item Catalog database facility for remembering Volumes, Pools, Jobs, and
- Files backed up.
- \item Support for MySQL, PostgreSQL, and SQLite Catalog databases.
- \item User extensible queries to the MySQL, PostgreSQL and SQLite databases.
- \end{itemize}
+ Files backed up.
+ \item Support for MySQL, PostgreSQL, and SQLite Catalog databases.
+ \item User extensible queries to the MySQL, PostgreSQL and SQLite databases.
+ \end{bsysitemize}
\item Advanced Volume and Pool Management
- \begin{itemize}
+ \begin{bsysitemize}
\item Labeled Volumes, preventing accidental overwriting (at least by
- Bacula).
+ Bacula).
\item Any number of Jobs and Clients can be backed up to a single Volume.
That is, you can backup and restore Linux, Unix, Sun, and Windows machines to
- the same Volume.
+ the same Volume.
\item Multi-volume saves. When a Volume is full, {\bf Bacula} automatically
- requests the next Volume and continues the backup.
- \item
- \ilink{Pool and Volume}{PoolResource} library management
+ requests the next Volume and continues the backup.
+ \item
+ \ilink{Pool and Volume}{PoolResource} library management
providing Volume flexibility (e.g. monthly, weekly, daily Volume sets, Volume
- sets segregated by Client, ...).
- \item Machine independent Volume data format. Linux, Solaris, and Windows
- clients can all be backed up to the same Volume if desired.
+ sets segregated by Client, ...).
+ \item Machine independent Volume data format. Linux, Solaris, and Windows
+ clients can all be backed up to the same Volume if desired.
\item The Volume data format is upwards compatible so that old Volumes
can always be read.
- \item A flexible
+ \item A flexible
\ilink{message}{MessagesChapter} handler including routing
of messages from any daemon back to the Director and automatic email
- reporting.
+ reporting.
\item Data spooling to disk during backup with subsequent write to tape from
the spooled disk files. This prevents tape "shoe shine" during
- Incremental/Differential backups.
- \end{itemize}
+ Incremental/Differential backups.
+ \end{bsysitemize}
\item Advanced Support for most Storage Devices
- \begin{itemize}
- \item Autochanger support using a simple shell interface that can interface
- to virtually any autoloader program. A script for {\bf mtx} is provided.
- \item Support for autochanger barcodes -- automatic tape labeling from
- barcodes.
+ \begin{bsysitemize}
+ \item Autochanger support using a simple shell interface that can interface
+ to virtually any autoloader program. A script for {\bf mtx} is provided.
+ \item Support for autochanger barcodes -- automatic tape labeling from
+ barcodes.
\item Automatic support for multiple autochanger magazines either using
- barcodes or by reading the tapes.
+ barcodes or by reading the tapes.
\item Support for multiple drive autochangers.
- \item Raw device backup/restore. Restore must be to the same device.
- \item All Volume blocks (approximately 64K bytes) contain a data checksum.
+ \item Raw device backup/restore. Restore must be to the same device.
+ \item All Volume blocks (approximately 64K bytes) contain a data checksum.
\item Migration support -- move data from one Pool to another or
one Volume to another.
\item Supports writing to DVD.
- \end{itemize}
+ \end{bsysitemize}
\item Multi-Operating System Support
- \begin{itemize}
- \item Programmed to handle arbitrarily long filenames and messages.
+ \begin{bsysitemize}
+ \item Programmed to handle arbitrarily long filenames and messages.
\item GZIP compression on a file by file basis done by the Client program if
- requested before network transit.
+ requested before network transit.
\item Saves and restores POSIX ACLs and Extended Attributes on most OSes if
enabled.
\item Access control lists for Consoles that permit restricting user access
- to only their data.
- \item Support for save/restore of files larger than 2GB.
+ to only their data.
+ \item Support for save/restore of files larger than 2GB.
\item Support for 64 bit machines, e.g. amd64, Sparc.
\item Support ANSI and IBM tape labels.
\item Support for Unicode filenames (e.g. Chinese) on Win32 machines
- \item Consistent backup of open files on Win32 systems (WinXP, Win2003,
+ \item Consistent backup of open files on Win32 systems (WinXP, Win2003,
and Vista)
but not Win2000, using Volume Shadow Copy (VSS).
\item Support for path/filename lengths of up to 64K on Win32 machines
(unlimited on Unix/Linux machines).
- \end{itemize}
+ \end{bsysitemize}
\item Miscellaneous
- \begin{itemize}
- \item Multi-threaded implementation.
- \item A comprehensive and extensible
- \ilink{configuration file}{DirectorChapter} for each daemon.
- \end{itemize}
-\end{itemize}
+ \begin{bsysitemize}
+ \item Multi-threaded implementation.
+ \item A comprehensive and extensible
+ \ilink{configuration file}{DirectorChapter} for each daemon.
+ \end{bsysitemize}
+\end{bsysitemize}
\section{Advantages Over Other Backup Programs}
\index[general]{Advantages of Bacula Over Other Backup Programs }
\index[general]{Programs!Advantages of Bacula Over Other Backup }
-\begin{itemize}
+\begin{bsysitemize}
\item Since there is a client for each machine, you can backup
and restore clients of any type ensuring that all attributes
of files are properly saved and restored.
software by using NFS or Samba. However, if possible, we
recommend running a Client File daemon on each machine to be
backed up.
-\item Bacula handles multi-volume backups.
+\item Bacula handles multi-volume backups.
\item A full comprehensive SQL standard database of all files backed up. This
- permits online viewing of files saved on any particular Volume.
-\item Automatic pruning of the database (removal of old records) thus
- simplifying database administration.
-\item Any SQL database engine can be used making Bacula very flexible.
+ permits online viewing of files saved on any particular Volume.
+\item Automatic pruning of the database (removal of old records) thus
+ simplifying database administration.
+\item Any SQL database engine can be used making Bacula very flexible.
Drivers currently exist for MySQL, PostgreSQL, and SQLite.
-\item The modular but integrated design makes Bacula very scalable.
+\item The modular but integrated design makes Bacula very scalable.
\item Since Bacula uses client file servers, any database or
other application can be properly shutdown by Bacula using the
native tools of the system, backed up, then restarted (all
within a Bacula Job).
-\item Bacula has a built-in Job scheduler.
-\item The Volume format is documented and there are simple C programs to
- read/write it.
+\item Bacula has a built-in Job scheduler.
+\item The Volume format is documented and there are simple C programs to
+ read/write it.
\item Bacula uses well defined (IANA registered) TCP/IP ports -- no rpcs, no
- shared memory.
+ shared memory.
\item Bacula installation and configuration is relatively simple compared to
- other comparable products.
-\item According to one user Bacula is as fast as the big major commercial
- applications.
+ other comparable products.
+\item According to one user Bacula is as fast as the big major commercial
+ applications.
\item According to another user Bacula is four times as fast as another
commercial application, probably because that application stores its catalog
information in a large number of individual files rather than an SQL database
- as Bacula does.
+ as Bacula does.
\item Aside from several GUI administrative interfaces, Bacula has a
comprehensive shell administrative interface, which allows the
administrator to use tools such as ssh to administrate any part of
Bacula from anywhere (even from home).
-\item Bacula has a Rescue CD for Linux systems with the following features:
- \begin{itemize}
+\item Bacula has a Rescue CD for Linux systems with the following features:
+ \begin{bsysitemize}
\item You build it on your own system from scratch with one simple command:
- make -- well, then make burn.
- \item It uses your kernel
+ make -- well, then make burn.
+ \item It uses your kernel
\item It captures your current disk parameters and builds scripts that allow
you to automatically repartition a disk and format it to put it back to what
- you had before.
+ you had before.
\item It has a script that will restart your networking (with the right IP
- address)
- \item It has a script to automatically mount your hard disks.
- \item It has a full Bacula FD statically linked
- \item You can easily add additional data/programs, ... to the disk.
- \end{itemize}
+ address)
+ \item It has a script to automatically mount your hard disks.
+ \item It has a full Bacula FD statically linked
+ \item You can easily add additional data/programs, ... to the disk.
+ \end{bsysitemize}
-\end{itemize}
+\end{bsysitemize}
\section{Current Implementation Restrictions}
\index[general]{Current Implementation Restrictions }
\index[general]{Restrictions!Current Implementation }
-\begin{itemize}
+\begin{bsysitemize}
\item It is very unusual to attempt to restore two Jobs
that ran simultaneously in a single restore, but if
you do, please be aware that unless you had
work correctly. In other terms, Bacula cannot restore
two jobs in the same restore if the Jobs' data blocks were
intermixed on the backup medium. The problem is resolved by
- simply doing two restores, one for each Job.
+ simply doing two restores, one for each Job.
Normally this can happen only if you manually enter specific
JobIds to be restored in a single restore Job.
\item Bacula can generally restore any backup made from one client
on other Unix/Linux machines; there are reports that Zlib compression
written with 64 bit machines does not always read correctly on a 32 bit
machine).
-\end{itemize}
+\end{bsysitemize}
\section{Design Limitations or Restrictions}
\index[general]{Restrictions!Design Limitations or }
\index[general]{Design Limitations or Restrictions }
-\begin{itemize}
-\item Names (resource names, Volume names, and such) defined in Bacula
+\begin{bsysitemize}
+\item Names (resource names, Volume names, and such) defined in Bacula
configuration files are limited to a fixed number of
characters. Currently the limit is defined as 127 characters. Note,
this does not apply to filenames, which may be arbitrarily long.
bconsole is restricted to several hundred characters maximum.
Normally, this is not a restriction, except in the case of listing
multiple Volume names for programs such as {\bf bscan}. To avoid
- this command line length restriction, please use a {\bf .bsr}
+ this command line length restriction, please use a {\bf .bsr}
file to specify the Volume names.
\item Bacula configuration files for each of the components can be
any length. However, the length of an individual line is limited
specify multiple short lines repeating the directive on
each line but with different list values.
-\end{itemize}
+\end{bsysitemize}
\section{Items to Note}
\index[general]{Items to Note}
-\begin{itemize}
+\begin{bsysitemize}
\item Bacula's Differential and Incremental \textsl{normal} backups are based
on time stamps. Consequently, if you move files into an existing directory
or move a whole directory into the backup fileset after a Full backup, those
\item In non \textsl{Accurate} mode, files deleted after a Full save will be
included in a restoration. This is typical for most similar backup programs.
To avoid this, use Accurate mode backup.
-\end{itemize}
+\end{bsysitemize}
provide some \textit{Service Level Agreement} indicators, you could use a few
SQL queries on the Job table to report how many:
-\begin{itemize}
+\begin{bsysitemize}
\item jobs have run
\item jobs have been successful
\item files have been backed up
\item ...
-\end{itemize}
+\end{bsysitemize}
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.
+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
You can use the following Job resource in your nightly \textbf{BackupCatalog}
job to maintain statistics.
-\begin{verbatim}
+\begin{lstlisting}
Job {
Name = BackupCatalog
...
RunsOnClient = no
}
}
-\end{verbatim}
+\end{lstlisting}
quite a large number of directives in the Device Resource definition that
allow you to define all the characteristics of your Storage device (normally a
tape drive). Fortunately, with modern storage devices, the defaults are
-sufficient, and very few directives are actually needed.
+sufficient, and very few directives are actually needed.
Examples of {\bf Device} resource directives that are known to work for a
number of common tape drives can be found in the {\bf
\lt{}bacula-src\gt{}/examples/devices} directory, and most will also be listed
-here.
+here.
For a general discussion of configuration file and resources including the
-data types recognized by {\bf Bacula}, please see the
+data types recognized by {\bf Bacula}, please see the
\ilink{Configuration}{ConfigureChapter} chapter of this manual. The
-following Storage Resource definitions must be defined:
+following Storage Resource definitions must be defined:
-\begin{itemize}
-\item
+\begin{bsysitemize}
+\item
\ilink{Storage}{StorageResource} -- to define the name of the
- Storage daemon.
-\item
+ Storage daemon.
+\item
\ilink{Director}{DirectorResource1} -- to define the Director's
- name and his access password.
-\item
+ name and his access password.
+\item
\ilink{Device}{DeviceResource} -- to define the
- characteristics of your storage device (tape drive).
-\item
+ characteristics of your storage device (tape drive).
+\item
\ilink{Messages}{MessagesChapter} -- to define where error and
- information messages are to be sent.
-\end{itemize}
+ information messages are to be sent.
+\end{bsysitemize}
\section{Storage Resource}
\label{StorageResource}
In general, the properties specified under the Storage resource define global
properties of the Storage daemon. Each Storage daemon configuration file must
-have one and only one Storage resource definition.
+have one and only one Storage resource definition.
\begin{description}
\item [Name = \lt{}Storage-Daemon-Name\gt{}]
\index[sd]{Name}
\index[sd]{Directive!Name}
- Specifies the Name of the Storage daemon. This directive is required.
+ Specifies the Name of the Storage daemon. This directive is required.
\item [Working Directory = \lt{}Directory\gt{}]
\index[sd]{Working Directory}
daemon may put its status files. This directory should be used only by {\bf
Bacula}, but may be shared by other Bacula daemons provided the names
given to each daemon are unique. This directive is
- required
+ required
\item [Pid Directory = \lt{}Directory\gt{}]
\index[sd]{Pid Directory}
\index[sd]{Directive!Pid Directory}
- This directive is mandatory and specifies a directory in which the Director
+ This directive is mandatory and specifies a directory in which the Director
may put its process Id file files. The process Id file is used to shutdown
- Bacula and to prevent multiple copies of Bacula from running simultaneously.
- This directive is required. Standard shell expansion of the {\bf Directory}
+ Bacula and to prevent multiple copies of Bacula from running simultaneously.
+ This directive is required. Standard shell expansion of the {\bf Directory}
is done when the configuration file is read so that values such as {\bf
- \$HOME} will be properly expanded.
+ \$HOME} will be properly expanded.
Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
not installing Bacula in the system directories, you can use the {\bf Working
- Directory} as defined above.
+ Directory} as defined above.
\item [Heartbeat Interval = \lt{}time-interval\gt{}]
\index[sd]{Heartbeat Interval}
explain how this directive works is to show an example:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
SDAddresses = { ip = {
addr = 1.2.3.4; port = 1205; }
ipv4 = {
addr = bluedot.thun.net
}
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
as a number or as the mnemonic value from the /etc/services file. If a port
is not specified, the default will be used. If an ip section is specified,
the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
-only IPv4 resolutions will be permitted, and likewise with ip6.
+only IPv4 resolutions will be permitted, and likewise with ip6.
-Using this directive, you can replace both the SDPort and SDAddress
-directives shown below.
+Using this directive, you can replace both the SDPort and SDAddress
+directives shown below.
\item [SDPort = \lt{}port-number\gt{}]
\index[sd]{SDPort}
\index[sd]{Directive!SDPort}
Specifies port number on which the Storage daemon listens for Director
- connections. The default is 9103.
-
+ connections. The default is 9103.
+
\item [SDAddress = \lt{}IP-Address\gt{}]
\index[sd]{SDAddress}
\index[sd]{Directive!SDAddress}
\end{description}
-The following is a typical Storage daemon Storage definition.
+The following is a typical Storage daemon Storage definition.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# "Global" Storage daemon configuration specifications appear
# under the Storage resource.
WorkingDirectory = "~/bacula/working"
Pid Directory = "~/bacula/working"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{Director Resource}
\index[sd]{Name}
\index[sd]{Directive!Name}
Specifies the Name of the Director allowed to connect to the Storage daemon.
- This directive is required.
+ This directive is required.
\item [Password = \lt{}Director-password\gt{}]
\index[sd]{Password}
\index[sd]{Directive!Password}
Specifies the password that must be supplied by the above named Director.
- This directive is required.
+ This directive is required.
\item [Monitor = \lt{}yes\vb{}no\gt{}]
\index[sd]{Monitor}
director will only be able to fetch the current status of this Storage
daemon.
- Please note that if this director is being used by a Monitor, we highly
- recommend to set this directive to {\bf yes} to avoid serious security
- problems.
+ Please note that if this director is being used by a Monitor, we highly
+ recommend to set this directive to {\bf yes} to avoid serious security
+ problems.
\end{description}
-The following is an example of a valid Director resource definition:
+The following is an example of a valid Director resource definition:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = MainDirector
Password = my_secret_password
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{DeviceResource}
make it correspond to the English name of the backup device. The physical
name of the device is specified on the {\bf Archive Device} directive
described below. The name you specify here is also used in your Director's
- conf file on the
+ conf file on the
\ilink{Device directive}{StorageResource2} in its Storage
- resource.
+ resource.
\item [Archive Device = {\it name-string}]
\index[sd]{Archive Device}
conventions with the device. The {\bf b} in the Solaris (Sun) archive
specification {\bf /dev/rmt/0mbn} is what is needed in this case.
Bacula does not support SysV tape drive behavior.
-
+
As noted above, normally the Archive Device is the name of a tape drive, but
you may also specify an absolute path to an existing directory. If the
Device is a directory Bacula will write to file storage in the specified
kind of device, you never want to specify {\bf AlwaysOpen}, because you want
the Storage daemon to open it only when a job starts, so you must explicitly
set it to {\bf No}. Since a FIFO is a one way device, Bacula will not attempt
- to read a label of a FIFO device, but will simply write on it. To create a
+ to read a label of a FIFO device, but will simply write on it. To create a
FIFO Volume in the catalog, use the {\bf add} command rather than the {\bf
label} command to avoid attempting to write a label.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Device {
Name = FifoStorage
Media Type = Fifo
MaximumOpenWait = 60
AlwaysOpen = no
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
During a restore operation, if the Archive Device is a FIFO, Bacula will
writes into the FIFO. Bacula will wait {\bf MaximumOpenWait} seconds for the
program to begin writing and will then time it out and terminate the job. As
noted above, you may use the {\bf RunBeforeJob} to start the writer program
- at the beginning of the job.
-
- The Archive Device directive is required.
+ at the beginning of the job.
+
+ The Archive Device directive is required.
\item [Device Type = {\it type-specification}]
\index[sd]{Device Type}
The device is a tape device and thus is sequential access. Tape devices
are controlled using ioctl() calls.
\item [Fifo]
- The device is a first-in-first out sequential access read-only
+ The device is a first-in-first out sequential access read-only
or write-only device.
\end{description}
-
+
The Device Type directive is not required, and if not specified, Bacula
will attempt to guess what kind of device has been specified using the
Archive Device specification supplied. There are several advantages to
associated with it. The same {\bf name-string} must appear in the
appropriate Storage resource definition in the Director's configuration
file.
-
+
Even though the names you assign are arbitrary (i.e. you choose the name
you want), you should take care in specifying them because the Media Type
is used to determine which storage device Bacula will select during
for all drives where the Media can be freely interchanged. This is not
generally an issue if you have a single Storage daemon, but it is with
multiple Storage daemons, especially if they have incompatible media.
-
+
For example, if you specify a Media Type of "DDS-4" then during the
restore, Bacula will be able to choose any Storage Daemon that handles
"DDS-4". If you have an autochanger, you might want to name the Media Type
\index[sd]{Directive!Autochanger}
If {\bf Yes}, this device belongs to an automatic tape changer, and you
must specify an {\bf Autochanger} resource that points to the {\bf
- Device} resources. You must also specify a
+ Device} resources. You must also specify a
{\bf Changer Device}. If the Autochanger directive is set to {\bf
No} (default), the volume must be manually changed. You should also
- have an identical directive to the
+ have an identical directive to the
\ilink{Storage resource}{Autochanger1} in the Director's
configuration file so that when labeling tapes you are prompted for the slot.
The specified {\bf name-string} must be the {\bf generic SCSI} device
name of the autochanger that corresponds to the normal read/write
{\bf Archive Device} specified in the Device resource. This
- generic SCSI device name should be specified if you have an autochanger
+ generic SCSI device name should be specified if you have an autochanger
or if you have a standard tape drive and want to use the
- {\bf Alert Command} (see below). For example, on Linux systems, for
+ {\bf Alert Command} (see below). For example, on Linux systems, for
an Archive Device name of {\bf /dev/nst0}, you would specify {\bf
/dev/sg0} for the Changer Device name. Depending on your exact
configuration, and the number of autochangers or the type of
which is then used for all devices. However, you may also specify
the different {\bf Changer Command} in each Device resource.
Most frequently,
- you will specify the Bacula supplied {\bf mtx-changer} script as follows:
+ you will specify the Bacula supplied {\bf mtx-changer} script as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Changer Command = "/path/mtx-changer %c %o %S %a %d"
-\end{verbatim}
+\end{lstlisting}
\normalsize
and you will install the {\bf mtx} on your system (found in the {\bf depkgs}
- release). An example of this command is in the default bacula-sd.conf file.
+ release). An example of this command is in the default bacula-sd.conf file.
For more details on the substitution characters that may be specified to
- configure your autochanger please see the
+ configure your autochanger please see the
\ilink{Autochangers}{AutochangersChapter} chapter of this manual.
For FreeBSD users, you might want to see one of the several {\bf chio}
- scripts in {\bf examples/autochangers}.
+ scripts in {\bf examples/autochangers}.
\item [Alert Command = {\it name-string}]
\index[sd]{Alert Command}
substitution characters that may be specified in the Changer Command may
also be used in this string. For more information, please see the
\ilink{Autochangers}{AutochangersChapter} chapter of this manual.
-
-
+
+
Note, it is not necessary to have an autochanger to use this command. The
example below uses the {\bf tapeinfo} program that comes with the {\bf mtx}
package, but it can be used on any tape drive. However, you will need to
specify a {\bf Changer Device} directive in your Device resource (see above)
so that the generic SCSI device name can be edited into the command (with
the \%c).
-
+
An example of the use of this command to print Tape Alerts in the Job report
- is:
+ is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Alert Command = "sh -c 'tapeinfo -f %c | grep TapeAlert'"
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
-and an example output when there is a problem could be:
+and an example output when there is a problem could be:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
bacula-sd Alert: TapeAlert[32]: Interface: Problem with SCSI interface
between tape drive and initiator.
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
\item [Drive Index = {\it number}]
for an autochanger to change the volume. If this time is exceeded,
Bacula will invalidate the Volume slot number stored in the catalog and
try again. If no additional changer volumes exist, Bacula will ask the
- operator to intervene. The default is 5 minutes.
+ operator to intervene. The default is 5 minutes.
% TODO: if this is the format, then maybe "5 minutes" should be in
% TODO: quotes? define style. see others.
minimize unnecessary operator intervention, it is highly recommended
that {\bf Always Open = yes}. This also ensures that the drive is
available when Bacula needs it.
-
+
If you have {\bf Always Open = yes} (recommended) and you want to use the
drive for something else, simply use the {\bf unmount} command in the
Console program to release the drive. However, don't forget to remount the
drive with {\bf mount} when the drive is available or the next Bacula job
will block.
-
+
For File storage, this directive is ignored. For a FIFO storage device, you
- must set this to {\bf No}.
-
+ must set this to {\bf No}.
+
Please note that if you set this directive to {\bf No} Bacula will release
the tape drive between each job, and thus the next job will rewind the tape
and position it to the end of the data. This can be a very time consuming
and continue. Please be aware that if you set this interval too small, you
may excessively wear your tape drive if the old tape remains in the drive,
since Bacula will read it on each poll. This can be avoided by ejecting the
- tape using the {\bf Offline On Unmount} and the {\bf Close on Poll}
- directives.
+ tape using the {\bf Offline On Unmount} and the {\bf Close on Poll}
+ directives.
However, if you are using a Linux 2.6 kernel or other OSes
such as FreeBSD or Solaris, the Offline On Unmount will leave the drive
with no tape, and Bacula will not be able to properly open the drive and
may fail the job. For more information on this problem, please see the
- \ilink{description of Offline On Unmount}{NoTapeInDrive} in the Tape
- Testing chapter.
+ \bsysxrlink{description of Offline On Unmount}{NoTapeInDrive}{problems}{subsection}
+ in the \bsysxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}.
\item [Close on Poll= {\it yes\vb{}no}]
\index[sd]{Close on Poll}
useful unless you have the {\bf Offline on Unmount} directive set, in which
case the drive will be taken offline preventing wear on the tape during any
future polling. Once the operator inserts a new tape, Bacula will recognize
- the drive on the next poll and automatically continue with the backup.
+ the drive on the next poll and automatically continue with the backup.
Please see above more more details.
\item [Maximum Open Wait = {\it time}]
removed or a simply a removable harddisk. When attempting to open
such a device, if the Volume is not found (for File devices, the Volume
name is the same as the Filename), then the Storage daemon will search
- the entire device looking for likely Volume names, and for each one
+ the entire device looking for likely Volume names, and for each one
found, it will ask the Director if the Volume can be used. If so,
the Storage daemon will use the first such Volume found. Thus it
acts somewhat like a tape drive -- if the correct Volume is not found,
you might consider using additional Storage daemon device directives
such as {\bf Requires Mount}, {\bf Mount Point}, {\bf Mount Command},
and {\bf Unmount Command}, all of which can be used in conjunction with
- {\bf Removable Media}.
+ {\bf Removable Media}.
\item [Random access = {\it yes\vb{}no}]
\item [Mount Point = {\it directory}]
\index[sd]{Mount Point}
- Directory where the device can be mounted.
+ Directory where the device can be mounted.
This directive is used only
- for devices that have {\bf Requires Mount} enabled such as
+ for devices that have {\bf Requires Mount} enabled such as
USB file devices.
\item [Mount Command = {\it name-string}]
\index[sd]{Mount Command}
- This directive specifies the command that must be executed to mount
- devices such as many USB devices. Before the command is
- executed, \%a is replaced with the Archive Device, and \%m with the Mount
+ This directive specifies the command that must be executed to mount
+ devices such as many USB devices. Before the command is
+ executed, \%a is replaced with the Archive Device, and \%m with the Mount
Point.
See the \ilink {Edit Codes}{mountcodes} section below for more details of
\item [Unmount Command = {\it name-string}]
\index[sd]{Unmount Command}
- This directive specifies the command that must be executed to unmount
+ This directive specifies the command that must be executed to unmount
devices such as many USB devices. Before the command is
executed, \%a is replaced with the Archive Device, and \%m with the Mount
Point.
- Most frequently, you will define it as follows:
+ Most frequently, you will define it as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Unmount Command = "/bin/umount %m"
-\end{verbatim}
+\end{lstlisting}
\normalsize
See the \ilink {Edit Codes}{mountcodes} section below for more details of
The Storage daemon will attempt to efficiently fill blocks with data
received from active sessions but will, if necessary, add padding to a
block to achieve the required minimum size.
-
+
To force the block size to be fixed, as is the case for some non-random
access devices (tape drives), set the {\bf Minimum block size} and the
{\bf Maximum block size} to the same value (zero included). The default
is that both the minimum and maximum block size are zero and the default
- block size is 64,512 bytes.
-
- For example, suppose you want a fixed block size of 100K bytes, then you
- would specify:
+ block size is 64,512 bytes.
+
+ For example, suppose you want a fixed block size of 100K bytes, then you
+ would specify:
\footnotesize
-\begin{verbatim}
-
+\begin{lstlisting}
+
Minimum block size = 100K
Maximum block size = 100K
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
Please note that if you specify a fixed block size as shown above, the tape
drive must either be in variable block size mode, or if it is in fixed block
size mode, the block size (generally defined by {\bf mt}) {\bf must} be
identical to the size specified in Bacula -- otherwise when you attempt to
- re-read your Volumes, you will get an error.
-
+ re-read your Volumes, you will get an error.
+
If you want the block size to be variable but with a 64K minimum and 200K
- maximum (and default as well), you would specify:
+ maximum (and default as well), you would specify:
\footnotesize
-\begin{verbatim}
-
+\begin{lstlisting}
+
Minimum block size = 64K
Maximum blocksize = 200K
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
\item [Maximum block size = {\it size-in-bytes}]
{\bf size-in-bytes}. If adding data to a block would cause it to exceed
the given maximum size, the block will be written to the archive device,
and the new data will begin a new block.
-
+
If no value is specified or zero is specified, the Storage daemon will
use a default block size of 64,512 bytes (126 * 512).
option, which if set will cause the driver to lose track of the file
number. You should ensure that this option is always turned off using the
{\bf mt} program.
-
+
Default setting for Hardware End of Medium is {\bf Yes}. This function is
used before appending to a tape to ensure that no previously written data is
lost. We recommend if you have a non-standard or unusual tape drive that you
use the {\bf btape} program to test your drive to see whether or not it
supports this function. All modern (after 1998) tape drives support this
- feature.
-
+ feature.
+
\item [Fast Forward Space File = {\it yes\vb{}no}]
\index[sd]{Fast Forward Space File}
\index[sd]{Directive!Fast Forward Space File}
the file number ({\bf MTIOCGET} ioctl) during forward space file. If {\bf
Yes}, the archive device must support the {\tt ioctl} {\tt MTFSF} call, which
virtually all drivers support, but in addition, your SCSI driver must keep
- track of the file number on the tape and report it back correctly by the
+ track of the file number on the tape and report it back correctly by the
{\bf MTIOCGET} ioctl. Note, some SCSI drivers will correctly forward space,
but they do not keep track of the file number or more seriously, they do not
- report end of medium.
-
+ report end of medium.
+
Default setting for Fast Forward Space File is {\bf Yes}.
-
+
\item [Use MTIOCGET = {\it yes\vb{}no}]
\index[sd]{Use MTIOCGET}
\index[sd]{Directive!Use MTIOCGET}
If {\bf No}, the operating system is not required to support keeping track of
the file number and reporting it in the ({\bf MTIOCGET} ioctl). The default
is {\bf Yes}. If you must set this to No, Bacula will do the proper file
- position determination, but it is very unfortunate because it means that
+ position determination, but it is very unfortunate because it means that
tape movement is very inefficient.
Fortunately, this operation system deficiency seems to be the case only
on a few *BSD systems. Operating systems known to work correctly are
ioctl}s to backspace over an end of file mark and to the start of a file. If
{\it No}, these calls are not used and the device must be rewound and
advanced forward to the desired position. Default is {\bf Yes} for non
- random-access devices.
+ random-access devices.
\item [Forward Space Record = {\it yes\vb{}no}]
\index[sd]{Forward Space Record}
If {\it Yes}, the archive device must support the {\bf MTFSR ioctl} to
forward space over records. If {\bf No}, data must be read in order to
advance the position on the device. Default is {\bf Yes} for non
- random-access devices.
+ random-access devices.
\item [Forward Space File = {\it yes\vb{}no}]
\index[sd]{Forward Space File}
\index[sd]{Directive!Forward Space File}
If {\bf Yes}, the archive device must support the {\tt MTFSF ioctl} to
forward space by file marks. If {\it No}, data must be read to advance the
- position on the device. Default is {\bf Yes} for non random-access devices.
+ position on the device. Default is {\bf Yes} for non random-access devices.
\item [Offline On Unmount = {\it yes\vb{}no}]
\index[sd]{Offline On Unmount}
({\bf mt -f /dev/xxx load}) before the system will recognize the tape. If you
are using an autochanger, some devices require an offline to be issued prior
to changing the volume. However, most devices do not and may get very
- confused.
+ confused.
If you are using a Linux 2.6 kernel or other OSes
such as FreeBSD or Solaris, the Offline On Unmount will leave the drive
with no tape, and Bacula will not be able to properly open the drive and
may fail the job. For more information on this problem, please see the
- \ilink{description of Offline On Unmount}{NoTapeInDrive} in the Tape
- Testing chapter.
+ \bsysxrlink{description of Offline On Unmount}{NoTapeInDrive}{problems}{subsection}
+ in the \bsysxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}.
+
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
\index[sd]{Device Maximum Concurrent Jobs}
\index[sd]{Directive!New in 3.0.3}
where \lt{}number\gt{} is 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
+ 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
\index[sd]{Maximum Job Spool Size}
\index[sd]{Directive!Maximum Job Spool Size}
where the bytes specify the maximum spool size for any one job that is
- running. The default is no limit.
+ running. The default is no limit.
This directive is implemented only in version 1.37 and later.
\item [Spool Directory = {\it directory}]
specifies the name of the directory to be used to store the spool files for
this device. This directory is also used to store temporary part files when
writing to a device that requires mount (USB). The default is to use the
- working directory.
+ working directory.
\item [Maximum Part Size = {\it bytes}]
\index[sd]{Maximum Part Size}
If the device requires mount, it is transferred to the device when this size
is reached. In this case, you must take care to have enough disk space left
- in the spool directory.
+ in the spool directory.
- Otherwise, it is left on the hard disk.
+ Otherwise, it is left on the hard disk.
- It is ignored for tape and FIFO devices.
+ It is ignored for tape and FIFO devices.
\end{description}
\label{mountcodes}
-\section{Edit Codes for Mount and Unmount Directives}
+\section{Edit Codes for Mount and Unmount Directives}
\index[general]{Directives!Edit Codes}
\index[general]{Edit Codes for Mount and Unmount Directives }
-Before submitting the {\bf Mount Command}, {\bf Unmount Command},
-{\bf Write Part Command}, or {\bf Free Space Command} directives
+Before submitting the {\bf Mount Command}, {\bf Unmount Command},
+{\bf Write Part Command}, or {\bf Free Space Command} directives
to the operating system, Bacula performs character substitution of the
following characters:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
%% = %
%a = Archive device name
%e = erase (set if cannot mount and first part)
%n = part number
%m = mount point
%v = last part name (i.e. filename)
-\end{verbatim}
+\end{lstlisting}
\normalsize
\item [Mount Point = {\it directory}]
\index[sd]{Mount Point}
\index[sd]{Directive!Mount Point}
- Directory where the device can be mounted.
+ Directory where the device can be mounted.
\item [Mount Command = {\it name-string}]
\index[sd]{Mount Command}
\index[sd]{Directive!Mount Command}
- Command that must be executed to mount the device. Before the command is
- executed, \%a is replaced with the Archive Device, and \%m with the Mount
+ Command that must be executed to mount the device. Before the command is
+ executed, \%a is replaced with the Archive Device, and \%m with the Mount
Point.
- Most frequently, you will define it as follows:
+ Most frequently, you will define it as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Mount Command = "/bin/mount -t iso9660 -o ro %a %m"
-\end{verbatim}
+\end{lstlisting}
\normalsize
For some media, you may need multiple commands. If so, it is recommended
Command. For example, instead of this:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Mount Command = "/usr/local/bin/mymount"
-\end{verbatim}
+\end{lstlisting}
\normalsize
Where that script contains:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#!/bin/sh
ndasadmin enable -s 1 -o w
sleep 2
mount /dev/ndas-00323794-0p1 /backup
-\end{verbatim}
+\end{lstlisting}
\normalsize
Similar consideration should be given to all other Command parameters.
executed, \%a is replaced with the Archive Device, and \%m with the Mount
Point.
- Most frequently, you will define it as follows:
+ Most frequently, you will define it as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Unmount Command = "/bin/umount %m"
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you need to specify multiple commands, create a shell script.
\index[general]{Resource!Messages}
\index[general]{Messages Resource}
-For a description of the Messages Resource, please see the
+For a description of the Messages Resource, please see the
\ilink{Messages Resource}{MessagesChapter} Chapter of this
-manual.
+manual.
\section{Sample Storage Daemon Configuration File}
\label{SampleConfiguration}
\index[general]{File!Sample Storage Daemon Configuration}
\index[general]{Sample Storage Daemon Configuration File}
-A example Storage Daemon configuration file might be the following:
+A example Storage Daemon configuration file might be the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# Default Bacula Storage Daemon Configuration file
#
Device {
Name = Drive-1 #
- Drive Index = 0
+ Drive Index = 0
Media Type = DLT-8000
Archive Device = /dev/nst0
AutomaticMount = yes; # when device opened, read it
director = rufus-dir = all
operator = root = mount
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Although Recycling and Backing Up to Disk Volume have been discussed in
previous chapters, this chapter is meant to give you an overall view of
-possible backup strategies and to explain their advantages and disadvantages.
+possible backup strategies and to explain their advantages and disadvantages.
\label{Simple}
\section{Simple One Tape Backup}
\index[general]{Simple One Tape Backup }
Probably the simplest strategy is to back everything up to a single tape and
-insert a new (or recycled) tape when it fills and Bacula requests a new one.
+insert a new (or recycled) tape when it fills and Bacula requests a new one.
\subsection{Advantages}
\index[general]{Advantages }
-\begin{itemize}
+\begin{bsysitemize}
\item The operator intervenes only when a tape change is needed. (once a
- month at my site).
+ month at my site).
\item There is little chance of operator error because the tape is not
- changed daily.
+ changed daily.
\item A minimum number of tapes will be needed for a full restore. Typically
- the best case will be one tape and worst two.
+ the best case will be one tape and worst two.
\item You can easily arrange for the Full backup to occur a different night
of the month for each system, thus load balancing and shortening the backup
- time.
-\end{itemize}
+ time.
+\end{bsysitemize}
\subsection{Disadvantages}
\index[general]{Disadvantages }
-\begin{itemize}
+\begin{bsysitemize}
\item If your site burns down, you will lose your current backups, and in my
- case about a month of data.
+ case about a month of data.
\item After a tape fills and you have put in a blank tape, the backup will
- continue, and this will generally happen during working hours.
- \end{itemize}
+ continue, and this will generally happen during working hours.
+ \end{bsysitemize}
\subsection{Practical Details}
\index[general]{Details!Practical }
tape, you {\bf unmount} the tape from the Console program, insert a new tape
and {\bf label} it. In most cases after the label, Bacula will automatically
mount the tape and resume the backup. Otherwise, you simply {\bf mount} the
-tape.
+tape.
Using this strategy, one typically does a Full backup once a week followed by
daily Incremental backups. To minimize the amount of data written to the tape,
one can do a Full backup once a month on the first Sunday of the
month, a Differential backup on the 2nd-5th Sunday of the month, and
-incremental backups the rest of the week.
+incremental backups the rest of the week.
\label{Manual}
\section{Manually Changing Tapes}
If you use the strategy presented above, Bacula will ask you to change the
tape, and you will {\bf unmount} it and then remount it when you have inserted
-the new tape.
+the new tape.
If you do not wish to interact with Bacula to change each tape, there are
-several ways to get Bacula to release the tape:
+several ways to get Bacula to release the tape:
-\begin{itemize}
+\begin{bsysitemize}
\item In your Storage daemon's Device resource, set
{\bf AlwaysOpen = no}
In this case, Bacula will release the tape after every job. If you run
several jobs, the tape will be rewound and repositioned to the end at the
beginning of every job. This is not very efficient, but does let you change
- the tape whenever you want.
+ the tape whenever you want.
\item Use a {\bf RunAfterJob} statement to run a script after your last job.
This could also be an {\bf Admin} job that runs after all your backup jobs.
- The script could be something like:
+ The script could be something like:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#!/bin/sh
/full-path/bconsole -c /full-path/bconsole.conf <<END_OF_DATA
release storage=your-storage-name
END_OF_DATA
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
In this example, you would have {\bf AlwaysOpen=yes}, but the {\bf release}
command would tell Bacula to rewind the tape and on the next job assume the
tape has changed. This strategy may not work on some systems, or on
-autochangers because Bacula will still keep the drive open.
+autochangers because Bacula will still keep the drive open.
\item The final strategy is similar to the previous case except that you
would use the unmount command to force Bacula to release the drive. Then you
- would eject the tape, and remount it as follows:
+ would eject the tape, and remount it as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#!/bin/sh
/full-path/bconsole -c /full-path/bconsole.conf <\<END_OF_DATA
unmount storage=your-storage-name
/full-path/bconsole -c /full-path/bconsole.conf <<END_OF_DATA
mount storage=your-storage-name
END_OF_DATA
-
-\end{verbatim}
+
+\end{lstlisting}
\normalsize
-\end{itemize}
+\end{bsysitemize}
\label{Daily}
\subsection{Advantages}
\index[general]{Advantages }
-\begin{itemize}
+\begin{bsysitemize}
\item All the data is stored on a single tape, so recoveries are simple and
- faster.
+ faster.
\item Assuming the previous day's tape is taken offsite each day, a maximum
- of one days data will be lost if the site burns down.
- \end{itemize}
+ of one days data will be lost if the site burns down.
+ \end{bsysitemize}
\subsection{Disadvantages}
\index[general]{Disadvantages }
-\begin{itemize}
+\begin{bsysitemize}
\item The tape must be changed every day requiring a lot of operator
- intervention.
-\item More errors will occur because of human mistakes.
+ intervention.
+\item More errors will occur because of human mistakes.
\item If the wrong tape is inadvertently mounted, the Backup for that day
- will not occur exposing the system to data loss.
+ will not occur exposing the system to data loss.
\item There is much more movement of the tape each day (rewinds) leading to
- shorter tape drive life time.
+ shorter tape drive life time.
\item Initial setup of Bacula to run in this mode is more complicated than
- the Single tape system described above.
+ the Single tape system described above.
\item Depending on the number of systems you have and their data capacity, it
may not be possible to do a Full backup every night for time reasons or
- reasons of tape capacity.
-\end{itemize}
+ reasons of tape capacity.
+\end{bsysitemize}
\subsection{Practical Details}
\index[general]{Details!Practical }
addition, you will need to specify appropriate Job and File retention periods
so that Bacula will relabel and overwrite the tape each week rather than
appending to it. Nic Bellamy has supplied an actual working model of this
-which we include here.
+which we include here.
What is important is to create a different Pool for each day of the week, and
on the {\bf run} statement in the Schedule, to specify which Pool is to be
premounted by the operator, the job will be automatically canceled, and the
backup cycle will re-synchronize the next day. He has named his Friday Pool
{\bf WeeklyPool} because in that Pool, he wishes to have several tapes to be
-able to restore to a time older than one week.
+able to restore to a time older than one week.
And finally, in his Storage daemon's Device resource, he has {\bf Automatic
Mount = yes} and {\bf Always Open = No}. This is necessary for the tape
-ejection to work in his {\bf end\_of\_backup.sh} script below.
+ejection to work in his {\bf end\_of\_backup.sh} script below.
-For example, his bacula-dir.conf file looks like the following:
+For example, his bacula-dir.conf file looks like the following:
\footnotesize
-\begin{verbatim}
-
+\begin{lstlisting}
+
# /etc/bacula/bacula-dir.conf
#
# Bacula Director Configuration file
console = all, !skipped, !saved
append = "/var/lib/bacula/log" = all, !skipped
}
-
+
# Pool definitions
#
# Default Pool for jobs, but will hold no actual volumes
Maximum Volume Jobs = 2
}
# EOF
-\end{verbatim}
+\end{lstlisting}
\normalsize
Note, the mailcommand and operatorcommand should be on a single line each.
They were split to preserve the proper page width. In order to get Bacula to
release the tape after the nightly backup, he uses a {\bf RunAfterJob} script
that deletes the ASCII copy of the database back and then rewinds and ejects
-the tape. The following is a copy of {\bf end\_of\_backup.sh}
+the tape. The following is a copy of {\bf end\_of\_backup.sh}
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#! /bin/sh
/usr/lib/bacula/delete_catalog_backup
mt rewind
mt eject
exit 0
-\end{verbatim}
+\end{lstlisting}
\normalsize
-Finally, if you list his Volumes, you get something like the following:
+Finally, if you list his Volumes, you get something like the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
*list media
Using default Catalog name=MyCatalog DB=bacula
Pool: WeeklyPool
+-----+-----------+-------+--------+-----------+-----------------+-------+------+
Pool: Default
No results to list.
-\end{verbatim}
+\end{lstlisting}
\normalsize
Note, I have truncated a number of the columns so that the information fits on
-the width of a page.
+the width of a page.
\elink{http://mtx.opensource-sw.net/}{http://mtx.opensource-sw.net/}.
-\addcontentsline{lot}{table}{Autochangers Known to Work with Bacula}
-\begin{longtable}{|p{0.6in}|p{0.8in}|p{1.9in}|p{0.8in}|p{0.5in}|p{0.75in}|}
- \hline
-\multicolumn{1}{|c| }{\bf OS } & \multicolumn{1}{c| }{\bf Man. } &
-\multicolumn{1}{c| }{\bf Media } & \multicolumn{1}{c| }{\bf Model } &
-\multicolumn{1}{c| }{\bf Slots } & \multicolumn{1}{c| }{\bf Cap/Slot } \\
- \hline {Linux } & {Adic } & {DDS-3} & {Adic 1200G } & {12} & {-} \\
- \hline {Linux } & {Adic } & {DLT} & {FastStore 4000 } & {7} & {20GB} \\
- \hline {Linux } & {Adic } & {LTO-1/2, SDLT 320 } & {Adic Scalar 24 } & {24} & {100GB } \\
- \hline {Linux } & {Adic } & {LTO-2 } & {Adic FastStor 2, Sun Storedge L8 } & {8} & {200GB } \\
- \hline {Linux } & {BDT } & {AIT } & {BDT ThinStor } & {?} & {200GB } \\
- \hline {- } & {CA-VM } & {?? } & {Tape } & {??} & {?? } \\
- \hline {Linux } & {Dell} & {DLT VI,LTO-2,LTO3} & {PowerVault 122T/132T/136T } & {-} & {100GB } \\
- \hline {Linux } & {Dell} & {LTO-2} & {PowerVault 124T } & {-} & {200GB } \\
- \hline {- } & {DFSMS } & {?? } & {VM RMM} & {-} & {?? } \\
- \hline {Linux } & {Exabyte } & {VXA2 } & {VXA PacketLoader 1x10 2U } & {10} & {80/160GB } \\
- \hline {- } & {Exabyte } & {LTO } & {Magnum 1x7 LTO Tape Auotloader } & {7} & {200/400GB } \\
- \hline {Linux } & {Exabyte } & {AIT-2 } & {215A } & {15 (2 drives)} & {50GB } \\
- \hline {Linux } & {HP } & {DDS-4 } & {SureStore DAT-40X6 } & {6 } & {40GB } \\
- \hline {Linux } & {HP } & {Ultrium-2/LTO } & {MSL 6000/ 60030/ 5052 } & {28 } & {200/400GB } \\
- \hline {- } & {HP } & {DLT } & {A4853 DLT } & {30} & {40/70GB } \\
- \hline {Linux } & {HP (Compaq) } & {DLT VI } & {Compaq TL-895 } & {96+4 import export} & {35/70GB } \\
- \hline {z/VM } & {IBM } & {?? } & {IBM Tape Manager } & {-} & {?? } \\
- \hline {z/VM } & {IBM } & {?? } & {native tape } & {-} & {?? } \\
- \hline {Linux } & {IBM } & {LTO } & {IBM 3581 Ultrium Tape Loader } & {7} & {200/400GB } \\
- \hline {FreeBSD 5.4} & {IBM } & {DLT} & {IBM 3502-R14 -- rebranded ATL L-500} & {14} & {35/70GB } \\
- \hline {Linux} & {IBM } & {???} & {IBM TotalStorage 3582L23} & {??} & {?? } \\
- \hline {Debian} & {Overland } & {LTO } & {Overland LoaderXpress LTO/DLT8000 } & {10-19} & {40-100GB } \\
- \hline {Fedora} & {Overland } & {LTO } & {Overland PowerLoader LTO-2 } & {10-19} & {200/400GB } \\
- \hline {FreeBSD 5.4-Stable} & {Overland} & {LTO-2} & {Overland Powerloader tape} & {17} & {100GB } \\
- \hline {- } & {Overland} & {LTO } & {Overland Neo2000 LTO } & {26-30} & {100GB } \\
- \hline {Linux} & {Quantum } & {DLT-S4} & {Superloader 3} & {16} & {800/1600GB } \\
- \hline {Linux} & {Quantum } & {LTO-2} & {Superloader 3} & {16} & {200/400GB } \\
- \hline {Linux} & {Quantum } & {LTO-3 } & {PX502 } & {??} & {?? } \\
- \hline {FreeBSD 4.9 } & {QUALSTAR TLS-4210 (Qualstar) } & {AIT1: 36GB, AIT2: 50GB all
-uncomp } & {QUALSTAR TLS-4210 } & {12} & {AIT1: 36GB, AIT2: 50GB all uncomp }\\
- \hline {Linux } & {Skydata } & {DLT } & {ATL-L200 } & {8} & {40/80 } \\
- \hline {- } & {Sony } & {DDS-4 } & {TSL-11000 } & {8} & {40GB } \\
- \hline {Linux } & {Sony } & {AIT-2} & {LIB-304(SDX-500C) } & {?} & {200GB } \\
- \hline {Linux } & {Sony } & {AIT-3} & {LIB-D81) } & {?} & {200GB } \\
- \hline {FreeBSD 4.9-STABLE } & {Sony } & {AIT-1 } & {TSL-SA300C } & {4} & {45/70GB }\\
- \hline {- } & {Storagetek } & {DLT } & {Timberwolf DLT } & {6} & {40/70 } \\
- \hline {- } & {Storagetek } & {?? } & {ACSLS } & {??} & {?? } \\
- \hline {Solaris } & {Sun } & {4mm DLT } & {Sun Desktop Archive Python 29279 } & {4} & {20GB } \\
- \hline {Linux } & {Tandberg } & {DLT VI } & {VS 640 } & {8?} & {35/70GB } \\
- \hline {Linux 2.6.x } & {Tandberg Data } & {SLR100 } & {SLR100 Autoloader } & {8} & {50/100GB }\\
-\hline
-
-\end{longtable}
+%\addcontentsline{lot}{table}{Autochangers Known to Work with Bacula}
+\begin{landscape}
+\LTXtable{\linewidth}{table_supportedchangers}
+\end{landscape}
\index[general]{Drives!Supported Tape }
\index[general]{Supported Tape Drives }
-Bacula uses standard operating system calls (read, write, ioctl) to
+Bacula uses standard operating system calls (read, write, ioctl) to
interface to tape drives. As a consequence, it relies on having a
correctly written OS tape driver. Bacula is known to work perfectly well
with SCSI tape drivers on FreeBSD, Linux, Solaris, and Windows machines,
the OSST driver is one such
example, and it is known to work with Bacula. In addition a number of such
tape drives (i.e. OS drivers) seem to work on Windows systems. However,
-non-SCSI tape drives (other than the OnStream) that use ide-scis, ide-tape,
+non-SCSI tape drives (other than the OnStream) that use ide-scis, ide-tape,
or other non-scsi drivers do not function correctly with Bacula (or any
other demanding tape application) as of today (April 2007). If you
have purchased a non-SCSI tape drive for use with Bacula on Linux, there
is a good chance that it will not work. We are working with the kernel
-developers to rectify this situation, but it will not be resolved in the
+developers to rectify this situation, but it will not be resolved in the
near future.
Generally any modern tape drive (i.e. after 2010) will work out
of the box with Bacula using the standard Bacula Device specification
in the bacula-sd.conf file.
-Even if your drive is on the list below, please check the
+Even if your drive is on the list below, please check the
\ilink{Tape Testing Chapter}{btape1} of this manual for
procedures that you can use to verify if your tape drive will work with
Bacula. If your drive is in fixed block mode, it may appear to work with
Bacula until you attempt to do a restore and Bacula wants to position the
tape. You can be sure only by following the procedures suggested above and
-testing.
+testing.
It is very difficult to supply a list of supported tape drives, or drives that
are known to work with Bacula because of limited feedback (so if you use
Bacula on a different drive, please let us know). Based on user feedback, the
following drives are known to work with Bacula. A dash in a column means
-unknown:
-
-\addcontentsline{lot}{table}{Supported Tape Drives}
-\begin{longtable}{|p{2.0in}|l|l|p{2.5in}|l|}
- \hline
-\multicolumn{1}{|c| }{\bf OS } & \multicolumn{1}{c| }{\bf Man. } &
-\multicolumn{1}{c| }{\bf Media } & \multicolumn{1}{c| }{\bf Model } &
-\multicolumn{1}{c| }{\bf Capacity } \\
- \hline {- } & {ADIC } & {DLT } & {Adic Scalar 100 DLT } & {100GB } \\
- \hline {- } & {ADIC } & {DLT } & {Adic Fastor 22 DLT } & {- } \\
- \hline {FreeBSD 5.4-RELEASE-p1 amd64 } & {Certance} & {LTO } & {AdicCertance CL400 LTO Ultrium 2 } & {200GB } \\
- \hline {- } & {- } & {DDS } & {Compaq DDS 2,3,4 } & {- } \\
- \hline {SuSE 8.1 Pro} & {Compaq} & {AIT } & {Compaq AIT 35 LVD } & {35/70GB } \\
- \hline {- } & {HP } & {Travan 4 } & {Colorado T4000S } & {- } \\
- \hline {- } & {HP } & {DLT } & {HP DLT drives } & {- } \\
- \hline {- } & {HP } & {LTO } & {HP LTO Ultrium drives } & {- } \\
- \hline {- } & {IBM} & {??} & {3480, 3480XL, 3490, 3490E, 3580 and 3590 drives} & {- } \\
- \hline {FreeBSD 4.10 RELEASE } & {HP } & {DAT } & {HP StorageWorks DAT72i } & {- } \\
- \hline {- } & {Overland } & {LTO } & {LoaderXpress LTO } & {- } \\
- \hline {- } & {Overland } & {- } & {Neo2000 } & {- } \\
- \hline {- } & {OnStream } & {- } & {OnStream drives (see below) } & {- } \\
- \hline {FreeBSD 4.11-Release} & {Quantum } & {SDLT } & {SDLT320 } & {160/320GB } \\
- \hline {- } & {Quantum } & {DLT } & {DLT-8000 } & {40/80GB } \\
- \hline {Linux } & {Seagate } & {DDS-4 } & {Scorpio 40 } & {20/40GB } \\
- \hline {FreeBSD 4.9 STABLE } & {Seagate } & {DDS-4 } & {STA2401LW } & {20/40GB } \\
- \hline {FreeBSD 5.2.1 pthreads patched RELEASE } & {Seagate } & {AIT-1 } & {STA1701W} & {35/70GB } \\
- \hline {Linux } & {Sony } & {DDS-2,3,4 } & {- } & {4-40GB } \\
- \hline {Linux } & {Tandberg } & {- } & {Tandbert MLR3 } & {- } \\
- \hline {FreeBSD } & {Tandberg } & {- } & {Tandberg SLR6 } & {- } \\
- \hline {Solaris } & {Tandberg } & {- } & {Tandberg SLR75 } & {- } \\
- \hline
-
-\end{longtable}
+unknown:
+
+\LTXtable{0.95\linewidth}{table_tapedrives}
+%\addcontentsline{lot}{table}{Supported Tape Drives}
There is a list of \ilink{supported autochangers}{Models} in the Supported
Autochangers chapter of this document, where you will find other tape drives
-that work with Bacula.
+that work with Bacula.
\section{Unsupported Tape Drives}
\label{UnSupportedDrives}
Previously OnStream IDE-SCSI tape drives did not work with Bacula. As of
Bacula version 1.33 and the osst kernel driver version 0.9.14 or later, they
-now work. Please see the testing chapter as you must set a fixed block size.
+now work. Please see the testing chapter as you must set a fixed block size.
QIC tapes are known to have a number of particularities (fixed block size, and
one EOF rather than two to terminate the tape). As a consequence, you will
need to take a lot of care in configuring them to make them work correctly
-with Bacula.
+with Bacula.
\section{FreeBSD Users Be Aware!!!}
\index[general]{FreeBSD Users Be Aware }
Unless you have patched the pthreads library on FreeBSD 4.11 systems, you will
lose data when Bacula spans tapes. This is because the unpatched pthreads
library fails to return a warning status to Bacula that the end of the tape is
-near. This problem is fixed in FreeBSD systems released after 4.11. Please see the
-\ilink{Tape Testing Chapter}{FreeBSDTapes} of this manual for
-{\bf important} information on how to configure your tape drive for
-compatibility with Bacula.
+near. This problem is fixed in FreeBSD systems released after 4.11. Please see the
+\bsysxrlink{Tape testing}{FreeBSDTapes}{problems}{section} of \problemsman{}
+for {\bf important} information on how to configure your tape drive for
+compatibility with \mbacula{}.
\section{Supported Autochangers}
\index[general]{Autochangers!Supported }
\index[general]{Supported Autochangers }
-For information on supported autochangers, please see the
+For information on supported autochangers, please see the
\ilink{Autochangers Known to Work with Bacula}{Models}
-section of the Supported Autochangers chapter of this manual.
+section of the Supported Autochangers chapter of this manual.
\section{Tape Specifications}
\index[general]{Specifications!Tape}
If you want to know what tape drive to buy that will work with Bacula,
we really cannot tell you. However, we can say that if you are going
to buy a drive, you should try to avoid DDS drives. The technology is
-rather old and DDS tape drives need frequent cleaning. DLT drives are
-generally much better (newer technology) and do not need frequent
+rather old and DDS tape drives need frequent cleaning. DLT drives are
+generally much better (newer technology) and do not need frequent
cleaning.
Below, you will find a table of DLT and LTO tape specifications that will
-give you some idea of the capacity and speed of modern tapes. The
+give you some idea of the capacity and speed of modern tapes. The
capacities that are listed are the native tape capacity without compression.
All modern drives have hardware compression, and manufacturers often list
-compressed capacity using a compression ration of 2:1. The actual compression
+compressed capacity using a compression ration of 2:1. The actual compression
ratio will depend mostly on the data you have to backup, but I find that
-1.5:1 is a much more reasonable number (i.e. multiply the value shown in
+1.5:1 is a much more reasonable number (i.e. multiply the value shown in
the table by 1.5 to get a rough average of what you will probably see).
The transfer rates are rounded to the nearest GB/hr. All values are provided
by various manufacturers.
required to use (but you may) the same name in your Bacula conf resources.
-\begin{tabular}{|c|c|c|c}
-Media Type & Drive Type & Media Capacity & Transfer Rate \\ \hline
-DDS-1 & DAT & 2 GB & ?? GB/hr \\ \hline
-DDS-2 & DAT & 4 GB & ?? GB/hr \\ \hline
-DDS-3 & DAT & 12 GB & 5.4 GB/hr \\ \hline
-Travan 40 & Travan & 20 GB & ?? GB/hr \\ \hline
-DDS-4 & DAT & 20 GB & 11 GB/hr \\ \hline
-VXA-1 & Exabyte & 33 GB & 11 GB/hr \\ \hline
-DAT-72 & DAT & 36 GB & 13 GB/hr \\ \hline
-DLT IV & DLT8000 & 40 GB & 22 GB/hr \\ \hline
-VXA-2 & Exabyte & 80 GB & 22 GB/hr \\ \hline
-Half-high Ultrium 1 & LTO 1 & 100 GB & 27 GB/hr \\ \hline
-Ultrium 1 & LTO 1 & 100 GB & 54 GB/hr \\ \hline
-Super DLT 1 & SDLT 220 & 110 GB & 40 GB/hr \\ \hline
-VXA-3 & Exabyte & 160 GB & 43 GB/hr \\ \hline
-Super DLT I & SDLT 320 & 160 GB & 58 GB/hr \\ \hline
-Ultrium 2 & LTO 2 & 200 GB & 108 GB/hr \\ \hline
-Super DLT II & SDLT 600 & 300 GB & 127 GB/hr \\ \hline
-VXA-4 & Exabyte & 320 GB & 86 GB/hr \\ \hline
-Ultrium 3 & LTO 3 & 400 GB & 216 GB/hr \\ \hline
-\end{tabular}
+\LTXtable{0.95\linewidth}{table_ltodltspec}
\index[general]{Systems!Supported Operating }
\index[general]{Supported Operating Systems }
-\begin{itemize}
+\begin{bsysitemize}
\item[X] Fully supported
\item[$\star$] The are reported to work in many cases and the Community
has committed code for them. However they are
not directly supported by the Bacula project, as we don't have the
hardware.
-\end{itemize}
+\end{bsysitemize}
-
-\begin{tabular}[h]{|l|l|c|c|c|}
- \hline
- Operating Systems & Version & Client \small{Daemon} & Director \small{Daemon} & Storage \small{Daemon} \\
- \hline
- \hline
- GNU/Linux
- & All & X & X & X \\
- \hline
- FreeBSD & $\geq$ 5.0 & X & X & X
- \\
- \hline
- Solaris & $\geq$ 8 & X & X & X \\
- \hline
- OpenSolaris & ~ & X & X & X \\
- \hline
- \hline
- MS Windows 32bit& Win98/Me & X & ~ & ~ \\
- \hline
- ~ & WinNT/2K & X & $\star$ & $\star$ \\
- \hline
- ~ & XP & X & $\star$ & $\star$ \\
- ~ & 2008/Vista & X & $\star$ & $\star$ \\
- MS Windows 64bit& 2008/Vista & X & $\star$ & $\star$ \\
- \hline
- \hline
- MacOS X/Darwin & ~ & X & $\star$ & $\star$ \\
- \hline
- OpenBSD & ~ & X & $\star$ & ~ \\
- \hline
- NetBSD & ~ & X & $\star$ & ~ \\
- \hline
- Irix & ~ & $\star$ & ~ & ~ \\
- \hline
- True64 & ~ & $\star$ & ~ & ~ \\
- \hline
- AIX & $\geq$ 4.3 & $\star$ & ~ & ~ \\
- \hline
- BSDI & ~ & $\star$ & ~ & ~ \\
- \hline
- HPUX & ~ & $\star$ & ~ & ~ \\
- \hline
-\end{tabular}
+\LTXtable{\linewidth}{table_supportedoses}
\section*{Important notes}
-\begin{itemize}
+\begin{bsysitemize}
\item By GNU/Linux, we mean 32/64bit Gentoo, Red Hat, Fedora, Mandriva,
Debian, OpenSuSE, Ubuntu, Kubuntu, \dots
\item For FreeBSD older than version 5.0,
please see some {\bf important} considerations in the
- \ilink{ Tape Modes on FreeBSD}{FreeBSDTapes} section of the
- Tape Testing chapter of this manual.
+ \bsysxrlink{Tape Modes on FreeBSD}{FreeBSDTapes}{problems}{section} of \problemsman{}.
\item MS Windows Director and Storage daemon are available
in the binary Client installer
\item For MacOSX see \elink{http://fink.sourceforge.net/ for obtaining the packages}{http://fink.sourceforge.net/}
-\end{itemize}
+\end{bsysitemize}
-See the Porting chapter of the Bacula Developer's Guide for information on
-porting to other systems.
+See the \bsysxrlinkdocument{Porting}{_PortingChapter}{developers}{chapter} of the \devman{} for
+ information on porting to other systems.
If you have a older Red Hat Linux system running the 2.4.x kernel and you have
the directory {\bf /lib/tls} installed on your system (normally by default),
--- /dev/null
+\begin{longtable}{|X|c|c|}
+ \hline
+ \multicolumn{1}{|c|}{\bf 3rd Party Package}
+ & \multicolumn{1}{c|}{\bf depkgs}
+ & \multicolumn{1}{c|}{\bf depkgs-qt} \\
+ \endfirsthead
+ \hline
+ \multicolumn{1}{|c|}{\bf 3rd Party Package}
+ & \multicolumn{1}{c|}{\bf depkgs}
+ & \multicolumn{1}{c|}{\bf depkgs-qt} \\
+ \hline
+ \endhead
+ \hline
+ \multicolumn{3}{c}{Cont. on next page} \\
+ \endfoot
+\hline
+ \caption{Dependency packages} \\
+ \endlastfoot
+ \hline SQLite3 & X & \\
+ \hline mtx & X & \\
+ \hline qt4 & & X \\
+\end{longtable}
--- /dev/null
+\begin{longtable}{|X|c|c|c|}
+\hline
+\multicolumn{1}{|c|}{\textbf{Media Type}}
+& \multicolumn{1}{c|}{\textbf{Drive Type}}
+& \multicolumn{1}{c|}{\textbf{Media Capacity}}
+& \multicolumn{1}{c|}{\textbf{Transfer Rate}} \\
+\hline
+\endfirsthead
+\hline
+\multicolumn{1}{|c|}{\textbf{Media Type}}
+& \multicolumn{1}{c|}{\textbf{Drive Type}}
+& \multicolumn{1}{c|}{\textbf{Media Capacity}}
+& \multicolumn{1}{c|}{\textbf{Transfer Rate}} \\
+\hline
+\endhead
+ \hline
+\multicolumn{4}{c}{Cont. on next page} \\
+\endfoot
+\hline
+\caption{DLT \& LTO specifications} \\
+\endlastfoot
+DDS-1 & DAT & 2 GB & ?? GB/hr \\ \hline
+DDS-2 & DAT & 4 GB & ?? GB/hr \\ \hline
+DDS-3 & DAT & 12 GB & 5.4 GB/hr \\ \hline
+Travan 40 & Travan & 20 GB & ?? GB/hr \\ \hline
+DDS-4 & DAT & 20 GB & 11 GB/hr \\ \hline
+VXA-1 & Exabyte & 33 GB & 11 GB/hr \\ \hline
+DAT-72 & DAT & 36 GB & 13 GB/hr \\ \hline
+DLT IV & DLT8000 & 40 GB & 22 GB/hr \\ \hline
+VXA-2 & Exabyte & 80 GB & 22 GB/hr \\ \hline
+Half-high Ultrium 1 & LTO 1 & 100 GB & 27 GB/hr \\ \hline
+Ultrium 1 & LTO 1 & 100 GB & 54 GB/hr \\ \hline
+Super DLT 1 & SDLT 220 & 110 GB & 40 GB/hr \\ \hline
+VXA-3 & Exabyte & 160 GB & 43 GB/hr \\ \hline
+Super DLT I & SDLT 320 & 160 GB & 58 GB/hr \\ \hline
+Ultrium 2 & LTO 2 & 200 GB & 108 GB/hr \\ \hline
+Super DLT II & SDLT 600 & 300 GB & 127 GB/hr \\ \hline
+VXA-4 & Exabyte & 320 GB & 86 GB/hr \\ \hline
+Ultrium 3 & LTO 3 & 400 GB & 216 GB/hr \\ \hline
+\end{longtable}
--- /dev/null
+\begin{longtable}{|X|X|X|X|}
+\hline
+\multicolumn{1}{|c|}{\textbf{Orignal filename}}
+& \multicolumn{1}{|c|}{\textbf{New filename}}
+& \multicolumn{1}{|c|}{\textbf{RegexWhere}}
+& \multicolumn{1}{|c|}{\textbf{Comments}} \\
+\hline
+\endfirsthead
+\hline
+\multicolumn{1}{|c|}{\textbf{Orignal filename}}
+& \multicolumn{1}{|c|}{\textbf{New filename}}
+& \multicolumn{1}{|c|}{\textbf{RegexWhere}}
+& \multicolumn{1}{|c|}{\textbf{Comments}} \\
+\hline
+\endhead
+\caption{Regular expressions examples}\label{tab:regexpexamples} \\
+\endlastfoot
+\multicolumn{4}{c}{Cont. on next page} \\
+\endfoot
+\url{c:/system.ini} & \url{c:/system.old.ini} & \url{/.ini\$/.old.ini/} & \$ matches end of name\\
+\hline
+\url{/prod/u01/pdata/} & \url{/rect/u01/rdata} & \url{/prod/rect/,/pdata/rdata/} & uses two regexp\\
+\hline
+\url{/prod/u01/pdata/} & \url{/rect/u01/rdata} & \url{!/prod/!/rect/!,/pdata/rdata/} & use \url{!} as separator\\
+\hline
+\url{C:/WINNT} & \url{d:/WINNT} & \url{/c:/d:/i} & case insensitive pattern match \\
+\hline
+\end{longtable}
--- /dev/null
+\begin{longtable}{|X|c|c|c|c|}
+ \hline
+ \multicolumn{1}{|c|}{\bf Resource}
+ & \multicolumn{1}{c|}{\bf Director}
+ & \multicolumn{1}{c|}{\bf Client}
+ & \multicolumn{1}{c|}{\bf Storage} &
+ \multicolumn{1}{c|}{\bf Console} \\
+ \endfirsthead
+ \hline
+ \multicolumn{1}{|c|}{\bf Resource}
+ & \multicolumn{1}{c|}{\bf Director}
+ & \multicolumn{1}{c|}{\bf Client}
+ & \multicolumn{1}{c|}{\bf Storage} &
+ \multicolumn{1}{c|}{\bf Console} \\
+ \endhead
+ \hline
+ \multicolumn{5}{c}{Cont. on next page} \\
+ \endfoot
+ \hline
+ \caption{Resources types}
+ \endlastfoot
+ \hline
+Autochanger & No & No & Yes & No \\
+\hline
+Catalog & Yes & No & No & No \\
+ \hline
+Client & Yes & Yes & No & No \\
+ \hline
+Console & Yes & No & No & Yes \\
+ \hline
+Device & No & No & Yes & No \\
+ \hline
+Director & Yes & Yes & Yes & Yes \\
+ \hline
+FileSet & Yes & No & No & No \\
+ \hline
+Job & Yes & No & No & No \\
+ \hline
+JobDefs & Yes & No & No & No \\
+ \hline
+Message & Yes & Yes & Yes & No \\
+ \hline
+Pool & Yes & No & No & No \\
+ \hline
+Schedule & Yes & No & No & No \\
+ \hline
+Storage & Yes & No & Yes & No \\
+ \hline
+\end{longtable}
--- /dev/null
+\begin{longtable}{|X|X|X|X|}
+\hline
+\multicolumn{1}{|c|}{\textbf{Options}}
+& \multicolumn{1}{c|}{\textbf{Value}}
+& \multicolumn{1}{c|}{\textbf{Default}}
+& \multicolumn{1}{c|}{\textbf{Information}} \\
+\endfirsthead
+\hline
+\multicolumn{1}{|c|}{\textbf{Options}}
+& \multicolumn{1}{c|}{\textbf{Value}}
+& \multicolumn{1}{c|}{\textbf{Default}}
+& \multicolumn{1}{c|}{\textbf{Information}} \\
+\endhead
+\hline
+\multicolumn{4}{c}{Cont. on next page} \\
+\endfoot
+\hline
+\caption{Options for Run Script} \\
+\endlastfoot
+\hline
+Runs On Success & Yes / No & {\it Yes} & Run command if JobStatus is successful\\
+\hline
+Runs On Failure & Yes / No & {\it No} & Run command if JobStatus isn't successful\\
+\hline
+Runs On Client & Yes / No & {\it Yes} & Run command on client\\
+\hline
+Runs When & Before | After | Always | \textsl{AfterVSS} & {\it Never} & When run commands\\
+\hline
+Fail Job On Error & Yes/No & {\it Yes} & Fail job if script returns
+ something different from 0 \\
+\hline
+Command & & & Path to your script\\
+\hline
+Console & & & Console command\\
+\hline
+\end{longtable}
--- /dev/null
+\begin{longtable}{|X|c|c|c|c|c|}
+\hline
+\multicolumn{1}{|c|}{\textbf{~}}
+& \multicolumn{1}{c|}{\textbf{Runs}}
+& \multicolumn{1}{c|}{\textbf{Runs}}
+& \multicolumn{1}{c|}{\textbf{FailJob}}
+& \multicolumn{1}{c|}{\textbf{Runs}}
+& \multicolumn{1}{c|}{\textbf{Runs}} \\
+\multicolumn{1}{|c|}{\textbf{Keyword}}
+& \multicolumn{1}{c|}{\textbf{On}}
+& \multicolumn{1}{c|}{\textbf{On}}
+& \multicolumn{1}{c|}{\textbf{On}}
+& \multicolumn{1}{c|}{\textbf{On}}
+& \multicolumn{1}{c|}{\textbf{When}} \\
+\multicolumn{1}{|c|}{\textbf{~}}
+& \multicolumn{1}{c|}{\textbf{Success}}
+& \multicolumn{1}{c|}{\textbf{Failure}}
+& \multicolumn{1}{c|}{\textbf{Error}}
+& \multicolumn{1}{c|}{\textbf{Client}}
+& \multicolumn{1}{c|}{\textbf{~}} \\
+\endfirsthead
+\hline
+\multicolumn{1}{|c|}{\textbf{~}}
+& \multicolumn{1}{c|}{\textbf{Runs}}
+& \multicolumn{1}{c|}{\textbf{Runs}}
+& \multicolumn{1}{c|}{\textbf{FailJob}}
+& \multicolumn{1}{c|}{\textbf{Runs}}
+& \multicolumn{1}{c|}{\textbf{Runs}} \\
+\multicolumn{1}{|c|}{\textbf{Keyword}}
+& \multicolumn{1}{c|}{\textbf{On}}
+& \multicolumn{1}{c|}{\textbf{On}}
+& \multicolumn{1}{c|}{\textbf{On}}
+& \multicolumn{1}{c|}{\textbf{On}}
+& \multicolumn{1}{c|}{\textbf{When}} \\
+\multicolumn{1}{|c|}{\textbf{~}}
+& \multicolumn{1}{c|}{\textbf{Success}}
+& \multicolumn{1}{c|}{\textbf{Failure}}
+& \multicolumn{1}{c|}{\textbf{Error}}
+& \multicolumn{1}{c|}{\textbf{Client}}
+& \multicolumn{1}{c|}{\textbf{~}} \\
+\endhead
+\hline
+\multicolumn{6}{c}{Cont. on next page} \\
+\endfoot
+\hline
+\caption{RunScript shortcuts}\label{tab:runscriptshortcuts}
+\endlastfoot
+\hline
+Run Before Job & & & Yes & No & Before \\
+\hline
+Run After Job & Yes & No & & No & After \\
+\hline
+Run After Failed Job & No & Yes & & No & After \\
+\hline
+Client Run Before Job & & & Yes & Yes & Before \\
+\hline
+Client Run After Job & Yes & No & & Yes & After \\
+\end{longtable}
--- /dev/null
+\begin{longtable}{|p{2cm}|p{2cm}|p{2cm}|X|c|p{2cm}|}
+ \hline
+ \multicolumn{1}{|c|}{\bf O.S.}
+ & \multicolumn{1}{c|}{\bf Man.}
+ &\multicolumn{1}{c|}{\bf Media}
+ & \multicolumn{1}{c|}{\bf Model}
+ & \multicolumn{1}{c|}{\bf Slots}
+ & \multicolumn{1}{c|}{\bf Cap / Slot } \\
+ \hline
+\endfirsthead
+\hline
+ \multicolumn{1}{|c|}{\bf O.S.}
+ & \multicolumn{1}{c|}{\bf Man.}
+ &\multicolumn{1}{c|}{\bf Media}
+ & \multicolumn{1}{c|}{\bf Model}
+ & \multicolumn{1}{c|}{\bf Slots}
+ & \multicolumn{1}{c|}{\bf Cap / Slot } \\
+\hline
+\endhead
+\multicolumn{6}{c}{\emph{Cont. on next page}} \\
+\endfoot
+\caption{Autochangers Known to Work with Bacula}\label{tab:supportedchangers} \\
+\endlastfoot
+Linux & Adic & DDS-3 & Adic 1200G & 12 & --- \\
+ \hline Linux & Adic & DLT & FastStore 4000 & 7 & 20GB \\
+ \hline Linux & Adic & LTO-1/2, SDLT 320 & Adic Scalar 24 & 24 & 100GB \\
+ \hline Linux & Adic & LTO-2 & Adic FastStor 2, Sun Storedge L8 & 8 & 200GB \\
+ \hline Linux & BDT & AIT & BDT ThinStor & ? & 200GB \\
+ \hline --- & CA-VM & ?? & Tape & ?? & ?? \\
+ \hline Linux & Dell & DLT VI,LTO-2,LTO3 & PowerVault 122T/132T/136T & --- & 100GB \\
+ \hline Linux & Dell & LTO-2 & PowerVault 124T & --- & 200GB \\
+ \hline --- & DFSMS & ?? & VM RMM & --- & ?? \\
+ \hline Linux & Exabyte & VXA2 & VXA PacketLoader 1x10 2U & 10 & 80/160GB \\
+ \hline --- & Exabyte & LTO & Magnum 1x7 LTO Tape Auotloader & 7 & 200/400GB \\
+ \hline Linux & Exabyte & AIT-2 & 215A & 15 (2 drives) & 50GB \\
+ \hline Linux & HP & DDS-4 & SureStore DAT-40X6 & 6 & 40GB \\
+ \hline Linux & HP & Ultrium-2/LTO & MSL 6000/ 60030/ 5052 & 28 & 200/400GB \\
+ \hline --- & HP & DLT & A4853 DLT & 30 & 40/70GB \\
+ \hline Linux & HP (Compaq) & DLT VI & Compaq TL-895 & 96+4 import export & 35/70GB \\
+ \hline z/VM & IBM & ?? & IBM Tape Manager & --- & ?? \\
+ \hline z/VM & IBM & ?? & native tape & --- & ?? \\
+ \hline Linux & IBM & LTO & IBM 3581 Ultrium Tape Loader & 7 & 200/400GB \\
+ \hline FreeBSD 5.4 & IBM & DLT & IBM 3502-R14 -- rebranded ATL L-500 & 14 & 35/70GB \\
+ \hline Linux & IBM & ??? & IBM TotalStorage 3582L23 & ?? & ?? \\
+ \hline Debian & Overland & LTO & Overland LoaderXpress LTO/DLT8000 & 10-19 & 40-100GB \\
+ \hline Fedora & Overland & LTO & Overland PowerLoader LTO-2 & 10-19 & 200/400GB \\
+ \hline FreeBSD 5.4-Stable & Overland & LTO-2 & Overland Powerloader tape & 17 & 100GB \\
+ \hline --- & Overland & LTO & Overland Neo2000 LTO & 26-30 & 100GB \\
+ \hline Linux & Quantum & DLT-S4 & Superloader 3 & 16 & 800/1600GB \\
+ \hline Linux & Quantum & LTO-2 & Superloader 3 & 16 & 200/400GB \\
+ \hline Linux & Quantum & LTO-3 & PX502 & ?? & ?? \\
+ \hline FreeBSD 4.9 & QUALSTAR TLS-4210 (Qualstar) & AIT1: 36GB, AIT2: 50GB all
+uncomp & QUALSTAR TLS-4210 & 12 & AIT1: 36GB, AIT2: 50GB all uncomp \\
+ \hline Linux & Skydata & DLT & ATL-L200 & 8 & 40/80 \\
+ \hline - & Sony & DDS-4 & TSL-11000 & 8 & 40GB \\
+ \hline Linux & Sony & AIT-2 & LIB-304(SDX-500C) & ? & 200GB \\
+ \hline Linux & Sony & AIT-3 & LIB-D81) & ? & 200GB \\
+ \hline FreeBSD 4.9-STABLE & Sony & AIT-1 & TSL-SA300C & 4 & 45/70GB \\
+ \hline --- & Storagetek & DLT & Timberwolf DLT & 6 & 40/70 \\
+ \hline --- & Storagetek & ?? & ACSLS & ?? & ?? \\
+ \hline Solaris & Sun & 4mm DLT & Sun Desktop Archive Python 29279 & 4 & 20GB \\
+ \hline Linux & Tandberg & DLT VI & VS 640 & 8? & 35/70GB \\
+ \hline Linux 2.6.x & Tandberg Data & SLR100 & SLR100 Autoloader & 8 & 50/100GB \\
+\hline
+\end{longtable}
+
--- /dev/null
+\begin{longtable}[h]{|X|c|c|c|c|}
+ \hline
+ \multicolumn{1}{|c|}{\textbf{Operating}}
+ & \multicolumn{1}{c|}{\textbf{Version}}
+ & \multicolumn{1}{c|}{\textbf{Client}}
+ & \multicolumn{1}{c|}{\textbf{Director}}
+ & \multicolumn{1}{c|}{\textbf{Storage}} \\
+
+ \multicolumn{1}{|c|}{\textbf{Systems}}
+ & \multicolumn{1}{c|}{\textbf{~}}
+ & \multicolumn{1}{c|}{\textbf{Daemon}}
+ & \multicolumn{1}{c|}{\textbf{Daemon}}
+ & \multicolumn{1}{c|}{\textbf{Deamon}} \\
+ \hline
+\endfirsthead
+ \hline
+ \multicolumn{1}{|c|}{\textbf{Operating}}
+ & \multicolumn{1}{c|}{\textbf{Version}}
+ & \multicolumn{1}{c|}{\textbf{Client}}
+ & \multicolumn{1}{c|}{\textbf{Director}}
+ & \multicolumn{1}{c|}{\textbf{Storage}} \\
+
+ \multicolumn{1}{|c|}{\textbf{Systems}}
+ & \multicolumn{1}{c|}{\textbf{~}}
+ & \multicolumn{1}{c|}{\textbf{Daemon}}
+ & \multicolumn{1}{c|}{\textbf{Daemon}}
+ & \multicolumn{1}{c|}{\textbf{Deamon}} \\
+ \hline
+\endhead
+\hline
+\endfoot
+\hline
+\caption{\mbacula{} supported operating systems} \\
+\endlastfoot
+ \hline
+ GNU/Linux
+ & All & X & X & X \\
+ \hline
+ FreeBSD & $\geq$ 5.0 & X & X & X
+ \\
+ \hline
+ Solaris & $\geq$ 8 & X & X & X \\
+ \hline
+ OpenSolaris & ~ & X & X & X \\
+ \hline
+ \hline
+ MS Windows 32bit& Win98/Me & X & ~ & ~ \\
+ \hline
+ ~ & WinNT/2K & X & $\star$ & $\star$ \\
+ \hline
+ ~ & XP & X & $\star$ & $\star$ \\
+ ~ & 2008/Vista & X & $\star$ & $\star$ \\
+ MS Windows 64bit& 2008/Vista & X & $\star$ & $\star$ \\
+ \hline
+ \hline
+ MacOS X/Darwin & ~ & X & $\star$ & $\star$ \\
+ \hline
+ OpenBSD & ~ & X & $\star$ & ~ \\
+ \hline
+ NetBSD & ~ & X & $\star$ & ~ \\
+ \hline
+ Irix & ~ & $\star$ & ~ & ~ \\
+ \hline
+ True64 & ~ & $\star$ & ~ & ~ \\
+ \hline
+ AIX & $\geq$ 4.3 & $\star$ & ~ & ~ \\
+ \hline
+ BSDI & ~ & $\star$ & ~ & ~ \\
+ \hline
+ HPUX & ~ & $\star$ & ~ & ~ \\
+ \hline
+\end{longtable}
--- /dev/null
+\begin{longtable}[h]{|p{2cm}|c|c|X|c|}
+ \hline
+ \multicolumn{1}{|c|}{\bf OS}
+ & \multicolumn{1}{c|}{\bf Man.}
+ & \multicolumn{1}{c|}{\bf Media}
+ & \multicolumn{1}{c|}{\bf Model}
+ & \multicolumn{1}{c| }{\bf Capacity} \\
+ \hline
+ \endfirsthead
+ \hline
+ \multicolumn{1}{|c|}{\bf OS}
+ & \multicolumn{1}{c|}{\bf Man.}
+ & \multicolumn{1}{c|}{\bf Media}
+ & \multicolumn{1}{c|}{\bf Model }
+ & \multicolumn{1}{c| }{\bf Capacity } \\
+ \hline
+ \endhead
+ \hline
+ \multicolumn{5}{c}{Cont. on next page} \\
+ \endfoot
+ \hline
+ \caption{Supported Tape Drives} \\
+ \endlastfoot
+ \hline -- & ADIC & DLT & Adic Scalar 100 DLT & 100GB \\
+ \hline -- & ADIC & DLT & Adic Fastor 22 DLT & -- \\
+ \hline FreeBSD 5.4-RELEASE-p1 amd64 & Certance & LTO & AdicCertance CL400 LTO Ultrium 2 & 200GB \\
+ \hline -- & -- & DDS & Compaq DDS 2,3,4 & -- \\
+ \hline SuSE 8.1 Pro & Compaq & AIT & Compaq AIT 35 LVD & 35/70GB \\
+ \hline -- & HP & Travan 4 & Colorado T4000S & -- \\
+ \hline -- & HP & DLT & HP DLT drives & -- \\
+ \hline -- & HP & LTO & HP LTO Ultrium drives & -- \\
+ \hline -- & IBM & ?? & 3480, 3480XL, 3490, 3490E, 3580 and 3590 drives & -- \\
+ \hline FreeBSD 4.10 RELEASE & HP & DAT & HP StorageWorks DAT72i & -- \\
+ \hline -- & Overland & LTO & LoaderXpress LTO & -- \\
+ \hline -- & Overland & -- & Neo2000 & -- \\
+ \hline -- & OnStream & -- & OnStream drives (see below) & -- \\
+ \hline FreeBSD 4.11-Release & Quantum & SDLT & SDLT320 & 160/320GB \\
+ \hline -- & Quantum & DLT & DLT-8000 & 40/80GB \\
+ \hline Linux & Seagate & DDS-4 & Scorpio 40 & 20/40GB \\
+ \hline FreeBSD 4.9 STABLE & Seagate & DDS-4 & STA2401LW & 20/40GB \\
+ \hline FreeBSD 5.2.1 pthreads patched RELEASE & Seagate & AIT-1 & STA1701W & 35/70GB \\
+ \hline Linux & Sony & DDS-2,3,4 & -- & 4-40GB \\
+ \hline Linux & Tandberg & -- & Tandbert MLR3 & -- \\
+ \hline FreeBSD & Tandberg & -- & Tandberg SLR6 & -- \\
+ \hline Solaris & Tandberg & -- & Tandberg SLR75 & -- \\
+\end{longtable}
-%%
-%%
-
\chapter{Thanks}
\label{ThanksChapter}
\index[general]{Thanks }
release.
Thanks to Richard Stallman for starting the Free Software movement and for
-bringing us gcc and all the other GNU tools as well as the GPL license.
+bringing us gcc and all the other GNU tools as well as the GPL license.
-Thanks to Linus Torvalds for bringing us Linux.
+Thanks to Linus Torvalds for bringing us Linux.
Thanks to all the Free Software programmers. Without being able to peek at
your code, and in some cases, take parts of it, this project would have been
-much more difficult.
+much more difficult.
Thanks to John Walker for suggesting this project, giving it a name,
contributing software he has written, and for his programming efforts on
Bacula as well as having acted as a constant sounding board and source of
-ideas.
+ideas.
Thanks to the apcupsd project where I started my Free Software efforts, and
-from which I was able to borrow some ideas and code that I had written.
+from which I was able to borrow some ideas and code that I had written.
Special thanks to D. Scott Barninger for writing the bacula RPM spec file,
building all the RPM files and loading them onto Source Forge. This has been a
FreeBSD. His perseverance is truly remarkable. Thanks also for the many
contributions he has made to improve Bacula (pthreads patch for FreeBSD,
improved start/stop script and addition of Bacula userid and group, stunnel,
-...), his continuing support of Bacula users. He also wrote the PostgreSQL
-driver for Bacula and has been a big help in correcting the SQL.
+\ldots{}), his continuing support of Bacula users. He also wrote the PostgreSQL
+driver for Bacula and has been a big help in correcting the SQL.
Thanks to multiple other Bacula Packagers who make and release packages for
-different platforms for Bacula.
+different platforms for Bacula.
Thanks to Christopher Hull for developing the native Win32 Bacula emulation
-code and for contributing it to the Bacula project.
+code and for contributing it to the Bacula project.
Thanks to Robert Nelson for bringing our Win32 implementation up to par
with all the same features that exist in the Unix/Linux versions. In
to users.
Thanks to all the Bacula users, especially those of you who have contributed
-ideas, bug reports, patches, and new features.
+ideas, bug reports, patches, and new features.
Bacula can be enabled with data encryption and/or communications
encryption. If this is the case, you will be including OpenSSL code that
left out, please send me a reminder, and in any case, thanks for your
contribution.
-Thanks to the Free Software Foundation Europe e.V. for assuming the
+Thanks to the Free Software Foundation Europe e.V. for assuming the
responsibilities of protecting the Bacula copyright.
% TODO: remove this from the book?
the details of each, we don't try to list them here. However, we acknowledge
all such Copyrights and Trademarks, and if any copyright or trademark holder
wishes a specific acknowledgment, notify us, and we will be happy to add it
-where appropriate.
+where appropriate.
Bacula TLS (Transport Layer Security) is built-in network
encryption code to provide secure network transport similar to
-that offered by {\bf stunnel} or {\bf ssh}. The data written to
+that offered by {\bf stunnel} or {\bf ssh}. The data written to
Volumes by the Storage daemon is not encrypted by this code.
For data encryption, please see the \ilink{Data Encryption
Chapter}{DataEncryption} of this manual.
The Bacula encryption implementations were written by Landon Fuller.
-Supported features of this code include:
-\begin{itemize}
-\item Client/Server TLS Requirement Negotiation
+Supported features of this code include:
+\begin{bsysitemize}
+\item Client/Server TLS Requirement Negotiation
\item TLSv1 Connections with Server and Client Certificate
-Validation
-\item Forward Secrecy Support via Diffie-Hellman Ephemeral Keying
-\end{itemize}
+Validation
+\item Forward Secrecy Support via Diffie-Hellman Ephemeral Keying
+\end{bsysitemize}
This document will refer to both "server" and "client" contexts. These
terms refer to the accepting and initiating peer, respectively.
subject to known plaintext attacks, and it should be considered
considerably less secure than PKI certificate-based authentication.
-Appropriate autoconf macros have been added to detect and use OpenSSL
+Appropriate autoconf macros have been added to detect and use OpenSSL
if enabled on the {\bf ./configure} line with {\bf \verb?--?with-openssl}
\section{TLS Configuration Directives}
\begin{description}
\item [TLS Enable = \lt{}yes|no\gt{}]
Enable TLS support. If TLS is not enabled, none of the other TLS directives
-have any effect. In other words, even if you set {\bf TLS Require = yes}
+have any effect. In other words, even if you set {\bf TLS Require = yes}
you need to have TLS enabled or TLS will not be used.
\item [TLS Require = \lt{}yes|no\gt{}]
To generate the parameter file, you
may use openssl:
-\begin{verbatim}
- openssl dhparam -out dh1024.pem -5 1024
-\end{verbatim}
+\begin{lstlisting}
+ openssl dhparam -out dh1024.pem -5 1024
+\end{lstlisting}
\end{description}
valid for ten years can be made with the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
openssl req -new -x509 -nodes -out bacula.pem -keyout bacula.pem -days 3650
-\end{verbatim}
+\end{lstlisting}
\normalsize
The above script will ask you a number of questions. You may simply answer
PKI Book project at Source Forge: \elink{
http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}
{http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}.
-Note, this link may change.
+Note, this link may change.
-The program TinyCA has a very nice Graphical User Interface
+The program TinyCA has a very nice Graphical User Interface
that allows you to easily setup and maintain your own CA.
TinyCA can be found at
\elink{http://tinyca.sm-zone.net/}{http://tinyca.sm-zone.net/}.
or to become a CA yourself, and thus you can sign all your own certificates.
The book OpenSSL by John Viega, Matt Mesier \& Pravir Chandra from O'Reilly
explains how to do it, or you can read the documentation provided in the
-Open-source PKI Book project at Source Forge:
+Open-source PKI Book project at Source Forge:
\elink{
http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}
{http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}.
-Note, this link may change.
+Note, this link may change.
\section{Example TLS Configuration Files}
\index[general]{Example!TLS Configuration Files}
{\bf bacula-dir.conf}
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director { # define myself
Name = backup1-dir
...
Name = backup1-fd
Address = server1.example.com
...
-
+
TLS Enable = yes
TLS Require = yes
TLS CA Certificate File = /usr/local/etc/ssl/ca.pem
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
{\bf bacula-fd.conf}
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = backup1-dir
...
TLS Certificate = /usr/local/etc/ssl/server1/cert.pem
TLS Key = /usr/local/etc/ssl/server1/key.pem
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
{\bf bacula-sd.conf}
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Storage { # definition of myself
Name = backup1-sd
...
TLS Certificate = /usr/local/etc/ssl/backup1/cert.pem
TLS Key = /usr/local/etc/ssl/backup1/key.pem
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
directory, in addition, the data backed up will be the source directory where
you built Bacula. As a consequence, you can run all the Bacula daemons for
these tests as non-root. Please note, in production, your File daemon(s) must
-run as root. See the Security chapter for more information on this subject.
+run as root. See the Security chapter for more information on this subject.
% TODO: use crossreferences above
% TODO: add a section here
-The general flow of running Bacula is:
+The general flow of running Bacula is:
\begin{enumerate}
-\item cd \lt{}install-directory\gt{}
-\item Start the Database (if using MySQL or PostgreSQL)
-\item Start the Daemons with {\bf ./bacula start}
-\item Start the Console program to interact with the Director
-\item Run a job
+\item cd \lt{}install-directory\gt{}
+\item Start the Database (if using MySQL or PostgreSQL)
+\item Start the Daemons with {\bf ./bacula start}
+\item Start the Console program to interact with the Director
+\item Run a job
\item When the Volume fills, unmount the Volume, if it is a tape, label a new
one, and continue running. In this chapter, we will write only to disk files
- so you won't need to worry about tapes for the moment.
+ so you won't need to worry about tapes for the moment.
\item Test recovering some files from the Volume just written to ensure the
backup is good and that you know how to recover. Better test before disaster
- strikes
-\item Add a second client.
+ strikes
+\item Add a second client.
\end{enumerate}
-Each of these steps is described in more detail below.
+Each of these steps is described in more detail below.
\section{Before Running Bacula}
\index[general]{Bacula!Before Running }
% TODO: or quickstart. Consolidate!
Before running Bacula for the first time in production, we recommend that you
-run the {\bf test} command in the {\bf btape} program as described in the
-\ilink{Utility Program Chapter}{btape} of this manual. This will
+run the {\bf test} command in the {\bf btape} program as described in the
+\bsysxrlink{Utility Program}{btape}{utility}{chapter} of the \utilityman{}. This will
help ensure that Bacula functions correctly with your tape drive. If you have
a modern HP, Sony, or Quantum DDS or DLT tape drive running on Linux or
Solaris, you can probably skip this test as Bacula is well tested with these
run the test before continuing. {\bf btape} also has a {\bf fill} command that
attempts to duplicate what Bacula does when filling a tape and writing on the
next tape. You should consider trying this command as well, but be forewarned,
-it can take hours (about four hours on my drive) to fill a large capacity tape.
+it can take hours (about four hours on my drive) to fill a large capacity tape.
\section{Starting the Database}
\label{StartDB}
(Kern) use to start and stop my local MySQL. Note, if you are using SQLite,
you will not want to use {\bf startmysql} or {\bf stopmysql}. If you are
running this in production, you will probably want to find some way to
-automatically start MySQL or PostgreSQL after each system reboot.
+automatically start MySQL or PostgreSQL after each system reboot.
If you are using SQLite (i.e. you specified the {\bf \verb:--:with-sqlite=xxx} option
on the {\bf ./configure} command, you need do nothing. SQLite is automatically
-started by {\bf Bacula}.
+started by {\bf Bacula}.
\section{Starting the Daemons}
\label{StartDaemon}
\index[general]{Daemons!Starting the }
Assuming you have built from source or have installed the rpms,
-to start the three daemons, from your installation directory, simply enter:
+to start the three daemons, from your installation directory, simply enter:
-./bacula start
+./bacula start
The {\bf bacula} script starts the Storage daemon, the File daemon, and the
Director daemon, which all normally run as daemons in the background. If you
automatically started on reboot, or you can control them individually with the
files {\bf bacula-dir}, {\bf bacula-fd}, and {\bf bacula-sd}, which are
usually located in {\bf /etc/init.d}, though the actual location is system
-dependent.
+dependent.
Some distributions may do this differently.
Note, on Windows, currently only the File daemon is ported, and it must be
-started differently. Please see the
+started differently. Please see the
\ilink{Windows Version of Bacula}{Win32Chapter} Chapter of this
-manual.
+manual.
The rpm packages configure the daemons to run as user=root and group=bacula.
The rpm installation also creates the group bacula if it does not exist on the
system. Any users that you add to the group bacula will have access to files
created by the daemons. To disable or alter this behavior edit the daemon
-startup scripts:
+startup scripts:
-\begin{itemize}
-\item /etc/bacula/bacula
-\item /etc/init.d/bacula-dir
-\item /etc/init.d/bacula-sd
-\item /etc/init.d/bacula-fd
- \end{itemize}
+\begin{bsysitemize}
+\item /etc/bacula/bacula
+\item /etc/init.d/bacula-dir
+\item /etc/init.d/bacula-sd
+\item /etc/init.d/bacula-fd
+ \end{bsysitemize}
-and then restart as noted above.
+and then restart as noted above.
-The
+The
\ilink{installation chapter}{InstallChapter} of this manual
explains how you can install scripts that will automatically restart the
-daemons when the system starts.
+daemons when the system starts.
\section{Using the Director to Query and Start Jobs}
\index[general]{Jobs!Querying or Starting Jobs}
% TODO: section name is too long; maybe use "Using the Console Program" ??
To communicate with the director and to query the state of Bacula or run jobs,
-from the top level directory, simply enter:
+from the top level directory, simply enter:
-./bconsole
+./bconsole
Alternatively to running the command line console, if you have
Qt4 installed and used the {\bf \verb:--:enable-bat} on the configure command,
Which has a graphical interface, and many more features than bconsole.
-Two other possibilities are to run the GNOME console
+Two other possibilities are to run the GNOME console
{\bf bgnome-console} or the wxWidgets program {\bf bwx-console}.
For simplicity, here we will describe only the {\bf ./bconsole} program. Most
Director daemon. Since Bacula is a network program, you can run the Console
program anywhere on your network. Most frequently, however, one runs it on the
same machine as the Director. Normally, the Console program will print
-something similar to the following:
+something similar to the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
[kern@polymatou bin]$ ./bconsole
Connecting to Director lpmatou:9101
1000 OK: HeadMan Version: 2.1.8 (14 May 2007)
*
-\end{verbatim}
+\end{lstlisting}
\normalsize
-the asterisk is the console command prompt.
+the asterisk is the console command prompt.
-Type {\bf help} to see a list of available commands:
+Type {\bf help} to see a list of available commands:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
*help
Command Description
======= ===========
version print Director version
wait wait until no jobs are running [<jobname=name> | <jobid=nnn> | <ujobid=complete_name>]
*
-\end{verbatim}
+\end{lstlisting}
\normalsize
-Details of the console program's commands are explained in the
-\ilink{Console Chapter}{_ConsoleChapter} of this manual.
+Details of the console program's commands are explained in the
+\bsysxrlink{Console}{_ConsoleChapter}{console}{chapter} of the \consoleman{}.
\section{Running a Job}
\label{Running}
\index[general]{Job!Running a }
\index[general]{Running a Job }
-At this point, we assume you have done the following:
+At this point, we assume you have done the following:
-\begin{itemize}
-\item Configured Bacula with {\bf ./configure \verb:--:your-options}
-\item Built Bacula using {\bf make}
-\item Installed Bacula using {\bf make install}
+\begin{bsysitemize}
+\item Configured Bacula with {\bf ./configure \verb:--:your-options}
+\item Built Bacula using {\bf make}
+\item Installed Bacula using {\bf make install}
\item Have created your database with, for example, {\bf
- ./create\_sqlite\_database}
+ ./create\_sqlite\_database}
\item Have created the Bacula database tables with, {\bf
- ./make\_bacula\_tables}
+ ./make\_bacula\_tables}
\item Have possibly edited your {\bf bacula-dir.conf} file to personalize it
a bit. BE CAREFUL! if you change the Director's name or password, you will
need to make similar modifications in the other .conf files. For the moment
- it is probably better to make no changes.
-\item You have started Bacula with {\bf ./bacula start}
-\item You have invoked the Console program with {\bf ./bconsole}
-\end{itemize}
+ it is probably better to make no changes.
+\item You have started Bacula with {\bf ./bacula start}
+\item You have invoked the Console program with {\bf ./bconsole}
+\end{bsysitemize}
Furthermore, we assume for the moment you are using the default configuration
-files.
+files.
-At this point, enter the following command:
+At this point, enter the following command:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
show filesets
-\end{verbatim}
+\end{lstlisting}
\normalsize
-and you should get something similar to:
+and you should get something similar to:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
FileSet: name=Full Set
O M
N
N
I /home/kern/bacula/regress/working/bacula.sql
N
-\end{verbatim}
+\end{lstlisting}
\normalsize
This is a pre-defined {\bf FileSet} that will backup the Bacula source
to us for the moment. The {\bf I} entries are the files or directories that
will be included in the backup and the {\bf E} are those that will be
excluded, and the {\bf O} entries are the options specified for
-the FileSet. You can change what is backed up by editing {\bf bacula-dir.conf}
+the FileSet. You can change what is backed up by editing {\bf bacula-dir.conf}
and changing the {\bf File =} line in the {\bf FileSet} resource.
Now is the time to run your first backup job. We are going to backup your
Bacula source directory to a File Volume in your {\bf /tmp} directory just to
-show you how easy it is. Now enter:
+show you how easy it is. Now enter:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
status dir
-\end{verbatim}
+\end{lstlisting}
\normalsize
-and you should get the following output:
+and you should get the following output:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
rufus-dir Version: 1.30 (28 April 2003)
Daemon started 28-Apr-2003 14:03, 0 Jobs run.
Console connected at 28-Apr-2003 14:03
Incremental Backup 29-Apr-2003 01:05 Client1
Full Backup 29-Apr-2003 01:10 BackupCatalog
====
-\end{verbatim}
+\end{lstlisting}
\normalsize
where the times and the Director's name will be different according to your
run. Note, you should probably change the name {\bf Client1} to be the name of
your machine, if not, when you add additional clients, it will be very
confusing. For my real machine, I use {\bf Rufus} rather than {\bf Client1} as
-in this example.
+in this example.
-Now enter:
+Now enter:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
status client
-\end{verbatim}
+\end{lstlisting}
\normalsize
-and you should get something like:
+and you should get something like:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
The defined Client resources are:
1: rufus-fd
Item 1 selected automatically.
Director connected at: 28-Apr-2003 14:14
No jobs running.
====
-\end{verbatim}
+\end{lstlisting}
\normalsize
In this case, the client is named {\bf rufus-fd} your name will be different,
but the line beginning with {\bf rufus-fd Version ...} is printed by your File
-daemon, so we are now sure it is up and running.
+daemon, so we are now sure it is up and running.
-Finally do the same for your Storage daemon with:
+Finally do the same for your Storage daemon with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
status storage
-\end{verbatim}
+\end{lstlisting}
\normalsize
-and you should get:
+and you should get:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
The defined Storage resources are:
1: File
Item 1 selected automatically.
Device /tmp is not open.
No jobs running.
====
-\end{verbatim}
+\end{lstlisting}
\normalsize
You will notice that the default Storage daemon device is named {\bf File} and
-that it will use device {\bf /tmp}, which is not currently open.
+that it will use device {\bf /tmp}, which is not currently open.
-Now, let's actually run a job with:
+Now, let's actually run a job with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
run
-\end{verbatim}
+\end{lstlisting}
\normalsize
-you should get the following output:
+you should get the following output:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Using default Catalog name=MyCatalog DB=bacula
A job name must be specified.
The defined Job resources are:
2: BackupCatalog
3: RestoreFiles
Select Job resource (1-3):
-\end{verbatim}
+\end{lstlisting}
\normalsize
Here, Bacula has listed the three different Jobs that you can run, and you
-should choose number {\bf 1} and type enter, at which point you will get:
+should choose number {\bf 1} and type enter, at which point you will get:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Run Backup job
JobName: Client1
FileSet: Full Set
Pool: Default
When: 2003-04-28 14:18:57
OK to run? (yes/mod/no):
-\end{verbatim}
+\end{lstlisting}
\normalsize
At this point, take some time to look carefully at what is printed and
with FileSet {\bf Full Set} (we listed above) as an Incremental job on your
Client (your client name will be different), and to use Storage {\bf File} and
Pool {\bf Default}, and finally, it wants to run it now (the current time
-should be displayed by your console).
+should be displayed by your console).
Here we have the choice to run ({\bf yes}), to modify one or more of the above
parameters ({\bf mod}), or to not run the job ({\bf no}). Please enter {\bf
yes}, at which point you should immediately get the command prompt (an
asterisk). If you wait a few seconds, then enter the command {\bf messages}
-you will get back something like:
+you will get back something like:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
28-Apr-2003 14:22 rufus-dir: Last FULL backup time not found. Doing
FULL backup.
28-Apr-2003 14:22 rufus-dir: Start Backup JobId 1,
Storage: FileStorage
Media type: File
Pool: Default
-\end{verbatim}
+\end{lstlisting}
\normalsize
The first message, indicates that no previous Full backup was done, so Bacula
message indicates that the job started with JobId 1., and the third message
tells us that Bacula cannot find any Volumes in the Pool for writing the
output. This is normal because we have not yet created (labeled) any Volumes.
-Bacula indicates to you all the details of the volume it needs.
+Bacula indicates to you all the details of the volume it needs.
At this point, the job is BLOCKED waiting for a Volume. You can check this if
you want by doing a {\bf status dir}. In order to continue, we must create a
-Volume that Bacula can write on. We do so with:
+Volume that Bacula can write on. We do so with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
label
-\end{verbatim}
+\end{lstlisting}
\normalsize
-and Bacula will print:
+and Bacula will print:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
The defined Storage resources are:
1: File
Item 1 selected automatically.
Enter new Volume name:
-\end{verbatim}
+\end{lstlisting}
\normalsize
at which point, you should enter some name beginning with a letter and
containing only letters and numbers (period, hyphen, and underscore) are also
-permitted. For example, enter {\bf TestVolume001}, and you should get back:
+permitted. For example, enter {\bf TestVolume001}, and you should get back:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Defined Pools:
1: Default
Item 1 selected automatically.
Catalog record for Volume "TestVolume002", Slot 0 successfully created.
Requesting mount FileStorage ...
3001 OK mount. Device=/tmp
-\end{verbatim}
+\end{lstlisting}
\normalsize
-Finally, enter {\bf messages} and you should get something like:
+Finally, enter {\bf messages} and you should get something like:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
28-Apr-2003 14:30 rufus-sd: Wrote label to prelabeled Volume
"TestVolume001" on device /tmp
28-Apr-2003 14:30 rufus-dir: Bacula 1.30 (28Apr03): 28-Apr-2003 14:30
28-Apr-2003 14:30 rufus-dir: Begin pruning Files.
28-Apr-2003 14:30 rufus-dir: No Files found to prune.
28-Apr-2003 14:30 rufus-dir: End auto prune.
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you don't see the output immediately, you can keep entering {\bf messages}
until the job terminates, or you can enter, {\bf autodisplay on} and your
-messages will automatically be displayed as soon as they are ready.
+messages will automatically be displayed as soon as they are ready.
If you do an {\bf ls -l} of your {\bf /tmp} directory, you will see that you
-have the following item:
+have the following item:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
-rw-r----- 1 kern kern 39072153 Apr 28 14:30 TestVolume001
-\end{verbatim}
+\end{lstlisting}
\normalsize
This is the file Volume that you just wrote and it contains all the data of
the job just run. If you run additional jobs, they will be appended to this
-Volume unless you specify otherwise.
+Volume unless you specify otherwise.
You might ask yourself if you have to label all the Volumes that Bacula is
going to use. The answer for disk Volumes, like the one we used, is no. It is
possible to have Bacula automatically label volumes. For tape Volumes, you
-will most likely have to label each of the Volumes you want to use.
+will most likely have to label each of the Volumes you want to use.
If you would like to stop here, you can simply enter {\bf quit} in the Console
program, and you can stop Bacula with {\bf ./bacula stop}. To clean up, simply
delete the file {\bf /tmp/TestVolume001}, and you should also re-initialize
-your database using:
+your database using:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
./drop_bacula_tables
./make_bacula_tables
-\end{verbatim}
+\end{lstlisting}
\normalsize
Please note that this will erase all information about the previous jobs that
have run, and that you might want to do it now while testing but that normally
-you will not want to re-initialize your database.
+you will not want to re-initialize your database.
If you would like to try restoring the files that you just backed up, read the
-following section.
+following section.
\label{restoring}
\section{Restoring Your Files}
If you have run the default configuration and the save of the Bacula source
code as demonstrated above, you can restore the backed up files in the Console
-program by entering:
+program by entering:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
restore all
-\end{verbatim}
+\end{lstlisting}
\normalsize
-where you will get:
+where you will get:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
First you select one or more JobIds that contain files
to be restored. You will be presented several methods
of specifying the JobIds. Then you will be allowed to
10: Find the JobIds for a backup for a client before a specified time
11: Enter a list of directories to restore for found JobIds
12: Cancel
-Select item: (1-12):
-\end{verbatim}
+Select item: (1-12):
+\end{lstlisting}
\normalsize
As you can see, there are a number of options, but for the current
demonstration, please enter {\bf 5} to do a restore of the last backup you
-did, and you will get the following output:
+did, and you will get the following output:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Defined Clients:
1: rufus-fd
Item 1 selected automatically.
Enter "done" to leave this mode.
cwd is: /
$
-\end{verbatim}
+\end{lstlisting}
\normalsize
where I have truncated the listing on the right side to make it more readable.
and view what files will be restored. For example, if I enter {\bf cd
/home/kern/bacula/bacula-1.30} and then enter {\bf dir} I will get a listing
of all the files in the Bacula source directory. On your system, the path will
-be somewhat different. For more information on this, please refer to the
+be somewhat different. For more information on this, please refer to the
\ilink{Restore Command Chapter}{RestoreChapter} of this manual for
-more details.
+more details.
-To exit this mode, simply enter:
+To exit this mode, simply enter:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
done
-\end{verbatim}
+\end{lstlisting}
\normalsize
-and you will get the following output:
+and you will get the following output:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Bootstrap records written to
/home/kern/bacula/testbin/working/restore.bsr
The restore job will require the following Volumes:
-
+
TestVolume001
1444 files selected to restore.
Run Restore job
JobId: *None*
When: 2005-04-28 14:53:54
OK to run? (yes/mod/no):
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you answer {\bf yes} your files will be restored to {\bf
to nothing (or to /). We recommend you go ahead and answer {\bf yes} and after
a brief moment, enter {\bf messages}, at which point you should get a listing
of all the files that were restored as well as a summary of the job that looks
-similar to this:
+similar to this:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
28-Apr-2005 14:56 rufus-dir: Bacula 2.1.8 (08May07): 08-May-2007 14:56:06
Build OS: i686-pc-linux-gnu suse 10.2
JobId: 2
08-May-2007 14:56 rufus-dir: Begin pruning Files.
08-May-2007 14:56 rufus-dir: No Files found to prune.
08-May-2007 14:56 rufus-dir: End auto prune.
-\end{verbatim}
+\end{lstlisting}
\normalsize
After exiting the Console program, you can examine the files in {\bf
/tmp/bacula-restores}, which will contain a small directory tree with all the
-files. Be sure to clean up at the end with:
+files. Be sure to clean up at the end with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
rm -rf /tmp/bacula-restore
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{Quitting the Console Program}
\index[general]{Program!Quitting the Console }
\index[general]{Quitting the Console Program }
-Simply enter the command {\bf quit}.
+Simply enter the command {\bf quit}.
\label{SecondClient}
\section{Adding a Second Client}
modification to it to create the conf file for your second client. Change the
File daemon name from whatever was configured, {\bf rufus-fd} in the example
above, but your system will have a different name. The best is to change it to
-the name of your second machine. For example:
+the name of your second machine. For example:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
...
#
# "Global" File daemon configuration specifications
Pid Directory = /var/run
}
...
-\end{verbatim}
+\end{lstlisting}
\normalsize
-would become:
+would become:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
...
#
# "Global" File daemon configuration specifications
Pid Directory = /var/run
}
...
-\end{verbatim}
+\end{lstlisting}
\normalsize
where I show just a portion of the file and have changed {\bf rufus-fd} to
{\bf matou-fd}. The names you use are your choice. For the moment, I recommend
-you change nothing else. Later, you will want to change the password.
+you change nothing else. Later, you will want to change the password.
Now you should install that change on your second machine. Then you need to
make some additions to your Director's configuration file to define the new
File daemon or Client. Starting from our original example which should be
installed on your system, you should add the following lines (essentially
copies of the existing data but with the names changed) to your Director's
-configuration file {\bf bacula-dir.conf}.
+configuration file {\bf bacula-dir.conf}.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# Define the main nightly save backup job
# By default, this job will back up to disk in /tmp
Job Retention = 180d # six months
AutoPrune = yes # Prune expired Jobs/Files
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Then make sure that the Address parameter in the Storage resource is set to
address specified is sent to the File daemon (client) and it must be a fully
qualified domain name. If you pass something like "localhost" it will not
resolve correctly and will result in a time out when the File daemon fails to
-connect to the Storage daemon.
+connect to the Storage daemon.
That is all that is necessary. I copied the existing resource to create a
second Job (Matou) to backup the second client (matou-fd). It has the name
{\bf Matou}, the Client is named {\bf matou-fd}, and the bootstrap file name
is changed, but everything else is the same. This means that Matou will be
backed up on the same schedule using the same set of tapes. You may want to
-change that later, but for now, let's keep it simple.
+change that later, but for now, let's keep it simple.
The second change was to add a new Client resource that defines {\bf matou-fd}
and has the correct address {\bf matou}, but in real life, you may need a
fully qualified domain name or an IP address. I also kept the password the
-same (shown as xxxxx for the example).
+same (shown as xxxxx for the example).
At this point, if you stop Bacula and restart it, and start the Client on the
other machine, everything will be ready, and the prompts that you saw above
-will now include the second machine.
+will now include the second machine.
To make this a real production installation, you will possibly want to use
different Pool, or a different schedule. It is up to you to customize. In any
case, you should change the password in both the Director's file and the
-Client's file for additional security.
+Client's file for additional security.
For some important tips on changing names and passwords, and a diagram of what
-names and passwords must match, please see
-\ilink{Authorization Errors}{AuthorizationErrors} in the FAQ chapter
-of this manual.
+names and passwords must match, please see
+\bsysxrlink{Authorization Errors}{AuthorizationErrors}{problems}{chapter} in the \problemsman{}.
\section{When The Tape Fills}
\label{FullTape}
If you have scheduled your job, typically nightly, there will come a time when
the tape fills up and {\bf Bacula} cannot continue. In this case, Bacula will
-send you a message similar to the following:
+send you a message similar to the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
rufus-sd: block.c:337 === Write error errno=28: ERR=No space left
on device
-\end{verbatim}
+\end{lstlisting}
\normalsize
This indicates that Bacula got a write error because the tape is full. Bacula
volume. In the best of all cases, you will have properly set your Retention
Periods and you will have all your tapes marked to be Recycled, and {\bf
Bacula} will automatically recycle the tapes in your pool requesting and
-overwriting old Volumes. For more information on recycling, please see the
+overwriting old Volumes. For more information on recycling, please see the
\ilink{Recycling chapter}{RecyclingChapter} of this manual. If you
find that your Volumes were not properly recycled (usually because of a
-configuration error), please see the
+configuration error), please see the
\ilink{Manually Recycling Volumes}{manualrecycling} section of
-the Recycling chapter.
+the Recycling chapter.
If like me, you have a very large set of Volumes and you label them with the
date the Volume was first writing, or you have not set up your Retention
periods, Bacula will not find a tape in the pool, and it will send you a
-message similar to the following:
+message similar to the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
rufus-sd: Job kernsave.2002-09-19.10:50:48 waiting. Cannot find any
appendable volumes.
Please use the "label" command to create a new Volume for:
Storage: SDT-10000
Media type: DDS-4
Pool: Default
-\end{verbatim}
+\end{lstlisting}
\normalsize
Until you create a new Volume, this message will be repeated an hour later,
then two hours later, and so on doubling the interval each time up to a
-maximum interval of one day.
+maximum interval of one day.
-The obvious question at this point is: What do I do now?
+The obvious question at this point is: What do I do now?
The answer is simple: first, using the Console program, close the tape drive
using the {\bf unmount} command. If you only have a single drive, it will be
automatically selected, otherwise, make sure you release the one specified on
-the message (in this case {\bf STD-10000}).
+the message (in this case {\bf STD-10000}).
Next, you remove the tape from the drive and insert a new blank tape. Note, on
some older tape drives, you may need to write an end of file mark ({\bf mt \
-f \ /dev/nst0 \ weof}) to prevent the drive from running away when Bacula
-attempts to read the label.
+attempts to read the label.
Finally, you use the {\bf label} command in the Console to write a label to
the new Volume. The {\bf label} command will contact the Storage daemon to
write the software label, if it is successful, it will add the new Volume to
the Pool, then issue a {\bf mount} command to the Storage daemon. See the
-previous sections of this chapter for more details on labeling tapes.
+previous sections of this chapter for more details on labeling tapes.
The result is that Bacula will continue the previous Job writing the backup to
-the new Volume.
+the new Volume.
If you have a Pool of volumes and Bacula is cycling through them, instead of
the above message "Cannot find any appendable volumes.", Bacula may ask you
can simply mount another volume from the same Pool, providing it is
appendable, and Bacula will use it. You can use the {\bf list volumes} command
in the console program to determine which volumes are appendable and which are
-not.
+not.
If like me, you have your Volume retention periods set correctly, but you have
-no more free Volumes, you can relabel and reuse a Volume as follows:
+no more free Volumes, you can relabel and reuse a Volume as follows:
-\begin{itemize}
+\begin{bsysitemize}
\item Do a {\bf list volumes} in the Console and select the oldest Volume for
- relabeling.
+ relabeling.
\item If you have setup your Retention periods correctly, the Volume should
- have VolStatus {\bf Purged}.
+ have VolStatus {\bf Purged}.
\item If the VolStatus is not set to Purged, you will need to purge the
database of Jobs that are written on that Volume. Do so by using the command
{\bf purge jobs volume} in the Console. If you have multiple Pools, you will
be prompted for the Pool then enter the VolumeName (or MediaId) when
-requested.
-\item Then simply use the {\bf relabel} command to relabel the Volume.
- \end{itemize}
+requested.
+\item Then simply use the {\bf relabel} command to relabel the Volume.
+ \end{bsysitemize}
-To manually relabel the Volume use the following additional steps:
+To manually relabel the Volume use the following additional steps:
-\begin{itemize}
-\item To delete the Volume from the catalog use the {\bf delete volume}
- command in the Console and select the VolumeName (or MediaId) to be deleted.
+\begin{bsysitemize}
+\item To delete the Volume from the catalog use the {\bf delete volume}
+ command in the Console and select the VolumeName (or MediaId) to be deleted.
-\item Use the {\bf unmount} command in the Console to unmount the old tape.
+\item Use the {\bf unmount} command in the Console to unmount the old tape.
\item Physically relabel the old Volume that you deleted so that it can be
- reused.
-\item Insert the old Volume in the tape drive.
+ reused.
+\item Insert the old Volume in the tape drive.
\item From a command line do: {\bf mt \ -f \ /dev/st0 \ rewind} and {\bf mt \
-f \ /dev/st0 \ weof}, where you need to use the proper tape drive name for
- your system in place of {\bf /dev/st0}.
+ your system in place of {\bf /dev/st0}.
\item Use the {\bf label} command in the Console to write a new Bacula label
- on your tape.
-\item Use the {\bf mount} command in the Console if it is not automatically
- done, so that Bacula starts using your newly labeled tape.
- \end{itemize}
+ on your tape.
+\item Use the {\bf mount} command in the Console if it is not automatically
+ done, so that Bacula starts using your newly labeled tape.
+ \end{bsysitemize}
\section{Other Useful Console Commands}
\index[general]{Commands!Other Useful Console }
\item [status dir]
\index[console]{status dir }
- Print a status of all running jobs and jobs scheduled in the next 24 hours.
+ Print a status of all running jobs and jobs scheduled in the next 24 hours.
\item [status]
\index[console]{status }
The console program will prompt you to select a daemon type, then will
-request the daemon's status.
+request the daemon's status.
\item [status jobid=nn]
\index[console]{status jobid }
Print a status of JobId nn if it is running. The Storage daemon is contacted
-and requested to print a current status of the job as well.
+and requested to print a current status of the job as well.
\item [list pools]
\index[console]{list pools }
- List the pools defined in the Catalog (normally only Default is used).
+ List the pools defined in the Catalog (normally only Default is used).
\item [list media]
\index[console]{list media }
- Lists all the media defined in the Catalog.
+ Lists all the media defined in the Catalog.
\item [list jobs]
\index[console]{list jobs }
- Lists all jobs in the Catalog that have run.
+ Lists all jobs in the Catalog that have run.
\item [list jobid=nn]
\index[console]{list jobid }
- Lists JobId nn from the Catalog.
+ Lists JobId nn from the Catalog.
\item [list jobtotals]
\index[console]{list jobtotals }
- Lists totals for all jobs in the Catalog.
+ Lists totals for all jobs in the Catalog.
\item [list files jobid=nn]
\index[console]{list files jobid }
- List the files that were saved for JobId nn.
+ List the files that were saved for JobId nn.
\item [list jobmedia]
\index[console]{list jobmedia }
- List the media information for each Job run.
+ List the media information for each Job run.
\item [messages]
\index[console]{messages }
- Prints any messages that have been directed to the console.
+ Prints any messages that have been directed to the console.
\item [unmount storage=storage-name]
\index[console]{unmount storage }
Unmounts the drive associated with the storage device with the name {\bf
storage-name} if the drive is not currently being used. This command is used
-if you wish Bacula to free the drive so that you can use it to label a tape.
+if you wish Bacula to free the drive so that you can use it to label a tape.
\item [mount storage=storage-name]
Bacula reaches the end of a volume and requests you to mount a new volume,
you must issue this command after you have placed the new volume in the
drive. In effect, it is the signal needed by Bacula to know to start reading
-or writing the new volume.
+or writing the new volume.
\item [quit]
\index[sd]{quit }
- Exit or quit the console program.
+ Exit or quit the console program.
\end{description}
Most of the commands given above, with the exception of {\bf list}, will
-prompt you for the necessary arguments if you simply enter the command name.
+prompt you for the necessary arguments if you simply enter the command name.
\section{Debug Daemon Output}
\index[general]{Debug Daemon Output }
\index[general]{Output!Debug Daemon }
If you want debug output from the daemons as they are running, start the
-daemons from the install directory as follows:
+daemons from the install directory as follows:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
./bacula start -d100
-\end{verbatim}
+\end{lstlisting}
\normalsize
This can be particularly helpful if your daemons do not start correctly,
NULL device, but with the debug level greater than zero, the output
will be sent to the starting terminal.
-To stop the three daemons, enter the following from the install directory:
+To stop the three daemons, enter the following from the install directory:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
./bacula stop
-\end{verbatim}
+\end{lstlisting}
\normalsize
The execution of {\bf bacula stop} may complain about pids not found. This is
-OK, especially if one of the daemons has died, which is very rare.
+OK, especially if one of the daemons has died, which is very rare.
To do a full system save, each File daemon must be running as root so that it
will have permission to access all the files. None of the other daemons
tape drives. On many systems, only root can access the tape drives. Either run
the Storage daemon as root, or change the permissions on the tape devices to
permit non-root access. MySQL and PostgreSQL can be installed and run with any
-userid; root privilege is not necessary.
+userid; root privilege is not necessary.
\section{Patience When Starting Daemons or Mounting Blank Tapes}
used, it will be rewound, and on some devices this can take several minutes.
As a consequence, you may need to have a bit of patience when first contacting
the Storage daemon after starting the daemons. If you can see your tape drive,
-once the lights stop flashing, the drive will be ready to be used.
+once the lights stop flashing, the drive will be ready to be used.
The same considerations apply if you have just mounted a blank tape in a drive
such as an HP DLT. It can take a minute or two before the drive properly
the Console program during this recognition period, it is quite possible that
you will hang your SCSI driver (at least on my Red Hat Linux system). As a
consequence, you are again urged to have patience when inserting blank tapes.
-Let the device settle down before attempting to access it.
+Let the device settle down before attempting to access it.
\section{Difficulties Connecting from the FD to the SD}
\index[general]{Difficulties Connecting from the FD to the SD}
localhost}. An example that may work: {\bf megalon}. An example that is more
likely to work: {\bf magalon.mydomain.com}. On Win32 if you don't have a good
resolver (often true on older Win98 systems), you might try using an IP
-address in place of a name.
+address in place of a name.
If your address is correct, then make sure that no other program is using the
port 9103 on the Storage daemon's machine. The Bacula port numbers are
authorized by IANA, and should not be used by other programs, but apparently
some HP printers do use these port numbers. A {\bf netstat -a} on the Storage
daemon's machine can determine who is using the 9103 port (used for FD to SD
-communications in Bacula).
+communications in Bacula).
\section{Daemon Command Line Options}
\index[general]{Daemon Command Line Options }
Each of the three daemons (Director, File, Storage) accepts a small set of
options on the command line. In general, each of the daemons as well as the
-Console program accepts the following options:
+Console program accepts the following options:
\begin{description}
\item [-c \lt{}file\gt{}]
\index[sd]{-c \lt{}file\gt{} }
Define the file to use as a configuration file. The default is the daemon
- name followed by {\bf .conf} i.e. {\bf bacula-dir.conf} for the Director,
+ name followed by {\bf .conf} i.e. {\bf bacula-dir.conf} for the Director,
{\bf bacula-fd.conf} for the File daemon, and {\bf bacula-sd} for the Storage
- daemon.
+ daemon.
\item [-d nn]
\index[sd]{-d nn }
Set the debug level to {\bf nn}. Higher levels of debug cause more
- information to be displayed on STDOUT concerning what the daemon is doing.
+ information to be displayed on STDOUT concerning what the daemon is doing.
\item [-f]
Run the daemon in the foreground. This option is needed to run the daemon
- under the debugger.
+ under the debugger.
\item [-g <group>]
Run the daemon under this group. This must be a group name, not a GID.
\item [-s]
Do not trap signals. This option is needed to run the daemon under the
- debugger.
+ debugger.
\item [-t]
Read the configuration file and print any error messages, then immediately
- exit. Useful for syntax testing of new configuration files.
+ exit. Useful for syntax testing of new configuration files.
\item [-u <user>]
Run the daemon as this user. This must be a user name, not a UID.
\item [-v]
Be more verbose or more complete in printing error and informational
- messages. Recommended.
+ messages. Recommended.
\item [-?]
- Print the version and list of options.
+ Print the version and list of options.
\end{description}
\index[general]{Creating a Pool }
Creating the Pool is automatically done when {\bf Bacula} starts, so if you
-understand Pools, you can skip to the next section.
+understand Pools, you can skip to the next section.
When you run a job, one of the things that Bacula must know is what Volumes to
use to backup the FileSet. Instead of specifying a Volume (tape) directly, you
next volume and so on. If no appendable Volume exists in the Pool, the
Director will attempt to recycle an old Volume, if there are still no
appendable Volumes available, {\bf Bacula} will send a message requesting the
-operator to create an appropriate Volume.
+operator to create an appropriate Volume.
{\bf Bacula} keeps track of the Pool name, the volumes contained in the Pool,
-and a number of attributes of each of those Volumes.
+and a number of attributes of each of those Volumes.
When Bacula starts, it ensures that all Pool resource definitions have been
-recorded in the catalog. You can verify this by entering:
+recorded in the catalog. You can verify this by entering:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
list pools
-\end{verbatim}
+\end{lstlisting}
\normalsize
-to the console program, which should print something like the following:
+to the console program, which should print something like the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
*list pools
Using default Catalog name=MySQL DB=bacula
+--------+---------+---------+---------+----------+-------------+
| 2 | File | 12 | 12 | Backup | File |
+--------+---------+---------+---------+----------+-------------+
*
-\end{verbatim}
+\end{lstlisting}
\normalsize
If you attempt to create the same Pool name a second time, {\bf Bacula} will
-print:
+print:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Error: Pool Default already exists.
Once created, you may use the {\bf update} command to
modify many of the values in the Pool record.
-\end{verbatim}
+\end{lstlisting}
\normalsize
\label{Labeling}
command in the Console program to label a new Volume and to define it in the
Pool database, after which Bacula will begin writing on the new Volume.
Alternatively, I can use the Console {\bf relabel} command to relabel a Volume
-that is no longer used providing it has VolStatus {\bf Purged}.
+that is no longer used providing it has VolStatus {\bf Purged}.
Another strategy is to label a set of volumes at the start, then use them as
{\bf Bacula} requests them. This is most often done if you are cycling through
a set of tapes, for example using an autochanger. For more details on
-recycling, please see the
+recycling, please see the
\ilink{Automatic Volume Recycling}{RecyclingChapter} chapter of
-this manual.
+this manual.
If you run a Bacula job, and you have no labeled tapes in the Pool, Bacula
will inform you, and you can create them "on-the-fly" so to speak. In my
case, I label my tapes with the date, for example: {\bf DLT-18April02}. See
-below for the details of using the {\bf label} command.
+below for the details of using the {\bf label} command.
\section{Labeling Volumes with the Console Program}
\index[general]{Labeling Volumes with the Console Program }
\index[general]{Program!Labeling Volumes with the Console }
-Labeling volumes is normally done by using the console program.
+Labeling volumes is normally done by using the console program.
\begin{enumerate}
-\item ./bconsole
-\item label
+\item ./bconsole
+\item label
\end{enumerate}
If Bacula complains that you cannot label the tape because it is already
labeled, simply {\bf unmount} the tape using the {\bf unmount} command in the
console, then physically mount a blank tape and re-issue the {\bf label}
-command.
+command.
Since the physical storage media is different for each device, the {\bf label}
command will provide you with a list of the defined Storage resources such as
-the following:
+the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
The defined Storage resources are:
1: File
2: 8mmDrive
3: DLTDrive
4: SDT-10000
Select Storage resource (1-4):
-\end{verbatim}
+\end{lstlisting}
\normalsize
At this point, you should have a blank tape in the drive corresponding to the
-Storage resource that you select.
+Storage resource that you select.
-It will then ask you for the Volume name.
+It will then ask you for the Volume name.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Enter new Volume name:
-\end{verbatim}
+\end{lstlisting}
\normalsize
-If Bacula complains:
+If Bacula complains:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Media record for Volume xxxx already exists.
-\end{verbatim}
+\end{lstlisting}
\normalsize
It means that the volume name {\bf xxxx} that you entered already exists in
the Media database. You can list all the defined Media (Volumes) with the {\bf
list media} command. Note, the LastWritten column has been truncated for
-proper printing.
+proper printing.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
+---------------+---------+--------+----------------+-----/~/-+------------+-----+
| VolumeName | MediaTyp| VolStat| VolBytes | LastWri | VolReten | Recy|
+---------------+---------+--------+----------------+---------+------------+-----+
| DLT-04May2002 | DLT8000 | Full | 60,486,677,724 | 2002-05 | 31,536,000 | 0 |
| DLT-26May02 | DLT8000 | Append | 1,336,699,620 | 2002-05 | 31,536,000 | 1 |
+---------------+---------+--------+----------------+-----/~/-+------------+-----+
-\end{verbatim}
+\end{lstlisting}
\normalsize
Once Bacula has verified that the volume does not already exist, it will
If the tape is successfully labeled, a Volume record will also be created in
the Pool. That is the Volume name and all its other attributes will appear
when you list the Pool. In addition, that Volume will be available for backup
-if the MediaType matches what is requested by the Storage daemon.
+if the MediaType matches what is requested by the Storage daemon.
When you labeled the tape, you answered very few questions about it --
principally the Volume name, and perhaps the Slot. However, a Volume record in
the catalog database (internally known as a Media record) contains quite a few
attributes. Most of these attributes will be filled in from the default values
that were defined in the Pool (i.e. the Pool holds most of the default
-attributes used when creating a Volume).
+attributes used when creating a Volume).
It is also possible to add media to the pool without physically labeling the
Volumes. This can be done with the {\bf add} command. For more information,
-please see the
-\ilink{Console Chapter}{_ConsoleChapter} of this manual.
+please see the
+\bsysxrlink{Console}{_ConsoleChapter}{console}{chapter} of the \consoleman{}.
or MD5 signatures, it can be an ideal tool for improving computer security.
This is done by making a snapshot of your system files with a {\bf Verify} Job
and then checking the current state of your system against the snapshot, on a
-regular basis (e.g. nightly).
+regular basis (e.g. nightly).
-The first step is to set up a {\bf Verify} Job and to run it with:
+The first step is to set up a {\bf Verify} Job and to run it with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Level = InitCatalog
-\end{verbatim}
+\end{lstlisting}
\normalsize
The {\bf InitCatalog} level tells {\bf Bacula} simply to get the information on
the specified files and to put it into the catalog. That is your database is
initialized and no comparison is done. The {\bf InitCatalog} is normally run
-one time manually.
+one time manually.
-Thereafter, you will run a Verify Job on a daily (or whatever) basis with:
+Thereafter, you will run a Verify Job on a daily (or whatever) basis with:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Level = Catalog
-\end{verbatim}
+\end{lstlisting}
\normalsize
The {\bf Level = Catalog} level tells Bacula to compare the current state of
the files on the Client to the last {\bf InitCatalog} that is stored in the
catalog and to report any differences. See the example below for the format of
-the output.
+the output.
You decide what files you want to form your "snapshot" by specifying them in
a {\bf FileSet} resource, and normally, they will be system files that do not
-change, or that only certain features change.
+change, or that only certain features change.
Then you decide what attributes of each file you want compared by specifying
comparison options on the {\bf Include} statements that you use in the {\bf
-FileSet} resource of your {\bf Catalog} Jobs.
+FileSet} resource of your {\bf Catalog} Jobs.
\section{The Details}
\index[general]{Details }
In the discussion that follows, we will make reference to the Verify
Configuration Example that is included below in the {\bf A Verify
Configuration Example} section. You might want to look it over now to get an
-idea of what it does.
+idea of what it does.
The main elements consist of adding a schedule, which will normally be run
daily, or perhaps more often. This is provided by the {\bf VerifyCycle}
-Schedule, which runs at 5:05 in the morning every day.
+Schedule, which runs at 5:05 in the morning every day.
Then you must define a Job, much as is done below. We recommend that the Job
name contain the name of your machine as well as the word {\bf Verify} or {\bf
Check}. In our example, we named it {\bf MatouVerify}. This will permit you to
-easily identify your job when running it from the Console.
+easily identify your job when running it from the Console.
You will notice that most records of the Job are quite standard, but that the
{\bf FileSet} resource contains {\bf verify=pins1} option in addition to the
signature=SHA1} and none will be computed nor stored in the catalog. Or
alternatively, you can use {\bf verify=pins5} and {\bf signature=MD5}, which
will use the MD5 hash algorithm. The MD5 hash computes faster than SHA1, but
-is cryptographically less secure.
+is cryptographically less secure.
The {\bf verify=pins1} is ignored during the {\bf InitCatalog} Job, but is
used during the subsequent {\bf Catalog} Jobs to specify what attributes of
the files should be compared to those found in the catalog. {\bf pins1} is a
reasonable set to begin with, but you may want to look at the details of these
-and other options. They can be found in the
+and other options. They can be found in the
\ilink{FileSet Resource}{FileSetResource} section of this manual.
Briefly, however, the {\bf p} of the {\bf pins1} tells Verify to compare the
permissions bits, the {\bf i} is to compare inodes, the {\bf n} causes
comparison of the number of links, the {\bf s} compares the file size, and the
{\bf 1} compares the SHA1 checksums (this requires the {\bf signature=SHA1}
-option to have been set also).
+option to have been set also).
You must also specify the {\bf Client} and the {\bf Catalog} resources for
your Verify job, but you probably already have them created for your client
and do not need to recreate them, they are included in the example below for
-completeness.
+completeness.
As mentioned above, you will need to have a {\bf FileSet} resource for the
Verify job, which will have the additional {\bf verify=pins1} option. You will
Red Hat 7.3 system. Since I didn't spend a lot of time working on it, it
probably is missing a few important files (if you find one, please send it to
me). On the other hand, as long as I don't load any new packages, none of
-these files change during normal operation of the system.
+these files change during normal operation of the system.
\section{Running the Verify}
\index[general]{Running the Verify }
Verify Job. This will initialize the catalog to contain the file information
that will later be used as a basis for comparisons with the actual file
system, thus allowing you to detect any changes (and possible intrusions into
-your system).
+your system).
The easiest way to run the {\bf InitCatalog} is manually with the console
program by simply entering {\bf run}. You will be presented with a list of
Jobs that can be run, and you will choose the one that corresponds to your
-Verify Job, {\bf MatouVerify} in this example.
+Verify Job, {\bf MatouVerify} in this example.
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
The defined Job resources are:
1: MatouVerify
2: kernsrestore
3: Filetest
4: kernsave
Select Job resource (1-4): 1
-\end{verbatim}
+\end{lstlisting}
\normalsize
Next, the console program will show you the basic parameters of the Job and
-ask you:
+ask you:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Run Verify job
JobName: MatouVerify
FileSet: Verify Set
Level: Catalog
Client: MatouVerify
Storage: DLTDrive
-Verify Job:
+Verify Job:
Verify List: /tmp/regress/working/MatouVerify.bsr
OK to run? (yes/mod/no): mod
-\end{verbatim}
+\end{lstlisting}
\normalsize
Here, you want to respond {\bf mod} to modify the parameters because the Level
is by default set to {\bf Catalog} and we want to run an {\bf InitCatalog}
-Job. After responding {\bf mod}, the console will ask:
+Job. After responding {\bf mod}, the console will ask:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Parameters to modify:
1: Level
2: Storage
8: Pool
9: Verify Job
Select parameter to modify (1-5): 1
-\end{verbatim}
+\end{lstlisting}
\normalsize
-you should select number 2 to modify the {\bf Level}, and it will display:
+you should select number 2 to modify the {\bf Level}, and it will display:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Levels:
1: Initialize Catalog
2: Verify Catalog
4: Verify Disk to Catalog
5: Verify Volume Data (not yet implemented)
Select level (1-4): 1
-\end{verbatim}
+\end{lstlisting}
\normalsize
-Choose item 1, and you will see the final display:
+Choose item 1, and you will see the final display:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Run Verify job
JobName: MatouVerify
FileSet: Verify Set
Level: Initcatalog
Client: MatouVerify
Storage: DLTDrive
-Verify Job:
+Verify Job:
Verify List: /tmp/regress/working/MatouVerify.bsr
OK to run? (yes/mod/no): yes
-\end{verbatim}
+\end{lstlisting}
\normalsize
-at which point you respond {\bf yes}, and the Job will begin.
+at which point you respond {\bf yes}, and the Job will begin.
Thereafter the Job will automatically start according to the schedule you
have defined. If you wish to immediately verify it, you can simply run a
Verify {\bf Catalog} which will be the default. No differences should be
-found.
+found.
To use a previous job, you can add \texttt{jobid=xxx} option in run command
line. It will run the Verify job against the specified job.
-\begin{verbatim}
+\begin{lstlisting}
*run jobid=1 job=MatouVerify
Run Verify job
JobName: MatouVerify
Verify List: /tmp/regress/working/MatouVerify.bsr
When: 2010-09-08 15:35:32
Priority: 10
-OK to run? (yes/mod/no):
-\end{verbatim}
+OK to run? (yes/mod/no):
+\end{lstlisting}
\section{What To Do When Differences Are Found}
\index[general]{What To Do When Differences Are Found }
If you have setup your messages correctly, you should be notified if there are
any differences and exactly what they are. For example, below is the email
-received after doing an update of OpenSSH:
+received after doing an update of OpenSSH:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
HeadMan: Start Verify JobId 83 Job=RufusVerify.2002-06-25.21:41:05
HeadMan: Verifying against Init JobId 70 run 2002-06-21 18:58:51
HeadMan: File: /etc/pam.d/sshd
End time: 25-Jun-2002 21:41
Files Examined: 4,258
Termination: Verify Differences
-\end{verbatim}
+\end{lstlisting}
\normalsize
At this point, it was obvious that these files were modified during
installation of the RPMs. If you want to be super safe, you should run a {\bf
Verify Level=Catalog} immediately before installing new software to verify
that there are no differences, then run a {\bf Verify Level=InitCatalog}
-immediately after the installation.
+immediately after the installation.
To keep the above email from being sent every night when the Verify Job runs,
we simply re-run the Verify Job setting the level to {\bf InitCatalog} (as we
did above in the very beginning). This will re-establish the current state of
the system as your new basis for future comparisons. Take care that you don't
do an {\bf InitCatalog} after someone has placed a Trojan horse on your
-system!
+system!
If you have included in your {\bf FileSet} a file that is changed by the
normal operation of your system, you will get false matches, and you will need
to modify the {\bf FileSet} to exclude that file (or not to Include it), and
-then re-run the {\bf InitCatalog}.
+then re-run the {\bf InitCatalog}.
The FileSet that is shown below is what I use on my Red Hat 7.3 system. With a
bit more thought, you can probably add quite a number of additional files that
-should be monitored.
+should be monitored.
\section{A Verify Configuration Example}
\index[general]{Verify Configuration Example }
\index[general]{Example!Verify Configuration }
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Schedule {
Name = "VerifyCycle"
Run = Level=Catalog sun-sat at 5:05
Name = Bacula
dbname = verify; user = bacula; password = ""
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
been thouroughly tested on Windows and is suitable for a
production environment. As a consequence, when we
speak of the Windows version of Bacula below, we are referring to
-the File daemon (client) only.
+the File daemon (client) only.
The Windows version of the Bacula File daemon has been tested on WinXP,
Win2000, Windows Server 2003, Windows Server 2008, Vista, and Windows 7
Once installed Bacula normally runs as a system service. This means that it is
immediately started by the operating system when the system is booted, and
-runs in the background even if there is no user logged into the system.
+runs in the background even if there is no user logged into the system.
\section{Win32 Installation}
\label{installation}
Normally, you will install the Windows version of Bacula from the binaries.
This install is standard Windows .exe that runs an install wizard using the
NSIS Free Software installer, so if you have already installed Windows
-software, it should be very familiar to you.
+software, it should be very familiar to you.
If you have a previous version of Bacula
installed, you should stop the service, uninstall it, and remove
uses a different directory structure (see below).
Providing you do not already have Bacula installed,
-the installer installs the binaries and dlls in
-c:\textbackslash{}Program Files\textbackslash{}Bacula\textbackslash{}bin
+the installer installs the binaries and dlls in
+c:\textbackslash{}Program Files\textbackslash{}Bacula\textbackslash{}bin
and the configuration files
in c:\textbackslash{}Documents and Settings\textbackslash{}All Users\textbackslash{}Application Data\textbackslash{}Bacula
In addition, the {\bf Start\-\gt{}All Programs\-\gt{}Bacula} menu item
the document, and starting bwx-console or bconsole.
-Finally, proceed with the installation.
+Finally, proceed with the installation.
-\begin{itemize}
+\begin{bsysitemize}
\item You must be logged in as Administrator to the local machine
to do a correct installation, if not, please do so before continuing.
Some users have attempted to install logged in as a domain administrator
account and experienced permissions problems attempting to run
Bacula, so we don't recommend that option.
-
+
\item Simply double click on the {\bf bacula-win32-5.xx.0.exe} NSIS install
- icon. The actual name of the icon will vary from one release version to
- another.
+ icon. The actual name of the icon will vary from one release version to
+ another.
-\includegraphics{\idir win32-nsis.eps} bacula-win32-5.xx.0.exe
-
-\item Once launched, the installer wizard will ask you if you want to install
- Bacula.
+\includegraphics{nsis} bacula-win32-5.xx.0.exe
-\addcontentsline{lof}{figure}{Win32 Client Setup Wizard}
-\includegraphics{\idir win32-welcome.eps}
+\item Once launched, the installer wizard will ask you if you want to install
+ Bacula.
-\item Next you will be asked to select the installation type.
+%\addcontentsline{lof}{figure}{Win32 Client Setup Wizard}
+%\includegraphics{\idir win32-welcome}
+\bsysimageH{win32-welcome}{Win32 Client Setup Wizard}{fig:win32clientsetupwizard}
-\addcontentsline{lof}{figure}{Win32 Installation Type}
-\includegraphics{\idir win32-installation-type.eps}
+\item Next you will be asked to select the installation type.
+%\addcontentsline{lof}{figure}{Win32 Installation Type}
+%\includegraphics{\idir win32-installation-type}
+\bsysimageH{win32-installation-type}{Win32 Installation Type}{fig:win32installationtype}
-\item If you proceed, you will be asked to select the components to be
+\item If you proceed, you will be asked to select the components to be
installed. You may install the Bacula program (Bacula File Service) and or
the documentation. Both will be installed in sub-directories of the install
location that you choose later. The components dialog looks like the
- following:
+ following:
-\addcontentsline{lof}{figure}{Win32 Component Selection Dialog}
-\includegraphics{\idir win32-pkg.eps}
+%\addcontentsline{lof}{figure}{Win32 Component Selection Dialog}
+%\includegraphics{\idir win32-pkg}
+\bsysimageH{win32-pkg}{Win32 Component Selection Dialog}{fig:win32componentselectiondialog}
\index[general]{Upgrading}
\item If you are installing for the first time, you will be asked to
not be displayed.
-\addcontentsline{lof}{figure}{Win32 Configure}
-\includegraphics{\idir win32-config.eps}
-
+%\addcontentsline{lof}{figure}{Win32 Configure}
+%\includegraphics{\idir win32-config}
+\bsysimageH{win32-config}{Win32 Configure}{fig:win32configure}
+
\item While the various files are being loaded, you will see the following
dialog:
- \addcontentsline{lof}{figure}{Win32 Install Progress}
- \includegraphics{\idir win32-installing.eps}
-
+% \addcontentsline{lof}{figure}{Win32 Install Progress}
+% \includegraphics{\idir win32-installing}
+\bsysimageH{win32-installing}{Win32 Install Progress}{fig:win32installing}
-\item Finally, the finish dialog will appear:
+\item Finally, the finish dialog will appear:
- \addcontentsline{lof}{figure}{Win32 Client Setup Completed}
- \includegraphics{\idir win32-finish.eps}
+% \addcontentsline{lof}{figure}{Win32 Client Setup Completed}
+% \includegraphics{\idir win32-finish}
+\bsysimageH{win32-finish}{Win32 Client Setup Completed}{fig:win32setupcompleted}
-\
-\end{itemize}
+\end{bsysitemize}
That should complete the installation process. When the Bacula File Server is
-ready to serve files, an icon \includegraphics{\idir idle.eps} representing a
+ready to serve files, an icon \raisebox{-1ex}{\includegraphics{k7-idle}} representing a
cassette (or tape) will appear in the system tray
-\includegraphics{\idir tray-icon.eps}; right click on it and a menu will appear.\\
-\includegraphics{\idir menu.eps}\\
+\raisebox{-2ex}{\includegraphics{tray-icon}}; right click on it and a menu will appear.\\
+\bsysimageN{menu}{Menu on right click}{}\\
The {\bf Events} item is currently unimplemented, by selecting the {\bf
-Status} item, you can verify whether any jobs are running or not.
+Status} item, you can verify whether any jobs are running or not.
When the Bacula File Server begins saving files, the color of the holes in the
-cassette icon will change from white to green \includegraphics{\idir running.eps},
+cassette icon will change from white to green \raisebox{-1ex}{\includegraphics{k7-ok}},
and if there is an error, the holes in the cassette icon will change to red
-\includegraphics{\idir error.eps}.
+\raisebox{-1ex}{\includegraphics{k7-error}}.
If you are using remote desktop connections between your Windows boxes, be
warned that that tray icon does not always appear. It will always be visible
-when you log into the console, but the remote desktop may not display it.
+when you log into the console, but the remote desktop may not display it.
\section{Post Win32 Installation}
\index[general]{Post Win32 Installation}
the {\bf Start\-\gt{}All Programs\-\gt{}Bacula} menu item.
Finally, but pulling up the Task Manager (ctl-alt-del), verify that Bacula
-is running as a process (not an Application) with User Name SYSTEM. If this is
+is running as a process (not an Application) with User Name SYSTEM. If this is
not the case, you probably have not installed Bacula while running as
Administrator, and hence it will be unlikely that Bacula can access
all the system files.
\index[general]{Uninstalling Bacula on Win32}
Once Bacula has been installed, it can be uninstalled using the standard
-Windows Add/Remove Programs dialog found on the Control panel.
+Windows Add/Remove Programs dialog found on the Control panel.
\section{Dealing with Win32 Problems}
\label{problems}
backup transfer rates compared to other machines. To you might
try setting the Maximum Network Buffer Size to 32,768 in both the
File daemon and in the Storage daemon. The default size is larger,
-and apparently some Windows ethernet controllers do not deal with
+and apparently some Windows ethernet controllers do not deal with
a larger network buffer size.
-Many Windows ethernet drivers have a tendency to either run slowly
+Many Windows ethernet drivers have a tendency to either run slowly
due to old broken firmware, or because they are running in half-duplex
mode. Please check with the ethernet card manufacturer for the latest
-firmware and use whatever techniques are necessary to ensure that the
+firmware and use whatever techniques are necessary to ensure that the
card is running in duplex.
If you are not using the portable option, and you have VSS
{\bf bacula-fd.conf} file on
the Windows machine do not match with the names and the passwords in the
Director's configuration file {\bf bacula-dir.conf} located on your Unix/Linux
-server.
+server.
More specifically, the password found in the {\bf Client} resource in the
Director's configuration file must be the same as the password in the {\bf
Director} resource of the File daemon's configuration file. In addition, the
name of the {\bf Director} resource in the File daemon's configuration file
must be the same as the name in the {\bf Director} resource of the Director's
-configuration file.
+configuration file.
It is a bit hard to explain in words, but if you understand that a Director
normally has multiple Clients and a Client (or File daemon) may permit access
by multiple Directors, you can see that the names and the passwords on both
-sides must match for proper authentication.
+sides must match for proper authentication.
One user had serious problems with the configuration file until he realized
that the Unix end of line conventions were used and Bacula wanted them in
-Windows format. This has not been confirmed though, and Bacula version 2.0.0
+Windows format. This has not been confirmed though, and Bacula version 2.0.0
and above should now accept all end of line conventions (Win32,
Unix, Mac).
consequence, it is not generally possible to see the debug information and
certain error messages that Bacula prints. With a bit of work, however, it is
possible. When everything else fails and you want to {\bf see} what is going
-on, try the following:
+on, try the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Start a DOS shell Window.
c:\Program Files\bacula\bacula-fd -t >out
type out
-\end{verbatim}
+\end{lstlisting}
\normalsize
The precise path to bacula-fd depends on where it is installed.
The {\bf -t} option will cause Bacula to read the configuration file, print
any error messages and then exit. the {\bf \gt{}} redirects the output to the
-file named {\bf out}, which you can list with the {\bf type} command.
+file named {\bf out}, which you can list with the {\bf type} command.
If something is going wrong later, or you want to run {\bf Bacula} with a
-debug option, you might try starting it as:
+debug option, you might try starting it as:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
c:\Program Files\bacula\bin\bacula-fd -d 100 >out
-\end{verbatim}
+\end{lstlisting}
\normalsize
In this case, Bacula will run until you explicitly stop it, which will give
you a chance to connect to it from your Unix/Linux server. In later versions
of Bacula (1.34 on, I think), when you start the File daemon in debug mode it
can write the output to a trace file {\bf bacula.trace} in the current
-directory. To enable this, before running a job, use the console, and enter:
+directory. To enable this, before running a job, use the console, and enter:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
trace on
-\end{verbatim}
+\end{lstlisting}
\normalsize
then run the job, and once you have terminated the File daemon, you will find
-the debug output in the {\bf bacula.trace} file, which will probably be
+the debug output in the {\bf bacula.trace} file, which will probably be
located in the same directory as bacula-fd.exe.
In addition, you should look in the System Applications log on the Control
-Panel to find any Windows errors that Bacula got during the startup process.
+Panel to find any Windows errors that Bacula got during the startup process.
Finally, due to the above problems, when you turn on debugging, and specify
trace=1 on a setdebug command in the Console, Bacula will write the debug
information to the file {\bf bacula.trace} in the directory from which Bacula
-is executing.
+is executing.
-If you are having problems with ClientRunBeforeJob scripts randomly dying,
+If you are having problems with ClientRunBeforeJob scripts randomly dying,
it is possible that you have run into an Oracle bug. See bug number 622 in
the bugs.bacula.org database. The following information has been
provided by a user on this issue:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
The information in this document applies to:
Oracle HTTP Server - Version: 9.0.4
Microsoft Windows Server 2003
Symptoms
When starting an OC4J instance, the System Clock runs faster, about 7
seconds per minute.
-
+
Cause
-
+
+ This is caused by the Sun JVM bug 4500388, which states that "Calling
Thread.sleep() with a small argument affects the system clock". Although
this is reported as fixed in JDK 1.4.0_02, several reports contradict this
(see the bug in
http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4500388).
-
+
+ Also reported by Microsoft as "The system clock may run fast when you
use the ACPI power management timer as a high-resolution counter on Windows
2000-based computers" (See http://support.microsoft.com/?id=821893)
-\end{verbatim}
+\end{lstlisting}
\normalsize
You may wish to start the daemon with debug mode on rather than doing it
using bconsole. To do so, edit the following registry key:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
HKEY_LOCAL_MACHINE\HARDWARE\SYSTEM\CurrentControlSet\Services\Bacula-dir
-\end{verbatim}
+\end{lstlisting}
\normalsize
using regedit, then add -dnn after the /service option, where nn represents
During backup, Bacula doesn't know about the system registry, so you will
either need to write it out to an ASCII file using {\bf regedit~~/e} or use a
-program specifically designed to make a copy or backup the registry.
+program specifically designed to make a copy or backup the registry.
In Bacula version 1.31 and later, we use Windows backup API calls by
default. Typical of Windows, programming these special BackupRead and
can be restored, the Windows security and access control data will not be
restored. This means that a standard set of access permissions will be set
for such restored files.
-
+
As a default, Bacula backs up Windows systems using the Windows API calls.
If you want to backup data on a Windows system and restore it on a
You should always be able to restore any file backed up on Unix or Win95/98/Me
to any other system. On some older Windows systems, you may have to
-reset the ownership of such restored files.
+reset the ownership of such restored files.
Finally, if you specify the {\bf portable=yes} option on the files you back
up. Bacula will be able to restore them on any other system. However, any
-Windows specific security and ownership information will be lost.
+Windows specific security and ownership information will be lost.
The following matrix will give you an idea of what you can expect. Thanks to
-Marc Brueckner for doing the tests:
+Marc Brueckner for doing the tests:
\addcontentsline{lot}{table}{WinNT/2K/XP Restore Portability Status}
\begin{longtable}{|l|l|p{2.8in}|}
- \hline
+ \hline
\multicolumn{1}{|c|}{\bf Backup OS} & \multicolumn{1}{c|}{\bf Restore OS}
& \multicolumn{1}{c|}{\bf Results } \\
\hline {WinMe} & {WinMe} & {Works } \\
\hline {Linux} & {WinNT} & {Works (SYSTEM permissions) } \\
\hline {Linux} & {WinMe} & {Works } \\
\hline {Linux} & {WinXP} & {Works (SYSTEM permissions)}
-\\ \hline
+\\ \hline
\end{longtable}
Note: with Bacula versions 1.39.x and later, non-portable Windows data can
\index[general]{Volume Shadow Copy Service}
\index[general]{VSS}
In version 1.37.30 and greater, you can turn on Microsoft's Volume
-Shadow Copy Service (VSS).
+Shadow Copy Service (VSS).
Microsoft added VSS to Windows XP and Windows 2003. From the perspective of
a backup-solution for Windows, this is an extremely important step. VSS
\index[dir]{Enable VSS}
\index[general]{Enable VSS}
-\begin{verbatim}
+\begin{lstlisting}
Enable VSS = yes
-\end{verbatim}
+\end{lstlisting}
-in your FileSet resource.
+in your FileSet resource.
The VSS aware File daemon has the letters VSS on the signon line that
it produces when contacted by the console. For example:
-\begin{verbatim}
+\begin{lstlisting}
Tibs-fd Version: 1.37.32 (22 July 2005) VSS Windows XP MVS NT 5.1.2600
-\end{verbatim}
+\end{lstlisting}
the VSS is shown in the line above. This only means that the File daemon
is capable of doing VSS not that VSS is turned on for a particular backup.
There are two ways of telling if VSS is actually turned on during a backup.
The first is to look at the status output for a job, e.g.:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Running Jobs:
JobId 1 Job NightlySave.2005-07-23_13.25.45 is running.
VSS Backup Job started: 23-Jul-05 13:25
Files Examined=75,021
Processing file: c:/Documents and Settings/kern/My Documents/My Pictures/Misc1/Sans titre - 39.pdd
SDReadSeqNo=5 fd=352
-\end{verbatim}
+\end{lstlisting}
\normalsize
-Here, you see under Running Jobs that JobId 1 is "VSS Backup Job started ..."
+Here, you see under Running Jobs that JobId 1 is "VSS Backup Job started ..."
This means that VSS is enabled for that job. If VSS is not enabled, it will
simply show "Backup Job started ..." without the letters VSS.
-The second way to know that the job was backed up with VSS is to look at the
+The second way to know that the job was backed up with VSS is to look at the
Job Report, which will look something like the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
23-Jul 13:25 rufus-dir: Start Backup JobId 1, Job=NightlySave.2005-07-23_13.25.45
23-Jul 13:26 rufus-sd: Wrote label to prelabeled Volume "TestVolume001" on device "DDS-4" (/dev/nst0)
23-Jul 13:26 rufus-sd: Spooling data ...
23-Jul 13:26 Tibs: VSS Writer: "Microsoft Writer (Bootable State)", State: 1 (VSS_WS_STABLE)
23-Jul 13:26 Tibs: VSS Writer: "WMI Writer", State: 1 (VSS_WS_STABLE)
23-Jul 13:26 Tibs: VSS Writer: "Microsoft Writer (Service State)", State: 1 (VSS_WS_STABLE)
-\end{verbatim}
+\end{lstlisting}
\normalsize
In the above Job Report listing, you see that the VSS snapshot was generated for drive C (if
other drives are backed up, they will be listed on the {\bf Drive(s)="C"} You also see the
know that the problem is in your Windows machine and not with Bacula.
The FD hang problems were reported with {\bf MSDEwriter} when:
-\begin{itemize}
+\begin{bsysitemize}
\item a local firewall locked local access to the MSDE TCP port (MSDEwriter
-seems to use TCP/IP and not Named Pipes).
+seems to use TCP/IP and not Named Pipes).
\item msdtcs was installed to run under "localsystem": try running msdtcs
under networking account (instead of local system) (com+ seems to work
better with this configuration).
-\end{itemize}
+\end{bsysitemize}
\section{Windows Firewalls}
communicate to the other daemons. This can be deactivated through the {\bf
Security Notification} dialog, which is apparently somewhere in the {\bf
Security Center}. I don't have this on my computer, so I cannot give the exact
-details.
+details.
-The command:
+The command:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
netsh firewall set opmode disable
-\end{verbatim}
+\end{lstlisting}
\normalsize
is purported to disable the firewall, but this command is not accepted on my
-WinXP Home machine.
+WinXP Home machine.
\section{Windows Port Usage}
\index[general]{Windows Port Usage}
\index[general]{Usage!Windows Port}
If you want to see if the File daemon has properly opened the port and is
-listening, you can enter the following command in a shell window:
+listening, you can enter the following command in a shell window:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
netstat -an | findstr 910[123]
-\end{verbatim}
+\end{lstlisting}
\normalsize
TopView is another program that has been recommend, but it is not a
the {\bf portable} option. {\bf bextract} does not run on Windows, and the
normal way Bacula saves files using the Windows API prevents the files from
being restored on a Unix machine. Once you have an operational Windows OS
-loaded, you can run the File daemon and restore your user files.
+loaded, you can run the File daemon and restore your user files.
-Please see
+Please see
\ilink{ Disaster Recovery of Win32 Systems}{Win3233} for the latest
-suggestion, which looks very promising.
+suggestion, which looks very promising.
It looks like Bart PE Builder, which creates a Windows PE (Pre-installation
Environment) Boot-CD, may be just what is needed to build a complete disaster
-recovery system for Win32. This distribution can be found at
+recovery system for Win32. This distribution can be found at
\elink{http://www.nu2.nu/pebuilder/}{http://www.nu2.nu/pebuilder/}.
\section{Windows Restore Problems}
\index[general]{Problems!Windows Restore}
\index[general]{Windows Restore Problems}
-Please see the
+Please see the
\ilink{Restore Chapter}{Windows} of this manual for problems
that you might encounter doing a restore.
section{Windows Backup Problems}
\index[general]{Problems!Windows Backup}
\index[general]{Windows Backup Problems}
-If during a Backup, you get the message:
+If during a Backup, you get the message:
{\bf ERR=Access is denied} and you are using the portable option,
you should try both adding both the non-portable (backup API) and
the Volume Shadow Copy options to your Director's conf file.
In the Options resource:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
portable = no
-\end{verbatim}
+\end{lstlisting}
\normalsize
In the FileSet resource:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
enablevss = yes
-\end{verbatim}
+\end{lstlisting}
\normalsize
In general, specifying these two options should allow you to backup
if you run as administrator. In principle, Microsoft supplies you with the way
to cease the ownership of those files and thus change the permissions.
However, a much better solution to working with and changing Win32 permissions
-is the program {\bf SetACL}, which can be found at
-\elink{http://setacl.sourceforge.net/}{http://setacl.sourceforge.net/}.
+is the program {\bf SetACL}, which can be found at
+\elink{http://setacl.sourceforge.net/}{http://setacl.sourceforge.net/}.
If you have not installed Bacula while running as Administrator
-and if Bacula is not running as a Process with the userid (User Name) SYSTEM,
+and if Bacula is not running as a Process with the userid (User Name) SYSTEM,
then it is very unlikely that it will have sufficient permission to
-access all your files.
+access all your files.
Some users have experienced problems restoring files that participate in
the Active Directory. They also report that changing the userid under which
In this example, "top-level" means something like {\bf
c:\textbackslash{}src}, not {\bf c:\textbackslash{}tmp\textbackslash{}src}
where {\bf c:\textbackslash{}tmp} already exists. If a restore job specifies /
-as the {\bf Where:} value, this problem will arise.
+as the {\bf Where:} value, this problem will arise.
The problem appears as a directory which cannot be browsed with Windows
Explorer. The symptoms include the following message when you try to click on
-that directory:
+that directory:
-\includegraphics{\idir access-is-denied.eps}
+\bsysimageN{access-is-denied}{Popup on permission issue}{fig:accessdenied}
If you encounter this message, the following steps will change the permissions
-to allow full access.
+to allow full access.
\begin{enumerate}
\item right click on the top level directory (in this example, {\bf c:/src})
- and select {\bf Properties}.
-\item click on the Security tab.
+ and select {\bf Properties}.
+\item click on the Security tab.
\item If the following message appears, you can ignore it, and click on {\bf
- OK}.
+ OK}.
-\includegraphics{\idir view-only.eps}
+\bsysimageH{view-only}{Message to ignore}{fig:messagetoignore}
+%\includegraphics{\idir view-only}
-You should see something like this:
+You should see something like this:
-\includegraphics{\idir properties-security.eps}
-\item click on Advanced
-\item click on the Owner tab
+\bsysimageH{properties-security}{Properties security}{fig:propertiessecurity}
+%\includegraphics{\idir properties-security}
+\item click on Advanced
+\item click on the Owner tab
\item Change the owner to something other than the current owner (which is
- {\bf SYSTEM} in this example as shown below).
-
-\includegraphics{\idir properties-security-advanced-owner.eps}
-\item ensure the "Replace owner on subcontainers and objects" box is
- checked
-\item click on OK
-\item When the message "You do not have permission to read the contents of
+ {\bf SYSTEM} in this example as shown below).
+
+\bsysimageH{properties-security-advanced-owner}{Properties security advanced owner}{fig:propertiessecurityadvancedowner}
+%\includegraphics{\idir properties-security-advanced-owner}
+\item ensure the ``Replace owner on subcontainers and objects'' box is
+ checked
+\item click on OK
+\item When the message ``You do not have permission to read the contents of
directory c:\textbackslash{}src\textbackslash{}basis. Do you wish to replace
- the directory permissions with permissions granting you Full Control?", click
-on Yes.
+ the directory permissions with permissions granting you Full Control?'', click
+on Yes.
-\includegraphics{\idir confirm.eps}
-\item Click on OK to close the Properties tab
+\bsysimageH{confirm}{Confirm granting permissions}{fig:confirmgrantingpermissions}
+%\includegraphics{\idir confirm}
+\item Click on OK to close the Properties tab
\end{enumerate}
With the above procedure, you should now have full control over your restored
-directory.
+directory.
In addition to the above methods of changing permissions, there is a Microsoft
program named {\bf cacls} that can perform similar functions.
A suggestion by Damian Coutts using Microsoft's NTBackup utility in
conjunction with Bacula should permit a full restore of any damaged system
files on Win2K/XP. His suggestion is to do an NTBackup of the critical system
-state prior to running a Bacula backup with the following command:
+state prior to running a Bacula backup with the following command:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
ntbackup backup systemstate /F c:\systemstate.bkf
-\end{verbatim}
+\end{lstlisting}
\normalsize
The {\bf backup} is the command, the {\bf systemstate} says to backup only the
system state and not all the user files, and the {\bf /F
c:\textbackslash{}systemstate.bkf} specifies where to write the state file.
-this file must then be saved and restored by Bacula.
+this file must then be saved and restored by Bacula.
To restore the system state, you first reload a base operating system if the
OS is damaged, otherwise, this is not necessary, then you would use Bacula to
c:\textbackslash{}systemstate.bkf} file. Finally if there are any damaged or
missing system files or registry problems, you run {\bf NTBackup} and {\bf
catalogue} the system statefile, and then select it for restore. The
-documentation says you can't run a command line restore of the systemstate.
+documentation says you can't run a command line restore of the systemstate.
To the best of my knowledge, this has not yet been tested. If you test it,
-please report your results to the Bacula email list.
+please report your results to the Bacula email list.
Note, Bacula uses VSS to backup and restore open files and
system files, but on older Windows machines such as WinNT and
hard drive and restore the backup. Then run the
recovery CD and run
-\begin{verbatim}
+\begin{lstlisting}
diskpart
select disk 0
select part 1
bootrec /rebuldbcd
bootrec /fixboot
bootrec /fixmbr
-\end{verbatim}
+\end{lstlisting}
\section{Considerations for Filename Specifications}
\index[general]{Windows!Considerations for Filename Specifications}
-Please see the
+Please see the
\ilink{Director's Configuration chapter}{win32} of this manual
for important considerations on how to specify Windows paths in Bacula FileSet
-Include and Exclude directives.
+Include and Exclude directives.
\index[general]{Unicode}
Bacula versions prior to 1.37.28 do not support Windows Unicode filenames.
These options are not normally seen or used by the user, and are documented
here only for information purposes. At the current time, to change the default
options, you must either manually run {\bf Bacula} or you must manually edit
-the system registry and modify the appropriate entries.
+the system registry and modify the appropriate entries.
In order to avoid option clashes between the options necessary for {\bf
Bacula} to run on Windows and the standard Bacula options, all Windows
specific options are signaled with a forward slash character (/), while as
usual, the standard Bacula options are signaled with a minus (-), or a minus
minus (\verb:--:). All the standard Bacula options can be used on the Windows
-version. In addition, the following Windows only options are implemented:
+version. In addition, the following Windows only options are implemented:
\begin{description}
\item [/service ]
\index[fd]{/service}
- Start Bacula as a service
+ Start Bacula as a service
\item [/run ]
\index[fd]{/run}
- Run the Bacula application
+ Run the Bacula application
\item [/install ]
\index[fd]{/install}
- Install Bacula as a service in the system registry
+ Install Bacula as a service in the system registry
\item [/remove ]
\index[fd]{/remove}
- Uninstall Bacula from the system registry
+ Uninstall Bacula from the system registry
\item [/about ]
\index[fd]{/about}
- Show the Bacula about dialogue box
+ Show the Bacula about dialogue box
\item [/status ]
\index[fd]{/status}
- Show the Bacula status dialogue box
+ Show the Bacula status dialogue box
\item [/events ]
\index[fd]{/events}
- Show the Bacula events dialogue box (not yet implemented)
+ Show the Bacula events dialogue box (not yet implemented)
\item [/kill ]
\index[fd]{/kill}
- Stop any running {\bf Bacula}
+ Stop any running {\bf Bacula}
\item [/help ]
\index[fd]{/help}
- Show the Bacula help dialogue box
+ Show the Bacula help dialogue box
\end{description}
It is important to note that under normal circumstances the user should never
need to use these options as they are normally handled by the system
automatically once Bacula is installed. However, you may note these options in
-some of the .bat files that have been created for your use.
+some of the .bat files that have been created for your use.
\section{Shutting down Windows Systems}
\index[general]{Shutting down Windows Systems}
Some users like to shutdown their Windows machines after a backup using a
Client Run After Job directive. If you want to do something similar, you might
-take the shutdown program from the
-\elink{apcupsd project}{http://www.apcupsd.com} or one from the
+take the shutdown program from the
+\elink{apcupsd project}{http://www.apcupsd.com} or one from the
\elink{Sysinternals project}
{http://technet.microsoft.com/en-us/sysinternals/bb897541.aspx}.
--- /dev/null
+%\newfont{\bighead}{cmr17 at 36pt}
+\parskip 10pt
+\parindent 0pt
+
+\title{\includegraphics[width=0.3\linewidth]{baculasystems-logo}
+ \\
+ \Huge{Bacula\raisebox{0.1ex}{\textsuperscript\textregistered} Enterprise \bsystitle{}}}
+
+
+\author{The Leading Open Source Backup Solution.\\Kern Sibbald}
+\date{\begin{small}\today \\
+ This manual documents Bacula version \input{version} \\
+ \vspace{0.2in}
+ Copyright {\copyright} 1999-\the\year, Free Software Foundation Europe
+ e.V. \\
+ Bacula\raisebox{0.1ex}{\textsuperscript\textregistered} is a registered trademark of Kern Sibbald.\\
+ \vspace{0.2in}
+ Permission is granted to copy, distribute and/or modify this document under the terms of the
+ GNU Free Documentation License, Version 1.2 published by the Free Software Foundation;
+ with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+ A copy of the license is included in the section entitled ``GNU Free Documentation License''.
+ \end{small}
+}
+%%% --- Header and footer
+\fancypagestyle{plain}{%
+\fancyhf{}%
+\renewcommand{\footrulewidth}{0.4pt}
+\renewcommand{\headrulewidth}{0.4pt}
+\fancyhead[LE,RO]{\small{\textit{Bacula Enterprise \bsystitle{}}}}%
+\fancyhead[RE,LO]{\small{\textit{\textcolor{bsysredtwo}{\leftmark}}}}%Bacula Console and Opertors Guide}}}}%
+\fancyfoot[RE,LO]{\small{\href{http://www.baculasystems.com}{www.baculasystems.com}
+- \textit{Bacula Enterprise \bsystitle}}}% -- DRAFT}}}
+\fancyfoot[LE,RO]{\small{\textit{\thepage/\pageref{LastPage}}}}
+}
+
+%%% --- Header and footer
+\pagestyle{plain}
+\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
+\renewcommand{\sectionmark}[1]{\markboth{#1}{}}
+\maketitle
--- /dev/null
+%\part*{Appendix}
+\chapter{GNU Free Documentation License}
+\index[general]{GNU Free Documentation License}
+\index[general]{License!GNU Free Documentation}
+
+\label{label_fdl}
+Version 1.2, November 2002
+
+
+Copyright \copyright 2000,2001,2002 Free Software Foundation, Inc.
+51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+
+\section{Preamble}
+
+The purpose of this License is to make a manual, textbook, or other
+functional and useful document "free" in the sense of freedom: to
+assure everyone the effective freedom to copy and redistribute it,
+with or without modifying it, either commercially or noncommercially.
+Secondarily, this License preserves for the author and publisher a way
+to get credit for their work, while not being considered responsible
+for modifications made by others.
+
+This License is a kind of "copyleft", which means that derivative
+works of the document must themselves be free in the same sense. It
+complements the GNU General Public License, which is a copyleft
+license designed for free software.
+
+We have designed this License in order to use it for manuals for free
+software, because free software needs free documentation: a free
+program should come with manuals providing the same freedoms that the
+software does. But this License is not limited to software manuals;
+it can be used for any textual work, regardless of subject matter or
+whether it is published as a printed book. We recommend this License
+principally for works whose purpose is instruction or reference.
+
+
+\section{Applicability and definitions}
+
+This License applies to any manual or other work, in any medium, that
+contains a notice placed by the copyright holder saying it can be
+distributed under the terms of this License. Such a notice grants a
+world-wide, royalty-free license, unlimited in duration, to use that
+work under the conditions stated herein. The \textbf{"Document"}, below,
+refers to any such manual or work. Any member of the public is a
+licensee, and is addressed as \textbf{"you"}. You accept the license if you
+copy, modify or distribute the work in a way requiring permission
+under copyright law.
+
+A \textbf{"Modified Version"} of the Document means any work containing the
+Document or a portion of it, either copied verbatim, or with
+modifications and/or translated into another language.
+
+A \textbf{"Secondary Section"} is a named appendix or a front-matter section of
+the Document that deals exclusively with the relationship of the
+publishers or authors of the Document to the Document's overall subject
+(or to related matters) and contains nothing that could fall directly
+within that overall subject. (Thus, if the Document is in part a
+textbook of mathematics, a Secondary Section may not explain any
+mathematics.) The relationship could be a matter of historical
+connection with the subject or with related matters, or of legal,
+commercial, philosophical, ethical or political position regarding
+them.
+
+The \textbf{"Invariant Sections"} are certain Secondary Sections whose titles
+are designated, as being those of Invariant Sections, in the notice
+that says that the Document is released under this License. If a
+section does not fit the above definition of Secondary then it is not
+allowed to be designated as Invariant. The Document may contain zero
+Invariant Sections. If the Document does not identify any Invariant
+Sections then there are none.
+
+The \textbf{"Cover Texts"} are certain short passages of text that are listed,
+as Front-Cover Texts or Back-Cover Texts, in the notice that says that
+the Document is released under this License. A Front-Cover Text may
+be at most 5 words, and a Back-Cover Text may be at most 25 words.
+
+A \textbf{"Transparent"} copy of the Document means a machine-readable copy,
+represented in a format whose specification is available to the
+general public, that is suitable for revising the document
+straightforwardly with generic text editors or (for images composed of
+pixels) generic paint programs or (for drawings) some widely available
+drawing editor, and that is suitable for input to text formatters or
+for automatic translation to a variety of formats suitable for input
+to text formatters. A copy made in an otherwise Transparent file
+format whose markup, or absence of markup, has been arranged to thwart
+or discourage subsequent modification by readers is not Transparent.
+An image format is not Transparent if used for any substantial amount
+of text. A copy that is not "Transparent" is called \textbf{"Opaque"}.
+
+Examples of suitable formats for Transparent copies include plain
+ASCII without markup, Texinfo input format, LaTeX input format, SGML
+or XML using a publicly available DTD, and standard-conforming simple
+HTML, PostScript or PDF designed for human modification. Examples of
+transparent image formats include PNG, XCF and JPG. Opaque formats
+include proprietary formats that can be read and edited only by
+proprietary word processors, SGML or XML for which the DTD and/or
+processing tools are not generally available, and the
+machine-generated HTML, PostScript or PDF produced by some word
+processors for output purposes only.
+
+The \textbf{"Title Page"} means, for a printed book, the title page itself,
+plus such following pages as are needed to hold, legibly, the material
+this License requires to appear in the title page. For works in
+formats which do not have any title page as such, "Title Page" means
+the text near the most prominent appearance of the work's title,
+preceding the beginning of the body of the text.
+
+A section \textbf{"Entitled XYZ"} means a named subunit of the Document whose
+title either is precisely XYZ or contains XYZ in parentheses following
+text that translates XYZ in another language. (Here XYZ stands for a
+specific section name mentioned below, such as \textbf{"Acknowledgements"},
+\textbf{"Dedications"}, \textbf{"Endorsements"}, or \textbf{"History"}.)
+To \textbf{"Preserve the Title"}
+of such a section when you modify the Document means that it remains a
+section "Entitled XYZ" according to this definition.
+
+The Document may include Warranty Disclaimers next to the notice which
+states that this License applies to the Document. These Warranty
+Disclaimers are considered to be included by reference in this
+License, but only as regards disclaiming warranties: any other
+implication that these Warranty Disclaimers may have is void and has
+no effect on the meaning of this License.
+
+
+\section{Verbatim copying}
+
+You may copy and distribute the Document in any medium, either
+commercially or noncommercially, provided that this License, the
+copyright notices, and the license notice saying this License applies
+to the Document are reproduced in all copies, and that you add no other
+conditions whatsoever to those of this License. You may not use
+technical measures to obstruct or control the reading or further
+copying of the copies you make or distribute. However, you may accept
+compensation in exchange for copies. If you distribute a large enough
+number of copies you must also follow the conditions in section 3.
+
+You may also lend copies, under the same conditions stated above, and
+you may publicly display copies.
+
+\section{Copying in quantity}
+
+If you publish printed copies (or copies in media that commonly have
+printed covers) of the Document, numbering more than 100, and the
+Document's license notice requires Cover Texts, you must enclose the
+copies in covers that carry, clearly and legibly, all these Cover
+Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
+the back cover. Both covers must also clearly and legibly identify
+you as the publisher of these copies. The front cover must present
+the full title with all words of the title equally prominent and
+visible. You may add other material on the covers in addition.
+Copying with changes limited to the covers, as long as they preserve
+the title of the Document and satisfy these conditions, can be treated
+as verbatim copying in other respects.
+
+If the required texts for either cover are too voluminous to fit
+legibly, you should put the first ones listed (as many as fit
+reasonably) on the actual cover, and continue the rest onto adjacent
+pages.
+
+If you publish or distribute Opaque copies of the Document numbering
+more than 100, you must either include a machine-readable Transparent
+copy along with each Opaque copy, or state in or with each Opaque copy
+a computer-network location from which the general network-using
+public has access to download using public-standard network protocols
+a complete Transparent copy of the Document, free of added material.
+If you use the latter option, you must take reasonably prudent steps,
+when you begin distribution of Opaque copies in quantity, to ensure
+that this Transparent copy will remain thus accessible at the stated
+location until at least one year after the last time you distribute an
+Opaque copy (directly or through your agents or retailers) of that
+edition to the public.
+
+It is requested, but not required, that you contact the authors of the
+Document well before redistributing any large number of copies, to give
+them a chance to provide you with an updated version of the Document.
+
+
+\section{Modifications}
+
+You may copy and distribute a Modified Version of the Document under
+the conditions of sections 2 and 3 above, provided that you release
+the Modified Version under precisely this License, with the Modified
+Version filling the role of the Document, thus licensing distribution
+and modification of the Modified Version to whoever possesses a copy
+of it. In addition, you must do these things in the Modified Version:
+
+\begin{Aenumerate}
+\item
+ Use in the Title Page (and on the covers, if any) a title distinct
+ from that of the Document, and from those of previous versions
+ (which should, if there were any, be listed in the History section
+ of the Document). You may use the same title as a previous version
+ if the original publisher of that version gives permission.
+
+\item
+ List on the Title Page, as authors, one or more persons or entities
+ responsible for authorship of the modifications in the Modified
+ Version, together with at least five of the principal authors of the
+ Document (all of its principal authors, if it has fewer than five),
+ unless they release you from this requirement.
+
+\item
+ State on the Title page the name of the publisher of the
+ Modified Version, as the publisher.
+
+\item
+ Preserve all the copyright notices of the Document.
+
+\item
+ Add an appropriate copyright notice for your modifications
+ adjacent to the other copyright notices.
+
+\item
+ Include, immediately after the copyright notices, a license notice
+ giving the public permission to use the Modified Version under the
+ terms of this License, in the form shown in the Addendum below.
+
+\item
+ Preserve in that license notice the full lists of Invariant Sections
+ and required Cover Texts given in the Document's license notice.
+
+\item
+ Include an unaltered copy of this License.
+
+\item
+ Preserve the section Entitled "History", Preserve its Title, and add
+ to it an item stating at least the title, year, new authors, and
+ publisher of the Modified Version as given on the Title Page. If
+ there is no section Entitled "History" in the Document, create one
+ stating the title, year, authors, and publisher of the Document as
+ given on its Title Page, then add an item describing the Modified
+ Version as stated in the previous sentence.
+
+\item
+ Preserve the network location, if any, given in the Document for
+ public access to a Transparent copy of the Document, and likewise
+ the network locations given in the Document for previous versions
+ it was based on. These may be placed in the "History" section.
+ You may omit a network location for a work that was published at
+ leaSt four years before the Document itself, or if the original
+ publisher of the version it refers to gives permission.
+
+\item
+ For any section Entitled "Acknowledgements" or "Dedications",
+ Preserve the Title of the section, and preserve in the section all
+ the substance and tone of each of the contributor acknowledgements
+ and/or dedications given therein.
+
+\item
+ Preserve all the Invariant Sections of the Document,
+ unaltered in their text and in their titles. Section numbers
+ or the equivalent are not considered part of the section titles.
+
+\item
+ Delete any section Entitled "Endorsements". Such a section
+ may not be included in the Modified Version.
+
+\item
+ Do not retitle any existing section to be Entitled "Endorsements"
+ or to conflict in title with any Invariant Section.
+
+\item
+ Preserve any Warranty Disclaimers.
+\end{Aenumerate}
+
+If the Modified Version includes new front-matter sections or
+appendices that qualify as Secondary Sections and contain no material
+copied from the Document, you may at your option designate some or all
+of these sections as invariant. To do this, add their titles to the
+list of Invariant Sections in the Modified Version's license notice.
+These titles must be distinct from any other section titles.
+
+You may add a section Entitled "Endorsements", provided it contains
+nothing but endorsements of your Modified Version by various
+parties--for example, statements of peer review or that the text has
+been approved by an organization as the authoritative definition of a
+standard.
+
+You may add a passage of up to five words as a Front-Cover Text, and a
+passage of up to 25 words as a Back-Cover Text, to the end of the list
+of Cover Texts in the Modified Version. Only one passage of
+Front-Cover Text and one of Back-Cover Text may be added by (or
+through arrangements made by) any one entity. If the Document already
+includes a cover text for the same cover, previously added by you or
+by arrangement made by the same entity you are acting on behalf of,
+you may not add another; but you may replace the old one, on explicit
+permission from the previous publisher that added the old one.
+
+The author(s) and publisher(s) of the Document do not by this License
+give permission to use their names for publicity for or to assert or
+imply endorsement of any Modified Version.
+
+
+\section{Combining documents}
+
+
+You may combine the Document with other documents released under this
+License, under the terms defined in section 4 above for modified
+versions, provided that you include in the combination all of the
+Invariant Sections of all of the original documents, unmodified, and
+list them all as Invariant Sections of your combined work in its
+license notice, and that you preserve all their Warranty Disclaimers.
+
+The combined work need only contain one copy of this License, and
+multiple identical Invariant Sections may be replaced with a single
+copy. If there are multiple Invariant Sections with the same name but
+different contents, make the title of each such section unique by
+adding at the end of it, in parentheses, the name of the original
+author or publisher of that section if known, or else a unique number.
+Make the same adjustment to the section titles in the list of
+Invariant Sections in the license notice of the combined work.
+
+In the combination, you must combine any sections Entitled "History"
+in the various original documents, forming one section Entitled
+"History"; likewise combine any sections Entitled "Acknowledgements",
+and any sections Entitled "Dedications". You must delete all sections
+Entitled "Endorsements".
+
+\section{Collections of documents}
+
+You may make a collection consisting of the Document and other documents
+released under this License, and replace the individual copies of this
+License in the various documents with a single copy that is included in
+the collection, provided that you follow the rules of this License for
+verbatim copying of each of the documents in all other respects.
+
+You may extract a single document from such a collection, and distribute
+it individually under this License, provided you insert a copy of this
+License into the extracted document, and follow this License in all
+other respects regarding verbatim copying of that document.
+
+
+\section{Aggregation with independent works}
+
+
+A compilation of the Document or its derivatives with other separate
+and independent documents or works, in or on a volume of a storage or
+distribution medium, is called an "aggregate" if the copyright
+resulting from the compilation is not used to limit the legal rights
+of the compilation's users beyond what the individual works permit.
+When the Document is included in an aggregate, this License does not
+apply to the other works in the aggregate which are not themselves
+derivative works of the Document.
+
+If the Cover Text requirement of section 3 is applicable to these
+copies of the Document, then if the Document is less than one half of
+the entire aggregate, the Document's Cover Texts may be placed on
+covers that bracket the Document within the aggregate, or the
+electronic equivalent of covers if the Document is in electronic form.
+Otherwise they must appear on printed covers that bracket the whole
+aggregate.
+
+
+\section{Translation}
+
+Translation is considered a kind of modification, so you may
+distribute translations of the Document under the terms of section 4.
+Replacing Invariant Sections with translations requires special
+permission from their copyright holders, but you may include
+translations of some or all Invariant Sections in addition to the
+original versions of these Invariant Sections. You may include a
+translation of this License, and all the license notices in the
+Document, and any Warranty Disclaimers, provided that you also include
+the original English version of this License and the original versions
+of those notices and disclaimers. In case of a disagreement between
+the translation and the original version of this License or a notice
+or disclaimer, the original version will prevail.
+
+If a section in the Document is Entitled "Acknowledgements",
+"Dedications", or "History", the requirement (section 4) to Preserve
+its Title (section 1) will typically require changing the actual
+title.
+
+
+\section{Termination}
+
+You may not copy, modify, sublicense, or distribute the Document except
+as expressly provided for under this License. Any other attempt to
+copy, modify, sublicense or distribute the Document is void, and will
+automatically terminate your rights under this License. However,
+parties who have received copies, or rights, from you under this
+License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+
+\section{Future revisions of this license}
+
+The Free Software Foundation may publish new, revised versions
+of the GNU Free Documentation License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns. See
+http://www.gnu.org/copyleft/.
+
+Each version of the License is given a distinguishing version number.
+If the Document specifies that a particular numbered version of this
+License "or any later version" applies to it, you have the option of
+following the terms and conditions either of that specified version or
+of any later version that has been published (not as a draft) by the
+Free Software Foundation. If the Document does not specify a version
+number of this License, you may choose any version ever published (not
+as a draft) by the Free Software Foundation.
+
+\section{Addendum: How to use this License for your documents}
+
+To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and
+license notices just after the title page:
+
+\begin{quote}
+ Copyright \copyright YEAR YOUR NAME.
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.2
+ or any later version published by the Free Software Foundation;
+ with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+ A copy of the license is included in the section entitled "GNU
+ Free Documentation License".
+\end{quote}
+
+If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+replace the "with...Texts." line with this:
+
+\begin{quote}
+ with the Invariant Sections being LIST THEIR TITLES, with the
+ Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
+\end{quote}
+
+If you have Invariant Sections without Cover Texts, or some other
+combination of the three, merge those two alternatives to suit the
+situation.
+
+If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License,
+to permit their use in free software.
+
+%---------------------------------------------------------------------
--- /dev/null
+\chapter{GNU General Public License}
+\label{GplChapter}
+\index[general]{GNU General Public License }
+\index[general]{License!GNU General Public }
+\elink{\includegraphics{philosophical-gnu-sm}}
+{http://www.gnu.org/graphics/philosophicalgnu.html}
+
+\begin{bsysitemize}
+\item
+ \elink{What to do if you see a possible GPL violation}{http://www.gnu.org/copyleft/gpl-violation.html}
+\item
+ \elink{Translations of the
+ GPL}{http://www.gnu.org/copyleft/copyleft.html\#translations}
+\end{bsysitemize}
+
+
+%\section{Table of Contents}
+\minitoc
+\index[general]{GPL!Table of Contents }
+\index[general]{Contents!GPL Table of }
+
+%% \begin{bsysitemize}
+%% \item
+%% \label{TOC1}
+%% \ilink{GNU GENERAL PUBLIC LICENSE}{SEC1}
+%% \begin{bsysitemize}
+%% \item
+%% \label{TOC2}
+%% \ilink{Preamble}{SEC2}
+%% \item
+%% \label{TOC3}
+%% \ilink{TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
+%% MODIFICATION}{SEC3}
+%% \item
+%% \label{TOC4}
+%% \ilink{How to Apply These Terms to Your New Programs}{SEC4}
+%% \end{bsysitemize}
+%% \end{bsysitemize}
+
+
+\section*{GNU GENERAL PUBLIC LICENSE}
+\label{SEC1}
+\index[general]{GNU GENERAL PUBLIC LICENSE}
+\index[general]{LICENSE!GNU GENERAL PUBLIC}
+
+Version 2, June 1991
+
+\begin{verbatim}
+Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+\end{verbatim}
+
+\section{Preamble}
+\label{SEC2}
+\index[general]{Preamble }
+
+The licenses for most software are designed to take away your freedom to share
+and change it. By contrast, the GNU General Public License is intended to
+guarantee your freedom to share and change free software\verb:--:to make sure the
+software is free for all its users. This General Public License applies to
+most of the Free Software Foundation's software and to any other program whose
+authors commit to using it. (Some other Free Software Foundation software is
+covered by the GNU Library General Public License instead.) You can apply it
+to your programs, too.
+
+When we speak of free software, we are referring to freedom, not price. Our
+General Public Licenses are designed to make sure that you have the freedom to
+distribute copies of free software (and charge for this service if you wish),
+that you receive source code or can get it if you want it, that you can change
+the software or use pieces of it in new free programs; and that you know you
+can do these things.
+
+To protect your rights, we need to make restrictions that forbid anyone to
+deny you these rights or to ask you to surrender the rights. These
+restrictions translate to certain responsibilities for you if you distribute
+copies of the software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether gratis or for
+a fee, you must give the recipients all the rights that you have. You must
+make sure that they, too, receive or can get the source code. And you must
+show them these terms so they know their rights.
+
+We protect your rights with two steps: (1) copyright the software, and (2)
+offer you this license which gives you legal permission to copy, distribute
+and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain that
+everyone understands that there is no warranty for this free software. If the
+software is modified by someone else and passed on, we want its recipients to
+know that what they have is not the original, so that any problems introduced
+by others will not reflect on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software patents. We
+wish to avoid the danger that redistributors of a free program will
+individually obtain patent licenses, in effect making the program proprietary.
+To prevent this, we have made it clear that any patent must be licensed for
+everyone's free use or not licensed at all.
+
+The precise terms and conditions for copying, distribution and modification
+follow.
+
+\section{TERMS AND CONDITIONS}
+\label{SEC3}
+\index[general]{CONDITIONS!TERMS AND }
+\index[general]{TERMS AND CONDITIONS }
+
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+{\bf 0.} This License applies to any program or other work which contains a
+notice placed by the copyright holder saying it may be distributed under the
+terms of this General Public License. The "Program", below, refers to any
+such program or work, and a "work based on the Program" means either the
+Program or any derivative work under copyright law: that is to say, a work
+containing the Program or a portion of it, either verbatim or with
+modifications and/or translated into another language. (Hereinafter,
+translation is included without limitation in the term "modification".) Each
+licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not covered
+by this License; they are outside its scope. The act of running the Program is
+not restricted, and the output from the Program is covered only if its
+contents constitute a work based on the Program (independent of having been
+made by running the Program). Whether that is true depends on what the Program
+does.
+
+{\bf 1.} You may copy and distribute verbatim copies of the Program's source
+code as you receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice and
+disclaimer of warranty; keep intact all the notices that refer to this License
+and to the absence of any warranty; and give any other recipients of the
+Program a copy of this License along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and you may
+at your option offer warranty protection in exchange for a fee.
+
+{\bf 2.} You may modify your copy or copies of the Program or any portion of
+it, thus forming a work based on the Program, and copy and distribute such
+modifications or work under the terms of Section 1 above, provided that you
+also meet all of these conditions:
+
+\begin{bsysitemize}
+\item {\bf a)} You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+\item {\bf b)} You must cause any work that you distribute or publish, that
+ in whole or in part contains or is derived from the Program or any part
+ thereof, to be licensed as a whole at no charge to all third parties under
+ the terms of this License.
+
+\item {\bf c)} If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such interactive use in
+ the most ordinary way, to print or display an announcement including an
+ appropriate copyright notice and a notice that there is no warranty (or else,
+ saying that you provide a warranty) and that users may redistribute the
+ program under these conditions, and telling the user how to view a copy of
+ this License. (Exception: if the Program itself is interactive but does not
+ normally print such an announcement, your work based on the Program is not
+ required to print an announcement.)
+\end{bsysitemize}
+
+These requirements apply to the modified work as a whole. If identifiable
+sections of that work are not derived from the Program, and can be reasonably
+considered independent and separate works in themselves, then this License,
+and its terms, do not apply to those sections when you distribute them as
+separate works. But when you distribute the same sections as part of a whole
+which is a work based on the Program, the distribution of the whole must be on
+the terms of this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest your
+rights to work written entirely by you; rather, the intent is to exercise the
+right to control the distribution of derivative or collective works based on
+the Program.
+
+In addition, mere aggregation of another work not based on the Program with
+the Program (or with a work based on the Program) on a volume of a storage or
+distribution medium does not bring the other work under the scope of this
+License.
+
+{\bf 3.} You may copy and distribute the Program (or a work based on it, under
+Section 2) in object code or executable form under the terms of Sections 1 and
+2 above provided that you also do one of the following:
+
+\begin{bsysitemize}
+\item {\bf a)} Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections 1 and 2
+ above on a medium customarily used for software interchange; or,
+
+\item {\bf b)} Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your cost of
+ physically performing source distribution, a complete machine-readable copy of
+ the corresponding source code, to be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+\item {\bf c)} Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is allowed only
+ for noncommercial distribution and only if you received the program in object
+ code or executable form with such an offer, in accord with Subsection b
+ above.)
+\end{bsysitemize}
+
+The source code for a work means the preferred form of the work for making
+modifications to it. For an executable work, complete source code means all
+the source code for all modules it contains, plus any associated interface
+definition files, plus the scripts used to control compilation and
+installation of the executable. However, as a special exception, the source
+code distributed need not include anything that is normally distributed (in
+either source or binary form) with the major components (compiler, kernel, and
+so on) of the operating system on which the executable runs, unless that
+component itself accompanies the executable.
+
+If distribution of executable or object code is made by offering access to
+copy from a designated place, then offering equivalent access to copy the
+source code from the same place counts as distribution of the source code,
+even though third parties are not compelled to copy the source along with the
+object code.
+
+{\bf 4.} You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt otherwise to
+copy, modify, sublicense or distribute the Program is void, and will
+automatically terminate your rights under this License. However, parties who
+have received copies, or rights, from you under this License will not have
+their licenses terminated so long as such parties remain in full compliance.
+
+{\bf 5.} You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or distribute
+the Program or its derivative works. These actions are prohibited by law if
+you do not accept this License. Therefore, by modifying or distributing the
+Program (or any work based on the Program), you indicate your acceptance of
+this License to do so, and all its terms and conditions for copying,
+distributing or modifying the Program or works based on it.
+
+{\bf 6.} Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the original
+licensor to copy, distribute or modify the Program subject to these terms and
+conditions. You may not impose any further restrictions on the recipients'
+exercise of the rights granted herein. You are not responsible for enforcing
+compliance by third parties to this License.
+
+{\bf 7.} If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or otherwise)
+that contradict the conditions of this License, they do not excuse you from
+the conditions of this License. If you cannot distribute so as to satisfy
+simultaneously your obligations under this License and any other pertinent
+obligations, then as a consequence you may not distribute the Program at all.
+For example, if a patent license would not permit royalty-free redistribution
+of the Program by all those who receive copies directly or indirectly through
+you, then the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply and
+the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any patents or
+other property right claims or to contest validity of any such claims; this
+section has the sole purpose of protecting the integrity of the free software
+distribution system, which is implemented by public license practices. Many
+people have made generous contributions to the wide range of software
+distributed through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing to
+distribute software through any other system and a licensee cannot impose that
+choice.
+
+This section is intended to make thoroughly clear what is believed to be a
+consequence of the rest of this License.
+
+{\bf 8.} If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the original
+copyright holder who places the Program under this License may add an explicit
+geographical distribution limitation excluding those countries, so that
+distribution is permitted only in or among countries not thus excluded. In
+such case, this License incorporates the limitation as if written in the body
+of this License.
+
+{\bf 9.} The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will be
+similar in spirit to the present version, but may differ in detail to address
+new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any later
+version", you have the option of following the terms and conditions either of
+that version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of this License,
+you may choose any version ever published by the Free Software Foundation.
+
+{\bf 10.} If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author to
+ask for permission. For software which is copyrighted by the Free Software
+Foundation, write to the Free Software Foundation; we sometimes make
+exceptions for this. Our decision will be guided by the two goals of
+preserving the free status of all derivatives of our free software and of
+promoting the sharing and reuse of software generally.
+
+{\bf NO WARRANTY}
+
+{\bf 11.} BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE
+THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
+IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
+THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
+PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
+
+{\bf 12.} IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
+LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
+THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+END OF TERMS AND CONDITIONS
+
+\section{How to Apply These Terms to Your New Programs}
+\label{SEC4}
+\index[general]{Programs!How to Apply These Terms to Your New }
+\index[general]{How to Apply These Terms to Your New Programs }
+
+If you develop a new program, and you want it to be of the greatest possible
+use to the public, the best way to achieve this is to make it free software
+which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program. It is safest to attach
+them to the start of each source file to most effectively convey the exclusion
+of warranty; and each file should have at least the "copyright" line and a
+pointer to where the full notice is found.
+
+\begin{verbatim}
+{\em one line to give the program's name and an idea of what it does.}
+Copyright (C) {\em yyyy} {\em name of author}
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+02110-1301 USA
+\end{verbatim}
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this when it
+starts in an interactive mode:
+
+\begin{verbatim}
+Gnomovision version 69, Copyright (C) {\em year} {\em name of author}
+Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
+type `show w'. This is free software, and you are welcome
+to redistribute it under certain conditions; type `show c'
+for details.
+\end{verbatim}
+
+The hypothetical commands {\tt `show w'} and {\tt `show c'} should show the
+appropriate parts of the General Public License. Of course, the commands you
+use may be called something other than {\tt `show w'} and {\tt `show c'}; they
+could even be mouse-clicks or menu items\verb:--:whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+\begin{verbatim}
+Yoyodyne, Inc., hereby disclaims all copyright
+interest in the program `Gnomovision'
+(which makes passes at compilers) written
+by James Hacker.
+{\em signature of Ty Coon}, 1 April 1989
+Ty Coon, President of Vice
+\end{verbatim}
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General Public
+License instead of this License.
+Return to
+\elink{GNU's home page}{http://www.gnu.org/home.html}.
+
+FSF \& GNU inquiries \& questions to
+\elink{gnu@gnu.org}{mailto:gnu@gnu.org}. Other
+\elink{ways to contact}{http://www.gnu.org/home.html\#ContactInfo} the FSF.
+
+Comments on these web pages to
+\elink{webmasters@www.gnu.org}{mailto:webmasters@www.gnu.org}, send other
+questions to
+\elink{gnu@gnu.org}{mailto:gnu@gnu.org}.
+
+Copyright notice above.
+Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+Boston, MA 02110-1301 USA
+
+Updated: 3 Jan 2000 rms
--- /dev/null
+\chapter{GNU Lesser General Public License}
+\label{LesserChapter}
+\index[general]{GNU Lesser General Public License }
+\index[general]{License!GNU Lesser General Public }
+\elink{\includegraphics{philosophical-gnu-sm}}
+{http://www.gnu.org/graphics/philosophicalgnu.html}
+[ \elink{English}{http://www.gnu.org/copyleft/lesser.html} |
+\elink{Japanese}{http://www.gnu.org/copyleft/lesser.ja.html} ]
+
+\begin{bsysitemize}
+\item
+ \elink{Why you shouldn't use the Lesser GPL for your next
+ library}{http://www.gnu.org/philosophy/why-not-lgpl.html}
+\item
+ \elink{What to do if you see a possible LGPL
+ violation}{http://www.gnu.org/copyleft/gpl-violation.html}
+\item
+ \elink{Translations of the LGPL}
+{http://www.gnu.org/copyleft/copyleft.html\#translationsLGPL}
+\item The GNU Lesser General Public License as a
+ \elink{text file}{http://www.gnu.org/copyleft/lesser.txt}
+\item The GNU Lesser General Public License as a
+ \elink{Texinfo}{http://www.gnu.org/copyleft/lesser.texi} file
+ \end{bsysitemize}
+
+
+This GNU Lesser General Public License counts as the successor of the GNU
+Library General Public License. For an explanation of why this change was
+necessary, read the
+\elink{Why you shouldn't use the Lesser GPL for your next
+library}{http://www.gnu.org/philosophy/why-not-lgpl.html} article.
+
+%\section{Table of Contents}
+\minitoc
+\index[general]{Table of Contents }
+\index[general]{Contents!Table of }
+
+%% \begin{bsysitemize}
+%% \item
+%% \label{TOC12}
+%% \ilink{GNU LESSER GENERAL PUBLIC LICENSE}{SEC12}
+
+%% \begin{bsysitemize}
+%% \item
+%% \label{TOC23}
+%% \ilink{Preamble}{SEC23}
+%% \item
+%% \label{TOC34}
+%% \ilink{TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
+%% MODIFICATION}{SEC34}
+%% \item
+%% \label{TOC45}
+%% \ilink{How to Apply These Terms to Your New Libraries}{SEC45}
+%% \end{bsysitemize}
+
+%% \end{bsysitemize}
+
+
+\section{GNU LESSER GENERAL PUBLIC LICENSE}
+\label{SEC12}
+\index[general]{LICENSE!GNU LESSER GENERAL PUBLIC }
+\index[general]{GNU LESSER GENERAL PUBLIC LICENSE }
+
+Version 2.1, February 1999
+
+\begin{verbatim}
+Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+[This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+\end{verbatim}
+
+\section{Preamble}
+\label{SEC23}
+\index[general]{Preamble }
+
+The licenses for most software are designed to take away your freedom to share
+and change it. By contrast, the GNU General Public Licenses are intended to
+guarantee your freedom to share and change free software\verb:--:to make sure the
+software is free for all its users.
+
+This license, the Lesser General Public License, applies to some specially
+designated software packages\verb:--:typically libraries\verb:--:of the Free Software
+Foundation and other authors who decide to use it. You can use it too, but we
+suggest you first think carefully about whether this license or the ordinary
+General Public License is the better strategy to use in any particular case,
+based on the explanations below.
+
+When we speak of free software, we are referring to freedom of use, not price.
+Our General Public Licenses are designed to make sure that you have the
+freedom to distribute copies of free software (and charge for this service if
+you wish); that you receive source code or can get it if you want it; that you
+can change the software and use pieces of it in new free programs; and that
+you are informed that you can do these things.
+
+To protect your rights, we need to make restrictions that forbid distributors
+to deny you these rights or to ask you to surrender these rights. These
+restrictions translate to certain responsibilities for you if you distribute
+copies of the library or if you modify it.
+
+For example, if you distribute copies of the library, whether gratis or for a
+fee, you must give the recipients all the rights that we gave you. You must
+make sure that they, too, receive or can get the source code. If you link
+other code with the library, you must provide complete object files to the
+recipients, so that they can relink them with the library after making changes
+to the library and recompiling it. And you must show them these terms so they
+know their rights.
+
+We protect your rights with a two-step method: (1) we copyright the library,
+and (2) we offer you this license, which gives you legal permission to copy,
+distribute and/or modify the library.
+
+To protect each distributor, we want to make it very clear that there is no
+warranty for the free library. Also, if the library is modified by someone
+else and passed on, the recipients should know that what they have is not the
+original version, so that the original author's reputation will not be
+affected by problems that might be introduced by others.
+
+Finally, software patents pose a constant threat to the existence of any free
+program. We wish to make sure that a company cannot effectively restrict the
+users of a free program by obtaining a restrictive license from a patent
+holder. Therefore, we insist that any patent license obtained for a version of
+the library must be consistent with the full freedom of use specified in this
+license.
+
+Most GNU software, including some libraries, is covered by the ordinary GNU
+General Public License. This license, the GNU Lesser General Public License,
+applies to certain designated libraries, and is quite different from the
+ordinary General Public License. We use this license for certain libraries in
+order to permit linking those libraries into non-free programs.
+
+When a program is linked with a library, whether statically or using a shared
+library, the combination of the two is legally speaking a combined work, a
+derivative of the original library. The ordinary General Public License
+therefore permits such linking only if the entire combination fits its
+criteria of freedom. The Lesser General Public License permits more lax
+criteria for linking other code with the library.
+
+We call this license the "Lesser" General Public License because it does
+Less to protect the user's freedom than the ordinary General Public License.
+It also provides other free software developers Less of an advantage over
+competing non-free programs. These disadvantages are the reason we use the
+ordinary General Public License for many libraries. However, the Lesser
+license provides advantages in certain special circumstances.
+
+For example, on rare occasions, there may be a special need to encourage the
+widest possible use of a certain library, so that it becomes a de-facto
+standard. To achieve this, non-free programs must be allowed to use the
+library. A more frequent case is that a free library does the same job as
+widely used non-free libraries. In this case, there is little to gain by
+limiting the free library to free software only, so we use the Lesser General
+Public License.
+
+In other cases, permission to use a particular library in non-free programs
+enables a greater number of people to use a large body of free software. For
+example, permission to use the GNU C Library in non-free programs enables many
+more people to use the whole GNU operating system, as well as its variant, the
+GNU/Linux operating system.
+
+Although the Lesser General Public License is Less protective of the users'
+freedom, it does ensure that the user of a program that is linked with the
+Library has the freedom and the wherewithal to run that program using a
+modified version of the Library.
+
+The precise terms and conditions for copying, distribution and modification
+follow. Pay close attention to the difference between a "work based on the
+library" and a "work that uses the library". The former contains code
+derived from the library, whereas the latter must be combined with the library
+in order to run.
+
+\section{TERMS AND CONDITIONS}
+\label{SEC34}
+\index[general]{CONDITIONS!TERMS AND }
+\index[general]{TERMS AND CONDITIONS }
+
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+{\bf 0.} This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or other
+authorized party saying it may be distributed under the terms of this Lesser
+General Public License (also called "this License"). Each licensee is
+addressed as "you".
+
+A "library" means a collection of software functions and/or data prepared so
+as to be conveniently linked with application programs (which use some of
+those functions and data) to form executables.
+
+The "Library", below, refers to any such software library or work which has
+been distributed under these terms. A "work based on the Library" means
+either the Library or any derivative work under copyright law: that is to say,
+a work containing the Library or a portion of it, either verbatim or with
+modifications and/or translated straightforwardly into another language.
+(Hereinafter, translation is included without limitation in the term
+"modification".)
+
+"Source code" for a work means the preferred form of the work for making
+modifications to it. For a library, complete source code means all the source
+code for all modules it contains, plus any associated interface definition
+files, plus the scripts used to control compilation and installation of the
+library.
+
+Activities other than copying, distribution and modification are not covered
+by this License; they are outside its scope. The act of running a program
+using the Library is not restricted, and output from such a program is covered
+only if its contents constitute a work based on the Library (independent of
+the use of the Library in a tool for writing it). Whether that is true depends
+on what the Library does and what the program that uses the Library does.
+
+{\bf 1.} You may copy and distribute verbatim copies of the Library's complete
+source code as you receive it, in any medium, provided that you conspicuously
+and appropriately publish on each copy an appropriate copyright notice and
+disclaimer of warranty; keep intact all the notices that refer to this License
+and to the absence of any warranty; and distribute a copy of this License
+along with the Library.
+
+You may charge a fee for the physical act of transferring a copy, and you may
+at your option offer warranty protection in exchange for a fee.
+
+{\bf 2.} You may modify your copy or copies of the Library or any portion of
+it, thus forming a work based on the Library, and copy and distribute such
+modifications or work under the terms of Section 1 above, provided that you
+also meet all of these conditions:
+
+\begin{bsysitemize}
+\item {\bf a)} The modified work must itself be a software library.
+\item {\bf b)} You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+\item {\bf c)} You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+\item {\bf d)} If a facility in the modified Library refers to a function or
+ a table of data to be supplied by an application program that uses the
+ facility, other than as an argument passed when the facility is invoked, then
+you must make a good faith effort to ensure that, in the event an application
+does not supply such function or table, the facility still operates, and
+performs whatever part of its purpose remains meaningful.
+
+(For example, a function in a library to compute square roots has a purpose
+that is entirely well-defined independent of the application. Therefore,
+Subsection 2d requires that any application-supplied function or table used
+by this function must be optional: if the application does not supply it, the
+square root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole. If identifiable
+sections of that work are not derived from the Library, and can be reasonably
+considered independent and separate works in themselves, then this License,
+and its terms, do not apply to those sections when you distribute them as
+separate works. But when you distribute the same sections as part of a whole
+which is a work based on the Library, the distribution of the whole must be
+on the terms of this License, whose permissions for other licensees extend to
+the entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest your
+rights to work written entirely by you; rather, the intent is to exercise the
+right to control the distribution of derivative or collective works based on
+the Library.
+
+In addition, mere aggregation of another work not based on the Library with
+the Library (or with a work based on the Library) on a volume of a storage or
+distribution medium does not bring the other work under the scope of this
+License.
+\end{bsysitemize}
+
+{\bf 3.} You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do this,
+you must alter all the notices that refer to this License, so that they refer
+to the ordinary GNU General Public License, version 2, instead of to this
+License. (If a newer version than version 2 of the ordinary GNU General Public
+License has appeared, then you can specify that version instead if you wish.)
+Do not make any other change in these notices.
+
+Once this change is made in a given copy, it is irreversible for that copy, so
+the ordinary GNU General Public License applies to all subsequent copies and
+derivative works made from that copy.
+
+This option is useful when you wish to copy part of the code of the Library
+into a program that is not a library.
+
+{\bf 4.} You may copy and distribute the Library (or a portion or derivative
+of it, under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you accompany it with the complete
+corresponding machine-readable source code, which must be distributed under
+the terms of Sections 1 and 2 above on a medium customarily used for software
+interchange.
+
+If distribution of object code is made by offering access to copy from a
+designated place, then offering equivalent access to copy the source code from
+the same place satisfies the requirement to distribute the source code, even
+though third parties are not compelled to copy the source along with the
+object code.
+
+{\bf 5.} A program that contains no derivative of any portion of the Library,
+but is designed to work with the Library by being compiled or linked with it,
+is called a "work that uses the Library". Such a work, in isolation, is not
+a derivative work of the Library, and therefore falls outside the scope of
+this License.
+
+However, linking a "work that uses the Library" with the Library creates an
+executable that is a derivative of the Library (because it contains portions
+of the Library), rather than a "work that uses the library". The executable
+is therefore covered by this License. Section 6 states terms for distribution
+of such executables.
+
+When a "work that uses the Library" uses material from a header file that is
+part of the Library, the object code for the work may be a derivative work of
+the Library even though the source code is not. Whether this is true is
+especially significant if the work can be linked without the Library, or if
+the work is itself a library. The threshold for this to be true is not
+precisely defined by law.
+
+If such an object file uses only numerical parameters, data structure layouts
+and accessors, and small macros and small inline functions (ten lines or less
+in length), then the use of the object file is unrestricted, regardless of
+whether it is legally a derivative work. (Executables containing this object
+code plus portions of the Library will still fall under Section 6.)
+
+Otherwise, if the work is a derivative of the Library, you may distribute the
+object code for the work under the terms of Section 6. Any executables
+containing that work also fall under Section 6, whether or not they are linked
+directly with the Library itself.
+
+{\bf 6.} As an exception to the Sections above, you may also combine or link a
+"work that uses the Library" with the Library to produce a work containing
+portions of the Library, and distribute that work under terms of your choice,
+provided that the terms permit modification of the work for the customer's own
+use and reverse engineering for debugging such modifications.
+
+You must give prominent notice with each copy of the work that the Library is
+used in it and that the Library and its use are covered by this License. You
+must supply a copy of this License. If the work during execution displays
+copyright notices, you must include the copyright notice for the Library among
+them, as well as a reference directing the user to the copy of this License.
+Also, you must do one of these things:
+
+\begin{bsysitemize}
+\item {\bf a)} Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever changes were
+ used in the work (which must be distributed under Sections 1 and 2 above);
+and, if the work is an executable linked with the Library, with the complete
+machine-readable "work that uses the Library", as object code and/or source
+code, so that the user can modify the Library and then relink to produce a
+modified executable containing the modified Library. (It is understood that
+the user who changes the contents of definitions files in the Library will
+not necessarily be able to recompile the application to use the modified
+definitions.)
+\item {\bf b)} Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a copy of the
+ library already present on the user's computer system, rather than copying
+library functions into the executable, and (2) will operate properly with a
+modified version of the library, if the user installs one, as long as the
+modified version is interface-compatible with the version that the work was
+made with.
+\item {\bf c)} Accompany the work with a written offer, valid for at least
+ three years, to give the same user the materials specified in Subsection 6a,
+ above, for a charge no more than the cost of performing this distribution.
+\item {\bf d)} If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above specified
+ materials from the same place.
+\item {\bf e)} Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+ \end{bsysitemize}
+
+For an executable, the required form of the "work that uses the Library"
+must include any data and utility programs needed for reproducing the
+executable from it. However, as a special exception, the materials to be
+distributed need not include anything that is normally distributed (in either
+source or binary form) with the major components (compiler, kernel, and so on)
+of the operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+It may happen that this requirement contradicts the license restrictions of
+other proprietary libraries that do not normally accompany the operating
+system. Such a contradiction means you cannot use both them and the Library
+together in an executable that you distribute.
+
+{\bf 7.} You may place library facilities that are a work based on the Library
+side-by-side in a single library together with other library facilities not
+covered by this License, and distribute such a combined library, provided that
+the separate distribution of the work based on the Library and of the other
+library facilities is otherwise permitted, and provided that you do these two
+things:
+
+\begin{bsysitemize}
+\item {\bf a)} Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library facilities. This must
+ be distributed under the terms of the Sections above.
+\item {\bf b)} Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining where to find
+ the accompanying uncombined form of the same work.
+\end{bsysitemize}
+
+{\bf 8.} You may not copy, modify, sublicense, link with, or distribute the
+Library except as expressly provided under this License. Any attempt otherwise
+to copy, modify, sublicense, link with, or distribute the Library is void, and
+will automatically terminate your rights under this License. However, parties
+who have received copies, or rights, from you under this License will not have
+their licenses terminated so long as such parties remain in full compliance.
+
+{\bf 9.} You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or distribute
+the Library or its derivative works. These actions are prohibited by law if
+you do not accept this License. Therefore, by modifying or distributing the
+Library (or any work based on the Library), you indicate your acceptance of
+this License to do so, and all its terms and conditions for copying,
+distributing or modifying the Library or works based on it.
+
+{\bf 10.} Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the original
+licensor to copy, distribute, link with or modify the Library subject to these
+terms and conditions. You may not impose any further restrictions on the
+recipients' exercise of the rights granted herein. You are not responsible for
+enforcing compliance by third parties with this License.
+
+{\bf 11.} If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or otherwise)
+that contradict the conditions of this License, they do not excuse you from
+the conditions of this License. If you cannot distribute so as to satisfy
+simultaneously your obligations under this License and any other pertinent
+obligations, then as a consequence you may not distribute the Library at all.
+For example, if a patent license would not permit royalty-free redistribution
+of the Library by all those who receive copies directly or indirectly through
+you, then the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply, and
+the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any patents or
+other property right claims or to contest validity of any such claims; this
+section has the sole purpose of protecting the integrity of the free software
+distribution system which is implemented by public license practices. Many
+people have made generous contributions to the wide range of software
+distributed through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing to
+distribute software through any other system and a licensee cannot impose that
+choice.
+
+This section is intended to make thoroughly clear what is believed to be a
+consequence of the rest of this License.
+
+{\bf 12.} If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the original
+copyright holder who places the Library under this License may add an explicit
+geographical distribution limitation excluding those countries, so that
+distribution is permitted only in or among countries not thus excluded. In
+such case, this License incorporates the limitation as if written in the body
+of this License.
+
+{\bf 13.} The Free Software Foundation may publish revised and/or new versions
+of the Lesser General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+specifies a version number of this License which applies to it and "any later
+version", you have the option of following the terms and conditions either of
+that version or of any later version published by the Free Software
+Foundation. If the Library does not specify a license version number, you may
+choose any version ever published by the Free Software Foundation.
+
+{\bf 14.} If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these, write to
+the author to ask for permission. For software which is copyrighted by the
+Free Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals of
+preserving the free status of all derivatives of our free software and of
+promoting the sharing and reuse of software generally.
+
+{\bf NO WARRANTY}
+
+{\bf 15.} BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE
+THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
+IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
+THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY
+PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
+
+{\bf 16.} IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO
+LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
+THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+END OF TERMS AND CONDITIONS
+
+\section{How to Apply These Terms to Your New Libraries}
+\label{SEC45}
+\index[general]{Libraries!How to Apply These Terms to Your New }
+\index[general]{How to Apply These Terms to Your New Libraries }
+
+
+If you develop a new library, and you want it to be of the greatest possible
+use to the public, we recommend making it free software that everyone can
+redistribute and change. You can do so by permitting redistribution under
+these terms (or, alternatively, under the terms of the ordinary General Public
+License).
+
+To apply these terms, attach the following notices to the library. It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+\begin{verbatim}
+{\it one line to give the library's name and an idea of what it does.}
+Copyright (C) {\it year} {\it name of author}
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
+USA
+\end{verbatim}
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary. Here is a sample; alter the names:
+
+\begin{verbatim}
+Yoyodyne, Inc., hereby disclaims all copyright interest in
+the library "Frob" (a library for tweaking knobs) written
+by James Random Hacker.
+{\it signature of Ty Coon}, 1 April 1990
+Ty Coon, President of Vice
+\end{verbatim}
+
+That's all there is to it!
+Return to
+\elink{GNU's home page}{http://www.gnu.org/home.html}.
+
+FSF \& GNU inquiries \& questions to
+\elink{gnu@gnu.org}{mailto:gnu@gnu.org}. Other
+\elink{ways to contact}{http://www.gnu.org/home.html\#ContactInfo} the FSF.
+
+Comments on these web pages to
+\elink{webmasters@www.gnu.org}{mailto:webmasters@www.gnu.org}, send other
+questions to
+\elink{gnu@gnu.org}{mailto:gnu@gnu.org}.
+
+Copyright notice above.
+Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+Boston, MA 02110-1301 USA
+USA
+
+Updated: 27 Nov 2000 paulv
projects / bacula / docs / commitdiff