IBM Support

IBM MustGather: Read first for IBM API Connect



MustGather information aids in problem determination and save time resolving cases. API Connect Support can understand better the problem and save time analyzing the data.

Resolving The Problem

You can select your IBM API Connect version to collect the MustGather information.

In the "Intro to IBM API Connect MustGather & Hints and Tips" Tab you can find the following:

Gathering information to open a support ticket
A valid IBM customer number, contact name, email address, and phone number are important to validate the entitlement and contact information.
Refer the section "Accessing Software Support" in the IBM Software Support Handbook to have the full list of information necessary to open a support ticket.

To determinate the correct Severity of your concern for your business, refer the IBM Software Support Handbook.

The following information is relevant to justify the Severity of the concern and discuss the priority with development team.

  • Describe the Business Impact this problem is having specifying current and future Business Impact
  • Please indicate any project deadlines
  • Which is the current impact on the users: How many users are affected
  • Specify if the issue is in Development, Test, Pre-Prod or Production environment

IBM Support Handbooks
A guide to best practices and procedures when working with IBM support for each type of product (Software and Appliances)

Ensure that you meet at least the minimum requirements and any necessary prerequisites. If you do not meet the documented requirements, the configuration is not supported, and you may see issues.
Refer to the IBM Software Product Compatibility Reports site for detailed requirements for operating systems, supporting software, and other prerequisites. See Detailed system requirements for a specific product.

Gathering general problem description information

If you did not yet provided this information, please answer to the questions below to allow IBM support to investigate your problem. This will expedite problem resolution.

Please DO NOT send any confidential information from your company.

1. Description of the problem

  • Fully describe the problem you are experiencing (please provide the full error messages).
  • What were you attempting when the problem occurred?
  • When did you first noticed it?
  • When applicable, please provide a list of steps to recreate the problem (screen images will help to identify more details)
  • Define the scope of the issue: How many objects (machines, servers, APIs, Products...) have the issue? Could you identify some difference between the object with the issue and the one without? This could help to find the possible cause.

A video together with the problem description and steps can help to identify other important details.

This tool allow you to record your screen while recreating a problem locally:
Recording Your Screen To Share With Support

2. Product version and fix pack

For Management servers:

  • Log on to the Cloud Management Console, navigate to the Services page, and capture the version information by clicking on the 'Server Information' icon; or
  • Log on to the Management command line interface (CLI) and enter the command: system show version

For Gateway servers (DataPower):

  • Log on to the Cloud Management Console, navigate to the Services page, and capture the version information by clicking on the 'Server Information' icon; or
  • Log on to the DataPower command line interface (CLI) and enter the command: show version

3. Are you able to recreate the problem?
Is it repeatable or a one-time problem? If it can be repeated or recreated easily, please provide detailed steps and artifacts so IBM Support can attempt to recreate this internally.
When you reproduce the issue and you need to send logs to IBM Support please provide the start and finish time of the test, this helps to search the error in the logs.

4. Do you have a work around in place?
If yes, please provide full details.

5. Has anything recently changed in the environment prior to the problem starting?

  • Has anything recently changed in the environment prior to seeing the problem starting?
  • Have you applied fixes or fix packs?
  • Have any settings been changed?
  • Have any APIs or API operations been updated?

6. Provide an overall description of your cloud topology

  • How many DataPower gateways?
  • How many Management servers?
  • How many Developer portal servers?

Please specify the clusters and how many servers per cluster are defined in your topology. If you have a load balance please specify.

Having a description of the architecture helps to identify possible causes.

7. Provide details of the hosting environment

  • Are you using VMware, XEN or physical appliance?
  • Please provide the version of the hosting environment that you are using

Depending on the concern and version used, refer to the specific API Connect MustGather and provide the data requested and logs.

Back to top

How to submit diagnostic data to IBM Support
After you have collected the preceding information, and the support ticket is opened, you can follow the instructions in: exchanging information with IBM Technical Support for problem determination

For more details see submit diagnostic data to IBM (ECuRep) and Enhanced Customer Data Repository (ECuRep) secure upload.

If you are using IBM Community Portal, update the case to indicate that data has been sent.

General IBM Support hints and tips
Here you can find a list of useful links for IBM API Connect and the Support processes:

Back to top

[{"Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSMNED","label":"IBM API Connect"},"ARM Category":[{"code":"a8m50000000L0rvAAC","label":"API Connect"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"10.0.0;2018.4.1.0;5.0.0"}]

Document Information

Modified date:
18 February 2021