IBM Storage Protect Integration

Auto-generated by IssAssist Documentation Bootstrap · 2026-06-25 Review this page and remove [TODO: verify] markers as you verify each detail.

---

IBM Storage Protect Integration Guide for IssAssist

Table of Contents

1. Prerequisites
2. Configuring the TSM Agent
3. Data Collection
4. IBM Storage Protect Operation Center Integration
5. Verifying the Connection
6. Troubleshooting Common Errors

Prerequisites

1. IBM Storage Protect Server Prerequisites

Before setting up IssAssist with your IBM Storage Protect server, ensure the following prerequisites are met:

• An ISP admin account for IssAssist with minimum required privileges
• dsmadmc CLI available on the machine running issassist-tsm-agent
• Network access from issassist-tsm-agent to the ISP server (port 1500 default)

Configuring the TSM Agent

Environment Variables

Configure the following environment variables in your shell configuration file:

Variable	Description
TSM_SERVER_HOST	Hostname or IP address of the IBM Storage Protect server. Defaults to issassist-tsm-agent if not specified.
TSM_SERVER_PORT	Port number used by dsmadmc. Defaults to 1500.
TSM_ADMIN_ID	Admin ID for IssAssist with minimum required privileges. This should be the same as your dsmadmc user.
TSM_ADMIN_PASSWORD	Password for the admin ID specified above. Make sure to keep this secure.
COLLECTION_POLLING_INTERVAL	Polling interval (in seconds) for data collection from IBM Storage Protect. Defaults to 10.

Example:

export TSM_SERVER_HOST=issassist-tsm-agent
export TSM_SERVER_PORT=1500
export TSM_ADMIN_ID=myadminid
export TSM_ADMIN_PASSWORD=mypassword
export COLLECTION_POLLING_INTERVAL=10

Data Collection

IssAssist collects the following data from IBM Storage Protect:

• Backup node status and schedule compliance
• Occupancy (storage used per node and policy domain)
• Management class and policy domain assignments
• Error log entries
• Active and historical sessions

Example Output

The dsmadmc command can be used to verify the data collection:

dsmadmc status -all

This will display information about the backup nodes, their schedule compliance, occupancy, management class assignments, and error log entries.

IBM Storage Protect Operation Center Integration

If you are using IBM Storage Protect Operation Center, you can connect to its REST API by replacing the TSM_SERVER_HOST and TSM_SERVER_PORT environment variables with the corresponding values for your Operation Center server. Additionally, you will need to specify the following:

Variable	Description
OPC_USER_ID	User ID for IssAssist with minimum required privileges in IBM Storage Protect Operation Center.
OPC_PASSWORD	Password for the user ID specified above. Make sure to keep this secure.

Example:

export OPC_USER_ID=myopcuser
export OPC_PASSWORD=mypassword

By connecting to the Operation Center REST API, you will have access to additional data compared to the dsmadmc CLI.

Verifying the Connection

To verify the connection, run the following command:

docker compose run --rm tsm-agent

This should output a success message if the connection is established correctly.

Troubleshooting Common Errors

Error	Cause	Solution
Auth failure	Incorrect TSM_ADMIN_ID or TSM_ADMIN_PASSWORD.	Double-check that the admin credentials are correct and up-to-date.
dsmadmc not found	dsmadmc CLI not installed or accessible.	Install dsmadmc CLI or ensure it is accessible from the machine running issassist-tsm-agent.
Network timeout	Insufficient network connectivity between issassist-tsm-agent and IBM Storage Protect server.	Verify network connectivity and check for firewall rules blocking communication between the two services.

By following this guide, you should be able to successfully set up IssAssist with your IBM Storage Protect server and start collecting data in real-time.