Upgrading Developer Portal subsystem from to the latest 10.0.1.x-eus

Upgrade the Developer Portal subsystem from to the latest 10.0.1.x-eus version by completing configuration, deployment, and restoration steps.

About this task

The upgrade process uses the same project directory as you used on version The configuration file is called apiconnect-up-v10.yml.

Deploy the Developer Portal subsystem for the latest 10.0.1.x-eus, and restore the Developer Portal data from a backup.

Note: If your subsystem name on was greater than 63 characters, and you did not manually shorten it prior to upgrading, the upgrade shortened it automatically. To view the new subsystem name:
apicup subsys list
For more info, see Automatic shortening of subsystem names with greater than 63 characters ( upgrade only).


  1. Obtain IBM® API Connect <version> Developer Portal for VMware from Fix Central, as described in Upgrading subsystems from to the latest 10.0.1.x-eus on VMware.
  2. The configuration in your project directory should be complete. Optionally, you can review the contents of apiconnect-up-v10.yml. Since you are using the same project directory as used previously, the configuration properties for the subsystem should already have values set.
  3. Before deploying the latest 10.0.1.x-eus OVA, shutdown your existing v10 VMs but do not delete them.

    Note: You may need to rename the old VM after shutting it down to not conflict with the latest v10 replacement you will deploy.

  4. Create your ISO file.
    apicup subsys install port --out portplan-out

    The --out parameter and value are required. In this example, the ISO file is created in the myProject/portplan-out directory.

  5. Deploy the file into the VM. See Deploying the Developer Portal subsystem OVA file.
  6. Verify the deployment: See Verifying deployment of the Developer Portal subsystem.
  7. Restore Portal using the backup taken on version 10. See Restoring the Developer Portal subsystem.
  8. Confirm the restore has completed successfully:
    apicup subsys health-check <portal_subsystem_name>
    When no problems are detected, the health-check commands returns silently with a 0 return code.
    Important: If the health check command states that a reboot is required, you must ensure that all Portal sites have been upgraded first before performing the reboot. To check that the Portal sites have upgraded, inspect the platform and state values for each site. The sites should all be in INSTALLED state, and have platform equal to the new platform that you can identify with platforms:list. Note that there will be two platforms present in the list while the site upgrades are happening. There should be only one platform after they have completed. To check that the Portal sites were upgraded:
    1. Obtain the portal service id and endpoint:
      apic portal-services:get -o admin -s <management_server_endpoint> \
                   --availability-zone availability-zone-default <portal-service-name> \
                   --output - --format json
    2. List the sites:
      apic --mode portaladmin sites:list -s <management_server_endpoint> \
                    --portal_service_id <portal_service_id_from_above_command> \
                    --portal_service_endpoint <portal_service_endpoint_from_above_command> \ 
                    --format json

      Any sites currently upgrading will be listed as UPGRADING. Once all sites have finished upgrading they should have the INSTALLED status and the new platform version listed.

      See also: apic sites:list and Using the sites commands.

    3. After all sites are in INSTALLED state and have the new platform listed, run:
      apic --mode portaladmin platforms:list -s <management_server_endpoint> \
                    --portal_service_id <portal_service_id_from_above_command> \
                    --portal_service_endpoint <portal_service_endpoint_from_above_command> \ 
                    --format json

      The new version of the platform should be the only platform listed.

      See also: apic platforms:list and Using the platforms commands.