For the complete documentation index, see llms.txt. This page is also available as Markdown.

Performance test template

Overview

A performance test template can be used to pre-define a number of common test parameters, reducing the time to create individual tests. It can also auto-link such tests with a container, for use as a service tile or for reporting. The template must be defined in a folder.

The template does not in itself create any tests. Please refer to how to create a performance test.

Create performance test template

1

Initial dialog

Click + on the required folder in Admin then select Create a new Performance test template.

If the above option is not listed, ensure a folder is selected

The following dialog appears with the fields explained below.

This dialog allows you to select the type of test template you wish to create, which covers 5 test types across 4 categories:

Category
Test type
Purpose

Reachability

ICMP

Tests whether a remote device responds and measures round-trip delay

Reachability

UDP

Measures network delay between locations

Application availability

TCP Open

Determines whether an application is active ("listening")

Network performance

Precision delay

Measures realistic jitter and delay statistics

Voice

MOS

Assesses a network path for voice quality

Create moves to the next step.

2

Main

Give the template a name and optional description. The template name will be displayed when selecting a template to apply to a new performance test. The template description will be displayed once that template has been selected for the new test.

The template may be saved at this point or, more usually, now select the Target accordion.

3

Target

These two options change which fields are available:

Target
Available fields
Unavailable fields

From a common device

Source IP related fields

Target IP related fields

To a common device (default)

Target IP related fields

Source IP related fields

The two options From a common device or To a common device are only available when the template is first created, not on edit.

To a common device (default)

Field
Description

Target IP

Add the IP address of the device you are planning to test to.

Target Description

Add an optional description of the target which will appear in the Details page, reports and alerts.

Target port

ICMP Ping and MOS: Field is empty and greyed out (non-editable). UDP Echo and Precision delay: If required, change the UDP port from the default of 7. The target device needs additional configuration if you change it. TCP Open only: Add the application port on the target device that you are checking is active.

Source IP and Description

Fields are empty and greyed out (non-editable).

Test frequency

If required, change the frequency from the displayed default.

VRF

Optional. If planning to test over a specific network, add the VRF name.

DSCP

If required, select the packet marking from the drop-down using a DSCP or IP Precedence setting.

From a common device

Field
Description

Target IP and Description

Fields are empty and greyed out (non-editable).

Target port

Field is empty and greyed out (non-editable).

Source IP

Add the IP address of the device you are planning to test from.

Source Description

Add an optional description of the source which will appear in the Details page, reports and alerts.

Test frequency

If required change the frequency from the default displayed.

VRF

Optional. If planning to test over a specific network, add the VRF name.

DSCP

If required, select the packet marking from the drop-down using a DSCP or IP Precedence setting.

Save to update the details for this template.

4

Thresholds

The Thresholds tab varies according to what template type has been selected. All required fields have a default entry so the template can be saved without further changes. Default values for each template type are listed on the performance test information page.

Thresholds

The threshold values can impact heat tiles and therefore alerting, and would be set to match an SLA agreement for example.

Units for Precision delay tests are microseconds, otherwise milliseconds.

Threshold
Health assessment

Delay

Test round trip delay results are compared to the Delay threshold.

Packet loss

The percentage of test non-responses across all packets sent is compared to the Packet loss threshold.

Jitter

For MOS and Precision delay tests, the monitored device reports jitter. Highlight does not calculate it. The result is compared to the Jitter threshold.

Jitter

For ICMP Ping and UDP echo tests, Highlight calculates jitter from sample round trip delay results. The result is compared to the Jitter threshold.

Score

For MOS tests only, the monitored device reports MOS. Highlight does not calculate it. The result is compared to the Score threshold.

For each test

Field
Description

Packet size

The size in bytes of each test packet sent (cannot be changed for MOS tests).

Total packets

(Precision delay tests only) The number of packets contributing to a single test result.

Packet interval

(Precision delay tests only) The delay between the packets which contribute to a single test result.

Codec

(MOS tests only) Select the codec used in your network so the router can calculate the equivalent MOS value.

5

Containers

Use the Containers accordion to automatically include all tests created using this template in one or more containers. See containers for how the available and included lists work.

6

Save

Save updates the details for this template.

Edit dialog

To edit a template, select it from the list in Admin

Once in edit change any template parameter or setting on any accordion. See the relevant create section above for a description of the fields.

Save updates the details for this template.

Delete is only available on edit and deletes the performance test template.

Last updated

Was this helpful?