Topology
The Topology application enables you to view the topology of all managed devices in the network, view information about a specific device and perform certain actions on those devices (e.g., edit a device, telnet to a device, reboot a device). You can view devices in a topology map in various ways. For example, you can view managed devices in the Physical Layer Topology, highlight specific devices or links, and re-arrange devices in a map and save that new map view. The figure below provides an overview of some of the functions that can be performed in the Topology application. Specific functions available when working with maps are detailed below.
Devices must first be added to the Device Catalog and licensed before they are displayed in Topology. See the Device Catalog online help for more information.
![image-20240307-020209.png](../__attachments/796164097/image-20240307-020209.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
The Physical Layer Topology (shown above) is automatically created by OmniVista Cirrus and displays all managed network devices. Unmanaged devices may also appear in the topology if they were detected in the LLDP info of a managed device within 30 minutes or less.
Topology Maps
The Topology application not only provides an overview of the network, it can also be used to perform many functions that you can use to view and configure network devices. These functions are detailed in the following sections:
Working with Topology Maps
This section details the Topology Map view. In this view, you can view device and link information, customize the map background image, change the map layout, and perform device actions.
![image-20240321-221338.png](../__attachments/796164097/image-20240321-221338.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
Viewing Map Information
Topology Maps provide a visual representation of the network. The administrative status of the device or link is indicated by color, and detailed information can be displayed by clicking on a device or link.
You can change the Topology Map view, layout, background, and import or export Map information using the following icons located at the top-right corner of the screen.
![image-20240311-215620.png](../__attachments/796164097/image-20240311-215620.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
To save a Topology Map view, you can backup and/or export the Map layout to a text (.txt) or .svg file.
Devices
Each device type is displayed with an icon. Hover the mouse over a device to display basic information. Click on a device to open the Device Detail panel and view detailed information about the device.
![image-20240308-000257.png](../__attachments/796164097/image-20240308-000257.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
The status of a device is indicated by the following color coding of the small circle in the upper-right corner of the device icon and/or by the icon itself.
Green - Device connectivity is up and there are no trap notifications.
Orange - Device connectivity is unknown or warning/major trap notifications received from the device.
Red - Device connectivity is up with critical trap notifications received.
Blue - Device connectivity is up with minor or informational trap notifications.
No Circle - No management connectivity information or trap notifications received from the device.
Solid-Grey Device Icon - Device connectivity is down with no trap notifications.
Generic Icon - The device is unmanaged by OmniVista.
You can hide unmanaged devices on the Topology Map by clicking on the Show/hide Unmanaged Device icon in the top-right corner of the screen. Click the icon again to display unmanaged devices.
Note that the trap event notification status is only displayed if traps have been configured on the device.
Links
Links between devices are displayed as a single line, whether there is a single link or multiple links.
Green - Link is up. If there are multiple links, Green indicates all of the links are up.
Red - Link is down. If there are multiple links, Red indicates all of the links are down.
Aggregate links are displayed as a solid line with a black circle.
![image-20240311-184651.png](../__attachments/796164097/image-20240311-184651.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
AP Mesh networks are displayed with a dashed line between AP Wi-Fi icons that are part of the Mesh network configuration.
![image-20240311-185559.png](../__attachments/796164097/image-20240311-185559.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
A loop next to a switch indicates a loopback port link on the switch.
![image-20240311-192426.png](../__attachments/796164097/image-20240311-192426.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
You can hide loopback links on the Topology Map by clicking on the Show/hide Loop Link icon in the top-right corner of the screen. Click the icon again to display the loopback links.
Displaying Link Information
To display link information, move the mouse over the link until the pointer turns into a finger. Link information will be displayed as shown below. Information for all links is displayed.
![image-20240307-201642.png](../__attachments/796164097/image-20240307-201642.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
You can also click on a link to display detailed link information. Move the mouse over the link until the pointer turns into a finger and click. The link is highlighted and link information is displayed in the Link Detail panel as shown below.
![image-20240307-201806.png](../__attachments/796164097/image-20240307-201806.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
Customizing Maps
You can change the Topology Map layout and background image.
Changing the Map Layout
To change the basic layout of the Topology Map, click on the Horizontal, Vertical, or Circle icon in the top-right corner of the screen.
Horizontal - Displays devices in a horizontal pattern.
Vertical - Displays devices in a vertical pattern.
Circle - Displays devices in a circular pattern.
You can also change the layout of a Topology Map using any of the following methods:
Select a device and drag it to a new location on the Map. Press Shift and click to select multiple devices.
Zoom in or out on a Map using the mouse scroll wheel.
Move an entire Map on the screen by clicking anywhere outside the map and dragging the Map to a new location on the screen.
Changing the Background Image
You can change the Topology Map background image by clicking on the Change Background icon in the top-right corner of the screen. When you click on this icon, you are prompted to locate and upload an image file that you want to set as the background image for your Topology Map.
After the selected image is uploaded, click on the checkmark in the top corner of the Change Background icon to update the background of the Topology Map. The checkmark will then disappear from the icon.
![image-20240314-233858.png](../__attachments/796164097/image-20240314-233858.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
To remove a background image, click on the “x” in the bottom corner of the Change Background icon.
Backing Up the Topology Map
To create a backup of your Topology Map layout, click on the Create a Backup icon located next to the Site name in the top-left of the screen. A Back Up Topology window will open. Enter a name to assign to the backup file, then click on Save.
![image-20240312-000455.png](../__attachments/796164097/image-20240312-000455.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
![image-20240311-235854.png](../__attachments/796164097/image-20240311-235854.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
The Topology Map backup filename you created now appears next to the backup/restore icons.
![image-20240312-000201.png](../__attachments/796164097/image-20240312-000201.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
If you make any changes to the Topology Map layout after the backup is done, a check-mark appears next to the backup filename. Click on the checkmark to automatically update the existing backup file with the changes you made to the Topology Map.
![image-20240312-000950.png](../__attachments/796164097/image-20240312-000950.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
The Update Backup Positions option is particularly useful for updating a backup without having to create a another backup file. The existing backup file is updated with the latest changes.
To restore a Topology Map backup, click on the Restore a Backup icon, then select the backup file that you want to restore from the drop-down menu.
![image-20240312-002223.png](../__attachments/796164097/image-20240312-002223.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
When you restore a backup of a Topology Map, the background image does not change. For example, if you uploaded a background image for your Topology Map, then did a backup and a restore, the background image remains in place.
Importing/Exporting the Topology Map Layout
In addition to the backup/restore functionality, you can also import and export a Topology Map.
Importing a Topology Map
To import a Topology Map, click on the Import Device Layout icon in the top-right corner of the screen. You are prompted to locate and upload a Text File. The layout contained in the text file is displayed on the screen.
Exporting a Topology Map
You can export a Topology Map to a Text File or an SVG Document. To export the Map, click on the Export Data Options icon in the top-right corner of the screen and select “txt” or “svg” from the drop-down menu. You are then prompted to select the location where you want to download the exported file. Select the location on your computer, then click Save.
Working with Network Devices
You can view detailed information about a device or perform certain actions on a device by clicking on the device in the map. Actions can be performed on a single device or multiple devices. After selecting a device(s), you can perform one of the actions displayed in the Actions area. Note that the actions available depend on the device type(s) selected and whether or not you select a single device or multiple devices.
Viewing Device Information
Use the following methods for displaying device information on the Topology Map:
Hover the mouse over a device in the Map to display basic information.
Click on a device in the Map to display detailed device information in the Detail Panel on the right side of the screen.
Click on a device in the Map, then on the Show/Hide Client icon to display clients that are connected to the device.
Displaying Basic Device Information
When you hover the mouse over a device in the Topology Map, the following window displays above the device showing basic information for the device:
![image-20240313-204302.png](../__attachments/796164097/image-20240313-204302.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
Serial Number - The serial number of the device.
MAC Address - The MAC address of the device.
Managed - Is the device managed by OmniVista Cirrus (True or False).
Changes (Switch Only) - Are changes saved (Certified or Unsaved).
Model Name - The model name for the device.
Floor - The floor where the device is located within the Site building.
Building - The building where the device is located within the Site.
Version - The version of software running on the device.
Displaying Detailed Device Information
When you click on a device icon in the Topology Map, the following Device Detail window displays on the right-hand side of the screen showing additional device information:
![image-20240313-203921.png](../__attachments/796164097/image-20240313-203921.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
MAC Address - The MAC address of the device.
IP Address - The IP address of the device.
Current Software Version - The version of software currently running on the device.
Serial Number - The serial number of the device.
Building - The building where the device is located within the Site.
Version - The version of software running on the device.
Description - A description of the device received when the device was added to the Device Catalog.
Trap Notification List - A list of traps received from the device during the specified time range. Click the refresh icon to update the display from the OmniVista Cirrus database.
Displaying Clients Connected to a Device
By default, device clients do not show on the Topology Map. If clients are connected to a device, the number of connected clients is displayed at the end of the Friendly Name in brackets. For example, AP 172.25.201.114 [1) has one connected client.
![image-20240313-234614.png](../__attachments/796164097/image-20240313-234614.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
To display the connected clients, select the device and click on the Show/Hide Client icon located in the top-right corner of the screen.
![image-20240313-233306.png](../__attachments/796164097/image-20240313-233306.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
The connected client(s) appear on the Map.
![image-20240313-235228.png](../__attachments/796164097/image-20240313-235228.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
Note the following about displaying connected clients:
A wired client displays with a solid link line between the client and the device.
A wireless client displays with a dashed link line between the client and the device.
A phone icon is displayed for clients. However, if the client device type is a computer (including tablets) a computer icon is displayed.
You can also find a client by entering the client MAC address in the search box at the top-left corner of the screen. If the client is found, the device to which the client is connected is highlighted and the client device is displayed.
To view additional information about the client, click on the connected client icon. The Client Session History screen for the client will open in a new tab.
Performing Device Actions
You can perform device operations by selecting a device(s) in the Topology Map, then clicking on Actions to select one of the operations from the drop-down menu. Note that the Actions button does not appear until you select a device.
![image-20240314-010304.png](../__attachments/796164097/image-20240314-010304.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
Refer to the Performing Device Operations online help for the Device Catalog for information about the options on the Action drop-down menu. However, the Set as root action is specific to the Topology application.
Not all operations are supported on all devices., and some operations can only be performed on a single device, not multiple devices. If an operation is not supported for the selected device(s), it will be grayed out or not included in the list.
Setting the Root of the Topology Map
The root of the Topology Map is usually the upstream device; the device that provides Internet access. To change the root, click on the device that you want to become the root, then click on Actions and select the Set as root option. The Topology Map will automatically re-arrange devices around the new Topology root device.
Polling Devices
One of the device operations you can perform is polling devices to update device/link information. Click on the device you want to poll, then click on the Poll icon and select the poll
![image-20240314-222125.png](../__attachments/796164097/image-20240314-222125.png?inst-v=6ef7d778-2e59-416c-b000-0656d7e2d419)
Poll Links - Causes an immediate poll of any links on the device(s).
Poll Device - Causes an immediate poll of the selected device(s).
All Poll - Causes an immediate poll of the device(s) and any links on the device(s).