0% found this document useful (0 votes)
50 views

Configuring SNMP Version One Nbi

Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
50 views

Configuring SNMP Version One Nbi

Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 64

NetAct™ Cloud 22 FP2205

(VMware)

Configuring SNMP Northbound Interface


DN0973965
Issue: 6-0 Final

© 2023 Nokia. Nokia Confidential Information

Use subject to agreed restrictions on disclosure and use.


Configuring SNMP Northbound Interface DN0973965 6-0 Disclaimer

Nokia is committed to diversity and inclusion. We are continuously reviewing our customer documentation and consulting with standards
bodies to ensure that terminology is inclusive and aligned with the industry. Our future customer documentation will be updated accordingly.

This document includes Nokia proprietary and confidential information, which may not be distributed or disclosed to any third parties without
the prior written consent of Nokia.

This document is intended for use by Nokia’s customers (“You”/”Your”) in connection with a product purchased or licensed from any company
within Nokia Group of Companies. Use this document as agreed. You agree to notify Nokia of any errors you may find in this document;
however, should you elect to use this document for any purpose(s) for which it is not intended, You understand and warrant that any
determinations You may make or actions You may take will be based upon Your independent judgment and analysis of the content of this
document.

Nokia reserves the right to make changes to this document without notice. At all times, the controlling version is the one available on Nokia’s
site.

No part of this document may be modified.

N O WA RRA NT Y O F AN Y KI ND , EI T HER EXPR ES S OR I M P L I E D , I N C L U D I N G B U T N O T L I M I T E D TO A N Y


WARR ANT Y OF AVA IL ABI LI T Y, AC CU RAC Y, R EL I A B I L IT Y, T I T L E , N O N - I N F R I N G E M E N T, M E R C H A N TA B I L I TY
OR F IT NE SS FO R A PA RT ICU LAR PU RPO SE, I S M A D E IN R E L AT I O N TO T H E C O N T E N T O F T H I S D O C U M E N T.
IN NO EVEN T WI L L NOK IA B E LI ABLE F OR AN Y DA M A G E S , I N C L U D I N G B U T N O T L I M I T E D TO S P E C I A L ,
D IRE CT, IN D IRECT, I NCI DE NTAL OR C ON SEQ UE N T IA L OR A N Y L O S S E S , S U C H A S B U T N O T L I M I T E D TO LO SS
OF PRO F IT, REVE NU E, B US IN ESS IN T ER RU PT I ON , B U S I NE S S O P P O RT U N I T Y O R D ATA T H AT M AY A R I S E
FRO M T HE USE O F TH IS DO CU M EN T O R T HE IN F OR M AT IO N I N I T, E V E N I N T H E C A S E O F E R R O R S I N O R
OM IS SI O NS FRO M T HI S DOC UM EN T O R IT S CO NT E N T.

This document is Nokia’ proprietary and confidential information, which may not be distributed or disclosed to any third parties without the
prior written consent of Nokia.

Copyright and trademark: Nokia is a registered trademark of Nokia Corporation. Other product names mentioned in this document may be
trademarks of their respective owners.

© 2023 Nokia.

© 2023 Nokia. Nokia Confidential Information

Use subject to agreed restrictions on disclosure and use.


Configuring SNMP Northbound Interface DN0973965 6-0 Table of Contents

Contents
1 Setting filters....................................................................................................................................................4
1.1 Setting filters by modifying SNMP NBI configuration file..........................................................................4
1.1.1 Setting filterId.................................................................................................................................... 4
1.1.2 Setting correlationFilterResult...........................................................................................................4
1.1.3 Setting working set filter................................................................................................................... 5
1.1.3.1 Example 1: nms_conf.xml file with working set filter when except-hierarchy is present...........7
1.1.3.2 Example 2: nms_conf.xml file with working set filter when except-hierarchy is not present ... 10
1.1.4 Setting event type filter...................................................................................................................11
1.1.5 Setting object instance filter........................................................................................................... 15
1.1.6 Setting severity filter....................................................................................................................... 17
1.1.7 Setting alarm number filter............................................................................................................. 22
1.2 Setting filters by sending a filter request from the higher level system.................................................. 25
1.2.1 Setting event type filter...................................................................................................................25
1.2.2 Setting object instance filter........................................................................................................... 30
1.2.3 Setting severity filter....................................................................................................................... 31

2 Setting USM credential for SNMP v3.......................................................................................................... 34

3 Configuring notification enrichment function............................................................................................ 38


3.1 Configuring the notification enrichment tag............................................................................................ 46
3.2 Configuring object hierarchies for notification enrichment...................................................................... 49

4 Configurable items........................................................................................................................................ 51

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 3


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

1 Setting filters
This section describes the ways to set filters for the notifications received by the higher level system.

1.1 Setting filters by modifying SNMP NBI configuration file


This section provides the instructions on how to set filter by modifying SNMP NBI configuration file.

1.1.1 Setting filterId


This filter item indicates the ID of the applied filtering rule. You can change it to apply to other filtering
rules.

To change filterId

1. Log in as the omc user to the NetAct VM where the nbisnmp service is running.

Note: To locate the right VM, see Locating the right virtual machine for a service in
Administering NetAct Virtual Infrastructure.

2. open /etc/opt/oss/global/nbisnmp/conf/mf-conf/nbi-snmp.properties file by


entering:

[omc]$ vi /etc/opt/oss/global/nbisnmp/conf/mf-conf/nbi-snmp.properties
3. Set com.nsn.oss.nbi.fm.filterId according to the following format:

com.nsn.oss.nbi.fm.filterId=<value>

Note:

For more information on filterId, see Creating a filtering rule in Rule Explorer Help.

4. The changes will take effect automatically within one minute.

1.1.2 Setting correlationFilterResult


This filter defines the range of notifications which SNMP NBI forwards to the higher level system. If
the value is 0, SNMP NBI only forwards root cause notifications. If the value is 1, all notifications are
forwarded.

To change correlationFilterResult

1. Log in as the omc user to the NetAct VM where the nbisnmp service is running.

Note: To locate the right VM, see Locating the right virtual machine for a service in
Administering NetAct Virtual Infrastructure.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 4


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

2. Open the /etc/opt/oss/global/nbisnmp/conf/mf-conf/nbi-snmp.properties file by


entering:

[omc]$ vi /etc/opt/oss/global/nbisnmp/conf/mf-conf/nbi-snmp.properties
3. Set correlationFilterResult according to the following format:

com.nsn.oss.nbi.fm.correlationFilterResult=<value>

Note:

The possible value of <value> is 0 or 1.

0: only forward the root cause alarm

1: forward all alarms

For more information, see About Alarm Correlation in Rule Explorer Help.

4. The changes will take effect automatically within one minute.

1.1.3 Setting working set filter


Filter the notifications sent to the higher level system by working set.

For more information on configuring working set, see Managing working sets in Working Set Manager
Help.

Note: One higher level system supports only one working set filter rule.

1. Log in as omc user to the NetAct virtual machine (VM) where the nbisnmp service is running.

Note: To locate the right VM, see Locating the right virtual machine for a service in
Administering NetAct Virtual Infrastructure.

2. Open the nms_conf.xml file by entering:

[omc]$ vi /etc/opt/oss/global/nbisnmp/conf/mf-conf/nms_conf.xml

3. In the nms_conf.xml file, configure the working set filter according to the definition described
in Table 1: Description of the elements in the nms_conf.xml file and Table 2: Description of the
attributes in the nms_conf.xml file.

Element Description Occurrence

workingSet Describes the working set filter rule. 0...1

except-hierarchy Child element of workingSet. 0...1

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 5


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Element Description Occurrence

Describes the distinguished name (DN) hierar-


chy level to filter network elements or DN sub-
trees by working set.

Table 1: Description of the elements in the nms_conf.xml file

Occur-
Element Attribute Description Example
rence

work- filterMode The valid value is include or Mandatory filterMode="excl


ingSet exclude. ude"

• If the value is include, the


notification is sent to the
higher level system.
• If the value is exclude, the
notification is not sent to the
higher level system.

match- The valid value is full or pre- Mandatory matchMode="prefix"


Mode fix.

• full: the distinguished


name of the notification
present in the working set.
• prefix: the distinguished
name of the notification or
its parent present in the
working set.

Note: If the working


set filter is configured
and except-hi-
erarchy value is
present, then:

• matchMode="Pre
fix" is valid.
• matchMode="ful
l" is invalid.

name Describes the name of the work- Mandatory name="workingset1"


ing set.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 6


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Occur-
Element Attribute Description Example
rence

except-hi- value Describes the DN hierarchy lev- Mandatory value="PLMN/MRBTS/


erarchy el to filter network elements or LNBTS"
DN sub-trees by working set.

Table 2: Description of the attributes in the nms_conf.xml file

The following examples describe the nms_conf.xml file configured with working set filter:

• Example 1: nms_conf.xml file with working set filter when except-hierarchy is present
• Example 2: nms_conf.xml file with working set filter when except-hierarchy is not present

Note:

• When a working set filter is configured with the except-hierarchy value, the
alarm synchronization, the alarm summary, or the topology notifications received by
the higher level system might be affected.
• For deleting or adding working set in the nms_conf.xml file, the working set rule
takes effect automatically after several minutes.
• When the NMS is configured with the working set filter, the number of current alarms
in alarmSummaryNotification might be affected.
• For modifying the working set in Working Set Manager or after new network
elements are integrated, the change of working set rule takes effect after 24 hours at
most.

The alarm or topology notifications received by the higher level system might not be
consistent with the new working set rule. To resolve this problem, see Internal work-
ing set cache is out of date in Troubleshooting Fault Management.

Expected outcome

The working set filter is configured in the SNMP NBI configuration file.

1.1.3.1 Example 1: nms_conf.xml file with working set filter when except-hierarchy is present

The following is a sample of the nms_conf.xml file in which one higher level system nms1 is
configured with working set ws1 and another higher level system nms2 is configured with working set
ws2:

<?xml version="1.0" encoding="UTF-8"?>


<NMSConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="nms_conf.xsd">
<NMS name="nms1" ip="192.168.1.10" port="162">
<workingSet name="ws1" filterMode="include" matchMode="prefix">
<except-hierarchy value="PLMN/MRBTS/LNBTS/LNCEL"/>

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 7


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

</workingSet>
<NMS name="nms2" ip="192.168.1.11" port="163">
<workingSet name="ws2" filterMode="include" matchMode="prefix">
<except-hierarchy value="PLMN/MRBTS/LNBTS/LNCEL"/>
</workingSet>
</NMSConfig>

