Update documentation
[oam.git] / docs / sdnr_WT_Service_Configuration_parameters.rst
1 .. contents::
2    :depth: 3
3 ..
4
5 SDN-R WT Service Configuration parameters
6 =========================================
7
8 ODL is operated as a cluster. The configuration settings must be the
9 same for each cluster node.
10
11 -  `Sections <#SDN-RWTServiceConfigurationparameters-S>`__
12
13    -  `toggleAlarmFilter <#SDN-RWTServiceConfigurationparameters-t>`__
14    -  `devicemonitor <#SDN-RWTServiceConfigurationparameters-d>`__
15
16 Backgrounds regarding the container inter structure is described
17 in \ `SDN-R Docker Image configuration <sdnr_Docker_Image_configuration.html>`__.
18
19 The configuration information of sdnr wireless transport parameters are
20 in a single file.
21
22 For different devicemanager services, like DeviceMonitor there  are
23 individual sections in the configuration file available.
24
25 Configuration file location: 
26 ***$ODL\_HOME/etc/devicemanager.properties***
27
28 If SDN-R WT is starting
29
30 -  and the file exists, the configuration is used. 
31 -  if it does not exist it will be created with the default parameters.
32
33 Below an example of the content.
34
35 - Example 
36   ::
37
38     [toggleAlarmFilter]
39     taEnabled=true
40     taDelay=3000
41  
42     [es]
43     esCluster=sdnr
44     esArchiveCheckIntervalSeconds=0
45     esArchiveLifetimeSeconds=2592000
46
47     [dcae]
48     dcaeUrl=off
49     dcaeUserCredentials=admin:admin
50     dcaeHeartbeatPeriodSeconds=120
51
52     [aai]
53     aaiUrl=off
54     aaiUserCredentials=
55     aaiHeaders=["X-TransactionId: 9999"]
56     aaiDeleteOnMountpointRemove=false
57     aaiTrustAllCerts=false
58     aaiPropertiesFile=
59     aaiApiVersion=aai/v13
60     aaiApplicationId=SDNR
61     aaiClientConnectionTimeout=30000
62     aaiPcks12ClientCertFile=
63     aaiPcks12ClientCertPassphrase=
64
65     [pm]
66     pmEnabled=true
67     pmCluster=sdnr
68
69     [devicemonitor]
70     SeverityconnectionLossOAM=Major
71     SeverityconnectionLossMediator=Major
72     SeverityconnectionLossNeOAM=Major
73
74 Sections
75 --------
76
77 toggleAlarmFilter
78 ~~~~~~~~~~~~~~~~~
79
80 Configure toggle alarm filter.
81
82 taEnabled=true taDelay=3000
83
84 +-----------------+---------------+---------------+----------------+------------------------------------------------------+
85 | **Parameter**   | **Values**    | **Default**   | **Unit**       | **Description**                                      |
86 +=================+===============+===============+================+======================================================+
87 | taEnabled       | true, false   | false         |                | Enable or disable this service                       |
88 +-----------------+---------------+---------------+----------------+------------------------------------------------------+
89 | taDelay         | number        |               | milliseconds   | Integration time to take over the new alarm status   |
90 +-----------------+---------------+---------------+----------------+------------------------------------------------------+
91
92 devicemonitor
93 ~~~~~~~~~~~~~
94
95 Configure alarm severity of related alarms, generated by Device Monitor.
96
97 `SDNC-616 <https://jira.onap.org/browse/SDNC-616>`__ - SDN-R WT app need to change alarm severity "Configurable" for ConnectionLossxxx alarm family (received from Mediator) , when it passed to DCAE VES collector.
98
99
100 Syntax: Parameter=Value
101
102 Example: SeverityconnectionLossOAM=Major
103
104 +----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+
105 |                                  | **Values**                                    | **Default**   | **Unit**   | **Description**                                              |
106 +==================================+===============================================+===============+============+==============================================================+
107 | SeverityconnectionLossOAM        | NonAlarmed, Warning, Minor, Major, Critical   | Major         |            | SDN-Controller <> Mediator                                   |
108 |                                  |                                               |               |            |                                                              |
109 |                                  |                                               |               |            | Mountpoint monitoring. Indicates a not connected mounpoint   |
110 +----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+
111 | SeverityconnectionLossMediator   | NonAlarmed, Warning, Minor, Major, Critical   | Major         |            | SDN-Controller <> NetworkElement                             |
112 |                                  |                                               |               |            |                                                              |
113 |                                  |                                               |               |            | Device monitoring. No LTPs provided                          |
114 +----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+
115 | SeverityconnectionLossNeOAM      | NonAlarmed, Warning, Minor, Major, Critical   | Major         |            | SDN-Controller <> NetworkElement                             |
116 |                                  |                                               |               |            |                                                              |
117 |                                  |                                               |               |            | Device monitoring. SSH Connetion, Core model not answering   |
118 +----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+