Important: You must be using the TCP/IP communications protocol to communicate with the TSM Server to use this interface. No other protocol is supported.

Tivoli Storage Manager (TSM) is a complete data management solution for the unattended backup and recovery of a client/server network. Users can back up various platforms to the TSM Server while managing the distributed data centrally, allowing it to be used with most of today’s network environments.

HelpSystems has worked with IBM to provide their IBM i customers with an interface to TSM using Robot Save. Customers use Robot Save as the TSM Client to save IBM i data to the TSM Server.

Robot Save treats the TSM Server as an attached device, thus supporting all the common backup and recovery functions already built into Robot Save. Robot Save handles the saved data as if it had been saved to a physical volume, making the process transparent to the user.

This article describes how to set up Robot Save to use the TSM Server. Before you set up Robot Save, you must have the following:

  • OS/400 Version 4.5 or higher

  • TSM Server software installed and configured

  • TSM Client APIs installed and configured on your systems

Note: After you install and set up TSM and Robot Save, keep these instructions in a safe place. They contain important information should you need to perform a complete system restoration.

TSM Configuration

IBM will set up and configure your TSM software. The following occurs during TSM configuration:

On the TSM Server

  • Each IBM i TSM Client is registered on the server as a node. Select a unique node name for each IBM i. We suggest that you select the system name of the IBM i.

    Note: Write down the node name and password entered during this step.

  • After registering each client node, start a Tivoli Administrative session and verify that the node has the authority to clear a filespace. Enter the following Tivoli command to check each node:

    query node <node_name> format=detailed

    A node has the required authority when the Archive Delete Allowed and Backup Delete Allowed options are both set to Yes. If these options are not set to Yes on a node, enter the following Tivoli command to change them to Yes. Do this on each node.

    update node<node_name> archdelete=YES backdelete=YES

On each IBM i

  • A TSM Client options file called QANSAPI/QOPTADSM(APIOPT) is created during installation. Edit this file to include the following line:

    NODENAME <node_name>

    where node_name is the node name of the IBM i you wrote down in the previous step.

  • You need to provide Robot Save with information on how you have set up communications between the TSM Client (the IBM i) and the TSM Server. Enter the following commands on a command line:



    The ADSM Client API Configuration Setup panel displays.

    Fill in the name of the API Configuration Options file, and the library and member names. Enter the password specified during the TSM Server configuration. If you have any questions about the information that should be entered into the panel, contact your IBM representative.

You are now ready to complete your Robot Save system setup and define a backup class and sets.

Setting Up Robot Save

Setting up Robot SAVE to use the TSM Server is the same as defining and using any other device, such as a tape device.

Note: If you’re doing a new install of Robot Save, follow the instructions for system setup in the Robot Save User Guide.

Robot Save handles data saved to the TSM Server as if it is saved to a physical volume. To allow Robot Save to create virtual volume names to keep track of the saved data, enter the following command and press F4 to display the command prompt panel:


Specify Y in the Auto-initialize during save field. This allows Robot Save to initialize volumes automatically during the backup process.

The following steps describe how to define the device, and create a backup class and backup sets when you use TSM. See the Robot Save User Guide if you need additional information about these panels.

Define the Save Device

  1. On the Robot Save Main Menu, select option 7, System Setup Menu. When the System Setup Menu displays, select option 1. The Save Device Maintenance panel displays so you can define TSM as a device to Robot Save. Press F5 to refresh the display if the TSM device does not appear on the panel.

  2. Enter a 3 next to the device *TSM to define it to Robot Save.


    • You must define the device to Robot Save before you can select it in a backup set.

    • You cannot change the name or other device information for TSM.

Create a Backup Class

  1. On the Automated Backup Setup Menu, select option 1, Maintain Backup Classes and Sets. When the Backup Class Maintenance panel displays, press F6 to add a new backup class for the TSM Server. The Backup Class Entry panel displays.

  2. Complete the panel with the backup class information:

    Note: Usage types PC Backup and Data Sets only are not valid for TSM backups.

    • Enter the name and a brief description of the backup class and specify the rotation information.

    • Select the Usage type for the backup class. You can select a usage type of Backup/Restore, Objects Lists, or Backup, no Restore.

    • Select the volume naming method for the backup class. We suggest you use either serial or logical naming. Manual naming is not recommended.

    See the Robot Save User Guide for a complete discussion on entering backup class information.

Define Backup Sets

Once your backup class has been defined, you can set up backup sets that specify the libraries or objects to be saved.

  1. On the Backup Class Maintenance panel, enter a 2 next to the backup class you just created. When the Backup Set Definition Maintenance panel displays, press F6 to define a backup set.

    The Backup Set Information panel displays.

  2. Complete the panel with the information for the backup set. Specify the name and a brief description of the backup set. For a complete discussion of the fields on the Backup Set Information panel, see the Robot Save User Guide.

    Note: You must specify *TSM as the Save device for the backup set. You can enter *TSM in the Save device field and Save media fields. You cannot specify any other device names.

  3. Define as many backup sets as you need within your backup class. For example, you could have a backup set to save an object list, or another backup set that saves folders and documents.

When you have finished defining your backup sets, you can schedule the backup on Robot Schedule, the job scheduler, or run the save from the Robot Save Operations Menu. See the Robot Save User Guide for complete information on executing a Robot Save backup.

System Restoration From the TSM Server

To restore a library or object from the TSM Server, you follow the same procedures as you do to restore from any save device. See the Robot Save User Guide for a complete discussion on restoring libraries or objects.

