> 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-snmp.md).

# Performance test SNMP

## Overview

This page explains how to create and edit individual Performance tests on Highlight. For service providers with a requirement to add multiple tests (20 or more) there is an alternative process which is explained on the Bulkloading Performance Tests page.

Highlight can carry out a variety of different performance tests. For more details on performance tests and why they are used, see our Performance test information page in our Functionality section.

Performance testing is supported on Cisco devices for all test types, and on Juniper devices on all but MOS.

## Edit Watch: Performance

This dialog shows a list of all performance tests on the selected bearer. Details for each test are displayed down the right when a test is selected.

**Create new performance test** — Use to create a new test, see sections below for details.

## Create new test: Initial dialog

This dialog allows you to select the type of test you wish to run, which falls into 5 categories:

* **Reachability**
  * **ICMP**: Tests if a remote device responds and measure round trip delay
  * **UDP**: Measures network delay between locations
* **Application availability**
  * **TCP Open**: Determines if application is active ("listening")
* **Network performance**
  * **Precision delay**: Measure realistic jitter and delay statistics
* **Voice**
  * **MOS**: Assess a network path for voice quality

**based on...** — The list of test templates available is filtered according to the test type selected above. Use a test template if creating multiple tests with common parameters. Alternatively create a test with No template. If no templates exist for your selected test type, then this drop-down will be disabled.

**Create** — moves to the next step.

## Source

Use this dialog to set up a test either on the current device or on a different device.

The two From options **This device** or **Another device** are only available when the test is first created, not on edit.

{% tabs %}
{% tab title="SNMP v2c" %}
*Create From this device and From another device for SNMP v2c, not yet validated*

### From: This device

* **Device IP** — Defaults to the parent watch IP address (Non-editable)
* **RO Community** — Defaults to the parent watch SNMP community string (Non-editable)
* **RW Community** — Defaults to the folder setting, change if necessary

### From: Another device

* **Device IP** — Use "Add new device", or select a previously used device from the drop-down
* **New device address** — Appears if "Add new device" selected for Device IP. Add the IP address of the device which will run the test
* **RO Community** — Defaults to the parent watch SNMP community string, edit as needed for the new device (Required)
* **RW Community** — Defaults to the folder setting, edit as needed for the new device (Required)
  {% endtab %}

{% tab title="SNMP v3" %}
*Create From this device and From another device for SNMP v3, not yet validated*

### From: This device

* **Device IP** — Defaults to the parent watch IP address (Non-editable)
* **Security Level** — Defaults to authPriv (Non-editable)
* **Username** — Must be fewer than 32 characters and may not contain `,` `'` or `"` (Required)
* **Auth key** — Must be fewer than 32 characters and may not contain `,` `'` or `"` (Required). Select MD5 (default) or SHA1
* **Priv key** — Must be fewer than 32 characters and may not contain `,` `'` or `"` (Required). Select DES (default) or AES 128

### From: Another device

* **Device IP** — Use "Add new device", or select a previously used device from the drop-down
* **New device address** — Appears if "Add new device" selected for Device IP. Add the IP address of the device which will run the test
* **Security Level** — Defaults to authPriv (Non-editable)
* **Username** — Must be fewer than 32 characters and may not contain `,` `'` or `"` (Required)
* **Auth key** — Must be fewer than 32 characters and may not contain `,` `'` or `"` (Required). Select MD5 (default) or SHA1
* **Priv key** — Must be fewer than 32 characters and may not contain `,` `'` or `"` (Required). Select DES (default) or AES 128
  {% endtab %}
  {% endtabs %}

If changing the SNMP version on edit, the test automatically disables and needs to be validated before it can be enabled.

Before the test will run in Highlight the device needs to be validated. The test is Disabled (top right) until the device has been successfully validated.

**Click Validate now.** The result will either be:

* **Device successfully configured** — "This device can be used for performance tests" — and the test will be automatically Enabled, and can then be Disabled if required.
* **Device not validated** — "Validation failed" — and the test will remain Disabled with no toggle available.

When a test is Disabled:

* data is not collected for the test
* alerts cannot be sent nor colours changed (green to amber for example)
* the watch status card for the test is not displayed
* the performance chart (on the details page) is not displayed

