IBM Support

MustGather: Collecting the data needed for IBM Support to restore a client backup of an API Connect subsystem within the IBM secure lab

Question & Answer


Question

IBM Support indicated that they need a backup from an API Connect subsystem in order to progress identifying root cause. What actions need to be taken in order to provide all of the information and data needed by IBM Support? 

Answer

Under some circumstances, IBM Support may request backups from a client environment to progress root cause identification for a reported issue. IBM Support will leverage resources in an IBM secure lab in order restore a backup from a client's environment. Following is a list of information and data required by IBM Support:
  1. If a Local User Registry is currently not being used for the API Manager, please take the following steps before backing up the management subsystem:
    • If the default API Manager Local User Registry has not been deleted, please do the following:
      • Log in to the Cloud Manager with a user which has the Owner or Administrator role
      • Enable the API Manager Local User Registry to be a visible option on the the API Manager log in screen
        • In the Cloud Manager, click Settings

        • Choose User Registries.

        • Click Edit in the API Manager panel

        • Select the user registry by placing a checkmark next to the name in the list. Click Save

        • If you need help with the above steps, please see Selecting user registries for Cloud Manager and API Manager

    • If the default API Manager Local User Registry was deleted, please do the following:
      • Log in to the Cloud Manager with a user which has the Owner or Administrator role
      • Create a Local User Registry by following the instructions for Configuring a Local User Registry
      • Enable the API Manager Local User Registry to be a visible option on the the API Manager log in screen
        • In the Cloud Manager, click Settings

        • Choose User Registries.

        • Click Edit in the API Manager panel

        • Select the user registry by placing a check mark next to the name in the list. Click Save

        • If you need help with the above steps, please see Selecting user registries for Cloud Manager and API Manager

    • Invite a new member
      • Log in to the API Manager with a user which has the Owner or Administrator role for the provider organization which is encountering the issue.
      • In the left-hand navigation pane, choose Members.
      • Click the Invite Member button.
      • Enter a fictitious email address (for example apic_L2_support@ibm.com)
        • NOTE: The email address used for the above step does not need to exist
      • Assign the Administrator role
      • Click the Invite button
      • Copy the activation link from the UI
      • Log out of the API Manager
    • Activate the new member
      • Paste the activation link into the browser
      • Click the button for the local user repository
        • This button will either be API Manager Local User Repository or the name of the local user repository which was just created
      • Complete the form by entering values for each field
      • Click the Sign Up button. 
        • Once your backup is restored in the IBM secure lab, IBM Support will reset the log in credentials for this member and use those credentials to log in to the API Manager
  2. Generate a backup from each API Connect subsystem requested by IBM Support.
    NOTE: The Management and Portal subsystems must be backed up at the same time, to ensure synchronicity across the services.
  3. Extract the encryption-secret from the management subsystem
    • Use the following command to extract the encryption-secret:
       apicup certs get <management-subsystem> encryption-secret --type key > encryption-secret.bin
  4. Compress the apicup project directory used to install API Connect into an archive file. 
  5. Upload the following files to the case
    • Back ups from all the requested subsystems
    • encryption-secret.bin
    • archive file of the project directory

[{"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSMNED","label":"IBM API Connect"},"Component":"","Platform":[{"code":"PF004","label":"Appliance"}],"Version":"2018.4.1.x","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
13 March 2020

UID

ibm11169014