Upgrade UMP

In this article, learn how to upgrade UMP. You prepare for the upgrade, run the upgrade, and complete post-upgrade tasks.
uim902
In this article, learn how to upgrade UMP. You prepare for the upgrade, run the upgrade, and complete post-upgrade tasks.
Note that the "Upgrade UMP" (upgrading a single UMP) and "Upgrade a Multiple UMP Configuration" are two separate procedures. Based on your setup, you can follow the appropriate procedure.
2
The wasp probe is installed as a core probe with the Unified Management Portal (UMP) to manage network communications. Do not attempt UMP upgrades or downgrades by redeploying the wasp probe without running the UMP installer.
Prepare for the Upgrade
Verify that you are prepared to upgrade UMP by completing all tasks in the following table. Do not continue with the upgrade until all these tasks are complete.
Task
Description and Steps
Verify your upgrade path.
Ensure that you follow a supported upgrade path.
View the Compatibility Matrix and review the Supported Upgrade Paths section.
Back up the system.
Back up your system and database. UMP versions 7.5 and later use a new version of Liferay that modifies the database during the upgrade.
After the upgrade, the only way to revert to your previous system is to restore a backup.
If you cancel the installation during the upgrade due to errors, your current system can no longer be operational. In this case, the only option is to restore a backup.
Back up any customized files in the ROOT Webapp directory
During the upgrade, the directory
<UMP_installation>/Nimsoft/probes/service/wasp/webapps/ROOT/
is overwritten. If you have customized any of the files in this directory, back them up before upgrading. The following list includes some commonly customized files:
  • portal-ext.properties
  • web.xml
Both of these files are modified as part of multi-UMP or HTTPs configuration.
You can restore your files to the
<
UMP_installation>
/Nimsoft/probes/service/wasp/webapps/ROOT/ folder when the upgrade is complete.
Import custom LAR files
You can create custom pages in UMP and can arrange portlets on the pages. You can export custom pages as LAR files and can share them with other users.
UMP versions 7.5 and later use a new version of Liferay. If you exported custom pages as LAR files, manually import the custom LAR files before upgrading from a version before UMP 7.5.
If you created custom pages, you do not need to migrate them unless you exported them to LAR files. Pages and users are automatically migrated; LAR files are not.
Follow these steps:
Users are automatically migrated when you upgrade. Before upgrading, you create users with only the content that matches the LAR files. After you upgrade, you log in as the users you created to complete the steps.
  1. In UMP or in Infrastructure Manager, add a user for each LAR file.
  2. Log in to UMP as the user associated with the LAR file.
  3. Remove all portlets from the Home page.
  4. Delete all pages except the Home page.
  5. Complete these steps to import the LAR file to the user's private pages:
    1. Click Go to > Control Panel on the menu bar.
    2. Click My Pages.
    3. Click Private Pages.
    4. Click Export/Import, then click Import.
    5. Click Browse to select the LAR file.
    6. Leave the default options selected and click Import.
  6. Delete the Home page if it is still empty.
    If the Home page is empty, the LAR file did not contain a Home page. By deleting the Home page, the user's content is the same as the content in the LAR file.
  7. Repeat the previous steps for each LAR file.
  8. Upgrade UMP.
  9. Log in as the user associated with the LAR file.
  10. Complete these steps to export the private pages for the user:
    1. Click Go to > Control Panel on the menu bar.
    2. Click My Pages.
    3. Click Private Pages.
    4. Click Export/Import.
    5. If the Export tab is not selected, click the Export link.
    6. Enter a name for the LAR file.
    7. Leave the default options selected and click Export.
    The pages are exported and saved to a LAR file.
  11. Replace the existing LAR file with the LAR file you previously exported.
(Oracle only) Disable the Oracle recycle bin
If you are installing CA UIM for the first time, or upgrading from a previous version, the recycle bin must be disabled before you install or upgrade UIM and UMP.
If you are upgrading from 7.5, you
must
also purge the recycle bin, or the upgrade fails.
Follow these steps:
  1. Use a tool such as SQL Developer to connect to the Oracle database.
  2. Enter the following commands:
    ALTER SYSTEM SET recyclebin = OFF DEFERRED;
    ALTER SESSION SET recyclebin = off;
  3. Verify that the recycle bin is disabled using the following command:
    show parameter recyclebin;
