uninstall a robot using UIMAPI with _uninstall_robot callback

Products

• DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

You want to uninstall the UIM Robot from a server remotely using UIMAPI.

 

Environment

DX UIM - 23.4.3 (CU3) or later
robot/controller 23.4.3 or later - The _uninstall_robot callback does not exist on controller versions 23.4.2 and prior.

Resolution

To uninstall a robot you can use the _uninstall_robot callback directly against the controller.

To accomplish this with UIMAPI, you can execute the probes/callback function.

Usage Example

In this example, we want to uninstall the robot on the server "a-robot-1" which is a robot reporting to SecondaryHub-1.  

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 robot to uninstall
probe: the probe to execute the callback against -- in this case "controller" is the probe which contains the "_uninstall_robot" callback.
callback: the name of the callback to execute, in this case "_uninstall_robot"

The request body can be left at the default values:

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

 

Screenshot example from UIMAPI:

USE WITH CAUTION! This will result in the robot being uninstalled completely.  If you run it against a hubrobot, it will remove the entire robot and hub.