4 \section*{Storage Daemon Configuration}
5 \label{_ChapterStart31}
6 \index[general]{Storage Daemon Configuration }
7 \index[general]{Configuration!Storage Daemon }
8 \addcontentsline{toc}{section}{Storage Daemon Configuration}
11 \index[general]{General }
12 \addcontentsline{toc}{subsection}{General}
14 The Storage Daemon configuration file has relatively few resource definitions.
15 However, due to the great variation in backup media and system capabilities,
16 the storage daemon must be highly configurable. As a consequence, there are
17 quite a large number of directives in the Device Resource definition that
18 allow you to define all the characteristics of your Storage device (normally a
19 tape drive). Fortunately, with modern storage devices, the defaults are
20 sufficient, and very few directives are actually needed.
22 Examples of {\bf Device} resource directives that are known to work for a
23 number of common tape drives can be found in the {\bf
24 \lt{}bacula-src\gt{}/examples/devices} directory, and most will also be listed
27 For a general discussion of configuration file and resources including the
28 data types recognized by {\bf Bacula}, please see the
29 \ilink{Configuration}{_ChapterStart16} chapter of this manual. The
30 following Storage Resource definitions must be defined:
34 \ilink{Storage}{StorageResource} -- to define the name of the
37 \ilink{Director}{DirectorResource1} -- to define the Director's
38 name and his access password.
40 \ilink{Device}{DeviceResource} -- to define the
41 characteristics of your storage device (tape drive).
43 \ilink{Messages}{_ChapterStart15} -- to define where error and
44 information messages are to be sent.
47 \subsection*{Storage Resource}
48 \label{StorageResource}
49 \index[general]{Resource!Storage }
50 \index[general]{Storage Resource }
51 \addcontentsline{toc}{subsection}{Storage Resource}
53 In general, the properties specified under the Storage resource define global
54 properties of the Storage daemon. Each Storage daemon configuration file must
55 have one and only one Storage resource definition.
59 \item [Name = \lt{}Storage-Daemon-Name\gt{}]
61 Specifies the Name of the Storage daemon. This directive is required.
63 \item [Working Directory = \lt{}Directory\gt{}]
64 \index[sd]{Working Directory }
65 This directive is mandatory and specifies a directory in which the Storage
66 daemon may put its status files. This directory should be used only by {\bf
67 Bacula}, but may be shared by other Bacula daemons provided the names
68 given to each daemon are unique. This directive is
71 \item [Pid Directory = \lt{}Directory\gt{}]
72 \index[sd]{Pid Directory }
73 This directive is mandatory and specifies a directory in which the Director
74 may put its process Id file files. The process Id file is used to shutdown
75 Bacula and to prevent multiple copies of Bacula from running simultaneously.
76 This directive is required. Standard shell expansion of the {\bf Directory}
77 is done when the configuration file is read so that values such as {\bf
78 \$HOME} will be properly expanded.
80 Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
81 not installing Bacula in the system directories, you can use the {\bf Working
82 Directory} as defined above.
84 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
85 \index[sd]{Heartbeat Interval }
86 \index[general]{Heartbeat Interval}
87 \index[general]{Broken pipe}
88 This directive defines an interval of time. When the Storage daemon is
89 waiting for the operator to mount a tape, each time interval, it will
90 send a heartbeat signal to the File daemon. The default interval is
91 zero which disables the heartbeat. This feature is particularly useful
92 if you have a router such as 3Com that does not follow Internet
93 standards and times out an valid connection after a short duration
94 despite the fact that keepalive is set. This usually results
95 in a broken pipe error message.
97 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
98 \index[sd]{Maximum Concurrent Jobs}
99 where \lt{}number\gt{} is the maximum number of Jobs that should run
100 concurrently. The default is set to 10, but you may set it to a larger
101 number. Each contact from the Director (e.g. status request, job start
102 request) is considered as a Job, so if you want to be able to do a {\bf
103 status} request in the console at the same time as a Job is running, you
104 will need to set this value greater than 1. To run simultaneous Jobs,
105 you will need to set a number of other directives in the Director's
106 configuration file. Which ones you set depend on what you want, but you
107 will almost certainly need to set the {\bf Maximum Concurrent Jobs} in
108 the Storage resource in the Director's configuration file and possibly
109 those in the Job and Client resources.
111 \item [SDAddresses = \lt{}IP-address-specification\gt{}]
112 \index[sd]{SDAddresses}
113 Specify the ports and addresses on which the Storage daemon will listen
114 for Director connections. Normally, the default is sufficient and you
115 do not need to specify this directive. Probably the simplest way to
116 explain how this directive works is to show an example:
120 SDAddresses = { ip = {
121 addr = 1.2.3.4; port = 1205; }
123 addr = 1.2.3.4; port = http; }
136 addr = 201:220:222::2
139 addr = bluedot.thun.net
145 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
146 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
147 a symbolic name (only in the ip specification). Also, port can be specified
148 as a number or as the mnemonic value from the /etc/services file. If a port
149 is not specified, the default will be used. If an ip section is specified,
150 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
151 only IPv4 resolutions will be permitted, and likewise with ip6.
153 Using this directive, you can replace both the SDPort and SDAddress
154 directives shown below.
156 \item [SDPort = \lt{}port-number\gt{}]
158 Specifies port number on which the Storage daemon listens for Director
159 connections. The default is 9103.
161 \item [SDAddress = \lt{}IP-Address\gt{}]
162 \index[sd]{SDAddress }
163 This directive is optional, and if it is specified, it will cause the Storage
164 daemon server (for Director and File daemon connections) to bind to the
165 specified {\bf IP-Address}, which is either a domain name or an IP address
166 specified as a dotted quadruple. If this directive is not specified, the
167 Storage daemon will bind to any available address (the default).
171 The following is a typical Storage daemon Storage definition.
176 # "Global" Storage daemon configuration specifications appear
177 # under the Storage resource.
180 Name = "Storage daemon"
182 WorkingDirectory = "~/bacula/working"
183 Pid Directory = "~/bacula/working"
188 \subsection*{Director Resource}
189 \label{DirectorResource1}
190 \index[general]{Director Resource }
191 \index[general]{Resource!Director }
192 \addcontentsline{toc}{subsection}{Director Resource}
194 The Director resource specifies the Name of the Director which is permitted
195 to use the services of the Storage daemon. There may be multiple Director
196 resources. The Director Name and Password must match the corresponding
197 values in the Director's configuration file.
201 \item [Name = \lt{}Director-Name\gt{}]
203 Specifies the Name of the Director allowed to connect to the Storage daemon.
204 This directive is required.
206 \item [Password = \lt{}Director-password\gt{}]
207 \index[sd]{Password }
208 Specifies the password that must be supplied by the above named Director.
209 This directive is required.
211 \item [Monitor = \lt{}yes|no\gt{}]
213 If Monitor is set to {\bf no} (default), this director will have full
214 access to this Storage daemon. If Monitor is set to {\bf yes}, this
215 director will only be able to fetch the current status of this Storage
218 Please note that if this director is being used by a Monitor, we highly
219 recommend to set this directive to {\bf yes} to avoid serious security
224 The following is an example of a valid Director resource definition:
230 Password = my_secret_password
235 \label{DeviceResource}
236 \subsection*{Device Resource}
237 \index[general]{Resource!Device }
238 \index[general]{Device Resource }
239 \addcontentsline{toc}{subsection}{Device Resource}
241 The Device Resource specifies the details of each device (normally a tape
242 drive) that can be used by the Storage daemon. There may be multiple
243 Device resources for a single Storage daemon. In general, the properties
244 specified within the Device resource are specific to the Device.
248 \item [Name = {\it Device-Name}]
250 Specifies the Name that the Director will use when asking to backup or
251 restore to or from to this device. This is the logical Device name, and may
252 be any string up to 127 characters in length. It is generally a good idea to
253 make it correspond to the English name of the backup device. The physical
254 name of the device is specified on the {\bf Archive Device} directive
255 described below. The name you specify here is also used in your Director's
257 \ilink{Device directive}{StorageResource2} in its Storage
260 \item [Archive Device = {\it name-string}]
261 \index[sd]{Archive Device }
262 The specified {\bf name-string} gives the system file name of the storage
263 device managed by this storage daemon. This will usually be the device file
264 name of a removable storage device (tape drive), for example "{\bf
265 /dev/nst0}" or "{\bf /dev/rmt/0mbn}". For a DVD-writer, it will be for
266 example {\bf /dev/hdc}. It may also be a directory name if you are archiving
267 to disk storage. In this case, you must supply the full absolute path to the
268 directory. When specifying a tape device, it is preferable that the
269 "non-rewind" variant of the device file name be given. In addition, on
270 systems such as Sun, which have multiple tape access methods, you must be
271 sure to specify to use Berkeley I/O conventions with the device. The {\bf b}
272 in the Solaris (Sun) archive specification {\bf /dev/rmt/0mbn} is what is
273 needed in this case. Bacula does not support SysV tape drive behavior.
275 As noted above, normally the Archive Device is the name of a tape drive, but
276 you may also specify an absolute path to an existing directory. If the Device
277 is a directory Bacula will write to file storage in the specified directory,
278 and the filename used will be the Volume name as specified in the Catalog.
279 If you want to write into more than one directory (i.e. to spread the load to
280 different disk drives), you will need to define two Device resources, each
281 containing an Archive Device with a different directory.
283 In addition to a tape device name or a directory name, Bacula will accept the
284 name of a FIFO. A FIFO is a special kind of file that connects two programs
285 via kernel memory. If a FIFO device is specified for a backup operation, you
286 must have a program that reads what Bacula writes into the FIFO. When the
287 Storage daemon starts the job, it will wait for {\bf MaximumOpenWait} seconds
288 for the read program to start reading, and then time it out and terminate
289 the job. As a consequence, it is best to start the read program at the
290 beginning of the job perhaps with the {\bf RunBeforeJob} directive. For this
291 kind of device, you never want to specify {\bf AlwaysOpen}, because you want
292 the Storage daemon to open it only when a job starts, so you must explicitly
293 set it to {\bf No}. Since a FIFO is a one way device, Bacula will not attempt
294 to read a label of a FIFO device, but will simply write on it. To create a
295 FIFO Volume in the catalog, use the {\bf add} command rather than then {\bf
296 label} command to avoid attempting to write a label.
298 During a restore operation, if the Archive Device is a FIFO, Bacula will
299 attempt to read from the FIFO, so you must have an external program that
300 writes into the FIFO. Bacula will wait {\bf MaximumOpenWait} seconds for the
301 program to begin writing and will then time it out and terminate the job. As
302 noted above, you may use the {\bf RunBeforeJob} to start the writer program
303 at the beginning of the job.
305 The Archive Device directive is required.
307 \item [Media Type = {\it name-string}]
308 \index[sd]{Media Type }
309 The specified {\bf name-string} names the type of media supported by this
310 device, for example, "DLT7000". Media type names are arbitrary in that you
311 set it to anything you want, but must be known to the volume database to keep
312 track of which storage daemons can read which volumes. The same {\bf
313 name-string} must appear in the appropriate Storage resource definition in
314 the Director's configuration file.
316 Even though the names you assign are arbitrary (i.e. you choose the name you
317 want), you should take care in specifying them because the Media Type is used
318 to determine which storage device Bacula will select during restore. Thus you
319 should probably use the same Media Type specification for all drives where
320 the Media can be freely interchanged. This is not generally an issue if you
321 have a single Storage daemon, but it is with multiple Storage daemons,
322 especially if they have incompatible media.
324 For example, if you specify a Media Type of "DDS-4" then during the
325 restore, Bacula will be able to choose any Storage Daemon that handles
326 "DDS-4". If you have an autochanger, you might want to name the Media Type
327 in a way that is unique to the autochanger, unless you wish to possibly use
328 the Volumes in other drives. You should also ensure to have unique Media
329 Type names if the Media is not compatible between drives. This specification
330 is required for all devices.
333 \item [Autochanger = {\it Yes|No}]
334 \index[sd]{Autochanger}
335 If {\bf Yes}, this device belongs to an automatic tape changer, and you should also
336 specify a {\bf Changer Device} as well as a {\bf Changer Command}. If {\bf
337 No} (default), the volume must be manually changed. You should also
338 have an identical directive to the
339 \ilink{Storage resource}{Autochanger1} in the Director's
340 configuration file so that when labeling tapes you are prompted for the slot.
342 \item [Changer Device = {\it name-string}]
343 \index[sd]{Changer Device }
344 The specified {\bf name-string} gives the system file name of the autochanger
345 device name that corresponds to the {\bf Archive Device} specified. This
346 device name is specified if you have an autochanger or if you want to use the
347 {\bf Alert Command} (see below). Normally you will specify the {\bf generic
348 SCSI} device name in this directive. For example, on Linux systems, for
349 archive device {\bf /dev/nst0}, This directive is optional. See the
350 \ilink{ Using Autochangers}{_ChapterStart18} chapter of this
351 manual for more details of using this and the following autochanger
354 \item [Changer Command = {\it name-string}]
355 \index[sd]{Changer Command }
356 The {\bf name-string} specifies an external program to be called that will
357 automatically change volumes as required by {\bf Bacula}. Most frequently,
358 you will specify the Bacula supplied {\bf mtx-changer} script as follows:
362 Changer Command = "/path/mtx-changer %c %o %S %a %d"
366 and you will install the {\bf mtx} on your system (found in the {\bf depkgs}
367 release). An example of this command is in the default bacula-sd.conf file.
368 For more details on the substitution characters that may be specified to
369 configure your autochanger please see the
370 \ilink{Autochangers}{_ChapterStart18} chapter of this manual.
371 For FreeBSD users, you might want to see one of the several {\bf chio}
372 scripts in {\bf examples/autochangers}.
374 \item [Alert Command = {\it name-string}]
375 \index[sd]{Alert Command }
376 The {\bf name-string} specifies an external program to be called at the
377 completion of each Job after the device is released. The purpose of this
378 command is to check for Tape Alerts, which are present when something is
379 wrong with your tape drive (at least for most modern tape drives). The same
380 substitution characters that may be specified in the Changer Command may also
381 be used in this string. For more information, please see the
382 \ilink{Autochangers}{_ChapterStart18} chapter of this manual.
385 Note, it is not necessary to have an autochanger to use this command. The
386 example below uses the {\bf tapeinfo} program that comes with the {\bf mtx}
387 package, but it can be used on any tape drive. However, you will need to
388 specify a {\bf Changer Device} directive in your Device resource (see above)
389 so that the generic SCSI device name can be edited into the command (with the
392 An example of the use of this command to print Tape Alerts in the Job report
397 Alert Command = "sh -c 'tapeinfo -f %c | grep TapeAlert'"
402 and an example output when there is a problem could be:
406 bacula-sd Alert: TapeAlert[32]: Interface: Problem with SCSI interface
407 between tape drive and initiator.
412 \item [Drive Index = {\it number}]
413 \index[sd]{Drive Index}
414 The {\bf Drive Index} that you specify is passed to the {\bf mtx-changer}
415 script and is thus passed to the {\bf mtx} program. By default, the Drive
416 Index is zero, so if you have only one drive in your autochanger, everything
417 will work normally. However, if you have multiple drives, you may specify two
418 Bacula Device resources. The first will either set Drive Index to zero, or
419 leave it unspecified, and the second Device Resource should contain a Drive
420 Index set to 1. This will then permit you to use two or more drives in your
421 autochanger. However, you must ensure that Bacula does not request the same
422 Volume on both drives at the same time. You may also need to modify the
423 mtx-changer script to do locking so that two jobs don't attempt to use the
424 autochanger at the same time. An example script can be found in {\bf
425 examples/autochangers/locking-mtx-changer}.
427 \item [Autoselect = {\it Yes|No}]
428 \index[sd]{Autoselect}
429 If this directive is set to {\bf yes} (default), and the Device
430 belongs to an autochanger, then when the Autochanger is referenced
431 by the Director, this device can automatically be selected. If this
432 directive is set to {\bf no}, then the Device can only be referenced
433 by directly using the Device name in the Director. This is useful
434 for reserving a drive for something special such as a high priority
435 backup or restore operations.
437 \item [Maximum Changer Wait = {\it time}]
438 \index[sd]{Maximum Changer Wait }
439 This directive specifies the maximum time for Bacula to wait for an
440 autochanger to change the volume. If this time is exceeded, Bacula will
441 invalidate the Volume slot number stored in the catalog and try again. If no
442 additional changer volumes exist, Bacula will ask the operator to intervene.
443 The default time out is 5 minutes.
445 \item [Always Open = {\it Yes|No}]
446 \index[sd]{Always Open }
447 If {\bf Yes} (default), Bacula will always keep the device open unless
448 specifically {\bf unmounted} by the Console program. This permits Bacula to
449 ensure that the tape drive is always available. If you set {\bf AlwaysOpen}
450 to {\bf no} {\bf Bacula} will only open the drive when necessary, and at the
451 end of the Job if no other Jobs are using the drive, it will be freed. The
452 next time Bacula wants to append to a tape on a drive that was freed, Bacula
453 must rewind the tape and position to the end. To avoid unnecessary tape positioning
454 and to minimize unnecessary operator intervention, it is highly recommended that
455 {\bf Always Open = yes}. This also ensures that the drive is available when
458 If you have {\bf Always Open = yes} (recommended) and you want to use the
459 drive for something else, simply use the {\bf unmount} command in the Console
460 program to release the drive. However, don't forget to remount the drive with
461 {\bf mount} when the drive is available or the next Bacula job will block.
463 For File storage, this directive is ignored. For a FIFO storage device, you
464 must set this to {\bf No}.
466 Please note that if you set this directive to {\bf No} Bacula will release
467 the tape drive between each job, and thus the next job will rewind the tape
468 and position it to the end of the data. This can be a very time consuming
471 \item [Volume Poll Interval = {\it time}]
472 \index[sd]{Volume Poll Interval }
473 If the time specified on this directive is non-zero, after asking the
474 operator to mount a new volume Bacula will periodically poll (or read) the
475 drive at the specified interval to see if a new volume has been mounted. If
476 the time interval is zero (the default), no polling will occur. This
477 directive can be useful if you want to avoid operator intervention via the
478 console. Instead, the operator can simply remove the old volume and insert
479 the requested one, and Bacula on the next poll will recognize the new tape
480 and continue. Please be aware that if you set this interval too small, you
481 may excessively wear your tape drive if the old tape remains in the drive,
482 since Bacula will read it on each poll. This can be avoided by ejecting the
483 tape using the {\bf Offline On Unmount} and the {\bf Close on Poll}
486 \item [Close on Poll= {\it Yes|No}]
487 \index[sd]{Close on Poll }
488 If {\bf Yes}, Bacula close the device (equivalent to an unmount except no
489 mount is required) and reopen it at each poll. Normally this is not too
490 useful unless you have the {\bf Offline on Unmount} directive set, in which
491 case the drive will be taken offline preventing wear on the tape during any
492 future polling. Once the operator inserts a new tape, Bacula will recognize
493 the drive on the next poll and automatically continue with the backup.
495 \item [Maximum Open Wait = {\it time}]
496 \index[sd]{Maximum Open Wait }
497 This directive specifies the maximum amount of time that Bacula will wait for
498 a device that is busy. The default is 5 minutes. If the device cannot be
499 obtained, the current Job will be terminated in error. Bacula will re-attempt
500 to open the drive the next time a Job starts that needs the the drive.
502 \item [Removable media = {\it Yes|No}]
503 \index[sd]{Removable media }
504 If {\bf Yes}, this device supports removable media (for example, tapes or
505 CDs). If {\bf No}, media cannot be removed (for example, an intermediate
506 backup area on a hard disk).
508 \item [Random access = {\it Yes|No}]
509 \index[sd]{Random access }
510 If {\bf Yes}, the archive device is assumed to be a random access medium
511 which supports the {\bf lseek} (or {\bf lseek64} if Largefile is enabled
512 during configuration) facility.
514 \item [Minimum block size = {\it size-in-bytes}]
515 \index[sd]{Minimum block size }
516 On most modern tape drives, you will not need or wamt to specify this directive, and
517 if you do so, it will be to make Bacula use fixed block sizes. This
518 statement applies only to non-random access devices (e.g. tape drives).
519 Blocks written by the storage daemon to a non-random archive device will
520 never be smaller than the given {\bf size-in-bytes}. The Storage daemon will
521 attempt to efficiently fill blocks with data received from active sessions
522 but will, if necessary, add padding to a block to achieve the required
525 To force the block size to be fixed, as is the case for some non-random
526 access devices (tape drives), set the {\bf Minimum block size} and the {\bf
527 Maximum block size} to the same value (zero included). The default is that
528 both the minimum and maximum block size are zero and the default block size
529 is 64,512 bytes. If you wish the block size to be fixed and different from
530 the default, specify the same value for both {\bf Minimum block size} and
531 {\bf Maximum block size}.
533 For example, suppose you want a fixed block size of 100K bytes, then you
539 Minimum block size = 100K
540 Maximum block size = 100K
545 Please note that if you specify a fixed block size as shown above, the tape
546 drive must either be in variable block size mode, or if it is in fixed block
547 size mode, the block size (generally defined by {\bf mt}) {\bf must} be
548 identical to the size specified in Bacula -- otherwise when you attempt to
549 re-read your Volumes, you will get an error.
551 If you want the block size to be variable but with a 64K minimum and 200K
552 maximum (and default as well), you would specify:
557 Minimum block size = 64K
558 Maximum blocksize = 200K
563 \item [Maximum block size = {\it size-in-bytes}]
564 \index[sd]{Maximum block size }
565 On most modern tape drives, you will not need to specify this directive. If
566 you do so, it will most likely be to use fixed block sizes (see Minimum block
567 size above). The Storage daemon will aways attempt to write blocks of the
568 specified {\bf size-in-bytes} to the archive device. As a consequence, this
569 statement specifies both the default block size and the maximum block size.
570 The size written never exceed the given {\bf size-in-bytes}. If adding data
571 to a block would cause it to exceed the given maximum size, the block will be
572 written to the archive device, and the new data will begin a new block.
574 If no value is specified or zero is specified, the Storage daemon will use a
575 default block size of 64,512 bytes (126 * 512).
577 \item [Hardware End of Medium = {\it Yes|No}]
578 \index[sd]{Hardware End of Medium }
579 If {\bf No}, the archive device is not required to support end of medium
580 ioctl request, and the storage daemon will use the forward space file
581 function to find the end of the recorded data. If {\bf Yes}, the archive
582 device must support the {\tt ioctl} {\tt MTEOM} call, which will position the
583 tape to the end of the recorded data. In addition, your SCSI driver must keep
584 track of the file number on the tape and report it back correctly by the
585 {\bf MTIOCGET} ioctl. Note, some SCSI drivers will correctly forward space to
586 the end of the recorded data, but they do not keep track of the file number.
587 On Linux machines, the SCSI driver has a {\bf fast-eod} option, which if set
588 will cause the driver to lose track of the file number. You should ensure
589 that this option is always turned off using the {\bf mt} program.
591 Default setting for Hardware End of Medium is {\bf Yes}. This function is
592 used before appending to a tape to ensure that no previously written data is
593 lost. We recommend if you have a non-standard or unusual tape drive that you
594 use the {\bf btape} program to test your drive to see whether or not it
595 supports this function. All modern (after 1998) tape drives support this
598 \item [Fast Forward Space File = {\it Yes|No}]
599 \index[sd]{Fast Forward Space File }
600 If {\bf No}, the archive device is not required to support keeping track of
601 the file number ({\bf MTIOCGET} ioctl) during forward space file. If {\bf
602 Yes}, the archive device must support the {\tt ioctl} {\tt MTFSF} call, which
603 virtually all drivers support, but in addition, your SCSI driver must keep
604 track of the file number on the tape and report it back correctly by the
605 {\bf MTIOCGET} ioctl. Note, some SCSI drivers will correctly forward space,
606 but they do not keep track of the file number or more seriously, they do not
607 report end of meduim.
609 Default setting for Fast Forward Space File is {\bf Yes}.
611 \item [Use MTIOCGET = {\it Yes|No}]
612 \index[sd]{Fast Forward Space File }
613 If {\bf No}, the operating system is not required to support keeping track of
614 the file number and reporting it in the ({\bf MTIOCGET} ioctl). The default
615 is {\bf Yes}. If you must set this to No, Bacula will do the proper file
616 position determination, but it is very unfortunate because it means that
617 tape movement is very inefficient.
618 Fortunately, this operation system deficiency seems to be the case only
619 on a few *BSD systems. Operating systems known to work correctly are
620 Solaris, Linux and FreeBSD.
622 \item [BSF at EOM = {\it Yes|No}]
623 \index[sd]{BSF at EOM }
624 If {\bf No}, the default, no special action is taken by Bacula with the End
625 of Medium (end of tape) is reached because the tape will be positioned after
626 the last EOF tape mark, and Bacula can append to the tape as desired.
627 However, on some systems, such as FreeBSD, when Bacula reads the End of
628 Medium (end of tape), the tape will be positioned after the second EOF tape
629 mark (two successive EOF marks indicated End of Medium). If Bacula appends
630 from that point, all the appended data will be lost. The solution for such
631 systems is to specify {\bf BSF at EOM} which causes Bacula to backspace over
632 the second EOF mark. Determination of whether or not you need this directive
633 is done using the {\bf test} command in the {\bf btape} program.
635 \item [TWO EOF = {\it Yes|No}]
637 If {\bf Yes}, Bacula will write two end of file marks when terminating a tape
638 -- i.e. after the last job or at the end of the medium. If {\bf No}, the
639 default, Bacula will only write one end of file to terminate the tape.
641 \item [Backward Space Record = {\it Yes|No}]
642 \index[sd]{Backward Space Record}
643 If {\it Yes}, the archive device supports the {\tt MTBSR ioctl} to backspace
644 records. If {\it No}, this call is not used and the device must be rewound
645 and advanced forward to the desired position. Default is {\bf Yes} for non
646 random-access devices. This function if enabled is used at the end of a
647 Volume after writing the end of file and any ANSI/IBM labels to determine whether
648 or not the last block was written correctly. If you turn this function off,
649 the test will not be done. This causes no harm as the re-read process is
650 precautionary rather than required.
652 \item [Backward Space File = {\it Yes|No}]
653 \index[sd]{Backward Space File }
654 If {\it Yes}, the archive device supports the {\bf MTBSF} and {\bf MTBSF
655 ioctl}s to backspace over an end of file mark and to the start of a file. If
656 {\it No}, these calls are not used and the device must be rewound and
657 advanced forward to the desired position. Default is {\bf Yes} for non
658 random-access devices.
660 \item [Forward Space Record = {\it Yes|No}]
661 \index[sd]{Forward Space Record }
662 If {\it Yes}, the archive device must support the {\bf MTFSR ioctl} to
663 forward space over records. If {\bf No}, data must be read in order to
664 advance the position on the device. Default is {\bf Yes} for non
665 random-access devices.
667 \item [Forward Space File = {\it Yes|No}]
668 \index[sd]{Forward Space File }
669 If {\bf Yes}, the archive device must support the {\tt MTFSF ioctl} to
670 forward space by file marks. If {\it No}, data must be read to advance the
671 position on the device. Default is {\bf Yes} for non random-access devices.
673 \item [Offline On Unmount = {\it Yes|No}]
674 \index[sd]{Offline On Unmount }
675 The default for this directive is {\bf No}. If {\bf Yes} the archive device
676 must support the {\tt MTOFFL ioctl} to rewind and take the volume offline. In
677 this case, Bacula will issue the offline (eject) request before closing the
678 device during the {\bf unmount} command. If {\bf No} Bacula will not attempt
679 to offline the device before unmounting it. After an offline is issued, the
680 cassette will be ejected thus {\bf requiring operator intervention} to
681 continue, and on some systems require an explicit load command to be issued
682 ({\bf mt -f /dev/xxx load}) before the system will recognize the tape. If you
683 are using an autochanger, some devices require an offline to be issued prior
684 to changing the volume. However, most devices do not and may get very
687 \item [Maximum Volume Size = {\it size}]
688 \index[sd]{Maximum Volume Size }
689 No more than {\bf size} bytes will be written onto a given volume on the
690 archive device. This directive is used mainly in testing Bacula to simulate a
691 small Volume. It can also be useful if you wish to limit the size of a File
692 Volume to say less than 2GB of data. In some rare cases of really antiquated
693 tape drives that do not properly indicate when the end of a tape is reached
694 during writing (though I have read about such drives, I have never personally
695 encountered one). Please note, this directive is deprecated (being phased
696 out) in favor of the {\bf Maximum Volume Bytes} defined in the Director's
699 \item [Maximum File Size = {\it size}]
700 \index[sd]{Maximum File Size }
701 No more than {\bf size} bytes will be written into a given logical file on
702 the volume. Once this size is reached, an end of file mark is written on the
703 volume and subsequent data are written into the next file. Breaking long
704 sequences of data blocks with file marks permits quicker positioning to the
705 start of a given stream of data and can improve recovery from read errors on
706 the volume. The default is one Gigabyte.
708 \item [Block Positioning = {\it yes|no}]
709 \index[sd]{Block Positioning }
710 This directive is not normally used (and has not yet been tested). It will
711 tell Bacula not to use block positioning when it is reading tapes. This can
712 cause Bacula to be {\bf extremely} slow when restoring files. You might use
713 this directive if you wrote your tapes with Bacula in variable block mode
714 (the default), but your drive was in fixed block mode. If it then works as I
715 hope, Bacula will be able to re-read your tapes.
717 \item [Maximum Network Buffer Size = {\it bytes}]
718 \index[sd]{Maximum Network Buffer Size }
719 where {\it bytes} specifies the initial network buffer size to use with the
720 File daemon. This size will be adjusted down if it is too large until it is
721 accepted by the OS. Please use care in setting this value since if it is too
722 large, it will be trimmed by 512 bytes until the OS is happy, which may
723 require a large number of system calls. The default value is 32,768 bytes.
725 \item [Maximum Spool Size = {\it bytes}]
726 \index[sd]{Maximum Spool Size }
727 where the bytes specify the maximum spool size for all jobs that are running.
728 The default is no limit.
730 \item [Maximum Job Spool Size = {\it bytes}]
731 \index[sd]{Maximum Job Spool Size }
732 where the bytes specify the maximum spool size for any one job that is
733 running. The default is no limit.
734 This directive is implemented only in version 1.37 and later.
736 \item [Spool Directory = {\it directory}]
737 \index[sd]{Spool Directory }
738 specifies the name of the directory to be used to store the spool files for
739 this device. This directory is also used to store temporary part files when
740 writing to a device that requires mount (DVD). The default is to use the
743 \item [Maximum Part Size = {\it bytes}]
744 \index[sd]{Maximum Part Size }
745 This is the maximum size of a volume part file. The default is no limit.
746 This directive is implemented only in version 1.37 and later.
748 If the device requires mount, it is transfered to the device when this size
749 is reached. In this case, you must take care to have enough disk space left
750 in the spool directory.
752 Otherwise, it is left on the hard disk.
754 It is ignored for tape and FIFO devices.
759 \subsection*{Devices that require a mount (DVD)}
760 \index[general]{Devices that require a mount (DVD) }
761 \index[general]{DVD!Devices that require a mount }
762 \addcontentsline{toc}{subsection}{Devices that require a mount (DVD)}
764 All the directives in this section are implemented only in
765 Bacula version 1.37 and later.
769 \item [Requires Mount = {\it Yes|No}]
770 \index[sd]{Requires Mount }
771 You must set this directive to {\bf yes} for DVD-writers, and to {\bf no} for
772 all other devices (tapes/files). This directive indicates if the device
773 requires to be mounted to be read, and if it must be written in a special way.
774 If it set, {\bf Mount Point}, {\bf Mount Command}, {\bf Unmount Command} and
775 {\bf Write Part Command} directives must also be defined.
777 \item [Mount Point = {\it directory}]
778 \index[sd]{Mount Point }
779 Directory where the device can be mounted.
781 \item [Mount Command = {\it name-string}]
782 \index[sd]{Mount Command }
783 Command that must be executed to mount the device. Before the command is
784 executed, \%a is replaced with the Archive Device, and \%m with the Mount
787 Most frequently, you will define it as follows:
791 Mount Command = "/bin/mount -t iso9660 -o ro %a %m"
795 \item [Unmount Command = {\it name-string}]
796 \index[sd]{Unmount Command }
797 Command that must be executed to unmount the device. Before the command is
798 executed, \%a is replaced with the Archive Device, and \%m with the Mount
801 Most frequently, you will define it as follows:
805 Unmount Command = "/bin/umount %m"
809 \item [Write Part Command = {\it name-string}]
810 \index[sd]{Write Part Command }
811 Command that must be executed to write a part to the device. Before the
812 command is executed, \%a is replaced with the Archive Device, \%m with the
813 Mount Point, \%e is replaced with 1 if we are writing the first part,
814 and with 0 otherwise, and \%v with the current part filename.
816 For a DVD, you will most frequently specify the Bacula supplied {\bf
817 dvd-writepart} script as follows:
821 Write Part Command = "/path/dvd-writepart %e %a %v"
825 Where {\bf /path} is the path to your scripts install directory, and
826 dvd-writepart is the Bacula supplied script file.
827 This command will already be present, but commented out,
828 in the default bacula-sd.conf file. To use it, simply remove
829 the comment (\#) symbol.
832 \item [Free Space Command = {\it name-string}]
833 \index[sd]{Free Space Command }
834 Command that must be executed to check how much free space is left on the
835 device. Before the command is executed,\%a is replaced with the Archive
836 Device, \%m with the Mount Point, \%e is replaced with 1 if we are writing
837 the first part, and with 0 otherwise, and \%v with the current part filename.
839 For a DVD, you will most frequently specify the Bacula supplied {\bf
840 dvd-freespace} script as follows:
844 Free Space Command = "/path/dvd-freespace %a"
848 Where {\bf /path} is the path to your scripts install directory, and
849 dvd-freespace is the Bacula supplied script file.
850 If you want to specify your own command, please look at the code of
851 dvd-freespace to see what output Bacula expects from this command.
852 This command will already be present, but commented out,
853 in the default bacula-sd.conf file. To use it, simply remove
854 the comment (\#) symbol.
856 If you do not set it, Bacula will expect there is always free space on the
861 \label{AutochangerRes}
862 \label{AutochangerResource1}
863 \input{autochangerres}
865 \subsection*{Capabilities}
866 \index[general]{Capabilities }
867 \addcontentsline{toc}{subsection}{Capabilities}
871 \item [Label media = {\it Yes|No}]
872 \index[sd]{Label media }
873 If {\bf Yes}, permits this device to automatically label blank media without
874 an explicit operator command. It does so by using an internal algorithm as
876 \ilink{Label Format }{Label} record in each Pool resource. If
877 this is {\bf No} as by default, Bacula will label tapes only by specific
878 operator command ({\bf label} in the Console) or when the tape has been
879 recycled. The automatic labeling feature is most useful when writing to disk
880 rather than tape volumes.
882 \item [Automatic mount = {\it Yes|No}]
883 \index[sd]{Automatic mount }
884 If {\bf Yes} (the default), permits the daemon to examine the device to
885 determine if it contains a Bacula labeled volume. This is done initially when
886 the daemon is started, and then at the beginning of each job. This directive
887 is particularly important if you have set {\bf Always Open = no} because it
888 permits Bacula to attempt to read the device before asking the system
889 operator to mount a tape.
893 \subsection*{Messages Resource}
894 \label{MessagesResource1}
895 \index[general]{Resource!Messages }
896 \index[general]{Messages Resource }
897 \addcontentsline{toc}{subsection}{Messages Resource}
899 For a description of the Messages Resource, please see the
900 \ilink{Messages Resource}{_ChapterStart15} Chapter of this
903 \subsection*{Sample Storage Daemon Configuration File}
904 \label{SampleConfiguration}
905 \index[general]{File!Sample Storage Daemon Configuration }
906 \index[general]{Sample Storage Daemon Configuration File }
907 \addcontentsline{toc}{subsection}{Sample Storage Daemon Configuration File}
909 A example Storage Daemon configuration file might be the following:
914 # Default Bacula Storage Daemon Configuration file
916 # For Bacula release 1.37.2 (07 July 2005) -- gentoo 1.4.16
918 # You may need to change the name of your tape drive
919 # on the "Archive Device" directive in the Device
920 # resource. If you change the Name and/or the
921 # "Media Type" in the Device resource, please ensure
922 # that bacula-dir.conf has corresponding changes.
924 Storage { # definition of myself
927 WorkingDirectory = "$HOME/bacula/bin/working"
928 Pid Directory = "$HOME/bacula/bin/working"
929 Maximum Concurrent Jobs = 20
932 # List Directors who are permitted to contact Storage daemon
936 Password = "ZF9Ctf5PQoWCPkmR3s4atCB0usUPg+vWWyIo2VS5ti6k"
939 # Restricted Director, used by tray-monitor to get the
940 # status of the storage daemon
944 Password = "9usxgc307dMbe7jbD16v0PXlhD64UVasIDD0DH2WAujcDsc6"
948 # Devices supported by this Storage daemon
949 # To connect, the Director's bacula-dir.conf must have the
950 # same Name and MediaType.
956 Changer Command = "/home/kern/bacula/bin/mtx-changer %c %o %S %a %d"
957 Changer Device = /dev/sg0
963 Media Type = DLT-8000
964 Archive Device = /dev/nst0
965 AutomaticMount = yes; # when device opened, read it
967 RemovableMedia = yes;
970 Alert Command = "sh -c 'tapeinfo -f %c |grep TapeAlert|cat'"
976 Media Type = DLT-8000
977 Archive Device = /dev/nst1
978 AutomaticMount = yes; # when device opened, read it
980 RemovableMedia = yes;
983 Alert Command = "sh -c 'tapeinfo -f %c |grep TapeAlert|cat'"
989 Archive Device = /dev/nst0
990 AutomaticMount = yes; # when device opened, read it
992 RemovableMedia = yes;
997 # Archive Device = /dev/nst0
998 # AutomaticMount = yes; # when device opened, read it
1000 # RemovableMedia = yes;
1004 # Media Type = Floppy
1005 # Archive Device = /mnt/floppy
1006 # RemovableMedia = yes;
1007 # Random Access = Yes;
1008 # AutomaticMount = yes; # when device opened, read it
1012 # Name = FileStorage
1014 # Archive Device = /tmp
1015 # LabelMedia = yes; # lets Bacula label unlabeled media
1016 # Random Access = Yes;
1017 # AutomaticMount = yes; # when device opened, read it
1018 # RemovableMedia = no;
1022 # Name = "NEC ND-1300A"
1024 # Archive Device = /dev/hda
1025 # LabelMedia = yes; # lets Bacula label unlabeled media
1026 # Random Access = Yes;
1027 # AutomaticMount = yes; # when device opened, read it
1028 # RemovableMedia = yes;
1030 # MaximumPartSize = 800M;
1031 # RequiresMount = yes;
1032 # MountPoint = /mnt/cdrom;
1033 # MountCommand = "/bin/mount -t iso9660 -o ro %a %m";
1034 # UnmountCommand = "/bin/umount %m";
1035 # SpoolDirectory = /tmp/backup;
1036 # WritePartCommand = "/etc/bacula/dvd-writepart %e %a %v"
1037 # FreeSpaceCommand = "/etc/bacula/dvd-freespace %a"
1040 # A very old Exabyte with no end of media detection
1043 # Name = "Exabyte 8mm"
1044 # Media Type = "8mm"
1045 # Archive Device = /dev/nst0
1046 # Hardware end of medium = No;
1047 # AutomaticMount = yes; # when device opened, read it
1049 # RemovableMedia = yes;
1052 # Send all messages to the Director,
1053 # mount messages also are sent to the email address
1057 director = rufus-dir = all
1058 operator = root = mount