Upgrade Operator Console

uim203
In this article, learn how to upgrade UMP/OC to Operator Console. You prepare for the upgrade, run the upgrade, and complete post-upgrade tasks.
2
  • To upgrade from a previous version of OC to OC 20.3.3, use the OC 20.3.3 upgrade installer that is available as part of the UIM 20.3.3 release. For more information about the UIM 20.3.3 release, see the UIM 20.3.3 article.
  • UIM 20.3.3 has removed dependency on CA Business Intelligence (CABI) for rendering the native OC screens: Home page, Group view page, Device view page, and Monitoring Technologies (probes) view page. Custom and Out-of-the-Box dashboards and reports are still rendered by using CABI; that is, they have a dependency on CABI. However, the native OC screens are no longer dependent on CABI (Jaspersoft) and are rendered by using HTML5. For more information about the native OC screens using HTML5, see the Configuring and Viewing Monitoring Data article or the "Removing CABI Dependency (Native Operator Console)" section in the UIM 20.3.3 article.
  • To upgrade from a previous version of OC to OC 20.3.2, use the OC 20.3.2 upgrade installer that is available as part of the OC 20.3.2 patch release. For more information about the OC 20.3.2 patch, see the OC 20.3.2 Patch article.
  • To upgrade from OC 20.3.0 to OC 20.3.1, use the upgrade installer for Operator Console that the UIM 20.3.1 patch contains. Note that UIM 20.3.1 is a patch release over UIM 20.3.0. The UIM 20.3.1 patch does not include any upgrade installer for the UIM Server. The patch includes the OC upgrade installer along with the separate standalone artifacts that you can use to upgrade the respective components to 20.3.1. For more information about the artifacts that are available as part of the UIM 20.3.1 patch release, see the UIM 20.3.1 article.
  • In UIM 20.3.0, use the OC installer to upgrade UMP, as UMP is no longer available in UIM 20.3.0. The OC installer uninstalls the deprecated components and upgrades the valid components.
  • Note that the "Upgrade Operator Console" and "Upgrade a Multiple OC Configuration" are two separate procedures. Based on your setup, you can follow the appropriate procedure.
  • The wasp probe is installed as a core probe with OC to manage network communications. Do not attempt UMP/OC upgrades or downgrades by redeploying the wasp probe without running the OC installer.
  • While upgrading to 20.3.0, if the OC installer is trying to install OC on the primary hub instead of the UMP server, follow the information in the Troubleshooting Operator Console article.
Prepare for the Upgrade
Verify that you are prepared to upgrade UMP/OC to OC 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.
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/OC_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.
In UIM 20.3.0, portal-ext.properties file is replaced with config.properties. You can replace the content of config.properties with content of portal-ext.properties in the
<
UMP/OC_installation>
/Nimsoft/probes/service/wasp/config/ folder when the upgrade is complete.
You can add the changes in your web.xml file to web.xml in the
<
UMP/OC_installation>
/Nimsoft/probes/service/wasp/webapps/ROOT/ folder when the upgrade is complete.
(Oracle only) Disable the Oracle recycle bin
If you are installing UIM for the first time, or upgrading from a previous version, the recycle bin must be disabled before you install or upgrade UIM and OC.
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/OC to OC 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/OC 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/OC to OC in a secure setup, ensure that you bring your UMP/OC 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/OC. 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 UIM Server to 20.3.0:
  1. Take a backup of the wasp folder available on the existing UIM Server.
  2. Delete the wasp probe from the existing UIM Server.
  3. Start the process to upgrade the existing UIM Server to 20.3.0 (UIM Server).
    After you complete the UIM Server upgrade, you can now upgrade 9.0.2/9.2.0 UMP to 20.3.0 OC. Without performing these steps, if you try to upgrade UMP to 20.3.0 OC, you will face issues.
Scenario 2:
If you do not delete the wasp probe before upgrading the UIM Server to 20.3.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 20.3.0 OC.
  4. Deploy wasp that is available with 20.3.0 on the upgraded UIM Server.
  5. Deploy the adminconsole, mps, and telemetry packages that are available with 20.3.0.
    Without performing these steps, if you try to upgrade UMP to 20.3.0 OC, you will face issues.
