> 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/watch-snmp.md). # Watch SNMP DRAFT ## Overview This page shows how to edit watch detail or change watch options, including Autodiscovery. To edit a watch, go to the Admin listing and click on the watch entry. {% hint style="info" %} Many of the changes made in this dialog are recorded in the [Highlight Audit log](/reporting/audit-log.md). {% endhint %} One save stores details for all tabs. ## Visibility Shown only if you are a service provider. It determines if the watch will be visible to all users, or just to service provider internal staff. There are two options: * **Customer:** this is the default. Anyone can view the watch, and those with permission "edit watch" can edit/delete it * **Internal:** customers cannot view, edit or delete this watch as it is only seen by service providers Visibility selection is available from any of the Edit watch tabs. Subwatches by default adopt the visibility of the parent, but a discovered watch has its own visibility selection. For example, a customer-visible watch can have some of its QoS classes set as Internal to hide them from the customer. ## Main ### Enable *Edit Watch Main Tab Section 1* By default, all four options are checked. * **Collect data:** turns off polling, which keeps the watch 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 watch, for example. Previously known as Polling. * **Show data:** turns off display of the watch 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. Used for discovered but unused VLANs for example. Previously known as Reporting. * **Send alerts:** turns off alerting for the bearer watch and any discovered elements plus performance tests. Data will continue to affect heat tiles (when thresholds are crossed) but no alerts will be generated. Used for testing and demonstration watches, for example. Previously known as Alerting. * **Generate statistical reports:** turns off gathering of statistics for Network Reporting although data will still be collected. Note: this option may not be available for all users. Previously known as Statistics. ### Name & description * **Name:** a required field which uniquely identifies the watch and must not contain spaces. For autodiscovered watches like Classes, WAPs, and VLANs this field cannot be changed. * **Description:** optional and displayed in Highlight in place of the watch name. * **Watch Type:** entered on creation and cannot be changed but is overwritten in the UI by the Product Type if completed. * **Product Type:** optional text field which is limited to 20 characters and enables service providers to display the service name for a watch rather than the Highlight default name, for example FTTC instead of ADSL. ### Reference * **Reference:** optional and may be useful for customer specific information. * **Sensitivity:** optional and if setup, you can choose a different alerting sensitivity for each bearer or its discovered watches. Read more about [alerting sensitivity](broken://pages/35f3d2f2e578e771bab122c5a91f92ebd02120df). * **Expiry:** shows created and expiry dates which is a service provider specific field and not generally used. * **Availability SLA:** shown for bearers only. An optional percentage field, used in Reporting to compare actual availability with this SLA. Enter a number between 0 and 100 with up to 3 decimal places, such as 99.999. If SLA Now is disabled on the Features tab of a parent folder, then this field will not be available to edit. ### Bandwidths Both bandwidth fields are required. Start typing and select a bandwidth from the displayed list. Alternatively enter any whole number with one of the following units: * b/B: bits per second * k/K: kilobits per second * m/M: megabits per second * g/G: gigabits per second * t/T: terabits per second On asymmetric lines, bandwidth fields are labelled as Downstream and Upstream. {% hint style="info" %} If these fields are greyed out, it is because Autodiscovery of bandwidth is set, which would have to be disabled from the Features tab before speeds can be changed. {% endhint %} *Refer to the* [*Create Watch*](#create-watch) *page for information on setting bandwidths.* ## Main tab — lower sections Main tab lower sections refers to sections 5, 6, and 7. ### Polling If the watch is to be polled from a poller other than the default, use the poller drop-down to select the required agent or agent group. Any additional poller agents must previously have been assigned to the folder using [Agent Selection](broken://pages/ebe825d5dde7e36d3d767f908e7375b1e1cc7e0d) from the Edit Folder Main tab. If you select the default poller or poller group, then if the default is changed at some point in the future, this watch will use the new default poller or poller group. Poll Frequency shows the polling interval for this watch in minutes, and seconds if applicable, and is useful to determine the time from when an issue starts until alerts are sent and watches/tiles change colour. Refer to the [sensitivity page](broken://pages/35f3d2f2e578e771bab122c5a91f92ebd02120df) for more details. ### SNMP credentials If changing the SNMP type employed, again confirm access to the watch still works. **SNMP v2c** * **Community:** a required field which can contain any characters except spaces. If your device only supports SNMPv1, select SNMPv2c and Highlight will fall back to using the older protocol automatically. **SNMP v3** * **Username:** this is required, must be between 8 and 32 characters and may not contain `,` `\` `'` and `"` * **Auth Protocol:** SHA1 (default) or MD5 * **Auth Key:** this is required, must be between 8 and 32 characters and may not contain `,` `\` `'` and `"` * **Priv Protocol:** DES (default) or AES 128 * **Priv Key:** this is required, must be between 8 and 32 characters and may not contain `,` `\` `'` and `"` ### Interface * **Device:** a required field, the device IP address or [hostname](broken://pages/40420ae770a9a84b35163c1072a866b2cf574562) which must be reachable from Highlight. If changing it, click the button and confirm the hostname displayed is as expected. Infrequently, Highlight may not register, or the device may not provide, configuration changes. In these scenarios, a revalidation may resolve an issue. The reason for revalidation is required and monitored by Highlight Support to look for patterns. {% hint style="warning" %} Regular revalidation is not recommended because it can take up to one hour and, during this time, no data is collected so charts related to the device may have gaps. {% endhint %} *Edit Watch Revalidate Warning and Reason* * **Interface:** the currently monitored interface is shown. To change it, select the required interface. Changing the interface does not affect historical statistics. After changing device-specific information, for example IP address, run a technical test to confirm the monitored interface is correct. * **Phys Interface:** if the monitored interface is virtual, such as a sub-interface, run a technical test and select a physical interface. This watch will then report on any line errors in the Highlight charts and reports. * **Site link:** check this box to set the watch as a bearer contributing to the [Site Availability](broken://pages/c8cca3d3481afb4a18deb6f36fbfc0d650602417) report statistics and to enable [alert suppression](broken://pages/925a9e2e877ea530d106e74b1ff6891fcd7c4aa6) for this location. * **Hybrid WAN:** check this box to set the watch as a member of a [Hybrid WAN](broken://pages/4458e3c1f74962e832eab6d5e2615ca1e426c81a) group. Up to three watches per location can have this option. * **Dormant interface:** unchecked by default. Check this box to set the watch as dormant. Dormant interfaces only send stability alerts if the device is uncontactable or Highlight has detected that the underlying cellular service is unavailable. * **Tech test available to customers:** checked by default, this option allows any user to run a technical test from the [Technical information page](broken://pages/54aaa01d954ed8f15078a976f775c3e56300b7a7#watch_options). Highlight guidance is only to uncheck this option if the device being monitored is shared with other customers. ### Delete watch Only available on edit and deletes the watch. If possible the watch is moved to a "holding area", data will not be collected and it will not appear in any Highlight pages. The watch and its collected data will be completely deleted after approximately one month. If you accidentally delete a watch, [contact us](/getting-started/contact-us.md) within 30 days to recover it. Find out more about [recovering watches](/troubleshooting/recovery-of-deleted-items.md). ## Performance *Refer to the* [*Create/Edit a Performance Test*](broken://pages/c4bab7c56337a2f604a1c1865962e34a374ef10f) *page.* ## Applications Collection disabled shows a red toggle; collection enabled shows a green toggle, for the collection of NBAR or Flow application data on the selected watch. By default, Collect NBAR is selected. With either NBAR or Flow enabled, the traffic analysis results can be found at the bottom of the Details page. ### Collect NBAR NBAR must be enabled on the device, on the interface from which you wish to collect application data. See the [NBAR setup page.](/device-setup/nbar-device-configuration.md) * **Interface:** this will auto-populate with the interface on the Main tab. To change it, test the device — another window will open with a list of interfaces, with those supporting NBAR marked. Select the desired interface. * **Swap I/O:** Highlight assumes that the interface selected for NBAR is the same as the one on the Main tab, so the Traffic Analysis OUT/IN volumes correlate with the Traffic Load charts on the Details page for this watch. If NBAR is set to collect from a different interface, perhaps the LAN interface, then the "Swap I/O" box may need to be checked to align the OUT and IN NBAR charts with the Traffic Load charts. ### Collect Flow To use Flow you will need to have a Highlight Flow collector installed on your network, and then enable Flow Export on each device that will be sending data to this collector. Flow must be enabled on the device, on the interface from which you wish to collect application data. See the [Flow setup page](/device-setup/appvis-tm-and-flow-configuration.md). * **Interface:** either test the device — another window will open with a list of interfaces; select the desired interface — or list all flows from every source address received by the Flow collector and select the desired flow. See "Unallocated flows" below for more detail. * **Swap I/O:** Highlight assumes that the interface selected for Flow is the same as the one on the Main tab, so the Traffic Analysis OUT/IN volumes correlate with the Traffic Load charts on the Details page for this watch. If Flow is set to collect from a different interface, then the "Swap I/O" box may need to be checked. * **Flow exporter IP:** if you've selected an interface from the flow list, this field is auto-populated. Alternatively, leave this field blank to use the device IP as shown on the Main tab, or enter the source IP of the Flow packet as configured on the router, for example from the configuration command `ip flow-export source ....`. If required, check the output from the router command `show ip flow export`. ### Unallocated flows Clicking the unallocated flows option opens a dialog with 4 columns. Sort the list by clicking on a column header, which will then show ascending or descending sort order. Hold down shift on your keyboard to select multiple columns; the first column clicked is the primary sort order. The default sort order is by interface ID only. * **Interface ID:** the interface ID number contained in flow records from this source IP flow packet. * **Source IP:** the source IP address of flow packets being received on this agent. * **Agent:** the name of the agent giving details of the flow packets it receives. * Clicking a row selects it, closes the dialog, and returns to the Applications tab; the interface ID and Flow exporter IP address will be auto-populated based on your choice. Filter the list by entering an interface ID number, source IP, or agent name in the search box. By default the results are narrowed to the device IP shown on the Main tab for the watch; delete this and enter a partial interface number, source IP or agent name instead. * **Exact search:** check to force an exact match rather than a partial search. * **Show allocated flows:** check to show flows already in use. * **Page X of Y:** the dialog shows 100 rows per page; use these buttons to move to other pages if needed. The buttons will be greyed out if there is only one page of flows. ## Features This tab is divided into two sections: Autodiscovery and Enable. ### Autodiscovery These features can be enabled but will only be discovered if present on the device. * **Bandwidth:** Highlight supports rate-adaptive ADSL, which is ADSL that has not been fixed at a set bandwidth but instead determines the fastest reliable rate that can be run over a particular link. Highlight is able to interrogate the device and change the Highlight bandwidth to reflect the actual bandwidth in and out. In addition, for non-ADSL QoS environments, Highlight will discover speeds defined by a 'shape' or 'police' statement used in a service policy. Find out more about [Bandwidth Autodiscovery.](/functionality/bandwidth-autodiscovery.md) * **Classes:** on an MPLS network Highlight can detect Classes of Service running on a bearer and create a separate Link Health for each one. Generic Class names to be discovered will need to have been predefined in Highlight. Find out more about [Class Autodiscovery](/functionality/class-autodiscovery.md). * **Multilink elements:** if (and only if) the link being monitored is logical and built from multiple physical links, then Highlight can automatically discover these links and monitor them. This is valuable for checking the traffic is balanced and the links active. Multilink Discovery works for the WAN with links bonded using PPP, and for the LAN with links bonded using Link Aggregation (LACP) or Port Aggregation (PAgP). Find out more about [Multilink Autodiscovery](/functionality/multilink-autodiscovery.md). * **VLANs:** Highlight has the ability to detect VLANs (sub-interfaces) defined on a physical interface. Find out more about [VLAN Autodiscovery.](/functionality/vlan-autodiscovery.md) * **Applications (AppVis):** to enable this feature, first test the watch from the Main tab and reselect an interface. The checkbox will then be enabled. Check it to automatically discover all applications associated with this watch. Find out more about [AppVis](/device-setup/appvis-tm-and-flow-configuration.md). Contact [Highlight Support](/getting-started/contact-us.md) to enable discover applications on a folder. ### Enable The enable options are disabled (greyed out) until a technical test on the Main tab confirms the capabilities of the device. Each option can be enabled (green toggle) or disabled (red toggle). #### Switch port monitoring Highlight can start monitoring every port on the device if the device is recognised by Highlight as a switch. You can nominate individual ports as critical, and ongoing issues on these ports will affect the heat tile colour and generate alerts through the Highlight alerting system. {% hint style="info" %} Please wait up to 30 minutes after saving to select critical ports. {% endhint %} Find out more about [setting up switches](/details/other-watch-types/switches.md) and [critical ports](/details/other-watch-types/switches.md#critical-ports) in Highlight. #### Broadband Clarity If your routers provide broadband speed data via SNMP (using published standards), enabling this feature means Highlight collects, then stores, processes and acts on that data: * the graphing engine generates real time and historic graphs of the speed over time * the alerting engine sends alerts if speed drops below a custom threshold * the reporting engine collates and summarises the data for easy export Once saved, you can alter alerting thresholds or keep the default values. Find out more about [the broadband bandwidth chart on the Details page](/details/details-pages/broadband-bandwidth.md) and [alerting thresholds](/admin/admin-general-details/alerting-thresholds.md). #### Cellular Clarity If Highlight supports collecting cellular data for your router/SD-WAN device, enabling this feature means Highlight collects, then stores, processes and acts on that data: * the graphing engine generates real time and historic graphs of the signal strength over time * the alerting engine sends alerts if signal strength drops below a custom threshold * the reporting engine collates and summarises the data for easy export Once saved, you can alter alerting thresholds or keep the default values. #### Visibility This option (only shown if you are a service provider) determines if the [cellular signal strength chart on the Details page](/details/details-pages/cellular-clarity.md) will be visible to all users, or just to service provider internal staff. There are two options: * **Customer:** anyone can see the chart * **Internal:** the chart is only visible internally (for the service provider) {% hint style="info" %} If the watch is Internal, it's not possible to set the Cellular Clarity feature to Customer. {% endhint %} Find out more about [the cellular signal strength chart on the Details page](/details/details-pages/cellular-clarity.md) and [alerting thresholds](/admin/admin-general-details/alerting-thresholds.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/watch-snmp.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.