Alarm Threshold and Suppression

Feature Description

Release 14
Document Version 1.4
AlarmThresholdAndSuppressionFD.doc
ExtraView Numbers 10804, 10805

220 Perry Parkway

Gaithersburg, MD USA 20877
Tel +1 301.977.9440
Fax +1 301.977.8846
WWW.BROADSOFT.COM
 BroadWorks® Guide

Copyright Notice
Copyright © 2006 BroadSoft, Inc.
All rights reserved.
Any technical documentation that is made available by BroadSoft, Inc. is proprietary and
confidential and is considered the copyrighted work of BroadSoft, Inc.
This publication is for distribution under BroadSoft non-disclosure agreement only.
No part of this publication may be duplicated without the express written permission of
BroadSoft, Inc. 220 Perry Parkway, Gaithersburg, MD 20877.
BroadSoft reserves the right to make changes without prior notice.

Trademarks
BroadWorks® and BroadWorks Assistant™ are trademarks of BroadSoft, Inc.
Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft
Corporation. Other product names mentioned in this manual may be trademarks or
registered trademarks of their respective companies and are hereby acknowledged.
This document is printed in the United States of America.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 2 OF 33
 Document Revision History

Version Reason for Change Date

0.1 Draft Created document. March 1, 2006

0.2 Draft Updated document for CLI approval. March 2, 2006

0.3 Draft Updated document after interface approvals. March 7, 2006

1.0 Reviewed Updated document after FS review. April 4, 2006

1.1 Approved FS was approved. April 4, 2006

1.2 Edited document. April 19, 2006

1.3 Approved Described what happens when an alarm name is not valid. June 19, 2006

1.4 Edited changes in document. July 11, 2006

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 3 OF 33
 Table of Contents

1 Feature Overview and Purpose ...................................................................................................7

2 Requirements .................................................................................................................................8

3 Detailed Feature Description........................................................................................................9

3.1 Detailed Functional Description ...................................................................................................9
3.1.1 Traplist and Trapfilter...........................................................................................................9
3.1.2 Filtering Considerations.................................................................................................... 11
3.1.3 Filtered Alarms Notification .............................................................................................. 12
3.1.4 Provisioning Alarm Filters................................................................................................. 12
3.2 Pictorial Description................................................................................................................... 17
3.3 Use Cases ................................................................................................................................. 17
3.3.1 Execution Use Cases....................................................................................................... 17
3.3.2 Provisioning Use Cases ................................................................................................... 17
4 Provisioning Impacts...................................................................................................................19
4.1 Configuration Data..................................................................................................................... 19
4.1.1 Alarm Filter........................................................................................................................ 19
4.2 Web Portal Impacts ................................................................................................................... 19
4.3 CLI Impacts................................................................................................................................ 20
4.3.1 Summary........................................................................................................................... 20
4.3.2 Command ......................................................................................................................... 21
4.4 Open Client Interface-Provisioning (OCI-P) Impact................................................................. 24
4.5 OSS Impacts.............................................................................................................................. 24
4.6 Application Server Query User/Query Group Impacts ............................................................ 24
4.7 External Authentication Impacts ............................................................................................... 24
4.8 Application Server Portal API Impacts ..................................................................................... 24
4.9 Network Server Location API Impacts ..................................................................................... 24
4.10 NSSync API Impacts................................................................................................................. 24
4.11 Application Server Dump Impacts ............................................................................................ 24
4.12 Service Details and Licensing................................................................................................... 24
4.13 CDR SOAP Interface ................................................................................................................ 24
4.14 Treatments................................................................................................................................. 24
4.15 Media Announcements (Audio and Video) .............................................................................. 24
5 Accounting Impacts.....................................................................................................................25
5.1 Accounting Management Impacts............................................................................................ 25
6 System Management Impacts....................................................................................................26
6.1 Performance Management Impacts......................................................................................... 26
6.2 Fault Management Impacts ...................................................................................................... 26
6.2.1 New Alarms....................................................................................................................... 26

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 4 OF 33
 6.3 Scripts and Tools....................................................................................................................... 26
7 Execution/Call Processing Impacts ..........................................................................................27
7.1 CAP Interface Impact ................................................................................................................ 27
7.2 SIP/MGCP Interface Impact ..................................................................................................... 27
7.3 Service Interactions ................................................................................................................... 27
8 Deployment/Operational Impacts..............................................................................................28
8.1 Configuration File Impacts ........................................................................................................ 28
8.2 Installation Impacts.................................................................................................................... 28
8.3 Upgrade Impacts ....................................................................................................................... 28
8.4 Rollback Impacts ....................................................................................................................... 28
8.5 Restart Impacts.......................................................................................................................... 28
8.6 Performance Impacts ................................................................................................................ 28
8.7 Security Impacts ........................................................................................................................ 28
8.8 Scheduled Tasks....................................................................................................................... 29
8.9 Third Party Software.................................................................................................................. 29
8.10 Hardware Impacts ..................................................................................................................... 29
9 Restrictions and Limitations ......................................................................................................30

10 Tactical Content Information......................................................................................................31

10.1 Summary of Functional Differences between Patches and Releases ................................... 31
Acronyms and Abbreviations .............................................................................................................32

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 5 OF 33
 Table of Figures

Figure 1 SNMP Agent Alarm Processing Overview ............................................................................... 17

Figure 2 CLI Hierarchy Changes ............................................................................................................. 20

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 6 OF 33
 1 Feature Overview and Purpose

This feature provides the ability to suppress alarms by type so that they are not sent out
via the Simple Network Management Protocol (SNMP) interface and so that they stop
being logged to file on the local server. Alarm suppression is needed because there are
some alarms that provide useful evidence that something went wrong, but are not
necessarily useful if they are sent each time to the Element Management System (EMS).
For instance, Session Initiation Protocol (SIP) device authentication failures are useful to
keep locally on a log file in the Application Server, but an operator may not want to always
see them on the EMS.
This feature also provides the ability to threshold alarms sent over the SNMP interface by
alarm type. The threshold limits the number of alarms sent within a given period of time.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 7 OF 33
 2 Requirements

This feature has no formal requirements.

