List all robots using UIMAPI

Products

• DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

Is there a way to get a list of all robots from UIMAPI without regard to what hub they are under?

Environment

DX UIM - 20.4 and later

UIMAPI

Resolution

You can use a simple GET call to the /robots endpoint and leave all parameters empty to get a full list of robots under all hubs.

You will need to specify the UIM Administrator credentials in the call.

Example:

curl -u username:password -X GET "http://(operator console)/uimapi/robots" -H "accept: application/xml"

 

Example XML Output:

<UIMRobots>
  <UIMRobot id="1" origin="(Origin)" devId="(dev_id)" isHub="1" port="48000" version="23.4.2 [Build 23.4.2.1441, Aug  9 2024]">
    <ip>##.##.##.##</ip>
    <domain>MyDomain</domain>
    <hub>HubName</hub>
    <robot>hub-robot-name</robot>
    <address>//MyDomain/HubName/hub-robot-name</address>
    <userTag1>
    </userTag1>
    <userTag2>
    </userTag2>
    <osMajor>Windows</osMajor>
    <osMinor>Windows Server 2019 Standard, 64-bit</osMinor>
  </UIMRobot>
  <UIMRobot id="2" origin="(Other Origin)" devId="(dev_id)" isHub="0" port="48000" version="23.4.2.S [Build 23.4.2.S.1442, Aug  9 2024]">
    <ip>##.##.##.##</ip>
    <domain>MyDomain</domain>
    <hub>HubName</hub>
    <robot>other-robot</robot>
    <address>/MyDomain/Hubname/other-robot</address>
    <userTag1>
    </userTag1>
    <userTag2>
    </userTag2>
    <osMajor>UNIX</osMajor>
    <osMinor>Linux</osMinor>
  </UIMRobot>
 </UIMRobots>

For other API tools (e.g. POSTMan) you will need to specify the username in "Basic Authentication" headers.  (Example - POSTMan documentation )

Additional Information

This call intentionally only returns active robots.  It is not possible to get a list of all inactive and active robots using UIMAPI.