VirtualLibrary Tool

Table of Contents

The VirtualLibrary tool must only be used to evaluate and test the SnapProtect software. Do NOT use the VirtualLibrary tool for data protection.

For information about using a virtual library for data protection, see Virtual Tape Libraries.

Usage Notes

  • The VirtualLibraryTool.exe file is located in the <software installation path>\Base folder. Recommend creating a shortcut on the desktop for the tool. The Virtual Library Tool's initial screen as shown in the sample image is displayed.
  • Libraries created by the utility are actually XML files which are saved in the <software installation path>\LibEmulator folder.
  • Virtual tape media can be created and imported from a shelf to a library. Virtual tape media can be exported back to a shelf, deleted, or moved to another library.
  • Virtual tape will hold 4 GB compressed. This capacity can be changed in the MMS2MediaType table.
  • Virtual libraries DO NOT write backup data. Backups will run to a virtual library and report successful completion; however, no actual data is written to virtual tape. Therefore, there is no data to be restored.
  • Cleaning tapes are not supported in Virtual Libraries.
  • Indexes created in the Index Cache directory can be used to browse the backup data list, but any attempt to restore data from virtual tape will fail.
  • The VirtualLibraryTool can create direct-attached (single MediaAgent), dynamic/SAN (multiple MediaAgent), and shared (split between multiple MediaAgent) libraries. Stand-alone libraries and pooled Standalone libraries can be configured using the Library and Drive Configuration tool or by directly editing the library XML file.

Creating a Direct-Attached Library

  1. Navigate to the <software installation path>\Base\ folder and double-click VirtualLibraryTool.exe.

    Right-click the Libraries and then click Add New Library.

  2. Select the MediaAgent(s)/ NAS Servers to control the library from the Available MAs/NAS Servers list box.
  3. Click Add >> to move the MediaAgent(s)/NAS Servers to Selected MAs/NAS Servers list box and then click OK.

  4. In the Model box, type the model name to emulate a specific vendor library.

    In the Firmware box, set the firmware value.

    In the Drive Base Address box, retain the default values as Base Address values are for advanced use.

    In the Drive Count box, type or select the number of drives to be added to the library.

    In the Slot Base Address box, retain the default values as Base Address values are for advanced use.

    In the Slot Count box, type or select the number of slots to be added to the library.

    In the I/E Port Base Address box, retain the default values as Base Address values are for advanced use.

    In the I/E Port Count box, type or select the number of I/E ports to be added to the library.

    Click Drive Identifiers.

  5. Right-click the <Drive> and then click Add Drive Identifier and Drive for All Drives.

  6. Select the MediaAgent(s)/ NAS Servers to control the drives from the Available MAs/NAS Servers list box.

    Click Add >> to move the MediaAgent(s)/NAS Servers to Selected MAs/NAS Servers list box and then click OK.

    Click OK to close the Select MediaAgents/NAS Servers for Device dialog box.

    Click OK to close the Drive Identifiers dialog box.

    Click OK.

  7. The newly created library will be displayed under Libraries node.

    • Click the Drives tab and verify that the number of drives specified for that library are listed.
    • Both the Library and all Drives should have a serial number next to their description.

You have now successfully created a Virtual Tape library.

Creating and Adding Virtual Tapes to a Library

  1. Navigate to the <software installation path>\Base folder and double-click VirtualLibraryTool.exe.

    Right-click the <Library> and then click Element Status.

  2. Click Add tapes to Shelf.

    In the Barcode Prefix box, type the code to be prefixed.

    In the Start from box, type or select the starting barcode number.

    In the Number of Tapes box, type or select the number of virtual tapes to create.

    Click OK.

    The tapes will appear in the Shelf window on the right.

  3. You can select multiple tapes by holding down the CTRL key and clicking on each of the tape that you want to import from the Shelf list.

    Drag the selected tapes into the I/E Port list or Slot list.

    Number of ports to be Imported should be less than or equal to the number of I/E Ports available.

  4. Additional media can be added at anytime by repeating the above steps.

    Do not duplicate barcodes.

    For configured libraries, tapes should move from the I/E ports into library slots within 60 seconds.

    Click Refresh or select the Enable the Auto Refresh in every checkbox to set the refresh interval.

    Click Close to exit the Virtual Library Tool.

Where to go next

After you have created and added the Virtual tape to the library, configure this newly created Virtual Tape library from the CommCell Console.

For more information see, Tape Libraries - Getting Started.

