UIM x O2 Alarms integration guide
search cancel

UIM x O2 Alarms integration guide

book

Article ID: 444768

calendar_today

Updated On:

Products

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

Issue/Introduction

This guide provides a structured walkthrough for configuring bidirectional alarm synchronization between DX Unified Infrastructure Management (DX UIM) and DX Operational Observability (DX O2) SaaS. It covers component requirements, probe configuration, Southbound Gateway setup to ensure alarm state changes are consistently reflected across both platforms.

Environment

DX UIM 23.4
DX O2 SaaS
DX O2 On premise 25x

Resolution

1. Integration Flow

The integration works in two directions:

Direction

Responsible Component

Function

UIM -> DX O2

oi_connector (probe)

Sends alarms, metrics (QoS), and inventory from UIM to DX O2

DX O2 -> UIM

Southbound Gateway

Returns alarm closures/updates from DX O2 back to UIM

1.1 Components Involved

  • oi_connector probe (v2.01 or higher) - installed on UIM
  • apm_bridge probe - installed on UIM (for inventory and topology)
  • Southbound Gateway - installed on-premises as part of the DX Gateway package
  • DX O2 SaaS - Broadcom cloud-based observability platform
  • wasp probe - hosts the UIM Operator Console (OC), required for callbacks from DX O2

Warning: The SNMP Gateway probe and legacy Southbound Gateway are NOT recommended for alarm synchronization from DX UIM as of version 10.1.2. Use the oi_connector and DX Gateway instead.

2. Prerequisites

2.1 Probe Version Requirements

All probes listed below must meet the minimum version requirements before configuring the integration. Using outdated probe versions may result in missing features, data inconsistencies, or failed alarm synchronization.

Probe / Component

Min. Version

Recommended

Role in Integration

Where Installed

oi_connector

v2.01

v2.11+

Sends UIM alarms, QoS metrics, and inventory to DX O2 SaaS

Dedicated UIM Robot (connected to Primary Hub)

apm_bridge

v2.01

v2.01+

Sends UIM inventory and group topology to DX O2

Same robot as oi_connector

DX UIM Server

23.4 CU3

23.4 CU5+

Core UIM platform; required for enriched topology and new vertex ID format

UIM Primary Hub server

wasp probe

Included with UIM

Latest

Hosts the Operator Console (OC); required for southbound callbacks from DX O2

UIM Primary Hub server

nisapi (package)

Included in wasp

Latest

REST API layer used by DX O2 to close/update alarms in UIM

Deployed inside the wasp probe

DX Gateway (SBGW)

Current

Latest

On-premises Southbound Gateway; bridges DX O2 alarm actions back to UIM

On-premises server with internet access

 

Warning: Deploy both oi_connector and apm_bridge on a dedicated UIM robot connected to the Primary Hub. Running them on the Primary Hub itself may impact performance.

2.3 Network Requirements

  • The oi_connector server must have outbound HTTPS access to the DX O2 gateway URL
  • DX O2 SaaS must be able to reach the public URL of the UIM Operator Console (OC Host Name)
  • Port 80 (or 443 with HTTPS) must be open between the components
  • For on-premises environments with private IPs, a public FQDN or network tunnel is required

Warning: If the UIM Operator Console is only reachable via a private IP address (e.g. 10.x.x.x), DX O2 SaaS will be unable to send alarm closures back to UIM. Use a public FQDN or configure the DX Gateway as an intermediary.

3. oi_connector Configuration on UIM

The oi_connector probe is responsible for sending data from UIM to DX O2. It must be configured through the UIM Admin Console (AC).

3.1 Accessing the oi_connector

  • Open the UIM Admin Console (AC)
  • Navigate to the robot where the oi_connector is installed
  • Double-click the oi_connector probe to open its configuration

3.2 DOI Configuration

Field

Value

Description

Default Tenant ID

<your tenant ID>

DX O2 tenant ID (GUID format)

URL

<DX O2 gateway URL>

Ingestion gateway URL provided by Broadcom

Tenant Token

<token>

DX O2 tenant authentication token

Enable Proxy Settings

Optional

Enable only if a proxy exists between UIM and DX O2

Enable Multitenancy

Disabled

Enable only for environments with multiple tenants

3.3 OC Connection Details - CRITICAL for Bidirectionality

This section defines how DX O2 communicates back to UIM to close alarms. It is the most critical section for ensuring bidirectional alarm sync.

Field

Recommended Value

Notes

OC Host Name

https://<public-fqdn-of-uim>

DO NOT use a private IP (10.x.x.x) - use public FQDN

User Name

<oc_admin_user>

UIM Operator Console administrator username

Password

<oc_password>

Password for the OC administrator user

OC Port

443

Use 443 with HTTPS enabled

HTTPS Enabled

Enabled

Must be enabled for secure connections

 

Warning: If the OC Host Name field contains a private IP address (e.g. http://10.x.x.x), the DX O2 Southbound Gateway will be unable to send alarm closures back to UIM. Replace it with the server's public FQDN.

3.4 Reconciliation Configuration

Field

Default Value

Description

Time Range

1 month (31 days)

Time window for alarm reconciliation

Interval between reconciliation

10

Interval in minutes between reconciliation cycles

 

3.5 es_enabled Parameter (Raw Config)

For short-lived alarms that may not have their CLOSED status correctly updated in DX O2, enable the es_enabled parameter in the probe's raw configuration file:

 

es_enabled = true

When es_enabled = true, instead of relying solely on the local alarm payload to send a closure, the oi_connector fetches the existing alarm data directly from DX O2, updates its status to CLOSED, and republishes it. This ensures alarm closures are always properly synchronized, even for short-lived alarms where the full payload may not be available at the time of closure.

4. Southbound Gateway Configuration in DX O2 SaaS

The Southbound Gateway is configured directly in the DX O2 SaaS portal and defines how DX O2 sends alarm updates back to UIM.

4.1 Accessing the Configuration

  • Log in to the DX O2 SaaS portal
  • Navigate to Settings (gear icon)
  • Click on Integrations
  • Select Configure Gateways
  • Click Edit on the existing UIM gateway entry, or create a new one

4.2 Edit Southbound Gateway - Field Reference

Field

Value

Description

Name

uim

Gateway identifier name

Product name

UIM

Select UIM from the dropdown

UIM URL

https://<public-fqdn>:<port>

Publicly accessible URL of the UIM Operator Console

Authentication type

Basic Auth

Authentication method

Username

<oc_admin_user>

UIM Operator Console administrator username

Password

<oc_password>

UIM Operator Console administrator password

 

Tip: The UIM URL configured here must be the public URL of the Operator Console - for example: https://uim.yourcompany.com:443. This URL must be reachable from the Broadcom SaaS infrastructure over the internet.

 

Powered by Wolken Software