Interface Tag
  • 06 Aug 2024
  • 6 Minutes to read
  • Dark
    Light
  • PDF

Interface Tag

  • Dark
    Light
  • PDF

Article summary

Description

Interface tags allow a Netreo administrator to identify specific interfaces on managed devices. These tags allow for quick selection of interfaces for configuration and reporting purposes. Some built-in tags are available by default (see below), and allow the automatic application of certain features to devices using those tags.

Built-in Tags

The following built-in interface tags are available in Netreo:

TagDescription
Dashboard ZoomInterfaces using this tag are added to the Overview tab of the Device Dashboard for quick reference and display a summary of their performance over the previous 24-hour period.
Site TrafficInterfaces using this tag are included in the traffic flow graphs and tables on the Traffic tab of the site dashboard to which the managed device belongs. Note that the device must already be configured to export traffic flow data for the tag to work.
site-primaryInterfaces using this tag allow Netreo to display the full range of site statuses available in Netreo's Display Site Status feature.
site-secondaryInterfaces using this tag allow Netreo to display the full range of site statuses available in Netreo's Display Site Status feature.
site-backupInterfaces using this tag allow Netreo to display the full range of site statuses available in Netreo's Display Site Status feature.
site-backup-persistentInterfaces using this tag allow Netreo to display the full range of site statuses available in Netreo's Display Site Status feature.

Custom Tags

Interfaces may also be tagged with user-created custom tags. This allows you to organize your device interfaces in any way you see fit.

Custom tags that have not been in use for more than 24 hours are automatically deleted from Netreo. This prevents unused tags from cluttering selection dialogs.

Monitoring Interface Performance Using Tags

Specific interfaces on managed devices may be monitored for performance by tag using the Check Interface Status service check and selecting an interface tag as its filter. This service check is best added to managed devices through a device template, rather than adding it manually.

Manage Interface Tags on a Single Device

Interfaces on managed devices in Netreo can be tagged for use in reports and interface monitoring. See Interface Tag for more information about interface tags.

To add, remove or create new tags for interfaces on a device follow the procedure below.

  1. Log in to Netreo as a user with the Administrator or SuperAdmin access level.
  2. Navigate to the Device Dashboard of the device for which you would like to manage interface tags. (You can do this by clicking a device's name almost anywhere in Netreo.)
  3. Click the gear icon in the top right corner to switch to the Device Administration page.
  4. On the Device Administration page, select the "Instances" tab.
  5. Click the "Network" panel to expand its display. The list of currently active network interfaces is shown. Only active interfaces may have their tags managed. Any tags currently assigned to an interface show up in its TAG(S) column.
    • Quick Tip: Clicking the X in the ZOOM or TRAFFIC columns will automatically add the "Dashboard Zoom" or "Site Traffic" tags, respectively, without any further action required.
    • Likewise, clicking the checkmark will remove the "Dashboard Zoom" tag without any further action required.
  6. Click the edit icon in the TAG(S) column header to open the device's Interface Tags Administration page.
  7. In the first panel, select the interfaces that you want to manage tags for by clicking the checkbox next to the interface name.
  8. The second panel is made up of four sub-panels that allow you to manage the tags for the selected interfaces:
    • Current tag(s):
      This panel shows the tags that are currently applied to the selected interfaces. Click the x next to a tag to place it in the "Tag(s) to remove:" panel (see below).
    • Tag(s) to add:
      This panel shows the tags that will be applied to the selected interfaces. Begin typing to see a list of existing tags that match. If a matching tag exists, select the tag and press enter to add it to this panel. If a tag doesn't already exist, it will be created.
    • Tag(s) to remove:
      This panel shows the tags that will be removed from the selected interfaces. Populate this panel from the "Current Tag(s):" panel (see above).
    • Available tag(s):
      This panel shows the tags that have already been created in Netreo. Click a tag and press Enter to add it to the "Tag(s) to add:" panel (see above).
  9. Once you've set up what tags to add/remove, click Apply Changes. The changes will be reflected in the TAG(S) column of the selected interfaces in the top panel.
  10. You can continue to manage tags or, if you're finished, you can return to the Device Dashboard by clicking the dashboard icon in the top right of the page or simply navigate away to another page.

Manage Interface Tags on Multiple Devices

Interfaces on managed devices in Netreo can be tagged for use in reports and interface monitoring. See Interface Tags for more information about interface tags.

To add, remove, or create new tags for interfaces on multiple devices, follow the procedure below.

  1. Log in to Netreo as a user with the Administrator or SuperAdmin access level.
  2. From the main menu, select Administration >> Change Devices >> Edit/Add Tags to open the Edit/Add Interface Tags page.
  3. Using the SELECT A FUNCTION GROUP pull-down menu, select a functional group  option that contains the managed devices for which you would like to manage interface tags.
    • Select Everything to display all devices regardless of functional group.
    • Select None to display all devices not in any functional group.
  4. Once the device table is populated, you may use the Search: box as a realtime filter to narrow the available selection. The search filters on terms appearing under any of the column headers.
  5. Select the devices for which you would like to manage interface tags by clicking the checkbox to the left of the device name. Click the checkbox column header to select all devices in the table.
  6. Select the Go button.
  7. In the ENTER INTERFACE DESCRIPTION TO FILTER OR CLICK CONTINUE field, enter an interface name to filter the interface list that follows, or select the Continue button (leaving the field blank) for the full list of active interfaces. (Only active interfaces may have their tags managed.)
    • This field accepts the LIKE operator and uses the pattern-matching operation of LIKE '%$string%'. It accepts strings, numbers, and strings with special characters.
  8. From the list in the Interfaces panel, select the interfaces to manage. Multiple selection is allowed.
  9. Use the four panels below the Interfaces panel to create, add, remove, or otherwise manage tags for the selected interfaces. The panel functions are as follows:
    • Current tag(s):
      This panel shows the tags that are currently applied to the selected interfaces. Click the x next to a tag to place it in the "Tag(s) to remove:" panel (see below).
    • Tag(s) to add:
      This panel shows the tags that will be applied to the selected interfaces. Click within the box and begin typing to see a list of existing tags that match. If a matching tag exists, select the tag and press enter to add it to this panel. If a tag doesn't already exist, it will be created.
    • Tag(s) to remove:
      This panel shows the tags that will be removed from the selected interfaces. Populate this panel from the "Current Tag(s):" panel (see above).
    • Available tag(s):
      This panel shows the tags that have already been created in Netreo. Click a tag and press Enter to add it to the "Tag(s) to add:" panel (see above).
  10. Once you've selected the tags to add/remove from the selected interfaces, click the Apply Changes button.

Was this article helpful?