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: 23.4
• Component: UIMAPI Package
• Operator Console

Cause

• Guidance

Resolution

To use the uimapi, the package can be deployed to an Operator Console server or, if required, a robot using a more minimal footprint.

• The minimum required steps to deploy are:
  • deploy wasp
  • deploy wasp_service_wrapper package
  • deploy uimapi
  • when these packages are installed, start the wasp probe

Once the uimapi package is deployed either to an Operator Console robot or with the minimum required probes as described above, the swagger UI can be accessed as follows:

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)