Retrieving device_idx via NCM REST API

Products

• Network Observability

Issue/Introduction

The device_idx field from the NCM PostgreSQL database cm_device table is not returned by default when using the standard REST API endpoints.

Environment

DX NetOps NCM (formally Voyance) 25.4.2

Cause

This is a product limitation. The existing publicApi jar files did not include the device_idx field in the REST API response payload for device information. 

Resolution

A workaround was provided via a hotfix JAR file to enable this functionality. 

Backup Existing Files: Navigate to the library directory and back up the current JAR: 

$VOYENCE_HOME/ncmcore/webapps/ncm-webapp/WEB-INF/lib/publicApi-25.4.2.jar

Replace JAR File: Replace the existing publicApi-25.4.2.0.jar in the directory mentioned above with the updated version attached to this knowledge document.

Update Permissions: Set the correct ownership for the new file:

 chown ncm:voyance publicApi-25.4.2.0.jar

Restart Services: Restart the NCM application service to apply changes:

Verify via API: Use the following POST call to retrieve the device information, which will now include the device_idx:

Endpoint: POST /api/v1/network/{networkId}/devices/info