UIMAPI deployment and configuration

Products

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

Issue/Introduction

How to deploy and configure the UIMAPI package in DX UIM?

Environment

• Release: UIM 20.4/23.4
• Component: UIMAPI Package
• Operator Console

Cause

• Guidance

Resolution

The uimapi package needs to be installed on the OC robot to use the UIMAPI webservices

Once this package is installed, you may open the swagger UI to run tests and get results.

1. http://##.###.###.###/uimapi/swagger-ui/index.html

The UIMAPI swagger page offers many endpoints such as accounts, robots, domains, alarms etc as shown below

To query robots endpoints, click here and then filter on available options such as “devid, domain, hub, robotName, ip, usertag1, usertag2 and origin”

For example: to get a list of Robots from a specific hub, enter hub name “UIMPRI_hub”, hit “Execute”

Example results:

1. • The “request URL” is http://##.###.###.###:80/uimapi/robots?hub=UIMPRI_hub
   • Response Code is 200 (Successful)