Adding Groups

Use this API to add a group comprising of one/more components to the eG Enterprise.

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

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 with Default key values: { "groupname":"group_X", "elements":"Citrix Logon Simulator:TestLogon,Microsoft SQL:MSSQL:1433" }
Body	Default: { "groupname":"Group name", "elements":"comma-separated list of elements" }

 

Success Response

Type	Code	Content
JSON	200	{ "Succeed": "Group has been added successfully." }

 

Failure Response

Type	Code	Content
JSON	401 UNAUTHORIZED	{ "Error": "Required group details" }
	500 Server Error	{ "Error": "One or more elements do not exist or not available to associate. Invalid elements" }

Figure 1 : Example to add a group using Postman REST Client

Adding a Group using cURL

To add a group 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/addgroup" -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 "{'groupname': 'Group name', 'elements': 'comma-separated list of elements'}"

Figure 2 shows an example of adding a group using cURL.

Figure 2 : Adding a group using cURL