(SAML SSO configurations only) Back up the SAML configuration
If you are using SAML single sign-on, follow the instructions for backing up your SAML Configuration in the article Configure UMP to Use SAML Single Sign-On.
Upgrading UMP does not preserve the SAML configuration files.
Configure robot.cfg
The UIM Server installer creates a .pem file (certificate.pem) in the
<Nimsoft>\security
folder. The .pem file is a symmetric key that is shared with the required robots, which is then used for communication with the data_engine probe. You copy this .pem file to the remote UMP, UR, and CABI robots and provide the location of the file in the robot.cfg file (
cryptkey = <.pem file location>
). Furthermore, if any impacted probe is not on the same computer where data_engine is present, copy the generated .pem file to the robot computer (where data_engine is not available) and update the robot.cfg file with the .pem file location on that computer. For more information about the robot.cfg file configuration, see Configure the robot.cfg File.
Upgrading in Secure Setup
In an upgrade scenario, if you are upgrading UMP in a secure setup, ensure that you bring your UMP robot to the secure state by deploying the appropriate certificates and then updating the robot version to the secure one. After that, you upgrade UMP. For more information about the secure setup and how to deploy certificates, see Secure Hub and Robot.
Consideration if mon_config_service_ws on UIM Server and UMP on another robot
If the mon_config_service_ws package is installed on the UIM Server and UMP is installed on another robot, review the following points while performing the upgrade:
Scenario 1:
Before you upgrade the existing 9.0.2 UIM Server to 9.2.0:
  1. Take a backup of the wasp folder available on the 9.0.2 UIM Server.
  2. Delete the wasp probe from the 9.0.2 UIM Server.
  3. Start the process to upgrade the 9.0.2 UIM Server to 9.2.0 (UIM Server).
    After you complete the UIM Server upgrade, you can now upgrade 9.0.2 UMP to 9.2.0 UMP. Without performing these steps, if you try to upgrade UMP to 9.2.0 UMP, you will face issues.
Scenario 2:
If you do not delete the wasp probe before upgrading the UIM Server to 9.2.0:
  1. Take a backup of the wasp folder available on the upgraded UIM Server.
  2. Delete the wasp probe from the upgraded UIM Server.
  3. Upgrade existing UMP to 9.2.0 UMP.
  4. Deploy wasp that is available with 9.2.0 on the upgraded UIM Server.
  5. Deploy the adminconsole, mps, and telemetry packages that are available with 9.2.0.
    Without performing these steps, if you try to upgrade 9.0.2 UMP to 9.2.0 UMP, you will face issues.
OpenJDK in CA UIM 9.2.0
CA UIM 9.2.0 has adopted Open JDK (JRE) 8u212, replacing Oracle JDK. Therefore, when you upgrade UMP to 9.2.0 UMP, the upgrade process places OpenJDK onto the UMP computer. However, unless you restart the UMP robot, the new OpenJDK will not be picked up. This is an additional step that you need to perform after you upgrade UMP to 9.2.0. For more information about the OpenJDK usage in CA UIM, see Adopting OpenJDK.
Run the Upgrade
You upgrade UMP by following the same process as the installation of a new instance of UMP. Follow the supported upgrade path that is described in the Support Compatibility Matrix. The
Select UMP Robot
panel of the installer provides the option to Upgrade to UMP <x.x.x.x.>. The installer retains any settings, such as port numbers, that you changed from the default.
Complete Post-Upgrade Tasks
Complete the following tasks after the upgrade is complete:
Clear Your Web Browser
If you upgraded from a previous UMP version, clear your browser completely to remove older versions of components that might be cached.
Follow these steps:
  1. Log out from UMP.
  2. Clear the browser cookies and cache.
  3. Exit all browser windows.
  4. Log in to UMP.
(SAML SSO Configurations Only) Move xerceslmpl.jar
If you have configured UMP to use SAML Single Sign On in a release before 8.31, move or delete the
xerceslmpl.jar
file from the directory
<UMP_installation>\probes\service\wasp\webapps\ROOT\WEB-INF\lib
. If you do not move xerceslmpl.jar, you will receive the error Unable to process SAML request
when you attempt to log in to UMP after your upgrade.
We recommend moving the xerceslmpl.jar into your root CA UIM install directory (Nimsoft).