removing a robot from the hub list using UIMAPI and removerobot callback

Products

• DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

A robot has been uninstalled but still appears in the list of robots reporting to a hub.

You want to use a UIMAPI call to remove the robot from the hub list.

Environment

DX UIM - Any Version
UIMAPI - Any Version

Resolution

To remove a robot from the hub's list of active robots, the "removerobot" callback is used.

To accomplish this using UIMAPI you need to use the "probes/callback" API.

Note: this does not uninstall the robot. It only removes it from the hub list.  If the robot is still active, it will eventually return to the hub list unless it is uninstalled.

Example Usage

In this example, we want to remove the entry for "a-robot-1" which is a robot reporting to SecondaryHub-1.  We will need to make note of both the robotname, and the hubrobot name (the robot name where the 'hub' probe is running) as we will provide both of these values to the callback function.

 

The "callback" API function can be found in UIMAPI under "probes":

This function requires the following parameters:

Domain: the UIM Domain
hub: the hub name which manages the robot to be removed
robot: the name of the hubrobot (the robot where 'hub' is installed) -- not the name of the robot to remove
probe: the probe to execute the callback against -- in this case "hub" is the probe which contains the "removerobot" callback.
callback: the name of the callback to execute, in this case "removerobot"

The request body should contain:

{
  "parameters": [
    {
      "name": "name",
      "type": "string",
      "value": "(robotname)"
    }
  ],
  "pds": "string",
  "timeout": 0
}

Where "robotname" is the name of the robot you want to remove from the list.

Screenshot example from UIMAPI:

 

 

This example will remove the entry for "a-robot-1" from the list of robots on the secondary hub.

Result after refreshing the IM view:

 

 

Additional Information

To uninstall the robot, you can use the _uninstall_robot callback (DX UIM 23.4.3 or later.)