1 Using the OpenDaylight User Interface (DLUX)
2 ============================================
4 This section introduces you to the OpenDaylight User Experience (DLUX)
7 Getting Started with DLUX
8 -------------------------
10 DLUX provides a number of different Karaf features, which you can enable
11 and disable separately. In Beryllum they are: . odl-dlux-core .
12 odl-dlux-node . odl-dlux-yangui . odl-dlux-yangvisualizer
17 To log in to DLUX, after installing the application:
19 1. Open a browser and enter the login URL
20 http://<your-karaf-ip>:8181/index.html
21 in your browser (Chrome is recommended).
23 2. Login to the application with your username and password credentials.
27 OpenDaylight’s default credentials are *admin* for both the username
33 After you login to DLUX, if you enable only odl-dlux-core feature, you
34 will see only topology application available in the left pane.
38 To make sure topology displays all the details, enable the
39 odl-l2switch-switch feature in Karaf.
41 DLUX has other applications such as node, yang UI and those apps won’t
42 show up, until you enable their features odl-dlux-node and
43 odl-dlux-yangui respectively in the Karaf distribution.
45 .. figure:: ./images/dlux-login.png
52 If you install your application in dlux, they will also show up on
53 the left hand navigation after browser page refresh.
55 Viewing Network Statistics
56 --------------------------
58 The **Nodes** module on the left pane enables you to view the network
59 statistics and port information for the switches in the network.
61 To use the **Nodes** module:
63 1. Select **Nodes** on the left pane. The right pane displays atable
64 that lists all the nodes, node connectors and the statistics.
66 2. Enter a node ID in the **Search Nodes** tab to search by node
69 3. Click on the **Node Connector** number to view details such as port
70 ID, port name, number of ports per switch, MAC Address, and so on.
72 4. Click **Flows** in the Statistics column to view Flow Table
73 Statistics for the particular node like table ID, packet match,
74 active flows and so on.
76 5. Click **Node Connectors** to view Node Connector Statistics for the
79 Viewing Network Topology
80 ------------------------
82 The Topology tab displays a graphical representation of network topology
87 DLUX does not allow for editing or adding topology information. The
88 topology is generated and edited in other modules, e.g., the
89 OpenFlow plugin. OpenDaylight stores this information in the MD-SAL
90 datastore where DLUX can read and display it.
92 To view network topology:
94 1. Select **Topology** on the left pane. You will view the graphical
95 representation on the right pane. In the diagram blue boxes represent
96 the switches, the black represents the hosts available, and lines
97 represents how the switches and hosts are connected.
99 2. Hover your mouse on hosts, links, or switches to view source and
102 3. Zoom in and zoom out using mouse scroll to verify topology for larger
105 .. figure:: ./images/dlux-topology.png
106 :alt: Topology Module
110 Interacting with the YANG-based MD-SAL datastore
111 ------------------------------------------------
113 The **Yang UI** module enables you to interact with the YANG-based
114 MD-SAL datastore. For more information about YANG and how it interacts
115 with the MD-SAL datastore, see the *Controller* and *YANG Tools* section
116 of the *OpenDaylight Developer Guide*.
118 .. figure:: ./images/dlux-yang-ui-screen.png
125 1. Select **Yang UI** on the left pane. The right pane is divided in two
128 2. The top part displays a tree of APIs, subAPIs, and buttons to call
129 possible functions (GET, POST, PUT, and DELETE).
133 every subAPI can call every function. For example, subAPIs in
134 the *operational* store have GET functionality only.
136 Inputs can be filled from OpenDaylight when existing data from
137 OpenDaylight is displayed or can be filled by user on the page and
138 sent to OpenDaylight.
140 Buttons under the API tree are variable. It depends on subAPI
141 specifications. Common buttons are:
143 - GET to get data from OpenDaylight,
145 - PUT and POST for sending data to OpenDaylight for saving
147 - DELETE for sending data to OpenDaylight for deleting.
149 You must specify the xpath for all these operations. This path is
150 displayed in the same row before buttons and it may include text
151 inputs for specific path element identifiers.
153 .. figure:: ./images/dlux-yang-api-specification.png
154 :alt: Yang API Specification
156 Yang API Specification
158 3. The bottom part of the right pane displays inputs according to the
161 - Lists are handled as a special case. For example, a device can
162 store multiple flows. In this case "flow" is name of the list and
163 every list element is identified by a unique key value. Elements
164 of a list can, in turn, contain other lists.
166 - In Yang UI, each list element is rendered with the name of the
167 list it belongs to, its key, its value, and a button for removing
170 .. figure:: ./images/dlux-yang-sub-api-screen.png
171 :alt: Yang UI API Specification
173 Yang UI API Specification
175 4. After filling in the relevant inputs, click the **Show Preview**
176 button under the API tree to display request that will be sent to
177 OpenDaylight. A pane is displayed on the right side with text of
178 request when some input is filled.
180 Displaying Topology on the **Yang UI**
181 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
185 1. Select subAPI network-topology <topology revision number> == >
186 operational == > network-topology.
188 2. Get data from OpenDaylight by clicking on the "GET" button.
190 3. Click **Display Topology**.
192 .. figure:: ./images/dlux-yang-topology.png
193 :alt: DLUX Yang Topology
197 Configuring List Elements on the **Yang UI**
198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
200 Lists in Yang UI are displayed as trees. To expand or collapse a list,
201 click the arrow before name of the list. To configure list elements in
204 1. To add a new list element with empty inputs use the plus icon-button
205 **+** that is provided after list name.
207 2. To remove several list elements, use the **X** button that is
208 provided after every list element.
210 .. figure:: ./images/dlux-yang-list-elements.png
211 :alt: DLUX List Elements
215 3. In the YANG-based data store all elements of a list must have a
216 unique key. If you try to assign two or more elements the same key, a
217 warning icon **!** is displayed near their name buttons.
219 .. figure:: ./images/dlux-yang-list-warning.png
220 :alt: DLUX List Warnings
224 4. When the list contains at least one list element, after the **+**
225 icon, there are buttons to select each individual list element. You
226 can choose one of them by clicking on it. In addition, to the right
227 of the list name, there is a button which will display a vertically
228 scrollable pane with all the list elements.
230 .. figure:: ./images/dlux-yang-list-button1.png
231 :alt: DLUX List Button1