Subsections

- An Example Configuration File
- A Multi-drive Example Configuration File
- Specifying Slots When Labeling
- Changing Cartridges
- Dealing with Multiple Magazines
- Simulating Barcodes in your Autochanger
- The Full Form of the Update Slots Command
- FreeBSD Issues
- Testing Autochanger and Adapting mtx-changer script
- Using the Autochanger
- Barcode Support
- Use bconsole to display Autochanger content
- Bacula Autochanger Interface

# Autochanger Resource

The Autochanger resource supports single or multiple drive autochangers by grouping one or more Device resources into one unit called an autochanger in Bacula (often referred to as a "tape library" by autochanger manufacturers).

If you have an Autochanger, and you want it to function correctly, you must have an Autochanger resource in your Storage conf file, and your Director's Storage directives that want to use an Autochanger must refer to the Autochanger resource name. In previous versions of Bacula, the Director's Storage directives referred directly to Device resources that were autochangers. In version 1.38.0 and later, referring directly to Device resources will not work for Autochangers.

Name = Autochanger-Name
  Specifies the Name of the Autochanger. This name is used in the Director's Storage definition to refer to the autochanger. This directive is required.

Device = Device-name1, device-name2, ...
  Specifies the names of the Device resource or resources that correspond to the autochanger drive. If you have a multiple drive autochanger, you must specify multiple Device names, each one referring to a separate Device resource that contains a Drive Index specification that corresponds to the drive number base zero. You may specify multiple device names on a single line separated by commas, and/or you may specify multiple Device directives. This directive is required.

Changer Device = device-name
  In addition to the Archive Device name, you may specify a Changer Device name. This is because most autochangers are controlled through a different device than is used for reading and writing the cartridges. For example, on Linux, one normally uses the generic SCSI interface for controlling the autochanger, but the standard SCSI interface for reading and writing the tapes. On Linux, for the Archive Device = /dev/nst0, you would typically have Changer Device = /dev/sg0. Note, some of the more advanced autochangers will locate the changer device on /dev/sg1. Such devices typically have several drives and a large number of tapes.

  On FreeBSD systems, the changer device will typically be on /dev/pass0 through /dev/passn.

  On Solaris, the changer device will typically be some file under /dev/rdsk.

  Please ensure that your Storage daemon has permission to access this device.

Changer Command = command
  This record is used to specify the external program to call and what arguments to pass to it. The command is assumed to be a standard program or shell script that can be executed by the operating system. This command is invoked each time that Bacula wishes to manipulate the autochanger. The following substitutions are made in the command before it is sent to the operating system for execution:

            %% = %
            %a = archive device name
            %c = changer device name
            %d = changer drive index base 0
            %f = Client's name
            %j = Job name
            %o = command  (loaded, load, or unload)
            %s = Slot base 0
            %S = Slot base 1
            %v = Volume name

  An actual example for using mtx with the mtx-changer script (part of the Bacula distribution) is:

      Changer Command = "/etc/bacula/mtx-changer %c %o %S %a %d"

  Where you will need to adapt the /etc/bacula to be the actual path on your system where the mtx-changer script resides. Details of the three commands currently used by Bacula (loaded, load, unload) as well as the output expected by Bacula are give in the Bacula Autochanger Interface section below.

