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