Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
...
| Source | Event Type | Description of Payload | Comments | ||||
|---|---|---|---|---|---|---|---|
| UI | requestSummary | No (no payload) | Client requesting the server to send topology summary data. Invoked when the summary pane is brought into view. | ||||
| Server | showSummary | High level summary properties: total number of devices, links, hosts, ... | The summary data is displayed in a "fly-in" pane in the top right of the view. Note that the server will continue to send these events to keep the summary data up-to-date. | ||||
| UI | cancelSummary | (no payload) | Client requesting the server to stop sending summary data. Invoked when the summary pane is hidden. | ||||
| Server | addInstance | Instance ID, IP address, online status, ... | An ONOS instance to be added to the model. | ||||
| Server | addDevice | Device ID, type, online status, mastership, labels, properties, ... | A device (switch, roadm, ...) to be added to the model. | ||||
| Server | addHost | Host ID, type, connection point, labels, properties, ... | A host (endstation, bgpSpeaker, router, ...) to be added to the model. | ||||
| Server | addLink | Link ID, type, source ID/port, destination ID/port, ... | A link (direct, optical, tunnel, ...) to be added to the model. | ||||
| Server | updateInstance | (same as addInstance) | An ONOS instance with updated state. | ||||
| Server | updateDevice | (same as addDevice) | A device with updated state. | ||||
| Server | updateHost | (same as addHost) | A host with updated state. | ||||
| Server | updateLink | (same as addLink) | A link with updated state. | ||||
| Server | removeInstance | (same as addInstance)**(1) | An ONOS instance to be removed from the model. | ||||
| Server | removeDevice | (same as addDevice)**(1) | A device to be removed from the model. | ||||
| Server | removeHost | (same as addHost)**(1) | A host to be removed from the model. | ||||
| Server | removeLink | (same as addLink)**(1) | A link to be removed from the model.. | ||||
| UI | updateMeta | item ID, item class (device, host, ...) memento data | Client requesting the storage of data associated with a specific node (a memento), to be returned in the payload of events pertaining to that node. This is a mechanism whereby the location of the node (as dragged and pinned by the user) is persisted server-side. | ||||
| UI | requestDetails | item ID, item class (device, host, ...) | Client requesting details for the specified item. Sent in response to the user selecting a node on the map. | ||||
| Server | showDetails | item ID, item type (switch, roadm, endstation, ...) and list of properties | Server response to requestDetails. | ||||
| UI | requestTraffic | list of IDs for selected items, ID of hovered-over item | Client requesting traffic data to display on the topology. Invoked when the user requests traffic data, and starts exploring the data by hovering the mouse over nodes. | ||||
| Server | showTraffic | list of paths (sets of link IDs) and labels to apply to those links, as well as the styling classes to apply to those paths | Server response to requestTraffic. Note that the server will continue to send these events to keep updating the display. | ||||
| UI | cancelTraffic | (no payload) | Client requesting the server to stop sending traffic updates. Invoked by user gesture (typically the ESC key). | ||||
| UI | equalizeMasters | (no payload) | Client requesting server to rebalance mastership of devices across the cluster. Invoked by a keystroke: 'E'. | ||||
| UI | addHostIntent | IDs of two selected hosts | Client requesting server to install a host-to-host intent. Invoked from action button on multi-select display pane. | ||||
| UI | addMultiSourceIntent | IDs of selected nodes (multi source, single destination) | Client requesting server to install multiple intents. Invoked from action button on multi-select display pane. | ||||
| UI | requestDeviceLinkFlows | IDs of selected nodes, ID of hovered-over node | Client requesting traffic information for showing flow data of selected nodes. | ||||
| UI | requestAllTraffic | (no payload) | Client requesting traffic information for whole network. |
**(1) Technically, only the ID field is required, but this simplifies the code on the server side.
...