Creating a Shared Tape Library

  1. Navigate to the <software installation path>\Base folder and double-click VirtualLibraryTool.exe.

    Right-click the Libraries and then click Add New Library.

  2. Select the MediaAgent(s)/ NAS Servers to control the library from the Available MAs/NAS Servers list box.
  3. Click Add >> to move the MediaAgent(s)/NAS Servers to Selected MAs/NAS Servers list box and then click OK.

  4. In the Model box, type the model name to emulate a specific vendor library.

    In the Firmware box, set the firmware value.

    In the Drive Base Address box, retain the default values as Base Address values are for advanced use.

    In the Drive Count box, type or select the number of drives to be added to the library.

    In the Slot Base Address box, retain the default values as Base Address values are for advanced use.

    In the Slot Count box, type or select the number of slots to be added to the library.

    In the I/E Port Base Address box, retain the default values as Base Address values are for advanced use.

    In the I/E Port Count box, type or select the number of I/E ports to be added to the library.

    Click Drive Identifiers.

  5. Right-click the <Drive> and then click Add New Drive Identifier and New Drive.

  6. Select the MediaAgent(s)/ NAS Servers to control the drive from the Available MAs/NAS Servers list box.

    Click Add >> to move the MediaAgent(s)/NAS Servers to Selected MAs/NAS Servers list box and then click OK.

    Repeat steps 4 and 5 for each drive, selecting which one of the available MediaAgents will control each drive.

    Click OK to close the Drive Identifier window.

    Click OK to close the Library Properties Window.

  7. The newly created library should appear in the Libraries tab of the Virtual Library Tool window

    Click on the Drives tab and verify that the number of drives specified for that library are listed.

    Both the library and all drives should have a serial number next to their description.

    Click Close to exit the Virtual Library Tool.

    You have successfully created a shared virtual tape library.

Creating a Dynamic/SAN Tape Library

Follow all steps in the procedure for creating a Direct-Attached Library except select all MediaAgents that will see the library and all the MediaAgents that will see the drives.

Creating a Stand-Alone Library

Option 1

  1. Follow all steps in the procedure for creating a Direct-Attached Library. The Library should have at least 2 drives plus as many drives as you expect to make stand-alone libraries. You do not need to create media. Virtual stand-alone libraries will be automatically loaded with a virtual tape.
  2. In the Library and Drive Config tool, right-click on a drive of the newly created library and select Create Stand-alone Library. Note that you can create many stand-alone libraries in this manner. However, there must be at least two drives left in the source library.
  3. If you intend to pool the stand-alone libraries, do not configure them at this point.
  4. Right-click on the library and configure the library and all drives.

Option 2

  1. Follow all steps in the procedure for creating a direct-attached library. The Library should have 1 drive – no slots and no import/export mail slots. You do not need to create media. Virtual stand-alone libraries will be automatically loaded with a virtual tape.
  2. Using notepad, open the LibEmulator/<library>.xml file. Look for the tag <ScsiDeviceType>8</ScsiDeviceType>. Change the 8 to a 4 and save the file.
  3. In the Library and Drive Config tool, discover the new stand-alone library. Right-click on the library and configure the library and all drives.

Creating a Pooled Stand-Alone Library

  1. See Creating a Stand-alone Library to create multiple stand-alone libraries..
  2. If you used option 1 to create stand-alone libraries, use one un-configured stand-alone library as the target and drag the drive pool from each of the other un-configured stand-alone library into the target. Right-click and configure.
  3. If you used option 2 to create stand-alone libraries, detecting the libraries should automatically pool them.

Exporting Virtual Tapes

  1. You can export virtual tapes using the standard export tasks or you can export using Vault Tracker. Exported Media will appear in the I/E port, or, if using Virtual Mail slots, they will appear in the designated virtual mail slot(s) and range.
  2. Open the VirtualLibraryTool; right-click on the library and select Element Status.
  3. Locate the exported media; highlight; and drag to the shelf. The changed status will be reflected back to the CommCell Console within 30 seconds.

Moving Virtual Tapes Between Library Shelves

You can move virtual tapes from one library shelf to another.

  1. Open the VirtualLibraryTool; right-click on the source library and select Element Status.
  2. Select tapes on the shelf and drag them down to the Library Icon (cube shape icon next to Refresh button).
  3. In the Select Library window that appears, select the target library. Click OK.
  4. Close the Element status window; right-click on the target library; and select Element Status.