The working set ws1 is configured with the following distinguished names (DNs):

• PLMN-1/MRBTS-1
• PLMN-1/MRBTS-1/LNBTS-1/LNCEL-1

The working set ws2 is configured with the following distinguished names (DNs):

• PLMN-1/MRBTS-1
• PLMN-1/MRBTS-1/LNBTS-1/LNCEL-2

The except-hierarchy value configured in the sample nms_conf.xml file is PLMN/MRBTS/


LNBTS/LNCEL.

Based on the above nms_conf.xml file configuration with working set filter, Table 3: Example use
cases during which the distinguished name (DN) of the notification is sent to the higher level system
describes how the SNMP NBI uses the except-hierarchy value to send the incoming notification
DNs to the higher level systems.

except-hierar- Incoming notifi- Notification


Use cases Description
chy value cation DN status

Use case 1 PLMN/MRBTS/ PLMN-1/ The except-hierarchy The parent


LNBTS/LNCEL MRBTS-1/ value is not present in the of the incom-
BSC-1 hierarchy of the incoming ing notification
notification DN. DN, which is
PLMN/MRBTS, is
In this case, the SNMP
present in ws1
NBI filters the incoming
and ws2 and
notification DN in prefix
therefore, the
mode. That is, it checks if
notification is
the parent of the incoming
sent to nms1
notification DN is present
and nms2.
in the configured working
sets ws1 and ws2.

Use case 2 PLMN/MRBTS/ PLMN-1/ The except-hierarchy The parent


LNBTS/LNCEL MRBTS-1/ value is not present in the of the incom-
LNBTS-1 hierarchy of the incoming ing notification
notification DN. DN, which is
PLMN/MRBTS, is
In this case, the SNMP
present in ws1
NBI filters the incoming
and ws2 and
notification DN in prefix

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 8


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

except-hierar- Incoming notifi- Notification


Use cases Description
chy value cation DN status
mode. That is, it checks if therefore, the
the parent of the incoming notification is
notification DN is present sent to nms1
in the configured working and nms2.
sets ws1 and ws2.

Use case 3 PLMN/MRBTS/ PLMN-1/ The except-hierarchy The complete


LNBTS/LNCEL MRBTS-1/ value matches with the notification DN
LNBTS-1/LN- hierarchy of the incoming hierarchy, which
CEL-1 notification DN. is PLMN-1/
MRBTS-1/
In this case, the SNMP
LNBTS-1/
NBI filters the incoming
LNCEL-1, is
notification DN in
present in ws1
full mode. That is, it
and therefore,
checks if the complete
the notification
incoming notification DN
is sent only to
hierarchy is present in the
nms1.
configured working sets
ws1 and ws2.

Use case 4 PLMN/MRBTS/ PLMN-1/ The except-hierarchy The complete


LNBTS/LNCEL MRBTS-1/ value matches with the notification DN
LNBTS-1/LN- hierarchy of the incoming hierarchy, which
CEL-2 notification DN. is PLMN-1/
MRBTS-1/
In this case, the SNMP
LNBTS-1/
NBI filters the incoming
LNCEL-2, is
notification DN in
present in ws2
full mode. That is, it
and therefore,
checks if the complete
the notification
incoming notification DN
is sent only to
hierarchy is present in the
nms2.
configured working sets
ws1 and ws2.

Use case 5 PLMN/MRBTS/ PLMN-1/ The except-hierarchy The lifted notifi-


LNBTS/LNCEL MRBTS-1/ value is present in the cation DN, which
LNBTS-1/LN- hierarchy of the incoming is PLMN-1/
CEL-1/ABC-1 notification DN. MRBTS-1/
LNBTS-1/
In this case, the SNMP
LNCEL-1, is
NBI lifts the hierarchy
present in ws1
level of the notification

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 9


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

except-hierar- Incoming notifi- Notification


Use cases Description
chy value cation DN status
DN until it matches the and therefore,
except-hierarchy the notification
value and then filters the is sent only to
lifted notification DN in nms1.
full mode.

Use case 6 PLMN/MRBTS/ PLMN-1/ The except-hierarchy The lifted notifi-


LNBTS/LNCEL MRBTS-1/ value is present in the cation DN, which
LNBTS-1/LN- hierarchy of the incoming is PLMN-1/
CEL-2/ABC-1 notification DN. MRBTS-1/
LNBTS-1/
In this case, the SNMP
LNCEL-2, is
NBI lifts the hierarchy
present in ws2
level of the notification
and therefore,
DN until it matches the
the notification
except-hierarchy
is sent only to
value and then filters the
nms2.
lifted notification DN in
full mode.

Table 3: Example use cases during which the distinguished name (DN) of the notification is sent to the
higher level system

1.1.3.2 Example 2: nms_conf.xml file with working set filter when except-hierarchy is not present

The following is a sample of the nms_conf.xml file with working set filter when except-hierarchy
is not present:
<?xml version="1.0" encoding="UTF-8"?>
<NMSConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="nms_conf.xsd">
<NMS name="nms1" ip="192.168.1.10" port="162">
<workingSet name="workingset1" filterMode="include"
matchMode="full"/>
</NMS>
<NMS name="nms2" ip="192.168.1.11" port="162">
<workingSet name="workingset2" filterMode="exclude"
matchMode="prefix"/>
</NMS>
<NMS name="nms3" ip="192.168.1.11" port="162">
<workingSet name="workingset2" filterMode="exclude"
matchMode="full"/>
</NMS>
</NMSConfig>

In the above example:

• The distinguished name of the notification in workingset1 is sent to nms1.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 10


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

• The distinguished name of the notification or its ancestors in workingset2 are not sent to nms2.
• The distinguished name of the notification in workingset2 is not sent to nms3.

1.1.4 Setting event type filter


Filter the notifications sent to the higher level system by event type.

Note: One higher level system supports only one event type filter rule.

1. Log in as omc user to the NetAct virtual machine (VM) where the nbisnmp service is running.

Note: To locate the right VM, see Locating the right virtual machine for a service in
Administering NetAct Virtual Infrastructure.

2. Open the nms_conf.xml file by entering:

[omc]$ vi /etc/opt/oss/global/nbisnmp/conf/mf-conf/nms_conf.xml

3. In the nms_conf.xml file, configure the event type filter according to the definition described
in Table 4: Description of the element in the nms_conf.xml file and Table 5: Description of the
attributes in the nms_conf.xml file.

Element Description Occurrence

eventType Describes the event type filter rule. 0...1

Table 4: Description of the element in the nms_conf.xml file

Element Attribute Description Occurrence Example

event- value Describes the event type. Mandatory <eventType


Type value="environme
The attribute is a string. The
ntalAlarm"/>
valid values are:

• filterAll
• noEventTypeFilter
• communicationsAlarm
• qualityOfServiceAlarm
• processingErrorAlarm
• equipmentAlarm
• environmentalAlarm
• integrityViolationAlarm
• operationalViolation
Alarm

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 11


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Element Attribute Description Occurrence Example

• physicalViolationAlarm
• securityServiceOrMechan
ismViolationAlarm
• timeDomainViolation
Alarm
• createNotification
• deleteNotification
• AVCNotification
• stateChangeNotification
• alarmSyncNotification
• syncEMSDataNotification
• syncNEDataNotification
• alarmSummaryNotifica
tion
• heartbeatNotification
• endOfSequenceNotifica
tion
• changedPeriodNotifica
tion
• startUpNotification
• shutDownNotification
• alarmNewNotification
• alarmAckChangedNotifica
tion
• alarmChangedNotification
• alarmCommentNotification
• alarmClearedNotification

Note:

• You can also config-


ure the eventType
value with a deci-
mal_filter_code.
To find the correct
decimal filter code,
see Setting event
type filter. If you con-
figure the event-
Type value with a
decimal filter code,

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 12


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Element Attribute Description Occurrence Example

then the decimal fil-


ter code is changed
to the correspond-
ing event type string
value after the nms_
conf.xml file is
successfully loaded.
• The eventType
element must not
contain a combina-
tion of string and
decimal filter code
value. For exam-
ple, <eventType
value="environme
ntalAlarm,2"/> is
invalid.
• If the eventType
element is config-
ured with duplicate
values, for exam-
ple, <eventType
value="environme
ntalAlarm,enviro
nmentalAlarm"/>,
then the nms_conf.
xml file configuration
is invalid.

mode Describes the event type filter Mandato- <eventType


mode. ry for each mode="exclude"
event type value="environme
The valid value is include or
except no- ntalAlarm”/>
exclude.
Event
• If the value is include, the Type-
notification is sent to the higher Filter and
level system. filterAll.
• If the value is exclude, the
notification is not sent to the
higher level system.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 13


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Element Attribute Description Occurrence Example

Note:

• If the mode attribute


is not configured for
an event type other
than filterAll or
noEventTypeFilt
er, then the default
mode value is added
as exclude after
the nms_conf.xml
file is successfully
loaded.
• If the mode attribute
is configured for
filterAll and no-
EventTypeFilter
event types, then
the value of mode at-
tribute is ignored.

Table 5: Description of the attributes in the nms_conf.xml file

The following is an example of the nms_conf.xml file configured with the event type filter:

<?xml version="1.0" encoding="UTF-8"?>


<NMSConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="nms_conf.xsd">
<NMS name="nms1" ip="192.168.1.10" port="162">
<filters>
<eventType mode="exclude" value="environmentalAlarm”/>
<objectInstance value=""/>
<severityType value="noSeverityFilter"/>
<alarmNumber value=""/>
</filters>
</NMS>
NMS name="nms2" ip="192.168.1.11" port="162">
<filters>
<eventType mode="include" value="equipmentAlarm,
processingErrorAlarm”/>
<objectInstance value=""/>
<severityType value="noSeverityFilter"/>
<alarmNumber value=""/>
</filters>

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 14


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

</NMS>
<NMS name="nms3" ip="192.168.1.12" port="162">
<filters>
<eventType value="filterAll”/>
<objectInstance value=""/>
<severityType value="noSeverityFilter"/>
<alarmNumber value=""/>
</filters>
</NMS>
<NMS name="nms4" ip="192.168.1.13" port="162">
<filters>
<eventType value="noEventTypeFilter”/>
<objectInstance value=""/>
<severityType value="noSeverityFilter"/>
<alarmNumber value=""/>
</filters>
</NMS>
</NMSConfig>

In this example:

• All the notifications of environmentalAlarm are not sent to nms1.


• All the notifications of equipmentAlarm and processingErrorAlarm are sent to nms2.
• All the notifications of events irrespective of the event type are not sent to nms3.
• All the notifications of events irrespective of the event type are sent to nms4.

