> For the complete documentation index, see [llms.txt](https://help.highlight.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.highlight.net/admin/admin-page/performance-test-template.md).

# 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](/admin/admin-page/performance-test-snmp.md#create-new-test-initial-dialog).

## Create performance test template

{% stepper %}
{% step %}

### Initial dialog

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

{% hint style="info" %}
If the above option is not listed, ensure a folder is selected
{% endhint %}

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:

<table><thead><tr><th width="144">Category</th><th width="151">Test type</th><th>Purpose</th></tr></thead><tbody><tr><td>Reachability</td><td>ICMP</td><td>Tests whether a remote device responds and measures round-trip delay</td></tr><tr><td>Reachability</td><td>UDP</td><td>Measures network delay between locations</td></tr><tr><td>Application availability</td><td>TCP Open</td><td>Determines whether an application is active ("listening")</td></tr><tr><td>Network performance</td><td>Precision delay</td><td>Measures realistic jitter and delay statistics</td></tr><tr><td>Voice</td><td>MOS</td><td>Assesses a network path for voice quality</td></tr></tbody></table>

**Create** moves to the next step.
{% endstep %}

{% step %}

### 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.
{% endstep %}

{% step %}

### 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 |

{% hint style="info" %}
The two options **From a common device** or **To a common device** are only available when the template is first created, not on edit.
{% endhint %}

#### To a common device (default)

<table><thead><tr><th width="128">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Target IP</strong></td><td>Add the IP address of the device you are planning to test to.</td></tr><tr><td><strong>Target Description</strong></td><td>Add an optional description of the target which will appear in the Details page, reports and alerts.</td></tr><tr><td><strong>Target port</strong></td><td><strong>ICMP Ping and MOS:</strong> Field is empty and greyed out (non-editable).<br><br><strong>UDP Echo and Precision delay:</strong> If required, change the UDP port from the default of 7. The target device needs additional configuration if you change it.<br><br><strong>TCP Open only:</strong> Add the application port on the target device that you are checking is active.</td></tr><tr><td><strong>Source IP and Description</strong></td><td>Fields are empty and greyed out (non-editable).</td></tr><tr><td><strong>Test frequency</strong></td><td>If required, change the frequency from the displayed default.</td></tr><tr><td><strong>VRF</strong></td><td>Optional. If planning to test over a specific network, add the <a href="/getting-started/new-user/glossary.md#vrfvirtual_routing_and_forwarding">VRF</a> name.</td></tr><tr><td><strong>DSCP</strong></td><td>If required, select the packet marking from the drop-down using a <a href="/getting-started/new-user/glossary.md#dscpdifferentiated_services_code_point">DSCP</a> or IP Precedence setting.</td></tr></tbody></table>

#### From a common device

<table><thead><tr><th width="133">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Target IP and Description</strong></td><td>Fields are empty and greyed out (non-editable).</td></tr><tr><td><strong>Target port</strong></td><td>Field is empty and greyed out (non-editable).</td></tr><tr><td><strong>Source IP</strong></td><td>Add the IP address of the device you are planning to test from.</td></tr><tr><td><strong>Source Description</strong></td><td>Add an optional description of the source which will appear in the Details page, reports and alerts.</td></tr><tr><td><strong>Test frequency</strong></td><td>If required change the frequency from the default displayed.</td></tr><tr><td><strong>VRF</strong></td><td>Optional. If planning to test over a specific network, add the <a href="/getting-started/new-user/glossary.md#vrfvirtual_routing_and_forwarding">VRF</a> name.</td></tr><tr><td><strong>DSCP</strong></td><td>If required, select the packet marking from the drop-down using a <a href="/getting-started/new-user/glossary.md#dscpdifferentiated_services_code_point">DSCP</a> or IP Precedence setting.</td></tr></tbody></table>

**Save** to update the details for this template.
{% endstep %}

{% step %}

### 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.

{% hint style="info" %}
Units for Precision delay tests are microseconds, otherwise milliseconds.
{% endhint %}

<table><thead><tr><th width="97">Threshold</th><th>Health assessment</th></tr></thead><tbody><tr><td><strong>Delay</strong></td><td>Test round trip delay results are compared to the Delay threshold.</td></tr><tr><td><strong>Packet loss</strong></td><td>The percentage of test non-responses across all packets sent is compared to the Packet loss threshold.</td></tr><tr><td><strong>Jitter</strong></td><td>For MOS and Precision delay tests, the monitored device reports jitter. Highlight does not calculate it. The result is compared to the Jitter threshold.</td></tr><tr><td><strong>Jitter</strong></td><td>For ICMP Ping and UDP echo tests, Highlight calculates jitter from sample round trip delay results. The result is compared to the Jitter threshold.</td></tr><tr><td><strong>Score</strong></td><td>For MOS tests only, the monitored device reports MOS. Highlight does not calculate it. The result is compared to the Score threshold.</td></tr></tbody></table>

#### For each test

<table><thead><tr><th width="109">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Packet size</strong></td><td>The size in bytes of each test packet sent (cannot be changed for MOS tests).</td></tr><tr><td><strong>Total packets</strong></td><td>(Precision delay tests only) The number of packets contributing to a single test result.</td></tr><tr><td><strong>Packet interval</strong></td><td>(Precision delay tests only) The delay between the packets which contribute to a single test result.</td></tr><tr><td><strong>Codec</strong></td><td>(MOS tests only) Select the codec used in your network so the router can calculate the equivalent MOS value.</td></tr></tbody></table>
{% endstep %}

{% step %}

### Containers

Use the Containers accordion to automatically include all tests created using this template in one or more containers. See [containers](/admin/admin-page/watch-containers.md) for how the available and included lists work.
{% endstep %}

{% step %}

### Save

**Save** updates the details for this template.
{% endstep %}
{% endstepper %}

## 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.highlight.net/admin/admin-page/performance-test-template.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.