# loadTests

Run `core-load-tester` job with parameters

## Parameters

| Name             | Description                                                                                                                                                                                                                                                                                  | Type     | Default | Required |
|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|----------|
| host             | The base URL or IP address of the target system where the load tests will be performed.                                                                                                                                                                                                      | `string` |         | yes      |
| numberOfUsers    | The total number of simulated users (or 'locusts') that will be created in the load testing process. These users concurrently interact with the target system, simulating real-world user behavior and testing the system's ability to handle multiple simultaneous connections or requests. | `10`     | no      |
| spawnRate        | The speed at which the simulated users are spawned. It is the rate at which new users start making requests to the target host. The spawn rate is measured in users per second.                                                                                                              | `2`      | no |
| runTime          | The duration for which the load test will be run. It is typically specified in seconds, minutes, or hours, and it determines how long the simulated users will keep making requests to the target system.                                                                                    | `120s`   | no |
| waitCompletion   | When set to true, this instructs the Jenkins job to wait until the downstream job has completed its tasks before the load test is considered complete.                                                                                                                                        | true     | no |
| propagateFailure | If set to true, any failure in the load tests will cause the upstream job to fail.                                                                                                                                                                                                           | true     | no |