]> git.sur5r.net Git - bacula/docs/blobdiff - docs/manuals/en/main/storedconf.tex
Improve Autochanger documentation
[bacula/docs] / docs / manuals / en / main / storedconf.tex
index 52bcbe530c16a7d8fa3b863214e882df04b1f788..23b3fdedd2b03700c08027bcc2f8f38d9d0a242f 100644 (file)
@@ -107,7 +107,7 @@ have one and only one Storage resource definition.
    \index[sd]{Maximum Concurrent Jobs}
    \index[sd]{Directive!Maximum Concurrent Jobs}
    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
+   concurrently.  The default is set to 20, 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
    status} request in the console at the same time as a Job is running, you
@@ -420,6 +420,10 @@ Device {
 \item [Changer Device = {\it name-string}]
    \index[sd]{Changer Device}
    \index[sd]{Directive!Changer Device}
+   Note: Eventhough this directive may be specified in the Device resource,
+   it is normally specified only in the {\bf Autochanger} resource.  It
+   is listed here for historical reasons.
+   \smallskip
    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
@@ -430,13 +434,17 @@ Device {
    /dev/sg0} for the Changer Device name. Depending on your exact
    configuration, and the number of autochangers or the type of
    autochanger, what you specify here can vary.  This directive is
-   optional.  See the \ilink{ Using Autochangers}{AutochangersChapter} chapter
+   optional.  See the \ilink{Using Autochangers}{AutochangersChapter} chapter
    of this manual for more details of using this and the following
    autochanger directives.
 
 \item [Changer Command = {\it name-string}]
    \index[sd]{Changer Command}
    \index[sd]{Directive!Changer Command}
+   Note: Eventhough this directive may be specified in the Device resource,
+   it is normally specified only in the {\bf Autochanger} resource.  It
+   is listed here for historical reasons.
+   \smallskip
    The {\bf name-string} specifies an external program to be called  that will
    automatically change volumes as required by {\bf Bacula}.  Normally,
    this directive will be specified only in the {\bf AutoChanger} resource,
@@ -500,6 +508,8 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
 \item [Drive Index = {\it number}]
    \index[sd]{Drive Index}
    \index[sd]{Directive!Drive Index}
+   This directive is only used for a Device that is part of an
+   Autochanger.
    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
@@ -525,8 +535,8 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    for reserving a drive for something special such as a high priority
    backup or restore operations.
 
-\item[Maximum Concurent Jobs = {\it num}]
-\index[sd]{MaximumConcurentJobs}
+\item[Maximum Concurrent Jobs = {\it num}]
+\index[sd]{MaximumConcurrentJobs}
 
 {\bf Maximum Concurrent Jobs} is a directive that permits setting the maximum
 number of Jobs that can run concurrently on a specified Device.  Using this
@@ -556,9 +566,11 @@ writing to multiple drives with multiple Jobs that all use the same Pool.
 \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.
+   This directive specifies the maximum 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
+   error.  Bacula will re-attempt to open the drive the next time a Job
+   starts that needs the the drive.
 
 \item [Always Open = {\it yes\vb{}no}]
    \index[sd]{Always Open}
@@ -567,15 +579,15 @@ writing to multiple drives with multiple Jobs that all use the same Pool.
    specifically {\bf unmounted} by the Console program.  This permits
    Bacula to ensure that the tape drive is always available, and properly
    positioned. If you set
-   {\bf AlwaysOpen} to {\bf no} {\bf Bacula} will only open the drive when
-   necessary, and at the end of the Job if no other Jobs are using the
-   drive, it will be freed.  The next time Bacula wants to append to a tape
-   on a drive that was freed, Bacula will rewind the tape and position it to
-   the end.  To avoid unnecessary tape positioning and to 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.
-   
+   {\bf AlwaysOpen} to {\bf no}, {\bf Bacula} will only open the
+   drive when necessary, and at the end of the Job if no other Jobs are
+   using the drive, it will be freed.  The next time Bacula wants to append
+   to a tape on a drive that was freed, Bacula will rewind the tape and
+   position it to the end.  To avoid unnecessary tape positioning and to
+   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
@@ -611,8 +623,8 @@ writing to multiple drives with multiple Jobs that all use the same Pool.
    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.
+   \borgxrlink{description of Offline On Unmount}{NoTapeInDrive}{problems}{subsection}
+   in the \borgxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}.
 
 \item [Close on Poll= {\it yes\vb{}no}]
    \index[sd]{Close on Poll}
