]> git.sur5r.net Git - bacula/docs/blobdiff - docs/manuals/en/install/storedconf.tex
Update to separate manual versions
[bacula/docs] / docs / manuals / en / install / storedconf.tex
index 34133bf9dbd5be848fb85f69e5a39bc5f43a9f3a..b5d541967376728f3093085a292cf735707b1105 100644 (file)
@@ -99,14 +99,14 @@ have one and only one Storage resource definition.
    \index[general]{Client Connect Wait}
    This directive defines an interval of time in seconds that
    the Storage daemon will wait for a Client (the File daemon)
-   to connect.  The default is 30 seconds.  Be aware that the
+   to connect.  The default is 30 minutes.  Be aware that the
    longer the Storage daemon waits for a Client, the more
    resources will be tied up.
 
 \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
+   where \lt{}number\gt{} is the maximum number of Jobs that may 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
    request) is considered as a Job, so if you want to be able to do a {\bf
@@ -223,7 +223,7 @@ values in the Director's configuration file.
    Specifies the password that must be supplied by the above named  Director.
    This directive is required.  
 
-\item [Monitor = \lt{}yes|no\gt{}]
+\item [Monitor = \lt{}yes\vb{}no\gt{}]
    \index[sd]{Monitor}
    \index[sd]{Directive!Monitor}
    If Monitor is set to {\bf no} (default), this director will have full
@@ -289,13 +289,13 @@ specified within the Device resource are specific to the Device.
    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 directory,
-   and  the filename used will be the Volume name as specified in the  Catalog.
-   If you want to write into more than one directory (i.e.  to spread the load to
-   different disk drives), you will need to define  two Device resources, each
-   containing an Archive Device with a  different directory.  
+   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
+   directory, and the filename used will be the Volume name as specified in the
+   Catalog.  If you want to write into more than one directory (i.e.  to spread
+   the load to different disk drives), you will need to define two Device
+   resources, each containing an Archive Device with a different directory.
    \label{SetupFifo}
    In addition to a tape device name or a directory name, Bacula will  accept the
    name of a FIFO. A FIFO is a special kind of file that  connects two programs
@@ -409,7 +409,7 @@ Device {
    unique Media Type.
 
 \label{Autochanger}
-\item [Autochanger = {\it Yes|No}]
+\item [Autochanger = {\it yes\vb{}no}]
    \index[sd]{Autochanger}
    \index[sd]{Directive!Autochanger}
    If {\bf Yes}, this device belongs to an automatic tape changer, and you
@@ -465,21 +465,21 @@ Changer Command = "/path/mtx-changer %c %o %S %a %d"
 
 \item [Alert Command = {\it name-string}]
    \index[sd]{Alert Command}
-   The {\bf name-string} specifies an external program to be called  at the
+   The {\bf name-string} specifies an external program to be called at the
    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
-   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. 
+   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
+   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).  
+   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:  
@@ -518,7 +518,7 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    the past -- the default mtx-changer script works for any number of
    drives.
 
-\item [Autoselect = {\it Yes|No}]
+\item [Autoselect = {\it yes\vb{}no}]
    \index[sd]{Autoselect}
    \index[sd]{Directive!Autoselect}
    If this directive is set to {\bf yes} (default), and the Device
@@ -554,7 +554,7 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    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}]
+\item [Always Open = {\it yes\vb{}no}]
    \index[sd]{Always Open}
    \index[sd]{Directive!Always Open}
    If {\bf Yes} (default), Bacula will always keep the device open unless
@@ -570,10 +570,11 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    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.  
+   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}.  
@@ -607,7 +608,7 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    \ilink{description of Offline On Unmount}{NoTapeInDrive} in the Tape
    Testing chapter.
 
