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