Expected outcome

The event type filter is configured in the SNMP NBI configuration file.

1.1.5 Setting object instance filter


Filter the notifications sent to the higher level system by object instance.

Note: One higher level system supports only one object instance filter rule.

1. Log in as omc user to the NetAct virtual machine (VM) where the nbisnmp service is running.

Note: To locate the right VM, see Locating the right virtual machine for a service in
Administering NetAct Virtual Infrastructure.

2. Open the nms_conf.xml file by entering:

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 15


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

[omc]$ vi /etc/opt/oss/global/nbisnmp/conf/mf-conf/nms_conf.xml

3. In the nms_conf.xml file, configure the object instance filter according to the definition described
in Table 6: Description of the element in the nms_conf.xml file and Table 7: Description of the
attributes in the nms_conf.xml file.

Element Description Occurrence

objectInstance Describes the distinguished name filter rule. 0...1

Table 6: Description of the element in the nms_conf.xml file

At-
Element Description Occurrence Example
tribute

objectInstance value Indicates the object DN. Mandatory <objectInstance


value="PLMN-1/
To configure the DN, see Set-
MSC-*"/>
ting object instance filter.

mode Describes the object instance Mandatory for <objectInstance


filter mode. each object in- mode=”exclude”
stance except value="PLMN-1/
The valid value is include or
default "". MSC-*"/>
exclude.

• If the value is include,


the notification is sent to
the higher level system.
• If the value is exclude,
the notification is not sent
to the higher level system.

Note: If the mode at-


tribute is not config-
ured and objec-
tInstance value
attribute is config-
ured, then the de-
fault mode value is
added as exclude
after the nms_conf.
xml file is success-
fully loaded.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 16


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Table 7: Description of the attributes in the nms_conf.xml file

The following is an example of the nms_conf.xml file configured with the object instance filter:

<?xml version="1.0" encoding="UTF-8"?>


<NMSConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="nms_conf.xsd">
<NMS name="nms1" ip="192.168.1.10" port="162">
<filters>
<eventType value="noEventTypeFilter"/>
<objectInstance mode="exclude" value="PLMN-1/MSC-*"/>
<severityType value="noSeverityFilter"/>
<alarmNumber value=""/>
</filters>
</NMS>
<NMS name="nms2" ip="192.168.1.11" port="162">
<filters>
<eventType value="noEventTypeFilter"/>
<objectInstance mode="include" value="PLMN-1/MRBTS-*"/>
<severityType value="noSeverityFilter"/>
<alarmNumber value=""/>
</filters>
</NMS>
<NMS name="nms3" ip="192.168.1.12" port="162">
<filters>
<eventType value="noEventTypeFilter"/>
<objectInstance value=""/>
<severityType value="noSeverityFilter"/>
<alarmNumber value=""/>
</filters>
</NMS>
</NMSConfig>

In this example:

• All the notifications of MSC are not sent to nms1.


• All the notifications of MRBTS are sent to nms2.
• All the notifications of object instances are sent to nms3.

Expected outcome

The object instance filter is configured in the SNMP NBI configuration file.

1.1.6 Setting severity filter


Filter the notifications sent to the higher level system by severity.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 17


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Note:

• One higher level system supports only one severity filter rule.
• When you filter alarms using the severity filter, the alarm severity displayed corresponds
to the Perceived Severity of the alarm.

1. Log in as omc user to the NetAct virtual machine (VM) where the nbisnmp service is running.

Note: To locate the right VM, see Locating the right virtual machine for a service in
Administering NetAct Virtual Infrastructure.

2. Open the nms_conf.xml file by entering:

[omc]$ vi /etc/opt/oss/global/nbisnmp/conf/mf-conf/nms_conf.xml

3. In the nms_conf.xml file, configure the severity filter according to the definition described
in Table 8: Description of the element in the nms_conf.xml file and Table 9: Description of the
attributes in the nms_conf.xml file.

Element Description Occurrence

severityType Describes the severity filter rule. 0...1

Table 8: Description of the element in the nms_conf.xml file

Element Attribute Description Occurrence Example

severity- value Describes the severity type. Mandatory <severityType


Type value="critical"/
The attribute is a string. The
>
valid values are:

• indeterminate
• cleared
• warnings
• minor
• major
• critical
• noSeverityFilter
• filterAll

Note:

• You can also


configure the
severity-
Type value with
a decimal_

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 18


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Element Attribute Description Occurrence Example

filter_code.
To find the cor-
rect decimal filter
code, see Set-
ting severity fil-
ter. If you config-
ure the sever-
ityType val-
ue with a deci-
mal filter code,
then the deci-
mal filter code is
changed to the
corresponding
severityType
string value after
the nms_conf.
xml file is suc-
cessfully loaded.
• The severity-
Type element
must not contain
a combination of
string and dec-
imal filter code
value. For ex-
ample, <sever-
ityType
value="criti
cal,2"/> is in-
valid.
• If the severi-
tyType element
is configured
with duplicate
values, for ex-
ample, <sever-
ityType
value="criti
cal,critical"/
>, then the nms_
conf.xml file

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 19


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Element Attribute Description Occurrence Example

configuration is
invalid.

mode Describes the severity type fil- Mandatory for <severityType


ter mode. each severi- mode="exclude"
ty type except value="minor”/>
The valid value is include or
noSeverityF
exclude.
ilter and
• If the value is include, filterAll.
the notification is sent to
the higher level system.
• If the value is exclude,
the notification is not sent
to the higher level system.

Note:

• If the mode at-


tribute is not
configured for
a severity type
other than fil-
terAll or
noSeverity-
Filter, then
the default mode
value is added
as exclude
after the nsm_
conf.xml file
is successfully
loaded.
• If the mode at-
tribute is config-
ured for fil-
terAll and
noSeverity-
Filter severi-
ty types, then the
value of mode at-
tribute is ignored.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 20


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Table 9: Description of the attributes in the nms_conf.xml file

The following is an example of the nms_conf.xml file configured with the severity type filter:

<?xml version="1.0" encoding="UTF-8"?>


<NMSConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="nms_conf.xsd">
<NMS name="nms1" ip="192.168.1.10" port="162">
<filters>
<eventType value="noEventTypeFilter"/>
<objectInstance value=""/>
<severityType mode="exclude" value="minor”/>
<alarmNumber value=""/>
</filters>
</NMS>
NMS name="nms2" ip="192.168.1.11" port="162">
<filters>
<eventType value="noEventTypeFilter"/>
<objectInstance value=""/>
<severityType mode="include" value="major,critical”/>
<alarmNumber value=""/>
</filters>
</NMS>
<NMS name="nms3" ip="192.168.1.12" port="162">
<filters>
<eventType value="noEventTypeFilter"/>
<objectInstance value=""/>
<severityType value="filterAll”/>
<alarmNumber value=""/>
</filters>
</NMS>
<NMS name="nms4" ip="192.168.1.13" port="162">
<filters>
<eventType value="noEventTypeFilter"/>
<objectInstance value=""/>
<severityType value="noSeverityFilter”/>
<alarmNumber value=""/>
</filters>
</NMS>
</NMSConfig>

In this example:

• All the notifications of minor alarms are not sent to nms1.


• All the notifications of major and critical alarms are sent to nms2.
• All the notifications of alarms irrespective of the severity type are not sent to nms3.
• All the notifications of alarms irrespective of the severity type are sent to nms4.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 21


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Expected outcome

The severity filter is configured in the SNMP NBI configuration file.

1.1.7 Setting alarm number filter


Filter the notifications sent to the higher level system by alarm number.

Note: One higher level system supports only one alarm number filter rule.

1. Log in as omc user to the NetAct virtual machine (VM) where the nbisnmp service is running.

Note: To locate the right VM, see Locating the right virtual machine for a service in
Administering NetAct Virtual Infrastructure.

2. Open the nms_conf.xml file by entering:

[omc]$ vi /etc/opt/oss/global/nbisnmp/conf/mf-conf/nms_conf.xml

3. In the nms_conf.xml file, configure the alarm number filter according to the definition described
in Table 10: Description of the element in the nms_conf.xml file and Table 11: Description of the
attributes in the nms_conf.xml file.

Element Description Occurrence

alarmNumber Describes the alarm number filter rule. 0...1

Table 10: Description of the element in the nms_conf.xml file

Element Attribute Description Occurrence Example

alarmNum- value Indicates the alarm number. Mandatory <alarmNumber val-


ber ue="999,100-200"/>
Note:

• You can con-


figure max-
imum 20
alarm number
instances, in-
cluding sin-
gle alarm
number and
alarm number
range.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 22


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Element Attribute Description Occurrence Example

• If you are
configuring
more than
one alarm
number in-
stance, then
each instance
must be sep-
arated by a
comma ( ,).
• If the alarm-
Number ele-
ment is con-
figured with
duplicate
values, for
example,
<alarmNum
ber val-
ue="999,
100,999"/
>, then the
nms_conf.
xml file con-
figuration is
invalid.

mode Describes the alarm number Mandato- <alarmNumber


filter mode. ry for each mode="exclude" val-
alarm num- ue="900,100-200”/>
The valid value is include
ber except
or exclude.
default "".
• If the value is include,
the notification is sent to
the higher level system.
• If the value is exclude,
the notification is not
sent to the higher level
system.

Note: If the mode


attribute is not

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 23


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Element Attribute Description Occurrence Example

configured and
alarmNumber
value attribute is
configured, then
the default mode
value is added as
exclude after
the nms_conf.
xml file is suc-
cessfully loaded.

Table 11: Description of the attributes in the nms_conf.xml file

The following is an example of the nms_conf.xml file configured with the alarm number filter:

<?xml version="1.0" encoding="UTF-8"?>


<NMSConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="nms_conf.xsd">
<NMS name="nms1" ip="192.168.1.10" port="162">
<filters>
<eventType value="noEventTypeFilter"/>
<objectInstance value=""/>
<severityType value="noSeverityFilter"/>
<alarmNumber mode="exclude" value="999,100-200"/>
</filters>
</NMS>
<NMS name="nms2" ip="192.168.1.11" port="162">
<filters>
<eventType value="noEventTypeFilter"/>
<objectInstance value=""/>
<severityType value="noSeverityFilter"/>
<alarmNumber mode="include" value="999"/>
</filters>
</NMS>
<NMS name="nms3" ip="192.168.1.12" port="162">
<filters>
<eventType value="noEventTypeFilter"/>
<objectInstance value=""/>
<severityType value="noSeverityFilter"/>
<alarmNumber value=""/>
</filters>
</NMS>
</NMSConfig>

