DX UIM Upgrade Guide and Pre-Planning Checklist for 23.4

Products

CA Unified Infrastructure Management On-Premise (Nimsoft / UIM) CA Unified Infrastructure Management SaaS (Nimsoft / UIM) DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

This knowledge article provides a quick checklist of items to consider when upgrading to DX UIM 23.4. This article will help you ensure a successful upgrade of your existing DX UIM environment. You may choose to register for the Broadcom Designated Weekend Upgrade Program or perform your upgrade during the week. In either case, this checklist will help in pre-planning and upgrade plan discussions with your Account team before upgrading to UIM 23.4.

During the pre-upgrade planning discussion, please also mention whether or not your team is planning on other Broadcom software product upgrades such as Spectrum, SOI, PM, or other Broadcom software products, so they may be scheduled most efficiently.

For a more complete description and details of the upgrade options, process, and individual checklist tasks, please download, review, and use the "DX UIM Upgrade Guide and Pre-Planning Checklist" which is attached to this KB Article in both pdf and word (editable) format. The detailed guide goes beyond the core upgrade tasks and includes further information on hotfixes, security vulnerability updates, post-upgrade tasks, and more.

This DX UIM Upgrade Guide and Pre-Planning Checklist article as well as the full guide will be updated and maintained for each release.

You can update the checkboxes online within the table with a mouse click and/or print it out and use it as a checklist reference.

Main Content

DX UIM Upgrade Planning
DX UIM Installations/Upgrades
Known Issues
CABI (Jaspersoft)
Supporting Documents
Troubleshooting
MCS Configuration (optional)
Need for sample Windows/Linux upgrade plans
Links to post-install / post-upgrade tasks checklist for UIM Server, Operator Console, CABI

IMPORTANT!!! (for customers who use MCS):

If you are using "Legacy" MCS profiles, also known as "non-enhanced" profiles, DO NOT PROCEED with the upgrade to 23.4 as these profiles are not supported and you will no longer be able to change alarm thresholds or deploy the profiles.

You can identify these profiles in MCS because they do not say "Enhanced"- e.g. "CPU Monitor" as opposed to "CPU Monitor (Enhanced)".

Additionally, in MCS there is an option to configure the alarm thresholds directly in the profiles (as opposed to alarm policies) by setting policy_mode_enabled=false in the mon_config_service probe config. This is also not supported in 23.4 and you will need to made adjustments prior to upgrading.

You MUST migrate to Enhanced profiles prior to upgrading to 23.4.

The process is outlined in the documentation here:

Migrating and Converting Existing Profiles

Please contact Broadcom support for further guidance.

Important Note for customers upgrading to 23.4.7 (CU7):

If your environment uses UIM Hub SSL Tunnels and you have created those tunnels (and their corresponding certificates) on a release prior to DX UIM 23.4.0 please see the following KB related to tunnel certificate validation. You may need to recreate the Tunnel Server CA and re-issue all your tunnel client certificates prior to upgrading.

Validating Tunnel Certificate Readiness for CU7

Upgrade Guidance for CU7 when SHA1 certificates are detected

Environment

Upgrading from DX UIM v20.4 to DX UIM v23.4.x

Cause

Upgrade Guidance

Resolution