@@ -625,15 +637,6 @@ writing to multiple drives with multiple Jobs that all use the same Pool.
    the drive on the next poll and  automatically continue with the backup. 
    Please see above more more details.
 
-\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
-   error.  Bacula will re-attempt to open the drive the next time a Job
-   starts that needs the the drive.
-
 \label{removablemedia}
 \item [Removable media = {\it yes\vb{}no}]
    \index[sd]{Removable media}
@@ -701,7 +704,7 @@ writing to multiple drives with multiple Jobs that all use the same Pool.
    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
+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.
@@ -721,7 +724,7 @@ the editing codes that can be used in this directive.
 \end{verbatim}
 \normalsize
 
-See the \ilink {Edit Codes}{mountcodes} section below for more details of
+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.
@@ -753,8 +756,8 @@ the editing codes that can be used in this directive.
    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
+   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. 
    
@@ -783,28 +786,28 @@ the editing codes that can be used in this directive.
 \begin{verbatim}
  
     Minimum block size = 64K
-    Maximum blocksize = 200K
+    Maximum blocksize = 256K
    
 \end{verbatim}
 \normalsize
 
-\item [Maximum block size = {\it size-in-bytes}]
-   \index[sd]{Maximum block size}
+\item [Maximum Block Size = {\it size-in-bytes}]
+   \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 always attempt to
-   write blocks of the specified {\bf size-in-bytes} to the archive device.
-   As a consequence, this statement specifies both the default block size
-   and the maximum block size.  The size written never exceed the given
-   {\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 you do so, it will most likely be to reduce shoe-shine and improve
+   performance on more modern LTO drives.  The Storage daemon will always
+   attempt to write blocks of the specified {\bf size-in-bytes} to the
+   archive device.  As a consequence, this statement specifies both the
+   default block size and the maximum block size.  The size written never
+   exceeds the given {\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).
 
-   The maximum {\bf size-in-bytes} possible is 2,000,000.
+   The maximum {\bf size-in-bytes} possible is 4,000,000.
 
 \item [Hardware End of Medium = {\it yes\vb{}no}]
    \index[sd]{Hardware End of Medium}
@@ -931,8 +934,8 @@ the editing codes that can be used in this directive.
    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.
+   \borgxrlink{description of Offline On Unmount}{NoTapeInDrive}{problems}{subsection}
+   in the \borgxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}.
 
 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
    \index[sd]{Device Maximum Concurrent Jobs}
@@ -1040,21 +1043,6 @@ the editing codes that can be used in this directive.
    writing to a device that requires mount (USB).  The default is to use the
    working directory. 
 
-\item [Maximum Part Size = {\it bytes}]
-   \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.
-
-   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.  
-
-   Otherwise, it is left on the hard disk.  
-
-   It is ignored for tape and FIFO devices.  
-
-
 \end{description}
 
 \label{mountcodes}
@@ -1062,8 +1050,8 @@ the editing codes that can be used in this directive.
 \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},
+or {\bf Free Space Command} directives
 to the operating system, Bacula performs character substitution of the
 following characters:
 
@@ -1074,7 +1062,6 @@ following characters:
     %e = erase (set if cannot mount and first part)
     %n = part number
     %m = mount point
-    %v = last part name (i.e. filename)
 \end{verbatim}
 \normalsize
 
@@ -1085,7 +1072,7 @@ following characters:
 All the directives in this section are implemented only in
 Bacula version 1.37 and later and hence are available in version 1.38.6.
 
-As of version 1.39.5, the directives
+The directives: 
 "Requires Mount", "Mount Point", "Mount Command", and "Unmount Command"
 apply to removable filesystems such as USB.
 
@@ -1098,8 +1085,8 @@ apply to removable filesystems such as USB.
    USB unless they are automounted, 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.  If it
-   set, {\bf Mount Point}, {\bf Mount Command}, {\bf Unmount Command} and
-   {\bf Write Part Command} directives must also be defined.
+   set, {\bf Mount Point}, {\bf Mount Command}, and {\bf Unmount Command}
+   directives must also be defined.
 
 \item [Mount Point = {\it directory}]
    \index[sd]{Mount Point}
@@ -1164,9 +1151,9 @@ Similar consideration should be given to all other Command parameters.
 \end{description}
 
 %% This pulls in the Autochanger resource from another file.
-\label{AutochangerRes}
-\label{AutochangerResource1}
-\input{autochangerres}
+%%\label{AutochangerRes}
+%%\label{AutochangerResource1}
+%%\input{autochangerres}
 
 \section{Capabilities}
 \index[general]{Capabilities}