14. ERMI and ISV Integration

14.1 Overview

This section describes the integration process between the ERMI module and the Independent Software Vendor (ISV) platform. The ERMI module is responsible for providing remote device management capabilities such as power control and monitoring. The ISV platform can interact with the ERMI module via APIs to implement automated workflows, enabling unified control of devices regardless of their operating system status.

14.2 API Endpoints

ISV Partner Collection

Returns a list of ISV partners available.

URI: /redfish/v1/Managers/{managerId}/Integrations

Method: GET

Response:

{
    "@odata.id": "/redfish/v1/Managers/BMC/Integrations",
    "Name": "BMC Software Integrations",
    "Members@odata.count": 1,
    "CurrentIntegration":"",
    "Members": [
        {
            "@odata.id": "/redfish/v1/Managers/BMC/Integrations/Cogniteam"
        }
    ]
}

Response Properties:

Property	Type	Description
Members	array	A list of integrations currently supported by the system. Each element contains an @odata.id link to the detailed resource of that integration.
CurrentIntegration	string	The integration currently configured and active on the system. If empty, no integration is currently set.
Members@odata.count	integer	The number of available integrations.

Specified ISV Partner Information

Returns detailed information for a specific integration.

URI: /redfish/v1/Managers/{managerId}/Integrations/{IntegrationId}

Method: GET

Response for Cogniteam:

{
  "@odata.id": "/redfish/v1/Managers/BMC/Integrations/Cogniteam",
  "Name": "Cogniteam Integration",
  "Enable": false,
  "Settings": {
    "ApiKey": "",
    "CallbackURL": ""
  }
}

Response Properties:

Property	Type	Description
Enable	boolean	A boolean value indicating the current connection status between the ERMI module and this ISV. - true: The ERMI module is currently connected to this ISV. - false: The ERMI module is not connected to this ISV.
Settings.ApiKey	string	The API key is getting from the Cogniteam portal.
CallbackURL	string	The connection endpoint defined by the Cogniteam ISV vendor for integration purposes.

Update Specified ISV Partner Configure

Updates configurable properties of a specific integration.

URI: /redfish/v1/Managers/{managerId}/Integrations/{IntegrationId}

Method: PATCH

Request Body Example for Cogniteam:

{
  "Enable": false,
  "Settings": {
    "ApiKey": "",
    "CallbackURL": ""
  }
}

Response

HTTP Status Code: 204 No Content

If the operation is successful, a status code 204 No Content will be returned.

HTTP Status Code: 400 Bad Request

If the provided parameters are incorrect, a 400 Bad Request status code will be returned.

Next section