**Move next** to the Target tab, or **Save** to update the details for this test.\
**Delete** — Available on edit only and deletes the performance test.

## Target

**Fields for: ICMP Ping, UDP Echo, TCP Open, Precision delay and MOS tests**

<table><thead><tr><th width="124">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 testing.</td></tr><tr><td><strong>Description</strong></td><td>Add an optional description. It appears in the Details page, reports, and alerts.</td></tr><tr><td><strong>Target port</strong></td><td><strong>ICMP Ping and MOS:</strong> The field is empty and greyed out. It cannot be edited.<br><br><strong>UDP Echo and Precision delay:</strong> Change the default UDP port, <code>7</code>, if required. The target device needs additional configuration if changed.<br><br><strong>TCP Open only:</strong> Add the target device application port to check it is active.</td></tr><tr><td><strong>Source IP</strong></td><td>Add the source IP address for the test. It may differ from the default watch IP.</td></tr><tr><td><strong>Description</strong></td><td>Add an optional description. It appears on the Details page, reports, and alerts.</td></tr><tr><td><strong>Test frequency</strong></td><td>Change the displayed default frequency if required.</td></tr><tr><td><strong>VRF</strong></td><td>Optional. Add the VRF name when testing over a specific virtual network.</td></tr><tr><td><strong>DSCP</strong></td><td>Select the required packet marking using DSCP or IP Precedence settings.</td></tr></tbody></table>

**Move next** to the Thresholds tab, or **Save** to update the details for this test.\
**Delete** — Available on edit only and deletes the performance test.

## Thresholds

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

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

<table><thead><tr><th width="131">Threshold</th><th width="231">Applies to</th><th>Health assessment</th></tr></thead><tbody><tr><td><strong>Delay</strong></td><td>All tests</td><td>Compares results with the round trip delay. Precision delay uses microseconds. Other tests use milliseconds.</td></tr><tr><td><strong>Packet loss</strong></td><td>All tests</td><td>Compares the percentage of test non-responses against all packets sent.</td></tr><tr><td><strong>Jitter</strong></td><td>MOS and Precision delay</td><td>The target device reports jitter. Highlight does not calculate it.</td></tr><tr><td><strong>Jitter</strong></td><td>ICMP Ping and UDP Echo</td><td>Highlight calculates jitter from sample round trip delay results.</td></tr><tr><td><strong>Score</strong></td><td>MOS only</td><td>The target device reports MOS. Highlight does not calculate it.</td></tr></tbody></table>

### For each test

<table><thead><tr><th width="110">Setting</th><th>Applies to</th><th>Description</th></tr></thead><tbody><tr><td><strong>Packet size</strong></td><td>All tests except MOS</td><td>The size in bytes of each test packet sent.</td></tr><tr><td><strong>Total packets</strong></td><td>Precision delay only</td><td>The number of packets contributing to a single test result.</td></tr><tr><td><strong>Packet interval</strong></td><td>Precision delay only</td><td>The delay between packets contributing to a single test result.</td></tr><tr><td><strong>Codec</strong></td><td>MOS only</td><td>Select the codec used in your network. The router calculates the equivalent MOS value.</td></tr></tbody></table>

**Save** — Update the details for this test.\
**Delete** — Available on edit only and deletes the performance test.

## Containers

The Containers tab enables you to include this test in one or more containers. Logos will be shown if a logo has been added to the container.

If the test has been created based on a template with one or more associated containers, then those containers will show on the Containers tab. Containers linked from a template can be removed and other containers can be added.

### Choose containers - left panel

* **Filter...** — Enter text to select containers whose name or description contain that string (case is ignored)
* Click to add this watch to the container
* Indicates this watch is already included in the container, click to remove it

*Filter the list of containers based on name or description*

### Included in these containers - right panel

See a list of all containers in which this test is included. Use to remove this test from the container.

You will not see a container listed on this tab if:

* the container is above your user folder/location in the tree
* the container is set to Visibility: Internal and you are a user in a customer folder
* the container is enabled for maintenance and you do not have the Manage maintenance permission

**Save** — Update the details for this test.\
**Delete** — Available on edit only and deletes the performance test.


---

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