Update documentation
[oam.git] / docs / fault.rst
1 .. contents::
2    :depth: 3
3 ..
4
5 Fault Management
6 ================
7
8 To operate a network, it is important to get an overview about the
9 currently raised alarms. The application offers basic fault management
10 of devices supporting ONF-TR-532. The alarms are classified according to
11 the severity level (warning, minor, major, critical).
12
13 Views
14 -----
15
16 The graphical user interface is separated into three views.
17
18 Current Problem List
19 ~~~~~~~~~~~~~~~~~~~~
20
21 Lists all current active faults in the network. In addition, it also
22 lists alarms sent by the SDN controller itself, which detects connection
23 losses to the NetConf server (connectionLossOAM) or to a device via a
24 mediator to a device (connectionLossNeOAM).
25
26 Alarm Notifications
27 ~~~~~~~~~~~~~~~~~~~
28
29 As long as the view is open, all alarm notifications received by the SDN
30 Controller are listed. Please note that refreshing the view will start
31 the collection again. Previous alarm notification can be viewed in the
32 alarm log.
33
34 Alarm Log
35 ~~~~~~~~~
36
37 Next to the current active alarms an alarm log lists all alarm
38 notifications of the past.
39
40 Implementation
41 --------------
42
43 The application has two parts. While the server is listening for NetConf
44 notifications to store them in the database, the client retrieves the
45 information from the database and displays them in a table.
46
47 The server synchronizes with the current alarm lists of the devices.
48 Based on raised and cleared notifications, the current alarm status of
49 the network is calculated. The current alarms are stored in a database.
50 In addition, all Problem Notifications received by the SDN controller
51 are stored. There is no logic implemented on the client side.
52
53 An alarm status bar in the header of the web application informs the
54 operator about the health status of the network.
55
56 The ODLUX web application uses web sockets to update the graphical user
57 interface of the Alarm Notifications (devices) and Connection Status
58 Notifications in real-time.