The following is an example of a valid Autochanger resource definition:

    Autochanger {
      Name = "DDS-4-changer"
      Device = DDS-4-1, DDS-4-2, DDS-4-3
      Changer Device = /dev/sg0
      Changer Command = "/etc/bacula/mtx-changer %c %o %S %a %d"
    }
    Device {
      Name = "DDS-4-1"
      Drive Index = 0
      Autochanger = yes
      ...
    }
    Device {
      Name = "DDS-4-2"
      Drive Index = 1
      Autochanger = yes
      ...
    Device {
      Name = "DDS-4-3"
      Drive Index = 2
      Autochanger = yes
      Autoselect = no
      ...
    }

Please note that it is important to include the Autochanger = yes directive in each Device definition that belongs to an Autochanger. A device definition should not belong to more than one Autochanger resource. Also, your Device directive in the Storage resource of the Director's conf file should have the Autochanger's resource name rather than a name of one of the Devices.

If you have a drive that physically belongs to an Autochanger but you don't want to have it automatically used when Bacula references the Autochanger for backups, for example, you want to reserve it for restores, you can add the directive:

    Autoselect = no

to the Device resource for that drive. In that case, Bacula will not automatically select that drive when accessing the Autochanger. You can, still use the drive by referencing it by the Device name directly rather than the Autochanger name. An example of such a definition is shown above for the Device DDS-4-3, which will not be selected when the name DDS-4-changer is used in a Storage definition, but will be used if DDS-4-3 is used.

# An Example Configuration File

The following two resources implement an autochanger:

    Autochanger {
      Name = "Autochanger"
      Device = DDS-4
      Changer Device = /dev/sg0
      Changer Command = "/etc/bacula/mtx-changer %c %o %S %a %d"
    }

    Device {
      Name = DDS-4
      Media Type = DDS-4
      Archive Device = /dev/nst0    # Normal archive device
      Autochanger = yes
      LabelMedia = no;
      AutomaticMount = yes;
      AlwaysOpen = yes;
    }

where you will adapt the Archive Device, the Changer Device, and the path to the Changer Command to correspond to the values used on your system.

# A Multi-drive Example Configuration File

The following resources implement a multi-drive autochanger:

    Autochanger {
      Name = "Autochanger"
      Device = Drive-1, Drive-2
      Changer Device = /dev/sg0
      Changer Command = "/etc/bacula/mtx-changer %c %o %S %a %d"
    }

    Device {
      Name = Drive-1
      Drive Index = 0
      Media Type = DDS-4
      Archive Device = /dev/nst0    # Normal archive device
      Autochanger = yes
      LabelMedia = no;
      AutomaticMount = yes;
      AlwaysOpen = yes;
    }

    Device {
      Name = Drive-2
      Drive Index = 1
      Media Type = DDS-4
      Archive Device = /dev/nst1    # Normal archive device
      Autochanger = yes
      LabelMedia = no;
      AutomaticMount = yes;
      AlwaysOpen = yes;
    }

where you will adapt the Archive Device, the Changer Device, and the path to the Changer Command to correspond to the values used on your system.

# Specifying Slots When Labeling

If you add an Autochanger = yes record to the Storage resource in your Director's configuration file, the Bacula Console will automatically prompt you for the slot number when the Volume is in the changer when you add or label tapes for that Storage device. If your mtx-changer script is properly installed, Bacula will automatically load the correct tape during the label command.

You must also set Autochanger = yes in the Storage daemon's Device resource as we have described above in order for the autochanger to be used. Please see the Storage ResourceAutochanger1 in the Director's chapter and the Device ResourceAutochanger in the Storage daemon chapter for more details on these records.

Thus all stages of dealing with tapes can be totally automated. It is also possible to set or change the Slot using the update command in the Console and selecting Volume Parameters to update.

Even though all the above configuration statements are specified and correct, Bacula will attempt to access the autochanger only if a slot is non-zero in the catalog Volume record (with the Volume name).

If your autochanger has barcode labels, you can label all the Volumes in your autochanger one after another by using the label barcodes command. For each tape in the changer containing a barcode, Bacula will mount the tape and then label it with the same name as the barcode. An appropriate Media record will also be created in the catalog. Any barcode that begins with the same characters as specified on the "CleaningPrefix=xxx" command, will be treated as a cleaning tape, and will not be labeled. For example with:

    Pool {
      Name ...
      Cleaning Prefix = "CLN"
    }

Any slot containing a barcode of CLNxxxx will be treated as a cleaning tape and will not be mounted.

Please note that Volumes must be pre-labeled to be automatically used in the autochanger during a backup. If you do not have a barcode reader, this is done manually (or via a script).

# Changing Cartridges

If you wish to insert or remove cartridges in your autochanger or you manually run the mtx program, you must first tell Bacula to release the autochanger by doing:

    unmount
    (change cartridges and/or run mtx)
    mount

If you do not do the unmount before making such a change, Bacula will become completely confused about what is in the autochanger and may stop function because it expects to have exclusive use of the autochanger while it has the drive mounted.

# Dealing with Multiple Magazines

If you have several magazines or if you insert or remove cartridges from a magazine, you should notify Bacula of this. By doing so, Bacula will as a preference, use Volumes that it knows to be in the autochanger before accessing Volumes that are not in the autochanger. This prevents unneeded operator intervention.

If your autochanger has barcodes (machine readable tape labels), the task of informing Bacula is simple. Every time, you change a magazine, or add or remove a cartridge from the magazine, simply do

    unmount
    (remove magazine)
    (insert new magazine)
    update slots
    mount

in the Console program. This will cause Bacula to request the autochanger to return the current Volume names in the magazine. This will be done without actually accessing or reading the Volumes because the barcode reader does this during inventory when the autochanger is first turned on. Bacula will ensure that any Volumes that are currently marked as being in the magazine are marked as no longer in the magazine, and the new list of Volumes will be marked as being in the magazine. In addition, the Slot numbers of the Volumes will be corrected in Bacula's catalog if they are incorrect (added or moved).

If you do not have a barcode reader on your autochanger, you have several alternatives.

1. You can manually set the Slot and InChanger flag using the update volume command in the Console (quite painful).

2. You can issue a

       update slots scan

   command that will cause Bacula to read the label on each of the cartridges in the magazine in turn and update the information (Slot, InChanger flag) in the catalog. This is quite effective but does take time to load each cartridge into the drive in turn and read the Volume label.

3. You can modify the mtx-changer script so that it simulates an autochanger with barcodes. See below for more details.

# Simulating Barcodes in your Autochanger

You can simulate barcodes in your autochanger by making the mtx-changer script return the same information that an autochanger with barcodes would do. This is done by commenting out the one and only line in the list) case, which is:

      ${MTX} -f $ctl status | grep " *Storage Element [0-9]*:.*Full" | awk "{print \$3 \$4}" | sed "s/Full *\(:VolumeTag=\)*//"