However, if you use the TSM Server as your backup device, there are some special considerations when you need to perform a complete system restoration.

Use the following checklist to restore your system properly.

  1. Find the last Restoration Procedures Report printed by Robot Save.

  2. Mount the first tape of the SAVSYS on the tape drive. The restoration report tells you the volumes to use. Turn on the console.

  3. See the instructions for installing or restoring Licensed Internal Code (microcode) in IBM’s Backup and Recovery Guide. Do an IPL using the SAVSYS volumes.

  4. You will need to do a special restore of the IBM i operating system using the SAVSYS volumes. See the detailed instructions in IBM’s Backup and Recovery Guide.

  5. Sign on as security officer on the console.

    Note: If you are using the TSM software, your restoration report contains special instructions.

    • Before continuing with the restoration, install and configure the TSM Client APIs. This makes TSM available as a restore device. If you have questions, contact your IBM representative.

      Then, follow the instructions in the restoration report to restore the files needed by TSM. You will do the following:

      • Restore the special Robot Save TSM commands from the volume listed on your restoration report. If no volume is listed, use the media sent to you by HelpSystems.

      • Run the DSMCFGAPI command to configure the TSM Client software. Enter the information asked for on the panel.

    • Continue with the system restoration instructions.

      Note: During the restoration, you may need to restore data from the TSM Server. When you restore data from the TSM Server, you must first restore a save file, then restore your data from that save file. The commands you need to perform a restoration from the TSM Server are printed in the restoration report for every library or object that has been saved to the TSM Server. After you have restored your data, you can delete the save file.

  6. Mount the volumes indicated on the restoration report for the restore user profile data. Enter the restore user profile data command as indicated on the restoration report.

  7. Mount the volumes indicated on the restoration report for the restore configuration data. Enter the restore configuration data command as indicated on the restoration report.

  8. Restore the Robot Save data library RBSDTALIB. Mount the volumes indicated and enter the restore command that is on the restoration report.

  9. Restore the Robot Save program library RBSPGMLIB. You may have to restore the library and then restore the changes to the library. Mount the volumes indicated and enter the restore commands that are on the restoration report.

  10. Restore the library RBTSYSLIB. Mount the volumes indicated and enter the restore command that is on the restoration report.

  11. Add RBTSYSLIB to the system portion of your library list. Use the CHGSYSLIBL command to do this.

  12. Add RBSPGMLIB and RBSDTALIB to your library list. Execute the command RBSRSTSAVF. This restores the data necessary to access the save files on your ASP. The data is stored in library RBSDTALIB.

  13. If you're restoring your system at a hot site whose system name differs from your regular system name, run the RSLCHGSYSN (Change System Name in Files) command to rename the system in Robot Save’s files for the restoration process.

    RSLCHGSYSN BEFORE(previous system name) AFTER(current system name) PRODUCT(ROBOTSAV)

  14. If you are restoring from *NONSYS save, enter the following command using the tapes specified on the restoration report:

    RSTLIB SAVLIB(*NONSYS) DEV(device name)

    Skip steps 15 though 17 and proceed with step 18.

  15. Enter the command RBS to access the Robot Save Main Menu. Select option 5 to go to the Automated Backup Setup Menu.

  16. On the Automated Backup Setup Menu, select option 4 to display the Guided System Restoration Procedures panel.

  17. Press F21 to select system restoration. Robot Save tells you which volumes to mount and then restores the libraries automatically until all the libraries and their changes are restored. When each library is restored, it is marked "RESTORED."

    If any volumes are not available, enter option 2 next to the library for alternate volumes to use. If those are not available, go to the Library Archive Inquiry panel to find the latest available volumes for that library. Restore the library from those volumes.

  18. Enter the following command to restore your documents and folders:


    Or, select QDOC from the Robot Save Guided System Restoration Procedures panel.

  19. If you save the Integrated File System (IFS), use the RST command to restore IFS files.

  20. When all the libraries and their changes are restored, enter the following commands on the system console to restore object authority for the objects:



  21. If some objects were created after you did your last save of user profile security data, the ownership of the objects is transferred to the system default owner. You can fix this problem by executing the command for each library which has this problem.

    RBSCHGOWN LIBRARY(library name)

    When you execute this command, Robot Save finds the object archive entry for each object in the library and changes the ownership to the object owner as of the last object save. This should take care of any lost owner problems.

  22. If you are using journaling, you will need to apply your journal receivers from the last time Robot SAVE did a save of the file. Run the DSPJRN command on the file to find out when the file was last saved. The next sequence number should be placed on the parameter FROMENT of the command APYJRNCHG. Use *LAST for the ending sequence number.

  23. Similarly, apply the journal receivers to all the appropriate files in your libraries.

  24. When you have finished and everything looks normal, do a PWRDWNSYS *IMMED RESTART(*YES).

TSM Limitations

The Robot Save interface to the TSM Server has the following limitations:

  • You can use Robot Save only for save operations that can be directed to a save file. This means the following save types cannot be used with the TSM Server:

    • SAVSYS




    • Some forms of the SAV command

    • Domino Online Backup

  • Robot Save PC backups are not supported.

  • The RBSRECORD command is not supported.

  • Data Sets are not supported.

  • The IBM i cannot be in a restricted state because the TSM software runs in its own subsystem.

Robot Save supports all of these backups when you are saving to another device type, such as a tape drive. See the Robot Save User Guide for a complete discussion of how to back up your IBM i using Robot Save.


Still have questions? We can help. Submit a case to Technical Support.

Last Modified On: January 10, 2020