Upgrade UIM Server

This article describes the process for upgrading UIM Server.
This article describes the process for upgrading UIM Server.
Before You Begin
Complete the following tasks before you upgrade UIM Server.
Verify Your Upgrade Path
Ensure that you follow a supported upgrade path described in the Compatibility Support Matrix.
Verify Your RESTful Web Services Requirements
Your UIM RESTful web services might require a specific version of UIM to function properly. Refer to the RESTful web services documentation in Probes Documentation to see if an update is required for this version of UIM.
Back up the Primary Hub Configuration
Save a copy of the hub.cfg file in the
\hub folder. Optimal timeout parameters for the updated hub are set during the update, overwriting existing timeout settings. CA recommends running the updated hub with these optimal values for improved performance. However, if you wish to revert to the old timeout settings for any reason, keep a backup of the old Hub configuration file.
Remove Any Customized Probes in Your Probe Archive
If you have developed custom probes using one of the UIM probe SDKs, move or delete them from your archive before starting an upgrade. After your upgrade is complete, you can move your custom probes back into the archive.
Deactivate distsrv Forwarding
If you have package forwarding set up for the distsrv probe, deactivate it before upgrading.  Also, ensure that the forwarding on the distsrv probe is disabled until the complete UIM upgrade is done for primary hub, UMP to OC, and CABI.
Follow these steps:
  1. In Admin Console, click the 3-dot menu next to the distsrv probe, select
  2. Click the
    folder. If any Forwarding records have
    in the
    column, deactivate forwarding. For other types of records (
    , or
    ) you do not need to deactivate forwarding.
  3. Deselect
    Forwarding active
From UIM 9.2.0 onward, hub/robot- and probe-level licensing requirements have been removed. Deploy the hub, robot, and distsrv versions released with the latest UIM to remove the license dependency. If you want to continue with the older versions of hub and probes that require an extension of the license, contact Support so that they can assist you in extending the license (if required).
Turn off Anti-Virus Scanning
Turn off any anti-virus scanners running on the server. These scanners can significantly slow down the installation. You can turn your anti-virus scanner back on after the upgrade is complete.
Prepare Your UIM Database
Depending on the database software you are using to host the UIM database, you may have additional requirements.
Microsoft SQL Server
Turn off index maintenance in data engine. On very large tables (over 10 GB), running index maintenance will take longer than expected. We recommend that users disable this feature when upgrading to a newer release of UIM, then re-enable it to run during off-peak hours, carefully monitoring the index maintenance processes. This configuration can be done in Admin Console or Infrastructure Manager.
  • If you are upgrading to this release, as the Oracle database administrator, execute the following command to grant permission to the UIM user:
    Grant execute on DBMS_CRYPTO TO <
  • (Upgrade from NMS 7.6 only) If you are upgrading from NMS v7.6 to UIM 8.0 or later, complete the following procedure. If you are running a version of UIM and are upgrading to a newer release, you are not required to complete the following procedure.
    Follow these steps:
    1. As SYSDBA, execute:
      grant execute on dbms_redefinition to
      grant create type to
      grant execute any type to
      grant under any type to
      grant select any table to
      grant alter any table to
      grant create any table to
      grant drop any table to
      grant lock any table to
    2. Turn off and purge the Oracle recycle bin.
      If you are upgrading from NMS 7.6, the upgrade will fail if you do not purge the recycle bin.
      1. Use a tool such as SQL Developer to connect to the Oracle database.
      2. Purge the recycle bin. Execute:
      3. Disable the recycle bin. Execute:
        ALTER SYSTEM SET recyclebin = OFF DEFERRED;
        ALTER SESSION SET recyclebin = off;
      4. Verify that the recycle bin is off. Execute:
        show parameter recyclebin;