at approximately line 99 by putting a # in column one of that line, or by simply deleting it. Then in its place add a new line that prints the contents of a file. For example:

    cat /etc/bacula/changer.volumes

Be sure to include a full path to the file, which can have any name. The contents of the file must be of the following format:

    1:Volume1
    2:Volume2
    3:Volume3
    ...

Where the 1, 2, 3 are the slot numbers and Volume1, Volume2, ... are the Volume names in those slots. You can have multiple files that represent the Volumes in different magazines, and when you change magazines, simply copy the contents of the correct file into your /etc/bacula/changer.volumes file. There is no need to stop and start Bacula when you change magazines, simply put the correct data in the file, then run the update slots command, and your autochanger will appear to Bacula to be an autochanger with barcodes.

# The Full Form of the Update Slots Command

If you change only one cartridge in the magazine, you may not want to scan all Volumes, so the update slots command (as well as the update slots scan command) has the additional form:

    update slots=n1,n2,n3-n4, ...

where the keyword scan can be appended or not. The n1,n2, ... represent Slot numbers to be updated and the form n3-n4 represents a range of Slot numbers to be updated (e.g. 4-7 will update Slots 4,5,6, and 7).

This form is particularly useful if you want to do a scan (time expensive) and restrict the update to one or two slots.

For example, the command:

    update slots=1,6 scan

will cause Bacula to load the Volume in Slot 1, read its Volume label and update the Catalog. It will do the same for the Volume in Slot 6. The command:

    update slots=1-3,6

will read the barcoded Volume names for slots 1,2,3 and 6 and make the appropriate updates in the Catalog. If you don't have a barcode reader or have not modified the mtx-changer script as described above, the above command will not find any Volume names so will do nothing.

# FreeBSD Issues

If you are having problems on FreeBSD when Bacula tries to select a tape, and the message is Device not configured, this is because FreeBSD has made the tape device /dev/nsa1 disappear when there is no tape mounted in the autochanger slot. As a consequence, Bacula is unable to open the device. The solution to the problem is to make sure that some tape is loaded into the tape drive before starting Bacula.

Please see the Tape TestingFreeBSDTapesproblemschapter of the Bacula Enterprise Problem Resolution Guide for important information concerning your tape drive before doing the autochanger testing.

# Testing Autochanger and Adapting mtx-changer script

Before attempting to use the autochanger with Bacula, it is preferable to "hand-test" that the changer works. To do so, we suggest you do the following commands (assuming that the mtx-changer script is installed in /etc/bacula/mtx-changer):

Make sure Bacula is not running.

/etc/bacula/mtx-changer /dev/sg0 list 0 /dev/nst0 0

  This command should print:

         1:
         2:
         3:
         ...

  or one number per line for each slot that is occupied in your changer, and the number should be terminated by a colon (:). If your changer has barcodes, the barcode will follow the colon. If an error message is printed, you must resolve the problem (e.g. try a different SCSI control device name if /dev/sg0 is incorrect). For example, on FreeBSD systems, the autochanger SCSI control device is generally /dev/pass2.

/etc/bacula/mtx-changer /dev/sg0 listall 0 /dev/nst0 0

  This command should print:

       Drive content:         D:Drive num:F:Slot loaded:Volume Name
       D:0:F:2:vol2        or D:Drive num:E
       D:1:F:42:vol42
       D:3:E

       Slot content:
       S:1:F:vol1             S:Slot num:F:Volume Name
       S:2:E               or S:Slot num:E
       S:3:F:vol4

       Import/Export tray slots:
       I:10:F:vol10           I:Slot num:F:Volume Name
       I:11:E              or I:Slot num:E
       I:12:F:vol40

