Update Portal Integration Software

This topic describes the steps required to update the Portal Integration software, also known as the Portal Integration bundle.
Updating to the latest version of the integration software (also known as the Portal Integration bundle) ensures that API and API key deployment synchronization between the Portal and On-Premise proxies are optimized for reliability and scalability. It also ensures that the API Portal is able to capture and present richer data in the Proxy Details page for analysis and troubleshooting.
When an update for the integration software is available as part of a Portal release, its availability is highlighted in the Release Notes. Portal administrators should coordinate with the API proxy administrator to update the integration software on the API proxy.
See Compatibility Matrix to learn what the latest version of the integration software is and how to identify if you have the latest version installed on your proxy.
  • The update overwrites any customizations to standard services installed by the Portal integration software, policies, policy templates, or encapsulated assertions. The update does not affect non-standard services, policies, policy templates, or encapsulated assertions. It also does not affect scheduled tasks, or the cached age of APIs and Account Plans (cluster properties).
  • This update feature does not update the version of the API proxy. This upgrade feature only upgrades the integration software. For information about general API proxy updates, see Upgrade CA API Gateways in the online documentation for the API Gateway.
  • For customers using API Gateway 10 CR1 and higher:
    Download the PortalUpgradeAssertion replacement file to replace the existing server module file when performing your update. For more information, see KB 201757: Upgrade Portal Integration bundle operation fails for API Gateway 10 CR1 and above.
Follow these steps:
  1. In the Policy Manager, log in to the API proxy as an administrator.
  2. (
    For API Gateway 10 CR1 and higher only; skip this step if you are using other versions of the Gateway OR if you have already replaced the PortalUpgradeAssertion file after the Portal 5.0.0 upgrade
    ) Download and replace the PortalUpgradeAssertion file. Follow the instructions in KB 201757: Upgrade Portal Integration bundle operation fails for API Gateway 10 CR1 and above.
  3. On the
    Tasks
    menu, click
    Extensions and Add-Ons
    ,
    Update Portal Integration
    .
  4. Restart the API proxy. To do this, open a privileged shell on the API proxy and then run these commands:
    $ service ssg stop $ service ssg start
    For more information, see 'Using the Privileged Shell' in the online documentation for the API Gateway.