Checklist Task	Yes	No	NA	Brief Description
Pre-Upgrade				Required for pre-upgrade reviews and all upgrade preparation.
Backup the environment				Backup/snapshots of the Primary Hub, OC and Database.
Safely store any/all customizations				Backup and safely store any/all customization, custom probes/scripts, portal/images, as well as the nas scripts directory, and /wasp/conf/ folder on Admin Console and Operator Console.
Check Supported Upgrade Paths				Officially supported Installation/migration paths for this release.
Check Sizing Requirements				Check/re-check sizing requirements for small-medium-large environments. Note that CPU/RAM should be dedicated for UIM servers. Dynamic CPU/RAM have been seen to cause problems during installations/upgrades.
Check Compatibility Matrix				Compatibility must be checked to avoid upgrade issues / failures.
Review Release Notes				Provides latest information about new features, enhancements to existing features, resolved issues, international support, known issues, known/fixed security vulnerabilities and third-party software agreements for DX UIM.
Collect Existing UIM Environment Information				Helps to avoid upgrade issues, incompatibilities, upgrade failures, and helps to ensure optimal performance and ongoing scalability.
Disable the HA probe on the failover hub (if applicable).				If there is an HA probe on a Secondary/Remote hub in the UIM environment, disable the HA probe so that the failover hub does not takeover for the Primary during the upgrade process. Once the Primary hub upgrade is completed, consult the HA guide on options for upgrading the HA hub. Once completed, then the HA probe can be re-enabled. More details can be found in the DX UIM High Availability (HA) Guide for v23.4 and higher.
Ensure that the UIM Primary Hub and Operator Console robot processes (including all core probes) are up and running.				It is NOT necessary nor advisable to stop the hub, robots or probes prior to UIM/OC installation.
Disable Anti-Virus				Temporarily disable AV and any locally installed security software to avoid any blocking/filtering during the upgrade, and/or create a full exception for all Nimsoft (UIM) programs. On Unix/Linux, excluding the default install folder, e.g., /opt/nimsoft is sufficient, but to be extra safe, add an exclusion for /tmp during install/upgrade. After completion the /tmp exclusion may be removed.
Deactivate distsrv forwarding				If distsrv forwarding is not disabled, it may cause a severe slowdown in the upgrade process or in some cases cause it to fail.
Check Java Runtime Environment Requirements				Running multiple JRE versions on the same system can cause issues.
Remove java_jre packages from Archive				Upgrade failure may be avoided by removing all "java_jre" package versions from the UIM Archive, that are older than the current 'in-place' version of UIM.
spectrumgtw probe (optional)				If you are using the spectrumgtw probe, verify the versions you will need to be at post-upgrade. DX UIM version 23.4 requires spectrumgtw version 20.40 and the DX NetOps Spectrum version should be at 22.2.x, or 23.3 or higher. spectrumgtw Release Notes DX NetOps Spectrum and DX UIM Interoperability
Windows-Specific Prerequisites				Disk compression is not supported on Windows.
Administrator Privileges				UIM can only be installed by a user with administrative privileges. If you are using a service account, login as that service account before running the installer.
MS Windows User Account Control (UAC)				UAC prevents unauthorized modifications to your system. It may need to be temporarily disabled during an upgrade.
Check Firewall - Firewall Port Reference				Check the firewall ports and protocols required for UIM in the firewall port reference. Local, intermediate, or remote firewalls can prevent install/upgrade success.
Test Database Authentication				Before starting the upgrade, confirm the data_engine can connect to the backend UIM database.
Download Software				Download UIM software from the Broadcom support website Click on the link and choose "DX Infrastructure Management MULTI-PLATFORM."
Verify uimserverpackages.zip				Prior to downloading, document the precise uimserverpackages.zip file size via file properties, and make sure it is the same exact size after download and prior to running the upgrade. If the file size changes even slightly, the file may have been corrupted and this will cause the upgrade to fail.
Pre-upgrade Risk Assessment				Prior to running the installer to upgrade UIM, it is highly recommended to follow the risk assessment section in the DX UIM Upgrade Planning Guide and Pre-Planning Checklist.pdf attached to this KB Article.
Upgrade DX UIM Server				Customers may choose to customize this section of the attached detailed planning guide and insert their own UIM upgrade execution plan. Some examples of execution plans are provided.
Upgrade Operator Console				Customers may choose to customize this section of the attached detailed planning guide and insert their own UIM upgrade execution plan. Some examples of execution plans are provided.
Upgrade Infrastructure Manager				Upgrade Infrastructure Manager for the specific version of DX UIM 23.4.x you are upgrading to, e.g., 23,4,1, 23.4.2. Otherwise you may see a warning or experience unexpected results when using IM. Use Help->About in the IM to see the current version of IM that was installed.
Configure Discovery Queues				The discovery_server 23.4.x probe allows for the new robot 23.4.x to push discovery information. Without these new queues, that information will not reach the discovery_server probe and will be ignored. This can cause a variety of issues with data correlation. The discovery_server 23.4.x probe will still work to pull information from older robots, but the new robot versions require the queues to be manually configured.

Additional Information

CABI (Tibco Jaspersoft)

Install or Upgrade for a Bundled CABI Server

With bundled cabi server, you simply deploy the cabi package from the local archive on the Primary hub to the cabi robot (Note that "CABI" a.k.a. 'Tibco Jaspersoft' a.k.a. 'Jasperserver' is already included/self-contained within the cabi probe). Still, it is important to read through the complete instructions and requirements first.

IMPORTANT!: cabi_external is classified as End of Support (EOS) since the end of 2022 so it is no longer supported.

Supporting Documents (samples)