In this example:

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 24


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

• All the notifications of alarms with alarm number 999 and alarms with alarm numbers in the
range 100 to 200 are not sent to nms1.
• All the notifications of alarms with alarm number 999 are sent to nms2.
• All the notifications of alarms irrespective of alarm numbers are sent to nms3.

Expected outcome

The alarm number filter is configured in the SNMP NBI configuration file.

1.2 Setting filters by sending a filter request from the higher level
system
This section explains how to set the following filters:

• severity filter
• event type filter
• object instance filter

The above filters are independent of each other and take effect separately.

To set a filter, you need to send an SNMP SET request from the higher level system. NetAct provides a
tool to simulate the scenario of sending an SNMP SET request from the higher level system. For more
information on how to simulate this scenario, see step 5 in Integrating an external NMS by sending a
register request in Integrating NetAct to an External NMS Using SNMP Northbound Interface.

The following sections explains the required content, including OID and value, of the SNMP SET
request for setting each filter.

1.2.1 Setting event type filter


The notifications received by the higher level system can be filtered by event type. The higher level
system can send a filter request with the following management information base (MIB) fields to Net-
Act through SNMP Agent Startport.

• SNMP Agent Startport is

<NBISNMP_VM_FQDN>:16604
1.3.6.1.4.1.28458.1.26.2.1.1.1.1.5.<ascii_nms_name> s
<decimal_filter_code>

• <ascii_nms_name> is the name of higher level system in ASCII format. For example, the
ascii_nms_name of nms21 is 110.109.115.50.49 according to the following character and
ASCII mapping. <ascii_nms_name> must be no more than 100 ASCII characters.

Character ASCII

n 110

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 25


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Character ASCII

m 109

s 115

2 50

1 49

<decimal_filter_code> is the filter code in decimal notation.

Filter code is a thirty-digit binary number, and each digit represents the filter choice of one event type.
If the corresponding digit is 0, notifications of this event type are not filtered; if the corresponding digit
is 1, notifications of this event type are filtered.

The thirty event types are listed in order as follows, which are mapped to thirty-digit binary number
form high digit to low digit according to the filtering choice.

Digit position Event type

1 filterAll

2 noEventTypeFilter

3 filterCommunicationsAlarm

4 filterQualityOfServiceAlarm

5 filterProcessingErrorAlarm

6 filterEquipmentAlarm

7 filterEnvironmentalAlarm

8 filterIntegrityViolationAlarm

9 filterOperationalViolationAlarm

10 filterPhysicalViolationAlarm

11 filterSecurityServiceOrMechanismViolationAlarm

12 filterTimeDomainViolationAlarm

13 filterCreateNotification

14 filterDeleteNotification

15 filterAVCNotification

16 filterStateChangeNotification

17 filterAlarmSyncNotification

18 filterSyncEMSDataNotification

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 26


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Digit position Event type

19 filterSyncNEDataNotification

20 filterAlarmSummaryNotification

21 filterHeartbeatNotification

22 filterEndOfSequenceNotification

23 filterChangedPeriodNotification

24 filterStartUpNotification

25 filterShutDownNotification

26 filterAlarmNewNotification

27 filterAlarmAckChangedNotification

28 filterAlarmChangedNotification

29 filterAlarmCommentNotification

30 filterAlarmClearedNotification

Example 1:

The following setting means no event type filter is applied, and the filter code is
010000000000000000000000000000. The decimal_filter_code is 268435456.

Digit position Event type Choice

1 filterAll 0

2 noEventTypeFilter 1

3 filterCommunicationsAlarm 0

4 filterQualityOfServiceAlarm 0

5 filterProcessingErrorAlarm 0

6 filterEquipmentAlarm 0

7 filterEnvironmentalAlarm 0

8 filterIntegrityViolationAlarm 0

9 filterOperationalViolationAlarm 0

10 filterPhysicalViolationAlarm 0

11 filterSecurityServiceOrMechanismViolationAlarm 0

12 filterTimeDomainViolationAlarm 0

13 filterCreateNotification 0

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 27


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Digit position Event type Choice

14 filterDeleteNotification 0

15 filterAVCNotification 0

16 filterStateChangeNotification 0

17 filterAlarmSyncNotification 0

18 filterSyncEMSDataNotification 0

19 filterSyncNEDataNotification 0

20 filterAlarmSummaryNotification 0

21 filterHeartbeatNotification 0

22 filterEndOfSequenceNotification 0

23 filterChangedPeriodNotification 0

24 filterStartUpNotification 0

25 filterShutDownNotification 0

26 filterAlarmNewNotification 0

27 filterAlarmAckChangedNotification 0

28 filterAlarmChangedNotification 0

29 filterAlarmCommentNotification 0

30 filterAlarmClearedNotification 0

Example 2:

The following setting means only AlarmCommentNotification is filtered, and the filter code is
000000000000000000000000000010. The decimal_filter_code is 2.

Digit position Event type Choice

1 filterAll 0

2 noEventTypeFilter 0

3 filterCommunicationsAlarm 0

4 filterQualityOfServiceAlarm 0

5 filterProcessingErrorAlarm 0

6 filterEquipmentAlarm 0

7 filterEnvironmentalAlarm 0

8 filterIntegrityViolationAlarm 0

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 28


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Digit position Event type Choice

9 filterOperationalViolationAlarm 0

10 filterPhysicalViolationAlarm 0

11 filterSecurityServiceOrMechanismViolationAlarm 0

12 filterTimeDomainViolationAlarm 0

13 filterCreateNotification 0

14 filterDeleteNotification 0

15 filterAVCNotification 0

16 filterStateChangeNotification 0

17 filterAlarmSyncNotification 0

18 filterSyncEMSDataNotification 0

19 filterSyncNEDataNotification 0

20 filterAlarmSummaryNotification 0

21 filterHeartbeatNotification 0

22 filterEndOfSequenceNotification 0

23 filterChangedPeriodNotification 0

24 filterStartUpNotification 0

25 filterShutDownNotification 0

26 filterAlarmNewNotification 0

27 filterAlarmAckChangedNotification 0

28 filterAlarmChangedNotification 0

29 filterAlarmCommentNotification 1

30 filterAlarmClearedNotification 0

Note: The filterAll and noEventTypeFilter impact the settings of other event types.
If the value of filterAll is 1, the values of all other event types must be set as 0. If the
values of noEventTypeFilter is 1, the values of all other event types must be set as 0.
For example, if the filter code is 110000000000000000000000000000 with decimal-
filter_code 805306368, the following error message shows:
Error in packet.
Reason: (badValue) The value given has the wrong type or length.
Failed object: SNMPv2-SMI::enterprises.28458.1.26.2.1.1.1.1.5.110.
109.115.49

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 29


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

The default value is noEventTypeFilter.

The following types are not supported:

• filterAVCNotification
• filterStateChangeNotification
• filterSyncEMSDataNotification
• filterSyncNEDataNotification
• filterAlarmCommentNotification

1.2.2 Setting object instance filter


The notifications received by the higher level system can be filtered by object instance. The higher
level system can send a filter request with the following management information base (MIB) fields to
NetAct through SNMP Agent Startport.

• SNMP Agent Startport is

<NBISNMP_VM_FQDN>:16604
1.3.6.1.4.1.28458.1.26.2.1.1.1.1.6.<ascii_nms_name> s <DN>
• <ascii_nms_name> is the name of higher level system in ASCII format. For example, the
ascii_nms_name of nms21 is 110.109.115.50.49 according to the following character and
ASCII mapping. <ascii_nms_name> must be no more than 100 ASCII characters.

Character ASCII

n 110

m 109

s 115

2 50

1 49

<DN> is the distinguished name of the object whose notifications are filtered, and the notifications with
systemDN starting with <DN> are filtered.

For example:

If <DN> is PLMN-1/MSC-1, the notification with the systemDN PLMN-1/MSC-1/abc-2 is filtered. If


<DN> is MSC-1, this notification is not filtered.

Multiple object instances filters are supported, and the distinguished names of the objects are
separated by ,.

For example:

If <DN> is PLMN-1/MSC-1,PLMN-1/OMGW-1, the notification with systemDN PLMN-1/MSC-1/abc-2


and the notification with systemDN PLMN-1/OMGW-1/abc-2 are filtered.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 30


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Besides filtering a specified object instance, the instance in the last object supports the wildcard
character *.

For example:

If <DN> is PLMN-1/MSC-*, all the notifications of MSC under PLMN-1 and its child objects are filtered.

Note:

• If <DN> is *, all notifications are filtered.


• If <DN> contains a comma, it must be separated by single quotation marks, for example,
'PLMN-1/MSC-Street,Town', 'PLMN-1/OMGW-1'.
• The default value is empty. You can remove the filter by setting
the filter to "" as follows:<NBISNMP_VM_FQDN>:16604
1.3.6.1.4.1.28458.1.26.2.1.1.1.1.6.<ascii_nms_name> s <DN>

In case of several filters, when one filter condition is satisfied, then the notification is filtered, for exam-
ple, if the event type filter indicates the filtering of only equipment notifications and environmental noti-
fications, but the object type filter indicates the filtering of some object instances, all notification types
generated by these object instances are filtered.

1.2.3 Setting severity filter


The alarms received by the higher level system can be filtered by severity. The higher level sys-
tem can send a filter request with the following management information base (MIB) fields to NetAct
through SNMP Agent Startport.

Note: When you filter alarms using the severity filter, the alarm severity displayed
corresponds to the Perceived Severity of the alarm.

• SNMP Agent Startport is

<NBISNMP_VM_FQDN>:16604
1.3.6.1.4.1.28458.1.26.2.1.1.1.1.7.<ascii_nms_name> s
<decimal_filter_code>
• <ascii_nms_name> is the name of higher level system in ASCII format. For example, the
ascii_nms_name of nms21 is 110.109.115.50.49 according to the following character and
ASCII mapping. <ascii_nms_name> must be no more than 100 ASCII characters.

Character ASCII

n 110

m 109

s 115

2 50

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 31


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Character ASCII

1 49

Filter code is an eight-digit binary number, and each digit represents the filter choice of one alarm
severity type. If the corresponding digit is 0, alarms of this severity type are not filtered; if the
corresponding digit is 1, alarms of this severity type are filtered.

These eight alarm severity types are listed in order as follows, and they are mapped to eight-digit bina-
ry number from high digit to low digit according to the filtering choice.

Digit position Severity type

1 IndeterminateAlarms

2 ClearedAlarms

3 Warnings

4 MinorAlarms

5 MajorAlarms

