Configuring Specific Tests

This API aids in configuring a specific test for a chosen component of a chosen Component Type.

Note:

A few key values of the Body parameter are optional. These optional key values are mentioned separately in the below table.

URL: http://<eG manager IP:port>/api/eg/orchestration/SpecificTestConfiguration

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

Example:

{

"componenttype": "Microsoft windows",

"componentname": "WIN-0RUC0BV0SK3",

"testname": "Disk activity",

"USEEXE": "Yes",

"write_size_in_kb": "50",

"high_security": "No"

}

Body

Default:

{

"hostip":"IP address of the component",

"componenttype":"ComponentType",

"componentname":"nick name of the component",

"port":"port at which the component listens",

"testname":"name of the test that is to be configured",

"param1":"value1",

"param2":"value2",

"param3":"value3",

.

.

.

}

 

Success Response
Type Code Content

JSON

200

{

"Succeed": "Component has been configured successfully."

}

 

Failure Response
Type Code Content

JSON

401

{

"Error": "Component type is not available."

}

Figure 3 : Example to configure a specific test using Postman REST Client

Configuring Specific Tests using cURL

To configure a specific test through the REST API using cURL, the command should be specified in the following format:

curl --location --request POST "http://<eG Manager IP:Port>/api/eg/orchestration/addcomponent" -H "managerurl:http://<eG Manager IP:Port>"-H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "Content-Type: application/json" --data-raw "{'componenttype': 'ComponentType', 'componentname': 'nick name of the component', 'port': 'port at which the component listens', 'testname': 'name of the test that is to be configured', 'param1': 'value1', 'param2': 'value2', 'param3': 'value3', 'paramn': 'valuen'}"

Figure 4 shows an example of configuring a specific test for a chosen component of a chosen Component Type using cURL.

Figure 4 : Configuring a specific test using cURL