\begin{description}
\item [Name = \lt{}Storage-Daemon-Name\gt{}]
- \index[sd]{Name }
+ \index[sd]{Name}
+ \index[sd]{Directive!Name}
Specifies the Name of the Storage daemon. This directive is required.
\item [Working Directory = \lt{}Directory\gt{}]
- \index[sd]{Working Directory }
+ \index[sd]{Working Directory}
+ \index[sd]{Directive!Working Directory}
This directive is mandatory and specifies a directory in which the Storage
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
required
\item [Pid Directory = \lt{}Directory\gt{}]
- \index[sd]{Pid Directory }
+ \index[sd]{Pid Directory}
+ \index[sd]{Directive!Pid Directory}
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.
Directory} as defined above.
\item [Heartbeat Interval = \lt{}time-interval\gt{}]
- \index[sd]{Heartbeat Interval }
+ \index[sd]{Heartbeat Interval}
+ \index[sd]{Directive!Heartbeat Interval}
\index[general]{Heartbeat Interval}
\index[general]{Broken pipe}
This directive defines an interval of time. When the Storage daemon is
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
\index[sd]{Maximum Concurrent Jobs}
+ \index[sd]{Directive!Maximum Concurrent Jobs}
where \lt{}number\gt{} is the maximum number of Jobs that should run
concurrently. The default is set to 10, but you may set it to a larger
number. Each contact from the Director (e.g. status request, job start
\item [SDAddresses = \lt{}IP-address-specification\gt{}]
\index[sd]{SDAddresses}
+ \index[sd]{Directive!SDAddresses}
Specify the ports and addresses on which the Storage daemon will listen
for Director connections. Normally, the default is sufficient and you
do not need to specify this directive. Probably the simplest way to
directives shown below.
\item [SDPort = \lt{}port-number\gt{}]
- \index[sd]{SDPort }
+ \index[sd]{SDPort}
+ \index[sd]{Directive!SDPort}
Specifies port number on which the Storage daemon listens for Director
connections. The default is 9103.
\item [SDAddress = \lt{}IP-Address\gt{}]
- \index[sd]{SDAddress }
- This directive is optional, and if it is specified, it will cause the Storage
- daemon server (for Director and File daemon 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 directive is not specified, the
- Storage daemon will bind to any available address (the default).
+ \index[sd]{SDAddress}
+ \index[sd]{Directive!SDAddress}
+ This directive is optional, and if it is specified, it will cause the
+ Storage daemon server (for Director and File daemon 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 directive is not
+ specified, the Storage daemon will bind to any available address (the
+ default).
\end{description}
\begin{description}
\item [Name = \lt{}Director-Name\gt{}]
- \index[sd]{Name }
+ \index[sd]{Name}
+ \index[sd]{Directive!Name}
Specifies the Name of the Director allowed to connect to the Storage daemon.
This directive is required.
\item [Password = \lt{}Director-password\gt{}]
- \index[sd]{Password }
+ \index[sd]{Password}
+ \index[sd]{Directive!Password}
Specifies the password that must be supplied by the above named Director.
This directive is required.
\item [Monitor = \lt{}yes|no\gt{}]
- \index[sd]{Monitor }
+ \index[sd]{Monitor}
+ \index[sd]{Directive!Monitor}
If Monitor is set to {\bf no} (default), this director will have full
access to this Storage daemon. If Monitor is set to {\bf yes}, this
director will only be able to fetch the current status of this Storage
\begin{description}
\item [Name = {\it Device-Name}]
- \index[sd]{Name }
+ \index[sd]{Name}
+ \index[sd]{Directive!Name}
Specifies the Name that the Director will use when asking to backup or
restore to or from to this device. This is the logical Device name, and may
be any string up to 127 characters in length. It is generally a good idea to
resource.
\item [Archive Device = {\it name-string}]
- \index[sd]{Archive Device }
+ \index[sd]{Archive Device}
+ \index[sd]{Directive!Archive Device}
The specified {\bf name-string} gives the system file name of the storage
device managed by this storage daemon. This will usually be the device file
name of a removable storage device (tape drive), for example "{\bf
\item [Device Type = {\it type-specification}]
\index[sd]{Device Type}
+ \index[sd]{Directive!Device Type}
The Device Type specification allows you to explicitly tell Bacula
what kind of device you are defining. It the {\it type-specification}
may be one of the following:
If the Device Type is not explicitly specified, then the mount point
must exist when the Storage daemon starts.
- This directive was implemented in Bacula version 1.39.5.
+ This directive was implemented in Bacula version 1.38.6.
\item [Media Type = {\it name-string}]
- \index[sd]{Media Type }
+ \index[sd]{Media Type}
+ \index[sd]{Directive!Media Type}
The specified {\bf name-string} names the type of media supported by this
device, for example, "DLT7000". Media type names are arbitrary in that you
set them to anything you want, but they must be known to the volume
\label{Autochanger}
\item [Autochanger = {\it Yes|No}]
\index[sd]{Autochanger}
+ \index[sd]{Directive!Autochanger}
If {\bf Yes}, this device belongs to an automatic tape changer, and you should also
specify a {\bf Changer Device} as well as a {\bf Changer Command}. If {\bf
No} (default), the volume must be manually changed. You should also
configuration file so that when labeling tapes you are prompted for the slot.
\item [Changer Device = {\it name-string}]
- \index[sd]{Changer Device }
+ \index[sd]{Changer Device}
+ \index[sd]{Directive!Changer Device}
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
autochanger directives.
\item [Changer Command = {\it name-string}]
- \index[sd]{Changer Command }
+ \index[sd]{Changer Command}
+ \index[sd]{Directive!Changer Command}
The {\bf name-string} specifies an external program to be called that will
automatically change volumes as required by {\bf Bacula}. Most frequently,
you will specify the Bacula supplied {\bf mtx-changer} script as follows:
scripts in {\bf examples/autochangers}.
\item [Alert Command = {\it name-string}]
- \index[sd]{Alert Command }
+ \index[sd]{Alert Command}
The {\bf name-string} specifies an external program to be called at the
+ \index[sd]{Directive!Changer Command}
completion of each Job after the device is released. The purpose of this
command is to check for Tape Alerts, which are present when something is
wrong with your tape drive (at least for most modern tape drives). The same
\item [Drive Index = {\it number}]
\index[sd]{Drive Index}
+ \index[sd]{Directive!Drive Index}
The {\bf Drive Index} that you specify is passed to the {\bf mtx-changer}
script and is thus passed to the {\bf mtx} program. By default, the Drive
Index is zero, so if you have only one drive in your autochanger, everything
\item [Autoselect = {\it Yes|No}]
\index[sd]{Autoselect}
+ \index[sd]{Directive!Autoselect}
If this directive is set to {\bf yes} (default), and the Device
belongs to an autochanger, then when the Autochanger is referenced
by the Director, this device can automatically be selected. If this
for reserving a drive for something special such as a high priority
backup or restore operations.
-\item [Maximum Changer Wait = {\it seconds}]
+\item [Maximum Changer Wait = {\it time}]
\index[sd]{Maximum Changer Wait}
+ \index[sd]{Directive!Maximum Changer Wait}
This directive specifies the maximum time in seconds for Bacula to wait
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.
- Please note that if you want to set your changer wait time to
- 10 minutes, you must specify:
-
-\begin{verbatim}
-Maximum Changer Wait = 600
-\end{verbatim}
-
- This directive will not accept qualifiers (such as "minutes").
-
-\item [Maximum Rewind Wait = {\it seconds}]
+\item [Maximum Rewind Wait = {\it time}]
\index[sd]{Maximum Rewind Wait}
+ \index[sd]{Directive!Maximum Rewind Wait}
This directive specifies the maximum time in seconds for Bacula to wait
for a rewind before timing out. If this time is exceeded,
Bacula will cancel the job. The default is 5 minutes.
-\item [Maximum Open Wait = {\it seconds}]
+\item [Maximum Open Wait = {\it time}]
\index[sd]{Maximum Open Wait}
+ \index[sd]{Directive!Maximum Open Wait}
This directive specifies the maximum time in seconds for Bacula to wait
for a open before timing out. If this time is exceeded,
Bacula will cancel the job. The default is 5 minutes.
\item [Always Open = {\it Yes|No}]
- \index[sd]{Always Open }
+ \index[sd]{Always Open}
+ \index[sd]{Directive!Always Open}
If {\bf Yes} (default), Bacula will always keep the device open unless
specifically {\bf unmounted} by the Console program. This permits
Bacula to ensure that the tape drive is always available. If you set
operation.
\item [Volume Poll Interval = {\it time}]
- \index[sd]{Volume Poll Interval }
+ \index[sd]{Volume Poll Interval}
+ \index[sd]{Directive!Volume Poll Interval}
If the time specified on this directive is non-zero, after asking the
operator to mount a new volume Bacula will periodically poll (or read) the
drive at the specified interval to see if a new volume has been mounted. If
\item [Close on Poll= {\it Yes|No}]
\index[sd]{Close on Poll}
+ \index[sd]{Directive!Close on Poll}
If {\bf Yes}, Bacula close the device (equivalent to an unmount except no
mount is required) and reopen it at each poll. Normally this is not too
useful unless you have the {\bf Offline on Unmount} directive set, in which
the drive on the next poll and automatically continue with the backup.
Please see above more more details.
-\item [Maximum Open Wait = {\it seconds}]
- \index[sd]{Maximum Open Wait }
+\item [Maximum Open Wait = {\it time}]
+ \index[sd]{Maximum Open Wait}
+ \index[sd]{Directive!Maximum Open Wait}
This directive specifies the maximum amount of time in seconds that
Bacula will wait for a device that is busy. The default is 5 minutes.
If the device cannot be obtained, the current Job will be terminated in
starts that needs the the drive.
\item [Removable media = {\it Yes|No}]
- \index[sd]{Removable media }
- If {\bf Yes}, this device supports removable media (for example, tapes or
- CDs). If {\bf No}, media cannot be removed (for example, an intermediate
- backup area on a hard disk).
+ \index[sd]{Removable media}
+ \index[sd]{Directive!Removable media}
+ If {\bf Yes}, this device supports removable media (for example, tapes
+ or CDs). If {\bf No}, media cannot be removed (for example, an
+ intermediate backup area on a hard disk).
\item [Random access = {\it Yes|No}]
- \index[sd]{Random access }
- If {\bf Yes}, the archive device is assumed to be a random access medium
- which supports the {\bf lseek} (or {\bf lseek64} if Largefile is enabled
- during configuration) facility.
+ \index[sd]{Random access}
+ \index[sd]{Directive!Random access}
+ If {\bf Yes}, the archive device is assumed to be a random access medium
+ which supports the {\bf lseek} (or {\bf lseek64} if Largefile is enabled
+ during configuration) facility.
\item [Minimum block size = {\it size-in-bytes}]
- \index[sd]{Minimum block size }
+ \index[sd]{Minimum block size}
+ \index[sd]{Directive!Minimum block size}
On most modern tape drives, you will not need or wamt to specify this
directive, and if you do so, it will be to make Bacula use fixed block
sizes. This statement applies only to non-random access devices (e.g.
\normalsize
\item [Maximum block size = {\it size-in-bytes}]
- \index[sd]{Maximum block size }
+ \index[sd]{Maximum block size}
+ \index[sd]{Directive!Maximum block size}
On most modern tape drives, you will not need to specify this directive.
If you do so, it will most likely be to use fixed block sizes (see
Minimum block size above). The Storage daemon will aways attempt to
use a default block size of 64,512 bytes (126 * 512).
\item [Hardware End of Medium = {\it Yes|No}]
- \index[sd]{Hardware End of Medium }
+ \index[sd]{Hardware End of Medium}
+ \index[sd]{Directive!Hardware End of Medium}
If {\bf No}, the archive device is not required to support end of medium
ioctl request, and the storage daemon will use the forward space file
function to find the end of the recorded data. If {\bf Yes}, the archive
feature.
\item [Fast Forward Space File = {\it Yes|No}]
- \index[sd]{Fast Forward Space File }
+ \index[sd]{Fast Forward Space File}
+ \index[sd]{Directive!Fast Forward Space File}
If {\bf No}, the archive device is not required to support keeping track of
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
Default setting for Fast Forward Space File is {\bf Yes}.
\item [Use MTIOCGET = {\it Yes|No}]
- \index[sd]{Fast Forward Space File }
+ \index[sd]{Fast Forward Space File}
+ \index[sd]{Directive!Fast Forward Space File}
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
Solaris, Linux and FreeBSD.
\item [BSF at EOM = {\it Yes|No}]
- \index[sd]{BSF at EOM }
+ \index[sd]{BSF at EOM}
+ \index[sd]{Directive!BSF at EOM}
If {\bf No}, the default, no special action is taken by Bacula with the End
of Medium (end of tape) is reached because the tape will be positioned after
the last EOF tape mark, and Bacula can append to the tape as desired.
is done using the {\bf test} command in the {\bf btape} program.
\item [TWO EOF = {\it Yes|No}]
- \index[sd]{TWO EOF }
+ \index[sd]{TWO EOF}
+ \index[sd]{Directive!TWO EOF}
If {\bf Yes}, Bacula will write two end of file marks when terminating a tape
-- i.e. after the last job or at the end of the medium. If {\bf No}, the
default, Bacula will only write one end of file to terminate the tape.
\item [Backward Space Record = {\it Yes|No}]
\index[sd]{Backward Space Record}
+ \index[sd]{Directive!Backward Space Record}
If {\it Yes}, the archive device supports the {\tt MTBSR ioctl} to backspace
records. If {\it No}, this call is not used and the device must be rewound
and advanced forward to the desired position. Default is {\bf Yes} for non
precautionary rather than required.
\item [Backward Space File = {\it Yes|No}]
- \index[sd]{Backward Space File }
+ \index[sd]{Backward Space File}
+ \index[sd]{Directive!Backward Space File}
If {\it Yes}, the archive device supports the {\bf MTBSF} and {\bf MTBSF
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
random-access devices.
\item [Forward Space Record = {\it Yes|No}]
- \index[sd]{Forward Space Record }
+ \index[sd]{Forward Space Record}
+ \index[sd]{Directive!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.
\item [Forward Space File = {\it Yes|No}]
- \index[sd]{Forward Space File }
+ \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.
\item [Offline On Unmount = {\it Yes|No}]
- \index[sd]{Offline On Unmount }
+ \index[sd]{Offline On Unmount}
+ \index[sd]{Directive!Offline On Unmount}
The default for this directive is {\bf No}. If {\bf Yes} the archive device
must support the {\tt MTOFFL ioctl} to rewind and take the volume offline. In
this case, Bacula will issue the offline (eject) request before closing the
\item [Maximum Volume Size = {\it size}]
- \index[sd]{Maximum Volume Size }
+ \index[sd]{Maximum Volume Size}
+ \index[sd]{Directive!Maximum Volume Size}
No more than {\bf size} bytes will be written onto a given volume on the
archive device. This directive is used mainly in testing Bacula to
simulate a small Volume. It can also be useful if you wish to limit the
Volume Bytes} defined in the Director's configuration file.
\item [Maximum File Size = {\it size}]
- \index[sd]{Maximum File Size }
+ \index[sd]{Maximum File Size}
+ \index[sd]{Directive!Maximum File Size}
No more than {\bf size} bytes will be written into a given logical file
on the volume. Once this size is reached, an end of file mark is
written on the volume and subsequent data are written into the next
Gigabyte.
\item [Block Positioning = {\it yes|no}]
- \index[sd]{Block Positioning }
+ \index[sd]{Block Positioning}
+ \index[sd]{Directive!Block Positioning}
This directive is not normally used (and has not yet been tested). It will
tell Bacula not to use block positioning when it is reading tapes. This can
cause Bacula to be {\bf extremely} slow when restoring files. You might use
hope, Bacula will be able to re-read your tapes.
\item [Maximum Network Buffer Size = {\it bytes}]
- \index[sd]{Maximum Network Buffer Size }
+ \index[sd]{Maximum Network Buffer Size}
+ \index[sd]{Directive!Maximum Network Buffer Size}
where {\it bytes} 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
\item [Maximum Spool Size = {\it bytes}]
- \index[sd]{Maximum Spool Size }
+ \index[sd]{Maximum Spool Size}
+ \index[sd]{Directive!Maximum Spool Size}
where the bytes specify the maximum spool size for all jobs that are running.
The default is no limit.
\item [Maximum Job Spool Size = {\it bytes}]
- \index[sd]{Maximum Job Spool Size }
+ \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.
This directive is implemented only in version 1.37 and later.
\item [Spool Directory = {\it directory}]
- \index[sd]{Spool Directory }
+ \index[sd]{Spool Directory}
+ \index[sd]{Directive!Spool 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 (DVD). The default is to use the
working directory.
\item [Maximum Part Size = {\it bytes}]
- \index[sd]{Maximum Part Size }
+ \index[sd]{Maximum Part Size}
+ \index[sd]{Directive!Maximum Part Size}
This is the maximum size of a volume part file. The default is no limit.
This directive is implemented only in version 1.37 and later.
\addcontentsline{toc}{subsection}{Devices that require a mount (DVD)}
All the directives in this section are implemented only in
-Bacula version 1.37 and later. As of version 1.39.5, the directives
+Bacula version 1.37 and later and hence are available in version 1.38.6.
+
+As of version 1.39.5, the directives
"Requires Mount", "Mount Point", "Mount Command", and "Unmount Command"
apply to removable filesystems such as USB in addition to DVD.
\begin{description}
\item [Requires Mount = {\it Yes|No}]
- \index[sd]{Requires Mount }
+ \index[sd]{Requires Mount}
+ \index[sd]{Directive!Requires Mount}
You must set this directive to {\bf yes} for DVD-writers, and to {\bf no} for
all other devices (tapes/files). This directive indicates if the device
requires to be mounted to be read, and if it must be written in a special way.
{\bf Write Part Command} directives must also be defined.
\item [Mount Point = {\it directory}]
- \index[sd]{Mount Point }
+ \index[sd]{Mount Point}
+ \index[sd]{Directive!Mount Point}
Directory where the device can be mounted.
\item [Mount Command = {\it name-string}]
- \index[sd]{Mount Command }
+ \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
Point.
\normalsize
\item [Unmount Command = {\it name-string}]
- \index[sd]{Unmount Command }
+ \index[sd]{Unmount Command}
+ \index[sd]{Directive!Unmount Command}
Command that must be executed to unmount the device. Before the command is
executed, \%a is replaced with the Archive Device, and \%m with the Mount
Point.
\normalsize
\item [Write Part Command = {\it name-string}]
- \index[sd]{Write Part Command }
+ \index[sd]{Write Part Command}
+ \index[sd]{Directive!Write Part Command}
Command that must be executed to write a part to the device. Before the
command is executed, \%a is replaced with the Archive Device, \%m with the
Mount Point, \%e is replaced with 1 if we are writing the first part,
\item [Free Space Command = {\it name-string}]
- \index[sd]{Free Space Command }
+ \index[sd]{Free Space Command}
+ \index[sd]{Directive!Free Space Command}
Command that must be executed to check how much free space is left on the
device. Before the command is executed,\%a is replaced with the Archive
Device, \%m with the Mount Point, \%e is replaced with 1 if we are writing
\begin{description}
\item [Label media = {\it Yes|No}]
- \index[sd]{Label media }
- If {\bf Yes}, permits this device to automatically label blank media without
- an explicit operator command. It does so by using an internal algorithm as
- defined on the
- \ilink{Label Format}{Label} record in each Pool resource. If
- this is {\bf No} as by default, Bacula will label tapes only by specific
- operator command ({\bf label} in the Console) or when the tape has been
- recycled. The automatic labeling feature is most useful when writing to disk
- rather than tape volumes.
+ \index[sd]{Label media}
+ \index[sd]{Directive!Label media}
+ If {\bf Yes}, permits this device to automatically label blank media
+ without an explicit operator command. It does so by using an internal
+ algorithm as defined on the \ilink{Label Format}{Label} record in each
+ Pool resource. If this is {\bf No} as by default, Bacula will label
+ tapes only by specific operator command ({\bf label} in the Console) or
+ when the tape has been recycled. The automatic labeling feature is most
+ useful when writing to disk rather than tape volumes.
\item [Automatic mount = {\it Yes|No}]
- \index[sd]{Automatic mount }
+ \index[sd]{Automatic mount}
+ \index[sd]{Directive!Automatic mount}
If {\bf Yes} (the default), permits the daemon to examine the device to
determine if it contains a Bacula labeled volume. This is done
initially when the daemon is started, and then at the beginning of each
projects / bacula / docs / blobdiff