Merge "Create VES client example for domain 'stndefined'"
[oam.git] / docs / connect.rst
1 .. contents::
2    :depth: 3
3 ..
4
5 Connect
6 =======
7
8 The 'Connect' application on OpenDaylight provides up-to-date
9 connectivity information about the wireless devices in the network. It
10 automatically displays new Network Elements and their connection status.
11 Usually, the Network Elements mount themselves. If necessary, they can
12 be mounted manually by right-clicking on the element and selecting the
13 'mount' action. For better understanding of alarms and status, a
14 connection status log lists all the connection status changes of
15 OpenDaylight mount points.
16
17 Views
18 -----
19
20 The graphical user interface is divided into two sections.
21
22 Network Elements
23 ~~~~~~~~~~~~~~~~
24
25 Network Elements are physical network functions (PNFs). A table view
26 shows all configured and connected NetConf Servers of the SDN-R cluster.
27 This view also allows to manually configure/mount a device via the '+'
28 button. The SDN controller will start connecting to the NetConf server.
29
30 Network Elements can be marked as 'required'. If an element is required,
31 it will stay available even if disconnected. If an element is not
32 required, it will be deleted once disconnected.
33
34 By right-clicking on an element, an action menu opens. The menu allows
35 to mount, unmount, view the details, edit and remove the element.
36 Additionally, it links to several applications like
37 `Fault <fault.rst>`__ and
38 `Configure <config.rst>`__, which will be filtered to
39 display information relevant to the selected element.
40
41 Connection Status Log
42 ~~~~~~~~~~~~~~~~~~~~~
43
44 The log lists the connection status changes between SDN Controller and
45 NetConf servers (devices).