/etc/bacula/mtx-changer /dev/sg0 transfer 1 2

  This command should transfer a volume from source (1) to destination (2)

/etc/bacula/mtx-changer /dev/sg0 slots

  This command should return the number of slots in your autochanger.

/etc/bacula/mtx-changer /dev/sg0 unload 1 /dev/nst0 0

  If a tape is loaded from slot 1, this should cause it to be unloaded.

/etc/bacula/mtx-changer /dev/sg0 load 3 /dev/nst0 0

  Assuming you have a tape in slot 3, it will be loaded into drive (0).

/etc/bacula/mtx-changer /dev/sg0 loaded 0 /dev/nst0 0

  It should print "3" Note, we have used an "illegal" slot number 0. In this case, it is simply ignored because the slot number is not used. However, it must be specified because the drive parameter at the end of the command is needed to select the correct drive.

/etc/bacula/mtx-changer /dev/sg0 unload 3 /dev/nst0 0

  will unload the tape into slot 3.

Once all the above commands work correctly, assuming that you have the right Changer Command in your configuration, Bacula should be able to operate the changer. The only remaining area of problems will be if your autoloader needs some time to get the tape loaded after issuing the command. After the mtx-changer script returns, Bacula will immediately rewind and read the tape. If Bacula gets rewind I/O errors after a tape change, you will probably need to insert a sleep 20 after the mtx command, but be careful to exit the script with a zero status by adding exit 0 after any additional commands you add to the script. This is because Bacula checks the return status of the script, which should be zero if all went well.

You can test whether or not you need a sleep by putting the following commands into a file and running it as a script:

    #!/bin/sh
    /etc/bacula/mtx-changer /dev/sg0 unload 1 /dev/nst0 0
    /etc/bacula/mtx-changer /dev/sg0 load 3 /dev/nst0 0
    mt -f /dev/st0 rewind
    mt -f /dev/st0 weof

If the above script runs, you probably have no timing problems. If it does not run, start by putting a sleep 30 or possibly a sleep 60 in the script just after the mtx-changer load command. If that works, then you should move the sleep into the actual mtx-changer script so that it will be effective when Bacula runs.

A second problem that comes up with a small number of autochangers is that they need to have the cartridge ejected before it can be removed. If this is the case, the load 3 will never succeed regardless of how long you wait. If this seems to be your problem, you can insert an eject just after the unload so that the script looks like:

    #!/bin/sh
    /etc/bacula/mtx-changer /dev/sg0 unload 1 /dev/nst0 0
    mt -f /dev/st0 offline
    /etc/bacula/mtx-changer /dev/sg0 load 3 /dev/nst0 0
    mt -f /dev/st0 rewind
    mt -f /dev/st0 weof

Obviously, if you need the offline command, you should move it into the mtx-changer script ensuring that you save the status of the mtx command or always force an exit 0 from the script, because Bacula checks the return status of the script.

As noted earlier, there are several scripts in bacula-source/examples/devices that implement the above features, so they may be a help to you in getting your script to work.

If Bacula complains "Rewind error on /dev/nst0. ERR=Input/output error." you most likely need more sleep time in your mtx-changer before returning to Bacula after a load command has been completed.

# Using the Autochanger

Let's assume that you have properly defined the necessary Storage daemon Device records, and you have added the Autochanger = yes record to the Storage resource in your Director's configuration file.

Now you fill your autochanger with say six blank tapes.

What do you do to make Bacula access those tapes?

One strategy is to prelabel each of the tapes. Do so by starting Bacula, then with the Console program, enter the label command:

    ./bconsole
    Connecting to Director rufus:8101
    1000 OK: rufus-dir Version: 7.9.1 (29 May 2017)
    *label

it will then print something like:

    Using default Catalog name=BackupDB DB=bacula
    The defined Storage resources are:
         1: Autochanger
         2: File
    Select Storage resource (1-2): 1

I select the autochanger (1), and it prints:

    Enter new Volume name: TestVolume1
    Enter slot (0 for none): 1

where I entered TestVolume1 for the tape name, and slot 1 for the slot. It then asks:

    Defined Pools:
         1: Default
         2: File
    Select the Pool (1-2): 1

