Upgrading your IBM DataPower Gateways in API Connect

When you upgrade IBM® API Management Version 4.0 or later to IBM API Connect Version 5.0 or later, you must upgrade your DataPower® Gateway to version 7.5 or later.

Before you begin

  • Verify that the maintenance level you apply to the DataPower Gateway is compatible with all the IBM API Connect environments and other applications running on your gateway.
  • Verify that all Management server upgrades are complete, see Verifying maintenance level.
  • Schedule the upgrade during periods of low activity because overall capacity is reduced during maintenance.
  • If the Cloud Manager contains only one DataPower Gateway server, ensure that the API Connect environment does not require access while you upgrade.

About this task

  • The DataPower Gateway is maintained separately from other API Connect components.
  • Upgrading API Connect does not always require you to upgrade the DataPower Gateway.
  • When you remove a DataPower Gateway server, historical monitoring information relating to CPU, memory and disk usage, and server load is lost. However, analytics data relating to API usage is retained.
  • Removing the DataPower Gateway from the Cloud Manager removes it from the load balancing group. When you re-add the Gateway, it obtains the latest DataPower configuration.
  • You can perform a rolling upgrade for multiple DataPower Gateway servers in a load balancing group by removing one, then updating and re-adding it before continuing to the next.

Procedure

Following are general steps to upgrade a DataPower Gateway to meet the requirements of API Connect:

  1. Turn off upstream traffic.
  2. Wait for the upstream traffic to stop.
  3. In the Cloud Manager, remove the DataPower Gateway. For more information, see ../com.ibm.apic.cmc.doc/node_remove.html.
  4. Depending upon your platform, perform the product upgrade, or decommission your virtual machine image, or remove your container from service.
    The following examples link to IBM documentation for DataPower Version 7.5.0, but you can choose the target version of your desired upgrade with the selector found on the page.
    1. To upgrade a DataPower hardware appliance, see IBM Data Power Appliance Firmware Installation Version 7.5.0
    2. To upgrade all other DataPower products, select your platform in the Virtual section of Data Power Offerings for Version 7.5.0
  5. Deploy the new DataPower Gateway.
  6. Test your new deployment.
  7. Turn on upstream traffic.
  8. Add the Gateway server to a service.
    1. Add the Gateway server by using the Cloud Manager. For more information, see Adding a Gateway server.
    2. If you have two or more Gateway servers and you are using an external load balancer, add the Gateway server to the load balancer again.

Results

The upgrade is applied to your DataPower Gateway.

What to do next

  1. Verify the upgrade from the command line by using the --version command.
    • The following message is an example of the --version command output from a DataPower XI52 appliance:
      xi52# show version

         Serial: 0000000
        Version: XI52.7.1.0.3
          Build: 256232
     Build Date: 2015/01/30 10:39:05
 Watchdog Build: XI52.7.1.0.3
 Installed DPOS: XI52.7.1.0.3
   Running DPOS: XI52.7.1.0.3
XML accelerator: embedded
   Machine Type: 5725
     Model Type: J91
    • The following message is an example of the --version command output from a DataPower XG45 virtual appliance:
      xg45# show version

         Serial: 0000000
        Version: XG45.7.1.0.14
          Build: 283791
     Build Date: 2017/01/12 13:45:10
 Watchdog Build: XG45.7.1.0.14
 Installed DPOS: XG45.7.1.0.14
   Running DPOS: XG45.7.1.0.14
XML accelerator: embedded
   Machine Type: 7198
     Model Type: 32X
  2. With the Version information provided, verify the following data:
    • Verify that the version value matches the value for the installed image.
    • Verify that the version value and the DPOS values that are running are identical.