6 CriticalAlarms

7 noSeverityFilter

8 filterAllAlarms

Example 2:

The following setting means no severity filter is applied. The filter code is 00000010, and the
decimal_filter_code is 2.

Digit position Severity type Choice

1 IndeterminateAlarms 0

2 ClearedAlarms 0

3 Warnings 0

4 MinorAlarms 0

5 MajorAlarms 0

6 CriticalAlarms 0

7 noSeverityFilter 1

8 filterAllAlarms 0

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 32


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting filters

Note: The default value is noSeverityFilter.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 33


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting USM credential for SNMP v3

2 Setting USM credential for SNMP v3


This section describes how to get and set the User-based Security Model (USM) credential for SNMP
v3.

Note:

SNMP NBI supports two versions: v2c and v3. The default version is v3. For more informa-
tion, see Configurable items.

To get USM credential

1. Log in as the omc user to the NetAct VM where the nbisnmp service is running, and then switch to
the root user.

Note: To locate the right VM, see Locating the right virtual machine for a service in Ad-
ministering NetAct Virtual Infrastructure.

2. Run USM management tool with the following command:


[root]# /opt/oss/NSN-nbisnmp/bin/nbisnmpd usm

Expected Output:

NBISNMP User-based Security Model management tool


1. Get USM user's credential
2. Set USM user's credential
3. Change security level
4. Change USM username
5. Exit
Enter the choice:

3. Enter 1 to get the default USM user's credential.

Example output:

User name: snmpnbuser


Authentication protocol: SHA
Authentication passphrase: ********
Privacy protocol: AES128
Privacy passphrase: ********
security level: authPriv

To set USM credential

1. Log in as the omc user to the NetAct VM where the nbisnmp service is running, and then switch to
the root user.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 34


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting USM credential for SNMP v3

Note: To locate the right VM, see Locating the right virtual machine for a service in Ad-
ministering NetAct Virtual Infrastructure.

2. Run USM management tool with the following command:

[root]# /opt/oss/NSN-nbisnmp/bin/nbisnmpd usm

Expected Output:

NBISNMP User-based Security Model management tool


1. Get USM user's credential
2. Set USM user's credential
3. Change security level
4. Change USM username
5. Exit
Enter the choice:

Note:

Besides setting USM credential, you can also get USM credential, change security level
and change USM username with USM management tool.

Before changing the security level, make sure you have set the authentication and priva-
cy protocol, as well as their passphrases.

The default SNMP username is snmpnbuser.

3. Enter 2 to set USM user's credential.

Expected output:

Choose authentication protocol:


1. SHA
2. MD5
3. No authentication
Enter the choice [1]:

Note:

If the current version of SNMP NBI is v2c, the expected output is as below.

Active SNMP version is v2c. Do you want to change to v3 now?


[Y/N]:

Note:

Two authentication protocols, MD5 and SHA, are supported. The default protocol is SHA.
You can choose the default protocol by pressing Enter directly. If you choose either MD5
or SHA, you need to set a passphrase.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 35


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting USM credential for SNMP v3

4. Enter 1 or press Enter to choose SHA as the authentication protocol.

Expected output:

Enter authentication pass phrase (the minimum length is 8 characters):


Retype authentication pass phrase (the minimum length is 8
characters):

5. Enter an authentication passphrase as your choice.

Note: The password accepts alphanumeric characters and special characters including
~`!@#$%^&*()-_+=|:;,.<>?/.

Expected output:

Choose privacy protocol:


1. AES128
2. AES192
3. AES256
4. DES
5. DESEDE
6. No privacy
Enter the choice [1]:

Note:

Five privacy protocols are supported. The default protocol is AES128. You can choose
the default protocol by pressing Enter directly. You need to set a passphrase after choos-
ing any of the five protocols.

6. Enter 1 or press Enter to choose AES128 as the privacy protocol.

Expected output:

Enter privacy pass phrase (the minimum length is 8 characters):


Retype privacy pass phrase (the minimum length is 8 characters):

7. Enter a privacy passphrase as your choice.

Note: The password accepts alphanumeric characters and special characters including
~`!@#$%^&*()-_+=|:;,.<>?/.

Expected output:

1. noAuthNoPriv
2. authNoPriv
3. authPriv
Enter the choice [3]:

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 36


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Setting USM credential for SNMP v3

Note:

This step is to configure the security level.

If you chose No authentication in step 3, you can only choose noAuthNoPriv.

If you chose MD5 or SHA in step 3, you can choose noAuthNoPriv or authNoPriv.

If you chose MD5 or SHA in step 3, and any of the five privacy protocols (DES, DESEDE,
AES128, AES192 and AES256) in step 5, you can choose any of the three security lev-
els.

8. Enter 3 to choose authPriv as the security level.

Expected output:

Need restart nbisnmp service to take this change effect. Restart it


now? [Y/N]:

9. Enter Y to restart the service.

Note:

The changes will take effect after the restart.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 37


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

3 Configuring notification enrichment function


This section describes how to enable the SNMP notification enrichment function.

Note: By default, notification enrichment function is disabled. Enabling this function may re-
duce the SNMP NBI notification forwarding throughput. When the notification forwarding
speed is 1000 events per second, the forwarding speed will be reduced if the SNMP notifi-
cation enrichment function is enabled. However, when the notification forwarding speed is
lower than 600 events per second, enabling this function has no impact on the forwarding
speed.

To enable notification enrichment function

1. Log in as the omc user to the NetAct VM where the nbisnmp service is running.

Note: To locate the right VM, see Locating the right virtual machine for a service in Ad-
ministering NetAct Virtual Infrastructure.

2. Open the /etc/opt/oss/global/nbisnmp/conf/mf-conf/


snmp_notification_enrichment.xml file by entering:

[omc]$ cd /etc/opt/oss/global/nbisnmp/conf/mf-conf/

[omc]$ vi snmp_notification_enrichment.xml
3. In the snmp_notification_enrichment.xml file, change the value of support to true for
the notifications which you want to enable the enrichment function.

Note: When the value of support is changed to true, a key-value pair is added as the
value for the nbiOptionalInformation field in the related notification. For exam-
ple, nbiOptionalInformation="NEName=my name is WBTS|originalAlar-
mId=12345678".

The following is an example snmp_notification_enrichment.xml file which


enables the enrichment function of nbiAlarmNewNotification. In this example,
controlObjMR, enrichmentTag, and relatedDNs are excluded and the default
value of NEName is set to "Flexi NG". For more information on the configurable
items in the snmp_notification_enrichment.xml file, see Supported items in
snmp_notification_enrichment.xml file.

<?xml version="1.0" encoding="UTF-8"?>


<snmpNotificationEnrichment xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance"
xsi:noNamespaceSchemaLocation="snmp_notification_enrichment.
xsd">
<nbiAlarmNewNotification>
<NEName default="Flexi NG" support="true"/>
<originalAlarmId support="true"/>

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 38


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

<maintenanceRegion default="" support="true"/>


<siteObjName default="" support="true"/>
<siteObjDN default="" support="true"/>
<siteObjAddress default="" support="true"/>
<controlObjName default="" support="true"/>
<controlObjSiteAddress default="" support="true"/>
<controlObjMR default="" support="false"/>
<originalSeverity support="true"/>
<probableCauseText support="true"/>
<maintenanceRegionDN default="" support="true"/>
<alarmCount support="true"/>
<enrichmentTag support="false"/>
<relatedDNs support="false"/>
</nbiAlarmNewNotification>
<nbiAlarmChangedNotification>
<NEName default="" support="false"/>
<originalAlarmId support="false"/>
<maintenanceRegion default="" support="false"/>
<siteObjName default="" support="false"/>
<siteObjDN default="" support="false"/>
<siteObjAddress default="" support="false"/>
<controlObjName default="" support="false"/>
<controlObjSiteAddress default="" support="false"/>
<controlObjMR default="" support="false"/>
<originalSeverity support="false"/>
<probableCauseText support="false"/>
<maintenanceRegionDN default="" support="false"/>
<alarmCount support="false"/>
<enrichmentTag support="false"/>
<relatedDNs support="false"/>
</nbiAlarmChangedNotification>
<nbiAlarmAckChangedNotification>
<NEName default="" support="false"/>
<originalAlarmId support="false"/>
<maintenanceRegion default="" support="false"/>
<siteObjName default="" support="false"/>
<siteObjDN default="" support="false"/>
<siteObjAddress default="" support="false"/>
<controlObjName default="" support="false"/>
<controlObjSiteAddress default="" support="false"/>
<controlObjMR default="" support="false"/>
<originalSeverity support="false"/>
<probableCauseText support="false"/>
<maintenanceRegionDN default="" support="false"/>
<enrichmentTag support="false"/>
</nbiAlarmAckChangedNotification>
<nbiAlarmClearedNotification>
<NEName default="" support="false"/>
<originalAlarmId support="false"/>
<maintenanceRegion default="" support="false"/>

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 39


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

<siteObjName default="" support="false"/>


<siteObjDN default="" support="false"/>
<siteObjAddress default="" support="false"/>
<controlObjName default="" support="false"/>
<controlObjSiteAddress default="" support="false"/>
<controlObjMR default="" support="false"/>
<originalSeverity support="false"/>
<probableCauseText support="false"/>
<maintenanceRegionDN default="" support="false"/>
<enrichmentTag support="false"/>
</nbiAlarmClearedNotification>
<nbiAlarmSyncNotification>
<NEName default="" support="false"/>
<originalAlarmId support="false"/>
<maintenanceRegion default="" support="false"/>
<siteObjName default="" support="false"/>
<siteObjDN default="" support="false"/>
<siteObjAddress default="" support="false"/>
<controlObjName default="" support="false"/>
<controlObjSiteAddress default="" support="false"/>
<controlObjMR default="" support="false"/>
<originalSeverity support="false"/>
<probableCauseText support="false"/>
<maintenanceRegionDN default="" support="false"/>
<alarmCount support="false"/>
<enrichmentTag support="false"/>
<relatedDNs support="false"/>
</nbiAlarmSyncNotification>
<nbiCreateNotification>
<NEName default="" support="false"/>
<vendor default="" support="false"/>
<version default="" support="false"/>
<maintenanceRegion default="" support="false"/>
<siteObjName default="" support="false"/>
<siteObjDN default="" support="false"/>
<siteObjAddress default="" support="false"/>
<enrichmentTag support="false"/>
</nbiCreateNotification>
<nbiTopologySyncNotification>
<NEName default="" support="false"/>
<vendor default="" support="false"/>
<version default="" support="false"/>
<maintenanceRegion default="" support="false"/>
<siteObjName default="" support="false"/>
<siteObjDN default="" support="false"/>
<siteObjAddress default="" support="false"/>
<enrichmentTag support="false"/>
</nbiTopologySyncNotification>
</snmpNotificationEnrichment>

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 40


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