(R-1) Alarm suppression.

(R-2) Alarm threshold.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 8 OF 33
 3 Detailed Feature Description

3.1 Detailed Functional Description

Alarm suppression and threshold can be viewed as alarm filters. This feature provides
alarm filtering at the BroadWorks SNMP agent level. The BroadWorks servers continue to
generate alarms as they do today. They send the alarms to their SNMP agent (using a
proprietary protocol) and the agent processes them. When the SNMP agent receives an
alarm, it performs the following tasks:
1) It logs the alarm to a local file.
2) It sends the alarm to a trap server which then sends it to all registered trap clients
(such as BroadWorks CLI sessions).
3) It sends an SNMP trap to the provisioned managers.
This feature only performs alarm filtering for points 1) and 3) above. This means that
alarm filtering has no impact on trap clients waiting for alarms.
The feature only provides a mechanism to filter alarms generated by BroadWorks
applications (such as the Application Server XS, Application Server PS, Network Server
XS, Network Server PS, and so on) and BroadWorks process monitors. In other words,
this feature provides alarm filtering for alarms defined under the BroadSoft Object Identifier
(OID).
Alarm filtering occurs at the SNMP agent level and not on a cluster basis.

3.1.1 Traplist and Trapfilter

Currently, each BroadWorks server comes with an XML-encoded traplist file which defines
all the traps that this server can generate. These files are:
BroadWorks Server Traplist File Name

All /usr/local/broadworks/bw_base/conf/commontraplist.xml

Application Server /usr/local/broadworks/bw_base/conf/astraplist.xml

Network Server /usr/local/broadworks/bw_base/conf/nstraplist.xml

Media Server /usr/local/broadworks/bw_base/conf/mstraplist.xml

Element Management System /usr/local/broadworks/bw_base/conf/emstraplist.xml

Web Server /usr/local/broadworks/bw_base/conf/wstraplist.xml

Open Client Server /usr/local/broadworks/bw_base/conf/ocstraplist.xml

Call Detail Server /usr/local/broadworks/bw_base/conf/cdstraplist.xml

All these XML files follow the same format.

Following this model, this feature creates a new trapfilter type of file that includes a new
trapFilter XML block. The feature does not impact or modify the traplist files. Rather it
allows the creation and support of trapfilter files in which a new trapFilter block can be
used to define alarm filters. The new files are:
BroadWorks Server Name Trapfilter File Name

Application Server /usr/local/broadworks/bw_base/conf/astrapfilter.xml

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 9 OF 33
 BroadWorks Server Name Trapfilter File Name

Network Server /usr/local/broadworks/bw_base/conf/nstrapfilter.xml

Media Server /usr/local/broadworks/bw_base/conf/mstrapfilter.xml

Element Management System /usr/local/broadworks/bw_base/conf/emstrapfilter.xml

Web Server /usr/local/broadworks/bw_base/conf/wstrapfilter.xml

Open Client Server /usr/local/broadworks/bw_base/conf/ocstrapfilter.xml

Call Detail Server /usr/local/broadworks/bw_base/conf/cdstrapfilter.xml

The trapfilter files are preserved during a BroadWorks upgrade so that filters defined by
customers can remain unchanged after an upgrade.
Details on the Document Type Definition (DTD) for trapfilter files follow.
<?xml version='1.0' encoding="UTF-8"?>

<!ELEMENT trapFilter (defaultFilter?, filter*)>

<!ELEMENT defaultFilter (active, maxNumTrapsPerTimePeriod,

timePeriodInSeconds?, minSeverity?)>

<!ELEMENT filter (name, active, maxNumTrapsPerTimePeriod,

timePeriodInSeconds?, problemTextVarNum1?, problemTextVarNum2?,
problemTextVarNum3?, problemTextVarNum4?, problemTextVarNum5?)>