I select the Default pool. This will be automatically done if you only have a single pool, then Bacula will proceed to unload any loaded volume, load the volume in slot 1 and label it. In this example, nothing was in the drive, so it printed:

    Connecting to Storage daemon Autochanger at localhost:9103 ...
    Sending label command ...
    3903 Issuing autochanger "load slot 1" command.
    3000 OK label. Volume=TestVolume1 Device=/dev/nst0
    Media record for Volume=TestVolume1 successfully created.
    Requesting mount Autochanger ...
    3001 Device /dev/nst0 is mounted with Volume TestVolume1
    You have messages.
    *

You may then proceed to label the other volumes. The messages will change slightly because Bacula will unload the volume (just labeled TestVolume1) before loading the next volume to be labeled.

Once all your Volumes are labeled, Bacula will automatically load them as they are needed.

To "see" how you have labeled your Volumes, simply enter the list volumes command from the Console program, which should print something like the following:

    *{\bf list volumes}
    Using default Catalog name=BackupDB DB=bacula
    Defined Pools:
         1: Default
         2: File
    Select the Pool (1-2): 1
    +-------+----------+--------+---------+-------+--------+----------+-------+------+
    | MedId | VolName  | MedTyp | VolStat | Bites | LstWrt | VolReten | Recyc | Slot |
    +-------+----------+--------+---------+-------+--------+----------+-------+------+
    | 1     | TestVol1 | DDS-4  | Append  | 0     | 0      | 30672000 | 0     | 1    |
    | 2     | TestVol2 | DDS-4  | Append  | 0     | 0      | 30672000 | 0     | 2    |
    | 3     | TestVol3 | DDS-4  | Append  | 0     | 0      | 30672000 | 0     | 3    |
    | ...                                                                            |
    +-------+----------+--------+---------+-------+--------+----------+-------+------+

# Barcode Support

Bacula provides barcode support with two Console commands, label barcodes and update slots.

The label barcodes will cause Bacula to read the barcodes of all the cassettes that are currently installed in the magazine (cassette holder) using the mtx-changer list command. Each cassette is mounted in turn and labeled with the same Volume name as the barcode.

The update slots command will first obtain the list of cassettes and their barcodes from mtx-changer. Then it will find each volume in turn in the catalog database corresponding to the barcodes and set its Slot to correspond to the value just read. If the Volume is not in the catalog, then nothing will be done. This command is useful for synchronizing Bacula with the current magazine in case you have changed magazines or in case you have moved cassettes from one slot to another. If the autochanger is empty, nothing will be done.

The Cleaning Prefix statement can be used in the Pool resource to define a Volume name prefix, which if it matches that of the Volume (barcode) will cause that Volume to be marked with a VolStatus of Cleaning. This will prevent Bacula from attempting to write on the Volume.

# Use bconsole to display Autochanger content

The status slots storage=xxx command displays autochanger content.

     Slot |  Volume Name    |  Status  |      Type         |    Pool        |  Loaded |
    ------+-----------------+----------+-------------------+----------------+---------|
        1 |           00001 |   Append |  DiskChangerMedia |        Default |    0    |
        2 |           00002 |   Append |  DiskChangerMedia |        Default |    0    |
        3*|           00003 |   Append |  DiskChangerMedia |        Scratch |    0    |
        4 |                 |          |                   |                |    0    |

If you see a * near the slot number, you have to run update slots command to synchronize autochanger content with your catalog.

# Bacula Autochanger Interface

Bacula calls the autochanger script that you specify on the Changer Command statement. Normally this script will be the mtx-changer script that we provide, but it can in fact be any program. The only requirement for the script is that it must understand the commands that Bacula uses, which are loaded, load, unload, list, and slots. In addition, each of those commands must return the information in the precise format as specified below:

    - Currently the changer commands used are:
        loaded -- returns number of the slot that is loaded, base 1,
                  in the drive or 0 if the drive is empty.
        load   -- loads a specified slot (note, some autochangers
                  require a 30 second pause after this command) into
                  the drive.
        unload -- unloads the device (returns cassette to its slot).
        list   -- returns one line for each cassette in the autochanger
                  in the format <slot>:<barcode>. Where
                  the {\bf slot} is the non-zero integer representing
                  the slot number, and {\bf barcode} is the barcode
                  associated with the cassette if it exists and if you
                  autoloader supports barcodes. Otherwise the barcode
                  field is blank.
        slots  -- returns total number of slots in the autochanger.

Bacula checks the exit status of the program called, and if it is zero, the data is accepted. If the exit status is non-zero, Bacula will print an error message and request the tape be manually mounted on the drive.