The following table lists the supported items in snmp_notification_enrichment.xml file to


configure the notification enrichment function.

Items Description Example

NEName It represents a user-friendly name Flexi NG


of the network element which gen-
erates the notification.

By default, the value of Name set in


Alarm List tool is used. However, if
the value of Name set in Alarm List
tool is empty, the value of default
attribute of NEName set in snmp_
notification_enrichment.
xml is used.

siteObjAddress Address of the site object. For a notification from PLMN-


PLMN/RNC-1/WBTS-1, if the
If the address of the site object
site for WBTS is set to SITEC-1/
does not exist, the value of default
SITE-1, the siteObjAddress is
attribute of siteObjAddress
the address of SITEC-1/SITE-1.
set in snmp_notification_
enrichment.xml is used.

siteObjName Name of the site object. For a notification from PLMN-


PLMN/RNC-1/WBTS-1, if the
If the name of the site object does
site for WBTS is set to SITEC-1/
not exist, the value of default
SITE-1, the siteObjName is the
attribute of siteObjName set
name of SITEC-1/SITE-1.
in snmp_notification_
enrichment.xml is used.

siteObjDN Distinguished name of the site ob- For a notification from PLMN-
ject, which the alarming object be- PLMN/RNC-1/WBTS-1, if
longs to, in the NetAct format. the site for WBTS is set to
SITEC-1/SITE-1, the siteObjDN
If the distinguished name of the
is SITEC-1/SITE-1.
site object does not exist, the value
of default attribute of siteObjDN
set in snmp_notification_
enrichment.xml is used.

controlObjSiteAddress The site address of the controlling For a notification from PLMN-
object instance. Controlling object PLMN/RNC-1/WBTS-1, if the
means the object plays an agent controlling object for WBTS is
role from NetAct point of view. It for- set to the parent RNC, and the
wards the notification information site of PLMN-PLMN/RNC-1 is

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 41


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

Items Description Example


originated from subordinate net- set to SITEC-1/SITE-1, the con-
work resources. trolObjSiteAddress is the ad-
dress of SITEC-1/SITE-1.
If the site address of the controlling
object instance does not exist,
the value of default attribute of
controlObjSiteAddress
set in snmp_notification_
enrichment.xml is used.

controlObjMR The maintenance region (MR) of For a notification from PLMN-


the controlling object instance. PLMN/RNC-1/WBTS-1, if the
controlling object for WBTS is
If the maintenance region of the
set to the parent RNC, and the
controlling object instance does not
maintenance region for PLMN-
exist, the value of default attribute
PLMN/RNC-1 is set to MRC-1/
of controlObjMR set in snmp_
MR-1, the controlObjMR is the
notification_enrichment.
name of MRC-1/MR-1.
xml is used.

controlObjName The name of the controlling object For a notification from PLMN-
instance. PLMN/RNC-1/WBTS-1, if the
controlling object for WBTS is
If the name of the controlling
set to the parent RNC, the con-
object instance does not exist,
trolObjName is the name of
the value of default attribute of
PLMN-PLMN/RNC-1.
controlObjName set in snmp_
notification_enrichment.
xml is used.

probableCauseText The probable cause of an alarm For an alarm notification gener-


raised by a network element. ated by a network element as a
result of high temperature, the
The probable cause of an alarm is
respective probableCause-
represented in a textual format. The
Text is the value of proba-
probable cause text corresponds
baleCauseText set in the
to the probable cause code of the
Alarm List tool.
alarm.

originalSeverity The original severity of an alarm For an alarm notification raised


raised by a network element. with major severity, the per-
ceived severity is Major and
It represents the severity with which
the original severity is the value
the alarm was raised initially.
of originalSeverity set in
the Alarm List tool.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 42


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

Items Description Example


Note:

• The per-
ceivedSever
ity of an alarm is
the current sever-
ity.
• The origi-
nalSeverity
of an alarm is
the severity with
which the alarm
was raised initial-
ly.
• When an alarm
is acknowl-
edged, there is
no change in the
severity of the
alarm.
• When an alarm
is cleared, the
perceivedSev-
erity of the
alarm changes to
clear.
• When an alarm is
raised with Major
severity, the fol-
lowing applies:

– The per-
ceivedSe
verity is
Major and
the origi-
nalSeveri-
ty is Inde-
terminate.
– When the
severity of
the alarm is
changed to

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 43


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

Items Description Example


Critical,
the per-
ceivedSe
verity
is Crit-
ical and
the origi-
nalSeveri-
ty is Major.
– When the
alarm is ac-
knowledged,
the per-
ceivedSe
verity
is Crit-
ical and
the origi-
nalSeveri-
ty is Major.
– When the
alarm is
cleared,
the per-
ceivedSe
verity is
Clear and
the origi-
nalSeveri-
ty is Major.

maintenanceRegionDN The distinguished name (DN) of For an alarm notification from


the maintenance region (MR) to PLMN-5/BSC-5/BCF-5 associ-
which the network element raising ated with the maintenance re-
an alarm is associated. gion MRC-5/MR-5, the main-
tenanceRegionDN value is
MRC-5/MR-5.

maintenanceRegion Maintenance region (MR) name of For a notification from PLMN-


the alarming object. PLMN/RNC-1/WBTS-1, if the
maintenance region for WBTS
If the maintenance region name
is set to MRC-1/MR-1, the main-
of the alarming object does

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 44


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

Items Description Example


not exist, the value of default tenanceRegion is the name of
attribute of maintenanceRegion MRC-1/MR-1.
set in snmp_notification_
enrichment.xml is used.

originalAlarmId Running number given to each no- 12345678


tification by the network element to
correlate notifications.

The value of Notification ID


set in Alarm List tool is used.

If the running number does not


exist, an empty string, which is
originalAlarmId=, is used.

vendor The manufacturer of the network el- Nokia


ement.

If the manufacturer of the network


element does not exist, the value
of default attribute of vendor
set in snmp_notification_
enrichment.xml is used.

version The version of the network element. 1.0

If the version of the network


element does not exist, the value
of default attribute of version
set in snmp_notification_
enrichment.xml is used.

alarmCount The number of occurrences of the 1


same alarm raised by the same
network element.

The value of Instance Count set


in Alarm List tool is used.

If the number of occurrences of


the alarm does not exist, an empty
string, which is alarmCount=, is
used.

enrichmentTag Enrichment tag based on working For a notification from PLMN-


set to identify O&M data. PLMN/RNC-1/WBTS-1, if

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 45


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

Items Description Example


the notification DN matches
the LTE tag configured in the
enrichment_tag_mapping.
xml file, the enrichmentTag is
LTE.

relatedDNs Related DN to identify relationship For a notification from PLMN-


of infra (CBIS or CBAM) objects PLMN/CBIS-1/COMPUTE-1,
with virtual (VNF) objects. the relatedDNs attribute is
PLMN-PLMN/CBIS-1/COM-
Note: It only applies to
PUTE-1, PLMN-PLMN/
nbiAlarmNewNotifica-
CBAM-1/VNFS-1/VNF-
tion, nbiAlarmChanged-
CBAM-520434bfcc3a42b88dee64c179ae1cc
Notification, and nbiAlar-
PLMN-PLMN/IMSNFM-1/RE-
mSyncNotification.
POSERVER-02.

The Telco Cloud alarm enrichment


feature must be activated in ad-
vance if the external NMS needs
to get the value from SNMP NBI.
To activate the Telco Cloud alarm
enrichment feature, see Enabling
Telco Cloud alarm enrichment fea-
ture in Administering Fault Manage-
ment.

Table 12: Supported items in snmp_notification_enrichment.xml file

3.1 Configuring the notification enrichment tag


This section provides the instructions on how to configure the enrichment tag.

Note: This function must be enabled by configuring the


snmp_notification_enrichment.xml file. About how to enable this function, see
Configuring notification enrichment function.

1. Log in as the omc user to the NetAct VM where the nbisnmp service is running.

Note:

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 46


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

To locate the right VM, see Locating the right virtual machine for a service in Administer-
ing NetAct Virtual Infrastructure.

2. Open the /etc/opt/oss/global/nbisnmp/conf/mf-conf/


enrichment_tag_mapping.xml file by entering:

[omc]$ vi /etc/opt/oss/global/nbisnmp/conf/mf-conf/
enrichment_tag_mapping.xml

3. In the enrichment_tag_mapping.xml file, configure the enrichment tag according to the


following description:

Element Description Occurrence

tags This element describes the root element of the 1...1


configuration file.

tag The element content of tags describes the map- 0...20


ping relationship between the enrichment tag
and working set.

workingSet The element content of tag describes the work- 1... 20


ing set name and the match mode.

To configure a working set, see Viewing the


list of working sets and managing working sets
content in CM Editor Help .

Table 13: Description of the element in the enrichment_tag_mapping.xml file

Occur-
Element Attribute Description Example
rence

tag name This attribute describes the value mandato- name="LTE"


of the tag. ry

workingSet mode This attribute describes the mandato- mode="full"


match mode of a working set. ry
The valid value is full or
prefix.

• full: the distinguished


name (DN) of a notification
existing in a working set.
• prefix: the distinguished
name of a notification or

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 47


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

Occur-
Element Attribute Description Example
rence

its ancestors existing in a


working set.

Table 14: Description of the attribute in the enrichment_tag_mapping.xml file

Example 1 of the enrichment_tag_mapping.xml file:

<?xml version="1.0" encoding="UTF-8"?>


<tags>
<tag name="LTE">
<workingSet matchMode="prefix" name="WORKINGSET_NAME_LTE"/>
</tag>
<tag name="VNF">
<workingSet matchMode="full" name="WORKINGSET_NAME_VNF"/>
</tag>
</tags>

In the example 1, the tag LTE and VNF are configured. If the DN of the notification matches the
rule of working set WORKINGSET_NAME_LTE in the prefix mode, the notification sent to higher
level system contains the enrichment tag LTE in the element nbiOptionalInformation as
follows:

nbiOptionalInformation="enrichmentTag=LTE"

If the DN of notification matches the rule of working set WORKINGSET_NAME_VNF in full


mode, the notification sent to the higher level system includes the tag VNF in the element
nbiOptionalInformation as follows

nbiOptionalInformation="enrichmentTag=VNF"

Example 2 of the enrichment_tag_mapping.xml file:


