Setting the Engine Start Timeout on a Test

Overview

In the Test configuration JSON you get from the API, there is a block of timeouts:

"timeouts": {
  "connectionRequested": null,
  "connectionAttempted": null,
  "sessionStarted": null,
  "sessionEnded": null,
  "sessionAborted": null,
  "abortConfirmed": null
}

The connectionAttempted parameter governs how long the Appliance will wait for the Engine to start on a new session before declaring a login failure. This is useful when you have especially slow logins that take close to, or more than, 5 minutes.

You can edit this timeout by accessing the /publicApi/v8-preview/tests/{testId} endpoint and specifying the “timeouts.connectionAttempted” parameter.

You can use a PowerShell script attached at the bottom of this page to automate this process without having to go to our API interface.

Using the PowerShell Script

To use this script, download it, unblock it, and then get an API key from the Appliance web UI. To create a Configuration access token, see Adding a System Access Token.

Run the command “get-help .\engine-start-timeout.ps1 -detailed” for specific guidance on running this script. Examples:

List all available Tests:

PS> .\engine-start-timeout.ps1 -server FQDN -key KEY -action list

Get the currently configured timeout for a specific Test.

PS> .\engine-start-timeout.ps1  -server FQDN -key KEY -action get -testguid XXX

Set the timeout on the specific Test to 300 seconds.

PS> .\engine-start-timeout.ps1  -server FQDN -key KEY -action set -testguid XXX -value 300

Using the Public API

If you cannot use the PowerShell script, you can use our Swagger interface to access the API. For details on accessing the Public API in Login Enterprise, see Accessing the Public API.

Once you have accessed the 8.0-preview API Console (Swagger) link, scroll down to the Test API section:

1. To modify a Test, you must first use the GET method with {testId} to get the current configuration, and then use the PUT method with {testId} to update it. To get your Test ID, modify your Test in the Login Enterprise UI. For this:

   1. In the Login Enterprise sidebar menu > Configuration > Manage tests, select the type of Test, and click on your specific Test to modify it. 

   2. Then, look at your location bar at the top of the browser. Your URL will look like this: https://login-ent.loginvsi.com/configuration/tests/f69f0a19-b2fb-4e5d-9f85-4bbe69493d93/settings

   3. The GUID in that URL is the ID of your Test. Copy it into your clipboard.

2. Click on the second GET method, the one that includes testId, and open it as follows:

3. Click Try it out to enable the fields. 

4. In the testId field, paste your test ID. 

5. Leave the include options untouched. 

6. Scroll down and click Execute. 

7. In the Server response block, you should have a return code of 200 and the JSON body of your Test configuration:

Note the Copy button to copy the entire JSON output into your clipboard. Don’t do that yet.

Be careful not to scroll too far down to the Responses section. That section lists possible response examples, and not your actual Test configuration.

8. Click on the PUT method with {testId} to open it up, and then click Try it out. 

9. In the testId field, paste your testId.

10. Go back to the results of your GET and use the Copy button to copy the JSON into your clipboard. 

11. Return to the PUT method and paste it into the Request Body, replacing the data that is there.

12. Scroll down to the bottom of the JSON you just pasted and look for the “timeouts” entry. If this Test has never had connectionAttempted set, “timeouts” will be null:

Otherwise, it will list a set of timeouts as follows:

13. If your “timeout” block is null, change it to include just your new timeout as follows:

"timeouts": {
  "connectionAttempted": 0
}

14. If the block already exists, update the value you want. Ignore the other settings.

If you are modifying a Load Test or a Continuous Test, you must make one other modification.

15. Look for the following setting:

      "sessionMetricDefinitionGroupId": "...GUID...",

16. If the setting exists and is not “null”, you must change the field name to sessionMetricGroupId:

      "sessionMetricGroupId" ": "...GUID...",

17. Click Execute. You should see a “200” response.

18. Scroll back up to the GET with {testId} section and click Execute again. You should see your updated value there. The next Test execution will use this new timeout value.

engine-start-timeout.ps1