Add Virtual Users

This Eggplant Performance Test Controller REST method adds additional virtual users to the currently executing test run.

URL

/test_controller/api/1.0/<workspace>/<project>/<test>/add_virtual_users

HTTP Method

POST: Adds additional virtual users to the currently executing test run

POST Data Parameters

The POST data should be an object, with an entry for each VU group you want to add virtual users to. For each group, the entry should be an object mapping the required number of users to each injector.

Response Parameters

Parameter	Type	Description
dataConfigurationCheck	Object	Whether or not the test data was configured correctly.
injectorConfigurationCheck	Object	Whether or not all injectors have been configured correctly.
licenseCheck	Object	Whether or not you have sufficient licenses to run the test.
injectorFamilies	Object	Details of the new injectors and engines that are started to run the new virtual users.

Example Request

To add one virtual user to the demoScript VU group, on injector localhost:

http://localhost:5001/test_controller/api/1.0/Demo%20Workspace/Demo/demoScript/add_virtual_users

POST Data

{
  "demoScript": {
    "localhost": 1
  }
}

Example Response

{
  "dataConfigurationCheck": {
    "message": "Data configuration OK",
    "success": true
  },
  "injectorFamilies": {
    "This machine": {
      "localhost": [
        {
          "name": "intel.win32.clr4_6.1",
          "groups": [
            {
              "minIndex": 2,
              "name": "demoScript",
              "maxIndex": 2
            }
          ],
          "port": 30052
        }
      ]
    }
  },
  "licenseCheck": {
    "message": "License is valid",
    "success": true
  },
  "injectorConfigurationCheck": {
    "message": "Injector configuration is valid",
    "success": true
  }
}