1 ODL-SDNi Developer Guide
2 ========================
7 This project aims at enabling inter-SDN controller communication by
8 developing SDNi (Software Defined Networking interface) as an
9 application (ODL-SDNi App).
14 - SDNi Aggregator: Northbound SDNi plugin acts as an aggregator for
15 collecting network information such as topology, stats, host etc.
16 This plugin can be evolving as per needs of network data requested to
17 be shared across federated SDN controllers.
19 - SDNi API: API view autogenerated and accessible through RESTCONF to
20 fetch the aggregated information from the northbound plugin – SDNi
21 aggregator.The RESTCONF protocol operates on a conceptual datastore
22 defined with the YANG data modeling language.
24 - SDNi Wrapper: SDNi BGP Wrapper will be responsible for the sharing
25 and collecting information to/from federated controllers.
27 - SDNi UI:This component displays the SDN controllers connected to each
33 - SDNiAggregator connects with the Base Network Service Functions of
34 the controller. Currently it is querying network topology through
35 MD-SAL for creating SDNi network capability.
37 - SDNiAggregator is customized to retrieve the host controller’s
38 details, while running the controller in cluster mode. Rest of the
39 northbound APIs of controller will retrieve the entire topology
40 information of all the connected controllers.
42 - The SDNiAggregator creates a topology structure.This structure is
43 populated by the various network funtions.
48 Topology and QoS data is fetched from SDNiAggregator through RESTCONF.
50 `http://${controlleripaddress}:8181/apidoc/explorer/index.html <http://${controlleripaddress}:8181/apidoc/explorer/index.html>`__
52 `http://${ipaddress}:8181/restconf/operations/opendaylight-sdni-topology-msg:getAllPeerTopology <http://${ipaddress}:8181/restconf/operations/opendaylight-sdni-topology-msg:getAllPeerTopology>`__
54 **Peer Topology Data:** Controller IP Address, Links, Nodes, Link
55 Bandwidths, MAC Address of switches, Latency, Host IP address.
57 `http://${ipaddress}:8181/restconf/operations/opendaylight-sdni-qos-msg:get-all-node-connectors-statistics <http://${ipaddress}:8181/restconf/operations/opendaylight-sdni-qos-msg:get-all-node-connectors-statistics>`__
59 **QOS Data:** Node, Port, Transmit Packets, Receive Packets, Collision
60 Count, Receive Frame Error, Receive Over Run Error, Receive Crc Error
62 `http://${ipaddress}:8181/restconf/operations/opendaylight-sdni-qos-msg:get-all-peer-node-connectors-statistics <http://${ipaddress}:8181/restconf/operations/opendaylight-sdni-qos-msg:get-all-peer-node-connectors-statistics>`__
64 **Peer QOS Data:** Node, Port, Transmit Packets, Receive Packets,
65 Collision Count, Receive Frame Error, Receive Over Run Error, Receive
71 .. figure:: ./images/SDNiWrapper.png
76 - SDNiWrapper is an extension of ODL-BGPCEP where SDNi topology data is
77 exchange along with the Update NLRI message. Refer
78 http://tools.ietf.org/html/draft-ietf-idr-ls-distribution-04 for more
81 - SDNiWrapper gets the controller’s network capabilities through SDNi
82 Aggregator and serialize it in Update NLRI message. This NLRI message
83 will get exchange between the clustered controllers through
84 BGP-UPDATE message. Similarly peer controller’s UPDATE message is
85 received and unpacked then format to SDNi Network capability data,
86 which will be stored for further purpose.
91 This component displays the SDN controllers connected to each other.
93 http://localhost:8181/index.html#/sdniUI/sdnController
95 API Reference Documentation
96 ---------------------------
99 `http://${controlleripaddress}:8181/apidoc/explorer/index.html <http://${controlleripaddress}:8181/apidoc/explorer/index.html>`__,
100 sign in, and expand the opendaylight-sdni panel. From there, users can
101 execute various API calls to test their SDNi deployment.