OpenJDK in UIM
UIM 9.2.0 has adopted Open JDK (JRE), replacing Oracle JDK. Therefore, when you upgrade UMP to OC, the upgrade process places OpenJDK onto the OC computer. However, unless you restart the OC robot, the new OpenJDK will not be picked up. This is an additional step that you need to perform after you upgrade UMP to OC. For more information about the OpenJDK usage in UIM, see Adopting OpenJDK.
Run the Upgrade
You upgrade UMP/OC to OC by following the same process as the installation of a new instance of OC. Follow the supported upgrade path that is described in the Supported Upgrade Paths. The
Select Robot
panel of the installer provides the option to Upgrade to OC <x.x.x.x.>. The installer retains any settings, such as port numbers, that you changed from the default.
For 20.3.3, a new option
Specify IP
is also available in the
Select Robot
dialog. This option is in addition to the already existing
Choose
option. You can select the
Specify IP
option and directly enter the IP address of the robot where you want to upgrade the OC. The installer identifies that an older version of the OC is already available on the robot and prompts a message stating that you are going to upgrade the OC instance. You can then proceed with the remaining steps to upgrade the instance. For more information about the steps, see Install Operator Console (OC).
Operator Console Installer - Webapps Considerations
After the upgrade, the webapps that are deployed/upgraded with the OC installer need to be verified and few webapps need to be manually upgraded.
The following gives more details about the webapps being installed as part of the OC installation, obsolete webapps in UIM, and the webapps that need to be manually upgraded after running the upgrade.
Deployed/Upgraded Webapps
The following webapps are deployed/upgraded with the OC 20.3.0 (or later) installer:
  • accountadmin
  • policy_management_ws
  • dashboard
  • operatorconsole_portlet
  • mcs-ui-app
  • cabi
  • alarmviewer_api
  • reportscheduler (uim_reportscheduler 20.3.3)
  • slm
  • samlsso
  • nisapi
Obsolete Webapps from UIM OC WASP
The following webapps are obsolete from UIM 20.3.0 (or later) OC WASP.
  • cloudmonitor
  • listdesigner
  • listviewer
  • mobile
  • mytickets
  • policyeditor
  • qoschart
  • relationshipviewer
  • reports
  • reportscheduler (UMP reportscheduler)
  • servicedesk
  • slareports
  • unifiedreports
  • usm
  • saml-portlet
  • ump-theme
  • portal-compat-hook
  • ump-read-only-theme
If there are any undeleted folders of these webapps after the upgrade due to remote OC installation from Primary hub, users can manually delete post installation of OC.
Webapps to be manually upgraded
The following webapps are required to be manually upgraded post installation of OC 20.3.0 (or later). Users are notified during OC installation if any earlier versions of these webapps exist.
  • self_cert/ump_selfcert
  • uimapi
  • webservices_rest
  • ecometer_admin (dcimadmin)
  • ecometer_admin
Complete Post-Upgrade Tasks
Complete the following tasks after the upgrade is complete:
Clear Your Web Browser
If you upgraded from a previous UMP/OC version to OC, clear your browser completely to remove older versions of components that might be cached.
For OC 20.3.2 or later, you do not need to perform this procedure if you are upgrading from an older version of OC to OC 20.3.2 or later.
Follow these steps:
  1. Log out from OC.
  2. Clear the browser cookies and cache.
  3. Exit all browser windows.
  4. Log in to OC.
Custom ACLs with any new permissions added to the default administrator, would not be auto-selected for the custom ACLs after the upgrade. Those permissions must be selected manually for the custom ACLs after the upgrade.
(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 OC after your upgrade.
Troubleshooting
The wasp does not start after upgrading the Operator Console
Symptom
: After upgrading the Operator Console using the OC Installer in UIM 20.3.0, wasp does not start.
Solution
: After upgrading the Operator Console using the OC Installer in UIM 20.3.0, wasp does not start. This issue might be due to some obsolete webapps not removed from the OC wasp while installation. The leftover webapps must be manually removed to resolve the issue.
Follow the below steps to clean up the obsolete webapps:
Check for the obsolete webapps in the OC wasp webapps folder.
  • Remove the obsolete webapps sections from wasp.cfg of the OC server. This removal can be done in two ways:
    1. Open the wasp.cfg in Raw Configure and delete the listed webapps sections under the webapps folder using the Delete Section option.
    2. Open the wasp.cfg in Edit mode and remove the sections under the webapps.
  • Deactivate the wasp.
  • Delete these webapps folders from \Nimsoft\probes\service\wasp\webapps.
  • Delete the .war files of these webapps from \Nimsoft\probes\service\wasp\webapps.
  • Restart the wasp.
We recommend moving the xerceslmpl.jar into your root UIM install directory (Nimsoft).