Retrieving the Tests Supported by eG Enterprise Using eG REST API

To retrieve the tests that are available in eG Enterprise for execution, by default, administrators can use the eG REST API. The URL can be specified in the following format:

URL: http://<eG manager IP:port>/api/eg/miscservice/getTestMapping

Method: POST

Content-Type: application/json

Inputs to be Specified
Parameters Key values Example

Headers

managerurl: Base URL of the eG Manager i.e., http://<IP address of the eG console:Port>

user: eG username or domain/eG username

pwd: Base64 encoded password

Not Applicable

 

Success Response
Type Code Content

JSON

200

{

"CIsEqChassisTest": "Equipment Chassis - Intersight",

"CIsEqFanTest": "Equipment Fan - Intersight",

"CIsEqFanModuleTest": "Equipment Fan Module - Intersight",

"CIsEqIOCardTest": "Equipment IO Module - Intersight",

"CIsEqPSUTest": "Equipment PSU - Intersight",

"CIsEqPSUControlTest": "Equipment PSU Control - Intersight",

"CIsEthPortTest": "Ethernet Port - Intersight",

"CIsEthPortChTest": "Ethernet Port Channel - Intersight",

"CIsBladeTest": "Blade Server - Intersight",

.

.

.

}

 

Failure Response
Type Code Content

JSON

401 UNAUTHORIZED

{"code": 401,"error": "Invalid username or password."}

JSON

500 Server Error

{"code": 500,"error": "Server Error. Please check /manager/logs/error_log in the installation directory for more information."}

Retrieving List of Tests Using Postman REST Client

Figure 1 : Retrieving the tests supported by eG Enterprise using Postman REST Client

Retrieving the Tests Supported by eG Enterprise using cURL

To retrieve the details of the tests available in eG Enterprise for execution in the target environment using cURL, the command should be specified in the following format:

curl -L -X POST "http://<eG Manager IP:Port>/api/eg/miscservice/getTestMapping" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "managerurl:http://<eG Manager IP:Port>"

Figure 2 shows an example cURL command for retrieving the details of all the tests available for execution in the target environment.

cURL Command to Retrieve List of Tests

Figure 2 : An example cURL command to retrieve the tests supported by eG Enterprise

Figure 3 shows a sample output that retrieves the tests supported by eG Enterprise using cURL.

Retrieving List of Tests Using cURL

Figure 3 : Sample output with the list of tests supported by eG Enterprise