> 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/tunnel.md). # Tunnel ### Main Use this panel to edit a tunnel. If the parent controller has the option to autodiscover tunnels selected, then Highlight discovers tunnels. Tunnels cannot be created any other way. {% hint style="info" %} This option is currently only available for Meraki. {% endhint %} #### Discovered Read-only and shows the date of autodiscovery of the tunnel. #### Name Read-only and shows the autodiscovered name which is the "from" device Network ID *to* the "to" device Network ID plus the Highlight unique identifier for the "from" device. #### Description Auto-generated using the "from" location - To - the "to" location. This cannot be changed in this dialog and appears throughout Highlight instead of the name. #### Enable By default, all four options are checked: * **Collect data** — Uncheck to turn off polling, which keeps the tunnel in the system and can appear in Highlight statistical reports, but stops data being collected from the device so no alerts will be raised. Used for displaying history of an old tunnel, for example. * **Show data** — Uncheck to turn off display of the tunnel in the UI and in any Highlight statistical reports, although data can still be collected. If this is unchecked then the watch will not appear in the tree search, only the admin search. * **Send alerts** — Uncheck to turn off alerting for the tunnel. Data will continue to affect heat tiles (when thresholds are crossed) but no alerts will be generated. Used for testing and demonstration, for example. * **Generate statistical reports** — Uncheck to turn off gathering of statistics for Network Reporting although data will still be collected. {% hint style="info" %} This option may not be available for all users. {% endhint %} #### FROM / TO **Location** — where the device is in Highlight **Device** — a link to the device description (if available) otherwise the name #### Product Type Read-only text set to Tunnel and appears on watch status cards. #### Reference Optional and can contain a maximum of 50 characters. May be useful for customer specific information, see the [Inherited Reference ](/admin/admin-page/watch-controller-based.md#inherited-reference)section for more details. One save stores details for all tabs. {% hint style="warning" %} If the parent device has been deleted on the external network, a red warning bar is shown reading "Parent device no longer exists." See [Discontinued items](https://help.highlight.net/admin/admin-general-details/discontinued). {% endhint %} #### Discontinued tunnels See [Discontinued items](/admin/admin-general-details/discontinued.md). Discontinued tunnels are labelled in the following ways: * The tunnel row is faded red with a warning triangle under Status * A red bar is shown on the Edit Tunnel panel * A red bar shows across the top of the tunnel Details page ### Performance This tab is visible on any tunnel. If Tunnels with perf tests has been selected on the parent controller then Highlight automatically discovers and creates tunnels and any performance tests as subwatches of their parent tunnel. If the controller option is changed to None after tunnels and performance tests have been discovered, these will continue to work and can be manually disabled if needed. No new tunnels or tests will be discovered. If there are no tests or the option is to Tunnels, you will see the message "No performance tests have been discovered. Please check performance test autodiscovery is enabled on the parent controller." #### Type Shows the performance test icon and the test type. #### Status Enabled or Disabled. Disabling a test means: * no data is collected for the test * alerts cannot be sent nor colours changed (green to amber for example) * the watch status card disappears for the test * the performance chart (on the details page) disappears for the test #### Details **Name** — Read-only and comprised of \[Source interface] \[Source device description (if available, otherwise the device name)] to \[Target interface] \[Target device description (if available, otherwise the device name)] **Discovered** — Read-only and shows the date of autodiscovery of the test. #### Alerting thresholds The default setting for these values are set on a folder, inherited by all subfolders and used on the initial creation of tests only. Contact us to change defaults. Highlight compares the value reported by the external network to the threshold set here to determine if the fuel gauge should be incremented or decremented. Delay, packet loss and score impact Health and 100% packet loss impacts Stability. Read more about the Highlight Alerting Mechanism. **Delay** — Also known as latency or round trip delay, test results are compared to this threshold. **Jitter** — Value reported by the external network is compared to this jitter threshold to colour the chart on the Details page but Highlight does not alert on jitter. **Pkt loss** — Packet loss is expressed as a percentage of all packets sent and compared to this threshold. **Score** — If available for the test type, the Mean Opinion Score (MOS) on the scale of 1-5 with 5 indicating excellent quality and compared to this threshold. Otherwise, if not available, this field is disabled. #### Discontinued tests See [Discontinued items](/admin/admin-general-details/discontinued.md). ### Containers See [containers](/admin/admin-page/watch-containers.md). --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.highlight.net/admin/admin-page/tunnel.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.