<?xml version="1.0" encoding="UTF-8"?>
<tags>
<tag name="LTE">
<workingSet matchMode="prefix" name="WORKINGSET_NAME1_LTE"/>
<workingSet matchMode="prefix" name="WORKINGSET_NAME2_LTE"/>
</tag>
</tags>

In the example 2, the tag LTE is configured. If the DN matches the rule of working set
WORKINGSET_NAME1_LTE or WORKINGSET_NAME2_LTE in the prefix mode, the
notification sent to higher level system contains the enrichment tag LTE in the element
nbiOptionalInformation as follows:

nbiOptionalInformation="enrichmentTag=LTE"

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 48


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

Note:

• The configuration changes take effect automatically after one minute without
restarting the nbisnmp service.
• For modifying working set in Working Set Manager, or after new network elements
are integrated, the changes of working set rule take effect after 24 hours at most. To
make the changes take effect immediately, do the following:

1. Log in as the omc user to the NetAct VM where the nbicom service is running.
2. Refresh the cache manually by entering:
[omc]$ /opt/oss/Nokia-nbicom/bin/
nbicom_cache_refresh_tool.sh -r

An example output:

Status: ACCEPTED
Description: refresh is started

3. Check whether the refresh is completed by entering:


[omc]$ /opt/oss/Nokia-nbicom/bin/
nbicom_cache_refresh_tool.sh -q

An example output:

Status: SUCCESS
Description: refresh is successful
Begin time: 2019-07-19T04:22:49+0300
End time: 2019-07-19T04:22:49+0300

3.2 Configuring object hierarchies for notification enrichment


Enrichment lifting function can be activated in NetAct by configuring the
enrichment_hierarchy.cf file. With this function, the enrichment information, such as NEName,
controlObjName, controlObjSiteAddress, controlObjMR, siteObjName, siteObjDN, siteObjAddress
and maintenanceRegion of the optionalInformation attribute for the managed object, can be got
from its ancestors. For more information about the optinalInformation attribute, see Supported alarm
parameters in Functional Specification for SNMP Northbound Interface.

1. Log in as the omc user to the NetAct VM where the nbisnmp service is running.

Note:

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 49


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configuring notification enrichment
function

To locate the right VM, see Locating the right virtual machine for a service in Administer-
ing NetAct Virtual Infrastructure.

2. Open the /etc/opt/oss/global/nbisnmp/conf/mf-conf/enrichment_hierarchy.cf


file by entering:

[omc]$ vi /etc/opt/oss/global/nbisnmp/conf/mf-conf/
enrichment_hierarchy.cf

3. Set the hierarchies.

Example 1:
PLMN/MRBTS

For a notification from PLMN-PLMN/MRBTS-110/LNBTS-101/FTM-5/ETHLK-112, its


object instance matches the object hierarchy PLMN/MRBTS, which is configured in the
enrichment_hierarchy.cf, and the enrichment information comes from PLMN-PLMN/
MRBTS-110.

Example 2:
PLMN/MRBTS
PLMN/MRBTS/LNBTS

For a notification from PLMN-PLMN/MRBTS-110/LNBTS-101/FTM-5/ETHLK-112, its object


instance matches the longest object hierarchy PLMN/MRBTS/LNBTS, which is configured in the
enrichment_hierarchy.cf file, and the enrichment information comes from PLMN-PLMN/
MRBTS-110/LNBTS-101.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 50


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

4 Configurable items
Table 15: Configurable items shows all the configurable items in /etc/opt/oss/global/nbisnmp/
conf/mf-conf/nbi-snmp.properties, and the file is located in NetAct VM where the nbisnmp
service is running. To locate the right VM, see Locating the right virtual machine for a service in
Administering NetAct Virtual Infrastructure.

Note:

You can edit the property file with omc permission. However, you need to restart SNMP NBI
service for some items before the changes can take effect. To restart SNMP NBI service,
first stop nbisnmp service, and then start nbisnmp service. For detailed instruction, see
Stopping SNMP NBI in Administering SNMP Northbound Interface and Starting SNMP NBI in
Administering SNMP Northbound Interface.

Restart SNMP NBI service for the following items before the changes can take effect.

Configurable item Explanation Default value

snmp.version.control SNMP version control. snmp.version.control=v3


The possible values are
v2c and v3.

communitymib.community_name. Community string for communitymib.community_name.


read SNMP read operations, read=public
such as SNMP GET.
Note:

This value is used to iden-


tify read access authenti-
cation. This value should
not be the same as the
value of communitymib.
community_name.write.

communitymib.community_name. Community string for communitymib.community_name.


write SNMP write operations, write=private
such as SNMP SET.
Note:

This value is used to iden-


tify write access authenti-
cation. This value should
not be the same as the
value of communitymib.
community_name.read.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 51


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value

com.nsn.oss.nbi.snmp.cache.size This value defines the com.nsn.oss.nbi.snmp.cache.


number of notifications size=1000
that can be stored in
the buffer which stores
the latest notifications
sent to the higher level
system. In case of lost
notifications because
of, for example, DCN
problems, it improves
the efficiency of resend-
ing such notifications.
The range of the cache
size is 100 to 2000 (no-
tifications), and the de-
fault value is 1000.

Note: This
buffer is
memory-con-
suming, so it
should be set
to a reason-
able value.
For exam-
ple, for a 1G
JVM memory,
the maximum
size is 2000.

com.nsn.oss.nbi.snmp.integrating. This item can be com.nsn.oss.nbi.snmp.integrating.


by.register.request.enable switched to support us- by.register.request.enable=true
ing SNMP SET request
to integrate higher level
system, and using SN-
MP GET/WALK request
to check the integrated
higher level system in-
formation.

The value of this item is


true or false.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 52


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


If the value is true,
NetAct can integrate
the higher level system
through SNMP request.

If the value is false,


NetAct SNMP NBI
cannot integrate higher
level system through
SNMP requests.

Table 15: Configurable items

The following items will take effect automatically after the changing without restarting service.

Configurable item Explanation Default value

com.nsn.oss.nbi.snmp. Time period to synchronize the reg- com.nsn.oss.nbi.snmp.registeredN-


registeredNMS.synchro- istered higher level system informa- MS.synchronization.period=10
nization.period tion. The unit is second. Valid time
period is 1 to 900, and the default
value is 10.

com.nsn.oss.nbi.snmp. This value defines the separator com.nsn.oss.nbi.snmp.trap.separa-


trap.separator character used to split the text in tor=|
nbiSpecificProblem, nbi-
Note: Support characters
AdditionalText and nbiOp-
are "|", "!", "#", "%" and
tionalInformation fields of
"^".
NSN-SNMP-NBI-FAULTMANAGE-
MENT-MIB.

com.nsn.oss.nbi.snmp. This value defines if nbiSpeci- com.nsn.oss.nbi.snmp.trap.speci-


trap.specificproblem.flag ficProblem is included in alarm ficproblem.flag=1
acknowledge and alarm clear
notifications. If the value is 0,
nbiSpecificProblem is not in-
cluded; if the value is 1, it is includ-
ed.

com.nsn.oss.nbi.snmp. This value defines if nbiSpeci- com.nsn.oss.nbi.snmp.trap.speci-


trap.specificproblem. ficProblem contains alarm- ficproblem.alarmtext.flag=1
alarmtext.flag Text in nbiAlarmAckChanged-
Notification and nbiAlarm-
ClearedNotification. If the
value is 0, the alarmText does

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 53


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


not appear. If the value is 1, the
alarmText appears.

Note: This item works


only when the value of
com.nsn.oss.nbi.snmp.
trap.specificproblem.flag
is 1.

com.nsn.oss.nbi.snmp.en- The waiting time for the enrichment com.nsn.oss.nbi.snmp.enrich.


rich.cachecheck.period modification to take effect. The unit cachecheck.period=5
is second. The valid range is 5 to
60.

com.nsn.oss.nbi.snmp. The default value for nbiAckSys- com.nsn.oss.nbi.snmp.systemid.


systemid.nms temId and nbiClearSystemId. It will nms=
be filled in alarm notifications if the
Note:
higher level system does not pro-
vide it.

The default value is empty.

com.nsn.oss.nbi.snmp. The default value for nbiAckSys- com.nsn.oss.nbi.snmp.systemid.


systemid.netact temId and nbiClearSystemId. It will netact=NetAct
be filled in alarm notifications if the
alarm is acknowledged or cleared
on NetAct Alarm List application.

com.nsn.oss.nbi.snmp. The default value for nbiAckSys- com.nsn.oss.nbi.snmp.systemid.


systemid.ne temId and nbiClearSystemId. It will ne=NE
be filled in alarm notifications if the
alarm is acknowledged or cleared
on network elements.

com.nsn.oss.nbi.snmp. The default value for nbiAckUser com.nsn.oss.nbi.snmp.user.ne=NE


user.ne and nbiClearUser. It will be filled in
alarm notifications if the alarm is
acknowledged or cleared on net-
work elements.

com.nsn.oss.nbi.snmp.on- Enable or disable topology related com.nsn.oss.nbi.snmp.


lyFMsupported functions. onlyFMsupported=true

The possible value is true


or false. To be backwards

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 54


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


compatible, the default value is
true.

If the value is true, only FM


related traps are supported.

If the value is false, all


SNMP NBI functions are
supported. That means,
besides FM related functions,
topology related functions,
including nbiCreateNotification,
nbiDeleteNotification and
nbiTopologySyncNotification, are
supported.

com.nsn.oss.nbi.snmp. Enable or disable alarm change no- com.nsn.oss.nbi.snmp.alarm-


alarmchange.enable tification related functions. change.enable=false

The possible values are true


and false. To be backwards
compatible, the default value is
false.

If the value is true,


nbiAlarmChangedNotification traps
are supported.

If the value is false,


nbiAlarmChangedNotification traps
are not supported.

com.nsn.oss.nbi.fm.filterId ID of the applied filtering rule. For com.nsn.oss.nbi.fm.filterId=0


instruction on creating a filtering
rule, see Creating a filtering rule in
Rule Explorer Help.

com.nsn.oss.nbi.fm.corre- This value defines the range of com.nsn.oss.nbi.fm.correlationFil-


lationFilterResult alarms which SNMP NBI forwards terResult=0
to the higher level system. If the
value is 0, only root cause alarms
are forwarded; if the value is 1, all
alarms are forwarded.

com.nsn.oss.nbi.snmp. Enable or disable the function to com.nsn.oss.nbi.snmp.alarm.ne-


alarm.netimezone.sup- show the time zone of network ele- timezone.supported=false
ported

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 55


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