-\item [Close on Poll= {\it Yes|No}]
+\item [Close on Poll= {\it yes\vb{}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
@@ -628,7 +629,7 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    starts that needs the the drive.
 
 \label{removablemedia}
-\item [Removable media = {\it Yes|No}]
+\item [Removable media = {\it yes\vb{}no}]
    \index[sd]{Removable media}
    \index[sd]{Directive!Removable media}
    If {\bf Yes}, this device supports removable media (for example, tapes
@@ -653,7 +654,7 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    {\bf Removable Media}.    
 
 
-\item [Random access = {\it Yes|No}]
+\item [Random access = {\it yes\vb{}no}]
    \index[sd]{Random access}
    \index[sd]{Directive!Random access}
    If {\bf Yes}, the archive device is assumed to be a random access medium
@@ -663,7 +664,7 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    {\bf No} for non-random access devices such as tapes and named pipes.
 
 
-\item [Requires Mount = {\it Yes|No}]
+\item [Requires Mount = {\it yes\vb{}no}]
    \index[sd]{Requires Mount  }
    When this directive is enabled, the Storage daemon will submit
    a {\bf Mount Command} before attempting to open the device.
@@ -716,6 +717,7 @@ able to use a mount command such as:
 See the \ilink {Edit Codes}{mountcodes} section below for more details of
 the editing codes that can be used in this directive.
 
+  If you need to specify multiple commands, create a shell script.
 
 \item [Unmount Command = {\it name-string}]
    \index[sd]{Unmount Command}
@@ -735,6 +737,7 @@ the editing codes that can be used in this directive.
 See the \ilink {Edit Codes}{mountcodes} section below for more details of
 the editing codes that can be used in this directive.
 
+  If you need to specify multiple commands, create a shell script.
 
 \item [Minimum block size = {\it size-in-bytes}]
    \index[sd]{Minimum block size}
@@ -800,20 +803,23 @@ the editing codes that can be used in this directive.
    If no value is specified or zero is specified, the Storage daemon will
    use a default block size of 64,512 bytes (126 * 512).
 
-\item [Hardware End of Medium = {\it Yes|No}]
+   The maximum {\bf size-in-bytes} possible is 2,000,000.
+
+\item [Hardware End of Medium = {\it yes\vb{}no}]
    \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
-   device must support the {\tt ioctl}  {\tt MTEOM} call, which will position the
-   tape to the end of the  recorded data. In addition, your SCSI driver must keep
-   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 to
-   the end of the recorded data, but they do not  keep track of the file number.
-   On Linux machines, the SCSI driver  has a {\bf fast-eod} 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.  
+   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
+   device must support the {\tt ioctl} {\tt MTEOM} call, which will position
+   the tape to the end of the recorded data. In addition, your SCSI driver must
+   keep 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 to the end of the recorded data, but they do not keep track of the
+   file number.  On Linux machines, the SCSI driver has a {\bf fast-eod}
+   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
@@ -822,7 +828,7 @@ the editing codes that can be used in this directive.
    supports this function.  All modern (after 1998) tape drives support this
    feature.  
    
-\item [Fast Forward Space File = {\it Yes|No}]
+\item [Fast Forward Space File = {\it yes\vb{}no}]
    \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
@@ -836,7 +842,7 @@ the editing codes that can be used in this directive.
    
    Default setting for Fast Forward Space File is {\bf Yes}.
    
-\item [Use MTIOCGET = {\it Yes|No}]
+\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
@@ -848,40 +854,40 @@ the editing codes that can be used in this directive.
    on a few *BSD systems.  Operating systems known to work correctly are
    Solaris, Linux and FreeBSD.
 
-\item [BSF at EOM = {\it Yes|No}]
+\item [BSF at EOM = {\it yes\vb{}no}]
    \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.
-   However, on some  systems, such as FreeBSD, when Bacula reads the End of
-   Medium  (end of tape), the tape will be positioned after the second  EOF tape
-   mark (two successive EOF marks indicated End of  Medium). If Bacula appends
-   from that point, all the appended  data will be lost. The solution for such
-   systems is to  specify {\bf BSF at EOM} which causes Bacula to backspace  over
-   the second EOF mark. Determination of whether or not  you need this directive
-   is done using the {\bf test} command  in the {\bf btape} program.
-
-\item [TWO EOF = {\it Yes|No}]
+   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.
+   However, on some systems, such as FreeBSD, when Bacula reads the End of
+   Medium (end of tape), the tape will be positioned after the second EOF tape
+   mark (two successive EOF marks indicated End of Medium). If Bacula appends
+   from that point, all the appended data will be lost. The solution for such
+   systems is to specify {\bf BSF at EOM} which causes Bacula to backspace over
+   the second EOF mark. Determination of whether or not you need this directive
+   is done using the {\bf test} command in the {\bf btape} program.
+
+\item [TWO EOF = {\it yes\vb{}no}]
    \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. 
+   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}]
+\item [Backward Space Record = {\it yes\vb{}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
-   random-access  devices. This function if enabled is used at the end of a 
-   Volume after writing the end of file and any ANSI/IBM labels to determine whether
-   or not the last block was written correctly. If you turn this function off,
-   the test will not be done. This causes no harm as the re-read process is
-   precautionary rather than required.
-
-\item [Backward Space File = {\it Yes|No}]
+   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
+   random-access devices. This function if enabled is used at the end of a
+   Volume after writing the end of file and any ANSI/IBM labels to determine
+   whether or not the last block was written correctly. If you turn this
+   function off, the test will not be done. This causes no harm as the re-read
+   process is precautionary rather than required.
+
+\item [Backward Space File = {\it yes\vb{}no}]
    \index[sd]{Backward Space File}
    \index[sd]{Directive!Backward Space File}
    If {\it Yes}, the archive device supports the {\bf MTBSF} and  {\bf MTBSF
@@ -890,7 +896,7 @@ default, Bacula will only write  one end of file to terminate the tape.
   advanced forward to the desired position.  Default is {\bf Yes} for non
   random-access devices. 
 
-\item [Forward Space Record = {\it Yes|No}]
+\item [Forward Space Record = {\it yes\vb{}no}]
    \index[sd]{Forward Space Record}
    \index[sd]{Directive!Forward Space Record}
    If {\it Yes}, the archive device must support the {\bf MTFSR  ioctl} to
@@ -898,14 +904,14 @@ default, Bacula will only write  one end of file to terminate the tape.
    advance the position on the device. Default is  {\bf Yes} for non
    random-access devices. 
 
-\item [Forward Space File = {\it Yes|No}]
+\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. 
 
-\item [Offline On Unmount = {\it Yes|No}]
+\item [Offline On Unmount = {\it yes\vb{}no}]
    \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
@@ -927,6 +933,17 @@ default, Bacula will only write  one end of file to terminate the tape.
    \ilink{description of Offline On Unmount}{NoTapeInDrive} in the Tape
    Testing chapter.
 
+\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
+   \index[sd]{Device Maximum Concurrent Jobs}
+   \index[sd]{Directive!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 
+   the Maximum Concurrent Jobs limit is
+   reached, the Storage Daemon will start new Jobs on any other available
+   compatible drive.  This facilitates writing to multiple drives with
+   multiple Jobs that all use the same Pool.
 
 \item [Maximum Volume Size = {\it size}]
    \index[sd]{Maximum Volume Size}
@@ -958,6 +975,10 @@ default, Bacula will only write  one end of file to terminate the tape.
    you will generate lots of database records (JobMedia) and may
    significantly increase CPU/disk overhead.
 
+   If you are configuring an LTO-3 or LTO-4 tape, you probably will
+   want to set the {\bf Maximum File Size} to 2GB to avoid making
+   the drive stop to write an EOF mark.
+
    Note, this directive does not limit the size of Volumes that Bacula
    will create regardless of whether they are tape or disk volumes. It
    changes only the number of EOF marks on a tape and the number of
@@ -967,7 +988,7 @@ default, Bacula will only write  one end of file to terminate the tape.
    {\bf Maximum Volume Bytes} directive in the Director's Pool resource,
    which does the same thing but on a Pool (Volume) basis.
 
-\item [Block Positioning = {\it yes|no}]
+\item [Block Positioning = {\it yes\vb{}no}]
    \index[sd]{Block Positioning}
    \index[sd]{Directive!Block Positioning}
    This directive tells Bacula not to use block positioning when doing restores.
@@ -1000,8 +1021,8 @@ default, Bacula will only write  one end of file to terminate the tape.
 \item [Maximum Spool Size = {\it bytes}]
    \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. 
+   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}
@@ -1070,7 +1091,7 @@ apply to removable filesystems such as USB in addition to DVD.
 
 \begin{description}
 
-\item [Requires Mount = {\it Yes|No}]
+\item [Requires Mount = {\it yes\vb{}no}]
    \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
@@ -1099,6 +1120,29 @@ apply to removable filesystems such as USB in addition to DVD.
 \end{verbatim}
 \normalsize
 
+For some media, you may need multiple commands.  If so, it is recommended
+that you use a shell script instead of putting them all into the Mount
+Command.  For example, instead of this:
+
+\footnotesize
+\begin{verbatim}
+  Mount Command = "/usr/local/bin/mymount"
+\end{verbatim}
+\normalsize
+
+Where that script contains:
+
+\footnotesize
+\begin{verbatim}
+#!/bin/sh
+ndasadmin enable -s 1 -o w
+sleep 2
+mount /dev/ndas-00323794-0p1 /backup
+\end{verbatim}
+\normalsize
+
+Similar consideration should be given to all other Command parameters.
+
 \item [Unmount Command = {\it name-string}]
    \index[sd]{Unmount Command}
    \index[sd]{Directive!Unmount Command}
@@ -1114,6 +1158,8 @@ apply to removable filesystems such as USB in addition to DVD.
 \end{verbatim}
 \normalsize
 
+  If you need to specify multiple commands, create a shell script.
+
 \item [Write Part Command = {\it name-string}]
    \index[sd]{Write Part Command}
    \index[sd]{Directive!Write Part Command}
@@ -1137,6 +1183,8 @@ apply to removable filesystems such as USB in addition to DVD.
   in the default bacula-sd.conf file. To use it, simply remove
   the comment (\#) symbol.
 
+  If you need to specify multiple commands, create a shell script.
+
 
 \item [Free Space Command = {\it name-string}]
    \index[sd]{Free Space Command}
@@ -1166,6 +1214,8 @@ apply to removable filesystems such as USB in addition to DVD.
   If you do not set it, Bacula will expect there is always free space on the
   device. 
 
+  If you need to specify multiple commands, create a shell script.
+
 \end{description}
 
 %% This pulls in the Autochanger resource from another file.
@@ -1181,7 +1231,7 @@ apply to removable filesystems such as USB in addition to DVD.
 
 \begin{description}
 
-\item [Label media = {\it Yes|No}]
+\item [Label media = {\it yes\vb{}no}]
    \index[sd]{Label media}
    \index[sd]{Directive!Label media}
    If {\bf Yes}, permits this device to automatically label blank media
@@ -1192,7 +1242,7 @@ apply to removable filesystems such as USB in addition to DVD.
    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}]
+\item [Automatic mount = {\it yes\vb{}no}]
    \index[sd]{Automatic mount}
    \index[sd]{Directive!Automatic mount}
    If {\bf Yes} (the default), permits the daemon to examine the device to