Running Must-Gather scripts

Edit online

You can run the Must-Gather script for IBM Storage Protect for Databases- Data Protection for Oracle to collect diagnostic information required by IBM Support.

For more information about the script location, installation, and prerequisites, see Collecting diagnostic data using Must-Gather scripts.

Supported operating systems

  • Windows
  • Linux (RHEL, SLES)
  • Solaris
  • Z Linux (RHEL,SLES)
  • AIX

Prerequisites

  • Perl 5.x installed
  • Sudo privileges for network/firewall commands (Linux/Solaris/AIX).
  • IBM Storage Protect Data protection for Oracle must be installed on the system.
  • Output directory must have write permissions.

How to run the Must-Gather script

  1. Open a terminal at the Must-Gather script directory.
  2. Run the following command. For example: 
    perl mustgather.pl --product sp-client-oracle --output-dir     <output-dir-path> --caseno <case_number> --adminid <id> [options]
Example: 
perl mustgather.pl --product sp-client-oracle --output-dir /tmp/mustgather_output --caseno TS020999999 --adminid admin –verbose
perl mustgather.pl -p sp-client-oracle -c TS020999999 -id admin -o mustgather_output -v
perl mustgather.pl --product sp-client-oracle --output-dir C:\mustgather_output --caseno TS020999999 --adminid admin --verbose

Data protect for Oracle modules

Table 1. Oracle modules
Module Description
config Collects IBM Storage Protect configuration files (dsm.opt, dsm.sys, dsminfo.txt, query vm).
logs Gathers client logs such as dsmj.log, dsminstr.log, dsmwebcl.log, dsmerror.log, and dsmsched.log.
performance Captures performance metrics and instrumentation logs (dsminstr.log).
server Runs Storage Protect administrative queries for system, storage, logs, and server status.
system Collects system information, OS details, and environment variables.
oracle Collects tdpo.opt, dsm.opt (from DSMI_ORC_CONFIG), dsm.sys (UNIX only), dsmerror.log, dsminstr.log, tdpoerror.log, and dsmsched.log. Also gathers OS level details and the full RMAN script used for the backup or restore operation.
network Performs network checks including ping, port check, firewall rules, and tcpdump capture.

Output summary

The collected data is saved in the specified output directory and automatically compressed into a .zip file (unless --no-compress is used): 
############## Starting Collection of sp-client-oracle diagnostic information ##############
 
 
Enter RMAN backup script path (Example: /u01/scripts/rman_backup.rcv or C:\oracle\scripts\rman_backup.rcv)
Press Enter to skip: c:\oracleTDPLogs\rman_allocate_channel.rcv
 
Enter RMAN message log path (Example: /u01/logs/rman_backup.log or C:\oracle\logs\rman_backup.log)
Press Enter to skip:
 
Enter Oracle OS username (Example: oracle)
Press Enter to skip environment capture: oracleOS

=== Must-Gather Collection Summary ===
Product              : sp-client-oracle
Version              : 8.2.1.0
Node Name            : NODE-WIN-1
Server Name          : DSMSERV
 
    Modules         : Status
-----------------------------
 1. config          : Success
 2. logs            : Partial
 3. network         : Partial
 4. oracle          : Partial
 5. performance     : Success
 6. server          : Failed
 7. system          : Partial
 
Check script.log inside each module folder for detailed failures.
 
Output : must\mustgather_TS020999999_sp-client-oracle_20260304_205324.zip
 
This file can be sent to IBM Support team for analysis.

The .zip file contains the diagnostic data for each module in the following file format:

mustgather_<case_number>_<product_name>_<timestamp>.zip