Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Overlays bundled with out-of-the-box ONOS are listed here. Follow the links for more information:

...

IconKeyFunctionDefault StateComments
IShow / hide ONOS cluster instance panelshowThe instance panel is shown by default.
OShow / hide ONOS summary panelshowThe summary panel is shown by default.
DDisable / enable details panelenable

The details panel is enabled by default, and is displayed when one or more topology elements are selected. Disabling this panel keeps it hidden even when something is selected.

     
HToggle host visibilityhideShows or hides the hosts (and their links). Hosts are hidden by default.
MToggle offline visibilityshowDevices that are offline (but that ONOS still knows about) are shown by default. This toggle will hide offline devices (and any hosts/links connected to them).
PToggle port highlightingonPort highlighting is when hovering the mouse over a link will highlight the link and label the ends with the appropriate port numbers. This feature can be switched off with this toggle.
BToggle background geo maphideThe background map (hidden by default) can be shown or hidden with this toggle.
Image AddedGSelect background geo mapn/aOpens a dialog box which allows selection of a geographic region from a pre-defined set.
SToggle sprite layerhideThe sprite layer (static shapes/text injected into the view) can be shown or hidden with this toggle.

...

IconKeyDescriptionDefault StateComments
ZToggle oblique view (experimental)regular viewCreates a split-level visualization of the packet and optical layers of the network. Note that this feature is experimental and may be slightly buggy.
NCycle node layersshow all layersCycles between three view modes: show all layers, show packet layer, show optical layer.
LCycle device labelshide labelsCycles between three modes of showing labels on devices: hide labels, show friendly labels, show device ID.
RReset pan / zoom-This function restores the pan and zoom levels to default settings.
     
EEqualize mastership roles-Sends a command to ONOS to invoke a mastership equalization request.
     
 No overlay De-activates the current overlay.
 Traffic overlay(tick)Provides traffic monitoring functions.
...
 
...
 <Topology Overlays installed by ONOS Apps will appear here>

...

The four action buttons (with white backgrounds) are navigation buttons detailed below. The two action buttons on the right are added to the panel if the Traffic Overlay is currently active. See the Traffic Overlay page for details.

Navigation Actions
Navigate to the Device View for the selected device
Navigate to the Flow View for the selected device
Navigate to the Port View for the selected Device
Navigate to the Group View for the selected Device

...

The background map provides a geographic reference for the topology. The default map is the Continental US. The map layer's visibility can be toggled on and off with the 'B' (for background) key.
See Providing Alternate Maps for the Topology View for additional details.

The scale of background map can be changed on demand. To do that, simply append ?mapscale=<real-number> at the end of the URL. For example,

Panel

http://localhost:8181/onos/ui/index.html#/topo?mapscale=1.5

Custom Sprites

The Topology Sprite Layer mechanism allows custom "background" elements to be displayed (above the background map, but below the topology elements). This could be used, for example, to inject labeled "subnet clouds", or the plan of an office building or campus into the topology view. Typically, one would want to hide the background map layer (press 'B') and show the sprite layer (press 'S') instead.

...