Review the following considerations:
  • For more information about the UIM 20.3.3 release, see the UIM 20.3.3 article.
  • UIM 20.3.1 is a patch release. The UIM 20.3.1 patch does not include any upgrade installer for the UIM Server. The patch includes separate standalone artifacts that you can use to upgrade the respective components. For more information about the artifacts that are available as a part of the UIM 20.3.1 patch release, see the UIM 20.3.1 article.
  • UIM 9.2.0 (or later) uses OpenJDK instead of Oracle JDK. Upgrading to UIM Server automatically updates the existing Oracle JDK to OpenJDK in the CA UIM environment. Additionally, this upgrade also deletes the older Oracle JDK instances. For more information about the OpenJDK usage in CA UIM, see Adopting OpenJDK.
  • UIM 20.3.0 upgrade installer installs the
    uimesdplatelemetry web service
    on the uimserver wasp when you upgrade from UIM 9.0.2 to UIM 20.3.0. This service is introduced for the PLA customers as it is mandatory for such customers to upload the customer information and usage data to Segment. For more information about how to configure telemetry properties, see Configure Telemetry for the PLA Model.
  • UIM also provides you with the secure and non-secure hub and robot options while upgrading UIM Server. Enabling the secure option implies that you want to use the secure version of the hub and robot. If you do not enable the secure option, it implies you want to use the non-secure version of the hub and robot, which is based on the legacy security model. For more information about the secure hub and robot, see Secure Hub and Robot.
  • If the mon_config_service_ws package is installed on the UIM Server and Operator Console (OC) 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 (UIM Server):
    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 the existing 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 the existing UMP to 20.3.0 (OC), you will face issues.
  • As part of the installation process, the installer runs an SQL query to verify that your environment is ready for the upgrade. If an issue is found, a message appears:
    Duplicate MCS database entries have been detected. Please contact CA UIM support to continue with your upgrade.
    Contact CA UIM Support to validate your environment for installation. Attach to the case, in csv format, extracts of the following tables:
    • ssrv2template
    • ssrv2devicegroup
    • ssrv2field
    • ssrv2profile
    • ssrv2ConfigValue
    If your SQL query results in the message, 'It is safe to upgrade to UIM x.x.x,' continue with the installation of version x.x.x.
  • The discovery_agent and some other probes might send a single information alarm when upgrading to the latest version of UIM Server. This alarm is benign and can be safely ignored.
  • For data_engine released with versions prior to UIM 9.0.2, the S_QOS_DATA table contains the object data for each unique combination of QoS, source, and target attributes. It does not include the origin value in identifying the unique combination. However, the data_engine probe in UIM 9.0.2 has been enhanced to use the unique combination of QoS, source, target, and origin attributes. Therefore, when you upgrade UIM Server from a previous version to UIM 9.0.2, the upgrade process might take some time because data_engine uses the origin value to recalculate the unique combination. This recalculation results in updating the existing values in the checksum column of the S_QOS_DATA table. The data_engine probe runs database scripts during the upgrade process to update the existing records. For example, for Microsoft SQL Server and MySQL, the respective scripts take approximately 20-30 seconds to update 700,000 records in the S_QOS_DATA table. In this case, the computer has 16 GB of memory and 8 cores processor.
  • The UIM Server installer creates a .pem file (certificate.pem) in the
    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 Operator Console (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 robot.cfg.
  • UIM 9.2.0 removes dependency on the end-of-life (EOL) Microsoft Visual C++ Redistributables for a few probes and packages. Because of this dependency removal, UIM installation deploys the Microsoft Visual C++ 2017 Redistributables package (for example, vs2017_vcredist_x86) by default. With this package deployment, only the listed probes can work. For other probes that use the EOL Microsoft Visual C++ Redistributables or for older versions of the impacted probes, you must download and deploy the required EOL Microsoft Visual C++ Redistributable package (for example, vs2008_redist_x86) from the Archive.
    Furthermore, if you want to use the impacted probes with UIM releases prior to UIM 9.2.0, ensure that you download and deploy the required Microsoft Visual C++ 2017 Redistributables package that is available in the Archive.
  • In Linux environment, after you upgrade UIM 9.0.2/9.2.0 Server to 20.3.0, the access permission on the
    directory in the CA UIM installation path is changed to 750. This ensures that only the root user can access the directory contents. Other users are not allowed to access the contents. If required, the root user can change the access permissions.
Download the UIM Server Install Package
Follow these steps:
  1. Log on to the primary hub server as administrator.
  2. A CA support login is required.
  3. Download the following installation packages for your operating system:
    • The UIM Installer (
    • The UIM Server Packages (
      zip file)
      Both files are required on the system that hosts the UIM server. If the uimserverpackages zip file is not present, the installation fails.
  4. (Silent Mode Upgrade Only)
    Download the
    Silent Install Templates for UIM Server
    zip package.
  5. (Linux Only)
    Run the
    chmod 755
    command on the setupCAUIMServer executable file.
Run the UIM Server Installer
You can run the installer in three modes. Graphical user interface (GUI) mode walks you through the installation process. Console mode provides an interactive command-line interface. In silent mode, the installer reads configuration information from a response file you create, then runs with no further interaction.
GUI Mode Upgrade
All fields in the installer are case-sensitive.
To complete a GUI mode upgrade, run the installer and follow the prompts to complete the installation. Where possible, the installer displays the current configuration values for your confirmation.
Console Mode Upgrade
Follow these steps:
  1. Run the installer. From a command line, execute:
    • Windows:
      setupCAUIMServer.exe -i console
    • Linux:
      setupCAUIMServer_linux.bin -i console
  2. Follow the prompts to complete the installation. Where possible, the Installer displays the current configuration values for your confirmation.
  3. When the upgrade is complete, make sure you:
    • Turn the anti-virus scanners on again if necessary
    • Enable package forwarding
    • Move customized probes back into your probe archive if necessary
Silent Mode Upgrade
Follow these steps:
  1. Prepare your response file:
    1. Extract the silent install templates.
    2. Locate the
      file and save it as
      in the same directory as the installer.
    3. Add your UIM administrator password to the
      line in
    4. Save the file, ensuring the file type is still
      . If the file type is
      Text Document
      , remove the
      extension (which may not be displayed in the folder).
  2. Run the installer. From a command line, execute:
    • Windows:
      setupCAUIMServer.exe -i silent
    • Linux:
      setupCAUIMServer_linux.bin -i silent
  3. The installer unpacks the files and completes the installation. This process can take several minutes or more.
  4. UIM Server launches. If for some reason it does not, execute:
    • Windows:
      net start "Nimsoft Robot Watcher"
    • Linux:
      /etc/init.d/nimbus start
Microsoft Cluster Server Upgrade
Use the following procedure to upgrade UIM Server on a Microsoft Server 2012 failover cluster.
Follow these steps:
  1. Upgrade the primary (active) node using either the GUI mode or silent mode procedure.
  2. Make the secondary (passive) node active, then upgrade the node using the same process you used on the primary node.
This ensures that registry keys on both the primary (active) and secondary (passive) nodes are updated for the new version.
Post-Upgrade Tasks
Once the upgrade is complete:
  • Turn your anti-virus software back on.
  • Enable package forwarding.
  • Move your customized probes back into the probe archive if necessary.
  • If necessary, upgrade UMP to OC.
  • If necessary, upgrade the UIM RESTful web services.
CA provides newer versions of certain probes between server package releases. During an upgrade, the installer overwrites currently installed probes and components. If you downloaded "hot fix" or updated probes, upgrading UIM Server can result in component downgrades. If this happens, go to the
page of the Support website and download the overwritten components again.