]> git.sur5r.net Git - bacula/docs/blob - docs/manuals/en/main/storedconf.tex
Eliminate DVD specific directives -- WritePart ...
[bacula/docs] / docs / manuals / en / main / storedconf.tex
1 %%
2 %%
3
4 \chapter{Storage Daemon Configuration}
5 \label{StoredConfChapter}
6 \index[general]{Storage Daemon Configuration}
7 \index[general]{Configuration!Storage Daemon}
8
9 The Storage Daemon configuration file has relatively few resource definitions.
10 However, due to the great variation in backup media and system capabilities,
11 the storage daemon must be highly configurable. As a consequence, there are
12 quite a large number of directives in the Device Resource definition that
13 allow you to define all the characteristics of your Storage device (normally a
14 tape drive). Fortunately, with modern storage devices, the defaults are
15 sufficient, and very few directives are actually needed. 
16
17 Examples of {\bf Device} resource directives that are known to work for a
18 number of common tape drives can be found in the {\bf
19 \lt{}bacula-src\gt{}/examples/devices} directory, and most will also be listed
20 here. 
21
22 For a general discussion of configuration file and resources including the
23 data types recognized by {\bf Bacula}, please see the 
24 \ilink{Configuration}{ConfigureChapter} chapter of this manual. The
25 following Storage Resource definitions must be defined: 
26
27 \begin{itemize}
28 \item 
29    \ilink{Storage}{StorageResource} -- to define the  name of the
30    Storage daemon.  
31 \item 
32    \ilink{Director}{DirectorResource1} -- to  define the Director's
33    name and his access password.  
34 \item 
35    \ilink{Device}{DeviceResource} -- to define  the
36    characteristics of your storage device (tape  drive).  
37 \item 
38    \ilink{Messages}{MessagesChapter} -- to define where error  and
39    information messages are to be sent. 
40 \end{itemize}
41
42 \section{Storage Resource}
43 \label{StorageResource}
44 \index[general]{Resource!Storage}
45 \index[general]{Storage Resource}
46
47 In general, the properties specified under the Storage resource define global
48 properties of the Storage daemon. Each Storage daemon configuration file must
49 have one and only one Storage resource definition. 
50
51 \begin{description}
52
53 \item [Name = \lt{}Storage-Daemon-Name\gt{}]
54    \index[sd]{Name}
55    \index[sd]{Directive!Name}
56    Specifies the Name of the Storage daemon. This  directive is required. 
57
58 \item [Working Directory = \lt{}Directory\gt{}]
59    \index[sd]{Working Directory}
60    \index[sd]{Directive!Working Directory}
61    This directive  is mandatory and specifies a directory in which the Storage
62    daemon  may put its status files. This directory should be used only  by {\bf
63    Bacula}, but may be shared by other Bacula daemons provided the names
64    given to each daemon are unique. This  directive is
65    required  
66
67 \item [Pid Directory = \lt{}Directory\gt{}]
68    \index[sd]{Pid Directory}
69    \index[sd]{Directive!Pid Directory}
70    This directive  is mandatory and specifies a directory in which the Director 
71    may put its process Id file files. The process Id file is used to  shutdown
72    Bacula and to prevent multiple copies of  Bacula from running simultaneously. 
73    This directive is required. Standard shell expansion of the {\bf Directory} 
74    is done when the configuration file is read so that values such  as {\bf
75    \$HOME} will be properly expanded.  
76
77    Typically on Linux systems, you will set this to:  {\bf /var/run}. If you are
78    not installing Bacula in the  system directories, you can use the {\bf Working
79    Directory} as  defined above. 
80
81 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
82    \index[sd]{Heartbeat Interval}
83    \index[sd]{Directive!Heartbeat Interval}
84    \index[general]{Heartbeat Interval}
85    \index[general]{Broken pipe}
86    This directive defines an interval of time in seconds.  When
87    the Storage daemon is waiting for the operator to mount a
88    tape, each time interval, it will send a heartbeat signal to
89    the File daemon.  The default interval is zero which disables
90    the heartbeat.  This feature is particularly useful if you
91    have a router such as 3Com that does not follow Internet
92    standards and times out an valid connection after a short
93    duration despite the fact that keepalive is set.  This usually
94    results in a broken pipe error message.
95
96 \item [Client Connect Wait = \lt{}time-interval\gt{}]
97    \index[sd]{Connect Wait}
98    \index[sd]{Directive!Connect Wait}
99    \index[general]{Client Connect Wait}
100    This directive defines an interval of time in seconds that
101    the Storage daemon will wait for a Client (the File daemon)
102    to connect.  The default is 30 minutes.  Be aware that the
103    longer the Storage daemon waits for a Client, the more
104    resources will be tied up.
105
106 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
107    \index[sd]{Maximum Concurrent Jobs}
108    \index[sd]{Directive!Maximum Concurrent Jobs}
109    where \lt{}number\gt{} is the maximum number of Jobs that may run
110    concurrently.  The default is set to 10, but you may set it to a larger
111    number.  Each contact from the Director (e.g.  status request, job start
112    request) is considered as a Job, so if you want to be able to do a {\bf
113    status} request in the console at the same time as a Job is running, you
114    will need to set this value greater than 1.  To run simultaneous Jobs,
115    you will need to set a number of other directives in the Director's
116    configuration file.  Which ones you set depend on what you want, but you
117    will almost certainly need to set the {\bf Maximum Concurrent Jobs} in
118    the Storage resource in the Director's configuration file and possibly
119    those in the Job and Client resources.
120
121 \item [SDAddresses = \lt{}IP-address-specification\gt{}]
122    \index[sd]{SDAddresses}
123    \index[sd]{Directive!SDAddresses}
124    Specify the ports and addresses on which the Storage daemon will listen
125    for Director connections.  Normally, the default is sufficient and you
126    do not need to specify this directive.  Probably the simplest way to
127    explain how this directive works is to show an example:
128
129 \footnotesize
130 \begin{verbatim}
131  SDAddresses  = { ip = {
132         addr = 1.2.3.4; port = 1205; }
133     ipv4 = {
134         addr = 1.2.3.4; port = http; }
135     ipv6 = {
136         addr = 1.2.3.4;
137         port = 1205;
138     }
139     ip = {
140         addr = 1.2.3.4
141         port = 1205
142     }
143     ip = {
144         addr = 1.2.3.4
145     }
146     ip = {
147         addr = 201:220:222::2
148     }
149     ip = {
150         addr = bluedot.thun.net
151     }
152 }
153 \end{verbatim}
154 \normalsize
155
156 where ip, ip4, ip6, addr, and port are all keywords. Note, that  the address
157 can be specified as either a dotted quadruple, or  IPv6 colon notation, or as
158 a symbolic name (only in the ip specification).  Also, port can be specified
159 as a number or as the mnemonic value from  the /etc/services file.  If a port
160 is not specified, the default will be used. If an ip  section is specified,
161 the resolution can be made either by IPv4 or  IPv6. If ip4 is specified, then
162 only IPv4 resolutions will be permitted,  and likewise with ip6.  
163
164 Using this directive, you can replace both the SDPort and SDAddress 
165 directives shown below. 
166
167 \item [SDPort = \lt{}port-number\gt{}]
168    \index[sd]{SDPort}
169    \index[sd]{Directive!SDPort}
170    Specifies port number on which the Storage daemon  listens for Director
171    connections. The default is 9103.  
172    
173 \item [SDAddress = \lt{}IP-Address\gt{}]
174    \index[sd]{SDAddress}
175    \index[sd]{Directive!SDAddress}
176    This directive is optional, and if it is specified, it will cause the
177    Storage daemon server (for Director and File daemon connections) to bind
178    to the specified {\bf IP-Address}, which is either a domain name or an
179    IP address specified as a dotted quadruple.  If this directive is not
180    specified, the Storage daemon will bind to any available address (the
181    default).
182
183 \end{description}
184
185 The following is a typical Storage daemon Storage definition. 
186
187 \footnotesize
188 \begin{verbatim}
189 #
190 # "Global" Storage daemon configuration specifications appear
191 # under the Storage resource.
192 #
193 Storage {
194   Name = "Storage daemon"
195   Address = localhost
196   WorkingDirectory = "~/bacula/working"
197   Pid    Directory = "~/bacula/working"
198 }
199 \end{verbatim}
200 \normalsize
201
202 \section{Director Resource}
203 \label{DirectorResource1}
204 \index[general]{Director Resource}
205 \index[general]{Resource!Director}
206
207 The Director resource specifies the Name of the Director which is permitted
208 to use the services of the Storage daemon.  There may be multiple Director
209 resources.  The Director Name and Password must match the corresponding
210 values in the Director's configuration file.
211
212 \begin{description}
213
214 \item [Name = \lt{}Director-Name\gt{}]
215    \index[sd]{Name}
216    \index[sd]{Directive!Name}
217    Specifies the Name of the Director allowed to connect  to the Storage daemon.
218    This directive is required.  
219
220 \item [Password = \lt{}Director-password\gt{}]
221    \index[sd]{Password}
222    \index[sd]{Directive!Password}
223    Specifies the password that must be supplied by the above named  Director.
224    This directive is required.  
225
226 \item [Monitor = \lt{}yes\vb{}no\gt{}]
227    \index[sd]{Monitor}
228    \index[sd]{Directive!Monitor}
229    If Monitor is set to {\bf no} (default), this director will have full
230    access to this Storage daemon.  If Monitor is set to {\bf yes}, this
231    director will only be able to fetch the current status of this Storage
232    daemon.
233
234    Please note that if this director is being used by a Monitor, we highly 
235    recommend to set this directive to {\bf yes} to avoid serious security 
236    problems. 
237
238 \end{description}
239
240 The following is an example of a valid Director resource definition: 
241
242 \footnotesize
243 \begin{verbatim}
244 Director {
245   Name = MainDirector
246   Password = my_secret_password
247 }
248 \end{verbatim}
249 \normalsize
250
251 \label{DeviceResource}
252 \section{Device Resource}
253 \index[general]{Resource!Device}
254 \index[general]{Device Resource}
255
256 The Device Resource specifies the details of each device (normally a tape
257 drive) that can be used by the Storage daemon.  There may be multiple
258 Device resources for a single Storage daemon.  In general, the properties
259 specified within the Device resource are specific to the Device.
260
261 \begin{description}
262
263 \item [Name = {\it Device-Name}]
264    \index[sd]{Name}
265    \index[sd]{Directive!Name}
266    Specifies the Name that the Director will use when asking to backup or
267    restore to or from to this device. This is the logical  Device name, and may
268    be any string up to 127 characters in length.  It is generally a good idea to
269    make it correspond to the English  name of the backup device. The physical
270    name of the device is  specified on the {\bf Archive Device} directive
271    described below.  The name you specify here is also used in your Director's
272    conf  file on the 
273    \ilink{Device directive}{StorageResource2}  in its Storage
274    resource. 
275
276 \item [Archive Device = {\it name-string}]
277    \index[sd]{Archive Device}
278    \index[sd]{Directive!Archive Device}
279    The specified {\bf name-string} gives the system file name of the  storage
280    device managed by this storage daemon. This will usually be  the device file
281    name of a removable storage device (tape drive),  for example "{\bf
282    /dev/nst0}" or "{\bf /dev/rmt/0mbn}".  It may also be a directory name
283    if you are archiving to disk storage.  In this case, you must supply the
284    full absolute path to the directory.  When specifying a tape device, it
285    is preferable that the "non-rewind" variant of the device file name be
286    given.  In addition, on systems such as Sun, which have multiple tape
287    access methods, you must be sure to specify to use Berkeley I/O
288    conventions with the device.  The {\bf b} in the Solaris (Sun) archive
289    specification {\bf /dev/rmt/0mbn} is what is needed in this case.
290    Bacula does not support SysV tape drive behavior.
291    
292    As noted above, normally the Archive Device is the name of a tape drive, but
293    you may also specify an absolute path to an existing directory. If the
294    Device is a directory Bacula will write to file storage in the specified
295    directory, and the filename used will be the Volume name as specified in the
296    Catalog.  If you want to write into more than one directory (i.e.  to spread
297    the load to different disk drives), you will need to define two Device
298    resources, each containing an Archive Device with a different directory.
299    \label{SetupFifo}
300    In addition to a tape device name or a directory name, Bacula will  accept the
301    name of a FIFO. A FIFO is a special kind of file that  connects two programs
302    via kernel memory. If a FIFO device is specified  for a backup operation, you
303    must have a program that reads what Bacula  writes into the FIFO. When the
304    Storage daemon starts the job, it  will wait for {\bf MaximumOpenWait} seconds
305    for the read program to start reading, and then time it out and  terminate
306    the job. As a consequence, it is best to start the read  program at the
307    beginning of the job perhaps with the {\bf RunBeforeJob}  directive. For this
308    kind of device, you never want to specify  {\bf AlwaysOpen}, because you want
309    the Storage daemon to open it only  when a job starts, so you must explicitly
310    set it to {\bf No}.  Since a FIFO is a one way device, Bacula will not attempt
311    to read  a label of a FIFO device, but will simply write on it. To create a 
312    FIFO Volume in the catalog, use the {\bf add} command rather than the {\bf
313    label} command to avoid attempting to write a label.
314
315 \footnotesize
316 \begin{verbatim}
317 Device {
318   Name = FifoStorage
319   Media Type = Fifo
320   Device Type = Fifo
321   Archive Device = /tmp/fifo
322   LabelMedia = yes
323   Random Access = no
324   AutomaticMount = no
325   RemovableMedia = no
326   MaximumOpenWait = 60
327   AlwaysOpen = no
328 }
329 \end{verbatim}
330 \normalsize
331
332    During a restore operation, if the Archive Device is a FIFO, Bacula  will
333    attempt to read from the FIFO, so you must have an external program  that
334    writes into the FIFO. Bacula will wait {\bf MaximumOpenWait} seconds  for the
335    program to begin writing and will then time it out and  terminate the job. As
336    noted above, you may use the {\bf RunBeforeJob}  to start the writer program
337    at the beginning of the job.  
338    
339    The Archive Device directive is required. 
340
341 \item [Device Type = {\it type-specification}]
342    \index[sd]{Device Type}
343    \index[sd]{Directive!Device Type}
344    The Device Type specification allows you to explicitly tell Bacula
345    what kind of device you are defining. It the {\it type-specification}
346    may be one of the following:
347    \begin{description}
348    \item [File]
349      Tells Bacula that the device is a file. It may either be a
350      file defined on fixed medium or a removable filesystem such as
351      USB.  All files must be random access devices.
352    \item [Tape]
353      The device is a tape device and thus is sequential access. Tape devices
354      are controlled using ioctl() calls.
355    \item [Fifo]
356      The device is a first-in-first out sequential access read-only 
357      or write-only device.
358   \end{description}
359   
360   The Device Type directive is not required, and if not specified, Bacula
361   will attempt to guess what kind of device has been specified using the
362   Archive Device specification supplied. There are several advantages to
363   explicitly specifying the Device Type. First, on some systems, block and
364   character devices have the same type.
365   Secondly, if you explicitly specify the Device Type, the mount point
366   need not be defined until the device is opened. This is the case with
367   most removable devices such as USB that are mounted by the HAL daemon.
368   If the Device Type is not explicitly specified, then the mount point
369   must exist when the Storage daemon starts.
370
371   This directive was implemented in Bacula version 1.38.6.
372
373
374 \item [Media Type = {\it name-string}]
375    \index[sd]{Media Type}
376    \index[sd]{Directive!Media Type}
377    The specified {\bf name-string} names the type of media supported by this
378    device, for example, "DLT7000".  Media type names are arbitrary in that you
379    set them to anything you want, but they must be known to the volume
380    database to keep track of which storage daemons can read which volumes.  In
381    general, each different storage type should have a unique Media Type
382    associated with it.  The same {\bf name-string} must appear in the
383    appropriate Storage resource definition in the Director's configuration
384    file.
385    
386    Even though the names you assign are arbitrary (i.e.  you choose the name
387    you want), you should take care in specifying them because the Media Type
388    is used to determine which storage device Bacula will select during
389    restore.  Thus you should probably use the same Media Type specification
390    for all drives where the Media can be freely interchanged.  This is not
391    generally an issue if you have a single Storage daemon, but it is with
392    multiple Storage daemons, especially if they have incompatible media.
393    
394    For example, if you specify a Media Type of "DDS-4" then during the
395    restore, Bacula will be able to choose any Storage Daemon that handles
396    "DDS-4".  If you have an autochanger, you might want to name the Media Type
397    in a way that is unique to the autochanger, unless you wish to possibly use
398    the Volumes in other drives.  You should also ensure to have unique Media
399    Type names if the Media is not compatible between drives.  This
400    specification is required for all devices.
401
402    In addition, if you are using disk storage, each Device resource will
403    generally have a different mount point or directory. In order for
404    Bacula to select the correct Device resource, each one must have a
405    unique Media Type.
406
407 \label{Autochanger}
408 \item [Autochanger = {\it yes\vb{}no}]
409    \index[sd]{Autochanger}
410    \index[sd]{Directive!Autochanger}
411    If {\bf Yes}, this device belongs to an automatic tape changer, and you
412    must specify an {\bf Autochanger} resource that points to the {\bf
413    Device} resources.  You must also specify a 
414    {\bf Changer Device}.  If the Autochanger directive is set to {\bf
415    No} (default), the volume must be manually changed.  You should also
416    have an identical directive to the  
417    \ilink{Storage resource}{Autochanger1}  in the Director's
418    configuration file so that  when labeling tapes you are prompted for the slot.
419
420 \item [Changer Device = {\it name-string}]
421    \index[sd]{Changer Device}
422    \index[sd]{Directive!Changer Device}
423    The specified {\bf name-string} must be the {\bf generic SCSI} device
424    name of the autochanger that corresponds to the normal read/write
425    {\bf Archive Device}  specified in the Device resource. This
426    generic SCSI device name should be specified if you have an autochanger 
427    or if you have a standard tape drive and want to use the
428    {\bf Alert Command} (see below). For example, on Linux systems, for 
429    an Archive Device name of {\bf /dev/nst0}, you would specify {\bf
430    /dev/sg0} for the Changer Device name. Depending on your exact
431    configuration, and the number of autochangers or the type of
432    autochanger, what you specify here can vary.  This directive is
433    optional.  See the \ilink{Using Autochangers}{AutochangersChapter} chapter
434    of this manual for more details of using this and the following
435    autochanger directives.
436
437 \item [Changer Command = {\it name-string}]
438    \index[sd]{Changer Command}
439    \index[sd]{Directive!Changer Command}
440    The {\bf name-string} specifies an external program to be called  that will
441    automatically change volumes as required by {\bf Bacula}.  Normally,
442    this directive will be specified only in the {\bf AutoChanger} resource,
443    which is then used for all devices.  However, you may also specify
444    the different {\bf Changer Command} in each Device resource.
445    Most frequently,
446    you will specify the Bacula supplied {\bf mtx-changer}  script as follows:  
447
448 \footnotesize
449 \begin{verbatim}
450 Changer Command = "/path/mtx-changer %c %o %S %a %d"
451 \end{verbatim}
452 \normalsize
453
454    and you will install the {\bf mtx} on your system (found  in the {\bf depkgs}
455    release). An example of this command is in the default bacula-sd.conf file. 
456    For more details on the substitution characters that may be specified  to
457    configure your autochanger please see  the 
458    \ilink{Autochangers}{AutochangersChapter} chapter of this  manual.
459    For FreeBSD users, you might want to see one of the  several {\bf chio}
460    scripts in {\bf examples/autochangers}.  
461
462 \item [Alert Command = {\it name-string}]
463    \index[sd]{Alert Command}
464    The {\bf name-string} specifies an external program to be called at the
465    completion of each Job after the device is released.  The purpose of this
466    command is to check for Tape Alerts, which are present when something is
467    wrong with your tape drive (at least for most modern tape drives).  The same
468    substitution characters that may be specified in the Changer Command may
469    also be used in this string.  For more information, please see the
470    \ilink{Autochangers}{AutochangersChapter} chapter of this manual.
471    
472    
473    Note, it is not necessary to have an autochanger to use this command. The
474    example below uses the {\bf tapeinfo} program that comes with the {\bf mtx}
475    package, but it can be used on any tape drive. However, you will need to
476    specify a {\bf Changer Device} directive in your Device resource (see above)
477    so that the generic SCSI device name can be edited into the command (with
478    the \%c).
479    
480    An example of the use of this command to print Tape Alerts  in the Job report
481    is:  
482
483 \footnotesize
484 \begin{verbatim}
485 Alert Command = "sh -c 'tapeinfo -f %c | grep TapeAlert'"
486       
487 \end{verbatim}
488 \normalsize
489
490 and an example output when there is a problem could be:  
491
492 \footnotesize
493 \begin{verbatim}
494 bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
495                   between tape drive and initiator.
496       
497 \end{verbatim}
498 \normalsize
499
500 \item [Drive Index = {\it number}]
501    \index[sd]{Drive Index}
502    \index[sd]{Directive!Drive Index}
503    The {\bf Drive Index} that you specify is passed to the {\bf
504    mtx-changer} script and is thus passed to the {\bf mtx} program.  By
505    default, the Drive Index is zero, so if you have only one drive in your
506    autochanger, everything will work normally.  However, if you have
507    multiple drives, you must specify multiple Bacula Device resources (one
508    for each drive).  The first Device should have the Drive Index set to 0,
509    and the second Device Resource should contain a Drive Index set to 1,
510    and so on.  This will then permit you to use two or more drives in your
511    autochanger.  As of Bacula version 1.38.0, using the {\bf Autochanger}
512    resource, Bacula will automatically ensure that only one drive at a time
513    uses the autochanger script, so you no longer need locking scripts as in
514    the past -- the default mtx-changer script works for any number of
515    drives.
516
517 \item [Autoselect = {\it yes\vb{}no}]
518    \index[sd]{Autoselect}
519    \index[sd]{Directive!Autoselect}
520    If this directive is set to {\bf yes} (default), and the Device
521    belongs to an autochanger, then when the Autochanger is referenced
522    by the Director, this device can automatically be selected. If this
523    directive is set to {\bf no}, then the Device can only be referenced
524    by directly using the Device name in the Director. This is useful
525    for reserving a drive for something special such as a high priority
526    backup or restore operations.
527
528 \item[Maximum Concurrent Jobs = {\it num}]
529 \index[sd]{MaximumConcurrentJobs}
530
531 {\bf Maximum Concurrent Jobs} is a directive that permits setting the maximum
532 number of Jobs that can run concurrently on a specified Device.  Using this
533 directive, it is possible to have different Jobs using multiple drives, because
534 when the Maximum Concurrent Jobs limit is reached, the Storage Daemon will
535 start new Jobs on any other available compatible drive.  This facilitates
536 writing to multiple drives with multiple Jobs that all use the same Pool.
537
538 \item [Maximum Changer Wait = {\it time}]
539    \index[sd]{Maximum Changer Wait}
540    \index[sd]{Directive!Maximum Changer Wait}
541    This directive specifies the maximum time in seconds for Bacula to wait
542    for an autochanger to change the volume.  If this time is exceeded,
543    Bacula will invalidate the Volume slot number stored in the catalog and
544    try again.  If no additional changer volumes exist, Bacula will ask the
545    operator to intervene.  The default is 5 minutes.      
546 % TODO: if this is the format, then maybe "5 minutes" should be in
547 % TODO: quotes? define style. see others.
548
549 \item [Maximum Rewind Wait = {\it time}]
550    \index[sd]{Maximum Rewind Wait}
551    \index[sd]{Directive!Maximum Rewind Wait}
552    This directive specifies the maximum time in seconds for Bacula to wait
553    for a rewind before timing out.  If this time is exceeded,
554    Bacula will cancel the job.  The default is 5 minutes.
555
556 \item [Maximum Open Wait = {\it time}]
557    \index[sd]{Maximum Open Wait}
558    \index[sd]{Directive!Maximum Open Wait}
559    This directive specifies the maximum time in seconds for Bacula to wait
560    for a open before timing out.  If this time is exceeded,
561    Bacula will cancel the job.  The default is 5 minutes.
562
563 \item [Always Open = {\it yes\vb{}no}]
564    \index[sd]{Always Open}
565    \index[sd]{Directive!Always Open}
566    If {\bf Yes}, Bacula will always keep the device open unless
567    specifically {\bf unmounted} by the Console program.  This permits
568    Bacula to ensure that the tape drive is always available, and properly
569    positioned. If you set
570    {\bf AlwaysOpen} to {\bf no} (default) {\bf Bacula} will only open the
571    drive when necessary, and at the end of the Job if no other Jobs are
572    using the drive, it will be freed.  The next time Bacula wants to append
573    to a tape on a drive that was freed, Bacula will rewind the tape and
574    position it to the end.  To avoid unnecessary tape positioning and to
575    minimize unnecessary operator intervention, it is highly recommended
576    that {\bf Always Open = yes}.  This also ensures that the drive is
577    available when Bacula needs it.
578    
579    If you have {\bf Always Open = yes} (recommended) and you want to use the
580    drive for something else, simply use the {\bf unmount} command in the
581    Console program to release the drive. However, don't forget to remount the
582    drive with {\bf mount} when the drive is available or the next Bacula job
583    will block.
584    
585    For File storage, this directive is ignored. For a FIFO storage  device, you
586    must set this to {\bf No}.  
587    
588    Please note that if you set this directive to {\bf No} Bacula  will release
589    the tape drive between each job, and thus the next job  will rewind the tape
590    and position it to the end of the data. This  can be a very time consuming
591    operation. In addition, with this directive set to no, certain multiple
592    drive autochanger operations will fail.  We strongly recommend to keep
593    {\bf Always Open} set to {\bf Yes}
594
595 \item [Volume Poll Interval = {\it time}]
596    \index[sd]{Volume Poll Interval}
597    \index[sd]{Directive!Volume Poll Interval}
598    If the time  specified on this directive is non-zero, after  asking the
599    operator to mount a new volume Bacula will  periodically poll (or read) the
600    drive at the specified  interval to see if a new volume has been mounted. If
601    the  time interval is zero (the default), no polling will occur.  This
602    directive can be useful if you want to avoid operator  intervention via the
603    console. Instead, the operator can  simply remove the old volume and insert
604    the requested one,  and Bacula on the next poll will recognize the new tape
605    and  continue. Please be aware that if you set this interval  too small, you
606    may excessively wear your tape drive if the  old tape remains in the drive,
607    since Bacula will read it on  each poll. This can be avoided by ejecting the
608    tape using  the {\bf Offline On Unmount} and the {\bf Close on Poll} 
609    directives. 
610    However, if you are using a Linux 2.6 kernel or other OSes
611    such as FreeBSD or Solaris, the Offline On Unmount will leave the drive
612    with no tape, and Bacula will not be able to properly open the drive and
613    may fail the job.  For more information on this problem, please see the
614    \borgxrlink{description of Offline On Unmount}{NoTapeInDrive}{problems}{subsection}
615    in the \borgxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}.
616
617 \item [Close on Poll= {\it yes\vb{}no}]
618    \index[sd]{Close on Poll}
619    \index[sd]{Directive!Close on Poll}
620    If {\bf Yes}, Bacula close the device (equivalent to  an unmount except no
621    mount is required) and reopen it at each  poll. Normally this is not too
622    useful unless you have the  {\bf Offline on Unmount} directive set, in which
623    case the  drive will be taken offline preventing wear on the tape  during any
624    future polling. Once the operator inserts a new  tape, Bacula will recognize
625    the drive on the next poll and  automatically continue with the backup. 
626    Please see above more more details.
627
628 \item [Maximum Open Wait = {\it time}]
629    \index[sd]{Maximum Open Wait}
630    \index[sd]{Directive!Maximum Open Wait}
631    This directive specifies the maximum amount of time in seconds that
632    Bacula will wait for a device that is busy.  The default is 5 minutes.
633    If the device cannot be obtained, the current Job will be terminated in
634    error.  Bacula will re-attempt to open the drive the next time a Job
635    starts that needs the the drive.
636
637 \label{removablemedia}
638 \item [Removable media = {\it yes\vb{}no}]
639    \index[sd]{Removable media}
640    \index[sd]{Directive!Removable media}
641    If {\bf Yes}, this device supports removable media (for example, tapes
642    or CDs).  If {\bf No}, media cannot be removed (for example, an
643    intermediate backup area on a hard disk). If {\bf Removable media} is
644    enabled on a File device (as opposed to a tape) the Storage daemon will
645    assume that device may be something like a USB device that can be
646    removed or a simply a removable harddisk. When attempting to open
647    such a device, if the Volume is not found (for File devices, the Volume
648    name is the same as the Filename), then the Storage daemon will search
649    the entire device looking for likely Volume names, and for each one 
650    found, it will ask the Director if the Volume can be used.  If so,
651    the Storage daemon will use the first such Volume found.  Thus it
652    acts somewhat like a tape drive -- if the correct Volume is not found,
653    it looks at what actually is found, and if it is an appendable Volume,
654    it will use it.
655
656    If the removable medium is not automatically mounted (e.g. udev), then
657    you might consider using additional Storage daemon device directives
658    such as {\bf Requires Mount}, {\bf Mount Point}, {\bf Mount Command},
659    and {\bf Unmount Command}, all of which can be used in conjunction with
660    {\bf Removable Media}.    
661
662
663 \item [Random access = {\it yes\vb{}no}]
664    \index[sd]{Random access}
665    \index[sd]{Directive!Random access}
666    If {\bf Yes}, the archive device is assumed to be a random access medium
667    which supports the {\bf lseek} (or {\bf lseek64} if Largefile is enabled
668    during configuration) facility. This should be set to {\bf Yes} for all
669    file systems such as USB, and fixed files.  It should be set to
670    {\bf No} for non-random access devices such as tapes and named pipes.
671
672
673 \item [Requires Mount = {\it yes\vb{}no}]
674    \index[sd]{Requires Mount  }
675    When this directive is enabled, the Storage daemon will submit
676    a {\bf Mount Command} before attempting to open the device.
677    You must set this directive to {\bf yes} for removable
678    file systems such as USB devices that are not automatically mounted
679    by the operating system when plugged in or opened by Bacula.
680    It should be set to {\bf no} for
681    all other devices such as tapes and fixed filesystems. It should also
682    be set to {\bf no} for any removable device that is automatically
683    mounted by the operating system when opened (e.g. USB devices mounted
684    by udev or hotplug). This directive
685    indicates if the device requires to be mounted using the {\bf Mount
686    Command}.  To be able to write devices need a mount, the following
687    directives must also be defined: {\bf Mount Point}, {\bf Mount Command},
688    and {\bf Unmount Command}.
689
690 \item [Mount Point = {\it directory}]
691    \index[sd]{Mount Point}
692    Directory where the device can be mounted. 
693    This directive is used only
694    for devices that have {\bf Requires Mount} enabled such as 
695    USB file devices.
696
697 \item [Mount Command = {\it name-string}]
698    \index[sd]{Mount Command}
699    This directive specifies the command that must be executed to mount 
700    devices such as many USB devices. Before the command is 
701    executed, \%a is replaced with the Archive Device, and \%m with the Mount 
702    Point.
703
704 See the \ilink{Edit Codes}{mountcodes} section below for more details of
705 the editing codes that can be used in this directive.
706
707   If you need to specify multiple commands, create a shell script.
708
709 \item [Unmount Command = {\it name-string}]
710    \index[sd]{Unmount Command}
711    This directive specifies the command that must be executed to unmount 
712    devices such as many USB devices. Before the command  is
713    executed, \%a is replaced with the Archive Device, and \%m with the  Mount
714    Point.
715
716    Most frequently, you will define it as follows:  
717
718 \footnotesize
719 \begin{verbatim}
720   Unmount Command = "/bin/umount %m"
721 \end{verbatim}
722 \normalsize
723
724 See the \ilink{Edit Codes}{mountcodes} section below for more details of
725 the editing codes that can be used in this directive.
726
727   If you need to specify multiple commands, create a shell script.
728
729 \item[Block Checksum = {\it yes/no}]
730
731   You may turn off the Block Checksum (CRC32) code that Bacula uses when
732   writing blocks to a Volume. Doing so can reduce the Storage daemon CPU usage
733   slightly.  It will also permit Bacula to read a Volume that has corrupted
734   data.
735
736   The default is {\bf yes} -- i.e. the checksum is computed on write and
737   checked on read.
738
739   \textbf{We do not recommend to turn this off} particularly on older tape
740   drives or for disk Volumes where doing so may allow corrupted data to go
741   undetected.
742
743 \item [Minimum block size = {\it size-in-bytes}]
744    \index[sd]{Minimum block size}
745    \index[sd]{Directive!Minimum block size}
746    On most modern tape drives, you will not need or want to specify this
747    directive, and if you do so, it will be to make Bacula use fixed block
748    sizes.  This statement applies only to non-random access devices (e.g.
749    tape drives).  Blocks written by the storage daemon to a non-random
750    archive device will never be smaller than the given {\bf size-in-bytes}.
751    The Storage daemon will attempt to efficiently fill blocks with data
752    received from active sessions but will, if necessary, add padding to a
753    block to achieve the required minimum size.
754    
755    To force the block size to be fixed, as is the case for some non-random
756    access devices (tape drives), set the {\bf Minimum block size} and the
757    {\bf Maximum block size} to the same value (zero included).  The default
758    is that both the minimum and maximum block size are zero and the default
759    block size is 64,512 bytes. 
760    
761    For  example, suppose you want a fixed block size of 100K bytes, then you 
762    would specify:  
763
764 \footnotesize
765 \begin{verbatim}
766  
767     Minimum block size = 100K
768     Maximum block size = 100K
769     
770 \end{verbatim}
771 \normalsize
772
773    Please note that if you specify a fixed block size as shown above,  the tape
774    drive must either be in variable block size mode, or  if it is in fixed block
775    size mode, the block size (generally  defined by {\bf mt}) {\bf must} be
776    identical to the size specified  in Bacula -- otherwise when you attempt to
777    re-read your Volumes,  you will get an error.  
778    
779    If you want the  block size to be variable but with a 64K minimum and 200K
780    maximum (and  default as well), you would specify:  
781
782 \footnotesize
783 \begin{verbatim}
784  
785     Minimum block size = 64K
786     Maximum blocksize = 200K
787    
788 \end{verbatim}
789 \normalsize
790
791 \item [Maximum block size = {\it size-in-bytes}]
792    \index[sd]{Maximum block size}
793    \index[sd]{Directive!Maximum block size}
794    On most modern tape drives, you will not need to specify this directive.
795    If you do so, it will most likely be to use fixed block sizes (see
796    Minimum block size above).  The Storage daemon will always attempt to
797    write blocks of the specified {\bf size-in-bytes} to the archive device.
798    As a consequence, this statement specifies both the default block size
799    and the maximum block size.  The size written never exceed the given
800    {\bf size-in-bytes}.  If adding data to a block would cause it to exceed
801    the given maximum size, the block will be written to the archive device,
802    and the new data will begin a new block.
803    
804    If no value is specified or zero is specified, the Storage daemon will
805    use a default block size of 64,512 bytes (126 * 512).
806
807    The maximum {\bf size-in-bytes} possible is 2,000,000.
808
809 \item [Hardware End of Medium = {\it yes\vb{}no}]
810    \index[sd]{Hardware End of Medium}
811    \index[sd]{Directive!Hardware End of Medium}
812    If {\bf No}, the archive device is not required to support end of medium
813    ioctl request, and the storage daemon will use the forward space file
814    function to find the end of the recorded data. If {\bf Yes}, the archive
815    device must support the {\tt ioctl} {\tt MTEOM} call, which will position
816    the tape to the end of the recorded data. In addition, your SCSI driver must
817    keep track of the file number on the tape and report it back correctly by
818    the {\bf MTIOCGET} ioctl. Note, some SCSI drivers will correctly forward
819    space to the end of the recorded data, but they do not keep track of the
820    file number.  On Linux machines, the SCSI driver has a {\bf fast-eod}
821    option, which if set will cause the driver to lose track of the file
822    number. You should ensure that this option is always turned off using the
823    {\bf mt} program.
824    
825    Default setting for Hardware End of Medium is {\bf Yes}. This  function is
826    used before appending to a tape to ensure that no  previously written data is
827    lost. We recommend if you have a non-standard or unusual tape drive that you
828    use the {\bf btape} program  to test your drive to see whether or not it
829    supports this function.  All modern (after 1998) tape drives support this
830    feature.  
831    
832 \item [Fast Forward Space File = {\it yes\vb{}no}]
833    \index[sd]{Fast Forward Space File}
834    \index[sd]{Directive!Fast Forward Space File}
835    If {\bf No}, the archive device is not required to support  keeping track of
836    the file number ({\bf MTIOCGET} ioctl) during  forward space file. If {\bf
837    Yes}, the archive device must support  the {\tt ioctl} {\tt MTFSF} call, which
838    virtually all drivers  support, but in addition, your SCSI driver must keep
839    track of the  file number on the tape and report it back correctly by the 
840    {\bf MTIOCGET} ioctl. Note, some SCSI drivers will correctly  forward space,
841    but they do not keep track of the file number or more  seriously, they do not
842    report end of medium.  
843    
844    Default setting for Fast Forward Space File is {\bf Yes}.
845    
846 \item [Use MTIOCGET = {\it yes\vb{}no}]
847    \index[sd]{Use MTIOCGET}
848    \index[sd]{Directive!Use MTIOCGET}
849    If {\bf No}, the operating system is not required to support keeping track of
850    the file number and reporting it in the ({\bf MTIOCGET} ioctl). The default
851    is {\bf Yes}. If you must set this to No, Bacula will do the proper file
852    position determination, but it is very unfortunate because it means that 
853    tape movement is very inefficient.
854    Fortunately, this operation system deficiency seems to be the case only
855    on a few *BSD systems.  Operating systems known to work correctly are
856    Solaris, Linux and FreeBSD.
857
858 \item [BSF at EOM = {\it yes\vb{}no}]
859    \index[sd]{BSF at EOM}
860    \index[sd]{Directive!BSF at EOM}
861    If {\bf No}, the default, no special action is taken by Bacula with the End
862    of Medium (end of tape) is reached because the tape will be positioned after
863    the last EOF tape mark, and Bacula can append to the tape as desired.
864    However, on some systems, such as FreeBSD, when Bacula reads the End of
865    Medium (end of tape), the tape will be positioned after the second EOF tape
866    mark (two successive EOF marks indicated End of Medium). If Bacula appends
867    from that point, all the appended data will be lost. The solution for such
868    systems is to specify {\bf BSF at EOM} which causes Bacula to backspace over
869    the second EOF mark. Determination of whether or not you need this directive
870    is done using the {\bf test} command in the {\bf btape} program.
871
872 \item [TWO EOF = {\it yes\vb{}no}]
873    \index[sd]{TWO EOF}
874    \index[sd]{Directive!TWO EOF}
875    If {\bf Yes}, Bacula will write two end of file marks when terminating a
876    tape -- i.e. after the last job or at the end of the medium. If {\bf No},
877    the default, Bacula will only write one end of file to terminate the tape.
878
879 \item [Backward Space Record = {\it yes\vb{}no}]
880    \index[sd]{Backward Space Record}
881    \index[sd]{Directive!Backward Space Record}
882    If {\it Yes}, the archive device supports the {\tt MTBSR ioctl} to backspace
883    records. If {\it No}, this call is not used and the device must be rewound
884    and advanced forward to the desired position. Default is {\bf Yes} for non
885    random-access devices. This function if enabled is used at the end of a
886    Volume after writing the end of file and any ANSI/IBM labels to determine
887    whether or not the last block was written correctly. If you turn this
888    function off, the test will not be done. This causes no harm as the re-read
889    process is precautionary rather than required.
890
891 \item [Backward Space File = {\it yes\vb{}no}]
892    \index[sd]{Backward Space File}
893    \index[sd]{Directive!Backward Space File}
894    If {\it Yes}, the archive device supports the {\bf MTBSF} and  {\bf MTBSF
895   ioctl}s to backspace over an end of file mark and to the  start of a file. If
896   {\it No}, these calls are not used and the  device must be rewound and
897   advanced forward to the desired position.  Default is {\bf Yes} for non
898   random-access devices. 
899
900 \item [Forward Space Record = {\it yes\vb{}no}]
901    \index[sd]{Forward Space Record}
902    \index[sd]{Directive!Forward Space Record}
903    If {\it Yes}, the archive device must support the {\bf MTFSR  ioctl} to
904    forward space over records. If {\bf No}, data must  be read in order to
905    advance the position on the device. Default is  {\bf Yes} for non
906    random-access devices. 
907
908 \item [Forward Space File = {\it yes\vb{}no}]
909    \index[sd]{Forward Space File}
910    \index[sd]{Directive!Forward Space File}
911    If {\bf Yes}, the archive device must support the {\tt MTFSF  ioctl} to
912    forward space by file marks. If {\it No}, data  must be read to advance the
913    position on the device. Default is  {\bf Yes} for non random-access devices. 
914
915 \item [Offline On Unmount = {\it yes\vb{}no}]
916    \index[sd]{Offline On Unmount}
917    \index[sd]{Directive!Offline On Unmount}
918    The default for this directive is {\bf No}. If {\bf Yes} the  archive device
919    must support the {\tt MTOFFL ioctl} to rewind and  take the volume offline. In
920    this case, Bacula will issue the  offline (eject) request before closing the
921    device during the {\bf unmount}  command. If {\bf No} Bacula will not attempt
922    to offline the  device before unmounting it. After an offline is issued,  the
923    cassette will be ejected thus {\bf requiring operator intervention}  to
924    continue, and on some systems require an explicit load command  to be issued
925    ({\bf mt -f /dev/xxx load}) before the system will recognize  the tape. If you
926    are using an autochanger, some devices  require an offline to be issued prior
927    to changing the volume. However,  most devices do not and may get very
928    confused.  
929
930    If you are using a Linux 2.6 kernel or other OSes
931    such as FreeBSD or Solaris, the Offline On Unmount will leave the drive
932    with no tape, and Bacula will not be able to properly open the drive and
933    may fail the job.  For more information on this problem, please see the
934    \borgxrlink{description of Offline On Unmount}{NoTapeInDrive}{problems}{subsection}
935    in the \borgxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}.
936
937 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
938    \index[sd]{Device Maximum Concurrent Jobs}
939    \index[sd]{Directive!Device Maximum Concurrent Jobs}
940    \index[sd]{Directive!New in 3.0.3}
941    where \lt{}number\gt{} is the maximum number of Jobs that can run
942    concurrently on a specified Device.  Using this directive, it is possible
943    to have different Jobs using multiple drives, because when 
944    the Maximum Concurrent Jobs limit is
945    reached, the Storage Daemon will start new Jobs on any other available
946    compatible drive.  This facilitates writing to multiple drives with
947    multiple Jobs that all use the same Pool.
948
949 \item [Maximum Volume Size = {\it size}]
950    \index[sd]{Maximum Volume Size}
951    \index[sd]{Directive!Maximum Volume Size}
952    No more than {\bf size} bytes will be written onto a given volume on the
953    archive device.  This directive is used mainly in testing Bacula to
954    simulate a small Volume.  It can also be useful if you wish to limit the
955    size of a File Volume to say less than 2GB of data.  In some rare cases
956    of really antiquated tape drives that do not properly indicate when the
957    end of a tape is reached during writing (though I have read about such
958    drives, I have never personally encountered one).  Please note, this
959    directive is deprecated (being phased out) in favor of the {\bf Maximum
960    Volume Bytes} defined in the Director's configuration file.
961
962 \item [Maximum File Size = {\it size}]
963    \index[sd]{Maximum File Size}
964    \index[sd]{Directive!Maximum File Size}
965    No more than {\bf size} bytes will be written into a given logical file
966    on the volume.  Once this size is reached, an end of file mark is
967    written on the volume and subsequent data are written into the next
968    file.  Breaking long sequences of data blocks with file marks permits
969    quicker positioning to the start of a given stream of data and can
970    improve recovery from read errors on the volume.  The default is one
971    Gigabyte.  This directive creates EOF marks only on tape media.
972    However, regardless of the medium type (tape, disk, USB ...) each time
973    a the Maximum File Size is exceeded, a record is put into the catalog
974    database that permits seeking to that position on the medium for
975    restore operations. If you set this to a small value (e.g. 1MB),
976    you will generate lots of database records (JobMedia) and may
977    significantly increase CPU/disk overhead.
978
979    If you are configuring an LTO-3 or LTO-4 tape, you probably will
980    want to set the {\bf Maximum File Size} to 2GB to avoid making
981    the drive stop to write an EOF mark.
982
983    Note, this directive does not limit the size of Volumes that Bacula
984    will create regardless of whether they are tape or disk volumes. It
985    changes only the number of EOF marks on a tape and the number of
986    block positioning records (see below) that are generated. If you
987    want to limit the size of all Volumes for a particular device, use
988    the {\bf Maximum Volume Size} directive (above), or use the
989    {\bf Maximum Volume Bytes} directive in the Director's Pool resource,
990    which does the same thing but on a Pool (Volume) basis.
991
992 \item [Block Positioning = {\it yes\vb{}no}]
993    \index[sd]{Block Positioning}
994    \index[sd]{Directive!Block Positioning}
995    This directive tells Bacula not to use block positioning when doing restores.
996    Turning this directive off can cause Bacula to be {\bf extremely} slow
997    when restoring files.  You might use this directive if you wrote your
998    tapes with Bacula in variable block mode (the default), but your drive
999    was in fixed block mode. The default is {\bf yes}.
1000
1001 \item [Maximum Network Buffer Size = {\it bytes}]
1002    \index[sd]{Maximum Network Buffer Size}
1003    \index[sd]{Directive!Maximum Network Buffer Size}
1004    where {\it bytes} specifies the initial network buffer  size to use with the
1005    File daemon.  This size will be adjusted down if it is too large until
1006    it is accepted by the OS. Please use care in setting this value since if
1007    it is too large, it will be trimmed by 512 bytes until the OS is happy,
1008    which may require a large number of system calls.  The default value is
1009    32,768 bytes.
1010
1011    The default size was chosen to be relatively large but not too big in
1012    the case that you are transmitting data over Internet.  It is clear that
1013    on a high speed local network, you can increase this number and improve
1014    performance. For example, some users have found that if you use a value
1015    of 65,536 bytes they get five to ten times the throughput.  Larger values for
1016    most users don't seem to improve performance. If you are interested
1017    in improving your backup speeds, this is definitely a place to
1018    experiment. You will probably also want to make the corresponding change
1019    in each of your File daemons conf files.
1020
1021
1022 \item [Maximum Spool Size = {\it bytes}]
1023    \index[sd]{Maximum Spool Size}
1024    \index[sd]{Directive!Maximum Spool Size}
1025    where the bytes specify the maximum spool size for all jobs that are
1026    running.  The default is no limit.
1027
1028 \item [Maximum Job Spool Size = {\it bytes}]
1029    \index[sd]{Maximum Job Spool Size}
1030    \index[sd]{Directive!Maximum Job Spool Size}
1031    where the bytes specify the maximum spool size for any one job  that is
1032    running. The default is no limit. 
1033    This directive is implemented only in version 1.37 and later.
1034
1035 \item [Spool Directory = {\it directory}]
1036    \index[sd]{Spool Directory}
1037    \index[sd]{Directive!Spool Directory}
1038    specifies the name of the directory to be used to store  the spool files for
1039    this device. This directory is also used to store  temporary part files when
1040    writing to a device that requires mount (USB).  The default is to use the
1041    working directory. 
1042
1043 \end{description}
1044
1045 \label{mountcodes}
1046 \section{Edit Codes for Mount and Unmount Directives} 
1047 \index[general]{Directives!Edit Codes}
1048 \index[general]{Edit Codes for Mount and Unmount Directives }
1049
1050 Before submitting the {\bf Mount Command}, {\bf Unmount Command},
1051 or {\bf Free Space Command} directives
1052 to the operating system, Bacula performs character substitution of the
1053 following characters:
1054
1055 \footnotesize
1056 \begin{verbatim}
1057     %% = %
1058     %a = Archive device name
1059     %e = erase (set if cannot mount and first part)
1060     %n = part number
1061     %m = mount point
1062 \end{verbatim}
1063 \normalsize
1064
1065
1066 \section{Devices that require a mount (USB)}
1067 \index[general]{Devices that require a mount (USB)}
1068
1069 All the directives in this section are implemented only in
1070 Bacula version 1.37 and later and hence are available in version 1.38.6.
1071
1072 The directives: 
1073 "Requires Mount", "Mount Point", "Mount Command", and "Unmount Command"
1074 apply to removable filesystems such as USB.
1075
1076 \begin{description}
1077
1078 \item [Requires Mount = {\it yes\vb{}no}]
1079    \index[sd]{Requires Mount}
1080    \index[sd]{Directive!Requires Mount}
1081    You must set this directive to {\bf yes} for removable devices such as
1082    USB unless they are automounted, and to {\bf no} for all other devices
1083    (tapes/files).  This directive indicates if the device requires to be
1084    mounted to be read, and if it must be written in a special way.  If it
1085    set, {\bf Mount Point}, {\bf Mount Command}, and {\bf Unmount Command}
1086    directives must also be defined.
1087
1088 \item [Mount Point = {\it directory}]
1089    \index[sd]{Mount Point}
1090    \index[sd]{Directive!Mount Point}
1091    Directory where the device can be mounted. 
1092
1093 \item [Mount Command = {\it name-string}]
1094    \index[sd]{Mount Command}
1095    \index[sd]{Directive!Mount Command}
1096    Command that must be executed to mount the device. Before the command is 
1097    executed, \%a is replaced with the Archive Device, and \%m with the Mount 
1098    Point.
1099
1100    Most frequently, you will define it as follows:  
1101
1102 \footnotesize
1103 \begin{verbatim}
1104   Mount Command = "/bin/mount -t iso9660 -o ro %a %m"
1105 \end{verbatim}
1106 \normalsize
1107
1108 For some media, you may need multiple commands.  If so, it is recommended
1109 that you use a shell script instead of putting them all into the Mount
1110 Command.  For example, instead of this:
1111
1112 \footnotesize
1113 \begin{verbatim}
1114   Mount Command = "/usr/local/bin/mymount"
1115 \end{verbatim}
1116 \normalsize
1117
1118 Where that script contains:
1119
1120 \footnotesize
1121 \begin{verbatim}
1122 #!/bin/sh
1123 ndasadmin enable -s 1 -o w
1124 sleep 2
1125 mount /dev/ndas-00323794-0p1 /backup
1126 \end{verbatim}
1127 \normalsize
1128
1129 Similar consideration should be given to all other Command parameters.
1130
1131 \item [Unmount Command = {\it name-string}]
1132    \index[sd]{Unmount Command}
1133    \index[sd]{Directive!Unmount Command}
1134    Command that must be executed to unmount the device. Before the command  is
1135    executed, \%a is replaced with the Archive Device, and \%m with the  Mount
1136    Point.
1137
1138    Most frequently, you will define it as follows:  
1139
1140 \footnotesize
1141 \begin{verbatim}
1142   Unmount Command = "/bin/umount %m"
1143 \end{verbatim}
1144 \normalsize
1145
1146   If you need to specify multiple commands, create a shell script.
1147
1148 \end{description}
1149
1150 %% This pulls in the Autochanger resource from another file.
1151 \label{AutochangerRes}
1152 \label{AutochangerResource1}
1153 \input{autochangerres}
1154
1155 \section{Capabilities}
1156 \index[general]{Capabilities}
1157
1158 \begin{description}
1159
1160 \item [Label Media = {\it yes\vb{}no}]
1161    \index[general]{Label Media}
1162    \index[sd]{Label Media}
1163    \index[sd]{Directive!Label Media}
1164    If {\bf Yes}, permits this device to automatically label blank media
1165    without an explicit operator command.  It does so by using an internal
1166    algorithm as defined on the \ilink{Label Format}{Label} record in each
1167    Pool resource.  If this is {\bf No} as by default, Bacula will label
1168    tapes only by specific operator command ({\bf label} in the Console) or
1169    when the tape has been recycled.  The automatic labeling feature is most
1170    useful when writing to disk rather than tape volumes.
1171
1172 \item [Automatic mount = {\it yes\vb{}no}]
1173    \index[sd]{Automatic mount}
1174    \index[sd]{Directive!Automatic mount}
1175    If {\bf Yes} (the default), permits the daemon to examine the device to
1176    determine if it contains a Bacula labeled volume.  This is done
1177    initially when the daemon is started, and then at the beginning of each
1178    job.  This directive is particularly important if you have set
1179    {\bf Always Open = no} because it permits Bacula to attempt to read the
1180    device before asking the system operator to mount a tape.  However,
1181    please note that the tape must be mounted before the job begins.
1182
1183 \end{description}
1184
1185 \section{Messages Resource}
1186 \label{MessagesResource1}
1187 \index[general]{Resource!Messages}
1188 \index[general]{Messages Resource}
1189
1190 For a description of the Messages Resource, please see the 
1191 \ilink{Messages Resource}{MessagesChapter} Chapter of this
1192 manual. 
1193
1194 \section{Sample Storage Daemon Configuration File}
1195 \label{SampleConfiguration}
1196 \index[general]{File!Sample Storage Daemon Configuration}
1197 \index[general]{Sample Storage Daemon Configuration File}
1198
1199 A example Storage Daemon configuration file might be the following: 
1200
1201 \footnotesize
1202 \begin{verbatim}
1203 #
1204 # Default Bacula Storage Daemon Configuration file
1205 #
1206 #  For Bacula release 1.37.2 (07 July 2005) -- gentoo 1.4.16
1207 #
1208 # You may need to change the name of your tape drive
1209 #   on the "Archive Device" directive in the Device
1210 #   resource.  If you change the Name and/or the
1211 #   "Media Type" in the Device resource, please ensure
1212 #   that bacula-dir.conf has corresponding changes.
1213 #
1214 Storage {                               # definition of myself
1215   Name = rufus-sd
1216   Address = rufus
1217   WorkingDirectory = "$HOME/bacula/bin/working"
1218   Pid Directory = "$HOME/bacula/bin/working"
1219   Maximum Concurrent Jobs = 20
1220 }
1221 #
1222 # List Directors who are permitted to contact Storage daemon
1223 #
1224 Director {
1225   Name = rufus-dir
1226   Password = "ZF9Ctf5PQoWCPkmR3s4atCB0usUPg+vWWyIo2VS5ti6k"
1227 }
1228 #
1229 # Restricted Director, used by tray-monitor to get the
1230 #   status of the storage daemon
1231 #
1232 Director {
1233   Name = rufus-mon
1234   Password = "9usxgc307dMbe7jbD16v0PXlhD64UVasIDD0DH2WAujcDsc6"
1235   Monitor = yes
1236 }
1237 #
1238 # Devices supported by this Storage daemon
1239 # To connect, the Director's bacula-dir.conf must have the
1240 #  same Name and MediaType.
1241 #
1242 Autochanger {
1243   Name = Autochanger
1244   Device = Drive-1
1245   Device = Drive-2
1246   Changer Command = "/home/kern/bacula/bin/mtx-changer %c %o %S %a %d"
1247   Changer Device = /dev/sg0
1248 }
1249
1250 Device {
1251   Name = Drive-1                      #
1252   Drive Index = 0 
1253   Media Type = DLT-8000
1254   Archive Device = /dev/nst0
1255   AutomaticMount = yes;               # when device opened, read it
1256   AlwaysOpen = yes;
1257   RemovableMedia = yes;
1258   RandomAccess = no;
1259   AutoChanger = yes
1260   Alert Command = "sh -c 'tapeinfo -f %c |grep TapeAlert|cat'"
1261 }
1262
1263 Device {
1264   Name = Drive-2                      #
1265   Drive Index = 1
1266   Media Type = DLT-8000
1267   Archive Device = /dev/nst1
1268   AutomaticMount = yes;               # when device opened, read it
1269   AlwaysOpen = yes;
1270   RemovableMedia = yes;
1271   RandomAccess = no;
1272   AutoChanger = yes
1273   Alert Command = "sh -c 'tapeinfo -f %c |grep TapeAlert|cat'"
1274 }
1275
1276 Device {
1277   Name = "HP DLT 80"
1278   Media Type = DLT8000
1279   Archive Device = /dev/nst0
1280   AutomaticMount = yes;                 # when device opened, read it
1281   AlwaysOpen = yes;
1282   RemovableMedia = yes;
1283 }
1284 #Device {
1285 #  Name = SDT-7000                     #
1286 #  Media Type = DDS-2
1287 #  Archive Device = /dev/nst0
1288 #  AutomaticMount = yes;               # when device opened, read it
1289 #  AlwaysOpen = yes;
1290 #  RemovableMedia = yes;
1291 #}
1292 #Device {
1293 #  Name = Floppy
1294 #  Media Type = Floppy
1295 #  Archive Device = /mnt/floppy
1296 #  RemovableMedia = yes;
1297 #  Random Access = Yes;
1298 #  AutomaticMount = yes;               # when device opened, read it
1299 #  AlwaysOpen = no;
1300 #}
1301 #Device {
1302 #  Name = FileStorage
1303 #  Media Type = File
1304 #  Archive Device = /tmp
1305 #  LabelMedia = yes;                   # lets Bacula label unlabeled media
1306 #  Random Access = Yes;
1307 #  AutomaticMount = yes;               # when device opened, read it
1308 #  RemovableMedia = no;
1309 #  AlwaysOpen = no;
1310 #}
1311 #
1312 # A very old Exabyte with no end of media detection
1313 #
1314 #Device {
1315 #  Name = "Exabyte 8mm"
1316 #  Media Type = "8mm"
1317 #  Archive Device = /dev/nst0
1318 #  Hardware end of medium = No;
1319 #  AutomaticMount = yes;               # when device opened, read it
1320 #  AlwaysOpen = Yes;
1321 #  RemovableMedia = yes;
1322 #}
1323 #
1324 # Send all messages to the Director,
1325 # mount messages also are sent to the email address
1326 #
1327 Messages {
1328   Name = Standard
1329   director = rufus-dir = all
1330   operator = root = mount
1331 }
1332 \end{verbatim}
1333 \normalsize