Examples of MCS UIMAPI calls

Products

• DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

This article provides an example of how to create an MCS profile using UIMAPI calls

Environment

DX UIM 23.4.x 

UIMAPI

Resolution

Here are the detailed steps for creating an MCS profile using the UIM API:

 

1. Get SSRV2 Templates:

    

   API Call: 'GET /uimapi/v0/templates'
   Description: Retrieve the list of SSRV2 templates available and select the desired template ID.

    

2. Get a Blueprint for the Specified SSRV2 Template:

    

   API Call: 'GET /uimapi/v0/templates/{mcs_template_id}/blueprint'
   Parameters:
   'mcs_template_id': Get the 'templateId' value of one of the list of templates obtained from step 1.
   'Show hidden': Set this parameter to 'true'.
   Action: Download and copy the response body from this API call.

    

3. Create a Device Profile:

    

   API Call: 'POST /uimapi/deviceoperations/{identifier}/profiles'
   Parameters:
   'identifier': Set this to 'cs_id' of the robot on which we want to create profile.
   'lookup': Set this to 'by_cs_id'.
   Request Body: Use the response body obtained from step 2.
   Description: Create a profile for the specified device using the template blueprint.

    

4. Create a Group Profile:

    

   API Call: 'POST /uimapi/devicegroups/{mcs_grp_id}/profiles'
   Parameters:
   'mcs_grp_id': The ID of the group to which the profile should be added.
   Request Body: Use the response body from step 2.
   Description: Add the profile to the specified group using the template blueprint.

 

The successful response body from steps 3 or 4 will contain the profile ID created for the device/group. This profile ID can be verified in the ssrv2profile database table or by checking the respective device/group in the Operations Console.