Broadcom support highly recommends downloading the 'DX UIM Upgrade Guide and Pre-Planning Checklist' document which is attached to this KB Article - See below (and click 'Download' or Rt-click on the Download link and choose "Save link as...'). Once downloaded, please review it in full and fill out/edit the sections based on your UIM environment to ensure a successful upgrade. The more comprehensive planning guides cover both Windows and Linux, and a few samples for editing are attached to this article. These sample plans contain upgrade best practices and checks, known issues, pre-upgrade risk assessment, troubleshooting section, and more, including links to all relevant 23.4 techdocs/articles.
There is also a sample uimserver (Primary hub) install guide for customers who use MCS in their UIM environment. The "UIM 23.4 installation steps for uimserver.docx" is especially helpful for customers who actively use Monitoring Configuration Service (MCS).

Troubleshooting (Common/Known Upgrade Issues)

Important Notes

ADE
To completely avoid any issues with ADE interfering with the installer, you can delete/remove all java_jre packages from the Primary Hub local archive.

JAVA_JRE
If there are no java_jre packages in the Archive at install time, the failures described above will be avoided. After installation, you may re-download the latest java_jre package as needed.

Windows Authentication (optional)
If Windows authentication is being used to connect to a Microsoft SQL Server (MSSQL) DX UIM database, login to the Primary hub system as that same user, e.g., a Windows domain account, or the service account you defined for connecting to the database, to perform the upgrade.

For more information on Windows authentication, please refer to the following KB Article:
UIM database authentication SQL user and permissions requirements

MCS (mon_config_service)

If you are still running DX UIM 20.4x or prior; before executing an upgrade, please check the configuration in the mon_config_service probe on your Primary Hub.
In the <timed> section of the configuration, look for "policy_mode_enabled"
If this is set to "false" do NOT upgrade and please open a ticket with Broadcom Support so that we can work with you to prepare.

Post-Install Tasks

After the upgrade of DX UIM is completed, please refer to the following KB Article for any post-installation tasks:
Post-install upgrade checklist for UIM Server, Operator Console, CABI

Known Issues with associated patches to be applied (DX UIM 23.4 CU3 and CU4)

OC device deletion issue
UIM OC device deletion not completing

MCS 'Stuck' Profiles
MCS Profiles remain in Pending status and never change to Active

Known Issues when upgrading to CU6

All UIM Swagger calls return 500 – Internal Server Error

wasp startup failed after upgrade to UIM 23.4 CU6 and was green, had pid but no port

Failed to stop monitors error during upgrade to DX UIM 23.4 CU6

Suggested Key Items for Inclusion in Custom Upgrade Planning documents

Request a hotsite by following the KB Article:
How to Request a Hot Site and Pre-Upgrade Review for my Broadcom Software product upgrade?
Run through and check ALL of the checklist items in the KB Article:
DX UIM Upgrade Guide and Pre-Planning Checklist for 23.4
Reminder: Disable the HA probe on the failover hub so it doesn't arbitrarily takeover for the Primary during the upgrade.
Ensure you have a backup the following key/core configuration files:
- data_engine.cfg
- hub.cfg
- robot.cfg
- mon_config_service.cfg
- oi connector.cfg
- apm bridge.cfg
- wasp.cfg
- wasp.cfg (OC Robot)
- discovery_server.cfg
- logmon.cfg
- nas.cfg
- nas scripts folder

Check resource utilization CPU, Memory, Disk (available and disk IO) on the Primary hub before starting the upgrade!
Ensure there are no DB jobs running like backups/defrag etc.
Test the DB connection in the data_engine GUI
Cold start the automated_deployment_engine probe and once started check the logs to make sure there are no errors.
Check ALL Hub queues on the Primary hub and make sure none of them are backed up before starting the upgrade.
If new SSL certificates are required for the upgraded environment, are they already available? Ensure that there is a backup of existing SSL certificates and the keystore files.
Confirm rollback plan just in case upgrade difficulties are encountered
Include a current Known Issues section for the given cumulative update

Other

Hub Queues - notes on consolidated or custom queues

In some large environments which include a large number of queues, we have seen customers consolidate queues using generic names like 'messages' for ATTACH queues with a message Subject of * as a wildcard for all messages (similar to a catch-all). In this case, this local attach queue would include QOS_MESSAGE and alarms and would have a corresponding GET queue on the primary for all 'messages' from a specific hub.
Please note that some probes like prediction_engine probes by default, may automatically create a local ATTACH queue for QOS messages during an upgrade. When the prediction_engine probe is deployed it automatically creates its two queues, prediction_engine.QOS_MESSAGE and prediction_engine.QOS_MESSAGE.These queues would be redundant since the consolidated 'messages' queue is already processing those QOS messages via the wildcard Subject.
If this occurs, the queue mentioned above should be deleted otherwise it would back up with queued messages and not process the messages to an upstream hub. Therefore, those queue files would build up on the local file system.
The prediction_engine is responsible for collecting data to support Time to Threshold alarms. In some environments, Time to Threshold (TTT) is not used. As long as you're not using the TTT Feature, it is safe to delete the prediction_engine.QOS_MESSAGE queue if you're using a consolidated QOS_MESSAGE queue. The corresponding _CONFIG queue can be left as is.

Attachments

DX UIM Upgrade Planning Guide and Pre-Planning Checklist_2_15_2024.pdf get_app

DX UIM Upgrade Planning Guide and Pre-Planning Checklist_2_15_2024.docx get_app

UIM 23.4 installation steps for uimserver.docx get_app