Merge "Update release schedule for oxygen"
[docs.git] / docs / user-guide / odl-sdni-user-guide.rst
1 .. _sdni-user-guide:
2
3 ODL-SDNi User Guide
4 ===================
5
6 Introduction
7 ------------
8
9 This user guide will help to setup the ODL-SDNi application.
10
11 Components
12 ----------
13
14 SDNiAggregator, SDNi API, SDNiWrapper, and SDNiUI are the four
15 components in ODL-SDNi App:
16
17 -  SDNiAggregator: Connects with switch, topology, hosttracker managers
18    of controller to get the topology and other related data.
19
20 -  SDNi REST API: It is a part of controller northbound, which gives the
21    required information by quering SDNiAggregator through RESTCONF.
22
23 -  SDNiWrapper: This component uses the SDNi REST API and gathers the
24    information required to be shared among controllers.
25
26 -  SDNiUI:This component displays all the SDN controllers which are
27    connected to each other.
28
29 Troubleshooting
30 ---------------
31
32 To work with multiple controllers, change some of the configuration in
33 config.ini file. For example change the listening port of one controller
34 to 6653 and other controller to 6663 in
35 /root/controller/opendaylight/distribution/opendaylight/target/distribution.opendaylight-osgipackage/opendaylight/configuration/config.ini
36 (i.e., of.listenPort=6653).
37
38 **OpenFlow related system parameters.**
39
40 TCP port on which the controller is listening (default 6633)
41 of.listenPort=6653