ment or NetAct time zone in alarm
notification.

The possible value is true


or false. To be backwards
compatible, the default value is
false.

If the value is true, nbiAlarmTime,


nbiAckTime and nbiClearTime
show the time zone of network
element in alarm notification.

If the value is false,


nbiAlarmTime, nbiAckTime and
nbiClearTime show NetAct time
zone in alarm notification.

com.nsn.oss.nbi.snmp. This item can enable or disable the com.nsn.oss.nbi.snmp.standard.


standard.eos.notification. standard notification RequestType eos.notification.type.enable=false
type.enable in eos.

The possible value is true or


false.

If the value is false, the eos of


operation will use the backwards
compatible format.

If the value is true, the eos of


operation will use MIB standard
format.

com.nsn.oss.nbi.snmp. Enable or disable the event logging The com.nsn.oss.nbi.


fm.eventLogging.logre- function for logging Fault Manage- snmp.fm.eventLogging.
cievednotification ment (FM) events that are received logrecievednotification
at SNMP NBI. property is not present by default
in the /etc/opt/oss/global/
The possible values are true and
nbisnmp/conf/mf-conf/nbi-
false.
snmp.properties file.
If the value is set to true,
The following is a sample nbi-
the events received from
snmp.properties file in
FM are logged and stored in
which com.nsn.oss.nbi.
the /var/opt/oss/log/
snmp.fm.eventLogging.
nbisnmp/fmevent/received/
AlarmEvent.log.* file.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 56


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


When the com.nsn.oss.nbi. logrecievednotification is
snmp.fm.eventLogging. configured and enabled:
logrecievednotification
event logging function is enabled, com.nsn.oss.nbi.
snmp.standard.eos.
the following attributes are logged
notification.type.
in the AlarmEvent.log.* file for
enable = false
an FM event received at SNMP com.nsn.oss.nbi.
NBI: snmp.fm.eventLogging.
logrecievednotification
• Timestamp
= true
• AlarmNotificationType
com.nsn.oss.nbi.snmp.
• DN alarm.netimezone.
• AlarmId supported = false
• SpecificProblem
• EventTime
• PerceivedSeverity
• ProbableCauseCode

The following is a sample output


of the AlarmEvent.log.* file for
a new alarm notification received
event:

Timestamp;AlarmNotificati
onType;DN;AlarmId;Specifi
cProblem;EventTime;
PerceivedSeverity;Probabl
eCauseCode
2021-12-03 10:59:20.
522;ALARM_NEW;PLMN-
1/BSC-1/BCF-1;
321;7555;2021-12-
03T10:59:17+02:00;minor;
123;

Note: If an event re-


ceived at SNMP NBI
does not contain any
of the attributes listed
above, then the cor-
responding attribute
is displayed as [At-
tribute Not Sup-
ported] in the output of

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 57


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


the AlarmEvent.log.
* file.

Timestamp;AlarmNo
tificationType;DN;
AlarmId;SpecificP
roblem;EventTime;
PerceivedSeverity;
ProbableCauseCode
2021-12-06
08:39:59.
068;ALARM_
LIST_REBUILT;
[Attribute
Not Supported];
[Attribute Not
Supported];0;2021
-12-
06T08:39:58+02:00
;critical;0;

Note: In NetAct Small


configuration, it is recom-
mended to configure the
maxBackupZipIndex
value as 10 for the Re-
ceivedEventAppen-
der appender in the /
d/oss/global/etc/
nbisnmp/conf/mf-
conf/log4j-nbisn-
mp-event_logger.
xml file.

The SNMP NBI service


must be restarted to
make changes to the
maxBackupZipIndex
effective.

com.nokia.oss.nbi.nbis- Enable or disable the event log- The com.nokia.oss.nbi.


nmp.fm.eventlogging. ging function for logging Fault Man- nbisnmp.fm.eventlogging.
sendEventLogging.en- agement (FM) events that are sent sendEventLogging.enabled
abled from SNMP NBI to the higher level property is not present by default
system. in the/etc/opt/oss/global/

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 58


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


The possible values are true and nbisnmp/conf/mf-conf/nbi-
false. snmp.properties file.

When the com.nokia.oss.nbi. The following is a sample nbi-


nbisnmp.fm.eventlogging. snmp.properties file in
sendEventLogging.enabled which com.nokia.oss.nbi.
event logging function is enabled, nbisnmp.fm.eventlogging.
the following attributes are logged sendEventLogging.enabled is
in the /var/opt/oss/log/ configured and enabled:
nbisnmp/fmevent/sent/
AlarmEvent.log.* file for an FM com.nsn.oss.nbi.
snmp.standard.eos.
event sent from SNMP NBI to the
notification.type.
higher level system:
enable = false
• time_stamp com.nokia.oss.nbi.
• event_type nbisnmp.fm.eventlogging.
sendEventLogging.
• nbiObjectInstance
enabled = true
• nbiSpecificProblem com.nsn.oss.nbi.snmp.
• nbiAlarmId alarm.netimezone.
supported = false
The following is a sample default
output of the AlarmEvent.log.*
file for a new alarm notification sent
event:

time_stamp;event_
type;nbiObjectInstance;
nbiSpecificProblem;
nbiAlarmId;
2021-12-03 12:52:27.591;
nbiAlarmNewNotification;
PLMN-1/BSC-1/BCF-1;7560|
Alarm text;326

Note: In NetAct Small


configuration, it is rec-
ommended to configure
the maxBackupZipIn-
dex value as 10 for
the EventAppender
appender in the /d/
oss/global/etc/
nbisnmp/conf/mf-
conf/log4j-nbisn-

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 59


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


mp-event_logger.
xml file.

The SNMP NBI service


must be restarted to
make changes to the
maxBackupZipIndex
effective.

com.nokia.oss.nbi.nbisn- The attributes of an event The com.nokia.oss.nbi.


mp.fm.eventlogging.attrib- to be logged and displayed nbisnmp.fm.eventlogging.
utes in the event logging output attributes property is not
when com.nokia.oss.nbi. present by default in the /etc/
nbisnmp.fm.eventlogging. opt/oss/global/nbisnmp/
sendEventLogging.enabled conf/mf-conf/nbi-snmp.
event logging function is enabled. properties file.

For example: The following is a sample nbi-


snmp.properties file in which
com.nokia.oss. com.nokia.oss.nbi.nbisnmp.
nbi.nbisnmp.fm.
fm.eventlogging.attributes
eventlogging.attributes
is configured:
= time_stamp;event_
type;nbiObjectInstance;
com.nsn.oss.nbi.
nbiSpecificProblem;
snmp.standard.eos.
nbiAlarmId;
notification.type.
enable = false
Each attribute must be separated
com.nokia.oss.nbi.
by a semicolon ;. nbisnmp.fm.eventlogging.
The configured value of com. sendEventLogging.
enabled = true
nokia.oss.nbi.nbisnmp.fm.
com.nsn.oss.nbi.snmp.
eventlogging.attributes
alarm.netimezone.
is used as the output of the / supported = false
var/opt/oss/log/nbisnmp/ com.nokia.oss.
fmevent/sent/AlarmEvent. nbi.nbisnmp.fm.
log.* file. eventlogging.attributes
= time_stamp;event_
type;nbiObjectInstance;
nbiSpecificProblem;
nbiAlarmId;

Note:

If the com.nokia.
oss.nbi.nbisnmp.

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 60


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


fm.eventlogging.
attributes property
is not present and the
com.nokia.oss.
nbi.nbisnmp.fm.
eventlogging.
sendEventLogging.
enabled event
logging function is
enabled, then only the
default attributes of an
event, namely time_
stamp, event_type,
nbiObjectInstance,
nbiSpecificProblem,
and nbiAlarmId are
displayed in the event
logging output.

The com.nokia.oss.nbi.
nbisnmp.fm.eventlogging.
attributes property also
supports logging and displaying the
following additional attributes in the
event logging output:

• nbiEventTime
• nbiPerceivedSeverity
• nbiProbableCause
• nbiAlarmType
• nbiSequenceId
• nms

For example, if the user configures


the additional attributes listed
above along with the default
attributes in com.nokia.
oss.nbi.nbisnmp.fm.
eventlogging.attributes,
then the following is a sample
output of the /var/opt/oss/
log/nbisnmp/fmevent/sent/

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 61


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


AlarmEvent.log.* file for a new
alarm notification sent event:

time_stamp;event_
type;nbiObjectInstance;
nbiEventTime;
nbiSpecificProblem;
nbiAlarmId;
nbiPerceivedSeverity;
nbiProbableCause;
nbiAlarmType;
nbiSequenceId;nms;
2021-12-03 12:52:27.
591;nbiAlarmNewNotificati
on;PLMN-1/BSC-1/BCF-
1;2021-12-3,12:52:27.
4,+2:0;7560|Alarm
Text;326;2;123;3;402;nms1

Note: The com.nokia.


oss.nbi.nbisnmp.
fm.eventlogging.
attributes property
supports only the follow-
ing attributes:

• time_stamp
• event_type
• nbiObjectIn-
stance
• nbiEventTime
• nbiSpecificProb
lem
• nbiAlarmId
• nbiPer-
ceivedSeverity
• nbiProbable-
Cause
• nbiAlarmType
• nbiSequenceId
• nms

Note:

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 62


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


• If the user config-
ures any attribute
other than the attrib-
utes listed above,
then only the de-
fault attributes,
namely time_
stamp, event_
type, nbiOb-
jectInstance,
nbiSpecificProb
lem, and nbiAlar-
mId are logged and
displayed in the /
var/opt/oss/
log/nbisnmp/
fmevent/sent/
AlarmEvent.log.
* file.
• The attributes con-
figured in the com.
nokia.oss.nbi.
nbisnmp.fm.
eventlogging.
attributes prop-
erty must be entered
in the following order
only:

com.nokia.oss.
nbi.nbisnmp.fm.
eventlogging.
attributes
= time_
stamp;event_
type;nbiObject
Instance;
nbiEventTime;
nbiSpecific
Problem;
nbiAlarmId;
nbiPerceived

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 63


(VMware) Use subject to agreed restrictions on disclosure and use.
Final
Configuring SNMP Northbound Interface DN0973965 6-0 Configurable items

Configurable item Explanation Default value


Severity;
nbiProbableCau
se;
nbiAlarmType;
nbiSequenceId;
nms;

Table 16: Configurable items

NetAct™ Cloud 22 FP2205 © 2023 Nokia. Nokia Confidential Information 64


(VMware) Use subject to agreed restrictions on disclosure and use.
Final

You might also like