<!ELEMENT name (#PCDATA)>

<!ELEMENT active (false|true)>
<!ELEMENT maxNumTrapsPerTimePeriod (#PCDATA)>
<!ELEMENT timePeriodInSeconds (#PCDATA)>
<!ELEMENT minSeverity (0|1|2|3|4)>
<!ELEMENT problemTextVarNum1 (#PCDATA)>
<!ELEMENT problemTextVarNum2 (#PCDATA)>
<!ELEMENT problemTextVarNum3 (#PCDATA)>
<!ELEMENT problemTextVarNum4 (#PCDATA)>
<!ELEMENT problemTextVarNum5 (#PCDATA)>

>

Assuming that astrapfilter.xml would contain the following trapFilter block:

<trapFilter>
<defaultFilter>
<active>false</active>
<maxNumTrapsPerTimePeriod>10</maxNumTrapsPerTimePeriod>
<timePeriodInSeconds>5</timePeriodInSeconds>
<minSeverity>1</minSeverity>
</defaultFilter>
<filter>
<name>bwSipRegistrationFailure</name>
<active>true</active>
<maxNumTrapsPerTimePeriod>0</maxNumTrapsPerTimePeriod>
</filter>
<filter>
<name>bwSipUnexpectedMessage</name>
<active>true</active>
<maxNumTrapsPerTimePeriod>2</maxNumTrapsPerTimePeriod>
<timePeriodInSeconds>5</timePeriodInSeconds>
</filter>
<filter>

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 10 OF 33
 <name>bwNSSynchronizationFailure</name>
<active>true</active>
<maxNumTrapsPerTimePeriod>1</maxNumTrapsPerTimePeriod>
<timePeriodInSeconds>10</timePeriodInSeconds>
<problemTextVarNum1>3</problemTextVarNum1>
</filter>
<filter>
<name>bwSMDIOperationFailure</name>
<active>true</active>
<maxNumTrapsPerTimePeriod>10</maxNumTrapsPerTimePeriod>
<timePeriodInSeconds>60</timePeriodInSeconds>
<problemTextVarNum1>2</problemTextVarNum1>
<problemTextVarNum2>3</problemTextVarNum2>
</filter>
</trapFilter>

The Application Server SNMP agent would filter alarms as follows:

„ In general, no more than 10 alarms of a type per sliding period of five seconds are
sent out over the SNMP interface, unless alarm-specific filters exist for some alarms.
However, this system default threshold is inactive, so the SNMP agent simply ignores
this threshold definition. Also, if the default alarm filter is activated, only alarms with a
severity of “low” (1) or greater are sent out. Informational alarms would be discarded.
„ All bwSipRegistrationFailure alarms are filtered out and none are sent over the SNMP
interface.
„ The SNMP agent only sends a maximum of two bwSipUnexpectedMessage alarms
per sliding period of five seconds.
„ For a given Network Server address
(<problemTextVarNum1>3</problemTextVarNum1>), the SNMP agent sends a
maximum of one bwNSSynchronizationFailure alarm per sliding period of ten
seconds.
„ For a given phone number (<problemTextVarNum1>2</problemTextVarNum1>) and
a given failure reason (<problemTextVarNum2>3</problemTextVarNum2>), the
SNMP agent sends a maximum of ten bwSMDIOperationFailure alarms per sliding
period of one minute.
The above feature behavior is the same on all types of BroadWorks servers.

3.1.2 Filtering Considerations

„ BroadSoft does not provide any predefined alarm suppression or threshold rules in
the various trapfilter files besides the system default alarm threshold (set to inactive).
„ Alarm filtering works on a per-node basis and not on a per-cluster basis. This means
that if a filter specifies that alarm X should be discarded if the generation rate exceeds
five alarms per second, no alarm will be discarded if each server in a cluster has an
actual rate of three alarms per second, even though the aggregated rate for this two-
node cluster is actually of six alarms per second.
„ The data that the SNMP agent uses to filter out alarms is not persisted. This means
that after the SNMP agent restarts, filtering is reinitialized using the filters defined in
the trapfilter file and alarms are sent out until the various thresholds are reached once
more.
„ For a given alarm name, it is possible to define more than one filter. In this case, all
filters are evaluated and if at least one does not allow the alarm to be sent, then the
alarm is not sent.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 11 OF 33
 „ If maxNumTrapsPerTimePeriod is set to “0” (zero) or a negative integer value, then the
alarm (matching the other filter criteria, if some are specified) is suppressed. In such a
case, the timePeriodInSeconds value is ignored.
„ If maxNumTrapsPerTimePeriod is a positive integer greater than zero, then the alarm
(matching the other filter criteria, if some are specified) has a threshold. In such a
case, the timePeriodInSeconds needs to contain a positive integer value greater
than zero.
„ Alarm threshold uses the concept of sliding time period. When the agent receives an
alarm, it checks how many alarms matching the threshold rule(s) were received in the
previous timePeriodInSeconds seconds. If that number exceeds
maxNumTrapsPerTimePeriod, then the alarm is not sent over the SNMP interface.
The agent remembers that this alarm was received, for proper filtering when the next
one comes.
„ A maximum of five problem text variable filters can be defined per threshold. When
the agent compares the content of problem text variables for filtering purposes, the
comparison is not case sensitive.
„ If an alarm filter is provisioned with an invalid alarm name (that is, the alarm name
does not exist in the system), the filter is accepted but it remains in state invalid.

3.1.3 Filtered Alarms Notification

The feature introduces a new alarm called “bwAlarmsDiscarded” which is common to all
servers. The SNMP agent generates this alarm every 15 minutes (15 minutes after
SNMP agent restart and every 15 minutes thereafter) if at least one alarm was discarded
in the past 15 minutes. If this is the case, the alarm gives a list of all the alarms that were
discarded in the past 15 minutes along with the number of times each alarm was
discarded.
If the data to be included in the alarm gets too big, more than one alarm is generated. The
threshold is set to no more than 1024 characters in the list (and count) of alarms
discarded.

3.1.4 Provisioning Alarm Filters

The SNMP agent stores all alarm filters in a trapfilter file, as described in the previous
sections. To provision alarm filters, an administrator can:
„ Use the SNMP interface to ask the SNMP agent to add, delete, get, and set alarm
filters.
„ Use the BroadWorks CLI interface to add, delete, get, and set alarm filters.
These methods are explained in detail in the following subsections.

3.1.4.1 SNMP Provisioning

The definition of alarm filters and their configuration are part of the
BroadworksMaintenance.mib. Therefore, any network element that has an authorized
SNMP connectivity to the server’s SNMP agent can configure alarm filters. Alarm filters
can only be provisioned if the SNMP agent is running. To support this, the MIB is
enhanced as follows (shown in bold):
--===============================================================
-- File Name : BroadworksMaintenance.mib
-- Date : 08/15/2002
-- Author : BroadSoft Inc.
--===============================================================

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 12 OF 33
 BroadworksMaintenance DEFINITIONS ::= BEGIN
IMPORTS
DisplayString
FROM SNMPv2-TC
MODULE-COMPLIANCE, OBJECT-GROUP
FROM SNMPv2-CONF
enterprises, MODULE-IDENTITY, NOTIFICATION-TYPE, OBJECT-TYPE, Gauge32, Counter32
FROM SNMPv2-SMI;

broadsoft MODULE-IDENTITY
LAST-UPDATED "200508161000Z"
ORGANIZATION "Broadsoft, Inc"
CONTACT-INFO "Broadsoft, Inc
220 Perry Parkway
Gaithersburg, MD 20877
301-977-9440"
DESCRIPTION
"This is the System Management Information structure for the
Broadsoft enterprise."
REVISION "200603011000Z"
DESCRIPTION
"Added alarm threshold and suppression."
REVISION "200508161000Z"
DESCRIPTION
"Added MIB conformance section."
REVISION "200009191431Z"
DESCRIPTION
""
::= { enterprises 6431 }

broadworks OBJECT IDENTIFIER

::= { broadsoft 1 }

common OBJECT IDENTIFIER

::= { broadworks 1 }

managedObjects OBJECT IDENTIFIER

::= { common 2 }

thresholds OBJECT IDENTIFIER

::= { common 3 }

reservedModule OBJECT IDENTIFIER

::= { common 10 }

bwMtcMibConformance OBJECT IDENTIFIER

::= { common 20 }

moServerModule OBJECT IDENTIFIER

::= { managedObjects 1 }

moSoftwareVersionModule OBJECT IDENTIFIER

::= { managedObjects 2 }

moDeviceModule OBJECT IDENTIFIER

::= { managedObjects 3 }

thCounterModule OBJECT IDENTIFIER

::= { thresholds 1 }

thGaugeModule OBJECT IDENTIFIER

::= { thresholds 2 }

thAlarmModule OBJECT IDENTIFIER

::= { thresholds 3 }

...

-- Alarm thresholds modules ...........................................

bwAlarmThresholdTable OBJECT-TYPE
SYNTAX SEQUENCE OF BwAlarmThresholdEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of all the thresholds set against alarms in the system"
::= { thAlarmModule 1 }

bwAlarmThresholdEntry OBJECT-TYPE
SYNTAX BwAlarmThresholdEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This row contains information on a particular alarm threshold"
INDEX { bwAlarmThresholdIndex }
::= { bwAlarmThresholdTable 1 }

BwAlarmThresholdEntry ::= SEQUENCE {

bwAlarmThresholdIndex Integer32,

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 13 OF 33
 bwAlarmThresholdName DisplayString,
bwAlarmThresholdMaxNumTrapsPerTimePeriod Integer32,
bwAlarmThresholdTimePeriodInSeconds Integer32,
bwAlarmThresholdProblemTextVarNum1 Integer32,
bwAlarmThresholdProblemTextVarNum2 Integer32,
bwAlarmThresholdProblemTextVarNum3 Integer32,
bwAlarmThresholdProblemTextVarNum4 Integer32,
bwAlarmThresholdProblemTextVarNum5 Integer32,
bwAlarmThresholdMinimumSeverity INTEGER,
bwAlarmThresholdControl INTEGER
}

bwAlarmThresholdIndex OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This integer represents the index of an alarm threshold in the system"
::= { bwAlarmThresholdEntry 1 }

bwAlarmThresholdName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The name of an alarm or DEFAULT if the threshold applies to all alarms in
the system"
::= { bwAlarmThresholdEntry 2 }

bwAlarmThresholdMaxNumTrapsPerTimePeriod OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The maximum number of traps that the system outputs per sliding time
period. If set to 0 (zero), the alarm is suppressed and the system does not output any trap for this alarm
filter."
::= { bwAlarmThresholdEntry 3 }

bwAlarmThresholdTimePeriodInSeconds OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The time period used for threshold calculation, in seconds."
::= { bwAlarmThresholdEntry 4 }

bwAlarmThresholdProblemTextVarNum1 OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"To further refine a threshold, specify the position number of the variable
data within the alarm problem text (1, 2, 3, etc.) that together with the alarm name, define the actual
threshold. For example, if the alarm has five problem text variables: 1-deviceName, 2-deviceAddress, 3-
devicePort, 4-errorType, 5-errorCode, and if the alarm threshold is to limit the number of traps for a given
deviceName, devicePort, and errorType, then bwAlarmThresholdProblemTextVarNum1 should be set to 1,
bwAlarmThresholdProblemTextVarNum2 should be set to 3, and bwAlarmThresholdProblemTextVarNum3 should be set to
4. To ignore filtering based on problem text variables, set to 0 (zero)."
::= { bwAlarmThresholdEntry 5 }

bwAlarmThresholdProblemTextVarNum2 OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"To further refine a threshold, specify the position number of the variable
data within the alarm problem text (1, 2, 3, etc.) that together with the alarm name, define the actual
threshold. For example, if the alarm has five problem text variables: 1-deviceName, 2-deviceAddress, 3-
devicePort, 4-errorType, 5-errorCode, and if the alarm threshold is to limit the number of traps for a given
deviceName, devicePort, and errorType, then bwAlarmThresholdProblemTextVarNum1 should be set to 1,
bwAlarmThresholdProblemTextVarNum2 should be set to 3, and bwAlarmThresholdProblemTextVarNum3 should be set to
4. To ignore filtering based on problem text variables, set to 0 (zero)."
::= { bwAlarmThresholdEntry 6 }

bwAlarmThresholdProblemTextVarNum3 OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"To further refine a threshold, specify the position number of the variable
data within the alarm problem text (1, 2, 3, etc.) that together with the alarm name, define the actual
threshold. For example, if the alarm has five problem text variables: 1-deviceName, 2-deviceAddress, 3-
devicePort, 4-errorType, 5-errorCode, and if the alarm threshold is to limit the number of traps for a given
deviceName, devicePort, and errorType, then bwAlarmThresholdProblemTextVarNum1 should be set to 1,
bwAlarmThresholdProblemTextVarNum2 should be set to 3, and bwAlarmThresholdProblemTextVarNum3 should be set to
4. To ignore filtering based on problem text variables, set to 0 (zero)."
::= { bwAlarmThresholdEntry 7 }

bwAlarmThresholdProblemTextVarNum4 OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 14 OF 33
 DESCRIPTION
"To further refine a threshold, specify the position number of the variable
data within the alarm problem text (1, 2, 3, etc.) that together with the alarm name, define the actual
threshold. For example, if the alarm has five problem text variables: 1-deviceName, 2-deviceAddress, 3-
devicePort, 4-errorType, 5-errorCode, and if the alarm threshold is to limit the number of traps for a given
deviceName, devicePort, and errorType, then bwAlarmThresholdProblemTextVarNum1 should be set to 1,
bwAlarmThresholdProblemTextVarNum2 should be set to 3, and bwAlarmThresholdProblemTextVarNum3 should be set to
4. To ignore filtering based on problem text variables, set to 0 (zero)."
::= { bwAlarmThresholdEntry 8 }

bwAlarmThresholdProblemTextVarNum5 OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"To further refine a threshold, specify the position number of the variable
data within the alarm problem text (1, 2, 3, etc.) that together with the alarm name, define the actual
threshold. For example, if the alarm has five problem text variables: 1-deviceName, 2-deviceAddress, 3-
devicePort, 4-errorType, 5-errorCode, and if the alarm threshold is to limit the number of traps for a given
deviceName, devicePort, and errorType, then bwAlarmThresholdProblemTextVarNum1 should be set to 1,
bwAlarmThresholdProblemTextVarNum2 should be set to 3, and bwAlarmThresholdProblemTextVarNum3 should be set to
4. To ignore filtering based on problem text variables, set to 0 (zero)."
::= { bwAlarmThresholdEntry 9 }

bwAlarmThresholdMinimumSeverity OBJECT-TYPE
SYNTAX INTEGER { informational ( 0 ) , low ( 1 ) , medium ( 2 ) , high
( 3 ) , critical ( 4 ) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This is the minimum alarm severity under which alarms start to be
discarded."
::= { bwAlarmThresholdEntry 10 }

bwAlarmThresholdControl OBJECT-TYPE
SYNTAX INTEGER { inactive(0), active(1), delete(2), create(3),
invalid(4) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This scalar controls the life cycle of the threshold. Setting this
threshold to create(3) using an unused index creates a row with the specified index. Setting it with an already
used index has no effect. Setting this threshold to delete(2) removes the entry."
::= { bwAlarmThresholdEntry 11 }

...

-- BroadWorks Common managed object MIB Conformance Definition ...........................................

bwMtcMibGroups OBJECT IDENTIFIER ::= { bwMtcMibConformance 1 }

bwMtcMibCompliancy OBJECT IDENTIFIER ::= { bwMtcMibConformance 2 }

-- units of conformance

bwMoServerGroup OBJECT-GROUP
OBJECTS { bwServerType, bwRedundancyType, bwActiveSoftwareVersion, bwAdminState, bwOperationalState,
bwResetServer, bwSubComponentTable, bwTargetSoftwareVersion, bwSubComponentIndex, bwSubComponentName,
bwSubComponentInfo }
STATUS current
DESCRIPTION
"This group defines managed object server attributes."
::= { bwMtcMibGroups 1 }

bwMoSoftwareVersionsGroup OBJECT-GROUP
OBJECTS { bwUpdateSoftwareVersionTable, bwSoftwareVersionTable, bwSoftwarePatchTable,
bwSoftwareThirdPartyTable, bwSoftwareVersionIndex, bwSoftwareVersionName, bwSoftwareVersionInstallDate,
bwSoftwareVersionStatus, bwSoftwarePatchIndex, bwSoftwarePatchVersionName, bwSoftwarePatchName,
bwSoftwarePatchType, bwSoftwarePatchInstallDate, bwSoftwarePatchStatus, bwSoftwarePatchOperation,
bwSoftwareThirdPartyIndex, bwSoftwareThirdPartyName, bwSoftwareThirdPartyVersion, bwSoftwareThirdPartyStatus }
STATUS current
DESCRIPTION
"This group defines the software version attributes for the managed object."
::= { bwMtcMibGroups 2 }

bwMoDeviceGroup OBJECT-GROUP
OBJECTS { bwManagedObjectsTable, bwManagedObjectsIndex, bwManagedObjectsName, bwManagedObjectsProtocol,
bwManagedObjectsType, bwManagedObjectsAdminState, bwManagedObjectsOperationalState }
STATUS current
DESCRIPTION
"This group defines the counters used to manage the access or network devices monitored by this managed
object."
::= { bwMtcMibGroups 3 }

bwMoThresholdsGroup OBJECT-GROUP
OBJECTS { bwCounterThresholdTable, bwCounterThresholdIndex, bwCounterThresholdDescription,
bwCounterThresholdName, bwCounterThresholdInitialValue, bwCounterThresholdOffsetValue,
bwCounterThresholdCurrentValue, bwCounterThresholdSeverity, bwCounterThresholdControl, bwGaugeThresholdTable,
bwGaugeThresholdIndex, bwGaugeThresholdDescription, bwGaugeThresholdName, bwGaugeThresholdNotifyLow,
bwGaugeThresholdNotifyHigh, bwGaugeThresholdSeverity, bwGaugeThresholdControl, bwAlarmThresholdTable,
bwAlarmThresholdIndex, bwAlarmThresholdName, bwAlarmThresholdMaxNumTrapsPerTimePeriod,
bwAlarmThresholdTimePeriodInSeconds, bwAlarmThresholdProblemTextVarNum1, bwAlarmThresholdProblemTextVarNum2,

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 15 OF 33
 bwAlarmThresholdProblemTextVarNum3, bwAlarmThresholdProblemTextVarNum4, bwAlarmThresholdProblemTextVarNum5,
bwAlarmThresholdMinimumSeverity, bwAlarmThresholdControl}
STATUS current
DESCRIPTION
"This group defines the threshold control for this managed object."
::= { bwMtcMibGroups 4 }

bwMoReserveGroup OBJECT-GROUP
OBJECTS { bwReservedScalar }
STATUS current
DESCRIPTION
"MIB reserved section."
::= { bwMtcMibGroups 5 }

--
bwMoBasicCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"BroadWorks Common managed object MIB compliance"
MODULE -- this module
MANDATORY-GROUPS { bwMoServerGroup, bwMoSoftwareVersionsGroup, bwMoDeviceGroup,
bwMoThresholdsGroup, bwMoReserveGroup }
::= { bwMtcMibCompliancy 1 }

END

3.1.4.2 CLI Provisioning

It is also possible to add, delete, get, and set alarm filters using the BroadWorks CLI. To
provision and configure alarm filters using the CLI, the SNMP agent on the server needs
to be running. The following is an example (on an Application Server) showing how alarm
filters can be managed using the CLI.
AS_CLI/Monitoring/Alarm/Threshold> get
Index AlarmName MaxNumTrapsPerTimePeriod TimePeriodInSeconds Var1 Var2 Var3 Var4 Var5 Status
=======================================================================================================

0 entry found.

AS_CLI/Monitoring/Alarm/Threshold> %% No more than 4 bwNSSynchronizationFailure alarms per sliding period of 10

seconds.

AS_CLI/Monitoring/Alarm/Threshold> add bwNSSynchronizationFailure 4 10 active

...Done

AS_CLI/Monitoring/Alarm/Threshold> %% Suppress all bwSipRegistrationFailure alarms.

AS_CLI/Monitoring/Alarm/Threshold> add bwSipRegistrationFailure 0 1 active

...Done

AS_CLI/Monitoring/Alarm/Threshold/Default> %% Limit each alarm in system to 100 alarms of each type per hour.

AS_CLI/Monitoring/Alarm/Threshold/Default> set maxNumTrapsPerTimePeriod 100 timePeriodInSeconds 3600 status

active minSeverity low
...Done

AS_CLI/Monitoring/Alarm/Threshold> %% For the same Endpoint ID (problem text variable position 1) and Device
Address (problem text variable position 2), limit the number of bwMGCPReTransmissionTimeout alarms to 2 per
sliding period of 30 seconds.

AS_CLI/Monitoring/Alarm/Threshold> add bwMGCPReTransmissionTimeout 2 30 active problemTextVariable1 1

problemTextVariable2 2
...Done

AS_CLI/Monitoring/Alarm/Threshold> get
Index AlarmName MaxNumTrapsPerTimePeriod TimePeriodInSeconds Var1 Var2 Var3
Var4 Var5 Status
=====================================================================================================
==================
1 bwNSSynchronizationFailure 4 10
active
2 bwSipRegistrationFailure 0 1
active
4 bwMGCPReTransmissionTimeout 2 30 1 2
active

3 entries found.

AS_CLI/Monitoring/Alarm/Threshold/Default> get
maxNumTrapsPerTimePeriod = 100
timePeriodInSeconds = 3600
status = active
minSeverity = low

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 16 OF 33
 3.2 Pictorial Description
The following figure provides an overview of the processing that the SNMP agent goes
through with alarms. The new feature functionality is enclosed in the bold rectangle.

Incoming alarm

Dequeue
incoming alarm
from server
Trap Client (bwcli)

Send alarm to
Trap Server Trap Client (bwcli)
Trap Server

Filter alarm

Keep track of
Y Discard alarm?
discarded alarms

snmptraps.log Log alarm to file

Send alarm to
manager over
SNMP

Figure 1 SNMP Agent Alarm Processing Overview

3.3 Use Cases

3.3.1 Execution Use Cases

This is not applicable.

3.3.2 Provisioning Use Cases

This is an example of a typical CLI session showing how alarm filters are provisioned (on
an Application Server).
AS_CLI/Monitoring/Alarm/Threshold> get
Index AlarmName MaxNumTrapsPerTimePeriod TimePeriodInSeconds Var1 Var2 Var3 Var4 Var5 Status
=======================================================================================================

0 entry found.

AS_CLI/Monitoring/Alarm/Threshold> %% No more than 4 bwNSSynchronizationFailure alarms per sliding period of 10

seconds.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 17 OF 33
 AS_CLI/Monitoring/Alarm/Threshold> add bwNSSynchronizationFailure 4 10 active
...Done

AS_CLI/Monitoring/Alarm/Threshold> %% Suppress all bwSipRegistrationFailure alarms.

AS_CLI/Monitoring/Alarm/Threshold> add bwSipRegistrationFailure 0 1 active

...Done

AS_CLI/Monitoring/Alarm/Threshold/Default> %% Limit each alarm in system to 100 alarms of each type per hour.

AS_CLI/Monitoring/Alarm/Threshold/Default> set maxNumTrapsPerTimePeriod 100 timePeriodInSeconds 3600 status

active minSeverity low
...Done

AS_CLI/Monitoring/Alarm/Threshold> %% For the same Endpoint ID (problem text variable position 1) and Device
Address (problem text variable position 2), limit the number of bwMGCPReTransmissionTimeout alarms to 2 per
sliding period of 30 seconds.

AS_CLI/Monitoring/Alarm/Threshold> add bwMGCPReTransmissionTimeout 2 30 active problemTextVariable1 1

problemTextVariable2 2
...Done

AS_CLI/Monitoring/Alarm/Threshold> %% Add a filter for an alarm name that does not exist. The filter is not
rejected but it remains in state invalid.

AS_CLI/Monitoring/Alarm/Threshold> add abcdefg 3 60 active

...Done

AS_CLI/Monitoring/Alarm/Threshold> get
Index AlarmName MaxNumTrapsPerTimePeriod TimePeriodInSeconds Var1 Var2 Var3
Var4 Var5 Status
=====================================================================================================
==================
1 bwNSSynchronizationFailure 4 10
active
2 bwSipRegistrationFailure 0 1
active
4 bwMGCPReTransmissionTimeout 2 30 1 2
active
5 abcdefg 3 60
invalid

4 entries found.

AS_CLI/Monitoring/Alarm/Threshold/Default> get
maxNumTrapsPerTimePeriod = 100
timePeriodInSeconds = 3600
status = active

AS_CLI/Monitoring/Alarm/Threshold/Default> %% Deactivate the default threshold.

AS_CLI/Monitoring/Alarm/Threshold/Default> set status inactive

...Done

AS_CLI/Monitoring/Alarm/Threshold> %% Change threshold settings for bwNSSynchronizationFailure.

AS_CLI/Monitoring/Alarm/Threshold> set bwNSSynchronizationFailure maxNumTrapsPerTimePeriod 5 timePeriodInSeconds

20
...Done

AS_CLI/Monitoring/Alarm/Threshold> %% Delete bwMGCPReTransmissionTimeout filter.

AS_CLI/Monitoring/Alarm/Threshold> delete bwMGCPReTransmissionTimeout

...Done

AS_CLI/Monitoring/Alarm/Threshold> get
Index AlarmName MaxNumTrapsPerTimePeriod TimePeriodInSeconds Var1 Var2 Var3
Var4 Var5 Status
=====================================================================================================
==================
1 bwNSSynchronizationFailure 5 20
active
2 bwSipRegistrationFailure 0 1
active
5 abcdefg 3 60
invalid

3 entries found.

AS_CLI/Monitoring/Alarm/Threshold/Default> get
maxNumTrapsPerTimePeriod = 100
timePeriodInSeconds = 3600
status = inactive
minSeverity = low

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 18 OF 33
 4 Provisioning Impacts

4.1 Configuration Data

4.1.1 Alarm Filter

Name Field Type Required? Validation Default
Values Value

Index Integer Yes None None

AlarmName String(128) Yes None None

MaxNumTrapsPerTimePeriod Integer Yes 0 to 100000 None

TimePeriodInSeconds Integer Yes 1 to 2678400 None

Status String(80) Yes active, inactive None

ProblemTextVariable1 Integer No 1 to 16 None

ProblemTextVariable2 Integer No 1 to 16 None

ProblemTextVariable3 Integer No 1 to 16 None

ProblemTextVariable4 Integer No 1 to 16 None

ProblemTextVariable5 Integer No 1 to 16 None

MinSeverity String No informational, informational

low, medium,
high

4.2 Web Portal Impacts

There is no impact.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 19 OF 33
 4.3 CLI Impacts

4.3.1 Summary
This feature enhances the CLI of all types of BroadWorks servers. Following is an
example of the Application Server CLI.

AS_CLI

Monitoring Level Commands

Threshold add
Alarm delete
get
set
Threshold clear

Default get
set
Default

Figure 2 CLI Hierarchy Changes

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 20 OF 33
 4.3.2 Command
1) AS_CLI/Monitoring/Alarm/Threshold/add
Location within CLI Tree:
AS_CLI/Monitoring/Alarm/Threshold

Command Format:
add
<alarmName>, String {1 to 128 characters}
<maxNumTrapsPerTimePeriod>, Integer {0 to 100000}
<timePeriodInSeconds>, Integer {1 to 2678400}
<status>, Choice = {inactive, active}
[<attribute>, Multiple Choice = {problemTextVariable1,
problemTextVariable2, problemTextVariable3, problemTextVariable4,
problemTextVariable5}]
<problemTextVariable1>, Integer {1 to 16}
<problemTextVariable2>, Integer {1 to 16}
<problemTextVariable3>, Integer {1 to 16}
<problemTextVariable4>, Integer {1 to 16}
<problemTextVariable5>, Integer {1 to 16}

Definition and Usage:

The ADD command is used to add a new threshold against an alarm.

Example:
AS_CLI/Monitoring/Alarm/Threshold> add bwThreadDelayDetected 5 60 active
problemTextVariable1 1 problemTextVariable2 2
...Done

2) AS_CLI/Monitoring/Alarm/Threshold/delete
Location within CLI Tree:
AS_CLI/Monitoring/Alarm/Threshold

Command Format:
delete
<alarmName>, String {1 to 128 characters}
[<index>, Integer {0 to 65000}]

Definition and Usage:

The DELETE command is used to delete defined thresholds against an alarm.

Example:
AS_CLI/Monitoring/Alarm/Threshold> delete bwThreadDelayDetected
...Done

3) AS_CLI/Monitoring/Alarm/Threshold/get
Location within CLI Tree:
AS_CLI/Monitoring/Alarm/Threshold

Command Format:
get
[<attribute>, Multiple Choice = {alarmName}]
<alarmName>, String {1 to 128 characters}

Definition and Usage:

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 21 OF 33
 The GET command is used to list the defined alarm thresholds. The
'alarmName' attribute performs a case-sensitive prefix match.
Example:
AS_CLI/Monitoring/Alarm/Threshold> get
Index AlarmName MaxNumTrapsPerTimePeriod
TimePeriodInSeconds Var1 Var2 Var3 Var4 Var5 Status
=============================================================
=========================================================
0 bwNSSynchronizationFailure 5
20 1 2 active
1 bwSipRegistrationFailure 0
1 active

2 entries found.

4) AS_CLI/Monitoring/Alarm/Threshold/set
Location within CLI Tree:
AS_CLI/Monitoring/Alarm/Threshold
Command Format:
set
<alarmName>, String {1 to 128 characters}
[<index>, Integer {0 to 65000}]
<attribute>, Multiple Choice = {maxNumTrapsPerTimePeriod,
timePeriodInSeconds, problemTextVariable1, problemTextVariable2,
problemTextVariable3, problemTextVariable4, problemTextVariable5, status}
<maxNumTrapsPerTimePeriod>, Integer {0 to 100000}
<timePeriodInSeconds>, Integer {1 to 2678400}
<problemTextVariable1>, Integer {1 to 16}
<problemTextVariable2>, Integer {1 to 16}
<problemTextVariable3>, Integer {1 to 16}
<problemTextVariable4>, Integer {1 to 16}
<problemTextVariable5>, Integer {1 to 16}
<status>, Choice = {inactive, active}

Definition and Usage:

The SET command is used to modify alarm thresholds attributes.
Example:
AS_CLI/Monitoring/Alarm/Threshold> set bwThreadDelayDetected
maxNumTrapsPerTimePeriod 5 timePeriodInSeconds 60 status active
problemTextVariable1 1 problemTextVariable2 3
...Done

5) AS_CLI/Monitoring/Alarm/Threshold/clear
Location within CLI Tree:
AS_CLI/Monitoring/Alarm/Threshold

Command Format:
clear
<alarmName>, String {1 to 128 characters}
[<index>, Integer {0 to 65000}]
<attribute>, Multiple Choice = {problemTextVariable1,
problemTextVariable2, problemTextVariable3,
problemTextVariable4, problemTextVariable5}

Definition and Usage:

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 22 OF 33
 This command is used to clear alarm threshold-related attributes in the
system.
Example:
AS_CLI/Monitoring/Alarm/Threshold> clear bwThreadDelayDetected
problemTextVariable2
...Done

6) AS_CLI/Monitoring/Alarm/Threshold/Default/get
Location within CLI Tree:
AS_CLI/Monitoring/Alarm/Threshold/Default

Command Format:
get
get takes no parameter

Definition and Usage:

The GET command is used to list the system default alarm threshold.

Example:
AS_CLI/Monitoring/Alarm/Threshold/Default> get
maxNumTrapsPerTimePeriod = 10
timePeriodInSeconds = 1
status = inactive
minSeverity = low

7) AS_CLI/Monitoring/Alarm/Threshold/Default/set
Location within CLI Tree:
AS_CLI/Monitoring/Alarm/Threshold/Default

Command Format:
set
<attribute>, Multiple Choice = {maxNumTrapsPerTimePeriod,
timePeriodInSeconds, status, minSeverity}
<maxNumTrapsPerTimePeriod>, Integer {0 to 100000}
<timePeriodInSeconds>, Integer {1 to 2678400}
<status>, Choice = {inactive, active}
<minSeverity>, Choice = {informational, low, medium, high,
critical}

Definition and Usage:

The SET command is used to modify the system default alarm threshold
attributes.
Example:
AS_CLI/Monitoring/Alarm/Threshold/Default> set maxNumTrapsPerTimePeriod 5
timePeriodInSeconds 10 status active minSeverity high
...Done

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 23 OF 33
 4.4 Open Client Interface-Provisioning (OCI-P) Impact
There is no impact.

4.5 OSS Impacts

There is no impact.

4.6 Application Server Query User/Query Group Impacts

There is no impact.

4.7 External Authentication Impacts

There is no impact.

4.8 Application Server Portal API Impacts

There is no impact.

4.9 Network Server Location API Impacts

There is no impact.

4.10 NSSync API Impacts

There is no impact.

4.11 Application Server Dump Impacts

There is no impact.

4.12 Service Details and Licensing

There is no impact.

4.13 CDR SOAP Interface

There is no impact.

4.14 Treatments
There is no impact.

4.15 Media Announcements (Audio and Video)

There is no impact.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 24 OF 33
 5 Accounting Impacts

5.1 Accounting Management Impacts

There is no impact.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 25 OF 33
 6 System Management Impacts

6.1 Performance Management Impacts

There is no impact.

6.2 Fault Management Impacts

6.2.1 New Alarms

Fault Name Attributes Value
bwAlarmsDiscarded Problem type Notification
Severity range Low
Subcomponent Unspecified
Description Provides a complete list of all the alarms that the SNMP
agent discarded in the past 15 minutes either because
they are suppressed or because they exceeded their
predefined threshold criteria.
Problem text The following alarms were discarded during the 15
minute period starting at: %1:
%2
Problem text %1: Start time of the 15-minute period during which
parameters some alarms were discarded.
Time is given in the time zone of the default locale of
the server’s SNMP agent.
Example: 2006.02.13 15:16:29:281 EST
%2: Number and name of all the alarms that were
discarded in the past 15 minutes.
Example:
12 bwCommProtocolHostNotAllowed
1 bwOciReportingAclViolation
131 bwSipMaxRetriesExceeded
Recommendation None
text
Recommendation None
test parameters

6.3 Scripts and Tools

There is no impact.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 26 OF 33
 7 Execution/Call Processing Impacts

7.1 CAP Interface Impact

There is no impact.

7.2 SIP/MGCP Interface Impact

There is no impact.

7.3 Service Interactions

There is no impact.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 27 OF 33
 8 Deployment/Operational Impacts

8.1 Configuration File Impacts

There is no impact.

8.2 Installation Impacts

This feature introduces a new file that only the SNMP agent uses. The text file is called
xxtrapfilter.xml (where xx is the BroadWorks server type, such as Application Server,
Network Server, Call Detail Server, and so on). The file is optional and the SNMP agent
uses it to implement alarm filtering rules. Upon installation, a default file is installed on
each server type. The default file content is:
<?xml version="1.0"?>
<trapFilter>
<defaultFilter>
<active>false</active>
<maxNumTrapsPerTimePeriod>5</maxNumTrapsPerTimePeriod>
<timePeriodInSeconds>1</timePeriodInSeconds>
<minSeverity>0</minSeverity>
</defaultFilter>
</trapFilter>

8.3 Upgrade Impacts

During an upgrade, if the xxtrapfilter.xml does not exist on the old software version, it is
created (default file) on the target software version. Otherwise, it is copied over
(preserved from the old software version) to the target software version.

8.4 Rollback Impacts

There is no impact.

8.5 Restart Impacts

When the SNMP agent restarts, it loses all active threshold data. It reloads all the alarm
filtering rules from the xxtrapfilter.xml file and alarm filtering restarts from scratch. In other
words, if an alarm is discarded because the server generates too many alarms of this
type, the SNMP agent will no longer discard this alarm after a restart, until the alarm again
reaches its predefined threshold.

8.6 Performance Impacts

The impact is low.

8.7 Security Impacts

There is no impact.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 28 OF 33
 8.8 Scheduled Tasks
The SNMP agent has a new scheduled task that runs every 15 minutes (15 minutes after
the SNMP agent restarts and every 15 minutes thereafter). The purpose of the task is to
generate an alarm that gives a summary of all the alarms that were discarded during the
last 15 minutes.

8.9 Third Party Software

There is no impact.

8.10 Hardware Impacts

There is no impact.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 29 OF 33
 9 Restrictions and Limitations

There are no restrictions or limitations.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 30 OF 33
 10 Tactical Content Information

This feature will not be available as a patch.

10.1 Summary of Functional Differences between Patches and Releases

This is not applicable.

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 31 OF 33
 Acronyms and Abbreviations

This section lists the acronyms and abbreviations found in this document. The acronyms
and abbreviations are listed in alphabetical order along with their meanings.

Admin Administrator
API Application Programming Interface
AS Application Server
BW BroadWorks
CAP Client Application Protocol
CDR Call Detail Record
CDS Call Detail Server
CLI Command Line Interface
CS Conferencing Server
DN Directory Number
DTD Document Type Definition
EMS Element Management System
FS Functional Specification
HTML Hypertext Markup Language
LSSGR LATA Switching Systems Generic Requirements
MGCP Media Gateway Control Protocol
MIB Management Information Base
MS Media Server
NS Network Server
NSSync Network Server Synchronization
OCI Open Client Interface
OCI-P Open Client Interface-Provisioning
OID Object Identifier
OS Operating System
OSS Operations Support System
PM Performance Measurement
PS Provisioning Server
SIP Session Initiation Protocol
SNMP Simple Network Management Protocol
SOAP Simple Object Access Protocol
WS Web Server

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 32 OF 33
 XML eXtensible Markup Language
XS Execution Server

ALARM THRESHOLD AND SUPPRESSION 11-BD5102-00

©
2006 BROADSOFT INC. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 33 OF 33