BroadWorks EMS Administration Guide

Release 19.sp1
Version 1

9737 Washingtonian Boulevard, Suite 350

Gaithersburg, MD 20878
Tel +1 301.977.9440

WWW.BROADSOFT.COM
BroadWorks ® Guide

Copyright Notice
Copyright © 2014 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.
9737 Washingtonian Boulevard, Gaithersburg, MD 20878.
BroadSoft reserves the right to make changes without prior notice.

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

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 2
Document Revision History

Release Version Reason for Change Date

18.0 1.0 Transformed document in the following ways: November 25, 2011
• Combined content from BroadWorks EMS Administration Guide
(Part I and Part II), BroadWorks EMS User Guide (Part I and Part
II), and BroadWorks EMS Product Description.
• Converted document to DITA-based format.

18.0 2.0 Added minor editorial comments. December 22, 2011

18.0 3.0 Integrated additional content from the BroadWorks EMS Product March 24, 2012
Description.

18.0 3.0 Integrated content from the BroadWorks Enterprise/Service Provider May 15, 2012
Subscriber Migration Tool Administration Guide in addition to feedback
from Technical Support.

19.0 1.0 Updated document with the following Release 19.0 content: October 12, 2012
• Managing Licenses on page 441
• Configure License Reporting on page 346

19.0 1.0 Edited changes. October 15, 2012

19.0 1.0 Published document. November 16, 2012

19.0 2.0 Updated content in: January 30, 2013

• Examples of Periodic Reports on page 460
• Apply or Remove Patch on page 431

19.0 3.0 Updated content in the following sections for EV192306: May 29, 2013
• Configure License Reporting on page 346
• Managing Licenses on page 441

19.0 3.0 Edited changes and published document. June 4, 2013

19.0 4.0 Updated content in the following section for EV190411: July 31, 2013
• Using Patch Management on page 419

19.0 5.0 Updated content in the following sections for EV192055: August 12, 2013
• Add BroadWorks Servers with Multiple Interfaces on page 39
• Discover BroadWorks Servers on page 40
• Add Node on page 36

19.0 6.0 Updated content in the following section for EV190411 and published October 10, 2013
document:
• BroadSoft Patch Center Substitution on page 438

19.sp1 1.0 Updated the following sections for EV175535: July 16, 2014
• Perform Service Pack Migration on page 388
• Add Service Pack Migration Task on page 391
• Configure User Migration on page 353
• Add User Migration Configuration on page 355
• Execute User Migration on page 373

19.sp1 1.0 Edited content and published document. July 28, 2014

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 3
Table of Contents

Document Revision History.............................................................................................................3

1 EMS Overview..............................................................................................................................17
1.1 Network Management................................................................................................................................ 17
1.2 Network Architecture.................................................................................................................................. 18
1.3 Software Components................................................................................................................................19
1.4 Interactions with Northbound and Southbound Interfaces......................................................................... 21
1.5 EMS Functions........................................................................................................................................... 23
1.5.1 Maps/Topology..................................................................................................................................... 24
1.5.2 Inventory...............................................................................................................................................25
1.5.3 Fault Management............................................................................................................................... 25
1.5.4 Configuration Management..................................................................................................................27
1.5.5 Security................................................................................................................................................ 28
1.5.6 Performance Monitoring.......................................................................................................................29
1.5.7 Administration.......................................................................................................................................29
1.5.8 Software Lifecycle................................................................................................................................ 29
1.5.9 Centralized Services............................................................................................................................ 30
1.6 Default User Groups.................................................................................................................................. 30
1.6.1 EMS Behavior upon Insufficient Privileges..........................................................................................31
1.7 User Interfaces........................................................................................................................................... 31
1.8 Managed Objects....................................................................................................................................... 31
2 Getting Started............................................................................................................................ 33
2.1 Using EMS Web Interface......................................................................................................................... 33
2.1.1 Basic Components of Web Client Work Area.................................................................................... 33
2.2 Start-up Procedures................................................................................................................................... 35
2.2.1 Prerequisites.........................................................................................................................................35
2.2.2 Configure User Names and Passwords.............................................................................................. 35
2.2.3 Add Node............................................................................................................................................. 36
2.2.4 Add BroadWorks Servers with Multiple Interfaces.............................................................................. 39
2.2.5 Discover BroadWorks Servers.............................................................................................................40
2.2.6 Review Discovery Results................................................................................................................... 42
2.2.7 Configure E-mail, Distribution Lists, and Performance Reports.......................................................... 45
2.2.8 Create a Report by Node Type........................................................................................................... 45
2.2.9 Audit Statistics......................................................................................................................................45
2.2.10 Audit Patch Download....................................................................................................................... 46
2.3 Configuring Northbound Trap Forwarding................................................................................................ 46
2.4 Configuring Southbound Interface............................................................................................................. 48
3 Using Network Topology............................................................................................................49
3.1 Using BroadWorks Network Maps............................................................................................................. 49
3.1.1 Configure Node Access....................................................................................................................... 51
3.1.2 Discover BroadWorks Servers.............................................................................................................54
3.1.3 Managed Elements Auto-Configuration and Network Auto-Discovery.................................................56
3.2 Accessing Properties for BroadWorks Node............................................................................................. 57
3.2.1 Configure BroadWorks Node............................................................................................................... 58
3.2.2 Execute Remote Command.................................................................................................................71
3.2.3 View Routing Tables of Node..............................................................................................................72
3.2.4 View Interfaces of Node...................................................................................................................... 73
3.2.5 View TCP Table...................................................................................................................................74
3.2.6 View UDP Table.................................................................................................................................. 75
3.2.7 View IP Net to Media Table................................................................................................................ 77
3.2.8 Refresh this Node................................................................................................................................ 78
3.2.9 Configure Node Access....................................................................................................................... 79
3.2.10 Cut Through to BroadWorks Web Portal Interface............................................................................81

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 4
 3.2.11 Cut Through to BroadWorks SSH Session....................................................................................... 81
3.2.12 Cut Through to BroadWorks Telnet Session.....................................................................................82
3.2.13 Discover BroadWorks Servers...........................................................................................................82
4 Managing Inventory.....................................................................................................................85
4.1 Overview of Inventory................................................................................................................................ 85
4.2 Managing All Objects in Complete View................................................................................................... 86
4.2.1 Add Child View of the Inventory..........................................................................................................87
4.2.2 View Properties.................................................................................................................................... 90
4.3 Managing Networks..................................................................................................................................118
4.3.1 Add Child View of Networks..............................................................................................................120
4.3.2 View Network Properties................................................................................................................... 123
4.4 Managing Groups.....................................................................................................................................127
4.4.1 Add Child View of Groups................................................................................................................. 128
4.4.2 View Group Properties.......................................................................................................................132
4.5 Managing Nodes...................................................................................................................................... 134
4.5.1 Add Child View of Nodes.................................................................................................................. 136
4.5.2 View Node Properties........................................................................................................................ 139
4.6 Managing Interfaces.................................................................................................................................156
4.6.1 Add Child View of Interfaces............................................................................................................. 157
4.6.2 View Interface Properties...................................................................................................................161
5 Managing Faults........................................................................................................................ 167
5.1 Overview of Fault Management...............................................................................................................167
5.2 Monitoring Network Events...................................................................................................................... 171
5.2.1 Add Child View of Events..................................................................................................................172
5.2.2 Edit View Criteria of Events...............................................................................................................174
5.2.3 Remove a View..................................................................................................................................175
5.2.4 Search................................................................................................................................................ 175
5.2.5 Customize Columns of Child View.................................................................................................... 176
5.2.6 View Event Properties....................................................................................................................... 176
5.3 Monitoring Network Alarms...................................................................................................................... 178
5.3.1 Overview of Alarms............................................................................................................................180
5.3.2 Add Child View of Alarms..................................................................................................................181
5.3.3 Edit View Criteria of Alarms.............................................................................................................. 184
5.3.4 Remove a View..................................................................................................................................185
5.3.5 Search................................................................................................................................................ 185
5.3.6 Customize Columns of Child View.................................................................................................... 185
5.3.7 View Alarm Properties....................................................................................................................... 186
5.4 Monitoring Syslog Events........................................................................................................................ 189
5.4.1 Add Child View of Syslog Events......................................................................................................190
5.4.2 Edit View Criteria of Syslog Events...................................................................................................192
5.4.3 Remove a View..................................................................................................................................193
5.4.4 Search................................................................................................................................................ 193
5.4.5 Customize Columns of Child View.................................................................................................... 194
5.4.6 View Syslog Event Properties........................................................................................................... 194
5.5 Monitoring Syslog Alarms........................................................................................................................ 196
5.5.1 Add Child View of Syslog Alarms......................................................................................................198
5.5.2 Edit View Criteria of Syslog Alarms...................................................................................................201
5.5.3 Remove a View..................................................................................................................................202
5.5.4 Search................................................................................................................................................ 202
5.5.5 Customize Columns of Child View.................................................................................................... 202
5.5.6 View Syslog Alarm Properties........................................................................................................... 203
5.6 Reference Information..............................................................................................................................206
5.6.1 EMS Trap List.................................................................................................................................... 206
5.6.2 Network Elements Alarms Clearing and Correlation......................................................................... 206
5.6.3 BroadWorks Faults Correlation..........................................................................................................207

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 5
 6 Configuring Nodes.................................................................................................................... 209
6.1 About Configuration Management........................................................................................................... 209
6.1.1 Configuration Management System Conventions............................................................................ 209
6.1.2 Configuration Management Task Flow.............................................................................................. 211
6.1.3 Configure Common Server Types..................................................................................................... 211
6.1.4 Configure Nodes................................................................................................................................ 214
6.1.5 References to Common Configuration Documentation..................................................................... 216
6.2 Performing Revision Handling..................................................................................................................217
6.3 Managing Node Configurations................................................................................................................218
7 Configuring Security................................................................................................................. 219
7.1 Configuring Users.....................................................................................................................................219
7.1.1 Add User............................................................................................................................................ 220
7.1.2 Modify User Profile............................................................................................................................ 222
7.1.3 Add Multiple Users.............................................................................................................................223
7.2 Configuring Groups.................................................................................................................................. 225
7.2.1 Add Group..........................................................................................................................................226
7.2.2 Modify Group......................................................................................................................................227
7.3 Defining Schedules.................................................................................................................................. 229
7.3.1 Assign Schedule to User................................................................................................................... 230
7.4 Stale User Accounts................................................................................................................................ 231
7.5 Security Breach Detection....................................................................................................................... 231
8 Monitoring Performance........................................................................................................... 232
8.1 Overview of Performance Monitoring.......................................................................................................233
8.2 Collecting Performance Data................................................................................................................... 234
8.2.1 Configure Data Collection.................................................................................................................. 234
8.3 Monitoring Health Status..........................................................................................................................252
8.3.1 Multiplicator Ratio for Health Status Change.................................................................................... 254
8.3.2 Data Collection, Threshold and Health Status Interactions............................................................... 254
8.3.3 View Network Health Status.............................................................................................................. 254
8.3.4 View Health Statistics Details............................................................................................................ 256
8.3.5 Adjust Thresholds for New Hardware................................................................................................257
8.4 Viewing Reports and Graphs of Statistics............................................................................................... 265
8.4.1 Display a Report for Managed Objects and Statistics.......................................................................265
8.4.2 Create a Graph.................................................................................................................................. 267
8.4.3 Create a Report for Key Statistics.....................................................................................................268
8.4.4 Report Formats.................................................................................................................................. 269
8.5 Monitoring JVM........................................................................................................................................ 270
8.5.1 JVM Management - FE Server Details..............................................................................................272
8.5.2 JVM Management - Client Details.....................................................................................................274
8.6 View the Performance Status of a Node................................................................................................. 275
8.7 Configure List of Statistics (Health Status).............................................................................................. 276
8.7.1 Statistics Reference........................................................................................................................... 276
8.8 Configure List of Statistics (Daily)............................................................................................................282
8.8.1 Statistics Reference........................................................................................................................... 282
8.9 Configure Threshold Modifier Actions......................................................................................................288
9 Configuring Administration......................................................................................................290
9.1 Admin Tab................................................................................................................................................ 290
9.2 Managing Nodes...................................................................................................................................... 291
9.2.1 Add Node........................................................................................................................................... 291
9.2.2 Refresh Node..................................................................................................................................... 294
9.2.3 Delete Node....................................................................................................................................... 295
9.3 Configuring Settings After First Discovery............................................................................................... 296
9.3.1 Configure Logs...................................................................................................................................296
9.3.2 Configure Security Management....................................................................................................... 296
9.3.3 Configure Performance Management................................................................................................ 297

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 6
 9.3.4 Configure Centralized Syslog............................................................................................................ 298
9.3.5 Configure Auto-Configuration Parameters......................................................................................... 300
9.3.6 Configure Miscellaneous Settings......................................................................................................302
9.3.7 Configure Fault Management Parameters.........................................................................................303
9.4 Configuring Filter Actions, Traps, Events, and Alarms............................................................................ 306
9.4.1 Configure Filter Actions..................................................................................................................... 306
9.4.2 Configure Trap Parsers..................................................................................................................... 313
9.4.3 Configure Event Parsers....................................................................................................................321
9.4.4 Configure Event Filters...................................................................................................................... 326
9.4.5 Configure Alarm Filters...................................................................................................................... 331
9.5 Configuring E-mail....................................................................................................................................336
9.5.1 Configure E-mail Parameters.............................................................................................................336
9.5.2 Configure E-mail Distribution Lists.....................................................................................................338
9.6 Managing MIBs........................................................................................................................................ 339
9.6.1 Configuration...................................................................................................................................... 341
9.6.2 Upload MIB........................................................................................................................................ 341
9.6.3 SNMP Operations.............................................................................................................................. 342
9.6.4 Retrieve Table Data...........................................................................................................................344
9.7 Viewing Audit Trails................................................................................................................................. 344
9.7.1 View Audit Trail Details..................................................................................................................... 345
9.8 Configure License Reporting....................................................................................................................346
9.9 Advanced Administration..........................................................................................................................349
9.9.1 Suppress Superfluous Alarms/Events............................................................................................... 349
9.9.2 Trigger E-mail at Threshold Crossing................................................................................................349
10 Managing Centralized Services............................................................................................. 352
10.1 Performing User Migration..................................................................................................................... 352
10.1.1 Configure User Migration................................................................................................................. 353
10.1.2 Add User Migration Configuration....................................................................................................355
10.1.3 Migration Phases............................................................................................................................. 358
10.1.4 Execute User Migration................................................................................................................... 373
10.2 Setting Up Maintenance Tasks..............................................................................................................376
10.2.1 Apply Maintenance Task Setup....................................................................................................... 380
10.3 Managing Audible Alarms...................................................................................................................... 382
10.3.1 Configure Filters for Audible Alarms................................................................................................383
10.4 Managing Service Packs....................................................................................................................... 385
10.4.1 About Service Pack Migration......................................................................................................... 387
10.4.2 Perform Service Pack Migration...................................................................................................... 388
11 Managing Software Lifecycle................................................................................................. 418
11.1 Modifying EMS User Account................................................................................................................ 418
11.2 Using Patch Management......................................................................................................................419
11.2.1 Create Patch Schedule.................................................................................................................... 420
11.2.2 Configure Download Credentials..................................................................................................... 421
11.2.3 Configure Patch Center E-mails...................................................................................................... 422
11.2.4 Configure Software Manager Auto Update......................................................................................423
11.2.5 Using EMS Patch Support Center...................................................................................................424
11.2.6 Managing Patches for Node............................................................................................................ 429
11.2.7 BroadSoft Patch Center Substitution............................................................................................... 438
12 Managing Licenses................................................................................................................. 441
12.1 Terminology............................................................................................................................................ 441
12.2 Reporting on Licenses........................................................................................................................... 442
12.2.1 Overview...........................................................................................................................................442
12.2.2 Configure License Data Collection................................................................................................. 444
12.2.3 Configure Thresholds.......................................................................................................................445
12.2.4 Configure Usage Report.................................................................................................................. 448
12.2.5 Configure Reverse Lookup Report.................................................................................................. 452

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 7
 12.2.6 View Periodic Report Results.......................................................................................................... 459
12.2.7 View Reverse Lookup Report Results.............................................................................................489

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 8
List of Figures

Figure 1: TMN-layered Management Model View of BroadWorks Network..................................................... 18

Figure 2: Interface View of BroadWorks TMN-layered Network.......................................................................19
Figure 3: Software Components....................................................................................................................... 20
Figure 4: Northbound and Southbound Interface Interactions..........................................................................22
Figure 5: Login.................................................................................................................................................. 33
Figure 6: Basic Components of Web Client..................................................................................................... 34
Figure 7: Severity Representation.................................................................................................................... 35
Figure 8: Add Node.......................................................................................................................................... 37
Figure 9: Discover BroadWorks Servers.......................................................................................................... 41
Figure 10: Sample Node Statistics................................................................................................................... 46
Figure 11: Southbound Interface Configuration................................................................................................48
Figure 12: BW Network Maps.......................................................................................................................... 49
Figure 13: Configure Node Access...................................................................................................................52
Figure 14: Node Access (Page 1).................................................................................................................... 54
Figure 15: Discover BroadWorks Servers........................................................................................................ 55
Figure 16: General Information Properties....................................................................................................... 58
Figure 17: User Properties................................................................................................................................58
Figure 18: Status Monitoring.............................................................................................................................59
Figure 19: Interfaces & Parents........................................................................................................................59
Figure 20: Protocol Configuration..................................................................................................................... 59
Figure 21: Interfaces......................................................................................................................................... 59
Figure 22: Other Graphs...................................................................................................................................60
Figure 23: Alarm Descriptions.......................................................................................................................... 60
Figure 24: Add Node........................................................................................................................................ 62
Figure 25: Routing Table.................................................................................................................................. 72
Figure 26: Interfaces......................................................................................................................................... 73
Figure 27: TCP Table....................................................................................................................................... 74
Figure 28: UDP Table....................................................................................................................................... 76
Figure 29: IPNet to Media Table...................................................................................................................... 77
Figure 30: Refresh Node Results..................................................................................................................... 78
Figure 31: Configure Node Access...................................................................................................................79
Figure 32: Node Access (Page 1).................................................................................................................... 81
Figure 33: Discover BroadWorks Servers........................................................................................................ 83
Figure 34: Inventory Menu................................................................................................................................85
Figure 35: Complete View................................................................................................................................ 86
Figure 36: Add Topology Child View................................................................................................................87
Figure 37: Edit Topology View Criteria - Complete View................................................................................. 89
Figure 38: Advanced Search............................................................................................................................ 89

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 9
 Figure 39: Customize Columns........................................................................................................................ 90
Figure 40: Network Properties.......................................................................................................................... 91
Figure 41: Node Properties...............................................................................................................................95
Figure 42: Routing Table................................................................................................................................ 105
Figure 43: Interfaces....................................................................................................................................... 106
Figure 44: TCP Table..................................................................................................................................... 107
Figure 45: UDP Table..................................................................................................................................... 108
Figure 46: IPNet to Media Table.................................................................................................................... 109
Figure 47: Refresh Node Results................................................................................................................... 110
Figure 48: Group Properties........................................................................................................................... 111
Figure 49: Interface Properties....................................................................................................................... 114
Figure 50: Networks........................................................................................................................................ 119
Figure 51: Add Topology Child View..............................................................................................................120
Figure 52: Edit Topology View Criteria - Networks........................................................................................ 122
Figure 53: Advanced Search.......................................................................................................................... 122
Figure 54: Customize Columns...................................................................................................................... 123
Figure 55: Network Properties........................................................................................................................ 124
Figure 56: Groups........................................................................................................................................... 127
Figure 57: Groups........................................................................................................................................... 129
Figure 58: Edit Topology View Criteria - Groups........................................................................................... 130
Figure 59: Advanced Search.......................................................................................................................... 131
Figure 60: Customize Columns...................................................................................................................... 131
Figure 61: Group Properties........................................................................................................................... 132
Figure 62: Nodes............................................................................................................................................ 135
Figure 63: Add Topology Child View..............................................................................................................136
Figure 64: Edit Topology View Criteria - Nodes.............................................................................................138
Figure 65: Advanced Search.......................................................................................................................... 138
Figure 66: Customize Columns...................................................................................................................... 139
Figure 67: Node Properties.............................................................................................................................140
Figure 68: Routing Table................................................................................................................................ 150
Figure 69: Interfaces....................................................................................................................................... 151
Figure 70: TCP Table..................................................................................................................................... 152
Figure 71: UDP Table..................................................................................................................................... 153
Figure 72: IPNet to Media Table.................................................................................................................... 154
Figure 73: Refresh Node Results................................................................................................................... 155
Figure 74: Interfaces....................................................................................................................................... 156
Figure 75: Interfaces....................................................................................................................................... 158
Figure 76: Edit Topology View Criteria - Interfaces....................................................................................... 159
Figure 77: Advanced Search.......................................................................................................................... 160
Figure 78: Customize Columns...................................................................................................................... 161

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 10
 Figure 79: Interface Properties....................................................................................................................... 162
Figure 80: Syslog Message Flow – Managed Objects to/from EMS.............................................................. 168
Figure 81: Flow of Notifications...................................................................................................................... 169
Figure 82: Network Events............................................................................................................................. 172
Figure 83: Add Event Child View................................................................................................................... 173
Figure 84: Advanced Search.......................................................................................................................... 175
Figure 85: Customize Columns...................................................................................................................... 176
Figure 86: Event Properties............................................................................................................................ 177
Figure 87: Network Alarms............................................................................................................................. 179
Figure 88: Add Alarm Child View................................................................................................................... 182
Figure 89: Advanced Search.......................................................................................................................... 185
Figure 90: Customize Columns...................................................................................................................... 186
Figure 91: Alarm Properties............................................................................................................................187
Figure 92: Annotation & History..................................................................................................................... 188
Figure 93: Related Alarms.............................................................................................................................. 188
Figure 94: Syslog Events................................................................................................................................190
Figure 95: Add (Syslog) Event Child View..................................................................................................... 191
Figure 96: Advanced Search.......................................................................................................................... 193
Figure 97: Customize Columns...................................................................................................................... 194
Figure 98: Syslog Event Properties................................................................................................................ 195
Figure 99: Syslog Alarms................................................................................................................................196
Figure 100: Add (Syslog) Alarm Child View................................................................................................... 199
Figure 101: Advanced Search........................................................................................................................ 202
Figure 102: Customize Columns.................................................................................................................... 203
Figure 103: Syslog Alarm Properties..............................................................................................................203
Figure 104: Annotation & History....................................................................................................................204
Figure 105: Related Alarms............................................................................................................................ 205
Figure 106: Configuration Management Menu............................................................................................... 210
Figure 107: Help on Parameters.................................................................................................................... 210
Figure 108: Common Configuration................................................................................................................211
Figure 109: Common Configuration Revisions............................................................................................... 212
Figure 110: Node Configuration......................................................................................................................214
Figure 111: Revision Handling........................................................................................................................217
Figure 112: Manage Node Configuration....................................................................................................... 218
Figure 113: User Configuration.......................................................................................................................219
Figure 114: Add User..................................................................................................................................... 221
Figure 115: Modify Profile...............................................................................................................................222
Figure 116: Add Multiple Users...................................................................................................................... 224
Figure 117: Group Configuration.................................................................................................................... 225
Figure 118: Add Group................................................................................................................................... 226

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 11
 Figure 119: Modify Group............................................................................................................................... 227
Figure 120: Schedules Wizard........................................................................................................................229
Figure 121: Assign Schedule/Override........................................................................................................... 230
Figure 122: Configured Collection.................................................................................................................. 235
Figure 123: Add Polling Object.......................................................................................................................240
Figure 124: Add Threshold............................................................................................................................. 245
Figure 125: Add Statistic.................................................................................................................................249
Figure 126: Health Status Details...................................................................................................................255
Figure 127: Health Statistics Details...............................................................................................................256
Figure 128: Report – Managed Objects and Statistics...................................................................................265
Figure 129: Report Profile...............................................................................................................................266
Figure 130: Historical Report Management.................................................................................................... 267
Figure 131: Graph – Managed Objects and Statistics................................................................................... 267
Figure 132: Key Statistics............................................................................................................................... 268
Figure 133: XSL Format................................................................................................................................. 269
Figure 134: JVM Management....................................................................................................................... 271
Figure 135: JVM Management - FE Server Details....................................................................................... 273
Figure 136: JVM Management - Client Details.............................................................................................. 274
Figure 137: Performance Status.....................................................................................................................275
Figure 138: Configure the List of Statistics.................................................................................................... 276
Figure 139: Configure the List of Statistics (Daily).........................................................................................282
Figure 140: Threshold Modifier Actions..........................................................................................................288
Figure 141: Admin Tab................................................................................................................................... 290
Figure 142: Add Node.................................................................................................................................... 292
Figure 143: Refresh Node.............................................................................................................................. 294
Figure 144: Refresh Results (from Admin Tab)............................................................................................. 295
Figure 145: Delete Node.................................................................................................................................295
Figure 146: Security Management Configuration........................................................................................... 296
Figure 147: Performance Management Configuration....................................................................................297
Figure 148: Centralized Syslog Configuration................................................................................................ 299
Figure 149: Auto-Config Management Configuration..................................................................................... 301
Figure 150: Miscellaneous Management Configuration..................................................................................302
Figure 151: Fault Management Configuration................................................................................................ 304
Figure 152: Filter Actions................................................................................................................................307
Figure 153: Configure Suppress Action..........................................................................................................308
Figure 154: Configure Run Cmd Action......................................................................................................... 308
Figure 155: Configure Send Trap Action........................................................................................................310
Figure 156: Configure Send E-mail Action..................................................................................................... 312
Figure 157: Configure Custom Filter.............................................................................................................. 313
Figure 158: Trap Parser Configuration........................................................................................................... 314

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 12
 Figure 159: Add Trap Parser..........................................................................................................................316
Figure 160: Load Trap Parsers...................................................................................................................... 320
Figure 161: Save Trap Parser........................................................................................................................ 321
Figure 162: Event Parsers.............................................................................................................................. 321
Figure 163: Add Event Parser........................................................................................................................ 322
Figure 164: Load Event Parser...................................................................................................................... 325
Figure 165: Save Event Parser...................................................................................................................... 325
Figure 166: Event Filters.................................................................................................................................326
Figure 167: Add Event Filter...........................................................................................................................328
Figure 168: Load Event Filters....................................................................................................................... 330
Figure 169: Save Event Filters....................................................................................................................... 331
Figure 170: Alarm Filters................................................................................................................................ 332
Figure 171: Alarm Filters: Configure Alarm Filter........................................................................................... 333
Figure 172: Load Alarm Filters....................................................................................................................... 335
Figure 173: Save Alarm Filters....................................................................................................................... 336
Figure 174: Email Parameters........................................................................................................................ 337
Figure 175: Email Distribution Management...................................................................................................338
Figure 176: Email Distribution Configuration.................................................................................................. 339
Figure 177: MIB Browser................................................................................................................................ 340
Figure 178: Set Parameters Window..............................................................................................................341
Figure 179: Auth Audit.................................................................................................................................... 344
Figure 180: Audit Details................................................................................................................................ 345
Figure 181: License Reporting Configuration................................................................................................. 346
Figure 182: Data Migration Flow.................................................................................................................... 353
Figure 183: User Migration Management....................................................................................................... 354
Figure 184: User Migration Configuration.......................................................................................................356
Figure 185: Execute Migration........................................................................................................................374
Figure 186: Configure Maintenance Tasks Setup.......................................................................................... 377
Figure 187: Apply Maintenance Task............................................................................................................. 381
Figure 188: Audible Alarm Management........................................................................................................ 382
Figure 189: Audible Alarm Management - Configure Filters.......................................................................... 383
Figure 190: Application Server Clusters with EMS.........................................................................................386
Figure 191: States of Migration Task............................................................................................................. 388
Figure 192: Service Pack Migration................................................................................................................389
Figure 193: Add Service Pack Migration Task............................................................................................... 392
Figure 194: Clusters Selection........................................................................................................................394
Figure 195: Service Providers/Enterprises..................................................................................................... 396
Figure 196: Groups......................................................................................................................................... 398
Figure 197: User Selection............................................................................................................................. 400
Figure 198: Service Packs and User Services to Remove............................................................................ 402

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 13
 Figure 199: Service Packs and User Services to Assign...............................................................................404
Figure 200: Modify Service Pack Migration Task........................................................................................... 405
Figure 201: Add Service Pack Migration Task............................................................................................... 409
Figure 202: Service Pack Management – Service Providers/Enterprises...................................................... 410
Figure 203: Service Pack Management – Service Packs.............................................................................. 410
Figure 204: Service Pack Management - Service Packs............................................................................... 411
Figure 205: Service Pack Management – Confirmation................................................................................. 413
Figure 206: Add Service Pack Migration Task............................................................................................... 414
Figure 207: Service Pack Management - Service Providers/Enterprises....................................................... 415
Figure 208: Service Packs..............................................................................................................................416
Figure 209: Service Providers/Enterprises..................................................................................................... 416
Figure 210: Modify EMS Account................................................................................................................... 418
Figure 211: Patch Management..................................................................................................................... 419
Figure 212: BroadSoft Patch Center Schedule.............................................................................................. 421
Figure 213: BroadSoft Patch Center Credentials........................................................................................... 422
Figure 214: BroadSoft Patch Center Distribution........................................................................................... 423
Figure 215: SWManager AutoUpdate.............................................................................................................423
Figure 216: Patch Support Center..................................................................................................................424
Figure 217: Patch Properties.......................................................................................................................... 425
Figure 218: Patch Bundle Creation - Confirmation Page............................................................................... 428
Figure 219: Patch re-download - Confirmation Page..................................................................................... 429
Figure 220: NE Patch Level........................................................................................................................... 430
Figure 221: Missing PB NE Patch..................................................................................................................431
Figure 222: View Schedules........................................................................................................................... 434
Figure 223: Detailed Patch Level................................................................................................................... 435
Figure 224: Detailed Patch Level - DEPLOYED Group................................................................................. 437
Figure 225: History..........................................................................................................................................438
Figure 226: Detailed Patch Level - EXCLUDED Group................................................................................. 438
Figure 227: BroadSoft Patch Center Credentials........................................................................................... 439
Figure 228: BroadSoft Patch Center Directory Structure............................................................................... 440
Figure 229: Reporting Process....................................................................................................................... 443
Figure 230: Threshold Configuration.............................................................................................................. 446
Figure 231: Threshold Configuration.............................................................................................................. 447
Figure 232: Usage Report Configuration........................................................................................................449
Figure 233: Usage Report.............................................................................................................................. 451
Figure 234: Reverse Lookup Configuration.................................................................................................... 453
Figure 235: Service Licenses Selection......................................................................................................... 456
Figure 236: Service License Pack Selection.................................................................................................. 457
Figure 237: Reverse Lookup Report.............................................................................................................. 458
Figure 238: Periodic Reports.......................................................................................................................... 459

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 14
 Figure 239: HTML License – Network Report (1).......................................................................................... 460
Figure 240: HTML License – Network Report (2).......................................................................................... 461
Figure 241: HTML License – Network Report (3).......................................................................................... 461
Figure 242: HTML License – Network Report (4).......................................................................................... 462
Figure 243: HTML License – Network Report (5).......................................................................................... 463
Figure 244: HTML License – Network Report (6).......................................................................................... 464
Figure 245: HTML License – AS Cluster Report (1)...................................................................................... 465
Figure 246: HTML License – AS Cluster Report (2)...................................................................................... 466
Figure 247: HTML License – AS Cluster Report (3)...................................................................................... 466
Figure 248: HTML License – AS Cluster Report (4)...................................................................................... 467
Figure 249: HTML License – AS Cluster Report (5)...................................................................................... 467
Figure 250: HTML License – AS Cluster Report (6)...................................................................................... 468
Figure 251: HTML License – AS Cluster Report (7)...................................................................................... 469
Figure 252: HTML License – Service Provider Report...................................................................................471
Figure 253: HTML License – Group Report................................................................................................... 472
Figure 254: HTML License – User Report..................................................................................................... 473
Figure 255: CSV License – Network Report.................................................................................................. 474
Figure 256: CSV License – AS Cluster Report.............................................................................................. 476
Figure 257: CSV License – Service Provider Report..................................................................................... 478
Figure 258: CSV License – Group Report..................................................................................................... 479
Figure 259: CSV License – User Report........................................................................................................480
Figure 260: XML License – Network Report.................................................................................................. 481
Figure 261: XML License – AS Cluster Report.............................................................................................. 483
Figure 262: XML License – Service Provider Report..................................................................................... 485
Figure 263: XML License – Group Report..................................................................................................... 486
Figure 264: XML License – User Report........................................................................................................488
Figure 265: Reverse Lookup Results............................................................................................................. 489
Figure 266: HTML – Reverse Lookup AS Cluster Report.............................................................................. 490
Figure 267: HTML Reverse Lookup Service Provider Report........................................................................ 491
Figure 268: HTML Reverse Lookup Group Report........................................................................................ 492
Figure 269: HTML Reverse Lookup User Report...........................................................................................493
Figure 270: CSV Reverse Lookup AS Cluster Report................................................................................... 494
Figure 271: CSV Reverse Lookup Service Provider Report.......................................................................... 495
Figure 272: CSV Reverse Lookup Group Report...........................................................................................496
Figure 273: CSV Reverse Lookup User Report............................................................................................. 497
Figure 274: XML Reverse Lookup AS Cluster Report................................................................................... 498
Figure 275: XML Reverse Lookup Service Provider Report.......................................................................... 499
Figure 276: XML Reverse Lookup Group Report...........................................................................................500
Figure 277: XML Reverse Lookup User Report............................................................................................. 501

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 15
Performance Monitoring Program

BroadWorks offers a performance monitoring program designed to help BroadSoft customers monitor
their system resources. You only need to set up your system so that it sends an alert to the BroadSoft
Technical Assistance Center (TAC) in the event of a health status change. When TAC receives the alert,
it investigates the cause of the status change (if you grant BroadSoft remote access to your system) and
provides you with the results of the analysis and the recommendations.
To participate in the program:
1) Open a TAC ticket in ExtraView, which is a request to participate.
2) Enter the following information:
• Title: Performance Monitoring Program
• Description: Send us details on how to participate in the BroadSoft performance monitoring
program.
• Severity: Set to "Informational".
• Remote access information. For information on secure remote access recommendations, see
BroadSoft TAC Overview from the BroadSoft Xchange.
• Address (Fully Qualified Domain Name [FQDN] or Internet Protocol [IP]) of a Simple Network
Management Protocol (SNMP) server that can relay e-mail from your Element Management System
(EMS) to BroadSoft TAC.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 16
1 EMS Overview

This section provides an overview of the Element Management System (EMS).

This section describes the following:
• Network Management on page 17
• Network Architecture on page 18
• Software Components on page 19
• Interactions with Northbound and Southbound Interfaces on page 21
• EMS Functions on page 23
• Default User Groups on page 30
• User Interfaces on page 31
• Managed Objects on page 31
EMS and BroadWorks Servers
The BroadWorks Element Management System (EMS) is a server that provides a single point of entry
into BroadWorks for a system provider’s Operations, Administration, and Maintenance (OAM) systems.
The EMS provides visibility to all BroadWorks servers for provisioning, network management, and
maintenance.
The EMS is the central component for managing the following BroadWorks servers:
• Application Server
• Call Detail Server
• Conferencing Server
• Database Server
• Execution Server
• Media Server
• Network Server
• Service Control Function
• Web Server- The Web Servers were discontinued with Release 17.0 but the Element Management
System continues to support older releases.
The Element Management System cannot auto-discover Profile Server, Xtended Services Platform, or
Access Mediation Server nodes. To manage these servers, they must be populated using the Add Node
feature.
For more information:

1.1 Network Management

The TeleManagement Forum (TM Forum) defines a Telecommunication Management Network (TMN)
layered model, with interfaces that map the management functions and communication for the operation,
administration, and maintenance (OA&M) of networks and services in a multi-vendor environment. This
model includes the following layers:
1) Network element (BrooadWorks servers)
2) Element management (EMS)
3) Network management
4) Service management
5) Business management
The EMS focuses only on the first two layers with well-defined northbound interfaces to layer 3.
Network Management Areas

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 17
 In addition to the TMN layering structure, the International Telecommunications Union –
Telecommunications (ITU– T) also splits the general management functionality provided by management
systems into five key areas: Fault, Configuration, Accounting, Performance, and Security (FCAPS).
This categorization is a functional one and does not describe the business-related role of a management
system in a telecommunications network. The FCAPS concept stems directly from the ITU–T
recommendations and describes the five different types of information handled by management systems.

1.2 Network Architecture

The EMS fits into the TMN-layered management model. In this architectural model, the EMS provides a
single point of access for managing the fault, performance, and configuration components of BroadWorks
servers. The EMS also provides access to the management interfaces on the BroadWorks servers
through tools that centralize this task.
The following figure shows a TMN-layered management model view of a BroadWorks network.

Figure 1: TMN-layered Management Model View of BroadWorks Network

The EMS provides multiple human-to-machine and machine-to-machine interfaces. The EMS makes use
of the existing interfaces of the BroadWorks managed elements. From an EMS-layer perspective, the
EMS communicates southbound to the BroadWorks managed elements through the following interfaces:
• Simple Network Management Protocol (SNMP)
• Network Server (NS) OSS Portal API
• Application Server (AS) Portal API
• Secured Shell (SSH)
• Software Manager API (BCCT)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 18
 The EMS acts as an SNMP proxy for BroadWorks managed elements to communicate northbound to the
network management system (NMS) layer and above. The EMS supplements the northbound interface
with its own functionality to report aggregate events and data.

Figure 2: Interface View of BroadWorks TMN-layered Network

1.3 Software Components

The following figure shows the EMS software components.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 19
 Figure 3: Software Components

BroadWorks EMS Core

BroadWorks EMS core has two sub-cores: The framework core and the Simple Network Management
Protocol (SNMP) core.
The framework core has processes that ensure the normal operation of the EMS. They consist of the core
business logic related to management functions such as fault, configuration, performance, security, service
provisioning, and so on.
In addition to the database (MySQL), the framework core is split in two main processes: The front end
(FE) and the back end (BE).
The main function of the FE is to channel the requests received from clients. The FE takes care
of generating the database views through database read operations, using a completely stateless
architecture. This helps to provide accurate information at all times.
The BE performs network-facing tasks, such as discovery, modeling of discovered objects, receiving and
processing notifications, data collection, report generation, and status polling. The management server
performs core tasks and is the most important part of a BE server. The other services offered by the BE
server are database services, framework services, service access application programming interfaces
(APIs), and communication framework. The BE handles all write access to the database.
The framework core also acts as an SNMP proxy that reports EMS performance management values
and processes SNMP maintenance requests meant to control the EMS. This portion of the core is also
responsible for forwarding traps received from the managed objects to a higher management system.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 20
 The SNMP core is simply a logical grouping of the required processes that provide SNMP functions.
MySQL Database
MySQL database is the selected relational database management system (RDBMS) for the EMS core
software architecture, and provides all necessary internal interfaces to other software components. Note
that any identified database operations are made available through the EMS command line interface (CLI)
(for example, backup and restore operations). An operator should never use the database SQL client to
modify the data store.
SNMP Agent
The EMS SNMP agent subcomponent is responsible for providing the external northbound SNMP
interface, and for feeding EMS alarms using SNMP traps.
SNMP Subagents
The EMS SNMP agent is also an SNMP proxy to other SNMP subagents. The EMS may integrate the
basic Standard Management Committee (SMC) and Sun MIB-II subagents if configured on the host (as
documented in the BroadWorks Sun Manager Center Installation Guide). The subagent configuration is
handled through the EMS SNMP agent. The EMS agent and subagents share the same access list and
trap managers.
Process Monitors
A process monitor is responsible for starting and monitoring a specific individual process. At startup, it
starts the process. In steady state, it restarts the process if it dies.
Command Line Interface
The EMS CLI interface is a stand-alone client that communicates with the EMS using the Operations,
Administration, Maintenance, and Provisioning (OAMP) interface. The CLI is started from a console or
telnet session command line. The CLI can control the EMS through the maintenance-related levels.
Web Server
Apache/Tomcat is the selected Web Server of the EMS core software architecture, and provides all
necessary internal interfaces to other software components and external interfaces to the client tier.
Open Client Server
The Open Client Server (OCS) is a stand-alone process that proxies external XML requests to the network
Operations Support System (OSS) and to the Application Server Open Client Interface (OCI).

1.4 Interactions with Northbound and Southbound Interfaces

The EMS provides multiple human-to-machine and machine-to-machine interfaces. The following
figure depicts the EMS interactions with Southbound and Northbound Interfaces.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 21
 Figure 4: Northbound and Southbound Interface Interactions

The EMS uses the existing interfaces of the BroadWorks managed elements. From an EMS layer
perspective, the EMS communicates southbound to BroadWorks managed elements via the following
interfaces, to perform specific functions:
• BroadWorks Managed Element Simple Network Management Protocol (SNMP) Agent – This interaction
allows the EMS to receive SNMP traps that report application alarms, retrieve the performance
management values, send SNMP maintenance requests, and have access to the BroadWorks
managed object MIBs.
• BroadWorks Managed Element SNMP Subagents – Since the SNMP agent is also an SNMP proxy
to other SNMP subagents (Basic SMC, Sun MIB-II, and TimesTen), the EMS has access to the
subagents' SNMP characteristics as well.
• Network Server Operations Support System (OSS) – This EMS interaction uses various Network
Server OSS commands such as getHostingNes and getHostingNeNodes to enable discovery of other
BroadWorks nodes.
• Network Server and Application Server Portal APIs – This EMS interaction uses the portal application
programming interface (API) command PrepareLoginToken to enable automatic web cut through.
In addition, the EMS acts as an eXtensible Markup Language (XML) and SNMP proxies for BroadWorks-
managed elements to communicate northbound to the Network Management System (NMS) layer (and
above).
• The SNMP northbound interface has several roles. It reports EMS performance management values
and processes SNMP maintenance requests meant to control the EMS via a dedicated Management
Information Base (MIB). It is also responsible for forwarding traps received from managed objects to a
higher management system. In addition, the EMS allows the proxying of performance measurements

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 22
 to a specific managed object (that is, a BroadWorks node), again using a dedicated MIB in a two-step
process (sets the desired node and then obtains requested information).
• When the EMS is configured for basic trap forwarding, the EMS forwards traps to the higher
management system exactly as they were received. The EMS auto-configures the trap table of the
managed object using the shared object identifier (OID) model. Therefore, the forwarded traps use the
shared OID model.
• When the EMS is configured for SNMP alarm forwarding, the EMS forwards the traps using a third-
party MIB that has content that corresponds to the information displayed by the EMS. Therefore, it
encapsulates the mediation regarding the fields received from the managed object. However, this
approach requires knowledge and parsing of a distinct MIB.
• The EMS provides an XML interface via the Open Client Server (OCS) to centralize OSS requests to
any BroadWorks Application Servers (AS) or BroadWorks Network Servers (NS).

1.5 EMS Functions

The EMS provides the capability to automatically discover (auto-discover) most BroadWorks server types
and maintains the list of nodes to reflect changes as they occur on the network. The EMS is dedicated to
the network management of BroadWorks nodes only and excludes support for any other types of devices.
The EMS provides support for Fault, Configuration, Accounting, Performance, and Security (FCAPS)
functions. The management capabilities include:
• Fault management – Alarm handling, correlation, forwarding, and filtering
• Configuration – Auto-discovery, network provisioning, auto-backup and recovery, Centralized Software
Management and cut through to device for configuration
• Performance – Performance monitoring, report generation and data collection, and correlation
• Security – Access management and access audit logs
• BroadWorks tools – BroadWorks management utilities
• Administration tools – Service provisioning, configuration, and performance tuning
• Flexibility – Components and services can be added to the deployed solution to meet the performance,
scalability, and availability goals.
• Maintenance and upgrade – Fast and low-risk upgrades
The EMS has a number of applications and tools designed to simplify and centralize the management
of BroadWorks servers. The EMS enables network monitoring, configuration, and troubleshooting of
individual BroadWorks servers and resources. An entire BroadWorks network can be supervised from
a single platform, where multiple users can access the EMS services simultaneously. The EMS also
provides advanced configuration functions to all BroadWorks servers.
The EMS provides the following functions:
• Proactive alarm and event management with customizable filtering, propagation, and drill down
• Event correlation and root cause analysis
• Multi-level thresholding and hysteresis
• Parameterized eXtensible Markup Language (XML) tasks for streamlining configuration and
provisioning functions
• Configuration management – Add/modify/delete with rollback capability, and audit logs
• Fine-grained security with extensible access control and authorization, with support for users, groups,
roles, operations, and object views
• Supports J2EE security model
• Provides business rules capability for dynamic control
• Customizable reporting
The EMS consists of three tiers of server components as follows:
• Management server (mediation) tier, which provides protocol mediation with the managed systems
• Back-end server tier, which provides database transaction and encapsulation service

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 23
 • Front-end server tier, which provides client session management services
For more information

1.5.1 Maps/Topology
In the EMS, the Topology feature is called Maps. The EMS Maps shows a graphical representation of the
EMS network.
Managed Elements Auto-configuration and Network Auto-discovery
The Auto-configuration and Network Auto-discovery features are interrelated. The Auto-configuration
feature relies on the Network Auto-discovery feature to determine the managed elements. However,
the Auto-configuration feature is triggered first upon the addition of a node. For the provided Network
Server seed, the auto-discovery occurs only once the auto-configuration for the provided Network Server
seed has succeeded. Using this approach, the network auto-discovery confirms that a valid UNIX user
name and password exist for the provided Network Server seed. As auto-discovery identifies other
nodes for addition, the EMS uses the same approach by invoking the auto-configuration feature first.
Nevertheless, a successful auto-configuration is not mandatory, that is, the EMS adds a node even if the
auto-configuration has failed. Upon success, having the Auto-configuration feature invoked first allows the
EMS to add an SNMP node. Note that as auto-configuration populates the SNMP access list, the EMS
successfully queries the SNMP. If the auto-configuration fails, the EMS adds a regular node.
Managed Elements Auto-configuration
As auto-discovery identifies nodes for addition, the EMS runs the Auto-configuration feature. The EMS
uses Secure Shell (SSH) to run remote scripts on the managed node.
The remote script performs the following tasks:
• Auto-populates the EMS IP address to the SNMP access control list (ACL) and trap table (TT)
• The EMS populates the trap table using the OID shared model. Upon receiving traps, the EMS parses
the message text to identify relevant content.
• Auto-populates the EMS IP address to the Network Server OSS access list
• Auto-populates the EMS IP address to the Application Server OCI access list
• Auto-populates the EMS IP address to the BCCT access list
• Auto-configures syslog trap forwarding to the EMS
• Retrieves the platform type
• Retrieves OS information, BroadWorks server type and active release, and the Software Manager
version.
• Puts scripts on each node to collect OS performance information
The above actions allow the automatic enabling of many EMS functionalities. For example, the EMS starts
receiving traps immediately. In addition, the EMS has periodic audits of managed elements to maintain
EMS information for the access control list and trap table. Following the completion of a BroadWorks
network auto-discovery, the EMS generates an event (fault management) to report the auto-configuration
results. The event becomes an alarm if the auto-configuration was not successful. Otherwise, the EMS
generates only an information event.
The auto-configuration relies on the UNIX user name and password for individual nodes to be configured
on the EMS. These are required to update SNMP in the Times Ten database and to log in the the
Command Line Interface (CLI). The user has the following options to configure the UNIX user names and
passwords of managed elements on the EMS:
• Manually manage individual user names and passwords for each node.
• Manually ensure a single user name and password is available across all nodes.
• Enable a centralized user name and password on all managed elements using NIS PLUS (LDAP-
based).
Network Auto-discovery Configuration

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 24
 The EMS allows auto-discovery of most BroadWorks servers. The mechanism is triggered by a
BroadWorks Network Server host name/IP address used as a seed. This action allows the discovery of
other BroadWorks nodes in the network. The network auto-discovery has the following characteristics:
• Auto-discovery and topology update
• Information model to capture attributes of BroadWorks servers
• Topology summary and hierarchical representation of managed resources
• Intelligent grouping for simplified configuration management and performance management
The Auto-discovery functionality provides a user interface to trigger manual rediscovery, and configure an
optional rediscovery interval.
Following the completion of a BroadWorks network auto-discovery, the EMS generates an event (fault
management) to report the discovery result. The event becomes an alarm if the discovery was not
successful. Otherwise, the EMS generates only an information event.
Add Node
The EMS provides a manual Add Node feature that allows the population of individual network elements
one at the time. Although it is possible to use this approach for all nodes within an EMS span of control,
its use is recommended only for adding BroadWorks server types that the EMS auto-discovery does not
support such as the Profile Server, PS the Xtended Services Platform, or the Access Mediation Server
nodes.
The EMS auto-discovery process does not support element network with multiple interfaces: one for
signaling and one for management. The EMS auto-discovery process gets the signaling interface from the
Network Server when the management interface should be used to add the node. The manual Add Node
feature must be used instead.
Similarly to auto-discovery, the Add Node feature invokes the auto-configuration functionality. The EMS
adds the requested node only if its auto-configuration succeeded.
For more information on the maps/topology, see Using BroadWorks Network Maps on page 49.

1.5.2 Inventory
For inventory management, the EMS provides an information base of BroadWorks components and
devices across the network. For more information on the inventory, see Overview of Inventory on page
85.

1.5.3 Fault Management

The EMS offers sophisticated fault management capabilities for proactive management of network
reliability and availability. The EMS architecture allows for easy integration of events from diverse
BroadWorks network elements, and provides methods to process, correlate, and present alarms and
events based on domain-specific requirements. The fault management capabilities include the following:
• Support of northbound SNMP interfaces (for trap forwarding)
• Event/trap processing – Filtering, suppression, and propagation
• Intelligent correlation and color-coded alarm views
• Alarm drill down categorized by severity, managed resource type, and time of day
• Fault remedy work flow management – Categorize alarms as opened, acknowledged, or closed
For fault management, the EMS acts as an SNMP proxy to relay faults received from other components
and from managed elements, by specifying a list of IP addresses and ports where faults are forwarded.
Enabling a new item on the list does not require a restart of the server.
Defined Severity and Criticality
Trap severities are informational, low, medium, high, and critical. Event severities are info, warning, minor,
major, and critical. Another event severity is clear, which is used to reflect the clearance of a previous
event that had a severity with criticality. The info severity is defined as having no criticality and a severity

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 25
 less than that of the clear severity. The severities minor, major, and critical are defined as having a
criticality and a severity greater than that of the clear severity.
BroadWorks Trap to EMS Event Mapping
The EMS provides a basic mapping, whereby it translates a trap received from a BroadWorks server
into an event. The mapping is as follows:n The trap's severity is mapped to the event's severity. The
trap's BroadWorks server type is mapped to the event's category. The trap's managed object name (or
IP address) is mapped to the event's entity, source, and node. The trap's alarm name is mapped to the
event's name. The trap's alarm text is mapped to the event's message. The trap's recommended action is
mapped to the event's recommended action.
The following BroadWorks traps with an info severity generate an EMS event that has severity with
criticality to better reflect the impact on the server.
• The trap named bwServerStateTransition generates an event with minor severity when the trap's alarm
text meets the following conditions:
• There is a distinct value for the old operational state, as well as the new operational state.
• The new operational state is disabled.
• The trap named bwServerStateTransition generates an event with major severity when the trap's alarm
text meets the following conditions:
• There is a distinct value for the old administrative state, as well as the new administrative state.
• The new administrative state is locked.
• The following traps generate an event with major severity:
• BwPMExecutionServerRestarted
• BwPMExecutionServerDeath
• BwPMProvisioningServerRestarted
• BwPMProvisioningServerDeath
• BwPMMediaServerRestarted
• BwPMMediaServerDeath
• BwPMNetServerRestarted
• BwPMNetServerDeath
• BwPMOpenClientServerRestarted
• BwPMOpenClientServerDeath
• msShutdown
EMS Event to EMS Alarm Mapping
As general rule, a new alarm is generated from an event, if the following two conditions are met by the
generated event:
• If no other alarm exists matching the same event, as that of the event in the EMS
• If the criticality of the event is greater than that of the clear severity.
Subsequently when a new event is generated for the same failure object, the existing alarm is updated. An
event can update an alarm only if any one of the following conditions is met. Note that the name input box
instead of the message input box in the alarm and event are compared, whenever it is sufficient to uniquely
identify an alarm. This approach is performed to improve the system performance. If either:
• The criticality of the event is greater than or equal to that of clear and is different from the current status
of the corresponding alarm, or
• The message input box (or the name input box) of the event is different from the message input box (or
the name input box) of the corresponding alarm, and
• The source input box of the event is different from the source input box of the corresponding alarm.
Alarm Clearing

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 26
 The EMS automatically clears an outstanding alarm for a given managed
object when it receives the same trap with the alarmState input box
(.iso.org.dod.internet.private.enterprises.broadsoft.broadworks.common.systemFaults.faultFields.alarmState
or.1.3.6.1.4.1.6431.1.1.1.1.6) set to “OFF”.
In addition, the EMS automatically clears all outstanding alarms for a given managed object when the
following event is generated:
A trap named bwServerStateTransition, where the trap's alarm text specifies the new operational state as
enabled.

NOTE: This behavior excludes alarms that should always be cleared manually. For example, any alarm
that reports a software error or requires contacting BroadSoft personnel must be cleared manually. For
these exceptions, the alarm indicates the need for a manual clear by the end user.

The EMS trap correlation agent parses the trap's content to simulate support for state-full traps. The
correlation requires parsing into the trap's alarm text to ensure uniqueness of individual alarms.
The following traps follow this behavior:
• bwNetworkDeviceIsFailed, bwNetworkDeviceIsOnline
• bwPMOpenClientServerStartupFailed
• bwPMOpenClientServerLaunched.
Centralized Syslog
This feature aims at centralizing the UNIX syslog capabilities for all managed objects at the EMS. The goal
is to allow an EMS administrator to review all system logs.
The EMS converts syslog messages to EMS events where the category is set to "syslog", thus enabling
EMS administrators to view syslog in a typical EMS events view. Since the syslog integration uses ems
events, it leverages existing ems capabilities to raise ems syslog alarms when an event has a severity with
a criticality.
The integration focuses on the following items:
• Identifying which syslog messages are forwarded to the EMS.
• Specifying how the EMS maps the received syslog messages to EMS events.
This feature aims at centralizing the UNIX syslog capabilities for all managed objects at the EMS. The goal
is to allow an EMS administrator to review all system logs. The EMS converts syslog messages to EMS
events where the category is set to "syslog", thus enabling EMS administrators to view syslog in a typical
EMS events view. Since the syslog integration uses ems events, it leverages existing ems capabilities
to raise ems syslog alarms when an event has a severity with a criticality. The integration focuses on the
following items: n Identifying which syslog messages are forwarded to the EMS. Specifying how the EMS
maps the received syslog messages to EMS events. The following figure summarizes the steps involved
Audible Alarms
The BroadWorks EMS allows administrators to associate an audio file to each alarm severity level. The
administrator also specifies if the audio file is to be played only once or repeatedly.
The audio file for the highest alarm severity gets played if alarms are present at multiple severity levels.
An audible cut-off (ACO) capability allows users to silence audible alarms. If a new alarm comes in after
the audible cut-off is activated, the audible alarm is reactivated.
For more information on fault management, see Overview of Fault Management on page 167.

1.5.4 Configuration Management

EMS Configuration Parameters

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 27
 The BroadWorks EMS integrates configuration parameters to the graphical user interface (GUI). These
parameters map to configuration files. The configuration of the parameters is available through the web
interface.
The configuration pages accessible from the web interface are located in the Admin tab. The Admin
Configuration section includes the following relevant new categories.
• Fault Management Parameters
• Configuration Management Parameters
• Performance Management Parameters
• Security Management Parameters
• Centralized Syslog Management
• Auto-Config Management
For more information on configuration management, see Configuring Settings After First Discovery on
page 296.

1.5.5 Security
The EMS provides the following security features:
• Fine-grained and extensible authorization including support for users, groups, roles, operations, and
object views
• Secure authentication and access control, including Secure Sockets Layer (SSL)
Default User Groups
For addressing the various needs of EMS users and to contain the wider implications of the centralized
functionality, the EMS provides four distinct user-groups:
• CentralizedUsers
• CentralizedAdmin
• Admin
• Users
The users whose list of groups includes the group named CentralizedUsers have the ability to view
information regarding the centralized functionality. Such operations are typically located in the Centralized
Management and Centralized Services tabs of the Web Client interface. For example, a user in the
CentralizedUsers group may view all the information about the patches of remote nodes from the Patch
Management tree item of the Centralized Management tab.
The users whose list of groups includes the group named CentralizedAdmin have the ability to perform
remote operations that have a direct impact on the remote nodes that are within the EMS span of control.
For example, a user in the CentralizedAdmin group may apply a patch on a remote node from the Patch
Management tree item of the Centralized Management tab.
The users whose list of groups includes the group named Admin have the ability to perform configuration
changes whose impacts are limited to the EMS itself. Such operations are typically located in the Admin
tab. For example, a user in the Admin group may set the patch download frequency from the BroadSoft
Patch Center Schedule tree item of the Admin tab.
The users whose list of groups includes the group named Users have the ability to view information about
the information local to the EMS.
Security Breach Detection
The EMS generates a bwEMSLoginFailed alarm and deactivates the user account when a security breach
is detected, that is when a subscriber enters an incorrect password for the same user more than three
consecutive times (default value). Only an EMS administrator can re-enable an account. The security
administration tool available from the applet interface provides a list of disabled accounts. An administrator
must select the Setting Profile button from the User Profile tab to re-enable an account and set the user
status to enable.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 28
 EMS Stale Account Management
The EMS Stale Account Management feature uses a policy within the EMS to deactivate unused EMS
accounts. Using this feature, the service provider in maintaining their BroadWorks system, can ensure that
only valid accounts can be accessed.
This feature addresses the need for removing unused accounts caused by regular churn in personnel,
change in affectations, and regional reorganization. The expiration time (time credit limit) is set within the
Web Client and can be modified. The goal is to perform a periodic check on all accounts and prevent
invalid user accounts from being accessed. Invalid accounts are identified when the last login date/time
exceeds the user allowed login time credit.
For more information on security, see Configuring Security on page 219.

1.5.6 Performance Monitoring

The EMS provides performance measurements (PM) in two ways. First, it provides SNMP polling of all
servers on the network. Second, with BroadWorks-specific scripts, it collects data from the operating
systems of each server to and compares them to pre-defined statistics and thresholds. For more
information on performance management, see Overview of Performance Monitoring on page 233.

1.5.7 Administration
EMS Administration includes configuring discovery, traps, notifications, events, alarms MIBs, and audit
trails, amongst other features. For more information on EMS Administration, see Admin Tab on page
290.

1.5.8 Software Lifecycle

The EMS provides the ability to manage software lifecyles through software downloads.
Centralized Management
This section covers the EMS centralized management that focuses on addressing standard element
management capabilities. The centralized management targets the BroadWorks software as single unit.
In this context, the EMS views all BroadWorks servers as individual black-box entities in which knowledge
of the network element’s internal functionalities is irrelevant.
As part of this centralized management, the EMS serves as an entry point to manage BroadWorks
software, including releases and patches. The support applies to BroadWorks servers that use the
BroadWorks core platform only. Therefore, it excludes the Conferencing Server (CS). This section also
describes an EMS capability for controlling and configuring the BroadWorks maintenance tasks across the
EMS span of control.
Centralized Patching Management
This feature provides centralized patching management to better integrate BroadWorks patches from the
BroadSoft Patch Center (currently known as Xchange) and the BroadWorks servers at customer sites.
The aim is to allow BroadSoft customers to more easily manage their BroadWorks network elements
(NEs) while providing proactive notification on the availability of critical fixes.
The user interfaces provide Xchange-like views from the EMS. From these integrated and centralized
views, an operator can easily review what is available from the BroadSoft Patch Center and compare
them with the patches already installed on the different nodes. In addition, the Web Client enhancements
provide centralized patching actions such as apply and remove patches against multiple nodes in simple
point-and-click operations.
BroadSoft Patch Center Audit Cycle
On a daily basis, the EMS uses directory listing commands to review the list of patches available based on
the list of server release and server type within its management domain. The information retrieved from
the directory listings allows the EMS to gather the initial set of information for every patch while waiting for
the next scheduled download upon which all patch information becomes available.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 29
 In addition to the application patches, the EMS also manages the Software Manager version to ensure that
the latest Software Manager version is always downloaded to the EMS.
In a parallel processing and based on the configured schedule, the EMS automatically downloads newly
available patches. It may be daily, weekly, or monthly. By default, a weekly download occurs. The EMS
downloads patches only if they are related to the BroadWorks server types, BroadWorks releases, and OS
release within its management domain.
The BroadWorks releases include all the currently active releases AND all the installed releases that are
newer than the currently active release. This approach allows an operator to view and apply patches as
soon as an NE is ready for upgrade to a newer release (since the EMS starts downloading the patches
related to a BroadWorks release as soon as a newer release is installed). In addition, the EMS schedules
all patches related to BroadWorks releases that are older than the currently active release for removal.
For more information on software life cycles, see Managing Software Lifecycle on page 418.

1.5.9 Centralized Services

The EMS provides Centralized Services including user migration, maintenance tasks, audible alarms, and
service packs. For more information on centralized services, see Managing Centralized Services on page
352.

1.6 Default User Groups

For addressing the various needs of EMS users and to contain the wider implications of the centralized
functionality, the EMS provides four distinct user groups:
• CentralizedUsers
• CentralizedAdmin
• Admin
• Users
The users whose list of groups includes the group named CentralizedUsers have the ability to view
information regarding the centralized functionality. Such operations are typically located in the Centralized
Networking tab. For example, a user in the CentralizedUsers group can view all the information about the
patches of remote nodes from the Patch Management tree item of the Centralized Networking tab.
The users whose list of groups includes the group named CentralizedAdmin have the ability to perform
remote operations that have a direct impact on the remote nodes that are within the EMS span of control.
For example, a user in the CentralizedAdmin group can apply a patch on a remote node from the Patch
Management tree item of the Centralized Networking tab.
The users whose list of groups includes the group named Admin have the ability to perform configuration
changes where the impacts are limited to the EMS itself. Such operations are typically located in the
Admin tab. For example, a user in the Admin group can set the patch download frequency from the
BroadSoft Patch Center Schedule tree item of the Admin tab.
The users whose list of groups includes the group named Users have the ability to view information about
the information local to the EMS. Such operations are typically located in the other tabs of the Web Client
interface (other than the Admin and Centralized Networking tabs). For example, a user in the Users
group can view all the information about the events and alarms of all the managed nodes from the Fault
Management tab.
User to Groups Default Mappings
The following table lists the mappings of groups for default users created upon a fresh installation of an
EMS.
User Name List of Groups

Admin Users, Admin, CentralizedUsers, CentralizedAdmin

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 30
 User Name List of Groups

Guest Users, CentralizedUsers

For more information

1.6.1 EMS Behavior upon Insufficient Privileges

Once the credentials for a user have been authenticated, the EMS determines the list of available tabs that
are visible to this user based on the user's group permissions. When the user privileges do not include
any functionality from a tab, the EMS hides it. For example, the EMS hides the Admin and Centralized
Networking tabs from a user whose list of groups includes only the Users group.
Nevertheless, when a user is successfully logged in and tries entering a URL manually without having the
required privileges, it is denied explicitly by being redirected to a page that states a generic message about
its lack of privileges.
Similarly, when a user does not have the privileges for a command, they are redirected to the same page
that states a generic message about the user's lack of privileges. However, given that the EMS displays
the same web pages for all users, the buttons provided for operations are always enabled. For example,
a user whose groups include the CentralizedUsers group and exclude the CentralizedAdmin group may
view information about the patches of remote nodes from the Patch Management tree item, but they are
redirected to the page about the lack of privileges using the Apply Patches button.

1.7 User Interfaces

Aside from the web-based graphical user interface, the EMS provides the following user interfaces:
• Command line interface (CLI) # For information on using the CLI, see the BroadWorks EMS Server
Command Line Interface Administration Guide.
• UNIX-based interface # For information on using the UNIX interface, see the BroadWorks Software
Management Administration Guide.

1.8 Managed Objects

Managed objects are typically used to represent each physical component of a system. Thus, a product
typically exposes multiple managed objects through its Management Information Base (MIB). The EMS, at
a high level, is made of three key components: The BroadWorks software (which includes bundled third-
party software, including the database), the platform operating system, and the platform hardware. For
the last two components, operating system (OS) MIBs are delivered and integrated with the BroadWorks
servers.
The EMS also implements a managed object model. It provides the system administrator with a unified
operational and administrative view of the EMS and its underlying components. The EMS supports states
that maintain the administrative state and the operational state of the EMS. The administrative state is not
persistent. Hence, upon a restart, the EMS is in a locked state and transitions to the unlocked state when
fully initialized. The operational state represents the current state of the server. Upon reboot, the EMS goes
to the enabled state.
Administrative states are follows:
• Locked: No observable conditions
• Unlocked: No observable conditions
• Locking: No observable conditions
• Shutting down: All processes on the server are stopped. When completed, the server moves to the
stopped state.
• Forced locking: Upon requesting a forced lock, the server gracefully cleans up its resources.
• Stopped: All the BroadWorks processes are stopped.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 31
 Operational states are as follows:
• Enabled: The server is operable.
• Disabled: The server is not operable.
This command line interface (CLI) level offers EMS server maintenance-related commands that can
be invoked to perform maintenance tasks directly from the CLI client. These commands wrap regular
maintenance tasks by using the product's standard CLI interface. They offer a single point of entry for
managing the overall BroadWorks environment through the CLI client.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 32
2 Getting Started

This section provides information on how to use the Element Management System (EMS) web interface,
as well as, the start-up five procedures to get the EMS up and running.
This section describes the following:
• Using EMS Web Interface on page 33
• Start-up Procedures on page 35
• Configuring Northbound Trap Forwarding on page 46
• Configuring Southbound Interface on page 48

2.1 Using EMS Web Interface

Opening the Web Client
1) Open a JavaScript-enabled web browser.
2) In the Address text box, type "http ://< machine_name >:<port>".
3) The <machine_name> is the name of the BroadWorks EMS server. By default, the BroadWorks EMS
server runs on port 80.
4) Click Login. The Login page appears. The Web Client option is selected by default.

Figure 5: Login
5) In the User Name text box, enter your user name.
6) In the Password text box, enter your password. By default, the user name and password are "admin"
and "admin" respectively, for newly installed systems.
7) Click Login. The Web Client page appears.
8) To log out from the Web Client, click Logout.
For more information

2.1.1 Basic Components of Web Client Work Area

Once you have logged into the Web Client, the major components displayed are the following:
1) Module Tabs
2) Module Menus
3) Module View (In this case, these are the maps with the servers' icons)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 33
 4) Health Summary Panel
5) Alarm Summary Panel

Figure 6: Basic Components of Web Client

Module Tabs
The different module tabs available in the Web Client are the following:
• Maps
• Fault
• Performance
• Inventory
• Admin
• Centralized Networking
Click the tab to display its contents.
Module Menus
A tree containing various nodes is provided on the left side of the Web Client. This tree is different for
each tab. Click each of the tree nodes to display related information on the module view frame of the Web
Client.
Module View
The module view presents detailed information associated with the selected module menu.

Menus are available as drop-down lists, links, and icons . The drop-down list contains a set of
commands you can perform over multiple elements on a page. To perform the same operation over more
than one network element, click the check boxes of those elements, and then select the option on the drop-
down list.
Health Summary Panel
The Health Summary panel gives an overview of the system health. For more information on how to read
and act on the information presented in this panel, see Overview of Performance Monitoring on page
233.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 34
 Alarm Summary Panel
The Alarm Summary panel shows the alarm count for each alarm severity a red (Critical), orange (Major),
yellow (Minor), blue (Warning), or green (Healthy) arrow icon displays. The following figure illustrates the
representation of severity of alarms.

Figure 7: Severity Representation

This panel is below the module tree and is displayed on all the module pages. When you click the count
on this panel, the alarms of a specific severity are displayed in the corresponding alarm panel. For more
information about alarms, see section Overview of Alarms on page 180.

2.2 Start-up Procedures

Following a fresh installation of a EMS, the administrator must perform specific steps before the EMS can
provide its multiple functions. This section aims at providing a short but comprehensive summary of these
required steps.
This document assumes that the reader is familiar with the following concepts:
• Network management concepts
• BroadWorks EMS concepts
• BroadWorks servers and their purpose
• IP network architecture
For more information

2.2.1 Prerequisites
Before beginning to apply the steps documented in this section, all the installation steps must have been
completed. This includes running the post-installation setup and successfully applying all EMS released
patches. The EMS requires specific ports to be opened when using a firewall. For more information, see
the relevant sections documented in the BroadWorks Server Security Guide.
If the server is deployed in a redundant configuration, the database replication must be running and both
peers must be synchronized. An EMS administrator can use the BroadWorks UNIX command repctl status
to confirm this.
Both Front End (FE) and Back End (BE) components of the EMS server must be in a fully running state.
You can use the BroadWorks UNIX command showrun to confirm this.
Finally, this guide assumes that you have logged in with a valid EMS administrator user ID. For information
on configuring the command line interface (CLI) Hypertext Transfer Protocol (HTTP) interfaces to log in
to the Web Client, see the the BroadWorks Application Server Server EMS Configuration Management
Guide.

2.2.2 Configure User Names and Passwords

The first step you must take is to configure the passwords of BroadWorks-managed nodes. The steps
involved vary depending on whether the same password is used for all managed nodes. The EMS uses
the password information entered during this step in many EMS functionalities such as the BroadWorks
Discovery, the node auto-configuration, and the node cut-through. The administrator must adhere to the
following steps to configure passwords (web and secure shell [SSH] access):
Add a user and a group:
1) Add a user with all permissions. For information on how to add a user, see Add User on page 220.
2) Add a group with all permissions. For information on how to add a user, see Add Group on page 226.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 35
 If the same passwords are used for all managed nodes:
1) Click the Maps tab and then click the Configure Node Access link.

NOTE:
The Configuring Node Access link can be used for all types of BroadWorks-managed nodes.
The web browser pop-up blocker must be disabled as the Configuring Node Access link opens a new
window.

2) Click Change Default Parms.

3) Enter the required values.
4) Click Submit Request.
If specific passwords are used for each managed node:
1) Click the Maps tab and then click the Configure Node Access link.
2) Enter the name or IP address of the node to configure.
3) Click Next.
4) Enter the required values.
5) Click Submit Request.
6) Repeat the above steps for every managed node.
BroadSoft Patch Center Credentials
The EMS provides centralized patching management to better integrate BroadWorks patches from
the BroadSoft distribution portal, Xchange, and the BroadWorks servers at customer sites. An EMS
administrator must configure BroadSoft Patch Center credentials to fully enable this functionality and allow
the downloading of relevant patches from BroadSoft Xchange to the EMS.
To configure its BroadSoft Patch Center credentials:
1) Click the Admin tab.
2) From the Patch Management menu, click BroadSoft Patch Center Credentials.
3) Enter a value for the user name and password.
4) Click Configure.

2.2.3 Add Node

The EMS provides a manual Add Node feature that allows you to add individual network elements one at a
time. Although it is possible to use this approach for all nodes within an EMS span of control, its use is only
recommended for adding BroadWorks server types that the EMS auto-discovery does not support, such as
the BroadWorks Profile Server (PS), the Database Server (DBS), and the Xtended Services Platform (Xsp)
nodes. Similar to auto-discovery, when you add a node, the auto-configuration functionality is invoked.
Although it is possible to use this approach for all nodes within an EMS span of control, its use is only
recommended for adding BroadWorks server types that the EMS auto-discovery does not support, such as
the Profile Server, Database Server, and the Xtended Services Platform nodes.
The manual Add Node method must be used for adding BroadWorks servers with multiple interfaces. For
information, see Add BroadWorks Servers with Multiple Interfaces on page 39.
The EMS only adds the requested node if its auto-configuration succeeded. For information on auto-
configuration, see Managed Elements Auto-configuration on page 56.
Use the Add Node page to add a BroadWorks node
.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 36
 Figure 8: Add Node

The information on this page includes the following:

Input Box Description

User Name This text box specifies the user name for Secure Shell (SSH) access to the node.

Password This text box specifies the user password for SSH access to the node.

IP Address This text box specifies the node's Internet Protocol (IP) address.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 37
 Input Box Description

BroadWorks Platform This option specifies whether the node is a BroadWorks server.

Auto Detect BroadWorks This check box determines whether the node type is detected by the add node functionality.
Type

Server Type This drop-down list specifies the server type of the node.

Non-BroadWorks Platform This option specifies whether the node is a non-BroadWorks server.

Non-BroadWorks Platform This drop-down list specifies the server type of the node.
Server Type

Group This drop-down list specifies the name of the group associated with the node.

Associated NS (Network This drop-down list specifies the name of the Network Server seed associated with the node.
Server) Seed

SNMP Port This text box specifies the Simple Network Management Protocol (SNMP) port number.

Read Community This text box specifies the read community.

Write Community This text box specifies the write community.

Enable V3 This check box controls whether the SNMP v3 is enabled on the node.

User Name This text box specifies the SNMP v3 user name.

Context Name This text box specifies the SNMP v3 context name.

To add a node:
1) From the Discovery submenu, click Add Node. The Add Node page appears.
2) In the User Name text box, enter the SSH user name.
3) In the Password text box, enter the SSH password.
4) In the IP Address text box, enter the IP address of the node.
5) If the node is a BroadWorks server:
a) Select BroadWorks Platform, or
b) Select Auto Detect BroadWorks Type to let the add node process identify the type of node.
c) Optionally, unselect Auto Detect BroadWorks Type and select the node type from the Server Type
drop-down list.
6) If the node is not a BroadWorks server:
a) Select Non-BroadWorks Platform.
b) Select the node type from the Non-BroadWorks Platform Server Type drop-down list.
7) Select the Group to associate the node with from the drop-down list.

NOTE: The EMS uses group data for clustering and farm association. Therefore, the same group
can be reused upon adding more nodes of the same server cluster or farm. A group must contain only
nodes of the same server type.

8) Select the Associated NS (Network Server) Seed to associate the node with, from the drop-down list.

NOTE: The Network Server seed association allows the display of the node on the corresponding
BroadWorks maps.

9) In the SNMP Port text box, enter the SNMP port number.
10)In the Read Community text box, enter the read community.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 38
 11)In the Write Community text box, enter the write community.
12)If V3 is enabled on the node:
a) Select Enable V3.
b) In the User Name text box, enter the user name.
c) In the Context Name text box, enter the context name.
13)Click Submit to add the node or click Reset to discard the entries.

2.2.4 Add BroadWorks Servers with Multiple Interfaces

Use this procedure to add BroadWorks Server with multiple interfaces to ensure that the various functions
of the EMS will work properly for these nodes.
1) Edit the /etc/host file on the EMS.
Ensure that all of the nodes you plan to add to the EMS are in the EMS /etc/hosts file with the regular
format (IP, hostname, alias). Add the IP address of the maintenance interface (where the node will
expect to see SNMP/SSH traffic, and so on).
Ensure that the hostname of the node is associated with the maintenance interface of the node (not the
SIP interface). Otherwise, you may experience issues with the EMS Centralized Patching feature.
Example: The following example displays working entries where .10 is the maintenance interface (SSH,
SNMP, etc.) and .11 is the SIP interface for the node with hostname ms1:
10.0.0.10 ms1 ms1.mydom.net
10.0.0.11 ms1-sip ms1-sip.mydom.net
Example: The following example displays a hosts file which causes an issue:
10.0.0.10 ms1-oam ms1-oam.mydom.net
10.0.0.11 ms1 ms1.mydom.net
2) Add the primary Network Server node.
Using the manual Add Node method, add the primary Network Server to your EMS ensuring that you
leave the Group and the Associated NS Seed input boxes blank.
3) Add the secondary Network Server.
Add the secondary Network Server in your cluster and select the Group (there will only be one choice)
that contains the name of the first Network Server that you added. Select the Associated NS Seed as
well (one choice).
When you choose a Group, you create a grouping of like nodes that will be associated with group
statistics. Some statistics are for a group of nodes to indicate performance across the group. If the
group lost a member for example the remaining nodes in the group may not be able to handle the traffic
load being presented to the group as a whole.
4) Add the other nodes.
• Continue adding nodes using the same method. First, add the primary node (for example, a primary
Application Server) without a group. However, select the Associated NS Seed (the first Network
Server added).
• When you add the secondary Application Server, ensure that you add the group associated with
the primary Application Server previously added. The primary and secondary Application Servers
represent a complete group.
• If you are adding an Xtended Services Platform node, you add all Xtended Services Platform nodes
which perform the same tasks to the same group (there can be two or more Xtended Services
Platform nodes to form a group).
• Media Servers do not have a group concept so they can be added without a group.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 39
 NOTE: Select the Associated NS Seed for all nodes which share the same Network Server cluster.
If you have a separate Network Server cluster, associate all nodes of that Network Server cluster to a
separate Associated NS Seed to separate individual BroadWorks platforms.

2.2.5 Discover BroadWorks Servers

BroadWorks servers need to be managed by the EMS so that the EMS can also monitor them. A server
becomes managed when it is discovered by the EMS through the Network Server (NS) seed or it is added
manually. Discover BroadWorks servers provides the ability to discover all BroadWorks servers with the
following exceptions:
• Xtended Service Platform (Xsp)
• Database Server (DBS)
• Provisioning Server (PS)

NOTE: Add an Xtended Services Platform or Provisioning Server node before you perform a Discovery
procedure.

NOTE: The auto-discovery procedure is not recommended for BroadWorks servers with multiple
interfaces. These must be added using the manual Add Node procedure to ensure that all the functions
provided by the EMS work properly. For information, see Add BroadWorks Servers with Multiple
Interfaces on page 39.

Managed Elements Auto-Configuration and Network Auto-Discovery

The Auto-configuration and Network Auto-discovery features are interrelated. The Auto-configuration
feature relies on the Network Auto-discovery feature to determine the managed elements.
However, the Auto-configuration feature is triggered first upon the addition of a node. For the provided
Network Server seed, the auto-discovery occurs only once the auto-configuration for the provided Network
Server seed has succeeded. Using this approach, the network auto-discovery confirms that a valid UNIX
user name and password exist for the provided Network Server seed. As auto-discovery identifies other
nodes for addition, the EMS uses the same approach by invoking the Auto-configuration feature first.
Nevertheless, a successful auto-configuration is not mandatory, that is, the EMS adds a node even if the
auto-configuration has failed. Upon success, having the Auto-configuration feature invoked first allows the
EMS to add an SNMP node. Note that as auto-configuration populates the SNMP access list, the EMS
successfully queries the SNMP. If the auto-configuration fails, the EMS adds a regular node.
Managed Elements Auto-Configuration
As auto-discovery identifies nodes for addition, the EMS runs the Auto-configuration feature. The EMS
uses secure shell (SSH) to run remote scripts on the managed node.
The remote script performs the following tasks:
• Auto-populates the EMS IP address to the SNMP access control list (ACL) and trap table (TT).
The EMS populates the trap table using the object identifier (OID) shared model. Upon receiving traps,
the EMS parses the message text to identify relevant content.
• Auto-populates the EMS IP address to the Network Server operations support system (OSS) access
list.
• Auto-populates the EMS IP address to the Application Server Open Client Interface (OCI) access list.
• Auto-populates the EMS IP address to the BroadWorks Common Communication Transport (BCCT)
access list.
• Auto-configures syslog trap forwarding to the EMS.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 40
 • Retrieves the platform type.
• Retrieves the operating system (OS) information, the BroadWorks server type and active release, and
the Software Manager version.

Figure 9: Discover BroadWorks Servers

To discover BroadWorks servers:

1) Click the Maps tab.
2) Click Discover BW Servers. Alternately, from the Node Properties page, select BW Discovery from the
drop-down list. The Discover BW Servers window appears.
3) In the Please enter NS seed text box, enter the IP address, domain name, or host name of the Network
Server seed.
4) The Start BW Discovery Now check box is enabled by default. Deselect it if you do not want to process
the discovery immediately. The BroadWorks Discovery may be recurrent. Configuring the rediscovery
option enables EMS to synchronize its network representation with changes that occur in the network.
Alternatively, the administrator can reinvoke the BroadWorks Discovery manually.
5) By default, the Keep any existing configuration check box is enabled. This keeps the previously
specified rediscovery configuration. If it is the first time discovery is entered, no rediscovery is
performed. Alternatively, you can select either Disable future rediscovery or Enable future rediscovery.
Both of these options supersede any previous discovery configurations. If you select Disable future
rediscovery and it is the first time discovery is entered, no discovery is performed.

NOTE: If you select Disable future rediscovery, the Keep any existing configuration check box is
automatically disabled.

6) If you selected Enable future rediscovery, enter the interval time in the New rediscovery interval (in
minutes) text box.
7) Click Submit Request. A message displaying "Discovery request successfully submitted" appears.
The EMS is processing the validity of the discovery request. For information on reviewing the results of
a discovery, see Review Discovery Results on page 42.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 41
2.2.6 Review Discovery Results
Following the launch of a BroadWorks Discovery, the EMS reports several results to reflect the progress of
the auto-configuration and discovery functionalities. The EMS reporting comes in the form of EMS events
and alarms.
BroadWorks Discovery Completion
The BroadWorks Discovery may take a while before its completion. The duration varies based on
multiple factors such as the number of managed nodes, the type of BroadWorks servers, and the network
congestion. An EMS administrator can determine a BroadWorks Discovery completion by adhering to the
following steps.
To determine whether a BroadWorks Discovery failed:
1) Click the Fault tab.
2) Click the Network Alarms menu. The Network Alarms page appears.
3) Click Search.
4) Select category and equals.
5) Enter "BW-Discovery" in the third input box. Click Search.
If there is a discovery failure, any of the following alarms may be present with a severity of "minor" or
"major":
• Name: bwDiscNsSeed-<NS seed IP-address>
• Title: <Will vary depending on the issue encountered>
• Name: bwDiscResult-<NS seed IP-address>
• Title: <Will vary depending on the issue encountered>
The first most probable root cause for the above issues is that an invalid password was configured, in
which case you should repeat the steps documented in Configure User Names and Passwords on page
35. The second most probable root cause is that the seed entered is not a BroadWorks Network Server
(NS) type. If the root cause is not either of these, it may be related to a firewall configuration issue. Once
the issue is resolved, you should launch a new BroadWorks Discovery.
To determine whether the BroadWorks Discovery succeeded:

NOTE: Only events are visible since an event of severity "info" does not generate an alarm.

1) Click the Fault tab.

2) Click the Network Alarms menu. The Network Alarms page appears.
3) Click Search.
4) Select category and equals.
5) Enter "BW-Discovery" in the third input box.
6) Click Search.
Upon successful discovery, the following events should be present with a severity of "info" or "clear":
• Name: bwDiscNsSeed-<NS seed IP-address>
• Title: Successfully validated Ns Seed
• Name: bwDiscoveryStart-<NS seed IP-address>
• Title: Successfully validated Ns Seed
• Name: bwDiscResult-<NS seed IP-address>
• Title: Bw (Re)Discovery succeeded for NS Seed: <IP-Address>. Successful completion of BroadWorks
Discovery.
To view the auto-configuration results:
The success of the automatic remote configurations from the EMS to managed nodes relies on a valid
UNIX user name and password. The following list describes the functionality automatically configured.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 42
 • SNMP Trap Forwarding list, Performance SNMP Access list, and Performance Maintenance Tasks
Setup for Operating System-level PMs (OSPM)
• Syslog Forwarding
For every managed node, an EMS administrator can determine an automatic remote configuration
completion by adhering to the following tasks.
To determine whether an EMS auto-configuration failed:
1) Click the Fault tab.
2) Click the Network Alarms menu. The Network Alarms page appears.
3) Click Search.
4) Select category and equals.
5) Enter "BW-AutoConfig".
6) Click Search.
If there is an auto-configuration failure, for each managed node, an alarm is present with a severity of
"minor" or "major".
Since the most probable root cause for the above issues is that an invalid password was configured, the
fastest means to retrigger auto-configuration is to launch a new BroadWorks Discovery. If this is not done,
an auto-configuration audit runs hourly for failed managed nodes, and daily for all managed nodes.
If the EMS auto-configuration is successful:

NOTE: Only events are visible since an event of the severity "info" does not generate an alarm.

1) Click the Fault tab.

2) Click the Network Events menu. The Network Events page appears.
3) Click Search.
4) Select category and equals.
5) Enter "BW-AutoConfig" in the third field. Click Search.
Upon successful auto-configuration, for each managed node, an event is present with a severity of "info" or
"clear".
Platform Type Knowledge Results

NOTE: The threshold modifiers mechanism overlays the platform type mechanism in earlier EMS versions
where the multiplicator factor was mapped to one of three platform sizes (small, medium, and large). As
threshold values must increase based on improved processors, the threshold modifier mechanism allows
the EMS to avoid the need for new platform sizes (for example, large, extra-large, and so on) on an on-
going basis.Therefore, beginning with Release 16.0, this section is deprecated. It is still listed because
the threshold modifier functionality remains fully backward-compatible with the information provided by the
platform type.
No manual configuration should be required if you use one of the hardware configurations documented in
the BroadWorks Recommended Hardware Guide [4].
To determine if your hardware matches a default configuration, refer to the “Multiplicator Factors” sheet of
the EMS Polling Objects and Thresholds Definition Document [17].

The EMS requires knowledge of the platform type (also known as the platform size) for the platform name
retrieved from the discovered managed nodes. The platform type is used by the Health Status Monitoring
feature. (By default, the EMS uses a small platform type for all platform names that have a platform name
reported as “unknown”.) The EMS reports an alarm when it retrieves a platform name that has a platform
type that is unknown.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 43
 An EMS administrator can review such alarms by adhering to the following steps:
1) Click the Fault tab.
2) Click the Network Events menu. The Network Events page appears.
3) Click Search.
4) Select category and equals.
5) Enter "bwPlatformTypeAutoConfig" in the third field. Click Search.
With an unknown platform type, for each managed node, an alarm is present with a severity of “minor”.
An EMS administrator must adhere to the following steps to map a platform name to a platform type:
1) From the alarm details text of each bwPlatformTypeAutoConfig alarm, determine the platform name (it
matches the full string that follows the following header): platform type obtained from the
node is not defined in the system:
In other words, the format of the alarm details text is always: The platform type obtained from
the node is not defined in the system: <platform name>
For example, in the following alarm details text: The platform type obtained from the node
is not defined in the system: Sun Microsystems sun4u Sun Fire V125
… the platform name is Sun Microsystems sun4u Sun Fire V125.
2) Map the platform name that has a platform type that is unknown.
3) Click the Admin tab.
4) Click the Platform Configuration Group menu.
5) Click Add Platform Type.
6) Enter the platform name that has a platform type that is unknown.
7) Select the relevant value from the platform type input box. (As a general rule all Sun V1xx series are
“small”, V2xx series are “medium”, and V4xx are “large”. All Linux platforms are “large”.)
8) Click Submit.
To review these alarms:
1) Click the Fault tab.
2) Click the Network Alarms menu. The Network Alarms page appears.
3) Click Search.
4) Select entity and contains.
5) Enter "bwPlatformTypeAutoConfig" in the input box on the right-hand side.
6) Click Search. With an unknown or "unfound" platform type, for each managed node, an alarm is
present with a severity of "minor" or "warning".
To view the Patch Management dependency results:
The EMS depends on an updated version of the Software Manager to enable the full centralized patch
management functionality.
To review these alarms:
1) Click the Fault tab.
2) Click the Network Alarms menu. The Network Alarms page appears.
3) Click Search.
4) Select entity and contains.
5) Enter "SWManagerTooOld" in the the input box on the right-hand side. Click Search.
With an old version of the Software Manager, for each managed node, an alarm is present with a
severity of "major". To update to the latest version of the Software Manager, an EMS administrator must
follow the steps documented in the BroadWorks Software Management Guide.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 44
2.2.7 Configure E-mail, Distribution Lists, and Performance Reports
You can send e-mails as user notifications for the following:
• Critical Patch Notification: For newly available server critical patches, the EMS sends an e-mail to
all people configured on this list. The e-mail identifies the issue and the content includes the list of
relevant nodes.
• Health Status Change: The EMS provides a unique feature named Health Status Monitoring, which
monitors the health of the overall BroadWorks network. This functionality is based on a recurrent
distribution pattern of threshold crossings. Every managed node has an overall node health status that
can become green, cyan, yellow, orange, or red. The EMS also defines a group health status that has
the same purpose but applies to the server cluster level. When there is a change in the node or group
health status, the EMS may send an e-mail to automatically notify a list of users.
• Performance Daily Report: The EMS may send a performance daily report.
The EMS allows the sending of e-mails as user notifications for the following functionalities. Follow these
procedures to configure the e-mail server and e-mail distribution lists to send e-mail as user notifications.
To configure Simple Mail Transfer Protocol (SMTP) server and e-mail sender address, see Configure E-
mail Parameters on page 336.
To configure a list of e-mail recipients, see Configure E-mail Distribution Lists on page 338.
To configure the performance reports, see Display a Report for Managed Objects and Statistics on page
265.

2.2.8 Create a Report by Node Type

It is useful to create sample reports to ensure that reports are received as anticipated.
To create a sample report per node type:
1) Click the Performance tab.
2) For each server type, follow the steps in Create a Report on Server Statistics on page 266. Include
the following in each report.
• Name: enter the name of the report
• Server Type: select the server type (create a separate report for each server type on your network)
• Select Periodic Report Generation
• Frequency Type: select "Daily"
• Time of Day: enter the time approximately an hour from the time you are creating the report
• Select "Mail Report" amd click on the "BroadSoft Patch Center Distribution".
3) Check that the reports are received at the scheduled time.

2.2.9 Audit Statistics

Audit the BroadWorks statistics to ensure that they are collecting data from the OSPM as anticipated.

NOTE: Wait at least one hour after the inital discovery before auditing the statistics. This is required to
ensure that enough time has lapsed to collect OS data.

To audit statistics:
1) From the Inventory tab, select Nodes. The Nodes page appears.
2) Click a server to audit. The Node Properties page displays the statistics for that server appear.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 45
 Figure 10: Sample Node Statistics

2.2.10 Audit Patch Download

Audit the software patch downloads to ensure that patches are downloaded as anticipated.
1) Click the Centralized Networking tab and select the EMS Patch Support Center submenu.
2) Configure the BroadSoft Patch Center Credentials. For a step-by-step procedure to configure these
credentials, see Configure User Names and Passwords on page 35.
3) Wait for one hour and then return to the EMS Patch Support Center page to verify that patches are
being downloaded.
4) If you have any doubt, navigate to the BroadSoft Patch Center Schedule page and click Download
Now.

2.3 Configuring Northbound Trap Forwarding

Trap forwarding is a feature in EMS by which you can forward SNMP traps from the EMS to other
Managers. For EMS to forward the traps it receives to a Network Management System (NMS), configure
the trap.forwarder file, for Release 17.0 onward.
The file is at the following location:
cd /usr/local/roadworks/apps/active/EMSBackEnd/conf.

NOTE: Pre Release 17.0, the file is at the following location:

cd /usr/local/broadworks/bw_base/public_html/conf.

Edit the trap.forwarder file as follows:

<TRAP-FORWARDER>
<TRAP-FILE Refresh_Time="300"/>
<TRAP-REDIRECTION Dest_Addr=“192.168.8.131" Dest_Port="162"/>
</TRAP-FORWARDER>

NOTE: Make sure that the Network Management System (NMS) is listening on port 162 and for Enterprise
OID = 6431 (BroadSoft entOID).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 46
 NOTE: EMS forwards only raw traps received from the BroadWorks network elements managed by the
EMS. Internal events generated by the EMS are not forwarded.

The EMS can forward to multiple destinations, simply duplicate the line TRAP-REDIRECTION for every
destination with the corresponding IP address and port. When a destination is added to the file and the file
is saved the changes does not take effect immediately. The parameter Refresh_Time is used to instruct
the EMS to periodically read the file for new destination entries. It is only after the EMS reads the file, at the
end of the refresh cycle, that the traps start to be forwarded to the new destinations. The default refresh
time is 300 seconds.
EMS forward events created by EMS to NMS
This configuration allows the BroadWorks EMS to forward all events/alarms – both received and/or
generated at the EMS level – to a NMS-level management system. In this context, the NMS system
receives all events/alarms re-packaged under a distinct snmp traps (using Enterprise OID 2162). Then,
the NMS must implement a trap parser (as a mediation layer) to map the trap OID fields of the AdventNet-
WebNMS-MIB (as per your own requirements).
You can load this MIB from the SNMP Tools tab of the BW EMS Web client. Please look for the section
named alertNotificationMib (.1.3.6.1.4.1.2162.4.3.8) to understand the list of fields available.
The set-up for enabling the NorthBound interface requires to edit the config file named
V1V2TrapForwardingTable.xml .
For releases before Release 17.0, the file is located at:
cd /usr/local/broadworks/bw_base/public_html/conf/jmx_agent/conf
For Release 17.0 and above, the file is located at:
cd /usr/local/broadworks/apps/active/EMSBackEnd/conf/jmx_agent/conf

Open a vi editor modify the content of V1V2TrapForwardingTable.xml as follows:

[...]
<row>
<column name="managerHost" value="A.B.C.D" ></column>
<column name="managerPort" value="162" ></column>
<column name="version" value="2" ></column>
<column name="community" value="public" ></column>
<column name="timeOut" value="3200" ></column>
<column name="retries" value="0" ></column>
<column name="rowStatus" value="1" ></column>
</row>

Restart EMS is to make these changes.

To configure logging for the Northbound interface:
You can add logging for the northbound interface for debugging purposes.
Pre-release 17.0 only:
1) Make a backup of the logging_parameters.conf file.
2) Open a vi editor modify the content of the logging_parameters.conf file.
cd /usr/local/broadworks/bw_base/public_html/conf/
cp logging_parameters.conf logging_parameters.conf.bak
vi logging_parameters.conf
3) Search for the parameter AGENT and delete the following lines:
<KEY Logging="false" Name="AGENTERR" DisplayName="AGENT" LogLevel="3"/>
<KEY Logging="false" Name="AGENTUSER" DisplayName="AGENT" LogLevel="3"/>
4) Append the following lines to the end of the file above the </LOGGING_PARAMETERS_CONF> line

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 47
 <LOG_USER MaxLines="10000" UseTimeStamp="true" LogsDirectory="logs" FileCount="10"
FileName="northBoundlog.txt" MaxLinesCached="0">
<KEY Logging="true" Name="AGENTERR" DisplayName="AGENTERR" LogLevel="4"/>
<KEY Logging="true" Name="AGENTUSER" DisplayName="AGENTUSER" LogLevel="4"/>
</LOG_USER>
5) Restart EMS.
Logs will be written to the /var/broadworks/logs/emsBE/ directory with filename northBoundlog.txt. Remove
this configuration when done troubleshooting.

2.4 Configuring Southbound Interface

The EMS communicates with BroadWorks managed elements through the specified southbound interface.
To ensure communication, the EMS southbound interface needs to be in the same network as the
interfaces identifying the managed elements in the EMS. Otherwise, southbound communication between
theEMS and its managed elements may fail.
Use the Southbound Interface Configuration page to configure the southbound interface.

Figure 11: Southbound Interface Configuration

The information on this page includes the following:

Parameter Description

Primary Server This parameter specifies the southbound interface of the primary
EMS from a drop-down list.

Secondary Server This parameter specifies the southbound interface of the

secondary EMS from a drop-down list.

To configure the southbound interface:

1) Click the Admin tab.
2) From the Configurations submenu, click Southbound Interface. The Southbound Interface
Configuration page appears.
3) Select the network interface to be used for southbound communication on the Primary Server from the
drop-down list.
4) Select the network interface to be used for southbound communication on the Secondary Server from
the drop-down list.
5) Click Submit to configure the e-mail parameters, click Reset to reset the previously saved parameters,
or click Cancel to return to the previous page.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 48
3 Using Network Topology

This section provides information on how to use the network topology.

This section describes the following:
• Using BroadWorks Network Maps on page 49
• Accessing Properties for BroadWorks Node on page 57

3.1 Using BroadWorks Network Maps

The Maps page graphically displays and allows you to monitor all the BroadWorks servers that are
managed by your EMS. The BroadWorks Network Maps displays accurate information on the state of the
BroadWorks server clusters and their individual components. The change in state is represented using
colors that help you identify faults in the network.
The following figure illustrates the Maps tab. By default, when you log in to the Web Client, the
BroadWorks Network Maps view is displayed.

Figure 12: BW Network Maps

This tree on the left-hand side of the page provides access to the following:
Menu Description Icon

All BW Servers This displays icons representing all BroadWorks

server clusters on the network.

BW Network Servers This displays icons representing all Network Server

clusters on the network.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 49
 BW Application Servers This displays icons representing all Application
Server clusters on the network.

BW Media Servers This displays icons representing all Media Server

clusters on the network.

BW Web Servers This displays icons representing all Web Server

clusters on the network.

BW XS Servers This displays icons representing all Execution

Server clusters on the network.

BW PS Servers This displays icons representing all Profile Server

clusters on the network.

BW XSP Servers This displays icons representing all Xtended

Services Platform clusters on the network.

BW CDS Servers This displays icons representing all Call Detail

Server clusters on the network.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 50
 BW AMS Servers This displays icons representing all Access
Mediation Server clusters on the network.

BW CS Servers This displays icons representing all Conferencing

Server clusters on the network.

BW DBS Servers This displays icons representing all Database

Server clusters on the network.

BW Failed Servers This displays icons representing all failed clusters

on the network.

To access the Maps tab:

Click the Maps tab. The Maps tab appears.
For more information

3.1.1 Configure Node Access

The Configure Node Access page is used to set user names and passwords for web access and telnet/
SSH access where the default user names and passwords have changed or new user names and
passwords have been added for the Network Server seed.
Use the Configure Node Access page to configure the Network Server seed used to discover BroadWorks
servers.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 51
 Figure 13: Configure Node Access

The information on this page includes the following:

Input Box Description

Enter web username This text box specifies the user name for the web portal.

Enter web password This text box specifies the user password for the web portal.

Re-enter web password This text box specifies the reconfirmed user password for the web portal.

Enter CORBA port number This text box specifies the CORBA port number.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 52
 Input Box Description

Enter BCCT port number This text box specifies the BroadWorks Common Communication Transport (BCCT) port number.

Secure This check box controls whether the BCCT port is secure.

Enter ssh username This text box specifies the user name for the secure shell (SSH).

Enter ssh password This text box specifies the user password for the SSH.

Reenter ssh password This text box specifies the reconfirmed user password for the SSH.

Enter ssh port number This text box specifies the SSH port number.

Enter telnet port number This text box specifies the telnet port number.

SNMP Port This text box specifies the SNMP port number.

Read Community This text box specifies the read community.

Write Community This text box specifies the write community.

Enable V3 This check box controls whether the SNMP v3 is enabled.

User Name This text box specifies the SNMP v3 user name.

Context Name This text box specifies the SNMP v3 context name.

To access the Node Access page:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "Configure BW Node" from the drop-down list. The Configure
Node Access window appears.
To configure the node access:
1) Click the Maps tab.
2) Click Configure Node Access. The Configure Node Access window appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 53
 Figure 14: Node Access (Page 1)
3) In the Node to configure text box, type the IP address of your server and click Next. The access input
boxes appear with default parameters.
4) Modify the input boxes as required.

NOTE: Changes made to telnet/SSH only apply if NIS+ is not enabled.

5) Click Submit Request to complete the configuration. To cancel the request, click Cancel Request.

3.1.2 Discover BroadWorks Servers

BroadWorks servers need to be managed by the EMS so that the EMS can also monitor them. A server
becomes managed when it is discovered by the EMS through the Network Server (NS) seed or it is added
manually. Discover BroadWorks servers provides the ability to discover all BroadWorks servers with the
following exceptions:
• Xtended Service Platform (Xsp)
• Database Server (DBS)
• Provisioning Server (PS)

NOTE: Add an Xtended Services Platform or Provisioning Server node before you perform a Discovery
procedure.

NOTE: The auto-discovery procedure is not recommended for BroadWorks servers with multiple
interfaces. These must be added using the manual Add Node procedure to ensure that all the functions
provided by the EMS work properly. For information, see Add BroadWorks Servers with Multiple
Interfaces on page 39.

Managed Elements Auto-Configuration and Network Auto-Discovery

The Auto-configuration and Network Auto-discovery features are interrelated. The Auto-configuration
feature relies on the Network Auto-discovery feature to determine the managed elements.
However, the Auto-configuration feature is triggered first upon the addition of a node. For the provided
Network Server seed, the auto-discovery occurs only once the auto-configuration for the provided Network
Server seed has succeeded. Using this approach, the network auto-discovery confirms that a valid UNIX

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 54
 user name and password exist for the provided Network Server seed. As auto-discovery identifies other
nodes for addition, the EMS uses the same approach by invoking the Auto-configuration feature first.
Nevertheless, a successful auto-configuration is not mandatory, that is, the EMS adds a node even if the
auto-configuration has failed. Upon success, having the Auto-configuration feature invoked first allows the
EMS to add an SNMP node. Note that as auto-configuration populates the SNMP access list, the EMS
successfully queries the SNMP. If the auto-configuration fails, the EMS adds a regular node.
Managed Elements Auto-Configuration
As auto-discovery identifies nodes for addition, the EMS runs the Auto-configuration feature. The EMS
uses secure shell (SSH) to run remote scripts on the managed node.
The remote script performs the following tasks:
• Auto-populates the EMS IP address to the SNMP access control list (ACL) and trap table (TT).
The EMS populates the trap table using the object identifier (OID) shared model. Upon receiving traps,
the EMS parses the message text to identify relevant content.
• Auto-populates the EMS IP address to the Network Server operations support system (OSS) access
list.
• Auto-populates the EMS IP address to the Application Server Open Client Interface (OCI) access list.
• Auto-populates the EMS IP address to the BroadWorks Common Communication Transport (BCCT)
access list.
• Auto-configures syslog trap forwarding to the EMS.
• Retrieves the platform type.
• Retrieves the operating system (OS) information, the BroadWorks server type and active release, and
the Software Manager version.

Figure 15: Discover BroadWorks Servers

To discover BroadWorks servers:

1) Click the Maps tab.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 55
 2) Click Discover BW Servers. Alternately, from the Node Properties page, select BW Discovery from the
drop-down list. The Discover BW Servers window appears.
3) In the Please enter NS seed text box, enter the IP address, domain name, or host name of the Network
Server seed.
4) The Start BW Discovery Now check box is enabled by default. Deselect it if you do not want to process
the discovery immediately. The BroadWorks Discovery may be recurrent. Configuring the rediscovery
option enables EMS to synchronize its network representation with changes that occur in the network.
Alternatively, the administrator can reinvoke the BroadWorks Discovery manually.
5) By default, the Keep any existing configuration check box is enabled. This keeps the previously
specified rediscovery configuration. If it is the first time discovery is entered, no rediscovery is
performed. Alternatively, you can select either Disable future rediscovery or Enable future rediscovery.
Both of these options supersede any previous discovery configurations. If you select Disable future
rediscovery and it is the first time discovery is entered, no discovery is performed.

NOTE: If you select Disable future rediscovery, the Keep any existing configuration check box is
automatically disabled.

6) If you selected Enable future rediscovery, enter the interval time in the New rediscovery interval (in
minutes) text box.
7) Click Submit Request. A message displaying "Discovery request successfully submitted" appears.
The EMS is processing the validity of the discovery request. For information on reviewing the results of
a discovery, see Review Discovery Results on page 42.

3.1.3 Managed Elements Auto-Configuration and Network Auto-Discovery

The Auto-Configuration and Network Auto-Discovery features are interrelated. The Auto-Configuration
feature relies on the Network Auto-Discovery feature to determine the managed elements. However,
the Auto-Configuration feature is triggered first upon the addition of a node. For the provided Network
Server seed, the auto-discovery occurs only once the auto-configuration for the provided Network Server
seed has succeeded. Using this approach, the network auto-discovery confirms that a valid UNIX user
name and password exist for the provided Network Server seed. As auto-discovery identifies other
nodes for addition, the EMS uses the same approach by invoking the Auto-Configuration feature first.
Nevertheless, a successful auto-configuration is not mandatory, that is, the EMS adds a node even if the
auto-configuration has failed. Upon success, having the Auto-Configuration feature invoked first allows
the EMS to add a Simple Network Management Protocol (SNMP) node. Note that as auto-configuration
populates the SNMP access list, the EMS successfully queries the SNMP. If the auto-configuration fails,
the EMS adds a regular node.
For more information

3.1.3.1 Managed Elements Auto-configuration

While BroadWorks nodes are being added to the EMS, either through an auto-discovery or through a
manual addition, the EMS runs the Auto-configuration process. During that proces, the EMS uses Secure
Shell (SSH) to run remote scripts on the managed node. The remote scripts perform the following tasks:
• Auto-populates the EMS IP address to the SNMP access control list (ACL) : This allows the EMS to
access SNMP counters for statistics gathering.
• Auto-populates the EMS IP address to the SNMP trap table (TT) : This instructs the node to sent raised
traps to the EMS. The EMS auto-populates the trap table using the OID shared model meaning that
trap received at the EMS are parsed to retreived the relevant content.
• Auto-populates the EMS IP address to the Network Server OSS access list: This allows the EMS to
retreive network information from the Network Server through OSS
• Auto-populates the EMS IP address to the Application Server OCI access list: This allows the EMS to
retreive network information from the Application Server through OCI
• Auto-populates the EMS IP address to the Config Agent access list: This allows the EMS to perform
centralized configuration management.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 56
 • Auto-configures syslog forwarding to the EMS IP address: This instructs the node to forward syslogs to
the EMS
• Retrieves the platform type: This information is used for inventory and management purpose
• Retrieves OS information, BroadWorks server type and active release, and the Software Manager
version: This information is used for inventory and management purpose
In the above actions, the term EMS IP address corresponds to the Southbound interface defined through
the Admin tab. Following the completion of a BroadWorks network auto-discovery, the EMS generates an
event (fault management) to report the auto-configuration results. The event becomes an alarm if the auto-
configuration was not successful. Otherwise, the EMS generates only an information event. In addition,
the EMS starts to receive traps from the node, start to collect performance monitoring and start performing
other activities when triggered by the operator. In addition, The EMS performs periodic audits of nodes to
maintain EMS information for the access control list and trap table.
The auto-configuration relies on the UNIX user name and password for individual nodes to be configured
on the EMS. The user has the following options to configure the UNIX user names and passwords of
managed elements on the EMS:
• Manually manage individual user names and passwords for each node. This is done through the
Configure Node Access link available from the Maps tab.
• Manually ensure a single user name and password is available across all nodes. This is configured
through the Modify EMS Account page accessible through the Centralized User link from the
Centralized Networking tab. Please refer to Modify EMS Account for configuration details. The actual
user account can be implemented in two ways:
• Create the same UNIX user account on each node in the network
• Enable centralized user through LDAP and create a centralized user for EMS activities.
For more information about Lightweight Directory Access Protocol (LDAP) functionality and how to
integrate it with BroadWorks, see the BroadWorks UNIX User Account Configuration Guide.

3.1.3.2 Network Auto-Discovery Configuration

The EMS allows auto-discovery of most BroadWorks servers. The mechanism is triggered by a
BroadWorks Network Server host name/Internet Protocol (IP) address used as a seed. This action allows
the discovery of other BroadWorks nodes on the network. The network auto-discovery has the following
characteristics:
• Auto-discovery and topology update
• Informational model to capture attributes of BroadWorks servers
• Topology summary and hierarchical representation of managed resources
• Intelligent grouping for simplified configuration management
The auto-discovery functionality provides a user interface to trigger manual rediscovery and configure an
optional rediscovery interval.
Following the completion of a BroadWorks network auto-discovery, the EMS generates an event (fault
management) to report the discovery result. The event becomes an alarm if the discovery was not
successful. Otherwise, the EMS only generates an informational event.

3.2 Accessing Properties for BroadWorks Node

From the Node Properties page, you can view and modify the properties of a node, as well as perform
many remote commands and EMS commands on that node.
To access the node properties from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the BroadWorks
cluster appear.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 57
 3) Click the icon representing the BroadWorks node you are interested in. The Node Properties page
appears.
To access the node properties from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
For more information

3.2.1 Configure BroadWorks Node

By default, when you log in to the Web Client, the BroadWorks Network Maps view is displayed. Click the
map to appear in the right-hand panel.
All information and operations available in the various network maps are also available from the Inventory
tab. For example, all the networks and the operations that can be performed in the ipnet map are also
available from the Inventory tab. The maps are a graphical representation of network elements while the
Network Database view is a tabular representation of network data.

Figure 16: General Information Properties

Figure 17: User Properties

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 58
 Figure 18: Status Monitoring

Figure 19: Interfaces & Parents

Figure 20: Protocol Configuration

Figure 21: Interfaces

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 59
 Figure 22: Other Graphs

Figure 23: Alarm Descriptions

To configure a BroadWorks Node:

1) Click Edit on the section to configure.
2) Modify the input boxes as required.
3) Click Update Object to save the changes or click Reset to reset the settings to the previous
configuration.
For more information

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 60
3.2.1.1 Add Node
The EMS provides a manual Add Node feature that allows you to add individual network elements one at a
time. Although it is possible to use this approach for all nodes within an EMS span of control, its use is only
recommended for adding BroadWorks server types that the EMS auto-discovery does not support, such as
the BroadWorks Profile Server (PS), the Database Server (DBS), and the Xtended Services Platform (Xsp)
nodes. Similar to auto-discovery, when you add a node, the auto-configuration functionality is invoked.
Although it is possible to use this approach for all nodes within an EMS span of control, its use is only
recommended for adding BroadWorks server types that the EMS auto-discovery does not support, such as
the Profile Server, Database Server, and the Xtended Services Platform nodes.
The manual Add Node method must be used for adding BroadWorks servers with multiple interfaces. For
information, see Add BroadWorks Servers with Multiple Interfaces on page 39.
The EMS only adds the requested node if its auto-configuration succeeded. For information on auto-
configuration, see Managed Elements Auto-configuration on page 56.
Use the Add Node page to add a BroadWorks node
.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 61
 Figure 24: Add Node

The information on this page includes the following:

Input Box Description

User Name This text box specifies the user name for Secure Shell (SSH) access to the node.

Password This text box specifies the user password for SSH access to the node.

IP Address This text box specifies the node's Internet Protocol (IP) address.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 62
 Input Box Description

BroadWorks Platform This option specifies whether the node is a BroadWorks server.

Auto Detect BroadWorks This check box determines whether the node type is detected by the add node functionality.
Type

Server Type This drop-down list specifies the server type of the node.

Non-BroadWorks Platform This option specifies whether the node is a non-BroadWorks server.

Non-BroadWorks Platform This drop-down list specifies the server type of the node.
Server Type

Group This drop-down list specifies the name of the group associated with the node.

Associated NS (Network This drop-down list specifies the name of the Network Server seed associated with the node.
Server) Seed

SNMP Port This text box specifies the Simple Network Management Protocol (SNMP) port number.

Read Community This text box specifies the read community.

Write Community This text box specifies the write community.

Enable V3 This check box controls whether the SNMP v3 is enabled on the node.

User Name This text box specifies the SNMP v3 user name.

Context Name This text box specifies the SNMP v3 context name.

To add a node:
1) From the Discovery submenu, click Add Node. The Add Node page appears.
2) In the User Name text box, enter the SSH user name.
3) In the Password text box, enter the SSH password.
4) In the IP Address text box, enter the IP address of the node.
5) If the node is a BroadWorks server:
a) Select BroadWorks Platform, or
b) Select Auto Detect BroadWorks Type to let the add node process identify the type of node.
c) Optionally, unselect Auto Detect BroadWorks Type and select the node type from the Server Type
drop-down list.
6) If the node is not a BroadWorks server:
a) Select Non-BroadWorks Platform.
b) Select the node type from the Non-BroadWorks Platform Server Type drop-down list.
7) Select the Group to associate the node with from the drop-down list.

NOTE: The EMS uses group data for clustering and farm association. Therefore, the same group
can be reused upon adding more nodes of the same server cluster or farm. A group must contain only
nodes of the same server type.

8) Select the Associated NS (Network Server) Seed to associate the node with, from the drop-down list.

NOTE: The Network Server seed association allows the display of the node on the corresponding
BroadWorks maps.

9) In the SNMP Port text box, enter the SNMP port number.
10)In the Read Community text box, enter the read community.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 63
 11)In the Write Community text box, enter the write community.
12)If V3 is enabled on the node:
a) Select Enable V3.
b) In the User Name text box, enter the user name.
c) In the Context Name text box, enter the context name.
13)Click Submit to add the node or click Reset to discard the entries.

3.2.1.2 Node Property Reference

Input Box Description

General Information

Device Type This text box displays the device type of the node.

Is Managed? This option controls whether the node is managed or "unmanaged". When
a managed object is "unmanaged", status polling and data collection stops.
Therefore, threshold calculation is not done. Traps for the node continue to
be processed. To disable the processing of traps, see the Configure Fault
Management Parameters on page 303.

IP Address This text box specifies the IP address of the node.

Is DHCP Enabled? This text box indicates whether Dynamic Host Configuration Protocol (DHCP) is
enabled on the node.

Status This text box displays the overall alarm status of the node. The highest alarm
severity level associated with the node is displayed.

Display Name This input box displays the managed object's name that is used on the web
interface.

Netmask This drop-down list specifies the network mask of the node.

User Properties Details

UnamePlatform This text box displays the platform type of the node. This value corresponds to
the result of the command uname -i when it is run on the node.

SnmpAgentUnreachable This text box indicates whether the SNMP agent of the node is unreachable.

ConfiguredMemory This text box displays the amount of memory available on the node.

Threshold Name(s) This text box lists the threshold names that apply to the node when computing
(Multiplicator) performance.

bwName-NodeId This text box displays the name of the nodes clustered together with the node
ID within the cluster.

bwIpForWeb This text box displays the IP address to be used to access the web interface of
the node.

bwIsPrimary This text box indicates whether the node is the primary server of the cluster.

bw.config.requiresRestart This is an internal BroadWorks text box.

bw.config.interfaces This is an internal BroadWorks text box.

bwNsSeed This text box displays the IP address of the Network Server seed that was used
to discover the node. When a node is added manually, BW-Other is displayed.

bwManuallyAdded This text box indicates whether the node was manually added through "Add
Node" or discovered through a Network Server seed.

Server Type This text box displays the type of server. Valid values include: Application
Server (AS), Network Server (NS), Media Server (MS), Xtended Services
Platform (XSP), Profile Server (PS), Web Server (WS), Execution Server
(XS), Call Detail Server (CDS), Access Mediation Server (AMS), Conferencing
Server (CS), and Database Server (DBS).

bw.config.memorySize This is an internal BroadWorks text box.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 64
 Input Box Description

bwPlatformName This text box displays the name of the hardware platform. It is taken from the
product name available from the command dmidecode (available on x86_64
server only).

bwPlatformType This text box displays the platform type from a performance point of view.

Processor This text box displays the processor architecture of the node.

Operating System This text box displays the operating system running on the node.

BW Version This text box displays the version of BroadWorks running on the node.

bw.config.managementMode
This is an internal BroadWorks text box.

bw.config.currentSchema This is an internal BroadWorks text box.

Modifier Factor(s) This text box displays the modifier factor used by the performance module to
compute the statistics and threshold for the node.

bw.config.schemaVersionThis is an internal BroadWorks text box.

BroadWorksServer This text box indicates whether the node is a BroadWorks Server. If the value is
"true", the node is a BroadWorks Server. If the value is "false", it is not.

bw.config.currentVersion This is an internal BroadWorks text box

SWManager version This text box displays the version of the Software Manager running on the
node.

NodeDesc This text box describes the node within the cluster context.

NumberOfCores This text box specifies the number of cores available on the node.

Status Monitoring Details

Is Status polling This option controls status polling on the node. If the value is set to "yes", the
enabled? status of the node (alarms and events) is available through the web interface. If
the value is set to "false", the status is not available.

Last Status Change This text box displays the time of the last change of status.
Time

Last Status Update This text box displays the time stamp of the last time the node was polled for its
Time status.

Failure Threshold This input box specifies the number of consecutive failed status poll attempts to
declare the object as failed. A status change event for the object is generated
when the status polling for the object fails for "Failure Threshold" times.

Failure Count This text box displays the number of times consecutive status poll attempts for
this object have failed. The count is reset to "0" once the object is declared as
failed or when the object recovers after the failure. When the value of "Failure
Count" equals that of "Failure Threshold", the object is declared failed.

Tester for Status This drop-down list provides the ability to select the action to be performed on
Polling status polling for the managed object. When the selected value is "Max", the
status of the interface is propagated to the managed node. If the value "User
Test" is used, the User Class Name parameter should be set with the name of
the user tester class.

User Class Name This input box specifies the class to be invoked for status polling. Set this
parameter only if the selected value of the Tester for Status Polling parameter
is "User Test".

Status Polling Interval This input box specifies the interval between status polling attempts for this
group.

Interfaces & Parent Networks

List of Interfaces This drop-down list displays the list of interfaces available on this node.

Parent Object This text box specifies the parent of the managed object.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 65
 Input Box Description

Is Container? This text box specifies whether the managed object is a container.

Parent Networks This drop-down list displays the IP address of the parent network(s).

List of Groups This drop-down list identifies the names of the groups to which the node
belongs.

Is Group? This text box specifies whether the managed object is a group.

Protocol Configuration Settings

SNMP Port This text box displays the SNMP port number that the EMS uses to retrieve
SNMP values from this interface.

Read Community This text box displays the read community associated with this interface.

SNMP Version This text box displays the SNMP version running on this interface.

System Object This text box displays the node's sysOID MIB-II value.
Identifier (SysOID)

Host Netmask This text box displays the host netmask.

Base MIBs This text box displays the list of base Management Information Bases (MIBs)
implemented by the SNMP agent of the node.

Write Community This text box specifies the write community associated with this node.

System Description This text box displays the node's sysDescr MIB-II value.
(sysDescr)

Interfaces

Index This text box displays the hardware index of the interface.

Description This link navigates to the Property details of the interface.

Speed(bps) This text box displays the speed of the interface.

Status This text box displays the overall alarm status of the interface. The highest
alarm severity level associated with the interface is displayed. Supported
values are: critical(1), major(2), minor(3), warning(4), clear(5).

MAC This text box displays the Media Access Control (MAC) address of this
interface.

CPU Utilization If available, this diagram illustrates the amount of CPU utilization on the node.

Memory Utilization If available, this diagram illustrates the amount of memory utilization on the
node.

Disk Utilization If available, this diagram illustrates the amount of disk utilization on the node.

Other Graphs

INTERFACE_out_octets This graph displays the total number of octets transmitted out of the interface,
including framing characters.

INTERFACE_in_octets This graph displays the total number of octets received on the interface,
including framing characters.

memUsageSwap This graph displays the amount of memory swapped to disk per second.

memUsagePaging This graph displays the amount of virtual memory used.

virtualMemWaitThreads This graph displays the number of processes waiting for run time.

virtualMemBlkThreads This graph displays the number of processes in "uninterruptible" sleep.

virtualMemNumCPUs This graph displays the number of CPUs.

waitThreadsRatio This graph displays the ratio of wait threads per CPU instance.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 66
 Input Box Description

blockedVsWaitThreads This graph displays the difference between the blocked threads and the wait
threads.

diskUsageSlash This graph displays the disk usage for the "/" directory.

diskUsageBw This graph displays the disk usage for the "/bw" directory.

CPUBusy This graph displays the sum of CPUSys and CPUUsr.

CPUIdle This graph displays the percentage of the CPU idle time.

CPUSys This graph displays the percentage of the CPU used by the system.

CPUUsr This graph displays the percentage of the CPU used by the user programs.

ASBusyHourCallAttemptsThis graph displays the number of call attempts per hour.

ASOciRequestsInPerSecond
This graph displays the number of Open Client Interface (OCI) requests
attempted per second.

diskUsageTmp This graph displays the disk usage for the /tmp directory.

maxDiskIOSvc This graph displays the maximum disk Input Output (IO) svc time.

maxDiskIOBusy This graph displays the maximum disk IO busy time.

maxDiskIOBsyVsSvc This graph displays the maximum disk IO busy time versus svc time.

maxXsJavaHeap This graph displays the maximum Java heap used by the Execution Server.

totalXsJavaHeap This graph displays the total Java heap used by the Execution Server.

percentXsJHeap This graph displays the percentage of the Java heap used by the Execution
Server.

dsnInUse This graph displays the percentage of usage of the DataStore Name (DSN).

ASOciAvgRequestDelay This graph displays the average time (in milliseconds based on a rolling
average of the last 100 samples) it takes to process an OCI request.

ASOciMaxRequestDelay This graph displays the longest OCI request response time.

AStoSMTPtraffic This graph displays the total number of messages sent attempted on the
primary Simple Mail Transfer Protocol (SMTP) server.

ASNbOfUsers This graph displays the number of users configured on the node.

ASCallsPerSecond This graph displays the number of calls per second.

ASActiveCalls This graph displays the number of active calls on the node.

ASSysIntQueueTimeAvgCallHalf
This graph displays the average call processing queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxCallHalf(msec)
This graph displays the largest call processing queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgRegAdapt(1000usec)
This graph displays the average registration queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxRegAdapt(msec)
This graph displays the largest registration queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgCallPThreadDBAccess(1000usec)
This graph displays the average database access from call processing queue
holding time (in milliseconds).

ASSysIntQueueTimeMaxCallPThreadDBAccess(msec)
This graph displays the largest database access from call processing queue
sample holding time (in milliseconds).

ASSysIntQueueTimeAvgVoiceMailInAdapt(1000usec)
This graph displays the average voice mail queue holding time (in
milliseconds).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 67
 Input Box Description

ASSysIntQueueTimeMaxVoiceMailInAdapt(msec)
This graph displays the largest voice mail queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgAcctOutAdapt(1000usec)
This graph displays the average accounting queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxAcctOutAdapt(msec)
This graph displays the largest accounting queue sample holding time (in
milliseconds).

ASSipMsgPerSecond This graph displays the number of Session Initiation Protocol (SIP) messages
(per second).

ASSipRegistersInPerSecond
This graph displays the number of SIP register messages (per second).

ASSipOptionsPerSecond This graph displays the number of SIP option messages (per second).

ASSipSubscribeNotifyPerSecond
This graph displays the number of SIP subscribe messages (per second).

ASSipAvgCallSetupDelayThis graph displays the average time (in milliseconds) it takes between
the receipt of an INVITE message for the origination of a new call and the
transmission of an INVITE (SiIPterminator), Notification Request (RQNT)
(Media Gateway Control Protocol [MGCP] terminator with in-band ringback), or
Create Connection (CRCX) (MGCP terminator without in-band ringback) to the
primary device of the original called party (for intra-group call) or to the network
element of the original called party (for a call to the Public Switched Telephone
Network [PSTN]).

ASSipMaxCallSetupDelay(msec)
This graph displays the longest SIP setup-signal delay.

ASSipAvgAnswerDelay(msec)
This graph displays the average time (in milliseconds) between the receipt of a
200 OK message indicating answer or a NTFY off-hook indicating answer and
the transmission of a 200 OK indicating answer to the originator.

ASSipMaxAnswerDelay(msec)
This graph displays the longest SIP answer-signal delay.

ASSysIntQueueTimeAvgSIPEncodeQ(1000usec)
This graph displays the average SIP encoding queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxSIPEncodeQ(msec)
This graph displays the largest SIP encoding queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgSIPCallDecodeQ(1000usec)
This graph displays the average SIP decoding queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxSIPCallDecodeQ(msec)
This graph displays the largest SIP decoding queue sample holding time (in
milliseconds).

ASMgcpMsgPerSecond This graph displays the number of MGCP messages (per second).

ASMgcpAvgDialToneDelay(msec)
This graph displays the average MGCP dial tone delay time (in milliseconds).

ASMgcpMaxDialToneDelay(msec)
This graph displays the largest dial tone delay time (in milliseconds).

ASMgcpAvgCallSetupDelay(msec)
This graph displays the average MGCP call setup delay time (in milliseconds).

ASMgcpMaxCallSetupDelay
This graph displays the largest MGCP call setup delay time (in milliseconds).
(msec)

ASMgcpAvgAnswerDelay(msec)
This graph displays the average MGCP answer delay time (in milliseconds).

ASMgcpMaxAnswerdelay(msec)
This graph displays the largest MGCP answer delay time (in milliseconds).

ASSysIntQueueTimeAvgCallHalf(1000usec)T1
This graph displays the average call processing queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxCallHalf(msec)T1
This graph displays the largest call processing queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgMGCPEncodeQ(1000usec)
This graph displays the average MGCP encode queue delay time (in
milliseconds).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 68
 Input Box Description

ASSysIntQueueTimeMaxMGCPEncodeQ(msec)
This graph displays the largest MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeAvgCallHalf(1000usec)T2
This graph displays the average call processing queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxCallHalf(msec)T2
This graph displays the largest call processing queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgMGCPDecodeQ(1000usec)
This graph displays the average MGCP decode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxMGCPDecodeQ(1000usec)
This graph displays the largest MGCP decode queue delay time (in
milliseconds).

ASCapMsgPerSecond This graph displays the number of Client Application Protocol (CAP) messages
handled (per second).

ASNbOfMigratedUsers This graph displays the number of users migrated to the secondary Application
Server.

CPUUtilization This graph displays the CPU (system + user) utilization.

MemoryUtilization This graph displays the memory utilization.

hrStorageType_RAM This graph displays the memory type.

hrStorageUsed_RAM This graph displays the memory used.

hrStorageAllocationUnits_RAM
This graph displays the memory allocation unit.

hrStorageSize_RAM This graph displays the memory size.

Device_INTERFACE_out_octets
This graph displays the number of octets sent over the network.

Device_INTERFACE_in_octets
This graph displays the number of octets received over the network.

ReceiveErrors This graph displays the number of packets received in error.

TransmitErrors This graph displays the number of packets transmitted in error.

InDiscards This graph displays the number of incoming packets discarded.

OutDiscards This graph displays the number of outgoing packets discarded.

InterfaceOutUtilization This graph displays the percentage of the interface utilization in output.

InterfaceInUtilization This graph displays the percentage of the interface utilization in input.

ASSysIntQueueTimeAvgSIPEncodeQ(1000usec)T1
This graph displays the average SIP encode queue delay time (in milliseconds).

ASSysIntQueueTimeMaxSIPEncodeQ(msec)T1
This graph displays the largest SIP encode queue delay time (in milliseconds).

ASSysIntQueueTimeAvgSIPCallDecodeQ(1000usec)T1
This graph displays the average SIP call decode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxSIPCallDecodeQ(msec)T1
This graph displays the largest SIP call decode queue delay time (in
milliseconds).

ASSysIntQueueTimeAvgMGCPEncodeQ(1000usec)T1
This graph displays the average MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxMGCPEncodeQ(msec)T1
This graph displays the largest MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeAvgVoiceMailInAdapt(1000usec)T1
This graph displays the average voice mail queue delay time (in milliseconds).

ASSysIntQueueTimeMaxVoiceMailInAdapt(msec)T1
This graph displays the largest voice mail queue delay time (in milliseconds).

ASSysIntQueueTimeAvgRegAdapt(1000usec)T1
This graph displays the average registration queue delay time (in milliseconds).

ASSysIntQueueTimeMaxRegAdapt(msec)T1
This graph displays the largest registration queue delay time (in milliseconds).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 69
 Input Box Description

NSCallpCallsPerSecond This graph displays the number of calls (per second).

NSSipStatsInviteIns This graph displays the number of SIP invites.

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)T1
This graph displays the average SIP redirect queue delay time (in
milliseconds).

NSSipMsgPerSecond This graph displays the number of SIP messages (per second).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)
This graph displays the average SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipDecodeQ(1000usec)
This graph displays the largest SIP decode queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)
This graph displays the average SIP redirect queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipEncodeQ(msec)
This graph displays the largest SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipDecodeQ(msec)
This graph displays the largest SIP decode queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)
This graph displays the largest SIP redirect queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)T2
This graph displays the average SIP redirect queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)T1
This graph displays the largest SIP redirect queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)T2
This graph displays the largest SIP redirect queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)T1
This graph displays the average SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)T2
This graph displays the average SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipEncodeQ(msec)T2
This graph displays the largest SIP encode queue delay time (in milliseconds).

Alarm Status

Status This column displays the status of the alarm. Values include: Critical, Major,
Minor, Warning, Info, and Clear.

Source – Alarm Name This column displays the name of the alarm or the category of the alarm. For
or Category more information, see the BroadWorks Fault and Alarm Interface Specification.

Date/Time This column displays the date and time the alarm was issued.

Alarm Details This column displays the alarm description. It is also a link to the details of the
alarm on the Fault tab. For more information, see View Alarm Properties on
page 186.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 70
3.2.2 Execute Remote Command
Remote command execution is available from the Node Properties page. The remote command's
functionality provides remote access to a given command. The EMS waits for the command to complete or
time out. Once the command is executed, you can see the command result.
Following is a list of the supported commands and their descriptions:

NOTE: The menu is different based on the BroadWorks server type. The Peer Ctl Status and Rep Ctl
Status commands are only available for the Application Server and the Network Server. These commands
do not appear for other servers.

NOTE: Remote commands are not available for the Conferencing Server.

Command Description

BW Show Run This command is used to view all active BroadWorks processes.
An empty list means the application is not running.

BW Show Version This command is used to view the active BroadWorks release
and applied patches.

BW Health Mon This command is used to monitor and report the status of a
BroadWorks server.

BW CPU Mon This command runs the CPU monitoring script (for CPU idle
percentage and memory usage).

BW Tech Support This command is used to report the server software version,
the BroadWorks process and Solaris process status, the IP
configuration, the redundancy status, and other diagnostics.

BW List Port In Use This command provides a list of all Transmission Control
Protocol (TCP) and User Datagram Protocol (UDP) ports
configured to be used by BroadWorks.

BW Auto Cleanup This command is used to run automatic cleanup of specific

directories on the server to help manage disk space usage.

BW View SNMP Access List This command is used to view the list of IP addresses
configured in the SNMP access list of the node (for SNMP
performance measurement [PM] request).

BW View Trap Table This command is used to view the list of IP addresses
configured in the SNMP trap table of the node. The traps
generated by the node are sent to IP addresses specified on this
list.

BW Installed Software This command is used to view information about installed

BroadWorks server loads, patches, and third-party software.

BW Server Status This command is used to query a BroadWorks server for

information on Server Type, Redundancy Type, the Active
Software version, and so on.

BW Peer Ctl List This command is used to list all cluster peers.

BW Rep Ctl Status This command is used to get the status of file and database
replication. A lock file is created in /var/broadworks/lock /repctl
to prevent multiple instances from running simultaneously.

To execute a remote command:

1) To access the Node Properties page from the Maps tab:
a) Click the Maps tab.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 71
 b) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
c) Click the icon representing the BroadWorks node you are interested in. The Node Properties page
appears.
2) From the Node Properties page, select the remote command from the BW Remote Cmd drop-down list.
A Request sent dialog box appears.
3) When the request is done, a Result dialog box appears showing the results of the command that has
been run.
4) Click Close when you are finished with the results.

3.2.3 View Routing Tables of Node

Use the Routing Table page to view the routing table for a node.

Figure 25: Routing Table

The information on this page includes the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 72
 Column Description

ipRouteDest This column displays the IP route destination.

ipRouteNextHop This column displays the IP route next hop.

To display the routing table for a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "Routing Table" from the Snmp-Node drop-down list. The
Routing Table page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

3.2.4 View Interfaces of Node

Use the Interfaces page to view the interfaces table for a node.

Figure 26: Interfaces

The information on this page includes the following:

Column Description

ifIndex This column displays the index of the interface.

ifDescr This column displays the description of the interface.

ifType This column displays the type of the interface.

ifSpeed This column displays the speed of the interface.

ifPhysAddress This column displays the physical address of the interface.

ifAdminStatus This column displays the administration status of the interface.

ifOperStatus This column displays the operational status of the interface.

ifInOctets This column displays the number of input octets to the interface.

ifOutOctets This column displays the number of output octets from the interface.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 73
 Column Description

ifOutDiscards This column displays the number of output discards from the interface.

To display the interfaces of a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "Interfaces" from the Snmp-Node drop-down list. The Interfaces
page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

3.2.5 View TCP Table

Use the TCP Table page to view the TCP table for a node.

Figure 27: TCP Table

The information on this page includes the following:

Column Description

tcpConnState This column displays the TCP connection state.

tcpConnLocalAddress This column displays the local address of the TCP connection.

tcpConnLocalPort This column displays the local port of the TCP connection.

tcpConnRemAddress This column displays the remote address of the TCP connection.

tcpConnRemPort This column displays the remote port of the TCP connection.

To display the Transmission Control Protocols for a node:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 74
 1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "TCP Table" from the Snmp-Node drop-down list. The TCP
Table page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

3.2.6 View UDP Table

Use the UDP Table page to view the UDP tables for a node.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 75
 Figure 28: UDP Table

The information on this page includes the following:

Column Description

udpLocalAddress This column displays the local UDP address.

udpLocalPort This column displays the local UDP port.

To display the User Datagram Protocols for a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 76
 1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "UDP Table" from the Snmp-Node drop-down list. The UDP
Table page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

3.2.7 View IP Net to Media Table

Use the IPNetToMediaTable page to view the IPNet to Media table for a node.

Figure 29: IPNet to Media Table

The information on this page includes the following:

Column Description

ipNetToMedialfIndex This column displays the index of the IPNet to Media.

ipNetToMediaPhysAddress This column displays the physical address of the IPNet to Media.

ipNetToMediaNetAddress This column displays the network address of the IPNet to Media.

ipNetToMediaType This column displays the type of IPNet to Media.

To display the IPNet to Media table for a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 77
 2) From the Node Properties page, select "IPNetToMedia Table" from the Snmp-Node drop-down list. The
IPNetToMediaTable page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

3.2.8 Refresh this Node

Use the Refresh Node page to view the results of a refreshed node (server).

Figure 30: Refresh Node Results

To refresh a node from the Maps tab:

1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the BroadWorks
cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties page
appears.
4) From the Node Properties page, select "Refresh Node" from the Snmp-Node drop-down list. The
Refresh Node page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode".

5) Click Refresh. The results of the refresh appear.

To refresh a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
4) From the Node Properties page, select "Refresh Node" from the Snmp-Node drop-down list. The
Refresh Node page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode".

5) Click Refresh. The results of the refresh appear.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 78
3.2.9 Configure Node Access
The Configure Node Access page is used to set user names and passwords for web access and telnet/
SSH access where the default user names and passwords have changed or new user names and
passwords have been added for the Network Server seed.
Use the Configure Node Access page to configure the Network Server seed used to discover BroadWorks
servers.

Figure 31: Configure Node Access

The information on this page includes the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 79
 Input Box Description

Enter web username This text box specifies the user name for the web portal.

Enter web password This text box specifies the user password for the web portal.

Re-enter web password This text box specifies the reconfirmed user password for the web portal.

Enter CORBA port number This text box specifies the CORBA port number.

Enter BCCT port number This text box specifies the BroadWorks Common Communication Transport (BCCT) port number.

Secure This check box controls whether the BCCT port is secure.

Enter ssh username This text box specifies the user name for the secure shell (SSH).

Enter ssh password This text box specifies the user password for the SSH.

Reenter ssh password This text box specifies the reconfirmed user password for the SSH.

Enter ssh port number This text box specifies the SSH port number.

Enter telnet port number This text box specifies the telnet port number.

SNMP Port This text box specifies the SNMP port number.

Read Community This text box specifies the read community.

Write Community This text box specifies the write community.

Enable V3 This check box controls whether the SNMP v3 is enabled.

User Name This text box specifies the SNMP v3 user name.

Context Name This text box specifies the SNMP v3 context name.

To access the Node Access page:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "Configure BW Node" from the drop-down list. The Configure
Node Access window appears.
To configure the node access:
1) Click the Maps tab.
2) Click Configure Node Access. The Configure Node Access window appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 80
 Figure 32: Node Access (Page 1)
3) In the Node to configure text box, type the IP address of your server and click Next. The access input
boxes appear with default parameters.
4) Modify the input boxes as required.

NOTE: Changes made to telnet/SSH only apply if NIS+ is not enabled.

5) Click Submit Request to complete the configuration. To cancel the request, click Cancel Request.

3.2.10 Cut Through to BroadWorks Web Portal Interface

A web cut-through session allows you to open and log in to the BroadWorks Web Portal interface for the
specified server. You must first configure the server web access login properties as indicated on the Node
Access page. For information on the Node Access page, see Configure Node Access on page 79.
To open a cut-through session to BroadWorks Web Portal interface:
1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "BW WEB Cut-through" from the BW Node drop-down list. The
web portal interface for the selected server appears.

3.2.11 Cut Through to BroadWorks SSH Session

An SSH cut-through session allows you to open and log in to an SSH session for the specified server. You
must first configure the server SSH access login properties as indicated on the Node Access page. For
information on the Node Access page, see Configure Node Access on page 79.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 81
 1) To access the Node Properties page from the Maps tab:
a) Click the Maps tab.
b) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
c) Click the icon representing the BroadWorks node you are interested in. The Node Properties page
appears.
2) From the Node Properties page, select "Automated SSH" from the BW Node drop-down list. The SSH
session window for the specified server appears.

3.2.12 Cut Through to BroadWorks Telnet Session

A telnet cut-through session allows you to open and log in to a telnet session for the specified server. You
must first configure the server telnet access login properties as indicated on the Node Access page. For
information on the Node Access page, see Configure Node Access on page 79.
1) To access the Node Properties page from the Maps tab:
a) Click the Maps tab.
b) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
c) Click the icon representing the BroadWorks node you are interested in. The Node Properties page
appears.
2) From the Node Properties page, select "Automated Telnet" from the BW Node drop-down list. The
telnet session window for the specified server appears.

3.2.13 Discover BroadWorks Servers

BroadWorks servers need to be managed by the EMS so that the EMS can also monitor them. A server
becomes managed when it is discovered by the EMS through the Network Server (NS) seed or it is added
manually. Discover BroadWorks servers provides the ability to discover all BroadWorks servers with the
following exceptions:
• Xtended Service Platform (Xsp)
• Database Server (DBS)
• Provisioning Server (PS)

NOTE: Add an Xtended Services Platform or Provisioning Server node before you perform a Discovery
procedure.

NOTE: The auto-discovery procedure is not recommended for BroadWorks servers with multiple
interfaces. These must be added using the manual Add Node procedure to ensure that all the functions
provided by the EMS work properly. For information, see Add BroadWorks Servers with Multiple
Interfaces on page 39.

Managed Elements Auto-Configuration and Network Auto-Discovery

The Auto-configuration and Network Auto-discovery features are interrelated. The Auto-configuration
feature relies on the Network Auto-discovery feature to determine the managed elements.
However, the Auto-configuration feature is triggered first upon the addition of a node. For the provided
Network Server seed, the auto-discovery occurs only once the auto-configuration for the provided Network
Server seed has succeeded. Using this approach, the network auto-discovery confirms that a valid UNIX
user name and password exist for the provided Network Server seed. As auto-discovery identifies other
nodes for addition, the EMS uses the same approach by invoking the Auto-configuration feature first.
Nevertheless, a successful auto-configuration is not mandatory, that is, the EMS adds a node even if the
auto-configuration has failed. Upon success, having the Auto-configuration feature invoked first allows the

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 82
 EMS to add an SNMP node. Note that as auto-configuration populates the SNMP access list, the EMS
successfully queries the SNMP. If the auto-configuration fails, the EMS adds a regular node.
Managed Elements Auto-Configuration
As auto-discovery identifies nodes for addition, the EMS runs the Auto-configuration feature. The EMS
uses secure shell (SSH) to run remote scripts on the managed node.
The remote script performs the following tasks:
• Auto-populates the EMS IP address to the SNMP access control list (ACL) and trap table (TT).
The EMS populates the trap table using the object identifier (OID) shared model. Upon receiving traps,
the EMS parses the message text to identify relevant content.
• Auto-populates the EMS IP address to the Network Server operations support system (OSS) access
list.
• Auto-populates the EMS IP address to the Application Server Open Client Interface (OCI) access list.
• Auto-populates the EMS IP address to the BroadWorks Common Communication Transport (BCCT)
access list.
• Auto-configures syslog trap forwarding to the EMS.
• Retrieves the platform type.
• Retrieves the operating system (OS) information, the BroadWorks server type and active release, and
the Software Manager version.

Figure 33: Discover BroadWorks Servers

To discover BroadWorks servers:

1) Click the Maps tab.
2) Click Discover BW Servers. Alternately, from the Node Properties page, select BW Discovery from the
drop-down list. The Discover BW Servers window appears.
3) In the Please enter NS seed text box, enter the IP address, domain name, or host name of the Network
Server seed.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 83
 4) The Start BW Discovery Now check box is enabled by default. Deselect it if you do not want to process
the discovery immediately. The BroadWorks Discovery may be recurrent. Configuring the rediscovery
option enables EMS to synchronize its network representation with changes that occur in the network.
Alternatively, the administrator can reinvoke the BroadWorks Discovery manually.
5) By default, the Keep any existing configuration check box is enabled. This keeps the previously
specified rediscovery configuration. If it is the first time discovery is entered, no rediscovery is
performed. Alternatively, you can select either Disable future rediscovery or Enable future rediscovery.
Both of these options supersede any previous discovery configurations. If you select Disable future
rediscovery and it is the first time discovery is entered, no discovery is performed.

NOTE: If you select Disable future rediscovery, the Keep any existing configuration check box is
automatically disabled.

6) If you selected Enable future rediscovery, enter the interval time in the New rediscovery interval (in
minutes) text box.
7) Click Submit Request. A message displaying "Discovery request successfully submitted" appears.
The EMS is processing the validity of the discovery request. For information on reviewing the results of
a discovery, see Review Discovery Results on page 42.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 84
4 Managing Inventory

This section provides information on how to use the EMS inventory.

This section describes the following:
• Overview of Inventory on page 85
• Managing All Objects in Complete View on page 86
• Managing Networks on page 118
• Managing Groups on page 127
• Managing Nodes on page 134
• Managing Interfaces on page 156

4.1 Overview of Inventory

The BroadWorks EMS provides access to the networks, groups, nodes, and interfaces on your network
once they have been discovered. The Inventory contains the database of the properties of all the elements
managed in a network. These elements and their associated properties are listed in the inventory view.
To simplify searching through the database, there are various views of the inventory. These include:
• Complete View
• Networks
• Groups
• Nodes
• Interfaces
The Inventory tab allows you to access all of the networks, groups, nodes, and interfaces managed by your
EMS.
The Inventory tab displays the Inventory menu.

Figure 34: Inventory Menu

From this menu, you can perform the following:

Menu Description

Complete View Displays the list of all the managed elements: networks,
groups, nodes, and interfaces.

Networks Displays the list of all the managed networks on your EMS
network. From this list, you can configure any network.

Groups Displays the list of all the managed groups on your EMS
network. From this list, you can configure any group.

Nodes Displays the list of all the managed nodes (servers) on your
EMS network. From this list, you can configure any node.

Interfaces Displays the list of all the managed interfaces on your EMS
network. From this list, you can configure any interface.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 85
 To access the Inventory tab:
Click the Inventory tab. The Inventory tab appears.

4.2 Managing All Objects in Complete View

Use the Complete View page to list and manage all objects (networks, groups, nodes, and interfaces) on
your EMS network.

Figure 35: Complete View

The information on this page includes the following:

Column Description

Name This column displays the name of the managed object.

Display Name This column displays the name of the managed object as it appears on the EMS maps.

BW Type This column displays the type of BroadWorks server.

MO Type This column displays the type of the managed object.

Status This column displays the status of the managed object. When the managed object is "unmanaged",
this column displays a gray icon "?". When the managed object is "managed", a red (Critical),
orange (Major), yellow (Minor), blue (Warning), or green (Healthy) arrow icon appears.

To display the complete view of the inventory:

1) Click the Inventory tab.
2) Select the Complete View menu. The Complete View page appears.
3) To print this view of the inventory:
a) Click Print Version. A PDF view of the current list of the inventory appears in a new window.
b) From the File menu, click Print. The Print dialog box appears.
c) Select the printer and click Print.
d) Close the window.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 86
 4) To view the events in the inventory:
a) Click the check box for the managed object(s) (network, group, node, or interface) for which you
want to display the related events.
b) Click View Events. The Events page displays the list of events related to the selected managed
object.

NOTE: If there have not been any events triggered for the selected managed object, the page
displays a message indicating that there is no data to display.

5) To view the alarms in the inventory:

a) Click the check box for the managed object(s) (network, group, node, or interface) for which you
want to display the related alarms.
b) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

6) To manage an object in the inventory:

a) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
b) Click Manage.
7) To "unmanage" an object in the inventory:
a) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".
b) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
Tasks to perform from this page

4.2.1 Add Child View of the Inventory

You can add/create a new view by specifying various criteria and providing a name for the view. The views
you create enable you to quickly monitor your inventory of managed objects (networks, groups, nodes,
and interfaces). Multiple views can also be created to display a variety of information. For example, you
can create a new view named MasterSNMP, which shows only those nodes that are based on the Simple
Network Management Protocol (SNMP).
Use the Add Topology Child View page to add a child view of the inventory.

Figure 36: Add Topology Child View

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 87
 The information on this page includes the following:
Column Description

Custom view name This text box defines the name of the child view.

First drop-down list This drop-down list includes the properties available to define this view. These include:
• name: includes managed objects based on their names
• status: includes managed objects based on their status. Possible status values are: critical,
major, minor, warning, info, and clear.
• ipAddress: includes managed objects based on their IP addresses
• managed: includes managed objects depending on whether they are currently managed
• type: includes managed objects of a specific type (for example, bwserver-app, SnmpNode, and
so on)
• snmpport: includes managed objects by SNMP port
• version: includes managed objects by their version number
• isSNMP: includes managed objects depending on whether they run on SNMP
• statusPollEnabled: includes managed objects depending on whether they are enabled to poll for
status
• pollInterval: includes managed objects based on their polling interval
• statusUpdateTime: includes managed objects based on the time of status update
• statusChangeTime: includes managed objects based on the time of status change
• isDHCP: includes managed objects depending on whether they run on the Dynamic Host
Configuration Protocol (DHCP)
• isNode: includes managed objects depending on whether they are nodes
• isInterface: includes managed objects depending on whether they are interfaces
• isRouter: includes managed objects depending on whether they are routers
• isNetwork: includes managed objects depending on whether they are networks

Second drop-down list This drop-down list includes the Boolean statements available to define this view. These include:
• equals
• not equals
• starts with
• ends with
• contains
• does not contain

Text box This text box specifies the view criteria.

To add a child view from the complete view of the inventory:

1) From any View page, (Complete View, Network View, Group View, Node View, Interface View), click
Add Child View. The Add Child View page for that view appears.
2) In the Custom view name text box, type the name of the child view. This input box is mandatory.
3) Select the property from the first drop-down list.
4) Select the Boolean statement from the second drop-down list.
5) In the text box, type the view criteria.
6) To add additional criteria, click More and repeat steps 2 through 4.

NOTE: To remove existing criteria, click Fewer.

7) To preview the results of this view, click Preview Results. The view appears.
8) To add this view to the Inventory menu, click Add Child View. This view appears on the Inventory
menu.
Tasks to perform from this page

4.2.1.1 Edit Child View of Inventory

Use the Edit Topology View Criteria - Complete View page to modify the child view of the inventory.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 88
 Figure 37: Edit Topology View Criteria - Complete View

To edit the view criteria of a child view from the complete view of the inventory:
1) From any View page, (Complete View, Network View, Group View, Node View, Interface View), click
Edit View Criteria. The Edit Topology View Criteria page appears.
2) In the Custom view name text box, type the name of the child view. This input box is mandatory.
3) Select the property from the first drop-down list.
4) Select the Boolean statement from the second drop-down list.
5) In the text box, type the view criteria.
6) To add additional criteria, click More and repeat steps 3 through 5.

NOTE: To remove existing criteria, click Fewer.

7) To preview the results of this view, click Preview Results. The view appears.
8) To save the changes to this view, click Apply. This view appears on the Inventory menu.

4.2.1.2 Remove Child View of Inventory

1) From a view page, click Remove View. A message asks for your confirmation.
2) To permanently remove this view, click OK. Click Cancel to return to the previous page.

NOTE: When a view is deleted, all of its child views are also removed.

4.2.1.3 Search
Use the Search page to search for alarms, events, or managed objects.

Figure 38: Advanced Search

To search:
1) From a view page, click Search and complete the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 89
 2) Select Match any of the Following to perform a search operation that satisfies any of the specified
matching criteria or select Match all of the Following to perform a search operation that satisfies all of
the specified matching criteria.
3) In the left-hand input box (Properties), select the property based on which you need to perform your
search. If you select the time property as a search criterion, the Date Input Helper icon appears. It can
help you quickly specify the time and date of interest.
4) In the middle input box (Condition), select the condition based on which you need to restrict your
search.
5) In the right-hand input box, type the exact information you are looking for. For example, if you have
selected severity in the Properties box, then you must specify the severity value here, such as "critical",
"major", and so on.
6) To specify additional criteria, click More and repeat steps 2 through 4. Fewer options can be used to
remove the criteria that were last added.
7) Click Search. Events satisfying the criteria appear.

4.2.1.4 Customize Columns of Child View

The properties are displayed as columns in the list view. You can add more columns or remove existing
columns in the events list view.
Use the Customize Columns page to customize the columns for a view of events, alarms, or managed
objects.

Figure 39: Customize Columns

To customize the columns of a view:

1) From a view page, click Customize Columns. The Customize Columns page appears.
2) To add new columns, select the property (based on which columns are created) from the Available
columns list and click the arrow pointing to the right. The property is moved to the Displayed columns.
Multiple properties can be selected using the CTRL+Click and SHIFT+Click options.
3) To remove existing columns, select the property from the Displayed columns list and click the arrow
pointing to the left. The property is moved to the Available columns list.
4) In the Displayed columns list, use the up and down arrows to order the columns in the view, from left to
right.
5) Click Apply. The list view is refreshed using your custom column arrangement.

4.2.2 View Properties

Click on the following to view the corresponding properties:

4.2.2.1 View Network Properties

Use the Network Properties page to display the properties of a network.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 90
 NOTE: The buttons that appear on this page reflect the state of the network.

Figure 40: Network Properties

To view the properties of a network:

From a list page, click the link of the network to view. The Network Properties page appears.
To manage this network:
1) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
2) Click Manage.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 91
 To "unmanage" this network:
1) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".
2) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
To view the events for this network:
1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related events.
2) Click View Events. The Events page displays the list of events related to the selected managed object.

NOTE: If there have not been any events triggered for the selected managed object, the page displays
a message indicating that there is no data to display.

To view the alarms for this network:

1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related alarms.
2) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

To discover this network:

Click Start Discovery. The discovery process begins.

NOTE: Click Stop Discovery to interrupt the discovery process.

To "undiscover" this network:

Click Undiscover. The network is no longer present on the EMS network.
For more information
4.2.2.1.1 Network Property Reference
Input Box Description

General Information

Device Type This text box displays the device type of the node, group, or interface.

Is Managed? This option controls whether the node, group, or interface is managed or "unmanaged". When
a node, group, or interface is "unmanaged", status polling and data collection stops. Therefore,
threshold calculation is not done. Traps for the node, group, or interface continue to be processed.
To disable the processing of traps, see the Configure Fault Management Parameters on page 303.

IP Address This text box specifies the IP address of the node, group, or interface.

Is DHCP Enabled? This text box displays whether Dynamic Host Configuration Protocol (DHCP) is enabled on the node,
group, or interface.

Status This option displays the overall alarm status of the node. The highest alarm severity level associated
with the node, group, or interface is displayed.

Display Name This input box displays the name of the node, group, or interface that is used on the web interface.

Netmask This drop-down list specifies the network mask of the node, group, or interface.

Status Monitoring Details

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 92
 Input Box Description

Is Status polling enabled? This option controls status polling on the node, group, or interface. If the value is set to "yes", the
status of the node, group, or interface (alarms and events) is available through the web interface. If
the value is set to "false", the status is not available.

Last Status Update Time This text box displays the time stamp of the last time the node, group, or interface was polled for its
status.

User Class Name This text box specifies the class to be invoked for status polling. Set this parameter only if the
selected value of the Tester for Status Polling parameter is "User Test".

Failure Count This text box displays the number of times the EMS has failed to poll the node, group, or interface.

Tester for Status Polling This drop-down list provides the ability to select the action to be performed on status polling for the
node, group, or interface. When the selected value is "Max", the status of the interface is propagated
to the node. If the value "User Test" is used, the User Class Name parameter should be set with the
name of the user tester class.

Last Status Change Time This text box displays the time stamp of the last time the status of the node was changed.

Failure Threshold This text box displays the maximum number of occurrences of a failure before an alarm threshold is
reached.

Status Polling Interval This text box indicates the frequency that the node is polled for its status (in seconds).

Discovery Settings

Discover Status This text box displays the status of Discovery on the network.

Start/Resume Discovery This text box appears if the discovery command is currently available for this network.

Nodes & Interfaces Details

List of Nodes This text box displays the list of discovered nodes on this network.

Sub Networks This text box displays the subnetworks included on this network.

Parent Netmask This text box displays the parent netmask for this network.

List of Interfaces This text box displays the list of interfaces on this network.

Sub Netmasks This text box displays the subnetmasks included on this network.

Parent Network This text box displays the parent network on this network.

Group

CPU Utilization This text box displays the Central Processing Unit (CPU) utilization of this network at the time of the
last polling.

Memory Utilization This text box displays the current memory utilization of the network at the time of the last polling.

Disk Utilization This text box displays the current disk utilization of the network at the time of the last polling.

Alarm Status

Status This column displays the status of the alarm. Values include: Critical, Major, Minor, Warning, Info,
and Clear.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 93
 Input Box Description

Source – Alarm Name or This column displays the name of the alarm or the category of the alarm. For more information, see
Category the BroadWorks Fault and Alarm Interface Specification.

Date/Time This column displays the date and time the alarm was issued.

Alarm Details This column displays a link to the details of the alarm on the Fault tab. For more information on
alarms, see the Overview of Alarms on page 180.

4.2.2.1.2 Edit Network Properties

1) From the Network Properties page, click Edit on the section to edit.
2) Modify the properties.
3) Click Update Object to save the changes or click Reset to reset the values to the previous settings.
4) Repeat steps 1 through 3 for each section that requires modification.

4.2.2.2 View Node Properties

Use the Node Properties page to display the properties of a node.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 94
BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00
©2014 BROADSOFT, INC. PAGE 95
 Figure 41: Node Properties

To view the properties of a node:

From a list page, click the link of the node to view. The Node Properties page appears.
To "unmanage" a node:
1) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 96
 2) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
To manage a node:
1) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
2) Click Manage.
To view the events for a node:
1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related events.
2) Click View Events. The Events page displays the list of events related to the selected managed object.

NOTE: If there have not been any events triggered for the selected managed object, the page displays
a message indicating that there is no data to display.

To view the alarms for a node:

1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related alarms.
2) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

For more information

4.2.2.2.1 Node Property Reference
Input Box Description

General Information

Device Type This text box displays the device type of the node.

Is Managed? This option controls whether the node is managed or "unmanaged". When
a managed object is "unmanaged", status polling and data collection stops.
Therefore, threshold calculation is not done. Traps for the node continue to
be processed. To disable the processing of traps, see the Configure Fault
Management Parameters on page 303.

IP Address This text box specifies the IP address of the node.

Is DHCP Enabled? This text box indicates whether Dynamic Host Configuration Protocol (DHCP) is
enabled on the node.

Status This text box displays the overall alarm status of the node. The highest alarm
severity level associated with the node is displayed.

Display Name This input box displays the managed object's name that is used on the web
interface.

Netmask This drop-down list specifies the network mask of the node.

User Properties Details

UnamePlatform This text box displays the platform type of the node. This value corresponds to
the result of the command uname -i when it is run on the node.

SnmpAgentUnreachable This text box indicates whether the SNMP agent of the node is unreachable.

ConfiguredMemory This text box displays the amount of memory available on the node.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 97
 Input Box Description

Threshold Name(s) This text box lists the threshold names that apply to the node when computing
(Multiplicator) performance.

bwName-NodeId This text box displays the name of the nodes clustered together with the node
ID within the cluster.

bwIpForWeb This text box displays the IP address to be used to access the web interface of
the node.

bwIsPrimary This text box indicates whether the node is the primary server of the cluster.

bw.config.requiresRestart This is an internal BroadWorks text box.

bw.config.interfaces This is an internal BroadWorks text box.

bwNsSeed This text box displays the IP address of the Network Server seed that was used
to discover the node. When a node is added manually, BW-Other is displayed.

bwManuallyAdded This text box indicates whether the node was manually added through "Add
Node" or discovered through a Network Server seed.

Server Type This text box displays the type of server. Valid values include: Application
Server (AS), Network Server (NS), Media Server (MS), Xtended Services
Platform (XSP), Profile Server (PS), Web Server (WS), Execution Server
(XS), Call Detail Server (CDS), Access Mediation Server (AMS), Conferencing
Server (CS), and Database Server (DBS).

bw.config.memorySize This is an internal BroadWorks text box.

bwPlatformName This text box displays the name of the hardware platform. It is taken from the
product name available from the command dmidecode (available on x86_64
server only).

bwPlatformType This text box displays the platform type from a performance point of view.

Processor This text box displays the processor architecture of the node.

Operating System This text box displays the operating system running on the node.

BW Version This text box displays the version of BroadWorks running on the node.

bw.config.managementMode
This is an internal BroadWorks text box.

bw.config.currentSchema This is an internal BroadWorks text box.

Modifier Factor(s) This text box displays the modifier factor used by the performance module to
compute the statistics and threshold for the node.

bw.config.schemaVersionThis is an internal BroadWorks text box.

BroadWorksServer This text box indicates whether the node is a BroadWorks Server. If the value is
"true", the node is a BroadWorks Server. If the value is "false", it is not.

bw.config.currentVersion This is an internal BroadWorks text box

SWManager version This text box displays the version of the Software Manager running on the
node.

NodeDesc This text box describes the node within the cluster context.

NumberOfCores This text box specifies the number of cores available on the node.

Status Monitoring Details

Is Status polling This option controls status polling on the node. If the value is set to "yes", the
enabled? status of the node (alarms and events) is available through the web interface. If
the value is set to "false", the status is not available.

Last Status Change This text box displays the time of the last change of status.
Time

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 98
 Input Box Description

Last Status Update This text box displays the time stamp of the last time the node was polled for its
Time status.

Failure Threshold This input box specifies the number of consecutive failed status poll attempts to
declare the object as failed. A status change event for the object is generated
when the status polling for the object fails for "Failure Threshold" times.

Failure Count This text box displays the number of times consecutive status poll attempts for
this object have failed. The count is reset to "0" once the object is declared as
failed or when the object recovers after the failure. When the value of "Failure
Count" equals that of "Failure Threshold", the object is declared failed.

Tester for Status This drop-down list provides the ability to select the action to be performed on
Polling status polling for the managed object. When the selected value is "Max", the
status of the interface is propagated to the managed node. If the value "User
Test" is used, the User Class Name parameter should be set with the name of
the user tester class.

User Class Name This input box specifies the class to be invoked for status polling. Set this
parameter only if the selected value of the Tester for Status Polling parameter
is "User Test".

Status Polling Interval This input box specifies the interval between status polling attempts for this
group.

Interfaces & Parent Networks

List of Interfaces This drop-down list displays the list of interfaces available on this node.

Parent Object This text box specifies the parent of the managed object.

Is Container? This text box specifies whether the managed object is a container.

Parent Networks This drop-down list displays the IP address of the parent network(s).

List of Groups This drop-down list identifies the names of the groups to which the node
belongs.

Is Group? This text box specifies whether the managed object is a group.

Protocol Configuration Settings

SNMP Port This text box displays the SNMP port number that the EMS uses to retrieve
SNMP values from this interface.

Read Community This text box displays the read community associated with this interface.

SNMP Version This text box displays the SNMP version running on this interface.

System Object This text box displays the node's sysOID MIB-II value.
Identifier (SysOID)

Host Netmask This text box displays the host netmask.

Base MIBs This text box displays the list of base Management Information Bases (MIBs)
implemented by the SNMP agent of the node.

Write Community This text box specifies the write community associated with this node.

System Description This text box displays the node's sysDescr MIB-II value.
(sysDescr)

Interfaces

Index This text box displays the hardware index of the interface.

Description This link navigates to the Property details of the interface.

Speed(bps) This text box displays the speed of the interface.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 99
 Input Box Description

Status This text box displays the overall alarm status of the interface. The highest
alarm severity level associated with the interface is displayed. Supported
values are: critical(1), major(2), minor(3), warning(4), clear(5).

MAC This text box displays the Media Access Control (MAC) address of this
interface.

CPU Utilization If available, this diagram illustrates the amount of CPU utilization on the node.

Memory Utilization If available, this diagram illustrates the amount of memory utilization on the
node.

Disk Utilization If available, this diagram illustrates the amount of disk utilization on the node.

Other Graphs

INTERFACE_out_octets This graph displays the total number of octets transmitted out of the interface,
including framing characters.

INTERFACE_in_octets This graph displays the total number of octets received on the interface,
including framing characters.

memUsageSwap This graph displays the amount of memory swapped to disk per second.

memUsagePaging This graph displays the amount of virtual memory used.

virtualMemWaitThreads This graph displays the number of processes waiting for run time.

virtualMemBlkThreads This graph displays the number of processes in "uninterruptible" sleep.

virtualMemNumCPUs This graph displays the number of CPUs.

waitThreadsRatio This graph displays the ratio of wait threads per CPU instance.

blockedVsWaitThreads This graph displays the difference between the blocked threads and the wait
threads.

diskUsageSlash This graph displays the disk usage for the "/" directory.

diskUsageBw This graph displays the disk usage for the "/bw" directory.

CPUBusy This graph displays the sum of CPUSys and CPUUsr.

CPUIdle This graph displays the percentage of the CPU idle time.

CPUSys This graph displays the percentage of the CPU used by the system.

CPUUsr This graph displays the percentage of the CPU used by the user programs.

ASBusyHourCallAttemptsThis graph displays the number of call attempts per hour.

ASOciRequestsInPerSecond
This graph displays the number of Open Client Interface (OCI) requests
attempted per second.

diskUsageTmp This graph displays the disk usage for the /tmp directory.

maxDiskIOSvc This graph displays the maximum disk Input Output (IO) svc time.

maxDiskIOBusy This graph displays the maximum disk IO busy time.

maxDiskIOBsyVsSvc This graph displays the maximum disk IO busy time versus svc time.

maxXsJavaHeap This graph displays the maximum Java heap used by the Execution Server.

totalXsJavaHeap This graph displays the total Java heap used by the Execution Server.

percentXsJHeap This graph displays the percentage of the Java heap used by the Execution
Server.

dsnInUse This graph displays the percentage of usage of the DataStore Name (DSN).

ASOciAvgRequestDelay This graph displays the average time (in milliseconds based on a rolling
average of the last 100 samples) it takes to process an OCI request.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 100
 Input Box Description

ASOciMaxRequestDelay This graph displays the longest OCI request response time.

AStoSMTPtraffic This graph displays the total number of messages sent attempted on the
primary Simple Mail Transfer Protocol (SMTP) server.

ASNbOfUsers This graph displays the number of users configured on the node.

ASCallsPerSecond This graph displays the number of calls per second.

ASActiveCalls This graph displays the number of active calls on the node.

ASSysIntQueueTimeAvgCallHalf
This graph displays the average call processing queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxCallHalf(msec)
This graph displays the largest call processing queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgRegAdapt(1000usec)
This graph displays the average registration queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxRegAdapt(msec)
This graph displays the largest registration queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgCallPThreadDBAccess(1000usec)
This graph displays the average database access from call processing queue
holding time (in milliseconds).

ASSysIntQueueTimeMaxCallPThreadDBAccess(msec)
This graph displays the largest database access from call processing queue
sample holding time (in milliseconds).

ASSysIntQueueTimeAvgVoiceMailInAdapt(1000usec)
This graph displays the average voice mail queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxVoiceMailInAdapt(msec)
This graph displays the largest voice mail queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgAcctOutAdapt(1000usec)
This graph displays the average accounting queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxAcctOutAdapt(msec)
This graph displays the largest accounting queue sample holding time (in
milliseconds).

ASSipMsgPerSecond This graph displays the number of Session Initiation Protocol (SIP) messages
(per second).

ASSipRegistersInPerSecond
This graph displays the number of SIP register messages (per second).

ASSipOptionsPerSecond This graph displays the number of SIP option messages (per second).

ASSipSubscribeNotifyPerSecond
This graph displays the number of SIP subscribe messages (per second).

ASSipAvgCallSetupDelayThis graph displays the average time (in milliseconds) it takes between
the receipt of an INVITE message for the origination of a new call and the
transmission of an INVITE (SiIPterminator), Notification Request (RQNT)
(Media Gateway Control Protocol [MGCP] terminator with in-band ringback), or
Create Connection (CRCX) (MGCP terminator without in-band ringback) to the
primary device of the original called party (for intra-group call) or to the network
element of the original called party (for a call to the Public Switched Telephone
Network [PSTN]).

ASSipMaxCallSetupDelay(msec)
This graph displays the longest SIP setup-signal delay.

ASSipAvgAnswerDelay(msec)
This graph displays the average time (in milliseconds) between the receipt of a
200 OK message indicating answer or a NTFY off-hook indicating answer and
the transmission of a 200 OK indicating answer to the originator.

ASSipMaxAnswerDelay(msec)
This graph displays the longest SIP answer-signal delay.

ASSysIntQueueTimeAvgSIPEncodeQ(1000usec)
This graph displays the average SIP encoding queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxSIPEncodeQ(msec)
This graph displays the largest SIP encoding queue sample holding time (in
milliseconds).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 101
 Input Box Description

ASSysIntQueueTimeAvgSIPCallDecodeQ(1000usec)
This graph displays the average SIP decoding queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxSIPCallDecodeQ(msec)
This graph displays the largest SIP decoding queue sample holding time (in
milliseconds).

ASMgcpMsgPerSecond This graph displays the number of MGCP messages (per second).

ASMgcpAvgDialToneDelay(msec)
This graph displays the average MGCP dial tone delay time (in milliseconds).

ASMgcpMaxDialToneDelay(msec)
This graph displays the largest dial tone delay time (in milliseconds).

ASMgcpAvgCallSetupDelay(msec)
This graph displays the average MGCP call setup delay time (in milliseconds).

ASMgcpMaxCallSetupDelay
This graph displays the largest MGCP call setup delay time (in milliseconds).
(msec)

ASMgcpAvgAnswerDelay(msec)
This graph displays the average MGCP answer delay time (in milliseconds).

ASMgcpMaxAnswerdelay(msec)
This graph displays the largest MGCP answer delay time (in milliseconds).

ASSysIntQueueTimeAvgCallHalf(1000usec)T1
This graph displays the average call processing queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxCallHalf(msec)T1
This graph displays the largest call processing queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgMGCPEncodeQ(1000usec)
This graph displays the average MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxMGCPEncodeQ(msec)
This graph displays the largest MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeAvgCallHalf(1000usec)T2
This graph displays the average call processing queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxCallHalf(msec)T2
This graph displays the largest call processing queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgMGCPDecodeQ(1000usec)
This graph displays the average MGCP decode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxMGCPDecodeQ(1000usec)
This graph displays the largest MGCP decode queue delay time (in
milliseconds).

ASCapMsgPerSecond This graph displays the number of Client Application Protocol (CAP) messages
handled (per second).

ASNbOfMigratedUsers This graph displays the number of users migrated to the secondary Application
Server.

CPUUtilization This graph displays the CPU (system + user) utilization.

MemoryUtilization This graph displays the memory utilization.

hrStorageType_RAM This graph displays the memory type.

hrStorageUsed_RAM This graph displays the memory used.

hrStorageAllocationUnits_RAM
This graph displays the memory allocation unit.

hrStorageSize_RAM This graph displays the memory size.

Device_INTERFACE_out_octets
This graph displays the number of octets sent over the network.

Device_INTERFACE_in_octets
This graph displays the number of octets received over the network.

ReceiveErrors This graph displays the number of packets received in error.

TransmitErrors This graph displays the number of packets transmitted in error.

InDiscards This graph displays the number of incoming packets discarded.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 102
 Input Box Description

OutDiscards This graph displays the number of outgoing packets discarded.

InterfaceOutUtilization This graph displays the percentage of the interface utilization in output.

InterfaceInUtilization This graph displays the percentage of the interface utilization in input.

ASSysIntQueueTimeAvgSIPEncodeQ(1000usec)T1
This graph displays the average SIP encode queue delay time (in milliseconds).

ASSysIntQueueTimeMaxSIPEncodeQ(msec)T1
This graph displays the largest SIP encode queue delay time (in milliseconds).

ASSysIntQueueTimeAvgSIPCallDecodeQ(1000usec)T1
This graph displays the average SIP call decode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxSIPCallDecodeQ(msec)T1
This graph displays the largest SIP call decode queue delay time (in
milliseconds).

ASSysIntQueueTimeAvgMGCPEncodeQ(1000usec)T1
This graph displays the average MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxMGCPEncodeQ(msec)T1
This graph displays the largest MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeAvgVoiceMailInAdapt(1000usec)T1
This graph displays the average voice mail queue delay time (in milliseconds).

ASSysIntQueueTimeMaxVoiceMailInAdapt(msec)T1
This graph displays the largest voice mail queue delay time (in milliseconds).

ASSysIntQueueTimeAvgRegAdapt(1000usec)T1
This graph displays the average registration queue delay time (in milliseconds).

ASSysIntQueueTimeMaxRegAdapt(msec)T1
This graph displays the largest registration queue delay time (in milliseconds).

NSCallpCallsPerSecond This graph displays the number of calls (per second).

NSSipStatsInviteIns This graph displays the number of SIP invites.

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)T1
This graph displays the average SIP redirect queue delay time (in
milliseconds).

NSSipMsgPerSecond This graph displays the number of SIP messages (per second).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)
This graph displays the average SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipDecodeQ(1000usec)
This graph displays the largest SIP decode queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)
This graph displays the average SIP redirect queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipEncodeQ(msec)
This graph displays the largest SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipDecodeQ(msec)
This graph displays the largest SIP decode queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)
This graph displays the largest SIP redirect queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)T2
This graph displays the average SIP redirect queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)T1
This graph displays the largest SIP redirect queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)T2
This graph displays the largest SIP redirect queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)T1
This graph displays the average SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)T2
This graph displays the average SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipEncodeQ(msec)T2
This graph displays the largest SIP encode queue delay time (in milliseconds).

Alarm Status

Status This column displays the status of the alarm. Values include: Critical, Major,
Minor, Warning, Info, and Clear.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 103
 Input Box Description

Source – Alarm Name This column displays the name of the alarm or the category of the alarm. For
or Category more information, see the BroadWorks Fault and Alarm Interface Specification.

Date/Time This column displays the date and time the alarm was issued.

Alarm Details This column displays the alarm description. It is also a link to the details of the
alarm on the Fault tab. For more information, see View Alarm Properties on
page 186.

4.2.2.2.2 Edit Node Properties

1) From the Node Properties page, click Edit on the section to edit.
2) Modify the properties.
3) Click Update Object to save the changes or click Reset to reset the values to the previous settings.
4) Repeat steps 1 through 3 for each section that requires modification.
4.2.2.2.3 View Routing Tables of Node
Use the Routing Table page to view the routing table for a node.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 104
 Figure 42: Routing Table

The information on this page includes the following:

Column Description

ipRouteDest This column displays the IP route destination.

ipRouteNextHop This column displays the IP route next hop.

To display the routing table for a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 105
 1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "Routing Table" from the Snmp-Node drop-down list. The
Routing Table page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

4.2.2.2.4 View Interfaces of Node

Use the Interfaces page to view the interfaces table for a node.

Figure 43: Interfaces

The information on this page includes the following:

Column Description

ifIndex This column displays the index of the interface.

ifDescr This column displays the description of the interface.

ifType This column displays the type of the interface.

ifSpeed This column displays the speed of the interface.

ifPhysAddress This column displays the physical address of the interface.

ifAdminStatus This column displays the administration status of the interface.

ifOperStatus This column displays the operational status of the interface.

ifInOctets This column displays the number of input octets to the interface.

ifOutOctets This column displays the number of output octets from the interface.

ifOutDiscards This column displays the number of output discards from the interface.

To display the interfaces of a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 106
 3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "Interfaces" from the Snmp-Node drop-down list. The Interfaces
page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

4.2.2.2.5 View TCP Table

Use the TCP Table page to view the TCP table for a node.

Figure 44: TCP Table

The information on this page includes the following:

Column Description

tcpConnState This column displays the TCP connection state.

tcpConnLocalAddress This column displays the local address of the TCP connection.

tcpConnLocalPort This column displays the local port of the TCP connection.

tcpConnRemAddress This column displays the remote address of the TCP connection.

tcpConnRemPort This column displays the remote port of the TCP connection.

To display the Transmission Control Protocols for a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "TCP Table" from the Snmp-Node drop-down list. The TCP
Table page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 107
 NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

4.2.2.2.6 View UDP Table

Use the UDP Table page to view the UDP tables for a node.

Figure 45: UDP Table

The information on this page includes the following:

Column Description

udpLocalAddress This column displays the local UDP address.

udpLocalPort This column displays the local UDP port.

To display the User Datagram Protocols for a node:

1) Access a node:
• To access a node from the Maps tab:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 108
 1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "UDP Table" from the Snmp-Node drop-down list. The UDP
Table page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

4.2.2.2.7 View IP Net to Media Table

Use the IPNetToMediaTable page to view the IPNet to Media table for a node.

Figure 46: IPNet to Media Table

The information on this page includes the following:

Column Description

ipNetToMedialfIndex This column displays the index of the IPNet to Media.

ipNetToMediaPhysAddress This column displays the physical address of the IPNet to Media.

ipNetToMediaNetAddress This column displays the network address of the IPNet to Media.

ipNetToMediaType This column displays the type of IPNet to Media.

To display the IPNet to Media table for a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 109
 • To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "IPNetToMedia Table" from the Snmp-Node drop-down list. The
IPNetToMediaTable page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

4.2.2.2.8 Refresh this Node

Use the Refresh Node page to view the results of a refreshed node (server).

Figure 47: Refresh Node Results

To refresh a node from the Maps tab:

1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the BroadWorks
cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties page
appears.
4) From the Node Properties page, select "Refresh Node" from the Snmp-Node drop-down list. The
Refresh Node page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode".

5) Click Refresh. The results of the refresh appear.

To refresh a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
4) From the Node Properties page, select "Refresh Node" from the Snmp-Node drop-down list. The
Refresh Node page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 110
 NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode".

5) Click Refresh. The results of the refresh appear.

4.2.2.3 View Group Properties

Figure 48: Group Properties

To view the properties of a group:

From a list page, click the link of the group to view. The Group Properties page appears.
To manage this group:
1) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
2) Click Manage.
To "unmanage" this group:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 111
 1) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".
2) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
To view the events for this group:
1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related events.
2) Click View Events. The Events page displays the list of events related to the selected managed object.

NOTE: If there have not been any events triggered for the selected managed object, the page displays
a message indicating that there is no data to display.

To view the alarms for this group:

1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related alarms.
2) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

For more information

4.2.2.3.1 Group Property Reference
Input Box Description

General Information

Device Type This text box displays the device type of the group.

Is Managed? This option controls whether the group is managed or "unmanaged". When a managed object is
"unmanaged", status polling and data collection stops. Therefore, threshold calculation is not done.
Traps for the node continue to be processed. To disable the processing of traps, see Configure
Fault Management Parameters on page 303.

Status This text box displays the overall alarm status of the group. The highest alarm severity level
associated with the group is displayed.

Display Name This text box displays the managed object's name that is used on the web interface.

Status Monitoring Details

Is Status polling enabled? This option controls status polling on the group. If the value is set to "yes", the status of the group
(alarms and events) is available through the web interface. If the value is set to "false", the status is
not available.

Last Status Update Time This text box displays the time stamp of the last time the group was polled for its status.

User Class Name This text box specifies the class to be invoked for status polling. Set this parameter only if the
selected value of the Tester for Status Polling parameter is "User Test".

Failure Count This text box displays the number of times consecutive status poll attempts for this object have
failed. The count is reset to "0" once the object is declared as failed or when the object recovers
after the failure. When the value of "Failure Count" equals that of "Failure Threshold", the object is
declared failed.

Tester for Status Polling This drop-down list provides the ability to select the action to be performed on status polling for the
managed object. If the value "User Test" is used, the User Class Name parameter should be set
with the name of the user tester class.

Last Status Change Time This text box displays the time stamp of the last time the status of the group was changed.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 112
 Input Box Description

Failure Threshold This input box specifies the number of consecutive failed status poll attempts, to declare the object
as failed. A status change event for the object is generated when the status polling for the object
fails for "Failure Threshold" times.

Status Polling Interval This text box specifies the interval between status polling attempts for this group.

Logical & Hierarchical Relationship Details

Parent Object This text box specifies the parent of the managed object.

Is Container? This text box specifies whether the managed object is a container.

Group Members This drop-down list identifies the managed nodes that are members of the group.

List of Groups This drop-down list identifies the names of the groups to which the object belongs.

Is Group? This text box specifies whether the managed object is a group.

CPU Utilization This option is not available for group.

Memory Utilization This option is not available for group.

Disk Utilization This option is not available for group.

Other Graphs

CPUBusyGroup This graph displays the amount of utilization of busy CPU in the group.

4.2.2.3.2 Edit Group Properties

1) From the Group Properties page, click Edit on the section to edit.
2) Modify the properties.
3) Click Update Object to save the changes or click Reset to reset the values to the previous settings.
4) Repeat steps 1 through 3 for each section that requires modification.

4.2.2.4 View Interface Properties

Use the Interface Properties page to display the properties of an interface.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 113
BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00
©2014 BROADSOFT, INC. PAGE 114
BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00
©2014 BROADSOFT, INC. PAGE 115
 Figure 49: Interface Properties

To view the properties of an interface:

From a list page, click the link of the interface to view. The Interface Properties page appears.
To manage an interface:
1) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
2) Click Manage.
To "unmanage" an interface:
1) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".
2) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
To view events for an interface:
1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related events.
2) Click View Events. The Events page displays the list of events related to the selected managed object.

NOTE: If there have not been any events triggered for the selected managed object, the page displays
a message indicating that there is no data to display.

To view alarms for an interface:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 116
 1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related alarms.
2) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

For more information

4.2.2.4.1 Interface Properties Reference
Input Box Description

General Information

Device Type This text box displays the device type of the interface.

Is Managed? This option controls whether the interface is managed or "unmanaged". When an interface is
"unmanaged", status polling and data collection stops. Therefore, threshold calculation is not done.
Traps for the node interface continue to be processed. To disable the processing of traps, see
Configure Fault Management Parameters on page 303.

IP Address This text box specifies the IP address of the interface.

Is DHCP Enabled? This text box indicates whether Dynamic Host Configuration Protocol (DHCP) is enabled on the
interface.

Status This text box displays the overall alarm status of the interface. The highest alarm severity level
associated with the interface is displayed.

Display Name This input box displays the managed object's name (network, node, group, or interface) that is used
on the web interface.

Netmask This drop-down list specifies the network mask of the interface.

Status Monitoring Details

Is Status polling enabled? This option controls status polling on the node. If the value is set to "yes", the status of the node
(alarms and events) is available through the web interface. If the value is set to "false", the status is
not available.

Last Status Change Time This text box displays the time of the last change of status.

Last Status Update Time This text box displays the time stamp of the last time the node was polled for its status.

Failure Threshold This input box specifies the number of consecutive failed status poll attempts, to declare the object
as failed. A status change event for the object is generated when the status polling for the object fails
for "Failure Threshold" times.

Failure Count This text box displays the number of times consecutive status poll attempts for this object have
failed. The count is reset to "0" once the object is declared as failed or when the object recovers
after the failure. When the value of "Failure Count" equals that of "Failure Threshold", the object is
declared failed.

Tester for Status Polling This drop-down list provides the ability to select the action to be performed on status polling for the
managed object (network, node, group, or interface). When the selected value is "Max", the status
of the interface is propagated to the managed node. If the value "User Test" is used, the User Class
Name parameter should be set with the name of the user tester class.

User Class Name This input box specifies the class to be invoked for status polling. Set this parameter only if the
selected value of the Tester for Status Polling parameter is "User Test".

Status Polling Interval This input box specifies the interval between status polling attempts for this group.

Parent Node & Parent Networks

Parent Networks This text box specifies the parent of the managed object (network, node, group, or interface).

Parent Object This text box specifies the parent of the managed object.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 117
 Input Box Description

Is Container? This text box specifies whether the managed object is a container.

Parent Node This text box displays the IP address(es) of the parent node.

List of Groups This drop-down list identifies the names of the groups to which the node belongs.

Is Group? This text box specifies whether the managed object is a group.

Protocol Configuration Settings

SNMP Port This text box displays the SNMP port number the EMS uses to retrieve SNMP values from this
interface.

Read Community This text box displays the read community associated with this interface.

SNMP Version This text box displays the SNMP version running on this interface.

Physical Media This text box displays the physical media that the interface resides on.

Interface Speed This text box displays the speed of the interface.

System Object Identifier This text box displays the BroadWorks base object identifier (OID) for the interface.
(SysOID)

Host Netmask This text box displays the host netmask.

Base MIBs This text box displays the list of base Management Information Bases (MIBs) implemented by the
SNMP agent of the node.

Write Community This text box specifies the write community associated with this node.

Physical Address This text box displays the physical address of this interface.

Interface Descriptor This text box displays the (interface) descriptor of this interface.

SNMP index number for the This text box displays the SNMP index number for the physical interface.
physical interface (lfindex)

Graphs

Interface Traffic Details This graph displays the interface traffic details.

Interface Utilization Details This graph displays the interface utilization details.

Interface Error & Discard This graph displays the interface error and discard details.
Details

4.2.2.4.2 Edit Interface Properties

1) From the Interface Properties page, click Edit on the section to edit.
2) Modify the properties.
3) Click Update Object to save the changes or click Reset to reset the values to the previous settings.
4) Repeat steps 1 through 3 for each section that requires modification.

4.3 Managing Networks

Use the Networks page to list and manage the networks on your EMS network.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 118
 Figure 50: Networks

The information on this page includes the following:

Column Description

Name This column displays the name of the network.

Display Name This column displays the name of the network as it appears on the EMS.

MO Type This column displays the type of the network.

IP Address This column displays the IP address of the network.

Netmask This column displays the netmask of the network.

Status This column displays the status of the network. When the network is "unmanaged", this column
displays a gray icon "?". When the network is "managed", a red/yellow/green arrow icon is displayed.

Last Status Time Change This column displays the time stamp of the last status change of the network.

To display the network view of the inventory:

1) Click the Inventory tab.
2) Select the Networks menu. The Networks page appears.
3) To print this view of the inventory:
a) Click Print Version. A PDF view of the current list of the inventory appears in a new window.
b) From the File menu, click Print. The Print dialog box appears.
c) Select the printer and click Print.
d) Close the window.
4) To view the events for a network:
a) Click the check box for the managed object(s) (network, group, node, or interface) for which you
want to display the related events.
b) Click View Events. The Events page displays the list of events related to the selected managed
object.

NOTE: If there have not been any events triggered for the selected managed object, the page
displays a message indicating that there is no data to display.

5) To view the alarms for a network:

a) Click the check box for the managed object(s) (network, group, node, or interface) for which you
want to display the related alarms.
b) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

6) To manage a network:
a) Click the check box for the managed object(s) (network, group, node, or interface) to manage.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 119
 b) Click Manage.
7) To "unmanage" a network:
a) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".
b) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
Tasks to perform from this page

4.3.1 Add Child View of Networks

You can add/create a new view by specifying various criteria and providing a name for the view. The views
you create enable you to quickly monitor your networks. Multiple views can also be created to display a
variety of information. For example, you can create a new view named MasterNetworks, which shows only
those events in a particular network.
Use the Add Topology Child View page to add a child view of networks.

Figure 51: Add Topology Child View

The information on this page includes the following:

Input Box Description

Custom view name This text box defines the name of the child view.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 120
 Input Box Description

First drop-down list This drop-down list includes the properties available to define this view. These include:
• name: includes managed objects based on their names
• status: includes managed objects based on their status. Possible status values are: critical,
major, minor, warning, info, and clear.
• ipAddress: includes managed objects based on their IP addresses
• managed: includes managed objects depending on whether they are currently managed
• type: includes managed objects of a specific type (for example, bwserver-app, SnmpNode, and
so on)
• snmpport: includes managed objects by SNMP port
• version: includes managed objects by their version number
• isSNMP: includes managed objects depending on whether they run on SNMP
• statusPollEnabled: includes managed objects depending on whether they are enabled to poll for
status
• pollInterval: includes managed objects based on their polling interval
• statusUpdateTime: includes managed objects based on the time of status update
• statusChangeTime: includes managed objects based on the time of status change
• isDHCP: includes managed objects depending on whether they run on the Dynamic Host
Configuration Protocol (DHCP)
• isNode: includes managed objects depending on whether they are nodes
• isInterface: includes managed objects depending on whether they are interfaces
• isRouter: includes managed objects depending on whether they are routers
• isNetwork: includes managed objects depending on whether they are networks

Second drop-down list This drop-down list includes the Boolean statements available to define this view. These include:
• equals
• not equals
• starts with
• ends with
• contains
• does not contain

Text box This text box specifies the view criteria.

To add a child view from the network view of the inventory:

1) From any View page, (Complete View, Network View, Group View, Node View, Interface View), click
Add Child View. The Add Child View page for that view appears.
2) In the Custom view name text box, type the name of the child view. This input box is mandatory.
3) Select the property from the first drop-down list.
4) Select the Boolean statement from the second drop-down list.
5) In the text box, type the view criteria.
6) To add additional criteria, click More and repeat steps 2 through 4.

NOTE: To remove existing criteria, click Fewer.

7) To preview the results of this view, click Preview Results. The view appears.
8) To add this view to the Inventory menu, click Add Child View. This view appears on the Inventory
menu.
For more information

4.3.1.1 Edit Child View of Networks

Use the Edit Topology View Criteria - Networks page to modify the child view of networks.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 121
 Figure 52: Edit Topology View Criteria - Networks

To edit the view criteria of a child view from the networks' view of the inventory:
1) From any View page, (Complete View, Network View, Group View, Node View, Interface View), click
Edit View Criteria. The Edit Topology View Criteria page appears.
2) In the Custom view name text box, type the name of the child view. This input box is mandatory.
3) Select the property from the first drop-down list.
4) Select the Boolean statement from the second drop-down list.
5) In the text box, type the view criteria.
6) To add additional criteria, click More and repeat steps 3 through 5.

NOTE: To remove existing criteria, click Fewer.

7) To preview the results of this view, click Preview Results. The view appears.
8) To save the changes to this view, click Apply. This view appears on the Inventory menu.

4.3.1.2 Remove Child View of Networks

1) From a view page, click Remove View. A message asks for your confirmation.
2) To permanently remove this view, click OK. Click Cancel to return to the previous page.

NOTE: When a view is deleted, all of its child views are also removed.

4.3.1.3 Search
Use the Search page to search for alarms, events, or managed objects.

Figure 53: Advanced Search

To search:
1) From a view page, click Search and complete the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 122
 2) Select Match any of the Following to perform a search operation that satisfies any of the specified
matching criteria or select Match all of the Following to perform a search operation that satisfies all of
the specified matching criteria.
3) In the left-hand input box (Properties), select the property based on which you need to perform your
search. If you select the time property as a search criterion, the Date Input Helper icon appears. It can
help you quickly specify the time and date of interest.
4) In the middle input box (Condition), select the condition based on which you need to restrict your
search.
5) In the right-hand input box, type the exact information you are looking for. For example, if you have
selected severity in the Properties box, then you must specify the severity value here, such as "critical",
"major", and so on.
6) To specify additional criteria, click More and repeat steps 2 through 4. Fewer options can be used to
remove the criteria that were last added.
7) Click Search. Events satisfying the criteria appear.

4.3.1.4 Customize Columns of Child View

The properties are displayed as columns in the list view. You can add more columns or remove existing
columns in the events list view.
Use the Customize Columns page to customize the columns for a view of events, alarms, or managed
objects.

Figure 54: Customize Columns

To customize the columns of a view:

1) From a view page, click Customize Columns. The Customize Columns page appears.
2) To add new columns, select the property (based on which columns are created) from the Available
columns list and click the arrow pointing to the right. The property is moved to the Displayed columns.
Multiple properties can be selected using the CTRL+Click and SHIFT+Click options.
3) To remove existing columns, select the property from the Displayed columns list and click the arrow
pointing to the left. The property is moved to the Available columns list.
4) In the Displayed columns list, use the up and down arrows to order the columns in the view, from left to
right.
5) Click Apply. The list view is refreshed using your custom column arrangement.

4.3.2 View Network Properties

Use the Network Properties page to display the properties of a network.

NOTE: The buttons that appear on this page reflect the state of the network.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 123
 Figure 55: Network Properties

To view the properties of a network:

From a list page, click the link of the network to view. The Network Properties page appears.
To manage this network:
1) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
2) Click Manage.
To "unmanage" this network:
1) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 124
 2) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
To view the events for this network:
1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related events.
2) Click View Events. The Events page displays the list of events related to the selected managed object.

NOTE: If there have not been any events triggered for the selected managed object, the page displays
a message indicating that there is no data to display.

To view the alarms for this network:

1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related alarms.
2) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

To discover this network:

Click Start Discovery. The discovery process begins.

NOTE: Click Stop Discovery to interrupt the discovery process.

To "undiscover" this network:

Click Undiscover. The network is no longer present on the EMS network.
For more information

4.3.2.1 Network Property Reference

Input Box Description

General Information

Device Type This text box displays the device type of the node, group, or interface.

Is Managed? This option controls whether the node, group, or interface is managed or "unmanaged". When
a node, group, or interface is "unmanaged", status polling and data collection stops. Therefore,
threshold calculation is not done. Traps for the node, group, or interface continue to be processed.
To disable the processing of traps, see the Configure Fault Management Parameters on page 303.

IP Address This text box specifies the IP address of the node, group, or interface.

Is DHCP Enabled? This text box displays whether Dynamic Host Configuration Protocol (DHCP) is enabled on the node,
group, or interface.

Status This option displays the overall alarm status of the node. The highest alarm severity level associated
with the node, group, or interface is displayed.

Display Name This input box displays the name of the node, group, or interface that is used on the web interface.

Netmask This drop-down list specifies the network mask of the node, group, or interface.

Status Monitoring Details

Is Status polling enabled? This option controls status polling on the node, group, or interface. If the value is set to "yes", the
status of the node, group, or interface (alarms and events) is available through the web interface. If
the value is set to "false", the status is not available.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 125
 Input Box Description

Last Status Update Time This text box displays the time stamp of the last time the node, group, or interface was polled for its
status.

User Class Name This text box specifies the class to be invoked for status polling. Set this parameter only if the
selected value of the Tester for Status Polling parameter is "User Test".

Failure Count This text box displays the number of times the EMS has failed to poll the node, group, or interface.

Tester for Status Polling This drop-down list provides the ability to select the action to be performed on status polling for the
node, group, or interface. When the selected value is "Max", the status of the interface is propagated
to the node. If the value "User Test" is used, the User Class Name parameter should be set with the
name of the user tester class.

Last Status Change Time This text box displays the time stamp of the last time the status of the node was changed.

Failure Threshold This text box displays the maximum number of occurrences of a failure before an alarm threshold is
reached.

Status Polling Interval This text box indicates the frequency that the node is polled for its status (in seconds).

Discovery Settings

Discover Status This text box displays the status of Discovery on the network.

Start/Resume Discovery This text box appears if the discovery command is currently available for this network.

Nodes & Interfaces Details

List of Nodes This text box displays the list of discovered nodes on this network.

Sub Networks This text box displays the subnetworks included on this network.

Parent Netmask This text box displays the parent netmask for this network.

List of Interfaces This text box displays the list of interfaces on this network.

Sub Netmasks This text box displays the subnetmasks included on this network.

Parent Network This text box displays the parent network on this network.

Group

CPU Utilization This text box displays the Central Processing Unit (CPU) utilization of this network at the time of the
last polling.

Memory Utilization This text box displays the current memory utilization of the network at the time of the last polling.

Disk Utilization This text box displays the current disk utilization of the network at the time of the last polling.

Alarm Status

Status This column displays the status of the alarm. Values include: Critical, Major, Minor, Warning, Info,
and Clear.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 126
 Input Box Description

Source – Alarm Name or This column displays the name of the alarm or the category of the alarm. For more information, see
Category the BroadWorks Fault and Alarm Interface Specification.

Date/Time This column displays the date and time the alarm was issued.

Alarm Details This column displays a link to the details of the alarm on the Fault tab. For more information on
alarms, see the Overview of Alarms on page 180.

4.3.2.2 Edit Network Properties

1) From the Network Properties page, click Edit on the section to edit.
2) Modify the properties.
3) Click Update Object to save the changes or click Reset to reset the values to the previous settings.
4) Repeat steps 1 through 3 for each section that requires modification.

4.4 Managing Groups

Use the Groups page to list and manage the groups on your EMS network.

Figure 56: Groups

The information on this page includes the following:

Column Description

Name This column displays the name of the group.

Display Name This column displays the name of the group as it is displayed on the EMS.

MO Type This column displays the type of the group.

Status This column displays the status of the group. When the group is "unmanaged", this column displays
a gray icon "?". When the group is "managed", a red/yellow/green arrow icon is displayed.

Last Status Time Change This column displays the time stamp of the last status change of the group.

To display the group view of the inventory:

1) Click the Inventory tab.
2) Select the Groups menu. The Groups page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 127
 3) To print this view of the inventory:
a) Click Print Version. A PDF view of the current list of the inventory appears in a new window.
b) From the File menu, click Print. The Print dialog box appears.
c) Select the printer and click Print.
d) Close the window.
4) To view the events for a group:
a) Click the check box for the managed object(s) (network, group, node, or interface) for which you
want to display the related events.
b) Click View Events. The Events page displays the list of events related to the selected managed
object.

NOTE: If there have not been any events triggered for the selected managed object, the page
displays a message indicating that there is no data to display.

5) To view the alarms for a group:

a) Click the check box for the managed object(s) (network, group, node, or interface) for which you
want to display the related alarms.
b) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

6) To manage a group:
a) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
b) Click Manage.
7) To "unmanage" a group:
a) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".
b) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
Tasks to perform from this page

4.4.1 Add Child View of Groups

You can add/create a new view by specifying various criteria and providing a name for the view. The views
you create enable you to quickly monitor your groups. Multiple views can also be created to display a
variety of information. For example, you can create a new view named MasterCritical, which shows only
those critical alarms on a particular group.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 128
 Figure 57: Groups

The information on this page includes the following:

Input Box Description

Custom view name This input box defines the name of the child view.

First drop-down list This drop-down list includes the properties available to define this view. These include:
• name: includes managed objects based on their names
• status: includes managed objects based on their status. Possible status values are: critical,
major, minor, warning, info, and clear.
• ipAddress: includes managed objects based on their IP addresses
• managed: includes managed objects depending on whether they are currently managed
• type: includes managed objects of a specific type (for example, bwserver-app, SnmpNode, and
so on).
• snmpport: includes managed objects by SNMP port
• version: includes managed objects by their version number
• isSNMP: includes managed objects depending on whether they run on SNMP
• statusPollEnabled: includes managed objects depending on whether they are enabled to poll for
status
• pollInterval: includes managed objects based on their polling interval
• statusUpdateTime: includes managed objects based on the time of status update
• statusChangeTime: includes managed objects based on the time of status change
• isDHCP: includes managed objects depending on whether they run on the Dynamic Host
Configuration Protocol (DHCP)
• isNode: includes managed objects depending on whether they are nodes
• isInterface: includes managed objects depending on whether they are interfaces
• isRouter: includes managed objects depending on whether they are routers
• isNetwork: includes managed objects depending on whether they are networks

Second drop-down list This drop-down list includes the Boolean statements available to define this view. These include:
• equals
• not equals
• starts with
• ends with
• contains
• does not contain

Text box This text box specifies the view criteria.

To add a child view from the groups' view of the inventory:

1) From any View page, (Complete View, Network View, Group View, Node View, Interface View), click
Add Child View. The Add Child View page for that view appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 129
 2) In the Custom view name text box, type the name of the child view. This input box is mandatory.
3) Select the property from the first drop-down list.
4) Select the Boolean statement from the second drop-down list.
5) In the text box, type the view criteria.
6) To add additional criteria, click More and repeat steps 2 through 4.

NOTE: To remove existing criteria, click Fewer.

7) To preview the results of this view, click Preview Results. The view appears.
8) To add this view to the Inventory menu, click Add Child View. This view appears on the Inventory
menu.
For more information

4.4.1.1 Edit Child View of Groups

Use the Edit Topology View Criteria - Groups page to modify the child view of groups.

Figure 58: Edit Topology View Criteria - Groups

To edit the view criteria of a child view from the groups' view of the inventory:
1) From any View page, (Complete View, Network View, Group View, Node View, Interface View), click
Edit View Criteria. The Edit Topology View Criteria page appears.
2) In the Custom view name text box, type the name of the child view. This input box is mandatory.
3) Select the property from the first drop-down list.
4) Select the Boolean statement from the second drop-down list.
5) In the text box, type the view criteria.
6) To add additional criteria, click More and repeat steps 3 through 5.

NOTE: To remove existing criteria, click Fewer.

7) To preview the results of this view, click Preview Results. The view appears.
8) To save the changes to this view, click Apply. This view appears on the Inventory menu.

4.4.1.2 Remove Child View of Groups

1) From a view page, click Remove View. A message asks for your confirmation.
2) To permanently remove this view, click OK. Click Cancel to return to the previous page.

NOTE: When a view is deleted, all of its child views are also removed.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 130
4.4.1.3 Search
Use the Search page to search for alarms, events, or managed objects.

Figure 59: Advanced Search

To search:
1) From a view page, click Search and complete the following:
2) Select Match any of the Following to perform a search operation that satisfies any of the specified
matching criteria or select Match all of the Following to perform a search operation that satisfies all of
the specified matching criteria.
3) In the left-hand input box (Properties), select the property based on which you need to perform your
search. If you select the time property as a search criterion, the Date Input Helper icon appears. It can
help you quickly specify the time and date of interest.
4) In the middle input box (Condition), select the condition based on which you need to restrict your
search.
5) In the right-hand input box, type the exact information you are looking for. For example, if you have
selected severity in the Properties box, then you must specify the severity value here, such as "critical",
"major", and so on.
6) To specify additional criteria, click More and repeat steps 2 through 4. Fewer options can be used to
remove the criteria that were last added.
7) Click Search. Events satisfying the criteria appear.

4.4.1.4 Customize Columns of Child View

The properties are displayed as columns in the list view. You can add more columns or remove existing
columns in the events list view.
Use the Customize Columns page to customize the columns for a view of events, alarms, or managed
objects.

Figure 60: Customize Columns

To customize the columns of a view:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 131
 1) From a view page, click Customize Columns. The Customize Columns page appears.
2) To add new columns, select the property (based on which columns are created) from the Available
columns list and click the arrow pointing to the right. The property is moved to the Displayed columns.
Multiple properties can be selected using the CTRL+Click and SHIFT+Click options.
3) To remove existing columns, select the property from the Displayed columns list and click the arrow
pointing to the left. The property is moved to the Available columns list.
4) In the Displayed columns list, use the up and down arrows to order the columns in the view, from left to
right.
5) Click Apply. The list view is refreshed using your custom column arrangement.

4.4.2 View Group Properties

Figure 61: Group Properties

To view the properties of a group:

From a list page, click the link of the group to view. The Group Properties page appears.
To manage this group:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 132
 1) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
2) Click Manage.
To "unmanage" this group:
1) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".
2) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
To view the events for this group:
1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related events.
2) Click View Events. The Events page displays the list of events related to the selected managed object.

NOTE: If there have not been any events triggered for the selected managed object, the page displays
a message indicating that there is no data to display.

To view the alarms for this group:

1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related alarms.
2) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

For more information

4.4.2.1 Group Property Reference

Input Box Description

General Information

Device Type This text box displays the device type of the group.

Is Managed? This option controls whether the group is managed or "unmanaged". When a managed object is
"unmanaged", status polling and data collection stops. Therefore, threshold calculation is not done.
Traps for the node continue to be processed. To disable the processing of traps, see Configure
Fault Management Parameters on page 303.

Status This text box displays the overall alarm status of the group. The highest alarm severity level
associated with the group is displayed.

Display Name This text box displays the managed object's name that is used on the web interface.

Status Monitoring Details

Is Status polling enabled? This option controls status polling on the group. If the value is set to "yes", the status of the group
(alarms and events) is available through the web interface. If the value is set to "false", the status is
not available.

Last Status Update Time This text box displays the time stamp of the last time the group was polled for its status.

User Class Name This text box specifies the class to be invoked for status polling. Set this parameter only if the
selected value of the Tester for Status Polling parameter is "User Test".

Failure Count This text box displays the number of times consecutive status poll attempts for this object have
failed. The count is reset to "0" once the object is declared as failed or when the object recovers
after the failure. When the value of "Failure Count" equals that of "Failure Threshold", the object is
declared failed.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 133
 Input Box Description

Tester for Status Polling This drop-down list provides the ability to select the action to be performed on status polling for the
managed object. If the value "User Test" is used, the User Class Name parameter should be set
with the name of the user tester class.

Last Status Change Time This text box displays the time stamp of the last time the status of the group was changed.

Failure Threshold This input box specifies the number of consecutive failed status poll attempts, to declare the object
as failed. A status change event for the object is generated when the status polling for the object
fails for "Failure Threshold" times.

Status Polling Interval This text box specifies the interval between status polling attempts for this group.

Logical & Hierarchical Relationship Details

Parent Object This text box specifies the parent of the managed object.

Is Container? This text box specifies whether the managed object is a container.

Group Members This drop-down list identifies the managed nodes that are members of the group.

List of Groups This drop-down list identifies the names of the groups to which the object belongs.

Is Group? This text box specifies whether the managed object is a group.

CPU Utilization This option is not available for group.

Memory Utilization This option is not available for group.

Disk Utilization This option is not available for group.

Other Graphs

CPUBusyGroup This graph displays the amount of utilization of busy CPU in the group.

4.4.2.2 Edit Group Properties

1) From the Group Properties page, click Edit on the section to edit.
2) Modify the properties.
3) Click Update Object to save the changes or click Reset to reset the values to the previous settings.
4) Repeat steps 1 through 3 for each section that requires modification.

4.5 Managing Nodes

Use the Nodes page to list and manage the nodes on your EMS network.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 134
 Figure 62: Nodes

The information on this page includes the following:

Column Description

Name This column displays the name of the node.

Display Name This column displays the name of the node as it is displayed on the EMS.

BW Type This column displays the type of BroadWorks node.

MO Type This column displays the type of the node.

IP Address This column displays the IP address of the node.

Netmask This column displays the netmask of the node.

Is SNMP? This column displays whether the node is SNMP.

Status This column displays the status of the node. When the node is "unmanaged", this column displays a
gray icon "?". When the node is "managed", a red/yellow/green arrow icon is displayed.

Last Status Time Change This column displays the time stamp of the last status change of the node.

To display the node view of the inventory:

1) Click the Inventory tab.
2) Select the Nodes menu item. The Nodes page appears.
3) To print this view of the inventory:
a) Click Print Version. A PDF view of the current list of the inventory appears in a new window.
b) From the File menu, click Print. The Print dialog box appears.
c) Select the printer and click Print.
d) Close the window.
4) To view the events for a node:
a) Click the check box for the managed object(s) (network, group, node, or interface) for which you
want to display the related events.
b) Click View Events. The Events page displays the list of events related to the selected managed
object.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 135
 NOTE: If there have not been any events triggered for the selected managed object, the page
displays a message indicating that there is no data to display.

5) To view the alarms for a node:

a) Click the check box for the managed object(s) (network, group, node, or interface) for which you
want to display the related alarms.
b) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

6) To manage a node:
a) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
b) Click Manage.
7) To "unmanage" a node:
a) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".
b) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
Tasks to perform from this page

4.5.1 Add Child View of Nodes

You can add/create a new view by specifying various criteria and providing a name for the view. The
views you create enable you to quickly monitor your nodes. Multiple views can also be created to display
a variety of information. For example, you can create a new view named MasterAlarms, which shows only
those alarms on a particular node.
Use the Add Topology Child View page to add a child view of nodes.

Figure 63: Add Topology Child View

The information on this page includes the following:

Input Box Description

Custom view name This input box defines the name of the child view.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 136
 Input Box Description

First drop-down list This drop-down list includes the properties available to define this view. These include:
• name: includes managed objects based on their names
• status: includes managed objects based on their status. Possible status values are: critical,
major, minor, warning, info, and clear.
• ipAddress: includes managed objects based on their IP addresses
• managed: includes managed objects depending on whether they are currently managed
• type: includes managed objects of a specific type (for example, bwserver-app, SnmpNode, and
so on).
• snmpport: includes managed objects by SNMP port
• version: includes managed objects by their version number
• isSNMP: includes managed objects depending on whether they run on SNMP
• statusPollEnabled: includes managed objects depending on whether they are enabled to poll for
status
• pollInterval: includes managed objects based on their polling interval
• statusUpdateTime: includes managed objects based on the time of status update
• statusChangeTime: includes managed objects based on the time of status change
• isDHCP: includes managed objects depending on whether they run on the Dynamic Host
Configuration Protocol (DHCP)
• isNode: includes managed objects depending on whether they are nodes
• isInterface: includes managed objects depending on whether they are interfaces
• isRouter: includes managed objects depending on whether they are routers
• isNetwork: includes managed objects depending on whether they are networks

Second drop-down list This drop-down list includes the Boolean statements available to define this view. These include:
• equals
• not equals
• starts with
• ends with
• contains
• does not contain

Text box This text box specifies the view criteria.

To add a child view from the nodes view of the inventory:

1) From any View page, (Complete View, Network View, Group View, Node View, Interface View), click
Add Child View. The Add Child View page for that view appears.
2) In the Custom view name text box, type the name of the child view. This input box is mandatory.
3) Select the property from the first drop-down list.
4) Select the Boolean statement from the second drop-down list.
5) In the text box, type the view criteria.
6) To add additional criteria, click More and repeat steps 2 through 4.

NOTE: To remove existing criteria, click Fewer.

7) To preview the results of this view, click Preview Results. The view appears.
8) To add this view to the Inventory menu, click Add Child View. This view appears on the Inventory
menu.
For more information

4.5.1.1 Edit Child View of Nodes

Use the Edit Topology View Criteria - Nodes page to modify the child view of nodes.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 137
 Figure 64: Edit Topology View Criteria - Nodes

To edit the view criteria of a child view from the nodes view of the inventory:
1) From any View page, (Complete View, Network View, Group View, Node View, Interface View), click
Edit View Criteria. The Edit Topology View Criteria page appears.
2) In the Custom view name text box, type the name of the child view. This input box is mandatory.
3) Select the property from the first drop-down list.
4) Select the Boolean statement from the second drop-down list.
5) In the text box, type the view criteria.
6) To add additional criteria, click More and repeat steps 3 through 5.

NOTE: To remove existing criteria, click Fewer.

7) To preview the results of this view, click Preview Results. The view appears.
8) To save the changes to this view, click Apply. This view appears on the Inventory menu.

4.5.1.2 Remove Child View of Nodes

1) From a view page, click Remove View. A message asks for your confirmation.
2) To permanently remove this view, click OK. Click Cancel to return to the previous page.

NOTE: When a view is deleted, all of its child views are also removed.

4.5.1.3 Search
Use the Search page to search for alarms, events, or managed objects.

Figure 65: Advanced Search

To search:
1) From a view page, click Search and complete the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 138
 2) Select Match any of the Following to perform a search operation that satisfies any of the specified
matching criteria or select Match all of the Following to perform a search operation that satisfies all of
the specified matching criteria.
3) In the left-hand input box (Properties), select the property based on which you need to perform your
search. If you select the time property as a search criterion, the Date Input Helper icon appears. It can
help you quickly specify the time and date of interest.
4) In the middle input box (Condition), select the condition based on which you need to restrict your
search.
5) In the right-hand input box, type the exact information you are looking for. For example, if you have
selected severity in the Properties box, then you must specify the severity value here, such as "critical",
"major", and so on.
6) To specify additional criteria, click More and repeat steps 2 through 4. Fewer options can be used to
remove the criteria that were last added.
7) Click Search. Events satisfying the criteria appear.

4.5.1.4 Customize Columns of Child View

The properties are displayed as columns in the list view. You can add more columns or remove existing
columns in the events list view.
Use the Customize Columns page to customize the columns for a view of events, alarms, or managed
objects.

Figure 66: Customize Columns

To customize the columns of a view:

1) From a view page, click Customize Columns. The Customize Columns page appears.
2) To add new columns, select the property (based on which columns are created) from the Available
columns list and click the arrow pointing to the right. The property is moved to the Displayed columns.
Multiple properties can be selected using the CTRL+Click and SHIFT+Click options.
3) To remove existing columns, select the property from the Displayed columns list and click the arrow
pointing to the left. The property is moved to the Available columns list.
4) In the Displayed columns list, use the up and down arrows to order the columns in the view, from left to
right.
5) Click Apply. The list view is refreshed using your custom column arrangement.

4.5.2 View Node Properties

Use the Node Properties page to display the properties of a node.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 139
BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00
©2014 BROADSOFT, INC. PAGE 140
 Figure 67: Node Properties

To view the properties of a node:

From a list page, click the link of the node to view. The Node Properties page appears.
To "unmanage" a node:
1) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 141
 2) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
To manage a node:
1) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
2) Click Manage.
To view the events for a node:
1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related events.
2) Click View Events. The Events page displays the list of events related to the selected managed object.

NOTE: If there have not been any events triggered for the selected managed object, the page displays
a message indicating that there is no data to display.

To view the alarms for a node:

1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related alarms.
2) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

For more information

4.5.2.1 Node Property Reference

Input Box Description

General Information

Device Type This text box displays the device type of the node.

Is Managed? This option controls whether the node is managed or "unmanaged". When
a managed object is "unmanaged", status polling and data collection stops.
Therefore, threshold calculation is not done. Traps for the node continue to
be processed. To disable the processing of traps, see the Configure Fault
Management Parameters on page 303.

IP Address This text box specifies the IP address of the node.

Is DHCP Enabled? This text box indicates whether Dynamic Host Configuration Protocol (DHCP) is
enabled on the node.

Status This text box displays the overall alarm status of the node. The highest alarm
severity level associated with the node is displayed.

Display Name This input box displays the managed object's name that is used on the web
interface.

Netmask This drop-down list specifies the network mask of the node.

User Properties Details

UnamePlatform This text box displays the platform type of the node. This value corresponds to
the result of the command uname -i when it is run on the node.

SnmpAgentUnreachable This text box indicates whether the SNMP agent of the node is unreachable.

ConfiguredMemory This text box displays the amount of memory available on the node.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 142
 Input Box Description

Threshold Name(s) This text box lists the threshold names that apply to the node when computing
(Multiplicator) performance.

bwName-NodeId This text box displays the name of the nodes clustered together with the node
ID within the cluster.

bwIpForWeb This text box displays the IP address to be used to access the web interface of
the node.

bwIsPrimary This text box indicates whether the node is the primary server of the cluster.

bw.config.requiresRestart This is an internal BroadWorks text box.

bw.config.interfaces This is an internal BroadWorks text box.

bwNsSeed This text box displays the IP address of the Network Server seed that was used
to discover the node. When a node is added manually, BW-Other is displayed.

bwManuallyAdded This text box indicates whether the node was manually added through "Add
Node" or discovered through a Network Server seed.

Server Type This text box displays the type of server. Valid values include: Application
Server (AS), Network Server (NS), Media Server (MS), Xtended Services
Platform (XSP), Profile Server (PS), Web Server (WS), Execution Server
(XS), Call Detail Server (CDS), Access Mediation Server (AMS), Conferencing
Server (CS), and Database Server (DBS).

bw.config.memorySize This is an internal BroadWorks text box.

bwPlatformName This text box displays the name of the hardware platform. It is taken from the
product name available from the command dmidecode (available on x86_64
server only).

bwPlatformType This text box displays the platform type from a performance point of view.

Processor This text box displays the processor architecture of the node.

Operating System This text box displays the operating system running on the node.

BW Version This text box displays the version of BroadWorks running on the node.

bw.config.managementMode
This is an internal BroadWorks text box.

bw.config.currentSchema This is an internal BroadWorks text box.

Modifier Factor(s) This text box displays the modifier factor used by the performance module to
compute the statistics and threshold for the node.

bw.config.schemaVersionThis is an internal BroadWorks text box.

BroadWorksServer This text box indicates whether the node is a BroadWorks Server. If the value is
"true", the node is a BroadWorks Server. If the value is "false", it is not.

bw.config.currentVersion This is an internal BroadWorks text box

SWManager version This text box displays the version of the Software Manager running on the
node.

NodeDesc This text box describes the node within the cluster context.

NumberOfCores This text box specifies the number of cores available on the node.

Status Monitoring Details

Is Status polling This option controls status polling on the node. If the value is set to "yes", the
enabled? status of the node (alarms and events) is available through the web interface. If
the value is set to "false", the status is not available.

Last Status Change This text box displays the time of the last change of status.
Time

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 143
 Input Box Description

Last Status Update This text box displays the time stamp of the last time the node was polled for its
Time status.

Failure Threshold This input box specifies the number of consecutive failed status poll attempts to
declare the object as failed. A status change event for the object is generated
when the status polling for the object fails for "Failure Threshold" times.

Failure Count This text box displays the number of times consecutive status poll attempts for
this object have failed. The count is reset to "0" once the object is declared as
failed or when the object recovers after the failure. When the value of "Failure
Count" equals that of "Failure Threshold", the object is declared failed.

Tester for Status This drop-down list provides the ability to select the action to be performed on
Polling status polling for the managed object. When the selected value is "Max", the
status of the interface is propagated to the managed node. If the value "User
Test" is used, the User Class Name parameter should be set with the name of
the user tester class.

User Class Name This input box specifies the class to be invoked for status polling. Set this
parameter only if the selected value of the Tester for Status Polling parameter
is "User Test".

Status Polling Interval This input box specifies the interval between status polling attempts for this
group.

Interfaces & Parent Networks

List of Interfaces This drop-down list displays the list of interfaces available on this node.

Parent Object This text box specifies the parent of the managed object.

Is Container? This text box specifies whether the managed object is a container.

Parent Networks This drop-down list displays the IP address of the parent network(s).

List of Groups This drop-down list identifies the names of the groups to which the node
belongs.

Is Group? This text box specifies whether the managed object is a group.

Protocol Configuration Settings

SNMP Port This text box displays the SNMP port number that the EMS uses to retrieve
SNMP values from this interface.

Read Community This text box displays the read community associated with this interface.

SNMP Version This text box displays the SNMP version running on this interface.

System Object This text box displays the node's sysOID MIB-II value.
Identifier (SysOID)

Host Netmask This text box displays the host netmask.

Base MIBs This text box displays the list of base Management Information Bases (MIBs)
implemented by the SNMP agent of the node.

Write Community This text box specifies the write community associated with this node.

System Description This text box displays the node's sysDescr MIB-II value.
(sysDescr)

Interfaces

Index This text box displays the hardware index of the interface.

Description This link navigates to the Property details of the interface.

Speed(bps) This text box displays the speed of the interface.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 144
 Input Box Description

Status This text box displays the overall alarm status of the interface. The highest
alarm severity level associated with the interface is displayed. Supported
values are: critical(1), major(2), minor(3), warning(4), clear(5).

MAC This text box displays the Media Access Control (MAC) address of this
interface.

CPU Utilization If available, this diagram illustrates the amount of CPU utilization on the node.

Memory Utilization If available, this diagram illustrates the amount of memory utilization on the
node.

Disk Utilization If available, this diagram illustrates the amount of disk utilization on the node.

Other Graphs

INTERFACE_out_octets This graph displays the total number of octets transmitted out of the interface,
including framing characters.

INTERFACE_in_octets This graph displays the total number of octets received on the interface,
including framing characters.

memUsageSwap This graph displays the amount of memory swapped to disk per second.

memUsagePaging This graph displays the amount of virtual memory used.

virtualMemWaitThreads This graph displays the number of processes waiting for run time.

virtualMemBlkThreads This graph displays the number of processes in "uninterruptible" sleep.

virtualMemNumCPUs This graph displays the number of CPUs.

waitThreadsRatio This graph displays the ratio of wait threads per CPU instance.

blockedVsWaitThreads This graph displays the difference between the blocked threads and the wait
threads.

diskUsageSlash This graph displays the disk usage for the "/" directory.

diskUsageBw This graph displays the disk usage for the "/bw" directory.

CPUBusy This graph displays the sum of CPUSys and CPUUsr.

CPUIdle This graph displays the percentage of the CPU idle time.

CPUSys This graph displays the percentage of the CPU used by the system.

CPUUsr This graph displays the percentage of the CPU used by the user programs.

ASBusyHourCallAttemptsThis graph displays the number of call attempts per hour.

ASOciRequestsInPerSecond
This graph displays the number of Open Client Interface (OCI) requests
attempted per second.

diskUsageTmp This graph displays the disk usage for the /tmp directory.

maxDiskIOSvc This graph displays the maximum disk Input Output (IO) svc time.

maxDiskIOBusy This graph displays the maximum disk IO busy time.

maxDiskIOBsyVsSvc This graph displays the maximum disk IO busy time versus svc time.

maxXsJavaHeap This graph displays the maximum Java heap used by the Execution Server.

totalXsJavaHeap This graph displays the total Java heap used by the Execution Server.

percentXsJHeap This graph displays the percentage of the Java heap used by the Execution
Server.

dsnInUse This graph displays the percentage of usage of the DataStore Name (DSN).

ASOciAvgRequestDelay This graph displays the average time (in milliseconds based on a rolling
average of the last 100 samples) it takes to process an OCI request.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 145
 Input Box Description

ASOciMaxRequestDelay This graph displays the longest OCI request response time.

AStoSMTPtraffic This graph displays the total number of messages sent attempted on the
primary Simple Mail Transfer Protocol (SMTP) server.

ASNbOfUsers This graph displays the number of users configured on the node.

ASCallsPerSecond This graph displays the number of calls per second.

ASActiveCalls This graph displays the number of active calls on the node.

ASSysIntQueueTimeAvgCallHalf
This graph displays the average call processing queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxCallHalf(msec)
This graph displays the largest call processing queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgRegAdapt(1000usec)
This graph displays the average registration queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxRegAdapt(msec)
This graph displays the largest registration queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgCallPThreadDBAccess(1000usec)
This graph displays the average database access from call processing queue
holding time (in milliseconds).

ASSysIntQueueTimeMaxCallPThreadDBAccess(msec)
This graph displays the largest database access from call processing queue
sample holding time (in milliseconds).

ASSysIntQueueTimeAvgVoiceMailInAdapt(1000usec)
This graph displays the average voice mail queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxVoiceMailInAdapt(msec)
This graph displays the largest voice mail queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgAcctOutAdapt(1000usec)
This graph displays the average accounting queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxAcctOutAdapt(msec)
This graph displays the largest accounting queue sample holding time (in
milliseconds).

ASSipMsgPerSecond This graph displays the number of Session Initiation Protocol (SIP) messages
(per second).

ASSipRegistersInPerSecond
This graph displays the number of SIP register messages (per second).

ASSipOptionsPerSecond This graph displays the number of SIP option messages (per second).

ASSipSubscribeNotifyPerSecond
This graph displays the number of SIP subscribe messages (per second).

ASSipAvgCallSetupDelayThis graph displays the average time (in milliseconds) it takes between
the receipt of an INVITE message for the origination of a new call and the
transmission of an INVITE (SiIPterminator), Notification Request (RQNT)
(Media Gateway Control Protocol [MGCP] terminator with in-band ringback), or
Create Connection (CRCX) (MGCP terminator without in-band ringback) to the
primary device of the original called party (for intra-group call) or to the network
element of the original called party (for a call to the Public Switched Telephone
Network [PSTN]).

ASSipMaxCallSetupDelay(msec)
This graph displays the longest SIP setup-signal delay.

ASSipAvgAnswerDelay(msec)
This graph displays the average time (in milliseconds) between the receipt of a
200 OK message indicating answer or a NTFY off-hook indicating answer and
the transmission of a 200 OK indicating answer to the originator.

ASSipMaxAnswerDelay(msec)
This graph displays the longest SIP answer-signal delay.

ASSysIntQueueTimeAvgSIPEncodeQ(1000usec)
This graph displays the average SIP encoding queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxSIPEncodeQ(msec)
This graph displays the largest SIP encoding queue sample holding time (in
milliseconds).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 146
 Input Box Description

ASSysIntQueueTimeAvgSIPCallDecodeQ(1000usec)
This graph displays the average SIP decoding queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxSIPCallDecodeQ(msec)
This graph displays the largest SIP decoding queue sample holding time (in
milliseconds).

ASMgcpMsgPerSecond This graph displays the number of MGCP messages (per second).

ASMgcpAvgDialToneDelay(msec)
This graph displays the average MGCP dial tone delay time (in milliseconds).

ASMgcpMaxDialToneDelay(msec)
This graph displays the largest dial tone delay time (in milliseconds).

ASMgcpAvgCallSetupDelay(msec)
This graph displays the average MGCP call setup delay time (in milliseconds).

ASMgcpMaxCallSetupDelay
This graph displays the largest MGCP call setup delay time (in milliseconds).
(msec)

ASMgcpAvgAnswerDelay(msec)
This graph displays the average MGCP answer delay time (in milliseconds).

ASMgcpMaxAnswerdelay(msec)
This graph displays the largest MGCP answer delay time (in milliseconds).

ASSysIntQueueTimeAvgCallHalf(1000usec)T1
This graph displays the average call processing queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxCallHalf(msec)T1
This graph displays the largest call processing queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgMGCPEncodeQ(1000usec)
This graph displays the average MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxMGCPEncodeQ(msec)
This graph displays the largest MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeAvgCallHalf(1000usec)T2
This graph displays the average call processing queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxCallHalf(msec)T2
This graph displays the largest call processing queue sample holding time (in
milliseconds).

ASSysIntQueueTimeAvgMGCPDecodeQ(1000usec)
This graph displays the average MGCP decode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxMGCPDecodeQ(1000usec)
This graph displays the largest MGCP decode queue delay time (in
milliseconds).

ASCapMsgPerSecond This graph displays the number of Client Application Protocol (CAP) messages
handled (per second).

ASNbOfMigratedUsers This graph displays the number of users migrated to the secondary Application
Server.

CPUUtilization This graph displays the CPU (system + user) utilization.

MemoryUtilization This graph displays the memory utilization.

hrStorageType_RAM This graph displays the memory type.

hrStorageUsed_RAM This graph displays the memory used.

hrStorageAllocationUnits_RAM
This graph displays the memory allocation unit.

hrStorageSize_RAM This graph displays the memory size.

Device_INTERFACE_out_octets
This graph displays the number of octets sent over the network.

Device_INTERFACE_in_octets
This graph displays the number of octets received over the network.

ReceiveErrors This graph displays the number of packets received in error.

TransmitErrors This graph displays the number of packets transmitted in error.

InDiscards This graph displays the number of incoming packets discarded.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 147
 Input Box Description

OutDiscards This graph displays the number of outgoing packets discarded.

InterfaceOutUtilization This graph displays the percentage of the interface utilization in output.

InterfaceInUtilization This graph displays the percentage of the interface utilization in input.

ASSysIntQueueTimeAvgSIPEncodeQ(1000usec)T1
This graph displays the average SIP encode queue delay time (in milliseconds).

ASSysIntQueueTimeMaxSIPEncodeQ(msec)T1
This graph displays the largest SIP encode queue delay time (in milliseconds).

ASSysIntQueueTimeAvgSIPCallDecodeQ(1000usec)T1
This graph displays the average SIP call decode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxSIPCallDecodeQ(msec)T1
This graph displays the largest SIP call decode queue delay time (in
milliseconds).

ASSysIntQueueTimeAvgMGCPEncodeQ(1000usec)T1
This graph displays the average MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxMGCPEncodeQ(msec)T1
This graph displays the largest MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeAvgVoiceMailInAdapt(1000usec)T1
This graph displays the average voice mail queue delay time (in milliseconds).

ASSysIntQueueTimeMaxVoiceMailInAdapt(msec)T1
This graph displays the largest voice mail queue delay time (in milliseconds).

ASSysIntQueueTimeAvgRegAdapt(1000usec)T1
This graph displays the average registration queue delay time (in milliseconds).

ASSysIntQueueTimeMaxRegAdapt(msec)T1
This graph displays the largest registration queue delay time (in milliseconds).

NSCallpCallsPerSecond This graph displays the number of calls (per second).

NSSipStatsInviteIns This graph displays the number of SIP invites.

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)T1
This graph displays the average SIP redirect queue delay time (in
milliseconds).

NSSipMsgPerSecond This graph displays the number of SIP messages (per second).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)
This graph displays the average SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipDecodeQ(1000usec)
This graph displays the largest SIP decode queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)
This graph displays the average SIP redirect queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipEncodeQ(msec)
This graph displays the largest SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipDecodeQ(msec)
This graph displays the largest SIP decode queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)
This graph displays the largest SIP redirect queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)T2
This graph displays the average SIP redirect queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)T1
This graph displays the largest SIP redirect queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)T2
This graph displays the largest SIP redirect queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)T1
This graph displays the average SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)T2
This graph displays the average SIP encode queue delay time (in milliseconds).

NSSysIntQueueTimeMaxSipEncodeQ(msec)T2
This graph displays the largest SIP encode queue delay time (in milliseconds).

Alarm Status

Status This column displays the status of the alarm. Values include: Critical, Major,
Minor, Warning, Info, and Clear.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 148
 Input Box Description

Source – Alarm Name This column displays the name of the alarm or the category of the alarm. For
or Category more information, see the BroadWorks Fault and Alarm Interface Specification.

Date/Time This column displays the date and time the alarm was issued.

Alarm Details This column displays the alarm description. It is also a link to the details of the
alarm on the Fault tab. For more information, see View Alarm Properties on
page 186.

4.5.2.2 Edit Node Properties

1) From the Node Properties page, click Edit on the section to edit.
2) Modify the properties.
3) Click Update Object to save the changes or click Reset to reset the values to the previous settings.
4) Repeat steps 1 through 3 for each section that requires modification.

4.5.2.3 View Routing Tables of Node

Use the Routing Table page to view the routing table for a node.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 149
 Figure 68: Routing Table

The information on this page includes the following:

Column Description

ipRouteDest This column displays the IP route destination.

ipRouteNextHop This column displays the IP route next hop.

To display the routing table for a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 150
 1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "Routing Table" from the Snmp-Node drop-down list. The
Routing Table page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

4.5.2.4 View Interfaces of Node

Use the Interfaces page to view the interfaces table for a node.

Figure 69: Interfaces

The information on this page includes the following:

Column Description

ifIndex This column displays the index of the interface.

ifDescr This column displays the description of the interface.

ifType This column displays the type of the interface.

ifSpeed This column displays the speed of the interface.

ifPhysAddress This column displays the physical address of the interface.

ifAdminStatus This column displays the administration status of the interface.

ifOperStatus This column displays the operational status of the interface.

ifInOctets This column displays the number of input octets to the interface.

ifOutOctets This column displays the number of output octets from the interface.

ifOutDiscards This column displays the number of output discards from the interface.

To display the interfaces of a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 151
 3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "Interfaces" from the Snmp-Node drop-down list. The Interfaces
page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

4.5.2.5 View TCP Table

Use the TCP Table page to view the TCP table for a node.

Figure 70: TCP Table

The information on this page includes the following:

Column Description

tcpConnState This column displays the TCP connection state.

tcpConnLocalAddress This column displays the local address of the TCP connection.

tcpConnLocalPort This column displays the local port of the TCP connection.

tcpConnRemAddress This column displays the remote address of the TCP connection.

tcpConnRemPort This column displays the remote port of the TCP connection.

To display the Transmission Control Protocols for a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "TCP Table" from the Snmp-Node drop-down list. The TCP
Table page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 152
 NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

4.5.2.6 View UDP Table

Use the UDP Table page to view the UDP tables for a node.

Figure 71: UDP Table

The information on this page includes the following:

Column Description

udpLocalAddress This column displays the local UDP address.

udpLocalPort This column displays the local UDP port.

To display the User Datagram Protocols for a node:

1) Access a node:
• To access a node from the Maps tab:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 153
 1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "UDP Table" from the Snmp-Node drop-down list. The UDP
Table page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

4.5.2.7 View IP Net to Media Table

Use the IPNetToMediaTable page to view the IPNet to Media table for a node.

Figure 72: IPNet to Media Table

The information on this page includes the following:

Column Description

ipNetToMedialfIndex This column displays the index of the IPNet to Media.

ipNetToMediaPhysAddress This column displays the physical address of the IPNet to Media.

ipNetToMediaNetAddress This column displays the network address of the IPNet to Media.

ipNetToMediaType This column displays the type of IPNet to Media.

To display the IPNet to Media table for a node:

1) Access a node:
• To access a node from the Maps tab:
1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the
BroadWorks cluster appear.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 154
 3) Click the icon representing the BroadWorks node you are interested in. The Node Properties
page appears.
• To access a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
2) From the Node Properties page, select "IPNetToMedia Table" from the Snmp-Node drop-down list. The
IPNetToMediaTable page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode". For these nodes, use step 1 to access the node.

4.5.2.8 Refresh this Node

Use the Refresh Node page to view the results of a refreshed node (server).

Figure 73: Refresh Node Results

To refresh a node from the Maps tab:

1) Click the Maps tab.
2) Select the menu that corresponds to the network cluster to display. Icons representing the BroadWorks
cluster appear.
3) Click the icon representing the BroadWorks node you are interested in. The Node Properties page
appears.
4) From the Node Properties page, select "Refresh Node" from the Snmp-Node drop-down list. The
Refresh Node page appears.

NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode".

5) Click Refresh. The results of the refresh appear.

To refresh a node from the Inventory tab:
1) Click the Inventory tab.
2) Select the Nodes submenu. The Nodes page appears.
3) Click the name of the node to display. The Node Properties page appears.
4) From the Node Properties page, select "Refresh Node" from the Snmp-Node drop-down list. The
Refresh Node page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 155
 NOTE: This drop-down list does not appear for nodes that have a managed object (MO) label of
"SnmpNode".

5) Click Refresh. The results of the refresh appear.

4.6 Managing Interfaces

Use the Interfaces page to list and manage the interfaces on your EMS network.

Figure 74: Interfaces

The information on this page includes the following:

Column Description

Name This column displays the name of the interface.

Display Name This column displays the name of the interface as it is displayed on the EMS.

MO Type This column displays the type of the interface.

IP Address This column displays the IP address of the interface.

Netmask This column displays the netmask of the interface.

Is SNMP? This column displays whether the interface is SNMP.

Status This column displays the status of the interface. When the interface is "unmanaged", this column
displays a gray icon "?". When the interface is "managed", a red/yellow/green arrow icon is
displayed.

Last Status Time Change This column displays the time stamp of the last status change of the interface.

To display the interfaces view of the inventory:

1) Click the Inventory tab.
2) Select the Interfaces menu. The Interfaces page appears.
3) To print this view of the inventory:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 156
 a) Click Print Version. A PDF view of the current list of the inventory appears in a new window.
b) From the File menu, click Print. The Print dialog box appears.
c) Select the printer and click Print.
d) Close the window.
4) To view the events for an interface:
a) Click the check box for the managed object(s) (network, group, node, or interface) for which you
want to display the related events.
b) Click View Events. The Events page displays the list of events related to the selected managed
object.

NOTE: If there have not been any events triggered for the selected managed object, the page
displays a message indicating that there is no data to display.

5) To view the alarms for an interface:

a) Click the check box for the managed object(s) (network, group, node, or interface) for which you
want to display the related alarms.
b) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

6) To manage an interface:
a) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
b) Click Manage.
7) To "unmanage" an interface:
a) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".
b) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
Tasks to perform from this page

4.6.1 Add Child View of Interfaces

You can add/create a new view by specifying various criteria and providing a name for the view. The views
you create enable you to quickly monitor your interfaces. Multiple views can also be created to display a
variety of information. For example, you can create a new view named MasterIP, which shows only those
interfaces related to a particular IP address.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 157
 Figure 75: Interfaces

The information on this page includes the following:

Input Box Description

Custom view name This input box defines the name of the child view.

First drop-down list This drop-down list includes the properties available to define this view. These include:
• name: includes managed objects (network, node, group, or interface) based on their names
• status: includes managed objects (network, node, group, or interface) based on their status.
Possible status values are: critical, major, minor, warning, info, and clear.
• ipAddress: includes managed objects (network, node, group, or interface) based on their IP
addresses
• managed: includes managed objects (network, node, group, or interface) depending on whether
they are currently managed
• type: includes managed objects (network, node, group, or interface) of a specific type (for
example, bwserver-app, SnmpNode, and so on)
• snmpport: includes managed objects (network, node, group, or interface) by SNMP port
• version: includes managed objects (network, node, group, or interface) by their version number
• isSNMP: includes managed objects (network, node, group, or interface) depending on whether
they run on SNMP
• statusPollEnabled: includes managed objects (network, node, group, or interface) depending on
whether they are enabled to poll for status
• pollInterval: includes managed objects (network, node, group, or interface) based on their polling
interval
• statusUpdateTime: includes managed objects (network, node, group, or interface) based on the
time of status update
• statusChangeTime: includes managed objects (network, node, group, or interface) based on the
time of status change
• isDHCP: includes managed objects (network, node, group, or interface) depending on whether
they run on the Dynamic Host Configuration Protocol (DHCP)
• isNode: includes managed objects (network, node, group, or interface) depending on whether
they are nodes
• isInterface: includes managed objects (network, node, group, or interface) depending on whether
they are interfaces
• isRouter: includes managed objects (network, node, group, or interface) depending on whether
they are routers
• isNetwork: includes managed objects (network, node, group, or interface) depending on whether
they are networks

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 158
 Input Box Description

Second drop-down list This drop-down list includes the Boolean statements available to define this view. These include:
• equals
• not equals
• starts with
• ends with
• contains
• does not contain

Text box This text box specifies the view criteria.

To add a child view from the interfaces view of the inventory:

1) From any View page, (Complete View, Network View, Group View, Node View, Interface View), click
Add Child View. The Add Child View page for that view appears.
2) In the Custom view name text box, type the name of the child view. This input box is mandatory.
3) Select the property from the first drop-down list.
4) Select the Boolean statement from the second drop-down list.
5) In the text box, type the view criteria.
6) To add additional criteria, click More and repeat steps 2 through 4.

NOTE: To remove existing criteria, click Fewer.

7) To preview the results of this view, click Preview Results. The view appears.
8) To add this view to the Inventory menu, click Add Child View. This view appears on the Inventory
menu.
For more information

4.6.1.1 Edit Child View of Interfaces

Use the Edit Topology View Criteria - Interfaces page to modify the child view of interfaces.

Figure 76: Edit Topology View Criteria - Interfaces

To edit the view criteria of a child view from the interfaces view of the inventory:
1) From any View page, (Complete View, Network View, Group View, Node View, Interface View), click
Edit View Criteria. The Edit Topology View Criteria page appears.
2) In the Custom view name text box, type the name of the child view. This input box is mandatory.
3) Select the property from the first drop-down list.
4) Select the Boolean statement from the second drop-down list.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 159
 5) In the text box, type the view criteria.
6) To add additional criteria, click More and repeat steps 3 through 5.

NOTE: To remove existing criteria, click Fewer.

7) To preview the results of this view, click Preview Results. The view appears.
8) To save the changes to this view, click Apply. This view appears on the Inventory menu.

4.6.1.2 Remove Child View of Interfaces

1) From a view page, click Remove View. A message asks for your confirmation.
2) To permanently remove this view, click OK. Click Cancel to return to the previous page.

NOTE: When a view is deleted, all of its child views are also removed.

4.6.1.3 Search
Use the Search page to search for alarms, events, or managed objects.

Figure 77: Advanced Search

To search:
1) From a view page, click Search and complete the following:
2) Select Match any of the Following to perform a search operation that satisfies any of the specified
matching criteria or select Match all of the Following to perform a search operation that satisfies all of
the specified matching criteria.
3) In the left-hand input box (Properties), select the property based on which you need to perform your
search. If you select the time property as a search criterion, the Date Input Helper icon appears. It can
help you quickly specify the time and date of interest.
4) In the middle input box (Condition), select the condition based on which you need to restrict your
search.
5) In the right-hand input box, type the exact information you are looking for. For example, if you have
selected severity in the Properties box, then you must specify the severity value here, such as "critical",
"major", and so on.
6) To specify additional criteria, click More and repeat steps 2 through 4. Fewer options can be used to
remove the criteria that were last added.
7) Click Search. Events satisfying the criteria appear.

4.6.1.4 Customize Columns of Child View

The properties are displayed as columns in the list view. You can add more columns or remove existing
columns in the events list view.
Use the Customize Columns page to customize the columns for a view of events, alarms, or managed
objects.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 160
 Figure 78: Customize Columns

To customize the columns of a view:

1) From a view page, click Customize Columns. The Customize Columns page appears.
2) To add new columns, select the property (based on which columns are created) from the Available
columns list and click the arrow pointing to the right. The property is moved to the Displayed columns.
Multiple properties can be selected using the CTRL+Click and SHIFT+Click options.
3) To remove existing columns, select the property from the Displayed columns list and click the arrow
pointing to the left. The property is moved to the Available columns list.
4) In the Displayed columns list, use the up and down arrows to order the columns in the view, from left to
right.
5) Click Apply. The list view is refreshed using your custom column arrangement.

4.6.2 View Interface Properties

Use the Interface Properties page to display the properties of an interface.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 161
BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00
©2014 BROADSOFT, INC. PAGE 162
BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00
©2014 BROADSOFT, INC. PAGE 163
 Figure 79: Interface Properties

To view the properties of an interface:

From a list page, click the link of the interface to view. The Interface Properties page appears.
To manage an interface:
1) Click the check box for the managed object(s) (network, group, node, or interface) to manage.
2) Click Manage.
To "unmanage" an interface:
1) Click the check box for the managed object(s) (network, group, node, or interface) to "unmanage".
2) Click Unmanage. The managed object is no longer accessible to configure, poll, or display events or
alarms.
To view events for an interface:
1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related events.
2) Click View Events. The Events page displays the list of events related to the selected managed object.

NOTE: If there have not been any events triggered for the selected managed object, the page displays
a message indicating that there is no data to display.

To view alarms for an interface:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 164
 1) Click the check box for the managed object(s) (network, group, node, or interface) for which you want to
display the related alarms.
2) Click View Alarms. The Alarms page displays the list of alarms related to the selected managed
object(s).

NOTE: If there have not been any alarms triggered for the selected managed object(s), the page
displays a message indicating that there is no data to display.

For more information

4.6.2.1 Interface Properties Reference

Input Box Description

General Information

Device Type This text box displays the device type of the interface.

Is Managed? This option controls whether the interface is managed or "unmanaged". When an interface is
"unmanaged", status polling and data collection stops. Therefore, threshold calculation is not done.
Traps for the node interface continue to be processed. To disable the processing of traps, see
Configure Fault Management Parameters on page 303.

IP Address This text box specifies the IP address of the interface.

Is DHCP Enabled? This text box indicates whether Dynamic Host Configuration Protocol (DHCP) is enabled on the
interface.

Status This text box displays the overall alarm status of the interface. The highest alarm severity level
associated with the interface is displayed.

Display Name This input box displays the managed object's name (network, node, group, or interface) that is used
on the web interface.

Netmask This drop-down list specifies the network mask of the interface.

Status Monitoring Details

Is Status polling enabled? This option controls status polling on the node. If the value is set to "yes", the status of the node
(alarms and events) is available through the web interface. If the value is set to "false", the status is
not available.

Last Status Change Time This text box displays the time of the last change of status.

Last Status Update Time This text box displays the time stamp of the last time the node was polled for its status.

Failure Threshold This input box specifies the number of consecutive failed status poll attempts, to declare the object
as failed. A status change event for the object is generated when the status polling for the object fails
for "Failure Threshold" times.

Failure Count This text box displays the number of times consecutive status poll attempts for this object have
failed. The count is reset to "0" once the object is declared as failed or when the object recovers
after the failure. When the value of "Failure Count" equals that of "Failure Threshold", the object is
declared failed.

Tester for Status Polling This drop-down list provides the ability to select the action to be performed on status polling for the
managed object (network, node, group, or interface). When the selected value is "Max", the status
of the interface is propagated to the managed node. If the value "User Test" is used, the User Class
Name parameter should be set with the name of the user tester class.

User Class Name This input box specifies the class to be invoked for status polling. Set this parameter only if the
selected value of the Tester for Status Polling parameter is "User Test".

Status Polling Interval This input box specifies the interval between status polling attempts for this group.

Parent Node & Parent Networks

Parent Networks This text box specifies the parent of the managed object (network, node, group, or interface).

Parent Object This text box specifies the parent of the managed object.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 165
 Input Box Description

Is Container? This text box specifies whether the managed object is a container.

Parent Node This text box displays the IP address(es) of the parent node.

List of Groups This drop-down list identifies the names of the groups to which the node belongs.

Is Group? This text box specifies whether the managed object is a group.

Protocol Configuration Settings

SNMP Port This text box displays the SNMP port number the EMS uses to retrieve SNMP values from this
interface.

Read Community This text box displays the read community associated with this interface.

SNMP Version This text box displays the SNMP version running on this interface.

Physical Media This text box displays the physical media that the interface resides on.

Interface Speed This text box displays the speed of the interface.

System Object Identifier This text box displays the BroadWorks base object identifier (OID) for the interface.
(SysOID)

Host Netmask This text box displays the host netmask.

Base MIBs This text box displays the list of base Management Information Bases (MIBs) implemented by the
SNMP agent of the node.

Write Community This text box specifies the write community associated with this node.

Physical Address This text box displays the physical address of this interface.

Interface Descriptor This text box displays the (interface) descriptor of this interface.

SNMP index number for the This text box displays the SNMP index number for the physical interface.
physical interface (lfindex)

Graphs

Interface Traffic Details This graph displays the interface traffic details.

Interface Utilization Details This graph displays the interface utilization details.

Interface Error & Discard This graph displays the interface error and discard details.
Details

4.6.2.2 Edit Interface Properties

1) From the Interface Properties page, click Edit on the section to edit.
2) Modify the properties.
3) Click Update Object to save the changes or click Reset to reset the values to the previous settings.
4) Repeat steps 1 through 3 for each section that requires modification.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 166
5 Managing Faults

This section provides information on how to manage faults.

This section describes the following:
• Overview of Fault Management on page 167
• Monitoring Network Events on page 171
• Monitoring Network Alarms on page 178
• Monitoring Syslog Events on page 189
• Monitoring Syslog Alarms on page 196
• Reference Information on page 206

5.1 Overview of Fault Management

The EMS offers sophisticated fault management capabilities for proactive management of network
reliability and availability. The EMS architecture allows easy integration of events from diverse BroadWorks
network elements, and provides methods to process, correlate, and present alarms and events based on
domain-specific requirements. The fault management capabilities include the following:
• Support of northbound Simple Network Management Protocol (SNMP) interfaces (for trap forwarding
and performance management requests). For more information on northbound configuration, see
Configuring Northbound Trap Forwarding on page 46.
• Event/trap processing – Filtering, suppression, and propagation
• Intelligent correlation and color-coded alarm views
• Alarm drill down categorized by severity, managed resource type, and time of day
• Fault remedy work flow management, categorizing alarms as opened, acknowledged, or closed
For northbound support, the EMS acts as an SNMP proxy to relay faults received from other components
and from managed elements, by specifying a list of Internet Protocol) addresses and ports where faults are
forwarded.
Centralized Syslog
The Centralized Syslog centralizes the UNIX syslog capabilities for all managed objects at the EMS. The
goal is to allow an EMS administrator to review all system logs.
The EMS converts syslog messages to EMS events where the category is set to "syslog", thus enabling
EMS administrators to view syslog in a typical EMS events view. Since the syslog integration uses EMS
events, it leverages existing EMS capabilities to raise EMS syslog alarms when an event has a severity
with a criticality.
The integration focuses on the following items:
• Identifying which syslog messages are forwarded to the EMS
• Specifying how the EMS maps the received syslog messages to EMS events
The following figure summarizes the steps involved.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 167
 Figure 80: Syslog Message Flow – Managed Objects to/from EMS

The EMS integrates the Syslog feature by integrating two new views to the Fault Management tab. These
views are named Syslog Events and Syslog Alarms.
Flow of Notifications
The flow of notifications in EMS, divides syslog events from regular events. SNMP traps are also referred
to as notifications. Notifications that are evaluated as stateful alarms are forwarded to the trap collector.
The trap collector includes trap filters and trap parsers that convert a trap into an event. When traps are
received, they are first passed through a set of trap filters. Traps filters are Java-written code and are
not available for configuration from the EMS web interface. Trap parsers occupy the next step in the
notification flow. A received trap is passed through the level of trap parsers only if the trap has not already
been converted into an event by a trap filter or if the received trap has not been dropped by any trap filter
previously. Trap parsers are parsing mechanisms that can be configured by users to generate useful and
appropriate event information from the trap received (for example, a trap parser can be configured to set
the message of a generated event to be the same as that of a received trap message). The output of a trap
parser is an event. Trap parsers can be configured from the Admin tab. With the current implementation, all
BroadWorks traps (trapoid ".1.3.6.1.4.1.6431.*") are converted to corresponding events by the trap filters;
therefore, no BroadWorks traps actually get to the trap parser level. For more information on configuring
trap parsers, see Configure Trap Parsers on page 313.
The generated events are then passed through a series of event parsers. Event parsers are simple parsing
mechanisms that can be configured by users when further processing (or refinement) of the input events is
required. Event parsers are very flexible. They include tokenizers to convert any event field to tokens that
can be used in the output of the parser. Event parsers can be configured from the Admin tab. There are
no default event parsers defined/activated in EMS. For more information on configuring event parsers, see
Configure Event Parsers on page 321.
Event filters are used to execute user-specific actions whenever events are received with configurable
matching criteria, such as e-mailing someone when a particular event is generated. Types of supported
inbuilt filter actions are suppressing multiple events in a given interval, running shell commands on the
server system, sending e-mails, sending traps, and running custom Java code to filter events. Custom
Java code may be needed in cases where additional data must be retrieved or if specific rules are to
be applied in processing the event. Event filters can be configured from the Admin tab. By default, the
following event filters are defined/activated in EMS: BWEventFilterForThreshold, BWEventFilterForHealth,

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 168
 BWEventFilter, and BWEventFilterForSyslog. These filters are mandatory for EMS Fault Management
to work properly and therefore, must not be deleted under any circumstances. For more information on
configuring event filters, see Configure Event Filters on page 326.
An alert or alarm filter serves to execute user-specific actions whenever alarms are received with
configurable matching criteria (for example, e-mailing someone when a particular alarm is generated).
Types of supported inbuilt filter actions are suppressing multiple alerts in a given interval, running shell
commands on the server system, sending e-mails, sending traps, and running custom Java code to filter
alerts. Custom Java code may be needed in cases where any additional data must be retrieved or specific
rules are to be applied in processing the alarm. Alarm filters can be configured from the Admin tab. By
default, there are two alarm filters defined/activated in EMS: BWAlertFilter and BWAudibleAlarm. These
filters are mandatory for EMS Fault Management to work properly and therefore, must not be deleted in
any circumstances. For more information on configuring alarm filters, see Configure Alarm Filters on page
331.

NOTE: Parsers and filters are performed following the order in which they are defined on their list.
Currently, it is not possible to reorder the parser/filter lists through the web interface. You must use the
applet interface to perform these ordering actions.

You can view both alarms and events in the EMS.

The following figure provides an overview of the flow of notifications through the EMS.
Figure 81: Flow of Notifications

Defined Severity and Criticality

Trap severities are informational, low, medium, high, and critical. Their corresponding event severities
are info, warning, minor, major, and critical. Another event severity is clear, which is used to reflect the
clearance of a previous event that had a severity with criticality.
The info severity is defined as having no criticality and a severity less than that of the clear severity. The
severities minor, major, and critical are defined as having a criticality and a severity greater than that of the
clear severity.
BroadWorks Trap to EMS Event Mapping
The EMS provides a basic mapping, whereby it translates a trap received from a BroadWorks server into
an event. The mapping is as follows:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 169
 • The severity of the trap is mapped to the equivalent severity of the event.
• The BroadWorks server type of the trap is mapped to the category of the event.
• The managed object name (or Internet Protocol [IP] address) of the trap is mapped to the entity, source,
and node of the event.
• The alarm name of the trap is mapped to the name of the event.
• The alarm text of the trap is mapped to the message of the event.
• The recommended action of the trap is mapped to the recommended action of the event.
The following BroadWorks traps with an info severity generate an EMS event that has severity with
criticality to better reflect the impact on the server.
• The trap named bwServerStateTransition generates an event with minor severity when the alarm text of
the trap meets the following conditions:
• There is a distinct value for the old operational state and the new operational state.
• The new operational state is disabled.
• The trap named bwServerStateTransition generates an event with minor severity when the alarm text of
the trap meets the following conditions:
• There is a distinct value for the old administrative state and the new administrative state.
• The new administrative state is locked.
• The following traps are mapped to a different event with major severity:
• bwPMProvisioningServerShutDown ➝ bwPMProvisioningServerStopped
• bwPMExecutionServerShutDown ➝ bwPMExecutionServerStopped
• bwPMMediaServerShutDown ➝ bwPMMediaServerStopped
• bwPMNetServerShutDown ➝ bwPMNetServerStopped
• bwPMNSProvisioningServerShutDown ➝ bwPMNSProvisioningServerStopped
• bwPMNSExecutionServerShutDown ➝ bwPMNSExecutionServerStopped
• bwPMClientManagementProfileServerShutDown ➝ bwPMClientManagementProfileServerStopped
• bwPMtomcatShutDown ➝ bwPMtomcatStopped
• bwPMOpenClientServerShutDown ➝ bwPMOpenClientServerStopped
• The following traps are mapped to a different event with critical severity:
• bwPMProvisioningServerDeath ➝ bwPMProvisioningServerStopped
• bwPMExecutionServerDeath ➝ bwPMExecutionServerStopped
• bwPMMediaServerDeath ➝ bwPMMediaServerStopped
• bwPMNetServerDeath ➝ bwPMNetServerStopped
• bwPMNSProvisioningServerDeath ➝ bwPMNSProvisioningServerStopped
• bwPMNSExecutionServerDeath ➝ bwPMNSExecutionServerStopped
• bwPMClientManagementProfileServerDeath ➝ bwPMClientManagementProfileServerStopped
• bwPMtomcatDeath ➝ bwPMtomcatStopped
• bwPMOpenClientServerDeath ➝ bwPMOpenClientServerStopped
• The following BroadWorks traps with an info severity are mapped to a different EMS event with clear
severity:
• bwPMProvisioningServerLaunched ➝ bwPMProvisioningServerStopped
• bwPMProvisioningServerRestarted ➝ bwPMProvisioningServerStopped
• bwPMExecutionServerLaunched ➝ bwPMExecutionServerStopped
• bwPMExecutionServerRestarted ➝ bwPMExecutionServerStopped
• bwPMMediaServerLaunched ➝ bwPMMediaServerStopped
• bwPMMediaServerRestarted ➝ bwPMMediaServerStopped
• bwPMNetServerLaunched ➝ bwPMNetServerStopped
• bwPMNetServerRestarted ➝ bwPMNetServerStopped

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 170
 • bwPMNSProvisioningServerLaunched ➝ bwPMNSProvisioningServerStopped
• bwPMNSProvisioningServerRestarted ➝ bwPMNSProvisioningServerStopped
• bwPMNSExecutionServerLaunched ➝ bwPMNSExecutionServerStopped
• bwPMNSExecutionServerRestarted ➝ bwPMNSExecutionServerStopped
• bwPMClientManagementProfileServerLaunched ➝ bwPMClientManagementProfileServerStopped
• bwPMClientManagementProfileServerRestarted ➝ bwPMClientManagementProfileServerStopped
• bwPMtomcatLaunched ➝ bwPMtomcatStopped
• bwPMtomcatRestarted ➝ bwPMtomcatStopped
• bwPMOpenClientServerLaunched ➝ bwPMOpenClientServerStopped
• bwPMOpenClientServerRestarted ➝ bwPMOpenClientServerStopped
EMS Event to EMS Alarm Mapping
"Alarms" in EMS is the correlation of a set of events representing a common fault/failure. Alarms are
generated when there is an event that indicates a failure. The correlation of events into alarms is done
using the failure object (entity field) of the event object. (For all events with the same failure object, there is
only one alarm and the severity of the alarm is the severity of the latest event with the same failure object.)
Note that the failure object corresponds to parameter Source-Alarm Name or Category, shown on the
Event/Alarm Properties page.
A new alarm is generated from an event if the following two conditions are met by the generated event:
• If no other alarm exists matching the same failure object or entity, as that of the event in the EMS
• If the criticality of the event is greater than that of the clear severity
Subsequently, when a new event is generated for the same failure object, the existing alarm is updated.
An event can update an alarm only if any one of the following conditions is met:
• The criticality of the event is greater than or equal to that of clear and is different from the current status
of the corresponding alarm, or
• The message field of the event is different from the message field of the corresponding alarm, or
• The source field of the event is different from the source field of the corresponding alarm.
Alarm Clearing
The EMS automatically clears an outstanding alarm for a given managed
object when it receives the same trap with the alarmState input box
(.iso.org.dod.internet.private.enterprises.broadsoft.broadworks.common.systemFaults.faultFields.alarmState
or.1.3.6.1.4.1.6431.1.1.1.1.6) set to "OFF". In addition, the EMS automatically clears all outstanding alarms
for a given managed object when the following event is generated: A trap named bwServerStateTransition,
where the alarm text of the trap specifies the new operational state as enabled.

NOTE: This behavior excludes alarms that should always be cleared manually. For example, any alarm
that reports a software error or requires contacting BroadSoft personnel must be cleared manually. For
these exceptions, the alarm indicates the need for a manual clear by the end user.

Audible Alarms
The BroadWorks EMS allows administrators to associate an audio file with each alarm severity level. The
administrator also specifies whether the audio file is to be played only once or repeatedly. The audio file
for the highest alarm severity is played if alarms are present at multiple severity levels. An audible cutoff
(ACO) capability allows users to silence audible alarms. If a new alarm comes in after the audible cutoff
is activated, the audible alarm is reactivated. For information on configuring audible alarms, see Managing
Audible Alarms on page 382.

5.2 Monitoring Network Events

Use the Network Events page to monitor network events.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 171
 Figure 82: Network Events

The information on this page includes:

Column Description

Status This column displays the status of the network event.

Source This column displays a link to the source node of the network event. Click this link to display the
Event Properties page. For information on the input boxes appearing on this page, see View Event
Properties Reference on page 177.

Name This column displays the name of the network event.

BW Sub Component This column displays the BroadWorks subcomponent source of the network event.

Date/Time This column displays the date and time the network event occurred.

Event Details This column displays the detailed description of the network event.

To access the network events:

1) Click the Fault tab.
2) Select the Network Events menu. The Network Events page appears.
To print this view of network events:
1) On the Network Events page, click Print Version. A PDF view of the current list of network events
appears in a new window.
2) From the File menu, click Print. The Print dialog box appears.
3) Select the printer and click Print.
4) Close the window displaying the list of network events.
To view the alarms for an event:
1) On the Network Events page, to access the related alarms, click the check box for the event.
2) Click View Alarms. The Alarms page displays the list of alarms related to this event.
Tasks to perform from this page

5.2.1 Add Child View of Events

You can add/create a new view by specifying various criteria and providing a name for the view. The views
you create enable you to quickly monitor the devices you are interested in. Multiple views can also be
created to display a variety of information. For example, you can create a new view named MasterEvents,
which shows only those events in a particular network. Within this MasterEvents view, you can create more

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 172
 views, such as ME1and ME2. ME1 can have a different set of criteria, for example, only critical events in
that particular network. Deleting MasterEvents deletes its child views (ME1, ME2, and so on) as well.
Use the Add Event Child View page to add a child view of network events.

Figure 83: Add Event Child View

The information on this page includes:

Input Box Description

Child view name This text box describes this child view.

Severity These check boxes specify the severity levels included in this view.

Source This text box specifies the source of the events associated with this view. Events are filtered based
on this source only.

Source -- Alarm Name or This text box specifies the source, alarm name, or category of the events associated with this view.
Category Events are filtered based on this source, alarm name, or category only.

Message This text box specifies the event message associated with this view. Events are filtered based on
this event message only.

Category This text box displays the category of the events associated with this view. Events are filtered
based on this category only.

Node This text box displays the node associated with this view. Events are filtered based on this node
only.

Network This text box displays the network associated with this view. Events are filtered based on this
network only.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 173
 Input Box Description

Events generated after This text box specifies the start date and time of the events included in this view. The calendar icon
provides the ability to specify the date and time in the correct format.

Events generated before This text box specifies the end date and time of the events included in this view. The calendar icon
provides the ability to specify the date and time in the correct format.

Event Age This combination box specifies the age of the events included in this view. The drop-down list
includes the following:
• "Any" filters all ages of events.
• "Age in Minutes" filters the age of events by the number of minutes identified in the text box.
• "Age in Hours" filters the age of events by the number of hours identified in the text box.
• "Age in Days" filters the age of events by the number of days identified in the text box.
• "Today" filters the age of events based on the day the view is executed.
• "Yesterday" filters the age of events based on the day before the view is executed.

Refresh Period in Minutes This text box specifies the frequency that the view is refreshed (in minutes).

To add a child view of events:

1) Click the Faults tab.
2) Select the Network Events menu. The Network Events page appears.
3) Click Add Child View and complete the following:
• In the Child view name text box, type the name of this view.
• Under Severity, select the levels of severity to include in this view.
• To filter the view on a source, in the Source text box type the IP address of the source of the events
to include in this view.
• To filter the view on a source, alarm name, or category, in the Source -- Alarm Name or Category
text box, type the alarm names or categories to include in this view.
• To filter the view on a message text, in the Message text box, type the message for the events to
include in this view.
• To filter the view on a category, in the Category text box, type the category of events to include in
this view.
• To filter the view on a node, in the Node text box, type the specific nodes that you want to include in
this view.
• To filter the view on a network, in the Network text box, type the network to include in this view.
• To filter the view on a start date, in the Events generate after box, click the calendar icon and select
a start date for the events to include in this view.
• To filter the view on an end date, in the Events generated before box, click the calendar icon and
select an end date for the events to include in this view.
• To filter the view on an event age, in the Event Age box, select the type of event age from the drop-
down list and type the corresponding number in the text box.
• In the Refresh Period in Minutes box, specify the refresh frequency for this view.
4) Click Submit to create the child view. The name of the child view appears as a submenu of the Fault
Management menu in the left-hand navigation bar.

NOTE: Once you have added a view, you can remove it. To remove a child view, select the child view
from the Fault Management menu in the left-hand navigation bar and click Remove View. A message
appears asking for your confirmation. Click OK to remove the view.

5.2.2 Edit View Criteria of Events

1) Click the Faults tab.
2) Select the Network Events menu. The Network Events page appears.
3) Click Edit View Criteria and complete the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 174
 • Under Severity, select the levels of severity to include in this view.
• To filter the view on a source, in the Source text box type the IP address of the source of the events
to include in this view.
• To filter the view on a source, alarm name, or category, in the Source -- Alarm Name or Category
text box, type the alarm names or categories to include in this view.
• To filter the view on a message text, in the Message text box, type the message for the events to
include in this view.
• To filter the view on a category, in the Category text box, type the category of events to include in
this view.
• To filter the view on a node, in the Node text box, type the specific nodes that you want to include in
this view.
• To filter the view on a network, in the Network text box, type the network to include in this view.
• To filter the view on a start date, in the Events generate after box, click the calendar icon and select
a start date for the events to include in this view.
• To filter the view on an end date, in the Events generated before box, click the calendar icon and
select an end date for the events to include in this view.
• To filter the view on an event age, in the Event Age box, select the type of event age from the drop-
down list and type the corresponding number in the text box.
• In the Refresh Period in Minutes box, specify the refresh frequency for this view.
4) Click Submit to save the changes. The name of the child view appears as a submenu of the Fault
Management menu in the left-hand navigation bar.

NOTE: Once you have added a view, you can remove it. To remove a child view, select the child view
from the Fault Management menu in the left-hand navigation bar and click Remove View. A message
appears asking for your confirmation. Click OK to remove the view.

5.2.3 Remove a View

To remove a view:
1) From a view page, click Remove View. A message asks for your confirmation.
2) To permanently remove this view, click OK. Click Cancel to return to the previous page.

5.2.4 Search
Use the Search page to search for alarms, events, or managed objects.

Figure 84: Advanced Search

To search:
1) From a view page, click Search and complete the following:
2) Select Match any of the Following to perform a search operation that satisfies any of the specified
matching criteria or select Match all of the Following to perform a search operation that satisfies all of
the specified matching criteria.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 175
 3) In the left-hand input box (Properties), select the property based on which you need to perform your
search. If you select the time property as a search criterion, the Date Input Helper icon appears. It can
help you quickly specify the time and date of interest.
4) In the middle input box (Condition), select the condition based on which you need to restrict your
search.
5) In the right-hand input box, type the exact information you are looking for. For example, if you have
selected severity in the Properties box, then you must specify the severity value here, such as "critical",
"major", and so on.
6) To specify additional criteria, click More and repeat steps 2 through 4. Fewer options can be used to
remove the criteria that were last added.
7) Click Search. Events satisfying the criteria appear.

5.2.5 Customize Columns of Child View

The properties are displayed as columns in the list view. You can add more columns or remove existing
columns in the events list view.
Use the Customize Columns page to customize the columns for a view of events, alarms, or managed
objects.

Figure 85: Customize Columns

To customize the columns of a view:

1) From a view page, click Customize Columns. The Customize Columns page appears.
2) To add new columns, select the property (based on which columns are created) from the Available
columns list and click the arrow pointing to the right. The property is moved to the Displayed columns.
Multiple properties can be selected using the CTRL+Click and SHIFT+Click options.
3) To remove existing columns, select the property from the Displayed columns list and click the arrow
pointing to the left. The property is moved to the Available columns list.
4) In the Displayed columns list, use the up and down arrows to order the columns in the view, from left to
right.
5) Click Apply. The list view is refreshed using your custom column arrangement.

5.2.6 View Event Properties

Use the Event Properties page to display the properties of an event.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 176
 Figure 86: Event Properties

To access the properties of a network event:

On the Network Events page, click the event to display its properties. The Event Properties page appears.
For more information

5.2.6.1 View Event Properties Reference

Input Box Description

Source -- Alarm Name or Category This text box displays the source (IP address or host name) and
name or category of the alarm.

Status This column displays the status of the alarm. Values include:
Critical, Major, Minor, Warning, Info, and Clear.

Id This text box displays the ID associated with the event.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 177
 Input Box Description

Message This text box displays the message associated with the event.

Category This text box displays the category of the event.

Created This text box displays the creation time stamp of the event.

Group Name This text box displays the name of the group associated with the
event, if any.

Node This text box displays the node associated with the event.

Domain This text box displays the name of the domain associated with
the event, if any.

Network This text box displays the name of the network associated with
the event, if any.

BWTrapGenerated This text box specifies whether the event was generated by a
BroadWorks node.

BWMoSource This text box displays the managed object that generated the
event.

BWClearable This text box specifies whether the event can be automatically
cleared.

SourceTimeStamp This text box displays the time stamp of the time the event was
sent from the source.

BroadworksNode This text box specifies whether the node affected by the event
is a BroadWorks node. The value "true" indicates that it is a
BroadWorks node. The value "false" indicates that it is not a
BroadWorks node.

BwSubComponent This text box displays the subcomponent associated with the
event, if any.

EventName This text box displays the name of the event.

RecommendedAction This text box displays the recommended action associated with
the event.

5.3 Monitoring Network Alarms

Use the Network Alarms page to monitor network alarms.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 178
 Figure 87: Network Alarms

The information on this page includes:

Input Box Description

Status This column displays the status of the alarm.

Source -- Alarm Name or This column displays the source and name/category of the alarm. Click this link to display the
Category Alarm Properties page. For information on the input boxes displaying on that page, see View Alarm
Properties on page 186.

BW Sub Component This column displays the BroadWorks subcomponent source of the alarm.

Date/Time This column displays the date and time the alarm occurred.

Alarm Details This column displays the description of the detailed alarm.

Recommended Action This column displays the recommended action to address the alarm.

To access the network alarms:

1) Click the Fault tab.
2) Select the Network Alarms menu. The Network Alarms page appears.
To print this view of network alarms:
1) On the Network Alarms page, click Print Version. A PDF view of the current list of network alarms
appears in a new window.
2) From the File menu, click Print. The Print dialog box appears.
3) Select the printer and click Print.
4) Close the window.
To view the events related to an alarm:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 179
 1) On the Network Alarms page, click the check box for the alarm to access the related events.
2) Click View Events. The Events page displays the list of events related to this alarm.
To pick up an alarm:
1) On the Network Alarms page, click the check box for the alarm that you want to pick up for
investigation.
2) Click Pickup. The Alarms page displays the list of alarms without the alarm that you have picked up.

NOTE: To view the alarms that you have picked up, create a new child view with your user name in the
Operator text box.

NOTE: It is important to track any action you have taken to fix an alarm or any new information you
have gathered about the alarm. The Annotate option can be used to add notes to an alarm for future
reference. For example, you can enter the resolution to a problem as an annotation to the alarm, for
future reference. For information on annotating alarms, see View Alarm Properties on page 186 .

To "unpick" an alarm:
1) On the Network Alarms page, click the check box for the alarm that you want to "unpick" for
investigation. (In most cases, this is when you have resolved the problem associated with the alarm or
you want to allow another operator to investigate it.)
2) Click Unpick. The Alarms page displays the list of alarms including the alarm that you have "unpicked".
To clear an alarm:
An alarm can be cleared when it has been resolved or if it is inconsequential.
1) On the Network Alarms page, click the check box for the alarm that you want to change the status to
clear.
2) Click Clear. The Alarms page displays the list of alarms. The alarm that you have cleared appears at
the top of the list with its status changed to clear.
To delete an alarm:
You also have an option to delete an alarm when you feel that the alarm is not significant or the alarm
has been cleared. By default, the alarms that are in clear status for more than 24 hours are deleted and
this deletion occurs every 60 minutes automatically. However, if you want to manually delete the cleared
alarms, use this option.
1) On the Network Alarms page, click the check box for the alarm that you want to delete.
2) Click Delete. A dialog box appears requesting your confirmation.
3) Click OK. The Alarms page displays the list of alarms without the alarm that you deleted.
Tasks to perform from this page

5.3.1 Overview of Alarms

The EMS provides individual Network Operations Center (NOC) status and health status for each node on
the network. The NOC status refers to the existing alarm status based on the highest severity among all
outstanding server alarms. The default severities defined for the NOC status are informational, warning,
minor, major, and critical. In the typical monitoring of a production environment for a BroadWorks network,
any outstanding alarms of high severity (major and critical) require immediate attention.
The following illustrates alarm severity.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 180
5.3.2 Add Child View of Alarms
You can add/create a new view by specifying various criteria and providing a name for the view. The views
you create enable you to quickly monitor the devices you are interested in. Multiple views can also be
created to display a variety of information. For example, you can create a new view named MasterAlarms,
which shows only those alarms in a particular network. Within this MasterAlarms view, you can create
more views, such as ME1 and ME2. ME1 can have a different set of criteria, for example, only critical
events in that particular network. Deleting MasterAlarms deletes its child views (ME1, ME2, and so on) as
well.
Use the Add Alarm Child View page to add a child view of network alarms.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 181
 Figure 88: Add Alarm Child View

The information on this page includes the following:

Input Box Description

Child view name This text box describes this child view.

Severity These check boxes specify the severity levels of the alarms included in this view.

Previous Severity These check boxes specify the previous severity levels of the alarms included in this view.

Source This text box specifies the source of the alarms included in this view. Alarms are filtered based on
this source only. The source is either an IP address or a host name.

Source -- Alarm Name or This text box specifies the source, alarm name, or category of the events associated with this view.
Category Alarms are filtered based on this source, alarm name, or category only. The source is either an IP
address or a host name.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 182
 Input Box Description

Category This text box displays the category of the alarms included in this view. Alarms are filtered based on
this category only.

Owner This text box displays the owner associated with the alarms included in this view. The owner or an
alarm is the operator who has picked up an alarm to investigate. Alarms are filtered based on this
owner only.

Group Name This text box displays the name of the group associated with this view. Alarms are filtered based on
this group only.

From Last Modified This text box specifies the start date and time of the alarms included in this view based on the
modification date and time. The calendar icon provides the ability to specify the date and time in the
correct format.

To Last Modified This text box specifies the end date of the alarms included in this view based on the modification
date and time. The calendar icon provides the ability to specify the date and time in the correct
format.

From Created This text box specifies the start date and time of the alarms included in this view based on the
creation date and time. The calendar icon provides the ability to specify the date and time in the
correct format.

To Created This text box specifies the end date and time of the alarms included in this view based on the
creation date and time. The calendar icon provides the ability to specify the date and time in the
correct format.

Group View Mode This drop-down list specifies the type of group view to filter the alarms.
• "None" filters all group views of alarms.
• "Max" filters the maximum alarm in the group view.
• "Latest" filters the latest alarm in the group view.

NOTE: The EMS is currently not using the Group View functionality.

Alarm Age This combination box specifies the age of the alarms included in this view. The drop-down list
includes the following:
• "Any" filters all ages of alarms.
• "Age in Minutes" filters the age of alarms by the number of minutes identified in the text box.
• "Age in Hours" filters the age of alarms by the number of hours identified in the text box.
• "Age in Days" filters the age of alarms by the number of days identified in the text box.
• "Today" filters the age of alarms based on the day the view is executed.
• "Yesterday" filters the age of alarms based on the day before the view is executed.

Refresh Period in Minutes This text box specifies the frequency that the view is refreshed (in minutes).

To add a child view of alarms:

1) Click the Fault tab.
2) Select the Network Alarms menu. The Network Alarms page appears.
3) To create a child view, click Add Child View and complete the following:
• In the Child view name text box, type the name of this view.
• Under Severity, select the levels of severity to include in this view.
• Under Previous Severity, select the previous levels of severity to include in this view.
• To filter the view on a source, in the Source text box, type the IP address of the source of the events
to include in this view.
• To filter the view on a source, alarm name, or category, in the Source -- Alarm Name or Category
text box, type the alarm names or categories to include in this view.
• To filter the view on a category, in the Category text box, type the category of events to include in
this view.
• To filter the view on an owner, in the Owner text box, type the owner you want to include in this view.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 183
 • To filter the view on a group name, in the Group Name text box, type the group name to include in
this view.
• To filter the view on a last modified date, in the From Last Modified box, click the calendar icon and
select a start date for the modified alarms to include in this view.
• To filter the view on an end modified date, in the To Last Modified box, click the calendar icon and
select an end date for the modified alarms to include in this view.
• To filter the view on a creation date age, in the From Created box, click the calendar icon and select
a start date for the created alarms to include in this view.
• To filter the view on an end creation date, in the To Created box, click the calendar icon and select
an end date for the created alarms to include in this view.
• To filter the view on a group view mode, select the mode from the Group View Mode drop-down list.
• To filter the view on the age of alarms, select the age of the alarms from the Alarm Age drop-down
list and enter an integer value to include in this view.
• In the Refresh Period in Minutes box, specify the refresh frequency for this view.
4) Click Submit to create the child view. The name of the child view appears as a submenu of the Fault
Management menu in the left-hand navigation bar.

NOTE: Once you have added a view, you can remove it. To remove a child view, select the child view
from the Fault Management menu in the left-hand navigation bar and click Remove View. A message
appears asking for your confirmation. Click OK to remove the view.

5.3.3 Edit View Criteria of Alarms

1) Click the Fault tab.
2) Select the Network Alarms menu. The Network Alarms page appears.
3) To create a child view, click Edit View Criteria and complete the following:
• In the Child view name text box, type the name of this view.
• Under Severity, select the levels of severity to include in this view.
• Under Previous Severity, select the previous levels of severity to include in this view.
• To filter the view on a source, in the Source text box, type the IP address of the source of the events
to include in this view.
• To filter the view on a source, alarm name, or category, in the Source -- Alarm Name or Category
text box, type the alarm names or categories to include in this view.
• To filter the view on a category, in the Category text box, type the category of events to include in
this view.
• To filter the view on an owner, in the Owner text box, type the owner who you want to include in this
view.
• To filter the view on a group name, in the Group Name text box, type the group name to include in
this view.
• To filter the view on a last modified date, in the From Last Modified box, click the calendar icon and
select a start date for the modified alarms to include in this view.
• To filter the view on an end modified date, in the To Last Modified box, click the calendar icon and
select an end date for the modified alarms to include in this view.
• To filter the view on a creation date age, in the From Created box, click the calendar icon and select
a start date for the created alarms to include in this view.
• To filter the view on an end creation date, in the To Created box, click the calendar icon and select
an end date for the created alarms to include in this view.
• To filter the view on a group view mode, select the mode from the drop-down list.
• To filter the view on the age of alarms, select the age of the alarms from the drop-down list and enter
an integer value to include in this view.
• In the Refresh Period in Minutes box, specify the refresh frequency for this view.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 184
 4) Click Submit to save the changes. The name of the child view appears as a submenu of the Fault
Management menu in the left-hand navigation bar.

NOTE: Once you have added a view, you can remove it. To remove a child view, select the child view
from the Fault Management menu in the left-hand navigation bar and click Remove View. A message
appears asking for your confirmation. Click OK to remove the view.

5.3.4 Remove a View

To remove a view:
1) From a view page, click Remove View. A message asks for your confirmation.
2) To permanently remove this view, click OK. Click Cancel to return to the previous page.

5.3.5 Search
Use the Search page to search for alarms, events, or managed objects.

Figure 89: Advanced Search

To search:
1) From a view page, click Search and complete the following:
2) Select Match any of the Following to perform a search operation that satisfies any of the specified
matching criteria or select Match all of the Following to perform a search operation that satisfies all of
the specified matching criteria.
3) In the left-hand input box (Properties), select the property based on which you need to perform your
search. If you select the time property as a search criterion, the Date Input Helper icon appears. It can
help you quickly specify the time and date of interest.
4) In the middle input box (Condition), select the condition based on which you need to restrict your
search.
5) In the right-hand input box, type the exact information you are looking for. For example, if you have
selected severity in the Properties box, then you must specify the severity value here, such as "critical",
"major", and so on.
6) To specify additional criteria, click More and repeat steps 2 through 4. Fewer options can be used to
remove the criteria that were last added.
7) Click Search. Events satisfying the criteria appear.

5.3.6 Customize Columns of Child View

The properties are displayed as columns in the list view. You can add more columns or remove existing
columns in the events list view.
Use the Customize Columns page to customize the columns for a view of events, alarms, or managed
objects.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 185
 Figure 90: Customize Columns

To customize the columns of a view:

1) From a view page, click Customize Columns. The Customize Columns page appears.
2) To add new columns, select the property (based on which columns are created) from the Available
columns list and click the arrow pointing to the right. The property is moved to the Displayed columns.
Multiple properties can be selected using the CTRL+Click and SHIFT+Click options.
3) To remove existing columns, select the property from the Displayed columns list and click the arrow
pointing to the left. The property is moved to the Available columns list.
4) In the Displayed columns list, use the up and down arrows to order the columns in the view, from left to
right.
5) Click Apply. The list view is refreshed using your custom column arrangement.

5.3.7 View Alarm Properties

Use the Alarm Properties page to display the properties of an alarm.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 186
 Figure 91: Alarm Properties

To access the properties of a network alarm:

On the Network Alarms page, click the event to display its properties. The Alarm Properties page appears.
To view the related events for an alarm:
On the Alarm Properties page, click Events. The Network Events page displays the related events for this
alarm.
To pick up an alarm:
On the Alarm Properties page, click Pickup. The alarm is picked up.
To "unpick" an alarm:
On the Alarm Properties page, click Unpick. The alarm is "unpicked" and is available for others to pick up
for troubleshooting.
To clear an alarm:
On the Alarm Properties page, click Clear. The alarm is cleared.
To annotate an alarm:
1) On the Alarm Properties page, click Annotate. The Alarm Properties-Annotate dialog box appears.
2) In the Message text box, type the message that corresponds with the action(s) you have performed on
this alarm.
3) Click Annotate to save the message or Cancel to return to the previous page.
To view the history of annotations of an alarm:
On the Alarm Properties page, click Annotation & History The Annotation & History page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 187
 Figure 92: Annotation & History

To view the related alarms for an alarm:

On the Alarm Properties page, click Related Alarms The Related Alarms page appears.

Figure 93: Related Alarms

For more information

5.3.7.1 View Alarm Properties Reference

Input Box Description

Source -- Alarm Name or This text box specifies the source, alarm name, or category of the event associated with this alarm.
Category The source is either an IP address or a host name.

Source This text box specifies the source of the alarm. The source is either an IP address or a host name.

Created This text box displays the creation time stamp of the event.

Last Updated This text box displays the time stamp of the event last updated.

Severity This text box displays the current severity level of the alarm. Values include: Critical, Major, Minor,
Warning, Info, and Clear.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 188
 Input Box Description

Previous Severity This text box displays the previous severity level of the alarm.

Message This text box displays the message associated with the alarm.

Category This text box displays the category of the alarm.

Owner This text box displays the owner associated with this alarm. The owner or an alarm is the operator
who has picked up an alarm to investigate.

Group Name This text box displays the name of the group associated with this alarm.

EventName This text box displays the name of the event that relates to the alarm.

BroadWorksNode This text box indicates whether the node impacted by the alarm is a BroadWorks node.

BWTrapGenerated This text box specifies whether the event was generated by a BroadWorks node.

SourceTimeStamp This text box displays the time stamp of the event that is associated with this alarm.

BWClearable This text box specifies whether the alarm can be automatically cleared.

RecommendedAction This text box displays the recommended action pertaining to this alarm.

BWSubComponent This text box displays the BroadWorks subcomponent affected by this alarm.

BWMoSource This text box displays the managed object that generated the alarm.

5.4 Monitoring Syslog Events

Use the Syslog Events page to monitor syslog events.

NOTE: Among relevant syslog events, the "auth" and "sshd" messages may be of particular interest since
they report potential attempts of security breach.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 189
 Figure 94: Syslog Events

The information on this page includes the following:

Input Box Description

Status This column displays the status of the syslog event.

Source This column displays the source of the syslog event. Click this link to display the Event Properties
page.

Date/Time This column displays the date and time the syslog event occurred.

Event Details This column displays the details of the syslog event.

To access the syslog events:

1) Click the Fault tab.
2) Select the Syslog Events menu. The Syslog Events page appears.
To print this view of syslog events:
1) On the Syslog Events page, click Print Version. A PDF view of the current list of syslog events appears
in a new window.
2) From the File menu, click Print. The Print dialog box appears.
3) Select the printer and click Print.
4) Close the window displaying the list of syslog events.
To view the alarms for a syslog event:
1) On the Syslog Events page, click the check box for the event to access the related alarms.
2) Click View Alarms. The Alarms page displays the list of alarms related to this event.
Tasks to perform from this page

5.4.1 Add Child View of Syslog Events

You can add/create a new view by specifying various criteria and providing a name for the view. The views
you create enable you to quickly monitor the devices you are interested in. Multiple views can also be
created to display a variety of information. For example, you can create a new view named MasterEvents,
which shows only those events in a particular network. Within this MasterEvents view, you can create more
views, such as ME1 and ME2. ME1 can have a different set of criteria, for example, only critical events in
that particular network. Deleting MasterEvents deletes its child views (ME1, ME2, and so on) as well.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 190
 Use the Add (Syslog) Event Child View page to add a child view of syslog events.

Figure 95: Add (Syslog) Event Child View

The information on this page includes the following:

Input Box Description

Child view name This text box describes this child view.

Severity These check boxes specify the severity levels included in this view.

Source This text box specifies the source of the syslog events associated with this view. Syslog events are
filtered based on this source only.

Source -- Alarm Name or This text box specifies the source, alarm name, or category of the syslog events associated with
Category this view. Syslog events are filtered based on this source, alarm name, or category only.

Message This text box specifies the message that appears with syslog events included in the view.

Category This text box displays the category of the syslog events associated with this view. Syslog events
are filtered based on this category only.

Node This text box displays the node associated with this view. Syslog events are filtered based on this
node only.

Network This text box displays the network associated with this view. Syslog events are filtered based on
this network only.

Events generated after This text box specifies the start date of the syslog events included in this view. The calendar icon
provides the ability to specify the date in the correct format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 191
 Input Box Description

Events generated before This text box specifies the end date of the syslog events included in this view. The calendar icon
provides the ability to specify the date in the correct format.

Event Age This combination box specifies the age of the syslog events included in this view. The drop-down
list includes the following:
• "Any" filters all ages of syslog events.
• "Age in Minutes" filters the age of syslog events by the number of minutes identified in the text
box.
• "Age in Hours" filters the age of syslog events by the number of hours identified in the text box.
• "Age in Days" filters the age of syslog events by the number of days identified in the text box.
• "Today" filters the age of syslog events based on the day the view is executed.
• "Yesterday" filters the age of syslog events based on the day before the view is executed.

Refresh Period in Minutes This text box specifies the frequency the view is refreshed (in minutes).

To add a child view of syslog events:

1) Click the Faults tab.
2) Select the Syslog Events menu. The Syslog Events page appears.
3) Click Add Child View and complete the following:
• In the Child View Name text box, type the name of this view.
• Under the Severity box, select the levels of severity to include in this view.
• To filter the view on a source, in the Source text box, type the IP address of the source of the syslog
events to include in this view.
• To filter the view on a source, alarm name, or category, in the Source -- Alarm Name or Category
text box, type the alarm names or categories to include in this view.
• To filter the view on a message text, in the Message text box, type the message for the syslog
events to include in this view.
• To filter the view on a category, in the Category text box, type the category of syslog events to
include in this view.
• To filter the view on a node, in the Node text box, type the specific nodes that you want to include in
this view.
• To filter the view on a network, in the Network text box, type the network to include in this view.
• To filter the view on a start date, in the Events generate after box, click the calendar icon and select
a start date for the syslog events to include in this view.
• To filter the view on an end date, in the Events generated before box, click the calendar icon and
select an end date for the syslog events to include in this view.
• To filter the view on a syslog event age, in the Event Age box, select the type of syslog event age
from the drop-down list and type the corresponding number in the text box.
• In the Refresh Period in Minutes box, specify the refresh frequency for this view.
4) Click Submit to create the child view. The name of the child view appears as a submenu of the Fault
Management menu in the left-hand navigation bar.

NOTE: Once you have added a view, you can remove it. To remove a child view, select the child view
from the Fault Management menu in the left-hand navigation bar and click Remove View. A message
appears asking for your confirmation. Click OK to remove the view.

5.4.2 Edit View Criteria of Syslog Events

1) Click the Faults tab.
2) Select the Syslog Events menu. The Syslog Events page appears.
3) Click Edit View Criteria and complete the following:
• In the Child view name text box, type the name of this view.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 192
 • Under Severity, select the levels of severity to include in this view.
• To filter the view on a source, in the Source text box, type the IP address of the source of the syslog
events to include in this view.
• To filter the view on a source, alarm name, or category, in the Source -- Alarm Name or Category
text box, type the alarm names or categories to include in this view.
• To filter the view on a message text, in the Message text box, type the message for the syslog
events to include in this view.
• To filter the view on a category, in the Category text box, type the category of syslog events to
include in this view.
• To filter the view on a node, in the Node text box, type the specific nodes that you want to include in
this view.
• To filter the view on a network, in the Network text box, type the network to include in this view.
• To filter the view on a start date, in the Events generate after box, click the calendar icon and select
a start date for the syslog events to include in this view.
• To filter the view on an end date, in the Events generated before box, click the calendar icon and
select an end date for the syslog events to include in this view.
• To filter the view on a syslog event age, in the Event Age box, select the type of syslog event age
from the drop-down list and type the corresponding number in the text box.
• In the Refresh Period in Minutes box, specify the refresh frequency for this view.
4) Click Submit to save the changes. The name of the child view appears as a submenu of the Fault
Management menu in the left-hand navigation bar.

NOTE: Once you have added a view, you can remove it. To remove a child view, select the child view
from the Fault Management menu in the left-hand navigation bar and click Remove View. A message
appears asking for your confirmation. Click OK to remove the view.

5.4.3 Remove a View

To remove a view:
1) From a view page, click Remove View. A message asks for your confirmation.
2) To permanently remove this view, click OK. Click Cancel to return to the previous page.

5.4.4 Search
Use the Search page to search for alarms, events, or managed objects.

Figure 96: Advanced Search

To search:
1) From a view page, click Search and complete the following:
2) Select Match any of the Following to perform a search operation that satisfies any of the specified
matching criteria or select Match all of the Following to perform a search operation that satisfies all of
the specified matching criteria.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 193
 3) In the left-hand input box (Properties), select the property based on which you need to perform your
search. If you select the time property as a search criterion, the Date Input Helper icon appears. It can
help you quickly specify the time and date of interest.
4) In the middle input box (Condition), select the condition based on which you need to restrict your
search.
5) In the right-hand input box, type the exact information you are looking for. For example, if you have
selected severity in the Properties box, then you must specify the severity value here, such as "critical",
"major", and so on.
6) To specify additional criteria, click More and repeat steps 2 through 4. Fewer options can be used to
remove the criteria that were last added.
7) Click Search. Events satisfying the criteria appear.

5.4.5 Customize Columns of Child View

The properties are displayed as columns in the list view. You can add more columns or remove existing
columns in the events list view.
Use the Customize Columns page to customize the columns for a view of events, alarms, or managed
objects.

Figure 97: Customize Columns

To customize the columns of a view:

1) From a view page, click Customize Columns. The Customize Columns page appears.
2) To add new columns, select the property (based on which columns are created) from the Available
columns list and click the arrow pointing to the right. The property is moved to the Displayed columns.
Multiple properties can be selected using the CTRL+Click and SHIFT+Click options.
3) To remove existing columns, select the property from the Displayed columns list and click the arrow
pointing to the left. The property is moved to the Available columns list.
4) In the Displayed columns list, use the up and down arrows to order the columns in the view, from left to
right.
5) Click Apply. The list view is refreshed using your custom column arrangement.

5.4.6 View Syslog Event Properties

Use the (Syslog) Event Properties page to display the properties of a syslog event.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 194
 Figure 98: Syslog Event Properties

To access the properties of a syslog event:

On the Syslog Events page, click the event to display its properties. The Syslog Event Properties page
appears.
For more information

5.4.6.1 View Syslog Event Properties Reference

Input Box Description

Source -- Alarm Name or Category This text box displays the source (IP address or host name) and
name or category of the alarm.

Severity This text box displays the severity of the alarm. Values include:
Critical, Major, Minor, Warning, Info, and Clear.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 195
 Input Box Description

Id This text box displays the ID associated with the event.

Message This text box displays the message associated with the event.

Category This text box displays the category of the event.

Created This text box displays the creation time stamp of the event.

Group Name This text box displays the name of the group associated with the
event, if any.

Node This text box displays the node associated with the event.

Domain This text box displays the name of the domain associated with
the event, if any.

Network This text box displays the name of the network associated with
the event, if any.

BWTrapGenerated This text box specifies whether the event was generated by a
BroadWorks node.

BWMoSource This text box displays the managed object that generated the
event.

BWClearable This text box specifies whether the event can be automatically
cleared.

SourceTimeStamp This text box displays the time stamp of the time the event was
sent from the source.

BroadworksNode This text box specifies whether the node affected by the event
is a BroadWorks node. The value "true" indicates that it is a
BroadWorks node. The value "false" indicates that it is not a
BroadWorks node.

BwSubComponent This text box displays the subcomponent associated with the
event, if any.

EventName This text box displays the name of the event.

RecommendedAction This text box displays the recommended action associated with
the event.

5.5 Monitoring Syslog Alarms

Use the Syslog Alarms page to monitor syslog alarms.

Figure 99: Syslog Alarms

The information on this page includes the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 196
 Input Box Description

Status This column displays the status of the syslog alarm:

Source -- Alarm Name or This column displays the source and name/category of the alarm. Click this link to display the Alarm
Category Properties page. For information on the input boxes that appear on that page, see View Syslog
Alarm Properties on page 203.

Date/Time This column displays the date and time the network syslog alarm occurred.

Alarm Details This column displays the detailed description of the syslog alarm.

To access the syslog alarms:

1) Click the Fault tab.
2) Select the Syslog Alarms menu. The Syslog Alarms page appears.
To print this view of syslog alarms:
1) On the Syslog Alarms page, click Print Version. A PDF view of the current list of syslog alarms
appears in a new window.
2) From the File menu, click Print. The Print dialog box appears.
3) Select the printer and click Print.
4) Close the window.
To view the events related to a syslog alarm:
1) On the Syslog Alarms page, click the check box for the alarm to access the related events.
2) Click View Events. The Events page displays the list of events related to this alarm.
To pick up a syslog alarm:
1) On the Syslog Alarms page, click the check box for the alarm that you want to pick up for investigation.
2) Click Pickup. The Syslog Alarms page displays the list of alarms without the alarm that you have
picked up.

NOTE: To view the alarms that you have picked up, create a new child view with your user name in the
Operator text box.

NOTE: It is important to track any action you have taken to fix an alarm or any new information you
have gathered about the alarm. The Annotate option can be used to add notes to an alarm for future
reference. For example, you can enter the resolution to a problem as an annotation to the alarm, for
future reference. For information on annotating alarms, see View Syslog Alarm Properties on page
203 .

To "unpick" a syslog alarm:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 197
 1) On the Syslog Alarms page, click the check box for the alarm that you want to "unpick" for investigation.
(In most cases, this is when you have resolved the problem associated with the alarm or you want to
allow another operator to investigate it.)
2) Click Unpick. The Syslog Alarms page displays the list of alarms including the alarm that you have
"unpicked".
To clear a syslog alarm:
An alarm can be cleared when it has been resolved or if it is inconsequential.
1) On the Syslog Alarms page, click the check box for the alarm that you want to change the status to
clear.
2) Click Clear. The Syslog Alarms page displays the list of alarms. The alarm that you have cleared
appears at the top of the list with its status changed to clear.
To delete a syslog alarm:
You also have an option to delete an alarm when you feel that the alarm is not significant or the alarm
has been cleared. By default, the alarms that are in clear status for more than 24 hours are deleted and
this deletion occurs every 60 minutes automatically. However, if you want to manually delete the cleared
alarms, use this option.
1) On the Syslog Alarms page, click the check box for the alarm that you want to delete.
2) Click Delete. A dialog box appears requesting your confirmation.
3) Click OK. The Syslog Alarms page displays the list of alarms without the alarm that you have deleted.
Tasks to perform from this page

5.5.1 Add Child View of Syslog Alarms

You can add/create a new view by specifying various criteria and providing a name for the view. The views
you create enable you to quickly monitor the devices you are interested in. Multiple views can also be
created to display a variety of information. For example, you can create a new view named MasterAlarms,
which shows only those alarms in a particular network. Within this MasterAlarms view, you can create
more views, such as ME1 and ME2. ME1 can have a different set of criteria, such as only critical events in
that particular network. Deleting MasterAlarms deletes its child views (ME1, ME2, and so on) as well.
Use the Add (Syslog) Alarm Child View page to add a child view of syslog alarms.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 198
 Figure 100: Add (Syslog) Alarm Child View

The information on this page includes the following:

Input Box Description

Child view name This text box describes this child view.

Severity These check boxes specify the severity levels of the syslog alarms included in this view.

Previous Severity These check boxes specify the previous severity levels of the syslog alarms included in this view.

Source This text box specifies the source of the syslog alarms included in this view. Syslog alarms are
filtered based on this source only. The source is either an IP address or a host name.

Source -- Alarm Name or This text box specifies the source, syslog alarm name, or category of the events associated with
Category this view. Syslog alarms are filtered based on this source, syslog alarm name, or category only.
The source is either an IP address or a host name.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 199
 Input Box Description

Category This text box displays the category of the syslog alarms included in this view. Syslog alarms are
filtered based on this category only.

Owner This text box displays the owner associated with the syslog alarms included in this view. The owner
or a syslog alarm is the operator who has picked up a syslog alarm to investigate. Syslog alarms
are filtered based on this owner only.

Group Name This text box displays the name of the group associated with this view. Syslog alarms are filtered
based on this group only.

From Last Modified This text box specifies the start date and time of the syslog alarms included in this view based on
the modification date. The calendar icon provides the ability to specify the date and time in the
correct format.

To Last Modified This text box specifies the end date and time of the syslog alarms included in this view based on
the modification date and time. The calendar icon provides the ability to specify the date and time
in the correct format.

From Created This text box specifies the start date and time of the syslog alarms included in this view based on
the creation date and time. The calendar icon provides the ability to specify the date and time in the
correct format.

To Created This text box specifies the end date and time of the syslog alarms included in this view based on
the creation date and time. The calendar icon provides the ability to specify the date and time in the
correct format.

Group View Mode • "None" filters all group views of syslog alarms.
• "Max" filters the maximum syslog alarm in the group view.
• "Latest" filters the latest syslog alarm in the group view.

NOTE: The EMS is currently not using the Group View functionality.

Alarm Age This combination box specifies the age of the syslog alarms included in this view. The drop-down
list includes the following:
• "Any" filters all ages of syslog alarms.
• "Age in Minutes" filters the age of syslog alarms by the number of minutes identified in the text
box.
• "Age in Hours" filters the age of syslog alarms by the number of hours identified in the text box.
• "Age in Days" filters the age of syslog alarms by the number of days identified in the text box.
• "Today" filters the age of syslog alarms based on the day the view is executed.
• "Yesterday" filters the age of syslog alarms based on the day before the view is executed.

Refresh Period in Minutes This text box specifies the frequency that the view is refreshed (in minutes).

To add a child view of syslog alarms:

1) Click the Faults tab.
2) Select the Syslog Alarms menu. The Syslog Alarms page appears.
3) To create a child view, click Add Child View and complete the following:
• In the Child view name text box, type the name of this view.
• Under Severity, select the levels of severity to include in this view.
• Under Previous Severity, select the previous levels of severity to include in this view.
• To filter the view on a source, in the Source text box, type the IP address of the source of the events
to include in this view.
• To filter the view on a source, alarm name, or category, in the Source -- Alarm Name or Category
text box, type the alarm names or categories to include in this view.
• To filter the view on a category, in the Category text box, type the category of events to include in
this view.
• To filter the view on an owner, in the Owner text box, type the owner who you want to include in this
view.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 200
 • To filter the view on a group name, in the Group Name text box, type the group name to include in
this view.
• To filter the view on a last modified date, in the From Last Modified box, click the calendar icon and
select a start date for the modified alarms to include in this view.
• To filter the view on an end modified date, in the To Last Modified box, click the calendar icon and
select an end date for the modified alarms to include in this view.
• To filter the view on a creation date age, in the From Created box, click the calendar icon and select
a start date for the created alarms to include in this view.
• To filter the view on an end creation date, in the To Created box, click the calendar icon and select
an end date for the created alarms to include in this view.
• To filter the view on a group view mode, select the mode from the drop-down list.
• To filter the view on the age of alarms, select the age of the alarms from the drop-down list and enter
an integer value to include in this view.
• In the Refresh Period in Minutes box, specify the refresh frequency for this view.
4) Click Submit to create the list. The list appears and the name of the child view appears as a submenu.
Click Cancel to return to the previous list or click Reset to return to the previous values for the view.

NOTE: Once you have added a view, you can remove it. To remove a child view, click Remove View.
A message appears asking for your confirmation. Click OK to remove the view.

5.5.2 Edit View Criteria of Syslog Alarms

1) Click the Faults tab.
2) Select the Syslog Alarms menu. The Syslog Alarms page appears.
3) To create a child view, click Edit View Criteria and complete the following:
• In the Child view name text box, type the name of this view.
• Under Severity, select the levels of severity to include in this view.
• Under Previous Severity, select the previous levels of severity to include in this view.
• To filter the view on a source, in the Source text box, type the IP address of the source of the events
to include in this view.
• To filter the view on a source, alarm name, or category, in the Source -- Alarm Name or Category
text box, type the alarm names or categories to include in this view.
• To filter the view on a category, in the Category text box, type the category of events to include in
this view.
• To filter the view on an owner, in the Owner text box, type the owner who you want to include in this
view.
• To filter the view on a group name, in the Group Name text box, type the group name to include in
this view.
• To filter the view on a last modified date, in the From Last Modified box, click the calendar icon and
select a start date for the modified alarms to include in this view.
• To filter the view on an end modified date, in the To Last Modified box, click the calendar icon and
select an end date for the modified alarms to include in this view.
• To filter the view on a creation date age, in the From Created box, click the calendar icon and select
a start date for the created alarms to include in this view.
• To filter the view on an end creation date, in the To Created box, click the calendar icon and select
an end date for the created alarms to include in this view.
• To filter the view on a group view mode, select the mode from the drop-down list.
• To filter the view on the age of alarms, select the age of the alarms from the drop-down list and enter
an integer value to include in this view.
• In the Refresh Period in Minutes box, specify the refresh frequency for this view.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 201
 4) Click Submit to save the changes. The list appears and the name of the child view appears as a
submenu. Click Cancel to return to the previous list or click Reset to return to the previous values for
the view.

NOTE: Once you have added a view, you can remove it. To remove a child view, click Remove View.
A message appears asking for your confirmation. Click OK to remove the view.

5.5.3 Remove a View

To remove a view:
1) From a view page, click Remove View. A message asks for your confirmation.
2) To permanently remove this view, click OK. Click Cancel to return to the previous page.

5.5.4 Search
Use the Search page to search for alarms, events, or managed objects.

Figure 101: Advanced Search

To search:
1) From a view page, click Search and complete the following:
2) Select Match any of the Following to perform a search operation that satisfies any of the specified
matching criteria or select Match all of the Following to perform a search operation that satisfies all of
the specified matching criteria.
3) In the left-hand input box (Properties), select the property based on which you need to perform your
search. If you select the time property as a search criterion, the Date Input Helper icon appears. It can
help you quickly specify the time and date of interest.
4) In the middle input box (Condition), select the condition based on which you need to restrict your
search.
5) In the right-hand input box, type the exact information you are looking for. For example, if you have
selected severity in the Properties box, then you must specify the severity value here, such as "critical",
"major", and so on.
6) To specify additional criteria, click More and repeat steps 2 through 4. Fewer options can be used to
remove the criteria that were last added.
7) Click Search. Events satisfying the criteria appear.

5.5.5 Customize Columns of Child View

The properties are displayed as columns in the list view. You can add more columns or remove existing
columns in the events list view.
Use the Customize Columns page to customize the columns for a view of events, alarms, or managed
objects.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 202
 Figure 102: Customize Columns

To customize the columns of a view:

1) From a view page, click Customize Columns. The Customize Columns page appears.
2) To add new columns, select the property (based on which columns are created) from the Available
columns list and click the arrow pointing to the right. The property is moved to the Displayed columns.
Multiple properties can be selected using the CTRL+Click and SHIFT+Click options.
3) To remove existing columns, select the property from the Displayed columns list and click the arrow
pointing to the left. The property is moved to the Available columns list.
4) In the Displayed columns list, use the up and down arrows to order the columns in the view, from left to
right.
5) Click Apply. The list view is refreshed using your custom column arrangement.

5.5.6 View Syslog Alarm Properties

Use the Syslog Alarm Properties page to display the properties of a syslog alarm.

Figure 103: Syslog Alarm Properties

To access the properties of a syslog alarm:

On the Syslog Alarm page, click the event to display the properties. The Syslog Alarm Properties page
appears.
To view the related events for a syslog alarm:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 203
 On the Syslog Alarm Properties page, click Events. The Network Events page displays the related events
for this alarm.
To pick up a syslog alarm:
On the Syslog Alarm Properties page, click Pickup. The alarm is picked up.
To "unpick" a syslog alarm:
On the Syslog Alarm Properties page, click Unpick. The alarm is "unpicked" and is available for others to
pick up for troubleshooting.
To clear a syslog alarm:
On the Syslog Alarm Properties page, click Clear. The severity of the alarm is cleared.
To annotate a syslog alarm:
1) On the Syslog Alarm Properties page, click Annotate. The Alarm Properties-Annotate dialog box
appears.
2) In the Message text box, type the message corresponding with the action(s) you have performed on this
alarm.
3) Click Annotate to save the message or Cancel to return to the previous page.
To view the history of annotations of a syslog alarm:
On the Syslog Alarm Properties page, click Annotation & History. The Annotation & History page
appears.

Figure 104: Annotation & History

To view the related alarms for a syslog alarm:

On the Syslog Alarm Properties page, click Related Alarms. The Related Alarms page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 204
 Figure 105: Related Alarms

For more information

5.5.6.1 View Syslog Alarm Properties Reference

Input Box Description

Source -- Alarm Name or This text box specifies the source, alarm name, or category of the event associated with this alarm.
Category The source is either an IP address or a host name.

Source This text box specifies the source of the alarm. The source is either an IP address or a host name.

Created This text box displays the creation time stamp of the event.

Last Updated This text box displays the time stamp when the event was last updated.

Severity This text box displays the current severity level of the alarm. Values include: Critical, Major, Minor,
Warning, Info and Clear.

Previous Severity This text box displays the previous severity level of the alarm.

Message This text box displays the message associated with the alarm.

Category This text box displays the category of the alarm.

Owner This text box displays the owner associated with this alarm. The owner or an alarm is the operator
who has picked up an alarm to investigate.

Group Name This text box displays the name of the group associated with this alarm.

EventName This text box displays the name of the event that relates to the alarm.

BroadWorksNode This text box indicates whether the node impacted by the alarm is a BroadWorks node.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 205
 Input Box Description

BWTrapGenerated This text box specifies whether the event was generated by a BroadWorks node.

SourceTimeStamp This text box displays the time stamp of the event that is associated with this alarm.

BWClearable This text box specifies whether the alarm can be automatically cleared.

RecommendedAction This text box displays the recommended action pertaining to this alarm.

BWSubComponent This text box displays the BroadWorks subcomponent affected by this alarm.

BWMoSource This text box displays the managed object that generated the alarm.

5.6 Reference Information

This section describes the following:
EMS Trap List on page 206
Network Elements Alarms Clearing and Correlation on page 206
BroadWorks Faults Correlation on page 207

5.6.1 EMS Trap List

This section lists the traps generated by the EMS to report about its status.

NOTE: This list is not necessarily exhaustive.

Name Description Severity

bwPMElementManagementSystemFELaunched
BroadWorks EMS front-end process Info
started

bwPMElementManagementSystemFEShutDown
BroadWorks EMS front-end process shut Info
down

bwPMElementManagementSystemFERestarted
BroadWorks EMS front-end process Info
restarted

bwPMElementManagementSystemFEDeath BroadWorks EMS front-end process Critical

terminated

bwPMElementManagementSystemBELaunched
BroadWorks EMS back-end process Info
started

bwPMElementManagementSystemBEShutDown
BroadWorks EMS back-end process shut Info
down

bwPMElementManagementSystemBERestarted
BroadWorks EMS back-end process Info
restarted

bwPMElementManagementSystemBEDeath BroadWorks EMS back-end process Critical

terminated

bwSystemHealthReport General system status report Variable

bwCPUIdleTimeLimitReached The bwCPUMon tool has detected high Variable

central processing unit (CPU) usage on
the server.

5.6.2 Network Elements Alarms Clearing and Correlation

Upon receiving a bwServerStateTransition, the EMS can automatically clear most of the alarms associated
with a given BroadWorks network element.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 206
 The following table provides the list of alarms that are not automatically cleared by the EMS, and therefore
require a “Manual Clear”.
The type specifies which entity generated the alarm:
• For the network element (NE) type, the alarm is a one-to-one mapping to an NE fault.
• For the internal type, the alarm was generated by the EMS, applying correlation rules to NE faults. The
faults that caused the alarm have a different name.
Trap Name Type

bwGeneralSoftwareError NE

msSoftwareError NE

msSmtpFailure NE

bwSipAuthenticationFailure NE

bwCallPThreadAutoRestart NE

bwForcedExitDueToHungThread NE

bwLicenseAccntViolation NE

bwLicenseFileNotFound NE

bwLicenseAuthenticationFailure NE

bwLicenseFileExpiring NE

bwSMAPConnectionFailure NE

bwMSLicenseHWViolation NE

bwPMProvisioningServerStopped Internal

bwPMExecutionServerStopped Internal

bwPMMediaServerStopped Internal

bwPMNSProvisioningServerStopped Internal

bwPMNSExecutionServerStopped Internal

bwPMOpenClientServerStopped Internal

bwPMtomcatStopped Internal

bwNetworkDeviceIsFailed NE

bwServerLocked Internal

5.6.3 BroadWorks Faults Correlation

Most of the faults (events) reported by a BroadWorks network element are associated with a single alarm
on the EMS. However, there are some that are correlated and translated into a single alarm. Following is
the list of faults, the corresponding alarms, and expected behavior on the EMS:
Fault Alarm Additional Information

bwPMProvisioningServerShutDown bwPMProvisioningServerStopped The alarm is used to monitor the state of

the Application Server Provisioning Server
bwPMProvisioningServerDeath process. The alarm is set upon receiving
the shutdown and death events, while it
bwPMProvisioningServerRestarted is cleared by the launched and restarted
events.
bwPMProvisioningServerLaunched

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 207
 Fault Alarm Additional Information

bwPMExecutionServerShutDown bwPMExecutionServerStopped The alarm is used to monitor the state of

the Application Server Execution Server
bwPMExecutionServerDeath process. The alarm is set upon receiving
the shutdown and death events, while it
bwPMExecutionServerRestarted is cleared by the launched and restarted
events.
bwPMExecutionServerLaunched

bwPMMediaServerShutDown bwPMMediaServerStopped The alarm is used to monitor the state

of the Media Server main process. The
bwPMMediaServerDeath alarm is set upon receiving the shutdown
and death events, while it is cleared by
bwPMMediaServerRestarted the launched and restarted events.
bwPMMediaServerLaunched

bwPMNSProvisioningServerShutDown bwPMNSProvisioningServerStopped The alarm is used to monitor the state of

the Network Server Provisioning Server
bwPMNSProvisioningServerDeath process. The alarm is set upon receiving
the shutdown and death events, while it
bwPMNSProvisioningServerRestarted is cleared by the launched and restarted
events.
bwPMNSProvisioningServerLaunched

bwPMNSExecutionServerShutDown bwPMNSExecutionServerStopped The alarm is used to monitor the state

of the Network Server Execution Server
bwPMNSExecutionServerDeath process. The alarm is set upon receiving
the shutdown and death events, while it
bwPMNSExecutionServerRestarted is cleared by the launched and restarted
events.
bwPMNSExecutionServerLaunched

bwPMtomcatShutDown bwPMtomcatStopped The alarm is used to monitor the state

of the tomcat process that runs on the
bwPMtomcatDeath Application Server, the Network Server,
the Web Server, and EMS. The alarm
bwPMtomcatRestarted is set upon receiving the shutdown and
death events, while it is cleared by the
bwPMtomcatLaunched
launched and restarted events.

bwPMOpenClientServerLaunched bwPMOpenClientServerStopped The alarm is used to monitor the state of

the Open Client Server (OCS) process
bwPMOpenClientServerShutDown that runs on the Application Server, the
Web Server, and EMS. The alarm is set
bwPMOpenClientServerRestarted upon receiving the shutdown and death
events, while it is cleared by the launched
bwPMOpenClientServerDeath
and restarted events.

bwNetworkDeviceIsOnline bwNetworkDeviceIsFailed The alarm is used to report the fact

that a device is or is not reachable.
bwNetworkDeviceIsFailed The EMS parses the alarm text
and performs correlation between
a bwNetworkDeviceIsFailed and
a bwNetworkDeviceIsOnline,
based on the device information.
The bwNetworkDeviceIsOnline
is used to clear the corresponding
bwNetworkDeviceIsFailed alarm.
Note that there can be multiple
bwNetworkDeviceIsFailed active against
the same BroadWorks network element at
any given time.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 208
6 Configuring Nodes

This section provides information on how to configure nodes.

This section describes the following:
• About Configuration Management on page 209
• Performing Revision Handling on page 217
• Managing Node Configurations on page 218

6.1 About Configuration Management

The EMS Configuration Management feature provides centralized control of BroadWorks network element
configuration. You can view and set the parameters common to all nodes of a given type or override
the parameters for a specific node. The advanced mode provides control over all possible configuration
options of the network element. Currently, the advanced mode is supported only for specific BroadWorks
server types. The node configurations are stored in the EMS database and a configuration agent running
on the nodes communicates with a configuration manager implemented in the EMS to access them. The
key aspects of this feature operation are summarized as follows:
• Common configurations for the nodes of a given type permit the sharing of parameter values by all the
nodes of a type.
• Node configurations specifically override the values that differ from the common configuration on which
they are based.
• There is a controlled deployment of revisions. Modifying the configuration is a two-stage process
to have consistent configurations deployed on the nodes. First, the modifications to a number of
parameters are saved and a revision is created, and then the new revision is deployed to the nodes.
• A revision history of configurations is maintained. It is possible to browse old configurations and revert
to an old revision for a common or node configuration.
For more information

6.1.1 Configuration Management System Conventions

The Configuration Management feature has a unique interface. This section describes the following:
• Configuration Management Menus
• Configuration Management Pages
• Help on Parameters
Configuration Management Menus
The menus in Configuration Management work slightly differently from other areas of the EMS. They are
presented in a hierarchical folder structure. The following figure illustrates an example of a Configuration
Management menu expanded for the Xtended Services Platform.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 209
 Figure 106: Configuration Management Menu

To open a folder, click the plus (+) sign to the left of the folder. The menu expands and the corresponding
sign changes to a minus (-) sign to indicate that the folder is open.
Specific configuration pages are indicated with a blue circle to the left of the name of the page. Click the
name of the page to display the page.
Help on Parameters
From any page, you can obtain help for parameters. Click Help to the right of the parameter that you want
information on. A description of the parameter appears. The following figure illustrates an example of the
help for the File Collector of the Scheduler page.

Figure 107: Help on Parameters

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 210
6.1.2 Configuration Management Task Flow
1) Log in to the EMS and then access the Common Configuration menu on the Centralized Networking tab
through the Configuration Management interface.
2) Select the Common Configuration menu. The Common Configuration page appears.
3) Select the revision of the server type to configure.
4) Configure the common basic elements of the server type across the network. Basic configuration is
provided when the server is installed. However, from time to time this basic configuration may require
changing. Basic information includes addresses of other associated BroadWorks network elements,
system administration tasks, licensing, routing and treatments, configuration of emergency numbers,
and tracking of long duration call accounting events.
5) Configure the common interfaces. Basic configuration of interfaces used by the server is provided when
the server is installed. However, from time to time this basic configuration may require changing.
6) Customize the configuration of managed nodes (as required). Use the Node Configuration page to
select the node to customize. For information on node configurations, see Configure Nodes on page
214.
7) Manage the applications. To manage the applications, information management is necessary. It is the
administrator's responsibility to enter and maintain information such as groups, group members, and
group administrators.
8) Maintain the server. The day-to-day operations of the BroadWorks servers are monitored through
alarms, performance measurements, and shutdown and restart procedures.

6.1.3 Configure Common Server Types

Use the Common Configuration page to configure all of the common elements of a server type across your
network.

Figure 108: Common Configuration

The information on this page includes the following:

Column Description

Server Type This column displays the type of server.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 211
 Column Description

Deployed Revision This column displays the deployed common configuration

revision.

Deployed Revision Date This column displays the date the current configuration came
into effect.

Latest Revision This column displays the latest revision of the common
configuration. Note that a revision of the common configuration
may be created without being deployed.

To create a revision:
1) Click the Centralized Networking tab.
2) From the Configuration Management submenu, click Common Configuration. The Common
Configuration page appears.
3) Click the Server Type link.
4) Click Edit Latest to modify the latest revision of the common configuration.
5) Modify the common configuration for this node. Click Save Changes on each changed page.
6) Click Create Revision to create a revision of the common configuration. The Edit Revision page
appears.
7) Type a precise description of this new revision.
8) Click Save to save this description, Reset to reset the revision, or Cancel to cancel this description.
To compare revisions:
1) Click the Centralized Networking tab.
2) From the Configuration Management submenu, click Common Configuration. The Common
Configuration page appears.
3) Click the Deployed/Latest revision link of the server type that has the revisions to compare. The
Common Configuration Revisions page appears.

Figure 109: Common Configuration Revisions

4) Select the revisions to compare and click Compare Revisions. The configuration report for these two
revisions appears in a new window. Differences between the two revisions are highlighted.
5) To print the report, click Print.
a) To export the file to a Portable Definition Format (PDF) document:
a) Click Export PDF. A confirmation dialog box appears.
b) To save the PDF, click Save. To open the PDF, click Open. To return to the previous page, click
Cancel.
b) To export the file to a text file:
a) Click Export Text. A confirmation dialog box appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 212
 b) To save the file, click Save. To open the file, click Open. To return to the previous page, click
Cancel.
c) Close the window.
To generate a configuration report:
1) Click the Centralized Networking tab.
2) From the Configuration Management submenu, click Common Configuration. The Common
Configuration page appears.
3) Click the server type to report on.
4) Select the revision(s) to report on and click Configuration Report. The configuration report appears in
a new window.
5) To print the report, click Print.
a) To export the file to a Portable Definition Format (PDF) document:
a) Click Export PDF. A confirmation dialog box appears.
b) To save the PDF, click Save. To open the PDF, click Open. To return to the previous page, click
Cancel.
b) To export the file to a text file:
a) Click Export Text. A confirmation dialog box appears.
b) To save the file, click Save. To open the file, click Open. To return to the previous page, click
Cancel.
c) Close the window.
To deploy a revision:
1) Click the Centralized Networking tab.
2) From the Configuration Management submenu, click Common Configuration. The Common
Configuration page appears.
3) Select the server type by clicking on the check box next to the Server Type link.
4) Select the revision to deploy from the Deployed Revision drop-down list. The choices for the revision
deployment are the revisions between the version currently deployed (no change) and the latest
version.
5) Click Apply Changes to deploy this revision.

NOTE: Once a revision of the common configuration is deployed, it is not possible to roll back the
change, since this would potentially require deleting committed revisions of node configurations.
However, it is possible to create a new revision of the common configuration based on an earlier
revision rather than on the latest version, which reinstates the settings of that revision.
To cancel your changes, "uncheck" the check box in the row for the node type(s). A confirmation dialog
box appears if any unsaved changes are about to be lost.

To export a revision:
1) Click the Centralized Networking tab.
2) From the Configuration Management submenu, click Common Configuration. The Common
Configuration page appears.
3) Click the Deployed or Latest Revision link of a server type. The Common Configuration Revisions
page appears.
4) Click the Export link of the revision to export. The File Download dialog box appears.
5) Click Save. Open the export file with an XML Editor.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 213
 NOTE: Access the revision history for a node type by selecting the latest revision in the Deployed
Revision or Latest Revision column for the row of the desired server type.

6.1.4 Configure Nodes

Use the Node Configuration page to configure a specific node on your network.

Figure 110: Node Configuration

The information on this page includes the following:

Column Description

Node This indicates the node accessible through EMS.

Server Type This indicates the type of server.

BW Software Version This indicates the version of BroadWorks software.

Managed This indicates whether the mode is Managed (True) or

Unmanaged (False).

Auto-Deploy This indicates, when checked, that the node configuration is

deployed immediately.

Deployed Revision This indicates the revision currently deployed. Click to view the
history of revisions for this node.

Deployment Date This indicates the date of deployment.

Latest Revision This indicates the latest revision of the common configuration.

NOTE: A revision of the node configuration may be created

without being deployed.

Status This indicates the status of the node.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 214
 To generate a configuration report:
1) Click the Centralized Networking tab.
2) From the Configuration Management submenu, click Node Configuration. The Node Configuration
page appears.
3) Select the node to report on and click Configuration Report. The configuration report for this node
appears in a new window.
4) To print the report, click Print.
5) To export the file to a Portable Definition Format (PDF) document:
a) Click Export PDF. A confirmation dialog box appears.
b) To save the PDF, click Save. To open the PDF, click Open. To return to the previous page, click
Cancel.
6) To export the file to a text file:
a) Click Export Text. A confirmation dialog box appears.
b) To save the file, click Save. To open the file, click Open. To return to the previous page, click
Cancel.
7) Close the window.
To compare revisions:
1) Click the Centralized Networking tab.
2) From the Configuration Management submenu, click Node Configuration. The Node Configuration
page appears.
3) Select the revisions to compare and click Configuration Report. The configuration report for these two
revisions appears in a new window. The differences between the two revisions are highlighted.
4) To print the report, click Print.
a) To export the file to a Portable Definition Format (PDF) document:
a) Click Export PDF. A confirmation dialog box appears.
b) To save the PDF, click Save. To open the PDF, click Open. To return to the previous page, click
Cancel.
b) To export the file to a text file:
a) Click Export Text. A confirmation dialog box appears.
b) To save the file, click Save. To open the file, click Open. To return to the previous page, click
Cancel.
c) Close the window.
To create a revision:
1) Click the Centralized Networking tab.
2) From the Configuration Management submenu, click Node Configuration. The Node Configuration
page appears.
3) Select the node to configure. The name of the current revision appears.
4) Click Edit Latest to modify the parameters or configuration of this node.
5) Modify the configuration for this node. Click Save Changes on each changed page.
6) Click Create Revision to create a revision of the common configuration. The Edit Revision page
appears.
7) Type a precise description of this revision. Click Save to save this description, Reset to reset the
revision, or Cancel to cancel this description.
To deploy a revision:
1) Click the Centralized Networking tab.
2) From the Configuration Management submenu, click Node Configuration. The Node Configuration
page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 215
 3) Select the node of the revision to deploy.
4) Select the revision to deploy from the Deployed Revision drop-down list. The choices for the revision
deployment are the revisions between the version currently deployed (no change) and the latest
version.

NOTE: Once a revision of the node configuration is deployed, it is not possible to roll back the change,
since this would potentially require deleting committed revisions of node configurations. However, it is
possible to create a new revision of the common configuration based on an earlier revision rather than
on the latest version, which reinstates the settings in the earlier revision.

5) Click Apply Changes to deploy this revision.

6) To cancel your changes, "uncheck" the check box in the row for the node type(s). A confirmation dialog
box appears if any unsaved changes are about to be lost.
To export a revision:
1) Click the Centralized Networking tab.
2) From the Configuration Management submenu, click Node Configuration. The Node Configuration
page appears.
3) Click Edit Latest to export the latest revision.
4) Click Export. The File Download dialog box appears.
5) Click Save. Open the export file with an XML Editor.

NOTE: Access the revision history for a node type by selecting the latest revision in the Deployed
Revision or Latest Revision column for the row of the desired server type.

To configure a node:

NOTE: You can only configure a node that you currently manage.

1) Click the Centralized Networking tab.

2) From the Configuration Management submenu, click Node Configuration. The Node Configuration
page appears.
3) Click the node address link. The Node Configurations page appears. For more information on
configuring nodes, see the BroadWorks Common Configuration Guides.
To restart a node:
1) Click the Centralized Networking tab.
2) From the Configuration Management submenu, click Node Configuration. The Node Configuration
page appears.
3) On the Node Configuration page, select the check box of the node to restart.
4) Click Restart. The node restarts.

6.1.5 References to Common Configuration Documentation

Documents containing step-by-step procedures are available to configure BroadSoft servers through the
Common Configuration interface. These include the following:
• For information on configuring the Access Mediation Server through the EMS, see the BroadWorks
Access Mediation Server EMS Configuration Management Guide.
• For information on configuring the Application Server through the EMS, see the BroadWorks Application
Server Server EMS Configuration Management Guide.
• For information on configuring the Call Detail Server through the EMS, see the BroadWorks Call Detail
Server EMS Configuration Management Guide.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 216
 • For information on configuring the Database Server through the EMS, see the BroadWorks Database
Server EMS Configuration Management Guide.
• For information on configuring the Media Server through the EMS, see the BroadWorks Media Server
EMS Configuration Management Guide.
• For information on configuring the Network Server through the EMS, see the BroadWorks Network
Server EMS Configuration Management Guide.
• For information on configuring the Profile Server through the EMS, see the BroadWorks Profile Server
EMS Configuration Management Guide.
• For information on configuring the Xtended Services Platform through the EMS, see the BroadWorks
Xtended Services Platform EMS Configuration Management Guide.

6.2 Performing Revision Handling

The criterion to consolidate/archive revisions is the time (revisions older than a number of days) or the
number of revisions to keep. The consolidated revisions are no longer individually accessible after they
have been consolidated. It is not possible to view or select the old configurations to run on a node.
Only unused revisions can be consolidated with others. For a node configuration, a revision is used if
it is deployed on the node. For a common configuration, a revision is used if it is the base of a node
configuration revision.

Figure 111: Revision Handling

The information on this page includes the following:

Input Box Description

Mode This input box specifies the consolidation mode. When Automatic mode is selected, old revisions
that match the criteria are automatically consolidated on the server. In Manual mode, the user must
display this page, select the criteria, and click Archive Now to perform a consolidation.

Revisions This input box specifies the consolidation/archive criteria.

To configure how revisions are handled:

1) Click the Admin tab.
2) From the Configuration Management submenu, click Handle Revisions. The Handle Revisions page
appears.
3) To specify the mode for consolidating unused revisions, select Automatic or Manual.
4) To specify when revisions should be archived, in the Revisions section, select Older than <x> days, and
enter the number of days after which an unused revision should be archived.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 217
 5) To specify how many revisions to keep, in the Revisions section, select Keep <x> revisions, and enter
the number of revisions you want.
6) To archive revisions immediately, click Archive Now. To save your changes, click Save.

6.3 Managing Node Configurations

Use the Manage Node Configuration page to specify the nodes to manage.

Figure 112: Manage Node Configuration

The information on this page includes the following:

Input Box Description

Managed node available This list displays the nodes available to manage.

Managed node This list displays the nodes currently managed.

To configure the nodes to manage:

1) Click the Admin tab.
2) From the Configuration Management submenu, click Manage Node Configuration. The Manage
Node Configuration page appears.
3) To start managing a node, in the Manageable node available column, select the node to manage
and click Manage. The node appears in the Managed node column. Select Import Configuration to
preserve the configuration running on the node. When the node is managed with this option, the latest
common configuration is used as a base and it is compared with the configuration running on the
node. The changes are stored as configuration overrides that will be visible when editing the node
configuration thereafter.
4) To stop managing a node, select the node in the Managed node column and click Unmanage. The
node is removed from the Managed node column.

NOTE: You can select more than one node at a time.

5) Click Save to save the changes or Cancel to exit without saving.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 218
7 Configuring Security

This section provides information on authorization (including support for users, groups, roles, operations,
and object views) and secure authentication and access control, including the Secure Sockets Layer
(SSL).
This section describes the following:
• Configuring Users on page 219
• Configuring Groups on page 225
• Defining Schedules on page 229
• Stale User Accounts on page 231
• Assign Schedule to User on page 230

7.1 Configuring Users

Use the User Configuration page to configure users.

Figure 113: User Configuration

The information on this page includes the following:

Column Description

This icon provides a link to delete a user.

This icon provides a link to modify the user profile.

User This column provides a link to modify the user profile.

Group This column displays the name of the group(s) of which the user is a member.

Status This column displays the status of the user (green for "enabled" or gray for "disabled").

Active This column shows whether the user is currently active/logged on the EMS.

Assign To This icon provides a link to assign users to groups.

Operations Info This icon provides a link to assign operations to users.

To view users:
1) Click the Admin tab.
2) From the Security Administration submenu, click User Configuration. The User Configuration page
appears.
3) Select from the following type of users to view from the drop-down list:
• "All Users" to display all users
• "Active Users" to display active users
• "Inactive Users" to display inactive users

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 219
 The users appear on the list.
To delete a user:
1) Click the Admin tab.
2) From the Security Administration submenu, click User Configuration. The User Configuration page
appears.
3) Click the delete icon on the row of the user to delete. A confirmation dialog box appears. Alternatively,
you can first select a user by clicking the check box on the row of the user and then clicking the Delete
button.
4) Click Yes to delete the user or click No to return to the previous page.
To change the status of a user:
1) Click the Admin tab.
2) From the Security Administration submenu, click User Configuration. The User Configuration page
appears.
3) Click the check box on the row of the user to modify. More than one user can be selected.
4) Click Change Status and select the status from the drop-down list. The user's status is changed.
To assign a user to a group:
1) Click the Admin tab.
2) From the Security Administration submenu, click User Configuration. The User Configuration page
appears.
3) Click the Assign To icon on the row of the user to modify. The Modify Profile - New User page appears.
4) Use the arrow buttons to move the entries from the Available Groups list to Enrolled Groups list.
5) Click Submit to assign the user to the group(s), click Reset to reset the values to the previous values,
or click Cancel to return to the previous page.
To assign operations to a user:
1) Click the Admin tab.
2) From the Security Administration submenu, click User Configuration. The User Configuration page
appears.
3) Click the Operations icon on the row of the user to modify. The Operations Tree page appears.
4) Select the operations you would like to add or remove.
5) Click Save to save these changes or click Cancel to return to the previous page.
Tasks to perform from this page

7.1.1 Add User

Use the Add User page to add a user.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 220
 Figure 114: Add User

The information on this page includes the following:

Input Box Description

User name This input box specifies the name of the user.

Password This input box specifies the password for the user.

Re-type Password This input box confirms the password for the user.

Available group names This list displays the names of the groups to which the user can belong.

Add this user to a new This check box allows a user to be associated with a new group.
group

Password expires in days This input box specifies the number of days before the password expires.

Account expires in days This input box specifies the number of days before the account expires.

To add a user:
1) Click the Admin tab.
2) From the Security Administration submenu, click User Configuration. The User Configuration page
appears.
3) Click Add User. The Add User page appears.
4) In the User Name input box, enter the user's name.
5) In the Password input box, enter the user's password.
6) In the Re-type Password input box, re-enter the user's password.
7) Select the group(s) to assign the user to from the Available group names drop-down list. Press CTRL to
select multiple groups.
8) To add the user to a new group, click the check box and enter the name of the new group.
9) Select Password expires in and enter the number of days the password stays valid. If this check box is
not selected, then the password never expires.
10)Select Account expires in and enter the number of days the user account stays valid. If this check box is
not selected, then the user account never expires.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 221
 11)Click Add User to add this user, click Reset to reset the previous values, or click Back to return to the
previous page.

7.1.2 Modify User Profile

Use the Modify Profile page to modify a user profile.

Figure 115: Modify Profile

The information on this page includes the following:

Section Description

User Information This section displays the general user information.

Associated Groups This section displays the group information pertaining to the user.

Permitted Operations This section displays the permitted operations pertaining to the user.

To modify general information:

1) Click the Admin tab.
2) From the Security Administration submenu, click User Configuration. The User Configuration page
appears.
3) Click the user name on the row of the user to modify. The Modify Profile page appears.
4) Click Edit.
5) Modify the input boxes as required. The Modify password expiration field displays the number of days
the password stays valid. If this was not configured while creating the user, then "0" is displayed, which
means the password never expires. The Modify account expiration field displays the number of days the
user account stays valid. If this was not configured while creating the user, then "0" is displayed, which
means the user account never expires.
6) Click Submit to save these changes or click Cancel to return to the previous page.
To modify the associated groups:
1) Click the Admin tab.
2) From the Security Administration submenu, click User Configuration. The User Configuration page
appears.
3) Click the user name on the row of the user to modify. The Modify Profile page appears.
4) Click Associated Groups. The Associated Groups section is expanded. The Group Name section lists
the group(s) in which the user has already been enrolled.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 222
 5) Click Configure Group to add or delete associated group(s). The Modify Profile page appears.
6) Use the arrow buttons to move the entries from the Available Groups list to Enrolled Groups list.
7) Click Submit to assign/remove the user to/from the group(s), click Reset to reset the values to the
previous values, or click Cancel to return to the previous page.
To modify the permitted operations for a user:
1) Click the Admin tab.
2) From the Security Administration submenu, click User Configuration. The User Configuration page
appears.
3) Click the user name on the row of the user to modify. The Modify Profile page appears.
4) Click Permitted Operations. The Permitted Operations section is expanded. Under this section, the
Name column lists the operations for which the user is permitted and the Type column indicates the
type of permission for the corresponding operation (included or excluded).
5) Click Configure Operations. The Operations Tree page appears.
6) Select the operations you would like to add or remove.
7) Click Save to save these changes or click Cancel to return to the previous page.

7.1.3 Add Multiple Users

Use the Add Multiple Users page to add multiple users to groups.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 223
 Figure 116: Add Multiple Users

The information on this page includes the following:

Column Description

User Name This input box specifies the name of the user.

Selected Group This drop-down list indicates all the existing groups.

To add multiple users:

1) Click the Admin tab.
2) From the Security Administration submenu, click User Configuration. The User Configuration page
appears.
3) Click Add Multiple Users. The Add Multiple Users page appears. A maximum of 12 users can be
added on this page.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 224
 4) Enter the new names for the required number of users to the User Name input box.
5) Select the group(s) to assign the user to (as a member). The Selected Group drop-down list indicates
all the existing groups.
6) To apply a group to all users, select it for the first user and select Apply selected group to all users. All
users are members of that group.
7) Click Save to add these users or click Cancel to return to the previous page. Note that when multiple
users are added through this page, the default password assigned to each user is the same as the user
name.

7.2 Configuring Groups

Use the Group Configuration page to configure groups.

Figure 117: Group Configuration

The information on this page includes the following:

Column Description

This icon provides a link to delete a group.

This icon provides a link to modify the group profile.

Name This column specifies the name of the group.

Users This column specifies the name of the users in the group.

Operations This provides a link to assign operations to the group.

To delete a group:
1) Click the Admin tab.
2) From the Security Administration submenu, click Group Configuration. The Group Configuration page
appears.
3) Click the delete icon on the row of the group to delete. A confirmation dialog box appears. Alternatively,
you can first select a group by clicking the check box of the group row and then clicking the Delete
button.
4) Click Yes to delete the group or click No to return to the previous page.
To assign operations to a group:
1) Click the Admin tab.
2) From the Security Administration submenu, click Group Configuration. The Group Configuration page
appears.
3) Click the operations icon on the row of the group to modify. The Operations Tree page appears.
4) Select the operations you would like to add or remove.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 225
 5) Click Save to save these changes or click Cancel to return to the previous page.
Tasks to perform from this page

7.2.1 Add Group

Use the Add Group page to add a group.

Figure 118: Add Group

The information on this page includes the following:

Input Box Description

Group Name This input box specifies the name of the group.

To add a group:
1) Click the Admin tab.
2) From the Security Administration submenu, click Group Configuration. The Group Configuration page
appears.
3) Click Add Group. The Add Group page appears.
4) In the Group Name input box, enter the group name.
5) Select the operations options to include, exclude, or not authorize the operations for the user. In the
Operations Tree section, add or delete new operations and modify the permissions. The Operation Tree
Root lists all the existing operations that the group can be permitted. These operations will be inherited
by all the users belonging to this group.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 226
 6) Click Save to add this group or click Cancel to return to the previous page.

7.2.2 Modify Group

Use the Modify Profile page to modify a group.

Figure 119: Modify Group

The information on this page includes the following:

Section Description

Members This section displays the name and active status of users in the group.

Operation Settings This section displays the permitted operations pertaining to the group.

Custom View Scope This section displays the custom view scope pertaining to the group.

To modify members:
1) Click the Admin tab.
2) From the Security Administration submenu, click Group Configuration. The Group Configuration page
appears.
3) Click the group name on the row of the group to modify. The Group Profile page appears.
4) Click Edit.
5) Modify the input boxes as required.
6) Under the Members section, the users who have already enrolled in the group are displayed. To add
new member(s) or delete existing user(s), click Assign User. The Modify Profile window appears.
7) Use the arrow buttons to move the entries from the Available Users list to Enrolled Users list.
8) Click Submit to add/remove the user(s) to/from the group, click Reset to reset the values to the
previous values, or click Cancel to return to the previous page.
To modify the permitted operations of a group:
1) Click the Admin tab.
2) From the Security Administration submenu, click Group Configuration. The Group Configuration page
appears.
3) Click the group name on the row of the group to modify. The Group Profile page appears.
4) Click Operations Settings. In the Operations Settings section, the Name column lists the operations
for which the group is permitted, the Type column lists the type of permission for the corresponding
operation, and the Scope Setting column lists whether any custom view scope is set for this operation.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 227
 5) To modify the operations assigned to a group:
a) Click Configure. The Operations Tree page appears. The Operation Tree Root lists all the existing
operations that the group can be permitted. These operations will be inherited by the user belonging
to this group.
b) Select the options to include, exclude, and not authorize the operations for the group.
c) Click Save to save these changes or click Cancel to return to the previous page.
6) To add a scope to an operation:

NOTE: Authorized scopes (or authorized views) are independent entities that store the real
authorization information. The scopes are associated with the actual operations of the group
leading to fine-grained authorization for the user. Scopes consist of a set of properties, and the
scope is applicable only when these properties are true. For example, if you give a property as
network=192.168.4.0, the scope of that associated operation is applicable only for this network. These
scopes associated with the respective operations are grouped together under the groups and then
allocated to the users.

a) Click the Edit Operation Scope Settings icon on the row of the operation to modify. The Custom
View Scope Modify page appears.
b) In the Name input box, enter the property name.
c) In the Value input box, enter the property value.
d) Click Save to save these changes or Cancel to return to the previous page.
7) To modify a scope of an operation:
a) Click the Edit Operation Scope Settings icon on the row of the operation to modify. The Custom
View Scope Modify page appears.
b) Modify the Name and Value input boxes as required.
c) Click Save to save these changes or Cancel to return to the previous page.
8) To delete a scope of an operation:
a) Click the Edit Operation Scope Settings icon on the row of the operation to modify. The Custom
View Scope Modify page appears.
b) Click the Delete (X) icon next to the scope property that you want to delete.
c) Click Save to save these changes or Cancel to return to the previous page.
To modify the custom view scopes for a group:
1) Click the Admin tab.
2) From the Security Administration submenu, click Group Configuration. The Group Configuration page
appears.
3) Click the group name on the row of the group to modify. The Group Profile page appears.
4) Click Custom View Scope. Under the Custom View Scope section, the Authorized Scopes column lists
the custom view scopes authorized for this group.
5) To define new custom view scopes:
a) Select a scope name (module) from the drop-down list and click Add New Scope. Custom View
Scope - Modify page is displayed.
b) Enter the name for the new custom view scope in the Scope Name input box. In the Property Name
drop-down list, select the required property and enter the required value in the Property Value in the
input box.
c) Click More to add more properties and the Delete icon against the properties to remove them.
d) Click Save to add the new custom view scope or click Cancel to return to the previous page.
6) To assign or remove custom view scope(s) to/from a group:
a) Click Assign Scope. The Modify Profile window appears.
b) Use the arrow buttons to move the entries from the Available Scope list to Enrolled Scope list.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 228
 c) Click Submit to add the new scope or click Close to return to the previous page.
7) To delete a custom view scope:
a) Select the scope(s), by clicking the check box on the scope row. Click Delete.
b) Alternatively, click the Delete icon on the scope row. After confirming that you want to delete the
custom view scope, it is deleted from the database as well as from any group with which it was
associated.

7.3 Defining Schedules

Use the Schedules Wizard page to define schedules. Schedule templates are defined for one full week,
from Sunday to Saturday. You can specify one or more work shifts on each desired day.

Figure 120: Schedules Wizard

To define a new schedule:

1) Log in to the EMS Java client.
2) From the Tools menu, click Security Administration. The Security Administration page appears.
3) Click the Add Schedule icon on the toolbar. The Schedules Wizard window appears.
4) In the Enter the Schedule name (*) text box, type in a name for the schedule.
5) Click Next. The second page of the wizard appears.
6) Enter the Workday, Start Hour: Minute, and End Hour: Minute information for the schedule. A work
shift must start and end within the same day (0:00 and 23:59). The starting hour must be earlier than
the ending time. Once a schedule is created, it can be associated with a user along with the user time
zone. A schedule can span from one day to another by specifying two subsequent work shifts. For

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 229
 example, shift A (Monday 18:00 through 23:59) and shift B (Tuesday 0:00 through 5:00) are considered
subsequent and do not force the user out at midnight.
7) Click Finish. The new schedule appears in the Schedules tree of the Security Administration page.
For more information

7.3.1 Assign Schedule to User

Use the Assign Schedule/Override tab to assign a schedule to a user.

Figure 121: Assign Schedule/Override

The information on this page includes the following:

Input Box Description

Override Schedule This input box determines whether the schedule is replaced for the user. If this option is selected,
the access schedule is overridden for this user (the user has all-time access to the EMS). This is the
default value.

Assign a schedule for this If this option is selected, this user can only access EMS inside of the schedule defined by specified
user Schedule and Timezone input boxes.

To assign a schedule to a user:

1) Log in to the EMS Java client.
2) From the Tools menu, click Security Administration. The Security Administration page appears.
3) Select the user to assign the schedule to from the Users menu.
4) Click the Assign Schedule/Override tab.
5) Select Override Schedule (Default) to provide the user with all-time access to EMS. This is the default
state.
6) Select Assign a schedule for this user to provide the user with access to the system inside of the
specified schedule.
a) From the Schedule drop-down list, select the schedule to assign to the user.
b) From the Timezone drop-down list, select the time zone for the schedule.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 230
 7) Click Save. The user has the new schedule settings assigned.

7.4 Stale User Accounts

The EMS Stale Account Management feature uses a policy within the EMS to deactivate unused EMS
accounts. Using this feature, the service provider in maintaining their BroadWorks system, can ensure
that only valid accounts can be accessed. This feature addresses the need for removing unused accounts
caused by regular churn in personnel, change in affectations, and regional reorganization. The goal is
to perform a periodic check on all accounts and prevent invalid user accounts from being accessed.
Invalid accounts are identified when the last login date/time exceeds the user allowed login time credit. For
information on setting the expiration time (time credit limit), see Configure Miscellaneous Settings on page
302.

7.5 Security Breach Detection

The EMS generates a bwEMSLoginFailed alarm and deactivates the user account when a security breach
is detected, that is, when a subscriber enters an incorrect password for the same user more than three
consecutive times (default value).
Only an EMS administrator can re-enable an account.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 231
8 Monitoring Performance

This section provides information on how to monitor the performance of your network.
This section describes the following:
• Overview of Performance Monitoring on page 233
• Collecting Performance Data on page 234
• Monitoring Health Status on page 252
• Viewing Reports and Graphs of Statistics on page 265
• Monitoring JVM on page 270
• View the Performance Status of a Node on page 275
• Configure List of Statistics (Health Status) on page 276
• Configure List of Statistics (Daily) on page 282
• Configure Threshold Modifier Actions on page 288
About EMS Performance
The EMS automates and centralizes the configuration and polling of system-level performance commands
and data. This automation enables the EMS to auto-configure and poll system-level performance
commands on all managed objects. The EMS stores the consolidated data in its database. The goal is
to perform continuous monitoring, prevent unexpected failures, and keep the system in a healthy state.
As a result, an EMS administrator can take corrective actions before the system reaches specific limits.
Furthermore, the EMS provides a unique feature named Health Status Monitoring, which monitors the
health of the overall BroadWorks network. This functionality is based on recurrent distribution pattern of
threshold crossings. Every managed node has an overall node health status that may become green,
yellow, or red. The EMS also defines a group health status that has the same purpose but applies to the
server cluster level.
Monitoring Concepts
For all managed objects, the EMS provides individual Network Operations Center (NOC) status and health
status.
The NOC status refers to the existing alarm status based on the highest severity among all outstanding
alarms of a given managed object. The default severities defined for the NOC status are informational,
warning, minor, major, and critical. In the typical monitoring of a production environment for a BroadWorks
network, any outstanding alarms of high severity (major and critical) require immediate attention from the
NOC personnel.
The health status focuses on the performance status of a managed object. The server health status
aggregates the health status of a series of individual statistics (created from polling objects that match
specific criteria) for a given network element. Similar to the server health status, a group health status
aggregates a series of individual statistics for all servers of the same cluster. The default severities defined
for the health status are green, yellow, and red. In the typical monitoring of a production environment of a
BroadWorks network, outstanding health status (yellow and red) can be reviewed on a scheduled basis by
specialists in network performance analysis.
The NOC status and health status are not mutually exclusive. A threshold crossing can trigger a change
in both the server health status and NOC status if it is justified by the severity of the event. Such an event
requires immediate attention from the NOC personnel and prompts a review by a performance analyst as
soon as possible.
The summary of the Health Status and the NOC (Alarm) Status are provided on the left-hand dashboard of
the EMS web client.
This section focuses on the Health Status Monitoring feature. For more information about NOC Status,
please refer to section Managing Faults on page 167.
This section describes the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 232
8.1 Overview of Performance Monitoring
The EMS provides functionality to automatically poll any node (or group of nodes) on the network to
monitor its performance. The polled data is stored in the database. Once polled, data collected on nodes
can be presented in real-time or can be compared with other similar nodes across the network (for
example, compared with the data from all Application Servers). With the ability to perform continuous
monitoring with the EMS, you can prevent unexpected failures and keep the system in a healthy state by
taking corrective actions before the system reaches threatening limits.
The main input to network performance monitoring are the networks elements managed by the EMS.
These are created when discovery process or manual add node operation takes place and can be viewed
from the BW Network Maps of the Map tab. BW Network Maps hold details of all the managed network
elements such as Name, Type, status, and so on. As long as the communication between EMS and a
managed node can be established, data can be polled and collected for that node to ensure optimum
network performance.
EMS Performance module is made up of three main functional components:
• Data collection: apply data collection configuration, collect data.
• Monitoring: apply thresholds on collected data, monitor, send notifications on threshold rule violation.
• Reporting: control report generation.
Data Collection
Data is collected on the performance counters contained in nodes. For example, each node has a counter
that tracks the performance of the CPU of the node. For the purpose of performance monitoring, counters
are contained within polling objects.
The EMS provides a prepackaged configured collection of performance measurements (PMs). The list
of PMs was selected based on recommendations documented in the BroadWorks Maintenance Guide
. The specific list of prepackaged configured collections is expected to evolve over time and is likely to
change with releases of BroadWorks as BroadSoft’s understanding of performance impacting statistics
evolves. The prepackaged configured collection involves two main aspects: Packaging polling objects and
thresholds.
• A polling object defines equations based on SNMP or OSPM object identifier(s) (OIDs). A polling object
also defines a polling interval.
• A threshold defines conditions set for a polled object that trigger EMS actions.
There are two types of PMs in BroadWorks servers: Operating System (OS)-related and application-
related. OS-related PMs are used to monitor the performance of the operating system. SNMP-related PMs
are used to monitor the performance of BroadWorks applications, like the Provisioning Server.
Performance Monitoring
The EMS cumulates statistics computed from polling objects. Polling objects apply to all servers on the
network. However, you can edit the statistics of each server to refine the statistics that you want specifically
for each. The EMS also provides the ability to create or modify polling objects, thresholds and statistics for
other counters on BroadWorks nodes. The following functionalities are available to EMS users:
• Monitoring fault management for threshold crossing alarms
• Monitoring performance management for health status changes
• Plotting graphs from the cumulated statistics
Views of Performance Data
The EMS provides two types of views of the performance of nodes on the network. These include:
• Overall health status
• Detailed statistics

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 233
 The Health Status Monitoring feature monitors the health of the overall BroadWorks network. This
functionality is based on recurrent threshold crossings. Every server has an overall node health status
that may become green, yellow, or red depending on which thresholds have been crossed. The EMS also
defines a group health status that has the same purpose but applies to the server cluster level. A summary
of the health status is provided on the left-hand dashboard of the user interface. The health count provides
a view of the performance of the network. Counters that have exceeded their thresholds and indicate a
serious compromise of performance are evident immediately.
The health status functionality relies on three levels of health status: Basic (statistic), Node, and Group.
Upon a change in the health status of a node, the EMS can send an e-mail to automatically notify a list of
users. In addition, the EMS can send a performance daily report that lists all daily values for a specific list
of statistics.
The node health status aggregates the health status of a series of individual statistics (created from polling
objects that match specific criteria). Similarly, a group health status aggregates a series of individual
statistics for all nodes of the same cluster. In the typical monitoring of a production environment of a
BroadWorks network, outstanding health status (yellow and red) can be reviewed on a scheduled basis.
Individual detailed statistics are also available. These are used to assess performance trends.
Reporting of Statistical Data
You can generate report on any statistical data. Once a report is created, you can also view it as a graph.
For your convenience, Report on Key Statistics is also available to view the reports for key statistics for a
selected time period.

8.2 Collecting Performance Data

The EMS provides pre-configured polling objects with unique thresholds to collect performance data.
The prepackaged configured collection involves two main aspects: Packaging polling objects and
thresholds.
• A polling object defines equations based on Simple Network Management Protocol (SNMP) or
Operating System-level Performance Measurement (OSPM) object identifier(s) (OIDs). A polling object
also defines a polling interval.
• A threshold defines conditions set for a polled object that trigger the EMS actions.
The EMS cumulates statistics computed from defined polling objects. The following functionalities are
available to EMS users:
• Monitoring fault management for threshold crossing alarms
• Monitoring performance management for health status changes
• Plotting graphs from the cumulated statistics
For information on creating new polling objects, thresholds, or statistics, see Configure Data Collection on
page 234 .
For more information

8.2.1 Configure Data Collection

Configuring Data Collection is the process of deciding what data to collect, from which server, and in what
manner (that is, using which protocol). Use the Configured Collection page to configure data collection in
EMS.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 234
 Figure 122: Configured Collection

The information on this page includes:

Column Description

List This is the list of managed objects (groups or nodes).

Statistic Name This displays the statistics for the managed object. A description of each prepackaged statistic
follows.

Data Identifier This column displays the unique identification number of the polling objects from which data about
the node(s) is collected.

Community This column displays the community to be used when sending the SNMP request for collecting the
statistic.

Interval This column displays the interval at which data is collected for the statistic. For example, the value
"600" indicates that after every 600 seconds, data has to be collected.

Active This column specifies whether data collection for the selected node is active The possible values are
"true" or "false". If it is "false", data collection is not performed for that node.

Multiple This column specifies the type used to poll the columnar value of the tables.

User Name This column specifies the SNMP user name.

SNMP Version This column displays the SNMP version.

Context Name This column specifies the context name of the SNMP node.

The statistics are described as follows:

Statistic Description

INTERFACE_out_octets Displays the total number of octets transmitted out of the

interface, including framing characters.

INTERFACE_in_octets Displays the total number of octets received on the

interface, including framing characters.

emUsageSwap Displays the amount of virtual memory used.

messaging Displays the amount of memory swapped to disk per

second.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 235
 Statistic Description

virtualMemWaitThreads Displays the number of processes waiting for run time.

virtualMemBlkThreads Displays the number of processes of uninterrupted sleep.

virtualMemNumCPUs Displays the number of central processing units (CPUs).

waitThreadsRatio Displays the ratio of wait threads per CPU instance.

blockedVsWaitThreads Displays the difference between the blocked threads and

the wait threads.

diskUsageSlash Displays the disk usage for the "/ directory.

diskUsageBw Displays the disk usage for the "/bw" directory.

CPUBusy Displays the sum of CPUSys and CPUUsr.

CPUIdle Displays the percentage of the CPU idle time.

CPUSys Displays the percentage of the CPU used by the system.

CPUUsr Displays the percentage of the CPU used by the user

programs.

ASBusyHourCallAttempts Displays the number of call attempts per hour.

SOciRequestsInPerSecond Displays the number of Open Client Interface (OCI)

requests attempted per second.

iskUsageTmp Displays the disk usage for the "/tmp directory.

maxDiskIOSvc Displays the maximum disk IO service time.

maxDiskIOBusy Displays the maximum disk IO busy time.

maxDiskIOBsyVsSvc Displays the maximum disk IO busy versus service time.

axXsJavaHeap Displays the maximum ava heap used by the Execution

Server (XS).

totalXsJavaHeap Displays the Execution Server total Java heap size.

percentXsJHeap Displays the percentage of usage of the xecution Server

Java heap.

dsnInUse Displays the percentage of usage of the database store

name (DSN).

SOciAvgRequestDelay Displays the average time (in milliseconds, based on a

rolling average of the last 100 samples) it takes to process
an OCI request.

SOciMaxRequestDelay Displays the longest OCI request response time.

AStoSMTPtraffic Displays the total number of messages sent that are

attempted on the primary Simple Mail Transfer Protocol
(SMTP) server.

SNbOfUsers Displays the number of users configured on the node.

ASCallsPerSecond Displays the number of calls per second.

ASActiveCalls Displays the number of active calls on the node.

ASSysIntQueueTimeAvgCallHalf Displays the average call processing queue holding time

(in milliseconds).

SSysIntQueueTimeMaxCallHalf(msec) Displays the largest call processing queue sample holding

(in milliseconds).

SSysIntQueueTimeAvgRegAdapt(1000usec) Displays the average registration queue holding time (in

milliseconds).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 236
 Statistic Description

ASSysIntQueueTimeMaxRegAdapt(msec) Displays the largest registration queue sample holding (in

milliseconds).

ASSysIntQueueTimeAvgCallPThreadDBAccess(1000usec) Displays the average database access from the call

processing queue holding time (in milliseconds).

ASSysIntQueueTimeMaxCallPThreadDBAccess(msec) Displays the largest database access from the call

processing queue sample holding time (in milliseconds).

SSysIntQueueTimeAvgVoiceMailInAdapt(1000usec) Displays the average voice mail queue holding time (in
milliseconds).

SSysIntQueueTimeMaxVoiceMailInAdapt(msec) Displays the largest voice mail queue sample holding time
(in milliseconds).

SSysIntQueueTimeAvgAcctOutAdapt(1000usec) Display the average accounting queue holding time (in

milliseconds).

SSysIntQueueTimeMaxAcctOutAdapt(msec) Displays the largest accounting queue sample holding (in

milliseconds).

ASSipMsgPerSecond Displays the number of SIP messages (per second).

SSipRegistersInPerSecond Displays the number of SIP register messages (per

second).

ASSipOptionsPerSecond Displays the number of SIP option messages (per second).

ASSipSubscribeNotifyPerSecond Displays the number of SIP subscribe messages (per

second).

SSipAvgCallSetupDelay Displays the average time (in milliseconds) it takes

between the receipt of an INVITE message for the
origination of a new call and the transmission of an INVITE
(SiIPterminator), RQNT (MGCP terminator with in-band
ringback), or CRCX (MGCP terminator without in-band
ringback) to the primary device of the original called party
(for intragroup call) or to the network element of the original
called party (for a call to the PSTN).

ASSipMaxCallSetupDelay(msec) Displays the longest SIP setup-signal delay.

SSipAvgAnswerDelay(msec) Displays the average time (in milliseconds) between the

receipt of a 200 OK message indicating answer or an
NTFY off-hook indicating answer, and the transmission of a
200 OK indicating answer to the originator.

SSipMaxAnswerDelay(msec) Displays the longest SIP answer-signal delay.

SSysIntQueueTimeAvgSIPEncodeQ(1000usec) Displays the average SIP encoding queue holding time (in
milliseconds).

ASSysIntQueueTimeMaxSIPEncodeQ(msec) Displays the argest SIP-encoding queue sample holding (in

milliseconds).

SSysIntQueueTimeAvgSIPCallDecodeQ(1000usec) Displays the average SIP-decoding queue holding time (in

milliseconds).

ASSysIntQueueTimeMaxSIPCallDecodeQ(msec) Displays the argest SIP decoding queue sample holding (in
milliseconds).

SMgcpMsgPerSecond Displays the number of Media Gateway Control Protocol

(MGCP) messages (per second).

ASMgcpAvgDialToneDelay(msec) Displays the average MGCP dial tone delay time (in
milliseconds).

SMgcpMaxDialToneDelay(msec) Displays the largest dial tone delay time (in milliseconds).

ASMgcpAvgCallSetupDelay(msec) Displays the average MGCP call setup delay time (in
milliseconds).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 237
 Statistic Description

ASMgcpMaxCallSetupDelay (msec) Displays the argest MGCP call setup delay time (in
milliseconds).

ASMgcpAvgAnswerDelay(msec) Displays the average MGCP answer delay time (in

milliseconds).

ASMgcpMaxAnswerdelay(msec) Displays the largest MGCP answer delay time (in

milliseconds).

SSysIntQueueTimeAvgCallHalf(1000usec)T1 Displays the average call processing queue holding time

(in milliseconds).

ASSysIntQueueTimeMaxCallHalf(msec)T1 Displays the largest call processing queue sample holding

time (in milliseconds).

ASSysIntQueueTimeAvgMGCPEncodeQ(1000usec) Displays the average MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxMGCPEncodeQ(msec) Displays the argest MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeAvgCallHalf(1000usec)T2 Displays the average call processing queue holding time

(in milliseconds).

ASSysIntQueueTimeMaxCallHalf(msec)T2 Displays the largest call processing queue sample holding

time (in milliseconds).

ASSysIntQueueTimeAvgMGCPDecodeQ(1000usec) Displays the average MGCP decode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxMGCPDecodeQ(1000usec) Displays the largest MGCP decode queue delay time (in
milliseconds).

ASCapMsgPerSecond Displays the number of Client Application Protocol (CAP)

messages handled (per second).

ASNbOfMigratedUsers Displays the number of users migrated to the secondary

Application Server,

CPUUtilization Displays the CPU (system + user) utilization.

MemoryUtilization Displays the memory utilization.

Device_INTERFACE_out_octets Displays the number of octets sent over the network.

Device_INTERFACE_in_octets Displays the number of octets received over the network.

ReceiveErrors Displays the number of packets received in error.

TransmitErrors Displays the number of packets transmitted in error.

InDiscards Displays the number of incoming packets discarded.

OutDiscards Displays the number of outgoing packets discarded.

InterfaceOutUtilization Displays the percentage of the interface utilization in

output.

InterfaceInUtilization Displays the percentage of the interface utilization in input.

ASSysIntQueueTimeAvgSIPEncodeQ(1000usec)T1 Displays the average SIP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxSIPEncodeQ(msec)T1 Displays the largest SIP encode queue delay time (in
milliseconds).

SSysIntQueueTimeAvgSIPCallDecodeQ(1000usec)T1 Displays the average SIP call decode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxSIPCallDecodeQ(msec)T1 Displays the largest SIP call decode queue delay time (in
milliseconds).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 238
 Statistic Description

ASSysIntQueueTimeAvgMGCPEncodeQ(1000usec)T1 Displays the average MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxMGCPEncodeQ(msec)T1 Displays the largest MGCP encode queue delay time (in
milliseconds).

ASSysIntQueueTimeAvgVoiceMailInAdapt(1000usec)T1 Displays the average voice mail queue delay time (in
milliseconds).

ASSysIntQueueTimeMaxVoiceMailInAdapt(msec)T1 Displays the largest voice mail queue delay time (in
milliseconds).

SSysIntQueueTimeAvgRegAdapt(1000usec)T1 Displays the average registration queue delay time (in

milliseconds).

ASSysIntQueueTimeMaxRegAdapt(msec)T1 Displays the largest registration queue delay time (in

milliseconds).

NSCallpCallsPerSecond Displays the number of calls (per second).

NSSipStatsInviteIns Displays the number of SIP INVITES.

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)T1 Displays the average SIP redirect queue delay time (in
milliseconds).

NSSipMsgPerSecond Displays the number of SIP messages (per second).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec) Displays the average SIP encode queue delay time (in
milliseconds).

NSSysIntQueueTimeAvgSipDecodeQ(1000usec) Displays the largest SIP decode queue delay time (in
milliseconds).

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec) Displays the average SIP redirect queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipEncodeQ(msec) Displays the largest SIP encode queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipDecodeQ(msec) Displays the largest SIP decode queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec) Displays the largest SIP redirect queue delay time (in
milliseconds).

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)T2 Displays the average SIP redirect queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)T1 Displays the largest SIP redirect queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)T2 Displays the largest SIP redirect queue delay time (in
milliseconds).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)T1 Displays the average SIP encode queue delay time (in
milliseconds).

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)T2 Displays the average SIP encode queue delay time (in
milliseconds).

NSSysIntQueueTimeMaxSipEncodeQ(msec)T2 Displays the largest SIP encode queue delay time (in
milliseconds).

To access Configure Collection:

1) Click the Performance tab.
2) Click the Configured Collection menu item. The Configured Collection page appears.
Tasks to perform from this page

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 239
8.2.1.1 Configure Polling Objects
Purpose
A polling object contains the definition of the data collected to produce statistics, along with the additional
criteria pertaining to the types of nodes on the network.
A polling object contains the following two properties:
• Match Criteria: denotes the conditions to be satisfied by the server. Only when these conditions are
satisfied is the server considered for data collection. For example, isSNMP = true. This Match Criteria
denotes that the server must be an SNMP node.
• Data Collection Criteria: denotes the list of data to be collected from the server.
Use the Add Polling Object page to add a polling object.

Figure 123: Add Polling Object

The information on this page includes:

Input Box Description

Name of the Polling Object This input box specifies the name of the polling object. This name is shown as Policy Name on the
Statistics - Modify page of corresponding statistics.

Status This input box specifies the polling object status from a drop-down list. When the value is set to
"true", it is active and data collection for its associated polled data can be done. If set to "false", data
collection for the associated polled data is stopped. The default value is "true".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 240
 Input Box Description

Collected data for already This input box determines if you want to collect data for already polled nodes. When checked, it
polled nodes indicates that the polling object’s definition is applied over existing managed objects (MOs) and they
are updated with information given in polling objects. For example, you have 20 managed objects
existing and for each, you have two polled data added. Suppose you want to add two more polled
data for a particular set of managed objects. You can specify the match criteria in polling object and
information regarding the new polled data. If this check box is selected, as soon as a polling object
is added, for the existing managed objects that satisfy the match criteria, the two polled data are
added. If this option is unchecked, the polling object is used for newly created managed objects
only. The default value is "false".

Prefix This input box specifies the prefix. Normally the data identifiers are lengthy. For the identifiers
that have the starting “n” digits in common, you can specify that as prefix. For example, if two
statistics-IfSpeed and IfinOctect-the corresponding data identifiers are .1.3.6.1.2.1.2.2.1.5.1
and .1.3.6.1.2.1.2.2.1.10.1. You can see the first part, for example: .1.3.6.1.2.1.2.2.1 is common to
both. You can specify the common prefix as “1.3.6.1.2.1.2.2.1”. In the case of RFC 1213 MIB, even
if the prefix is not specified, the performance module will internally add a prefix to the identifier.

Polling Period (seconds) This input box specifies the time interval for periodic data collection (in seconds). For example,
if set to 5, it indicates that for all the data identifiers, data will be collected every 5 seconds. The
default value is 300 seconds.

User Class Name You can write your own Java class to define your own match criteria according to your requirement.
This class can be specified here to filter out managed objects. This feature requires JAVA coding
expertise. Please contact BroadSoft to create custom match criteria.

Match Criteria These combination input boxes specify the match criteria. When you specify a list of match criteria
based on MO properties, an implicit AND operation is performed among the results i.e., if you
specify 2 conditions, both of them have to be satisfied for the managed object to be considered for
data collection.
Below is a list of MO properties that can be used to set the match criteria.
status, type, managed, isGroup, isContainer, isSNMP, isDHCP, isRouter, isNode, isNetwork,
isInterface, sysName, sysOID, ifSpeed, ifDescr, ifIndex, BroadWorksServer, bwServerType, BW
Version, etc.

Data Collection Once it has been decided for which MOs data has to be collected, you have to choose the type of
data to be collected and the location. Data from the MO can be accessed from its agent, An agent
is a program running in the device which awaits data collection request.

Data Identifiers This input box lists the data identifiers to be collected. When a request is made to the agent for a
particular data, the corresponding OID (Object Identifier - A unique Identification number) has to be
supplied. An object identifier uniquely identifies specific characteristic of the Managed object. Hence
to collect the data you have to specify the OID for that characteristic. The term OID is generically
used as Data identifier. OID is SNMP-specific term.

SNMP OID This input box specifies the data OID to be collected. It could be a SNMP OID (e.g., 1 2.2.1.16.1
refers to IfOutOctects interface of instance 1) or OSPM OID. This input is mandatory.
The select button on the right allows to load a MIB and select a SNMP OID from the MIB tree.
You can form an expression using logical, arithmetic operators and existing Data identifiers. For
example, ( .1.3.6.1.2.1.2.2.1.10.1 + .1.3.6.1.2.1.2.2.1.16.1 ) / 2. The Configure Expression OIDs
link displays examples of Expression OIDs.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 241
 Input Box Description

Type This input identifies the type from a drop-down list. It can be set to “interface”, “node”, “multiple”, or
“none”.
Interface: This type has been exclusively made available for IF table entries of RFC 1213 MIB,
only. This is used when the object has many instances. When you want to collect data for all
the instances of an object, then you can choose the type to be Interface. Enter the data identifier
as .1.3.6.1.2.1.2.2.1.10. For every instance of the object, a PolledData will be created.
Node: If you know the fully qualified OID to collect data, then you can set the type as Node. For
example if you want to collect data for ifInOctets, instance 1, then choose this type and specify the
data identifier as .1.3.6.1.2.1.2.2.1.10.1.
Multiple: If you do not know how many instances exist for the OID, then this type can be used to
collect data for all the instances. As Interface type is specific to IF table entries; for other OIDs that
have multiple instances, you can choose the type as Multiple. Only one PolledData will be created
for the OID specified, but data collection will be done for all the instances.
Warning: Do not terminate the OID with a dot. If you do, then it will be treated as an invalid OID
and data will not be collected for it.
None: This is used when other protocols are used for data collection apart from SNMP.
The default value is "None".

Name This input box specifies the name for the data identifier. This name is also used as name for the
corresponding statistic created for managed objects that satisfy this polling object match criteria.
This input is mandatory.

Protocol This input box specifies the protocol used for data collection. If no value is specified, default
protocol SNMP will be assumed for data collection.

Interval This input box specifies the time interval for periodic data collection (in seconds). For example if set
to 2, data will be collected every 2 seconds. The default value is 300 seconds.

NOTE:
Case 1: If polling period (common property) and interval are specified, then interval value will take
precedence.
Case 2: If polling period is specified, but no interval, then polling period will be taken as interval.
Case 3: If neither polling period nor interval is specified, then default value (300) will be taken.

Threshold This input box specifies threshold application from a drop-down list. If it is set to "true", it indicates
that you want threshold to be applied on this identifier. If it is set to"false", it means you do not want
any threshold to be applied. The default value is "false".

Store Data This input box specifies if you want to store the data. Sometimes you may not want to store the data
collected for the data identifier. In this case, you can view the data only by Real Time monitoring
using Current Statistic Graph which is currently only available in the applet client. The default value
is "true".

More Properties Other properties that can be set for a data identifier.

Stats Data Table Name If the Collected data is of data type Long then it will be stored in STATSDATA table of the database.
The table will have the name and current date appended to it. For example if today's date is Aug
10 2003 then the table name will be STATSDATA8_10_2003. If you do not specify any input for
this property, then this will be the default behavior.
However, if you want to store data in some other table and not in the default STATSDATA, then you
can specify it in this field. For example, MyTable.
CAUTION: The table name which you specify here must have its structure already defined.

NOTE: You have to append a percentage symbol (%) to the table name like MyTable%. This
enables one table creation per day with the current date appended to the table name. If you do
not specify the % symbol, then no new table will be created everyday and data collected everyday
will be appended to the same table MyTable. This results in a big table after several days. It is
recommended to have separate tables for each day.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 242
 Input Box Description

String Data Table Name If the collected data is of data type String, then it will be stored in the STRINGDATA table of the
database. The table will have the name and current date appended to it. For example, if today's
date is Aug 10 2003 then the table name will be STRINGDATA8_10_2003. If you do not specify
any input for this property, then this will be the default behavior.
If you want to store data in another table and not in default STRINGDATA, then you must specify it.
For example, StringMyTable.
WARNING: The table name that you specify here must be already available with its structure
defined. The concept of appending % symbol applies for STRINGDATA table also.

Failure Threshold This input box specifies the number of consecutive failures after which, the threshold event should
be generated. This can be used in cases where a single Poll (data collection for the data identifier)
is not stable, for example, if the data identifier has a threshold associated and it is predicted
that the data collected can be cross checked 3 times. If the collected value still exceeds the
Threshold value, then it means that the collected data is stable and this may result in performance
degradation.

NOTE: If there is more than one threshold associated with the data identifier, then the collected
data has to exceed the same threshold consecutively “n” times, as specified in Failure Threshold.
Then only the Threshold Event will be generated.

The default value is 1.

Save Absolutes This input box specifies the save absolutes. This option is applicable only for Counter type OIDs.
By default, data collected for Counter-type OIDs is not stored as it is. The difference between
the previous data and latest data is collected and stored. If the exact value (absolute value) of
collected data has to be stored for Counter-type OIDs, then this check box should be checked.
Data collected for OIDs of other data types are saved as absolute values.
The default value is "false".

Time Average This input box determines whether the time average is calculated as (Latest collected value +
Previous value)/Difference in Data collection Time value. This is mostly calculated for Counter-
type and Gauge-type data identifiers where the data collected will be an incremental value, and
at one point, will reach the final value and reset to zero. As this reset may happen very often, it is
preferred that a delta value is derived from two consecutive polls. The default value is "false".

Active If this input box is set to "false", data collection will be temporarily stopped for this data identifier.
To resume data collection you will have to set it to "true". The default value is "true".

Save Poll Count This input box specifies the count, for example, only after “n” number of polls, data will be stored in
the database. This is used if the initial set of data collected for the data identifier is unstable and
may not be a correct measure of performance. The default value is "1".

Save On Threshold This input box determines whether the collected data is saved only when it exceeds threshold. The
default value is "False".

Available Thresholds This input box allows to specify the associated thresholds from the list of available thresholds. To
select several thresholds, click the entries you want while holding down the CTRL key.

To add a new polling object:

1) On the Configured Collection page, click Polling: Object: Add. The Add Polling Object page displays.
2) Enter the information as required. Please refer to the prepackaged polling objects for examples of the
fields values.
a) To add a data identifier, enter the applicable information under the Data Configuration and More
Properties sections. Click on the button Add. The new data identifier is added and displayed in the
Data Identifiers list.
b) To modify a data identifier, select it from the Data Identifiers list. Modify the required input boxes
under the Data Configuration and More Properties sections. Click on the button Modify to save the
changes.
3) Click Submit. The polling object is added.
To modify a polling object:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 243
 1) On the Configured Collection page, click Polling Object: Modify. The Modify Polling Object page
appears.
2) Select the Polling Object to modify from the list on the left-hand side of the page. The Polling Object
Properties page appears.
3) Modify the required input boxes.
a) To add a data identifier, enter the applicable information under the Data Configuration and More
Properties sections. Click on the button Add. The new data identifier is added and displayed in the
Data Identifiers list.
b) To modify a data identifier, select it from the Data Identifiers list. Modify the required input boxes
under the Data Configuration and More Properties sections. Click on the button Modify to save the
changes.
4) To save the changes, click Submit. To disregard the changes, click Reset. Click Cancel to return to the
previous page.
To delete a polling object:
1) On the Configured Collection page, click Polling Object: Delete. The Delete Polling Object window
pops up.

NOTE: If you delete a Polling Object that is included with the EMS at the time of purchase, you will
seriously compromise the reporting of statistics. You should only delete Polling Objects that have been
created since the EMS was installed on your premises.

2) Select the Polling Object from the drop-down list.

3) Click Delete. The Polling Object is removed as well as all its associated statistics.

8.2.1.2 Configure Thresholds

Purpose
A threshold defines conditions set for a polled object that trigger EMS actions. Once data collection starts,
collected data is stored in the database for future reference. To monitor network performance, you need to
check if the collected data is optimal. For example, the optimal speed of switch Rk5 should be 100000 to
be considered efficient. Hence, to perform such checks, you need to define thresholds.
A threshold contains a value as the maximum or minimum limit for the collected data. If the collected data
from the device exceeds this limit, it means the device performance is degrading. You need to understand
how to create thresholds and associate them with the data to be monitored.

NOTE:
Thresholds of category “License Monitoring” are available from this page but it is highly recommended not
to perform any operation on the license monitoring threshold from here. It should be done, instead, from
theConfigure Thresholds on page 445 page.

Use the Add Threshold page to add a threshold.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 244
 Figure 124: Add Threshold

The information on this page includes:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 245
 Property Description

Kind This input box specifies the kind of threshold from a drop-down
list: Long, String or Percentage.
Long: Threshold can be associated with data identifiers for
which the collected data is of type long. Some of such sample
data identifiers are IfAdminStat, IfOperStat, etc in RFC 1213
MIB. The value you provide for this threshold will be compared
as it is with the data collected for the identifier.
String: These thresholds are for comparing string type of
collected values. The fields Allowed Values and Disallowed
Values are specific to String thresholds. When the collected
value is any one of the strings given in Disallowed Values field
(comma separated), an event of specified Trigger Severity will
be generated. Likewise, when the value is any one string in
Allowed Values field, an event of specified Reset Severity will be
generated.
Percentage: These thresholds are used when the value
collected from an OID is to be compared against value of
another OID. The comparision is to be given in terms of
percentage.
For example, depending upon the toner level you want to set the
number of pages to be loaded in a printer. When the toner level
is 80% of the number of pages to be printed, you may like to be
notified. To achieve this perform the following:
1) Create a statistic for the toner level.
2) Create a percentage threshold with a Threshold Value 80
and ObjectID corresponding to the OID of "Number of pages
in the printer".
3) Associate this threshold object to the statistic created in
step 1. When data collected for the toner level statistic
iscompared with the Threshold value, since the Threshold
type is percentage, data is collected for the threshold
ObjectID. Then the toner level value will be divided by the
number of pages value and the result multiplied by 100, thus
giving a percentage. This resultant value will be compared
with 80 (the Threshold value).

Name This input box specifies the name of the threshold.

Category This input box specifies the category of the event to be

generated. When managed objects are added to the database,
an event can be generated. This event may be named
“AddMOevent”. Similarly, you can also name the generated
threshold Events. This name will be used by fault module for
Event handling and for appropriate notification. By default, the
word “Threshold” is used for identifying threshold events.

Severity This input box specifies the severity of the event generated
when threshold value is exceeded. This field is applicable only
to threshold objects whose Kind value is "long" or "percentage".
The following severitues are supported: Critical, Major, Minor,
Warning, and Clear.

Threshold Type This input box specifies the type of threshold value you are
going to specify. This field is applicable only to threshold
objects whose Kind value is "long" or "percentage". Possible
values are Max, Min, or Equal. Max: If the collected value
exceeds the threshold value, an event will be generated. Min:
If the collected value is less than the threshold value, an event
will be generated. Equal: If the collected value is equal to the
threshold value, an event will be generated.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 246
 Property Description

Threshold Value This input box specifies the threshold value. In case of threshold
defined for long values, the data collected for the OID is
compared with this value. In case of percentage thresholds,
the result of (first OID / second OID) * 100, for example, a
percentage value, is compared with this value.This field is
applicable only to threshold objects whose Kind value is "long"
or "percentage".

Rearm Value This input box specifies the rearm value. You can enter an
integer here that denotes that when the collected value or
calculated value (in case of % thresholds) reaches the rearm
value, the violated threshold is brought back to normalcy and
a clear event will be generated. This field is applicable only to
threshold objects whose Kind value is "long" or "percentage".

Send Clear This input box determines whether "Clear" events are generated
on threshold reset from the drop-down list. If it is set to "False",
when the threshold is reset (rearmed), no information will be
displayed on the Events page.This field is applicable only to
threshold objects whose Kind value is "long" or "percentage".

Message This input box specifies a string that is displayed on the Events
page when the threshold value is exceeded. This input is
optional, the default value is "Threshold exceeded".

Clear Message This input box specifies a string that is displayed on the Events
page when the threshold is reset (rearmed). This input is
optional, the default value is "Threshold reset".

Trigger Severity This input box specifies the severity of the event generated for
threshold objects of kind string. The following severitues are
supported: Critical, Major, Minor, Warning, and Clear.

Reset Severity The severity to be generated for the threshold object of the
kind string, when the previous severity is cleared. The following
severitues are supported: Critical, Major, Minor, Warning, and
Clear.

ObjectID This input box specifies the OID from which the value should be
obtained to calculate the percentage. This field is applicable only
to threshold objects whose Kind value is "percentage".

ObjectID Type This input box specifies the type of the oid (.ie., whether it is of
type node, interface or multiple). It is applicable for threshold
objects of kind percentage.
Warning: The type of identifier you choose here should be the
same as that of the identifier on which this Threshold is going
to be applied. Otherwise, when division of the two values take
place, invalid resultant value will be generated.

To add a threshold:
1) On the Configured Collection page, click Thresholds: Add. The Threshold - Add page displays.
2) Enter the information as required.
3) Click Add. The threshold is created and can be associated to a polling object.
To modify a threshold:
1) On the Configured Collection page, click Threshold: Modify. The Threshold - Modify page displays.
2) Select the threshold to modify from the Available Thresholds drop-down list.
3) Modify the input boxes.
4) To save the changes, click Submit. To disregard the changes, click Reset. Click Cancel to return to the
previous page.
To delete a threshold:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 247
 1) On the Configured Collection page, click Threshold: Delete. The Threshold - Delete page displays.

NOTE: If you delete a threshold that is included with the EMS at the time of purchase, you will
seriously compromise the reporting of statistics. You should only delete thresholds that have been
created since the EMS was installed on your premises.

2) Select the threshold to delete from the drop-down list.

3) Click Submit. The threshold is removed.

8.2.1.3 Configure Statistics

Overview
Statistic can be created either with a Polling object definition or directly for a Managed object with the
Statistics - Add function.
Once a node is discovered or added on EMS, a set of statistics is automatically assigned to it. On the
left-hand side of the Configured Collection page, you can see the list of managed servers and groups of
servers on the network. Each of these has statistics associated with it.
Statistics can also be created through Polling Objects creation at runtime. But if you want to monitor extra
information and you want the data to be collected for a specific managed object. In such a situation, you
prefer adding a new Statistic to the system. When you need to add a Statistic for a few nodes, the best
way is to use the Statistics - Add function.
You can also modify or delete existing statistics that you no longer need.
Use the Add Statistic page to add a statistic.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 248
 Figure 125: Add Statistic

The information on this page includes:

Input Box Description

Name This input box specifies the name of the statistic. This input is
mandatory

Snmp Version This input box determines the SNMP version. If you choose
V3, two more fields labeled User Name and Context Name are
available. The default value is "v1".

Agent This input box specifies the agent. This input is mandatory.
Normally, a device will have one agent in it to collect device
data, where device name and agent name will be same. Hence,
you can specify the device name as agent name. Example:
netwserver01.
If you are adding Statistic via UI, ensure that agent name and
DNS name are set.

Period This input box specifies the time interval for periodic data
collection (in seconds). This input is mandatory. The default
value is "300".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 249
 Input Box Description

Port This input box specifies the port number to which the EMS can
send the request to the managed nodes for data collection.
When the "Statistics - ADD" page is opened, the value displayed
for this parameter is 161. You must change it to 8001 which is
the default SNMP port used by all Broadworks servers except
EMS server which uses port 8002.

OID This input box specifies a unique Object Identifier string that
represents a MIB entry. Data is collected for this identifier.
An SNMP-specific Data identifier is called OID. This input is
mandatory.

Is MultiplePolledData This input box determines if the statistic relies on multiple polled
data. Select "true" if Data Identifier is of type multiple.

Active This input box determines whether data collection will start for
this statistic. The default value is "True".

Parent Object This input box specifies the name of the managed object which
acts as the parent for this statistic.

Protocol This input box determines the protocol used for data collection,
SNMP or OSPM. The default value is SNMP.

Community This input box specifies the SNMP read community.

Write Community This input box specifies the SNMP write community.

Data Collection Properties

DNS Name This input box specifies the name of the device from which data
has to be collected. Example: netwserver01.

Policy Name This input box displays the name of the policy which correspond
to the Polling Object name It is relevant only to statistics created
through polling objects.

Threshold This input box determines whether to apply threshold on this

statistic. The default value is "False".

Threshold List This input box determines which threshold(s) is(are) applied on
this statistic.

Current Save Count This input box specifies the current save count used for internal
purpose only.

Failure Count This input box specifies the failure count.

Save Absolute This option is applicable only for Counter type OIDs. By default,
data collected for Counter type OIDs is not stored as it is. The
difference between the previous data and latest data is collected
and stored. If the exact value (absolute value) of collected data
has to be stored for Counter type OIDs then this option should
be selected (checked). Data collected for OIDs of other data
types is saved as absolute values. The default value is "False".

Poller Name This input box specifies the poller name.

Save This input box determines whether collected data is stored in the
database. The default value is "True".

Data Store & Custom Properties

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 250
 Input Box Description

StatsDataTableName If the Collected data is of data type Long then it will be stored
in STATSDATA table of the database. The table will have
the name and current date appended to it. For example
if today's date is Aug 10 2003 then the table name will be
STATSDATA8_10_2003. If you do not specify any input for this
property, then this will be the default behavior.
However, if you want to store data in some other table and not in
the default STATSDATA, then you can specify it in this field. For
example, MyTable.
CAUTION: The table name which you specify here must have
its structure already defined.

NOTE: You have to append a percentage symbol (%) to the

table name like MyTable%. This enables one table creation per
day with the current date appended to the table name. If you
do not specify the % symbol, then no new table will be created
everyday and data collected everyday will be appended to the
same table MyTable. This results in a big table after several
days. It is recommended to have separate tables for each day.

ID This input box specifies the ID number of the statistic as stored

in table PolledData of the database. The number is assigned
automatically when the statistic is created.

Log Directly This input box determines whether collected data is stored in flat
files rather than storing them in database. The default value is
"false".

Log File Name This input box specifies the name of the log file to store
collected data.

Save Poll Count This input box specifies the integer (n), during every nth poll, the
collected data will be stored. The default value is "1".

Failure Threshold This input box specifies the failure threshold. This indicates the
number of consecutive failures after which the threshold event
should be generated.

Save On Threshold This input box determines whether the collected data is saved
only when it exceeds threshold. The default value is "false".

Owner Name This input box specifies a string to denote the owner of the
statistic.

Time Average This input box determines whether the Time Average is
calculated as (Latest collected value - Previous value ) /
Difference in Data collection Time value. This is mostly
calculated for Counter type OIDs where the collected data will
be an incremental value and at one point will reach the final
value and reset to Zero. As this reset may happen soon and
very often, it is preferred that a Delta value is derived from two
consecutive Polls. The default value is "false".

To view or modify the configured statistics for a node or group:

1) On the Configured Collection page, click the node or group whose statistics you want to display. The
statistics display.
2) Click Edit on the section to modify.
3) Modify the input boxes as required.
4) Click Submit to save the changes.
To delete a configured statistics for a node or group:
1) On the Configured Collection page, click the node or group whose statistics you want to delete.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 251
 2) Click Statistics: Delete.
To add a configured statistic for a node or group:
1) On the Configured Collection page, click the node or group to add a statistic to.
2) Click Statistics: Add. The Add Statistic page displays.
3) Enter information in the input boxes, as required. Please refer to existing defined statistics for examples
of values that can be put for each parameter.
4) To save the changes, click Submit. To disregard the changes, click Reset. Click Cancel to return to the
previous page.

8.2.1.4 About Polling Objects and Statistics

Polling Object versus Statistic
A statistic is the unit of data collection,that is when you specify what data to be collected in Polling Object,
a statistic is created for each of the definition of what data to be collected and using this statistic, data is
collected and stored in the database. Statistic can be created either through the Polling Object definition or
directly for a managed object with the Statistics - Add function.
Using PollingObject:
• The value set for status property of a Polling Object will reflect upon the statistic.
• The set of statistics will be treated as a single group and deletion of a Polling Object will automatically
delete the associated statistics.
• It is useful when you want to create many statistics for an individual Managed Objects wherein the
Pollin gObject's match criteria will satisfy the Managed Object properties.
Directly via Statistics - Add:
• Only one statistic can be added at a time for a Managed Object and each has to be modified and
deleted individually.
• Suitable when less number of statistics are to be created.
• Statistics added for the same Managed Object (that is using the Polling Object directly), is treated
separate. Any change in the Polling Object associated with the Managed Object will not affect the
statistics added directly to the Managed Object.

8.3 Monitoring Health Status

The EMS provides a unique feature named Health Status Monitoring, which monitors the health of the
overall BroadWorks network. This functionality is based on recurrent distribution patterns of threshold
crossings.
The health status functionality relies on three levels of health status: Basic, Node, and Group. Upon a
change in the node health status, the EMS can send an e-mail to notify a list of users automatically. In
addition, the EMS sends a daily report that lists all daily values for a specific list of statistics.
The EMS uses thresholds to determine boundary conditions that trigger a change in the health status
associated with individual basic statistics. Furthermore, a threshold definition documents how a change in
the health status of a basic statistic impacts the associated server and group health status.
Note that a yellow statistic may not immediately lead to a yellow server or group health status. That is, a
threshold definition for a node or group statistic specifies the following parameters, which define when a
change occurs to the associated server and group health status:
• Number of threshold crossings
• Number of successive polls
This approach helps in reducing false reporting caused by a punctual spike. In other words, a healthy
node or group health status (green) changes to an outstanding node or group health status (red or yellow)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 252
 when the polled values of the associated basic statistics are above the specified threshold crossing for the
defined number of times within the defined number of successive polls.
For example, if a yellow threshold defines the number of threshold crossings to be four and the number
of successive polls to be six, the node health status switches to yellow when there are four threshold
crossing events within six successive polls. When a specific node or group threshold switches to yellow,
the resulting node or group health status may still be red because of other outstanding health statistics.
Furthermore, an outstanding node or group health status (red or yellow) reverts to a healthy node or group
status (green) when the polled values of the associated statistic are below the specified threshold crossing,
for the following number of successive polls [ NSP – NTC + 1 ] where:
• NSP is the number of successive polls defined in a threshold.
• NTC is the number of threshold crossings defined in the same threshold.
For example, if a threshold defines the number of threshold crossings to be four and the number of
successive polls to be six, the threshold reverts to green status when there are three successive polls (6
– 4 + 1 = 3). When a specific node or group threshold reverts to green, the resulting node or group health
status may still be outstanding because of other outstanding health statistics.

NOTE: Health status events are local to EMS only.

Health Status and Threshold Modifiers

A number of statistics collected from the BroadWorks Application Server and the BroadWorks Network
Server have thresholds with values that vary based on the hardware characteristics of the server. For such
platform-dependent thresholds, the EMS automatically sets threshold values using the threshold modifiers
mechanism. For more information, see Adjust Thresholds for New Hardware on page 257.
Data Collection, Threshold, and Health Status Interactions
The health status functionality reuses and enhances the statistics and thresholds functionality. The
threshold definitions include thresholds of the Health Status category. The health status does not impact
the generation of statistics because the performance monitoring has two independent types of processing:
data collection and thresholding. In other words, the following sequence occurs from the EMS performance
module:
1) The statistics are always persisted from the data collection.
2) Upon individual data collection, the thresholding processing validates whether threshold crossing
occurred. This processing includes both regular Network Operations Center (NOC) thresholds and
Health Status thresholds.
Reset Health Status
The EMS provides a mechanism that allows the immediate resetting of an outstanding health status. The
EMS provides this functionality in addition to the automatic reset that waits for a number of data collection
cycles before automatically resetting a health status. The automatic approach ensures that the health
status is eventually reset when a condition clears. However, when an EMS operator intervenes to correct
a problem identified by an outstanding health status, it becomes useful to allow a manual reset of the
corresponding health status. This manual action accelerates the return to the default “green” processing.
Therefore, in case the corrective actions were not sufficient, this manual reset should accelerate the time
before the next health status change occurs.
Upon invocation of a manual reset, the EMS resets all counters related to the selected health status to
“zero” and returns the corresponding health status to “green”. An EMS operator can only select a manual
reset for health status at the basic statistics level. The node and group health status are automatically reset
based on the conditions of the other health status at the basic statistics level, from the corresponding node
and group. If an EMS operator sets the health status at the basic statistics level, the node or group health
status is reset automatically.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 253
 The manual health status reset is available from the View Health Statistics Details on page 256 page,
which provides a button named Reset Basic Health Stats. This button applies to the list of selected
statistics. In addition, the Reload Threshold Modifier functionality provides an option to reset all health
status at the same time. This function is available from the Configure Threshold Modifier Actions on page
288 page.
For more information

8.3.1 Multiplicator Ratio for Health Status Change

The Operating System-level Performance Measurement (OSPM)-based data is collected asynchronously.
Statistics are generated on the managed objects every five minutes, but they are collected only once per
hour from the EMS. Since the EMS sees all the fluctuations "in burst" every hour, it uses a multiplicator
ratio.
The ratio is used when computing the threshold distribution (for node and group). The multiplicator is used
for the number of reads above thresholds and the defined number of successive polls. Because the OSPM
data may fluctuate significantly from one measure to the next, only half of the ratio is used to compute the
number of reads above thresholds while the full ratio is used to compute the defined number of successive
polls.
Explanation for a multiplicator ratio:
• OSPM 60 minutes/5 minutes = ratio of 12
• Non-OSPM non-asynchronous = ratio of 1
Multiplicator ratio example:
• Statistics name: memUsagePaging
• Threshold name: PagingMObjY1
• Arm value: 50
• Rearm value: 45
• Reads above thresholds (configured): 4 = EMS uses 4*12/2 = 24
• Number of successive polls (configured): 6 = EMS uses 6*12 = 72
The node health status changes to yellow if the reading of the memUsagePaging statistic has 24 out of 72
successive polls (measured every 5 minutes) above 50. The health status changes back to green when
the number of readings below the rearm value of 45 is sufficient to break the yellow status: 72 - 24 + 1 = 49
(again, measured every 5 minutes).

8.3.2 Data Collection, Threshold and Health Status Interactions

The Health Status functionality reuses and enhances the statistics and thresholds functionality. The
threshold definitions include thresholds of the Health Status category. The health status does not
impact the generation of statistics because the performance monitoring has two independent types of
processing: Data collection and thresholding. In other words, the following sequence occurs from the
EMS performance module:
1) The statistics are always persisted from the data collection.
2) Upon individual data collection, the thresholding processing validates if threshold crossing occurred.
This processing includes both regular Network Operations Center (NOC) thresholds and Health Status
thresholds.

8.3.3 View Network Health Status

Use the Health Status Details page to view the network health status. This page details the:
• Repetition of the real-time health status at the node or group level for the selected groups and/or nodes.
• Real-time health status at the basic statistics level for all the statistics whose thresholds include health
status thresholds.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 254
 Figure 126: Health Status Details

The information on this page includes:

Column Description

Real Time Status This is the status, in real time, of the group or node. The icons indicate the following:

Indicates that the group (or node) is healthy.

Indicates that the group (or node) is marginally healthy. The threshold has been exceeded.

Indicates that the group (or node) is not healthy. The maximum threshold has been exceeded.

Group Name/Node Name This displays the name of the group or the name of the node.

Date This displays the time stamp of the last polling attempt on the group or node.

To view the health status of a group or node:

1) Click the Performance tab.
2) Select the Health Status Details menu item. The Health Status Details page appears. It displays the
health status of all the groups and nodes on the network.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 255
 3) Select the check box to the left of the name of the group or node to view.
4) Click View Stats. The Group/Node Related Statistics page appears.

8.3.4 View Health Statistics Details

Use the Health Statistics Details page to display the details of health statistics for a selected node or group.

Figure 127: Health Statistics Details

The information on this page includes:

Column Description

Real Time Status This is the status, in real time, of the health statistic. The icons indicate the following:

Indicates that the polled values of this statistic are below the defined threshold crossing for the
defined number of successive polls.

Indicates that the polled values of this statistic are above the defined threshold crossing, whose
severity is Major, for the defined number of successive polls.

Indicates that the polled values of this statistic are above the defined threshold crossing whose
severity is Critical, for the defined number of successive polls.

Statistic Name This displays the name of the statistic.

Date This displays the time stamp of the statistic last polling attempt.

To navigate to the health threshold details levels:

1) Click the Performance tab.
2) Select the Health Status Details menu item. The Health Status Details page appears.
3) To view threshold details for a specific statistic, click on the name of the statistic.
4) To view threshold details for all statistics of a given node or group, click on the name of the node or
group.
To view graphs for a statistic:
1) Click the Performance tab.
2) Select the Health Status Details menu item. The Health Status Details page appears.
3) Select the check box in the row containing the statistic for which you would like to see the graph.
4) Click View Graphs. The Report Selection page appears.
5) From the View drop-down list, select the type of graph.
6) From the Period drop-down list, select the time to include in the graph.
7) If you selected a "Custom" period, use the calendar icons to define the Start Date, End Date, and
Extrapolate-To Date.
8) Click View Graph to see the graph or click View Data to save or display the data in a .CSV file.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 256
 9) Click Clear Date to modify the date input boxes.
To reset basic health statistics:

NOTE: The EMS provides a mechanism that allows the immediate resetting of an outstanding health
status. The EMS provides this functionality in addition to the automatic reset that waits for a number of
data collection cycles before automatically resetting a health status. The automatic approach ensures
that the health status is eventually reset when a condition clears. However, when an EMS operator
intervenes to correct a problem identified by an outstanding health status, it becomes useful to allow a
manual reset of the corresponding health status. This manual action accelerates the return to the default
"green" processing. Therefore, in case the corrective actions were not sufficient, this manual reset should
accelerate the time before the next health status. Upon invocation of a manual reset, the EMS resets all
counters related to the selected health status to "zero" and returns the corresponding health status to
"green". You can only select a manual reset for health status at the basic statistics level. The node and
group health status are automatically reset based on the conditions of the other health status at the basic
statistics level (from the corresponding node and group). If you select all the health status at the basic
statistics level, the node or group health status are reset automatically.

1) Click the Performance tab.

2) Select the Health Status Details menu item. The Health Status Details page appears.
3) Select the check box in the row containing the statistic that you would like to reset.
4) Click Reset Basic Health Stats. The Confirming Reset Health Stat Request page appears.
5) Verify that these are the statistics that you want to reset.
6) Click Resetting Basic Health Stats. The Health Statistic Details page appears.

8.3.5 Adjust Thresholds for New Hardware

Threshold Modifiers
A number of statistics collected from the Application Server and the Network Server have thresholds
with values that vary based on the hardware characteristics of the network element. For such platform-
dependent thresholds, the EMS uses a mechanism named Threshold Modifiers, which maps hardware
characteristics to a multiplicator factor that varies based on the BroadWorks server type where the specific
data is collected.
The EMS coordinates the threshold values based on a hierarchical list of threshold values determined
by the characteristics gathered from each network element. As a result, the EMS threshold values scale
automatically with improved processors based on characteristics polled remotely from the network
elements.
Threshold Modifier Definition and Threshold Modifier Item
A threshold modifier is a means for the EMS to alter static threshold values based on a list of
criteria. The EMS contains two configuration files named ThresholdModifierDefinition.xml and
ThresholdModifierItem.xml, which hold a list of modifier definitions and modifier items.
The eXtensible Markup Language (XML) and XML Schema Definition (XSD) configuration files are located
in /usr/local/broadworks/bw_base/public_html/conf. The modifier definitions hold generic definitions for
a threshold modifier, and identify expected criteria based on remote command definitions and managed
object properties. Additionally, the modifier definition may specify selection criteria that define managed
object (MO) properties that must be found and matched for the defined modifier property to be computed
from that remote node.
A modifier item is an instance of a modifier definition, and provides specific values based on the modifier
definition. The EMS provides and maintains the modifier definitions and modifier items on a release-to-
release basis. Furthermore, the EMS provides a list of default modifier items. However, this mechanism
allows EMS administrators to introduce custom modifier items to adapt to individual end-user needs.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 257
 This functionality uses an XSD file named ThresholdModifierDefinition.xsd, which defines the rules for
the modifier definitions. Accordingly, the mandatory definitionName attribute uniquely identifies a modifier
definition element named ModifierDefinition and contains a list of ModifierProperty elements. Each
ModifierDefinition element provides a list of key information that the EMS uses for organizing the internal
EMS threshold modifier structure.
The modifier definition relies on a list of criteria identified by the ModifierProperty elements, which may
define how the EMS can identify a criterion from a remote node based on a UnixCmd with the definition
run on the matching remote nodes. A criterion may include a UnixCmd or it may be associated with any
managed object property such as the BroadWorks server type (for example, Application Server, Network
Server, and so on).
Additionally, this functionality uses an XSD file named ThresholdModifierItem.xsd, which defines the
rules for the modifier items. Accordingly, the mandatory definitionName attribute identifies the associated
ModifierDefinition element used to create an instance of a ModifierItem. Its content lists specific values
that are expected to match from the remote command or from the existing managed object properties
listed in the ModifierProperty element of the corresponding ModifierDefinition. This XSD file also defines
the type of expected threshold modifiers that define how ModifierItem instances impact the corresponding
static threshold values to form a dynamic threshold value. The effect of threshold modifiers that are named
ThresholdAlterator element may be of three distinct types:
• Absolute (Overwrites a specific threshold value; applies only to a specific threshold.)
• Multiplicator (Multiplies the base threshold value; applies to all platform-dependent thresholds.)
• Expression (Provides a mathematical formula for defining a dynamic threshold based on the number of
nodes within a cluster and a specified base threshold; applies only to a specific threshold.)
The attributes defined for each ThresholdAlterator type enforce the threshold modifier behavior, that is:
• The absolute threshold "alterator" forces specification of arm and rearm attributes and always has
empty content.
• The multiplicator alterator forces empty arm and rearm attributes and defines decimal content.
• The expression alterator forces specification of baseArm and baseRearm attributes and defines "string"
content.

NOTE: Once the ThresholdModifierItemCustom.xml file is modified, the thresholds must be reloaded to
become active.

Network Audit
By loading the full list of threshold modifiers, the EMS accumulates a list of UNIX commands that map
to various characteristics of a managed object. The EMS runs a network audit for managing these
characteristics. The EMS audit runs these UNIX commands from all relevant network elements on a daily
basis. Then the EMS adds the resulting characteristics as properties of the corresponding managed object.
Threshold Value Hierarchy
Given the generic nature of the current threshold modifier definitions, multiple threshold modifiers may be
relevant at the same time.
The EMS uses a priority list for determining which threshold modifier definition it ultimately uses. The
priority list is specified by an XML element named ModifierItemPriority, which is located in the same XML
file as the ModifierItem instances. (The file is named ThresholdModifierItem.xml.) For this tag, all the
values of the definitionName attribute for modifier definitions are separated by a space, and the highest
priority definitions are listed from left to right. Using this approach, an EMS administrator can modify the
priority list by customizing this XML element. Note that a reload of the threshold modifier definitions is
required before a change in the priority list becomes effective.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 258
 The following example shows the priority list for the ModifierGroupPriority tag. In this example, the
ModifierDefinition named ManagedObjectBased has the highest priority.

<MODIFIERITEMPRIORITY>
MANAGEDOBJECTBASED CLUSTERBASED MANAGEDOBJECTESTIMATOR EXPRESSIONBASEDSYSENG
DEFAULTSYSENG CPUNAMEBASED PLATFORMNAMEBASED PLATFORMSIZEBASED
</MODIFIERITEMPRIORITY>

Review Threshold Modifier Properties

This functionality introduces a list of hardware characteristics as properties of managed objects and relies
on a list of properties that are already defined. To ease identification of these properties, the EMS lists all
these related properties from the detailed managed object page.
Review Dynamic Threshold Values
The existing Health Threshold Details page from the Performance tab of the Web Client interface shows
the arm and rearm threshold values based on the current list of ModifierItem instances. The EMS uses
threshold values shown on this page. Therefore, when an EMS administrator reloads the threshold
modifiers following changes to their definitions, this page can be consulted to confirm that the latest
threshold values are as expected and match the modifications made.
The following example shows the threshold values for the statistic named ASSipMsgPerSecond from the
managed object named mtl64lin04.mtl.broadsoft.com when the EMS includes the ModifierItem instance of
the ManagedObjectEstimator for that node.

Threshold Name: MPSMObjRed1

Static Threshold Value: 300
Threshold Alterator: 60(ManagedObjectEstimator)
Dynamic Threshold Value: 300 * 60 = 18000

To modify hardware-related thresholds:

1) Open the ThresholdModifierItemCustom.xml file.
2) Modify the default ModifierItem instances or add new instances, as required.
3) Save the file.

NOTE: The file named ThresholdModifierItemCustomExamples.xml provides examples of

customizations. The customized modifier items follow the same patterns as the default items.

To reload threshold modifier definitions:

To reload the threshold modifier actions, see Configure Threshold Modifier Actions on page 288.
For more information

8.3.5.1 Threshold Examples

The following subsections provide examples of modifier definitions and modifier items to help the
understanding of the threshold modifier concept.

Example of ModifierItem Instance based on DefaultSysEng ModifierDefinition

Example of DefaultSysEng ModifierDefinition
The following example shows the modifier definition based on the system engineering
analysis and their identified key criteria. The name attribute NumberOfCores defines
a ModifierProperty element that specifies how the EMS can identify a criterion that
describes the number of central processing units (CPUs) from a remote node based on a
UnixCmd. The other criteria are UnamePlatform, ConfiguredMemory, and BwServerType.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 259
 Additionally, this example specifies that these remote commands are only relevant for the
BroadWorks server types with values "AS", "NS", or "MS".

<MODIFIERDEFINITION DEFINITIONNAME="DEFAULTSYSENG">
<!-- MODIFIERPROPERTY DEFINES ONE OF THE FOLLOWING:
- A PROPERTY THAT IS RAN FROM REMOTE NODES AND
ADDED TO A MANAGEDOBJECT.
- A PROPERTY ALREADY PRESENT FROM A MANAGEDOBJECT. -->
<MODIFIERPROPERTY NAME="NUMBEROFCORES" TYPE="INTEGER">
<UNIXCMD>/USR/LOCAL/BROADWORKS/BW_BASE/BIN/CPUNUM.PL | SED S/
NUMBER\ OF\ PROCESSORS\ IS\ *//</UNIXCMD>
</MODIFIERPROPERTY>
<MODIFIERPROPERTY NAME="UNAMEPLATFORM" TYPE="STRING">
<UNIXCMD>UNAME -I</UNIXCMD>
</MODIFIERPROPERTY>
<MODIFIERPROPERTY NAME="CONFIGUREDMEMORY" TYPE="INTEGER">
<UNIXCMD>PERL -I/USR/LOCAL/BROADWORKS/BW_BASE/BIN -I/USR/LOCAL/
BROADWORKS/BW_BASE/LIB -E "USE BWOS; PRINT MEMORY_SIZE().\"\N\";"</
UNIXCMD>
</MODIFIERPROPERTY>
<MODIFIERPROPERTY NAME="BWSERVERTYPE" TYPE="STRING"/>
<!-- THE SELECTION CRITERIA DEFINES MO PROPERTIES THAT MUST
BE FOUND AND MATCHED FOR THE DEFINED MODIFIERPROPERTY
(THE REMOTECMDBASEDPROPERTY SPECIFICALLY) TO BE COMPUTED
AND ADDED AS PROPERTY FOR AN MO.
ALL CRITERIA MUST MATCH FOR A MATCH. THUS 'AND' CONDITION
IS USED. -->
<MODIFIERSELECTIONCRITERION NAME="BWSERVERTYPE" TYPE="STRING"
MATCH="LIST">AS,NS,MS
</MODIFIERSELECTIONCRITERION>
<MODIFIERSELECTIONCRITERION NAME="ISGROUP" TYPE="BOOLEAN"
MATCH="EXACT">FALSE
</MODIFIERSELECTIONCRITERION>
</MODIFIERDEFINITION>

The ModifierItem in the following example is an instance of the DefaultSysEng modifier

definition described previously. According to the system engineering analysis, this item
reflects that a network element configured with an Intel platform, eight CPUs with between
24 and 32 GB of memory, and running an Application Server is capable of 18 times the
defined static threshold capacity.

<MODIFIERITEM DEFINITIONNAME="DEFAULTSYSENG">
<!-- ALL PLATFORM-DEPENDANT THRESHOLDS FOR ALL AS RUNNING
ON X86_64 ARCHITECTURE HAVING 8 CORES AND BETWEEN 24G-32G
OF RAM HAVE A MULTIPLICATOR FACTOR OF 18.
-->
<MODIFIERITEMPROPERTY NAME="UNAMEPLATFORM" MATCH="EXACT"
TYPE="STRING">X86_64
</MODIFIERITEMPROPERTY>
<MODIFIERITEMPROPERTY NAME="NUMBEROFCORES" MATCH="EXACT"
TYPE="INTEGER">8
</MODIFIERITEMPROPERTY>
<MODIFIERITEMPROPERTY NAME="CONFIGUREDMEMORY" MATCH="RANGE"
TYPE="INTEGER">
24576-32768</MODIFIERITEMPROPERTY>

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 260
 <MODIFIERITEMPROPERTY NAME="BWSERVERTYPE" MATCH="EXACT"
TYPE="STRING">AS
</MODIFIERITEMPROPERTY>
<THRESHOLDALTERATORMULTIPLICATOR>18
</THRESHOLDALTERATORMULTIPLICATOR>
</MODIFIERITEM>

As a result, for all the remote nodes that match the above description, the EMS
multiplies all the static thresholds that have platform-dependent values by 18. That
is, when the EMS collects a statistic such as ASSipMsgPerSecond for which the
threshold named MPSBStatYel applies, the EMS uses the following value (given that
the above criteria apply to the remote node where the statistic was collected). Note that
ASSipMsgPerSecond defines the number of Session Initiation Protocol (SIP) messages
per second from an Application Server and MPSBStatYel defines the number of messages
per second before reaching a yellow status (static level).
Threshold Name: MPSBStatYel Static Threshold Value: 200 Threshold
Alterator: 18 Dynamic Threshold Value: 200 * 18 = 3600

ManagedObjectEstimator ModifierDefinition
The following example shows the modifier definition named ManagedObjectEstimator.
This has a goal to help characterize all platform-dependent thresholds from a new or
enhanced platform. It allows the specification of a specific managed object name where
instances of this modifier definition apply.

MODIFIERDEFINITION DEFINITIONNAME="MANAGEDOBJECTESTIMATOR">
<MODIFIERPROPERTY NAME="MANAGEDOBJECTNAME" TYPE="STRING"/>
</MODIFIERDEFINITION>

The ModifierItem in the example that follows is an instance of the

ManagedObjectEstimator modifier definition previously described. This instance specifies
that the hardware capability of the managed object named mtl64lin04.mtl.broadsoft.com is
60 times greater than the defined static threshold capacity.
Example of ModifierItem Instance Based on ManagedObjectEstimator
ModifierDefinition

<MODIFIERITEM DEFINITIONNAME="MANAGEDOBJECTESTIMATOR">
<!-- ALL PLATFORM-DEPENDANT THRESHOLDS OF MO
MTL64LIN04.MTL.BROADSOFT.COM ARE MULTIPLIED BY 60.
-->
<MODIFIERITEMPROPERTY NAME="MANAGEDOBJECTNAME" MATCH="EXACT"
TYPE="STRING">
MTL64LIN04.MTL.BROADSOFT.COM</MODIFIERITEMPROPERTY>
<THRESHOLDALTERATORMULTIPLICATOR>60
</THRESHOLDALTERATORMULTIPLICATOR>
</MODIFIERITEM>

As a result, for all the statistics from the above-mentioned remote node, the EMS
multiplies all the static thresholds with platform-dependent values by 60, that is, when
the EMS collects a statistic such as ASSipMsgPerSecond with a threshold named
MPSBStatYel. The EMS uses the following value (given that this statistic was collected
from the managed object named mtl64lin04.mtl.broadsoft.com).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 261
 Threshold Name: MPSBStatYel Static Threshold Value: 200 Threshold
Alterator: 60 Dynamic Threshold Value: 200 * 60 = 12000

ManagedObjectBased ModifierDefinition
The following example shows the modifier definition named ManagedObjectBased, which
has a goal to allow overwriting the value for a specific threshold of a specific node.
Example of ManagedObjectBased ModifierDefinition

<MODIFIERDEFINITION DEFINITIONNAME="MANAGEDOBJECTBASED">
<MODIFIERPROPERTY NAME="MANAGEDOBJECTNAME" TYPE="STRING"/>
<THRESHOLDALTERATORABSOLUTE/>
</MODIFIERDEFINITION>

The ModifierItem in the following example is an instance of the ManagedObjectBased

modifier definition previously described. This instance specifies the arm and rearm
threshold values for the threshold named MPSMObjRed1 when a relevant statistic is
collected from the managed object named mtlas01.mtl.broadsoft.com. (This defines the
number of messages per second before reaching a red status node level.)
Example of ModifierItem Instance Based on ManagedObjectBased
ModifierDefinition

<MODIFIERITEM DEFINITIONNAME="MANAGEDOBJECTBASED">
<!-- ALTER ARM/REARM VALUE OF THRESHOLD MPSMOBJRED1
FOR MO MTLAS01.MTL.BROADSOFT.COM -->
<MODIFIERITEMPROPERTY NAME="MANAGEDOBJECTNAME" MATCH="EXACT"
TYPE="STRING">
MTLAS01.MTL.BROADSOFT.COM</MODIFIERITEMPROPERTY>
<THRESHOLDALTERATORABSOLUTE THRESHOLDNAME="MPSMOBJRED1"
ARM="120000" REARM="119500"/>
</MODIFIERITEM>

As a result, for all the statistics from the above-mentioned remote node, the EMS replaces
the defined static threshold values for the threshold named MPSMObjRed1. That is,
when the EMS collects a statistic such as ASSipMsgPerSecond with a threshold named
MPSMObjRed1, the EMS uses the following arm value (given that this statistic was
collected from the managed object named mtlas01.mtl.broadsoft.com). The same logic
applies to the rearm value.
Threshold Name: MPSMObjRed1 Static Threshold Value: 200 Absolute
Arm Threshold Value: 120000 Dynamic Arm Threshold Value: 120000
ClusterBased ModifierDefinition
The following example shows the modifier definition named ClusterBased, which has a
goal to allow the specification of an expression for determining the threshold progression
based on a baseline value and the number of nodes within a cluster. Since this modifier
definition applies to clusters, instances of this definition must set the IsGroup attribute to
"true".
Example of ClusterBased ModifierDefinition

<MODIFIERDEFINITION DEFINITIONNAME="CLUSTERBASED">
<MODIFIERPROPERTY NAME="ISGROUP" TYPE="STRING"/>
<THRESHOLDALTERATOREXPRESSION/>

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 262
 </MODIFIERDEFINITION>

The ModifierItem in the following example contains instances of the ClusterBased modifier
definition previously described. These instances specify the expression to be used when
determining the arm and rearm threshold values for the thresholds named CPUClusterYel
and CPUClusterRed when a relevant statistic is collected from any managed group object.
Note that CPUClusterYel defines the percentage of CPU utilization before reaching a
yellow status (group level) and CPUClusterRed defines the percentage of CPU utilization
before reaching a red status (group level).
Example of ModifierItem Instances Based on ClusterBased ModifierDefinition

<MODIFIERITEM DEFINITIONNAME="CLUSTERBASED">
<!-- DEFINE EXPRESSION FOR CLUSTER-BASED
THRESHOLD CPUCLUSTERYEL -->
<MODIFIERITEMPROPERTY NAME="ISGROUP" MATCH="EXACT"
TYPE="BOOLEAN">
TRUE</MODIFIERITEMPROPERTY>
<THRESHOLDALTERATOREXPRESSION THRESHOLDNAME="CPUCLUSTERYEL"
BASEARM="60" BASEREARM="54">
MAX(BASE,MIN(NBCLUSTERMEMBER,2)*BASE*9/10+MAX(0,
(NBCLUSTERMEMBER-2))*BASE)
</THRESHOLDALTERATOREXPRESSION>
</MODIFIERITEM>
<MODIFIERITEM DEFINITIONNAME="CLUSTERBASED">
<!-- DEFINE EXPRESSION FOR CLUSTER-BASED
THRESHOLD CPUCLUSTERRED -->
<MODIFIERITEMPROPERTY NAME="ISGROUP" MATCH="EXACT"
TYPE="BOOLEAN">TRUE
</MODIFIERITEMPROPERTY>
<THRESHOLDALTERATOREXPRESSION THRESHOLDNAME="CPUCLUSTERRED"
BASEARM="75" BASEREARM="67">
MAX(BASE,MIN(NBCLUSTERMEMBER,2)*BASE*9/10+MAX(0,
(NBCLUSTERMEMBER-2))*BASE)
</THRESHOLDALTERATOREXPRESSION>
</MODIFIERITEM>

As a result, for all the group statistics that have thresholds named CPUClusterYel and
CPUClusterRed that apply, the EMS replaces the defined static threshold values using the
specified formula, that is, when the EMS collects a statistic such as CPUBusyGroup, the
EMS uses the following arm value. This example assumes that the cluster has three nodes
(that is, nbClusterMember = 3).

Threshold Name: CPUClusterYel

Static Arm Threshold Value: 108
Base Arm Threshold Value ("base"): 60
Expression Arm Threshold:
Max(60, min(3,2) * 60 * 9 / 10 + max (0,(3-2))*60)
Max(60, 2 * 60 * 9 / 10 + max (0, 1) * 60)
Max(60, 108 + 1 * 60)
Max(60, 108 + 60)
Max(60, 168)
Dynamic Arm Threshold Value: 168

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 263
 Example of Multiple Threshold Modifiers Match
The following is an example in which multiple threshold modifiers match. The first instance
specifies a threshold alterator of 18 times the default threshold and the second instance
specifies a threshold alterator of 60. Assuming that the node mtl64lin04.mtl.broadsoft.com
specified in the second modifier item matches the hardware characteristics provided by the
first instance, both ModifierItem instances are relevant to all statistics collected from this
managed object.

<MODIFIERITEM DEFINITIONNAME="DEFAULTSYSENG">
<!-- ALL PLATFORM-DEPENDANT THRESHOLDS FOR ALL AS RUNNING
ON X86_64 ARCHITECTURE HAVING 8 CORES AND BETWEEN 24G-32G
OF RAM HAVE A MULTIPLICATOR FACTOR OF 18.
-->
<MODIFIERITEMPROPERTY NAME="UNAMEPLATFORM" MATCH="EXACT"
TYPE="STRING">X86_64
</MODIFIERITEMPROPERTY>
<MODIFIERITEMPROPERTY NAME="NUMBEROFCORES" MATCH="EXACT"
TYPE="INTEGER">8
</MODIFIERITEMPROPERTY>
<MODIFIERITEMPROPERTY NAME="CONFIGUREDMEMORY" MATCH="RANGE"
TYPE="INTEGER">
24576-32768</MODIFIERITEMPROPERTY>
<MODIFIERITEMPROPERTY NAME="BWSERVERTYPE" MATCH="EXACT"
TYPE="STRING">AS
</MODIFIERITEMPROPERTY>
<THRESHOLDALTERATORMULTIPLICATOR>18
</THRESHOLDALTERATORMULTIPLICATOR>
</MODIFIERITEM>

<MODIFIERITEM DEFINITIONNAME="MANAGEDOBJECTESTIMATOR">
<!-- ALL PLATFORM-DEPENDANT THRESHOLDS OF MO
MTL64LIN04.MTL.BROADSOFT.COM ARE MULTIPLIED BY 60.
-->
<MODIFIERITEMPROPERTY NAME="MANAGEDOBJECTNAME" MATCH="EXACT"
TYPE="STRING">
MTL64LIN04.MTL.BROADSOFT.COM</MODIFIERITEMPROPERTY>
<THRESHOLDALTERATORMULTIPLICATOR>60
</THRESHOLDALTERATORMULTIPLICATOR>
</MODIFIERITEM>

Therefore, the EMS must use the ModifierItemPriority element to determine which
threshold alterator it uses. If this priority list is used, the ManagedObjectEstimator
instance has the highest priority because its ModifierDefinition name is left of the
DefaultSysEng ModifierDefinition in the priority list.

<MODIFIERITEMPRIORITY>
MANAGEDOBJECTBASED CLUSTERBASED MANAGEDOBJECTESTIMATOR
EXPRESSIONBASEDSYSENG
DEFAULTSYSENG CPUNAMEBASED PLATFORMNAMEBASED PLATFORMSIZEBASED
</MODIFIERITEMPRIORITY>

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 264
 As a result, the EMS uses a threshold alterator of 60 times the default threshold when
validating platform-dependent thresholds against the statistics collected from the managed
object mtl64lin04.mtl.broadsoft.com.

8.4 Viewing Reports and Graphs of Statistics

You can create the following types of reports with the EMS:
• Report on statistics, servers, or groups
• Report on Basic Statistics
Once a report is created, you can view in a graph format.
For more information

8.4.1 Display a Report for Managed Objects and Statistics

Use the Report – Managed Objects and Statistics page to display a report.

NOTE: A report must be created before you can view the data as a graph.

Figure 128: Report – Managed Objects and Statistics

The information on this page includes:

Column Description

Name This column displays the name of an existing report.

View Historical Reports This column provides a link to the report.

To view an existing report:

1) Click the Performance tab.
2) Click the Report-Managed Objects and Statistics menu item. The Report – Managed Objects and
Statistics page appears.
3) Click View to the right of the report type display. A list of historical reports display for this report type.
4) Click View to the right of the report to display. The File Download dialog appears.
5) Click Open to view the report, click Save to save the report or click Cancel to return to the previous
page.
To delete a report:
1) Click the Performance tab.
2) Click the Report-Managed Objects and Statistics menu item. The Report – Managed Objects and
Statistics page appears.
3) Check the report to delete.
4) Click Delete Report. The page refreshes without the name of the report.
Tasks to perform from this page

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 265
8.4.1.1 Create a Report on Server Statistics
Overview
You can create reports by server type or by an individual server (managed object).

Figure 129: Report Profile

To create a report based on server type:

1) From the Report – Managed Objects and Statistics page, click the Create Report. The Report Profile
page appears.
2) Click Server Type.
3) Using the right-arrow button, select the Server Type. Click on the server type and then click on the
arrow pointing to the right. The server type displays in the Servers column and there is a link to Edit
Statistics in the Statistics column.
4) Click Edit Statistics. The Statistics Selection page displays.
5) Select the statistics to include in the report in the Available Statistics column. Select the statistics by
using the Ctrl key to select more than one and click the arrow pointing to the right. The statistics display
in the Selected Statistics column.
6) Click Save. The Report Profile page appears.
7) Select the report format from the drop-down list.
8) To execute the report on a regular basis, check Periodic Report Generation and select the Frequency
Type, Frequency Value, Week Day, and Time of Day as required.
9) To email the report, check Mail Report and selcted the email distribution list from the drop-down list.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 266
 10)Click Save to save the report or click Reset to reset the values for this report.

8.4.1.2 View a Historical Report

Use the Historical Report Management page to display an historical report.

Figure 130: Historical Report Management

To view an historical report:

1) From the Report – Managed Objects and Statistics page, click View on the row of the report to display.
The Historical Report Management page appears.
2) To delete the report, click Delete.

8.4.2 Create a Graph

Use the Graph – Managed Objects and Statistics page to create a graph of an existing report.

NOTE: A report must be created before you can view the data as a graph.

Figure 131: Graph – Managed Objects and Statistics

The information on this page includes:

Input Box Description

Report Selection This drop-down menu defines the type of report.

View This drop-down menu defines the type of graph.

Period This drop-down menu specifies the time period of the graph.

Start Date This text box specifies the day the graph begins.

End Date This text box specifies the last day of the graph.

Extrapolate-To Date This text box specifies the date the graph extrapolates to.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 267
 To create a graph:
1) Click the Performance tab.
2) Click the Graph-Managed Objects and Statistics menu item. The Graph-Managed Objects and
Statistics page appears.
3) In the View box, select the presentation type of the graph from the drop-down menu.
4) In the Period box, select the time period of the graph from the drop-down menu.
5) In the Start Date box, type the start date or use the calendar icon to select the date.
6) In the End Date box, type the end date or use the calendar icon to select the date.
7) In the Extrapolate-to Date box, type the date to extrapolate the data to or click the calendar icon to
select the date.

8.4.3 Create a Report for Key Statistics

Use the Key Statistics page to display reports of key statistics from your network.

Figure 132: Key Statistics

The information on this page includes:

Column Description

Stat Name This column displays the name of the statistic.

N This column displays the number of times the statistic was polled at the maximum value.

Max This column displays the maximum value polled for the statistic.

TimeStamp(Max) This column displays the last time the node was polled to collect data for this statistic.

To display a report for key statistics:

1) Click the Report for Key Statistics menu item. The Report for Key Statistics page appears.
2) Select the duration of the report from the drop-down list. The Report for Key Statistics displays.
3) To view the report in a PDF format, click PDF View.
4) To view the report in a printable format, click Printable View.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 268
8.4.4 Report Formats
The EMS provides three report formats. The following subsections provide a summary description.
CSV Format
The first possible format is comma separated value (CSV) and it is as follows:
ManagedObjectName, StatisticName, TimeStamp, StatisticValue, TimeStamp, StatisticValue, …
mtl64lin01.mtl.broadsoft.com, CPUUsr, 9/21/2008-13:05, 9, 9/21/2008-12:05, 10,
… mtl64lin02.mtl.broadsoft.com, CPUUsr, 9/21/2008-13:05, 11, 9/21/2008-12:05,
8, …
This format is text-based.
XSL Format
The second format is an eXtensible Stylesheet Language (XSL) (Excel) and it is as follows:

Figure 133: XSL Format

This format is binary-based.

XML Format
The last format is in eXtensible Markup Language (XML) and its schema is as follows:

<xs:schema>
<xs:complexType name="PerformanceStatisticReport">
<xs:sequence>
<xs:element name="PerformanceStatistic" type="PerformanceStatisticType"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="PerformanceStatisticType">
<xs:sequence>
<xs:element name="ManagedObject" type="xs:string"/>
<xs:element name="StatisticName" type="xs:string"/>
<xs:element name="StatisticValue" type="StatisticValueType"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="StatisticValueType">

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 269
 <xs:sequence>
<xs:element name="TimeStamp" type="xs:dateTime"/>
<xs:element name="Value" type="xs:integer"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

The following is an example of an XML report:

<PerformanceStatisticReport>
<PerformanceStatistic>
<ManagedObject>mtl64lin01.mtl.broadsoft.com</ManagedObject>
<StatisticName>CPUBusy</StatisticName>
<PerformanceStatisticsList>
<StatisticValue>
<TimeStamp>2008-08-09T00:00:00</TimeStamp>
<Value>10</Value>
</StatisticValue>
<StatisticValue>
<TimeStamp>2008-08-09T00:05:00</TimeStamp>
<Value>11</Value>
</StatisticValue>
</PerformanceStatisticsList>
</PerformanceStatistic>
<PerformanceStatistic>
<ManagedObject>ml64lin02.mtl.broadsoft.com</ManagedObject>
<StatisticName>CPUBusy</StatisticName>
<PerformanceStatisticsList>
<StatisticValue>
<TimeStamp>2008-08-09T00:00:00</TimeStamp>
<Value>10</Value>
</StatisticValue>
<StatisticValue>
<TimeStamp>2008-08-09T00:05:00</TimeStamp>
<Value>10</Value>
</StatisticValue>
</PerformanceStatisticsList>
</PerformanceStatistic>
</PerformanceStatisticReport>

This format is text-based.

8.5 Monitoring JVM

Use the JVM Management page to view Java Machine (JVM) performance details. The BE Server Details
tab is the default tab.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 270
 Figure 134: JVM Management

The information on this page includes:

Input Box Description

BE Host Name This input box displays the back end host name.

BE Startup Time This input box displays the back end startup time.

OS Details This input box displays the operating system details.

VM Version This input box displays the version of the virtual machine.

Memory Utilization This input box displays the memory utilization.

BE Host address This input box displays the back end host address.

Database Name This input box displays the name of the database.

OS Arch This input box displays the operating system architecture.

VM Vendor This input box displays the name of the virtual machine vendor.

The graphs on this page includes:

Graph Description

CPUtilization in Percent This graph displays the percentage of CPU utilization.

MemoryUtilization in Percent This graph displays the percentage of memory utilization.

ThreadCount This graph displays the thread count.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 271
 DataCollection in PerSec This graph displays the flow of data collection per second.

StatusPollingRate in PerSec This graph displays the rate of status polling per second.

TrapRate in PerSec This graph displays the rate of traps per second.

EventRate in PerSec This graph displays the rate of events per second.

AlertRate in PerSec This graph displays the rate of alerts per second.

To generate graphs:
1) Click the Admin tab.
2) From the Monitor/Management sub-menu, click JVM Management. The JVM Management page
appears.
3) To generate line graphs, click Line Graphs. A line graph representation of the statistics appear.
4) To generate line graphs, click Area Graphs. An area graph representation of the statistics appear.
5) To select the period of time that the graphs include, select the length of time from the drop-down menu.
The default is "1 day".
To view the stand-by server details:
Click STANDBY Server Details. The stand by server details display in a new window.
Tasks to perform from this page

8.5.1 JVM Management - FE Server Details

Use the JVM Management - FE Server Details tab to display the JVM front-end server details.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 272
 Figure 135: JVM Management - FE Server Details

The information on this page includes:

Input Box Description

FE Host Name This input box displays the front end host name.

OS Details This input box displays the operating system details.

VM Version This input box displays the version of the virtual machine.

FE StartUp Time This input box displays the front end startup time.

Memory Utilization This input box displays the memory utilization.

FE Host address This input box displays the front end host address.

OS Arch This input box displays the operating system architecture.

VM Vendor This input box displays the name of the virtual machine vendor.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 273
 Input Box Description

Web Server Port This input box displays the Web Server port.

Server Type This input box displays the type of server.

The graphs on this page includes:

Graph Description

CPUtilization in Percent This graph displays the percentage of CPU utilization.

MemoryUtilization in Percent This graph displays the percentage of memory utilization.

ThreadCount This graph displays the thread count.

To generate graphs:
1) Click the Admin tab.
2) From the Monitor/Management sub-menu, click JVM Management. The JVM Management page
appears.
3) Click the FE Server Details tab. The FE Server Details tab appears.
4) To generate line graphs, click Line Graphs. A line graph representation of the statistics appear.
5) To generate line graphs, click Area Graphs. An area graph representation of the statistics appear.
6) To select the period of time that the graphs include, select the length of time from the drop-down menu.
The default is "1 day".
To view the stand-by server details:
Click STANDBY Server Details. The stand by server details display in a new window.

8.5.2 JVM Management - Client Details

Use the JVM Management - Client Details tab to display the JVM client details..

Figure 136: JVM Management - Client Details

The columns on this page includes:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 274
 Column Description

VM_Host This column displays the virtual machine host name.

VM_Type This column displays the virtual machine type.

Client ID This column displays the client ID.

Memory Usage % This column displays the percentage of memory usage.

Terminate This column dprovides a link to terminate the client.

The client details on this page include:

Input Box Description

Client Host Name This input box displays the client host name.

Server Name This input box displays the server name.

User Name This input box displays the user name currently logged in to the client.

Client Type This input box displays the type of client.

Client Host Address This input box displays the client host address.

Server Port This input box displays the server port.

Start Time This input box displays the time the client logged in.

Server Type This input box displays the type of server.

To display the client details:

1) Click the Admin tab.
2) From the Monitor/Management sub-menu, click JVM Management. The JVM Management page
appears.
3) Click theClient Details tab. The Client Server Details tab appears.
4) Click the VM_Host of the client to display. The details of the client appear.
To terminate a client:
Click the Terminate icon (the letter X) on the row of the client to terminate. The client is logged off.

8.6 View the Performance Status of a Node

Use the Performance Status page to display the performance status of a node.

Figure 137: Performance Status

To display the performance status of a node:

1) Click the Admin tab.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 275
 2) From the Monitor/Management sub-menu, click Performance Status. The Performance Status page
appears.
3) Enter the name of the node.
4) Click View Status. The performance status appears.

8.7 Configure List of Statistics (Health Status)

Use the Configure the List of Statistics page to configure the list of statistics included in the Health Status
display.

Figure 138: Configure the List of Statistics

To configure the list of statistics:

1) Click the Admin tab.
2) From the Monitor/Management sub-menu, click List of Statistics (Health Status Change). The List of
Statistics page appears.
3) Use the Add Stat> and <Remove Stat buttons to compile the statistics for the Health Status display in
the Selected Statistics list.
4) Click the Configure List. The list of statistics is configured.
For more information

8.7.1 Statistics Reference

Statistic Description

Application Server Statistics

AS OCI STATISTICS Description

ASOciRequestsInPerSecond This statistic displays the Application Server OCI

requests (per second). This formula for this statistic is:
psOciStatsNbUpdateRequests + psOciStatsNbQueryRequests
+ psOciStatsNbAuthorizationRequests)/$DELTA_TIME

ASOciMaxRequestDelay This statistic displays the Application Server OCI

maximum request delay. It is based on the results for the
psOciStatsMaxRequestResponseTime statistic.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 276
 Statistic Description

ASOciAvgRequestDelay This statistic displays the Application Server OCI average

request delay. This statistic displays the results for
psOciStatsRequestResponseTime.

AS TRAFFIC Description

ASNbOfUsers This statistic displays the number of users on the Application

Server. It is based on the bwNumberOfUsers statistic.

ASBusyHourCallAttempts This statistic displays the busy hour call attempts

on the Application Server. The formula used for
this statistic is: bwCallpUserOriginationAttempts +
bwCallpNetworkOriginationAttempt.

ASCallsPerSecond This statistic displays the number of calls (per second) on the
Application Server. It is based on the bwCallpCallsPerSecond
statistic.

ASActiveCalls This statistic displays the number of active calls (per second) on
the Application Server. It is based on the bwCallpActiveCalls
statistic.

AS SIP MESSAGING Description

ASSipMsgPerSecond This statistic displays the number of SIP messages (per second)
on the Application Server. The formula used for this statistic
is: (bwSipStatsTcpIns+bwSipStatsTcpOuts+bwSipStatsUdpIns
+bwSipStatsUdpOuts)/$DELTA_TIME.

ASSipRegistersInPerSecond This statistic displays the number of SIP registers (per second)
on the Application Server. The formula used for this statistic is:
(bwSipStatsRegisterIns)/$DELTA_TIME.

ASSipOptionsPerSecond This statistic displays the number of SIP options (per second)
on the Application Server. The formula used for this statistic is:
(bwSipStatsRegisterIns)/$DELTA_TIME.

ASSipSubscribeNotifyPerSecond This statistic displays the number of SIP subscription

notifications (per second) on the Application Server. The
formula used for this statistic is: (bwSipStatsSubscribeIns
+ bwSipStatsSubscribeOuts+ bwSipStatsNotifyIns+
bwSipStatsNotifyOuts)/$DELTA_TIME.

ASSipAvgCallSetupDelay This statistic displays the average call delay for setting up
SIP messages on the Application Server. It is based on the
bwSipStatsSetupSignalDelay statistic.

ASSipMaxCallSetupDelay (msec) This statistic displays the maximum call delay for setting up
SIP messages (in milliseconds) on the Application Server. It is
based on the bwSipStatsSetupSignalDelay statistic.

ASSipAvgAnswerDelay (msec) This statistic displays the average time for SIP messages to
be answered (in milliseconds) on the Application Server. It is
based on the bwSipStatsAnswerSignalDelay statistic.

ASSipMaxAnswerDelay (msec) This statistic displays the maximum time for SIP messages to
be answered (in milliseconds) on the Application Server. It is
based on the bwSipStatsMaxAnswerSignalDelay statistic.

AS MGCP MESSAGING Description

ASMgcpMsgPerSecond This statistic displays the number of MGCP messages

(per second) on the Application Server. The formula used
for this statistic is: (bwMGCPStatsMGCPCommandOuts
+ bwMGCPStatsMGCPCommandIns
+ bwMGCPStatsMGCPResponseOuts +
bwMGCPStatsMGCPResponseOuts)/$DELTA_TIME.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 277
 Statistic Description

ASMgcpAvgDialToneDelay (msec) This statistic displays the maximum time for MGCP messages
to be answered (in milliseconds) on the Application Server. It is
based on the bwSipStatsMaxAnswerSignalDelay statistic.

ASMgcpAvgCallSetupDelay (msec) This statistic displays the average time before MGCP messages
are set-up (in milliseconds) on the Application Server. It is
based on the bwMGCPStatsSetupSignalDelay statistic.

ASMgcpMaxCallSetupDelay (msec) This statistic displays the average time before MGCP statistics
are set-up (in milliseconds) on the Application Server. It is
based on the bwMGCPStatsSetupSignalDelay statistic.

ASMgcpAvgAnswerDelay (msec) This statistic displays the average time before MGCP calls
are answered (in milliseconds) on the Application Server. It is
based on the bwMGCPStatsAnswerSignalDelay statistic.

ASMgcpMaxAnswerdelay (msec) This statistic displays the maximum time before MGCP calls
are answered (in milliseconds) on the Application Server. It is
based on the bwMGCPStatsMaxAnswerSignalDelay statistic.

AS QUEUE STATISTICS Description

bwSystemInternalQueueTimeAvg This statistic displays the average time messages stay in queue.

bwSystemInternalQueueTimeMax This statistic displays the maximum time messages stay in

queue.

CAP Statistics Description

ASCapMsgPerSecond This statistic displays the number of CAP messages (in

milliseconds) on the Application Server. It is based on the
bwCAPStatsTotalMsgs/$DELTA_TIME statistic.

AS REDUNDANCY Description

ASNbOfMigratedUsers This statistic displays the number of migrated users on the

Application Server. It is based on the nbOfMigratedUsers
statistic.

MISCELLANEOUS Description

percentXsJHeap This statistic displays the percentage of JAVA heap being used
by the Execution Server (XS) process.

dsnInUse This statistic displays the number of DSNs in use on the

Application Server.

ASBwNumberOfNonVirtualUsers This statistic displays the number of non-virtual users on the

Application Server.

ASBwNumberOfLicensedUsers This statistic displays the number of licensed users on the

Application Server.

ASBwNumberOfNonVirtualUsers This statistic displays the number of non virtual users.

ASBwNumberOfLicensedUsers This statistic displays the number of licensed users.

Media Server Statistics

MSNoPortAvailableError This statistic displays the number of "no port available" errors.

MSPortsInUse This statistic displays the number of ports currently in use.

MSPortsUsageRatio This statistic displays the ratio of currently used ports to the total
of licensed ports.

MSBlockingRatio This statistic displays the ratio of the number of "no port
available" error to the sum of Interactive Voice Response (IVR)
sessions and conferences.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 278
 Statistic Description

MSIvrSessionCount This statistic displays the total number of IVR sessions.

MSRtpSessionsCount This statistic displays the total number of Real-Time Transport

Protocol (RTP) sessions.

MSConferenceCount This statistic displays the total number of conferences.

MSVoiceMailDelivery-SMTP This statistic displays the total number of voice mail delivered
through SMTP.

MSIvrAudioMemoryUsageRatio This statistic displays the ratio of the IVR audio memory in use
to the IVF free audio memory.

MSRTPReceiveQOSin1000th This statistic displays the ratio of delta (times 1000) between
RTP packets expected and the RTP packets received to the
RTP packet expected.

MSRTPTransmitQOSin1000th This statistic displays the ratio (times 1000) of the cumulative
RTP packet lost to the total RTP packet sent.

MSBadSyncSourceRatio This statistic displays the ratio (times 100) of the number of
packets received that had an invalid Synchronization Source
(SSRC) to the number of RTP packets received.

MSVoiceQuality This statistic displays the number of RTP frames skipped per 10
seconds.

MSSipRetransmissionIn1000th This statistic displays the ratio (times 1000) of SIP invite 200OK
retransmits to the number of SIP invite.

MSASRequest-RetryIn1000th This statistic displays the ratio (times 1000) of SIP retransmit to
the sum of SIP invite, SIP Bye, and SIP Info.

MSTech-SupportPMEquivalencyIvrSessCount This statistic displays the total number IVR sessions.

MSTech-SupportPMEquivalencyRtpSessCount This statistic displays the total number of RTP sessions.

MSTech-SupportPMEquivalencyConfCount This statistic displays the total number of conferences.

MSTech-SupportPMEquivalencyPortsInUse This statistic displays the number of ports currently in use.

MSTech-SupportPMEquivalencyMSCMLPlayCollectFailed This statistic displays the number of PlayCollect command

failures.

MSTech-SupportPMEquivalencyMSCMLPlayCollect This statistic displays the number of PlayCollect commands

received.

MSTech-SupportPMEquivalencyMSCMLRecordFailed This statistic displays the number of PlayRecord command

failures.

MSTech-SupportPMEquivalencyPrimSmtpErr This statistic displays the number of errors that occurred to

primary SMTP server.

MSTech-SupportPMEquivalencySecSmtpErr This statistic displays the number of errors that occurred to

secondary SMTP server.

MSTech-SupportPMEquivalencyMSCMLSendMailFailed This statistic displays the number of PlayCollect command

failures.

MSTech-SupportPMEquivalencyNoPortAvailErr This statistic displays the number of ‘no ports available’ errors.

MSCallControlXMLSessionCount This statistic displays the total number of CallControlXML

Sessions.

MSCallControlXMLCreateCallCount This statistic displays the total number of CallControlXML calls

created through the createcall tag.

MSCallControlXMLDialogCount This statistic displays the total number of CallControlXML

dialogs.

MSCallControlXMLConfCount This statistic displays the total number of CallControlXML

conferences.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 279
 Statistic Description

MSVoiceXMLErrorCount This statistic displays the number times an error occurs while
downloading or running a VoiceXML script.

MSVoiceXMLFilesDownloaded This statistic displays number of VoiceXML files is downloaded.

It does not include media files.

Network Server Statistics

NSCallpCallsPerSecond This statistic displays the call per seconds.

NSSipStatsInviteIns This statistic displays the total number of INVITE requests

received.

NSSipMsgPerSecond This statistic displays the sum of SIP TCP messages received
and sent and the SIP UDP messages received and sent per
second.

NSSysIntQueueTimeAvgSipEncodeQ(1000usec) This statistic displays the average SIP encoding queue holding
time. This statistic is disabled when there is more than one
threads for SIP encoding.

NSSysIntQueueTimeAvgSipDecodeQ(1000usec) This statistic displays the average SIP decoding queue holding
time.

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec) This statistic displays the average SIP redirect session manager
holding time. This statistic is disabled when there is more than
one threads for SIP redirect session manager.

NSSysIntQueueTimeMaxSipEncodeQ(msec) This statistic displays the maximum SIP encoding queue holding
time. This statistic is disabled when there is more than one
threads for SIP encoding.

NSSysIntQueueTimeMaxSipDecodeQ(msec) This statistic displays the maximum SIP decoding queue holding
time.

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec) This statistic displays the maximum SIP redirect session

manager holding time. This statistic is disabled when there is
more than one threads for SIP redirect session manager.

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)TX This statistic displays the average SIP redirect session manager
holding time for thread TX, where TX can be T1 … TN, the
thread number.

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)TX This statistic displays the maximum SIP redirect session

manager holding time for thread TX, where TX can be T1 …
TN, the thread number.

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)TX This statistic displays the average SIP encoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

NSSysIntQueueTimeMaxSipEncodeQ(msec)TX This statistic displays the maximum SIP encoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

Execution Server Statistics

XStoSMTPtraffic This statistic displays the total number of message send

attempted on the primary SMTP server.

XSBusyHourCallAttempts This statistic displays the sum of user call origination attempts
and network call origination attempts.

XSCallsPerSecond This statistic displays the call attempts per second.

XSActiveCalls This statistic displays the total number of active originating

sessions.

XSSysIntQueueTimeAvgCallHalf(1000usec)TX This statistic displays the average queue holding time for a Call
Half thread TX, where TX can be T1 … TN, the thread number.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 280
 Statistic Description

XSSysIntQueueTimeMaxCallHalf(msec)TX This statistic displays the maximum queue holding time for a
Call Half thread TX, where TX can be T1 … TN, the thread
number.

XSSysIntQueueTimeAvgRegAdapt(1000usec)TX This statistic displays the average queue holding time for a
Registration input queue.

XSSysIntQueueTimeMaxRegAdapt(msec)TX This statistic displays the maximum queue holding time for a
Registration input queue.

XSSysIntQueueTimeAvgCallPThreadDBAccess(1000usec) This statistic displays the average queue holding time for the
Callp thread to DB access.

XSSysIntQueueTimeMaxCallPThreadDBAccess(msec) This statistic displays the maximum queue holding time for the
Callp thread to DB access.

XSSysIntQueueTimeAvgVoiceMailInAdapt(1000usec)TX This statistic displays the average queue holding time for a voice
mail input adapter thread TX, where TX can be T1 … TN, the
thread number.

XSSysIntQueueTimeMaxVoiceMailInAdapt(msec)TX This statistic displays the maximum queue holding time for a
voice mail input adapter thread TX, where TX can be T1 … TN,
the thread number.

XSSipMsgPerSecond This statistic displays the sum of SIP TCP messages received
and sent and the SIP UDP messages received and sent per
second.

XSSipRegistersInPerSecond This statistic displays the number of Register message received

per second

XSSipOptionsPerSecond This statistic displays the number of Option message received

and sent per second.

XSSipSubscribeNotifyPerSecond This statistic displays the number of Subscribe messages

received and sent and the number of Notify messages received
and sent per second.

XSSipAvgCallSetupDelay This statistic displays the average time (in milliseconds) it takes
between the receipt of an INVITE message for the origination of
a new call and the transmission of an INVITE (Sip terminator),
RQNT (MGCP terminator with in-band ringback), or CRCX
(MGCP terminator without in-band ringback) to the primary
device of the original called party (in the case of intra-group call)
or to the network element of the original called party (in the case
of a call to the PSTN).

XSSipMaxCallSetupDelay(msec) This statistic displays the longest SIP setup-signal delay

sampled since the system was started or since this
measurement was cleared.

XSSipAvgAnswerDelay(msec) This statistic displays the average time (in milliseconds)

between the receipt of a 200 OK message indicating answer or
a NTFY off-hook indicating answer and the transmission of a
200 OK indicating answer to the originator.

XSSipMaxAnswerDelay(msec) This statistic displays the longest SIP answer-signal

delay sampled since the system was started or since this
measurement was cleared.

XSSysIntQueueTimeAvgSIPEncodeQ(1000usec)TX This statistic displays the average SIP encoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

XSSysIntQueueTimeMaxSIPEncodeQ(msec)TX This statistic displays the maximum SIP encoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 281
 Statistic Description

XSSysIntQueueTimeAvgSIPCallDecodeQ(msec)TX This statistic displays the average SIP decoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

XSSysIntQueueTimeMaxSIPCallDecodeQ(msec)TX This statistic displays the maximum SIP decoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

XSCapMsgPerSecond This statistic displays the total number of CAP messages that
have been handled by the server.

8.8 Configure List of Statistics (Daily)

Use the Configure the List of Statistics page to configure the list of statistics included in the Key Statistics
display.

Figure 139: Configure the List of Statistics (Daily)

To configure the list of statistics:

1) Click the Admin tab.
2) From the Monitor/Management sub-menu, click List of Statistics (Daily Report). The List of Statistics
page appears.
3) Use the Add Stat> and <Remove Stat buttons to compile the statistics for the Daily Report display in
the Selected Statistics list.
4) Click the Configure List. The list of statistics is configured.
For more information

8.8.1 Statistics Reference

Statistic Description

Application Server Statistics

AS OCI STATISTICS Description

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 282
 Statistic Description

ASOciRequestsInPerSecond This statistic displays the Application Server OCI

requests (per second). This formula for this statistic is:
psOciStatsNbUpdateRequests + psOciStatsNbQueryRequests
+ psOciStatsNbAuthorizationRequests)/$DELTA_TIME

ASOciMaxRequestDelay This statistic displays the Application Server OCI

maximum request delay. It is based on the results for the
psOciStatsMaxRequestResponseTime statistic.

ASOciAvgRequestDelay This statistic displays the Application Server OCI average

request delay. This statistic displays the results for
psOciStatsRequestResponseTime.

AS TRAFFIC Description

ASNbOfUsers This statistic displays the number of users on the Application

Server. It is based on the bwNumberOfUsers statistic.

ASBusyHourCallAttempts This statistic displays the busy hour call attempts

on the Application Server. The formula used for
this statistic is: bwCallpUserOriginationAttempts +
bwCallpNetworkOriginationAttempt.

ASCallsPerSecond This statistic displays the number of calls (per second) on the
Application Server. It is based on the bwCallpCallsPerSecond
statistic.

ASActiveCalls This statistic displays the number of active calls (per second) on
the Application Server. It is based on the bwCallpActiveCalls
statistic.

AS SIP MESSAGING Description

ASSipMsgPerSecond This statistic displays the number of SIP messages (per second)
on the Application Server. The formula used for this statistic
is: (bwSipStatsTcpIns+bwSipStatsTcpOuts+bwSipStatsUdpIns
+bwSipStatsUdpOuts)/$DELTA_TIME.

ASSipRegistersInPerSecond This statistic displays the number of SIP registers (per second)
on the Application Server. The formula used for this statistic is:
(bwSipStatsRegisterIns)/$DELTA_TIME.

ASSipOptionsPerSecond This statistic displays the number of SIP options (per second)
on the Application Server. The formula used for this statistic is:
(bwSipStatsRegisterIns)/$DELTA_TIME.

ASSipSubscribeNotifyPerSecond This statistic displays the number of SIP subscription

notifications (per second) on the Application Server. The
formula used for this statistic is: (bwSipStatsSubscribeIns
+ bwSipStatsSubscribeOuts+ bwSipStatsNotifyIns+
bwSipStatsNotifyOuts)/$DELTA_TIME.

ASSipAvgCallSetupDelay This statistic displays the average call delay for setting up
SIP messages on the Application Server. It is based on the
bwSipStatsSetupSignalDelay statistic.

ASSipMaxCallSetupDelay (msec) This statistic displays the maximum call delay for setting up
SIP messages (in milliseconds) on the Application Server. It is
based on the bwSipStatsSetupSignalDelay statistic.

ASSipAvgAnswerDelay (msec) This statistic displays the average time for SIP messages to
be answered (in milliseconds) on the Application Server. It is
based on the bwSipStatsAnswerSignalDelay statistic.

ASSipMaxAnswerDelay (msec) This statistic displays the maximum time for SIP messages to
be answered (in milliseconds) on the Application Server. It is
based on the bwSipStatsMaxAnswerSignalDelay statistic.

AS MGCP MESSAGING Description

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 283
 Statistic Description

ASMgcpMsgPerSecond This statistic displays the number of MGCP messages

(per second) on the Application Server. The formula used
for this statistic is: (bwMGCPStatsMGCPCommandOuts
+ bwMGCPStatsMGCPCommandIns
+ bwMGCPStatsMGCPResponseOuts +
bwMGCPStatsMGCPResponseOuts)/$DELTA_TIME.

ASMgcpAvgDialToneDelay (msec) This statistic displays the maximum time for MGCP messages
to be answered (in milliseconds) on the Application Server. It is
based on the bwSipStatsMaxAnswerSignalDelay statistic.

ASMgcpAvgCallSetupDelay (msec) This statistic displays the average time before MGCP messages
are set-up (in milliseconds) on the Application Server. It is
based on the bwMGCPStatsSetupSignalDelay statistic.

ASMgcpMaxCallSetupDelay (msec) This statistic displays the average time before MGCP statistics
are set-up (in milliseconds) on the Application Server. It is
based on the bwMGCPStatsSetupSignalDelay statistic.

ASMgcpAvgAnswerDelay (msec) This statistic displays the average time before MGCP calls
are answered (in milliseconds) on the Application Server. It is
based on the bwMGCPStatsAnswerSignalDelay statistic.

ASMgcpMaxAnswerdelay (msec) This statistic displays the maximum time before MGCP calls
are answered (in milliseconds) on the Application Server. It is
based on the bwMGCPStatsMaxAnswerSignalDelay statistic.

AS QUEUE STATISTICS Description

bwSystemInternalQueueTimeAvg This statistic displays the average time messages stay in queue.

bwSystemInternalQueueTimeMax This statistic displays the maximum time messages stay in

queue.

CAP Statistics Description

ASCapMsgPerSecond This statistic displays the number of CAP messages (in

milliseconds) on the Application Server. It is based on the
bwCAPStatsTotalMsgs/$DELTA_TIME statistic.

AS REDUNDANCY Description

ASNbOfMigratedUsers This statistic displays the number of migrated users on the

Application Server. It is based on the nbOfMigratedUsers
statistic.

MISCELLANEOUS Description

percentXsJHeap This statistic displays the percentage of JAVA heap being used
by the Execution Server (XS) process.

dsnInUse This statistic displays the number of DSNs in use on the

Application Server.

ASBwNumberOfNonVirtualUsers This statistic displays the number of non-virtual users on the

Application Server.

ASBwNumberOfLicensedUsers This statistic displays the number of licensed users on the

Application Server.

ASBwNumberOfNonVirtualUsers This statistic displays the number of non virtual users.

ASBwNumberOfLicensedUsers This statistic displays the number of licensed users.

Media Server Statistics

MSNoPortAvailableError This statistic displays the number of "no port available" errors.

MSPortsInUse This statistic displays the number of ports currently in use.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 284
 Statistic Description

MSPortsUsageRatio This statistic displays the ratio of currently used ports to the total
of licensed ports.

MSBlockingRatio This statistic displays the ratio of the number of "no port
available" error to the sum of Interactive Voice Response (IVR)
sessions and conferences.

MSIvrSessionCount This statistic displays the total number of IVR sessions.

MSRtpSessionsCount This statistic displays the total number of Real-Time Transport

Protocol (RTP) sessions.

MSConferenceCount This statistic displays the total number of conferences.

MSVoiceMailDelivery-SMTP This statistic displays the total number of voice mail delivered
through SMTP.

MSIvrAudioMemoryUsageRatio This statistic displays the ratio of the IVR audio memory in use
to the IVF free audio memory.

MSRTPReceiveQOSin1000th This statistic displays the ratio of delta (times 1000) between
RTP packets expected and the RTP packets received to the
RTP packet expected.

MSRTPTransmitQOSin1000th This statistic displays the ratio (times 1000) of the cumulative
RTP packet lost to the total RTP packet sent.

MSBadSyncSourceRatio This statistic displays the ratio (times 100) of the number of
packets received that had an invalid Synchronization Source
(SSRC) to the number of RTP packets received.

MSVoiceQuality This statistic displays the number of RTP frames skipped per 10
seconds.

MSSipRetransmissionIn1000th This statistic displays the ratio (times 1000) of SIP invite 200OK
retransmits to the number of SIP invite.

MSASRequest-RetryIn1000th This statistic displays the ratio (times 1000) of SIP retransmit to
the sum of SIP invite, SIP Bye, and SIP Info.

MSTech-SupportPMEquivalencyIvrSessCount This statistic displays the total number IVR sessions.

MSTech-SupportPMEquivalencyRtpSessCount This statistic displays the total number of RTP sessions.

MSTech-SupportPMEquivalencyConfCount This statistic displays the total number of conferences.

MSTech-SupportPMEquivalencyPortsInUse This statistic displays the number of ports currently in use.

MSTech-SupportPMEquivalencyMSCMLPlayCollectFailed This statistic displays the number of PlayCollect command

failures.

MSTech-SupportPMEquivalencyMSCMLPlayCollect This statistic displays the number of PlayCollect commands

received.

MSTech-SupportPMEquivalencyMSCMLRecordFailed This statistic displays the number of PlayRecord command

failures.

MSTech-SupportPMEquivalencyPrimSmtpErr This statistic displays the number of errors that occurred to

primary SMTP server.

MSTech-SupportPMEquivalencySecSmtpErr This statistic displays the number of errors that occurred to

secondary SMTP server.

MSTech-SupportPMEquivalencyMSCMLSendMailFailed This statistic displays the number of PlayCollect command

failures.

MSTech-SupportPMEquivalencyNoPortAvailErr This statistic displays the number of ‘no ports available’ errors.

MSCallControlXMLSessionCount This statistic displays the total number of CallControlXML

Sessions.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 285
 Statistic Description

MSCallControlXMLCreateCallCount This statistic displays the total number of CallControlXML calls

created through the createcall tag.

MSCallControlXMLDialogCount This statistic displays the total number of CallControlXML

dialogs.

MSCallControlXMLConfCount This statistic displays the total number of CallControlXML

conferences.

MSVoiceXMLErrorCount This statistic displays the number times an error occurs while
downloading or running a VoiceXML script.

MSVoiceXMLFilesDownloaded This statistic displays number of VoiceXML files is downloaded.

It does not include media files.

Network Server Statistics

NSCallpCallsPerSecond This statistic displays the call per seconds.

NSSipStatsInviteIns This statistic displays the total number of INVITE requests

received.

NSSipMsgPerSecond This statistic displays the sum of SIP TCP messages received
and sent and the SIP UDP messages received and sent per
second.

NSSysIntQueueTimeAvgSipEncodeQ(1000usec) This statistic displays the average SIP encoding queue holding
time. This statistic is disabled when there is more than one
threads for SIP encoding.

NSSysIntQueueTimeAvgSipDecodeQ(1000usec) This statistic displays the average SIP decoding queue holding
time.

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec) This statistic displays the average SIP redirect session manager
holding time. This statistic is disabled when there is more than
one threads for SIP redirect session manager.

NSSysIntQueueTimeMaxSipEncodeQ(msec) This statistic displays the maximum SIP encoding queue holding
time. This statistic is disabled when there is more than one
threads for SIP encoding.

NSSysIntQueueTimeMaxSipDecodeQ(msec) This statistic displays the maximum SIP decoding queue holding
time.

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec) This statistic displays the maximum SIP redirect session

manager holding time. This statistic is disabled when there is
more than one threads for SIP redirect session manager.

NSSysIntQueueTimeAvgSipRedirectSessMgr(1000usec)TX This statistic displays the average SIP redirect session manager
holding time for thread TX, where TX can be T1 … TN, the
thread number.

NSSysIntQueueTimeMaxSipRedirectSessMgr(msec)TX This statistic displays the maximum SIP redirect session

manager holding time for thread TX, where TX can be T1 …
TN, the thread number.

NSSysIntQueueTimeAvgSipEncodeQ(1000usec)TX This statistic displays the average SIP encoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

NSSysIntQueueTimeMaxSipEncodeQ(msec)TX This statistic displays the maximum SIP encoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

Execution Server Statistics

XStoSMTPtraffic This statistic displays the total number of message send

attempted on the primary SMTP server.

XSBusyHourCallAttempts This statistic displays the sum of user call origination attempts
and network call origination attempts.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 286
 Statistic Description

XSCallsPerSecond This statistic displays the call attempts per second.

XSActiveCalls This statistic displays the total number of active originating

sessions.

XSSysIntQueueTimeAvgCallHalf(1000usec)TX This statistic displays the average queue holding time for a Call
Half thread TX, where TX can be T1 … TN, the thread number.

XSSysIntQueueTimeMaxCallHalf(msec)TX This statistic displays the maximum queue holding time for a
Call Half thread TX, where TX can be T1 … TN, the thread
number.

XSSysIntQueueTimeAvgRegAdapt(1000usec)TX This statistic displays the average queue holding time for a
Registration input queue.

XSSysIntQueueTimeMaxRegAdapt(msec)TX This statistic displays the maximum queue holding time for a
Registration input queue.

XSSysIntQueueTimeAvgCallPThreadDBAccess(1000usec) This statistic displays the average queue holding time for the
Callp thread to DB access.

XSSysIntQueueTimeMaxCallPThreadDBAccess(msec) This statistic displays the maximum queue holding time for the
Callp thread to DB access.

XSSysIntQueueTimeAvgVoiceMailInAdapt(1000usec)TX This statistic displays the average queue holding time for a voice
mail input adapter thread TX, where TX can be T1 … TN, the
thread number.

XSSysIntQueueTimeMaxVoiceMailInAdapt(msec)TX This statistic displays the maximum queue holding time for a
voice mail input adapter thread TX, where TX can be T1 … TN,
the thread number.

XSSipMsgPerSecond This statistic displays the sum of SIP TCP messages received
and sent and the SIP UDP messages received and sent per
second.

XSSipRegistersInPerSecond This statistic displays the number of Register message received

per second

XSSipOptionsPerSecond This statistic displays the number of Option message received

and sent per second.

XSSipSubscribeNotifyPerSecond This statistic displays the number of Subscribe messages

received and sent and the number of Notify messages received
and sent per second.

XSSipAvgCallSetupDelay This statistic displays the average time (in milliseconds) it takes
between the receipt of an INVITE message for the origination of
a new call and the transmission of an INVITE (Sip terminator),
RQNT (MGCP terminator with in-band ringback), or CRCX
(MGCP terminator without in-band ringback) to the primary
device of the original called party (in the case of intra-group call)
or to the network element of the original called party (in the case
of a call to the PSTN).

XSSipMaxCallSetupDelay(msec) This statistic displays the longest SIP setup-signal delay

sampled since the system was started or since this
measurement was cleared.

XSSipAvgAnswerDelay(msec) This statistic displays the average time (in milliseconds)

between the receipt of a 200 OK message indicating answer or
a NTFY off-hook indicating answer and the transmission of a
200 OK indicating answer to the originator.

XSSipMaxAnswerDelay(msec) This statistic displays the longest SIP answer-signal

delay sampled since the system was started or since this
measurement was cleared.

XSSysIntQueueTimeAvgSIPEncodeQ(1000usec)TX This statistic displays the average SIP encoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 287
 Statistic Description

XSSysIntQueueTimeMaxSIPEncodeQ(msec)TX This statistic displays the maximum SIP encoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

XSSysIntQueueTimeAvgSIPCallDecodeQ(msec)TX This statistic displays the average SIP decoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

XSSysIntQueueTimeMaxSIPCallDecodeQ(msec)TX This statistic displays the maximum SIP decoding queue holding
time for thread TX, where TX can be T1 … TN, the thread
number.

XSCapMsgPerSecond This statistic displays the total number of CAP messages that
have been handled by the server.

8.9 Configure Threshold Modifier Actions

Use the Threshold Modifier Actions page to configure threshold modifier actions.

Figure 140: Threshold Modifier Actions

The information on this page includes:

Input Box Description

Reset all health status to green This input box determines if all the health status are reset at
the same time as reloading the threshold modifier definitions.
This behavior may be preferred when a reload introduces
significant changes to threshold values. Such changes may
lead to inconsistencies in the number of threshold crossings that
were triggered by the previous threshold values.

Reload threshold modifiers This input box determines the modified

ThresholdModifierItemCustom.xml file is reloaded. This check
box must be used along with unselecting the Validation Mode
Only check box.

Validation Mode Only This input box determines if the modified

ThresholdModifierItemCustom.xml file is validated before
applying the changes.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 288
 Input Box Description

Run Synchronously This input box determines if the EMS immediately reports
any error identified in the configuration file on the screen.
In addition, the EMS generates corresponding events.
Furthermore, the EMS performs the reload action only if no
errors were identified during the reload action. Otherwise, the
EMS preserves the threshold modifiers that were currently in
use. When the Run Synchronously check box is unselected, the
EMS reports any error in EMS event only.

To configure the threshold modifier actions:

1) Click the Admin tab.
2) From the Monitor/Management sub-menu, click Threshold Modifier Actions. The Threshold Modifier
Actions page appears.
3) To reset all health status to green, select the Reset all health status to green check box.
4) To reload threshold modifier, select theReload threshold modifiers check box.
5) To validate the ThresholdModifierItemCustom.xml file, select the Validation Mode Only check box.
6) To report any error identified in the configuration file on the screen, check the Run Synchronously check
box.
7) Click Submit to save these changes or click Reset to reset the previous values.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 289
9 Configuring Administration

This section provides information on how to configure EMS administration.

This section describes the following:
• Admin Tab on page 290
• Managing Nodes on page 291
• Configuring Settings After First Discovery on page 296
• Configuring Filter Actions, Traps, Events, and Alarms on page 306
• Configuring E-mail on page 336
• Managing MIBs on page 339
• Viewing Audit Trails on page 344
• Advanced Administration on page 349

9.1 Admin Tab

The Admin tab allows you to access all of the administration tools on the EMS.
The Admin tab displays the Admin menu.

Figure 141: Admin Tab

From this menu you can perform the following:

Discovery For step-by-step procedures, see Managing Nodes on page 291.

Security Administration For step-by-step procedures, see Configuring Security on page 219.

Configurations For step-by-step procedures, see the following:

• Configuring Filter Actions, Traps, Events, and Alarms on page 306
• Configuring E-mail on page 336
• Configuring Settings After First Discovery on page 296

Monitor/Management For step-by-step procedures, see the following:

• Monitoring JVM on page 270
• View the Performance Status of a Node on page 275
• Configure List of Statistics (Health Status) on page 276
• Configure Threshold Modifier Actions on page 288

Tools & Browsers For step-by-step procedures, see the following:

• Managing MIBs on page 339
• Viewing Audit Trails on page 344

Patch Management For step-by-step procedures, see Using EMS Patch Support Center on page 424.

Configuration Management For step-by-step procedures, see About Configuration Management on page 209.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 290
9.2 Managing Nodes
The EMS Discovery automatically discovers all the BroadWorks servers on the network with the following
exceptions:
• Xtended Services Platform (Xsp)
• Database Server (DBS)
• Provisioning Server (PS)
These servers must be added manually. Refresh and delete node commands are also available under this
group.
To access the add, delete and refresh node functions:
1) Click the Admin tab.
2) Select the Discovery menu. The Discovery submenu appears.
Tasks to perform from this page

9.2.1 Add Node

The EMS provides a manual Add Node feature that allows you to add individual network elements one at a
time. Although it is possible to use this approach for all nodes within an EMS span of control, its use is only
recommended for adding BroadWorks server types that the EMS auto-discovery does not support, such as
the BroadWorks Profile Server (PS), the Database Server (DBS), and the Xtended Services Platform (Xsp)
nodes. Similar to auto-discovery, when you add a node, the auto-configuration functionality is invoked.
Although it is possible to use this approach for all nodes within an EMS span of control, its use is only
recommended for adding BroadWorks server types that the EMS auto-discovery does not support, such as
the Profile Server, Database Server, and the Xtended Services Platform nodes.
The manual Add Node method must be used for adding BroadWorks servers with multiple interfaces. For
information, see Add BroadWorks Servers with Multiple Interfaces on page 39.
The EMS only adds the requested node if its auto-configuration succeeded. For information on auto-
configuration, see Managed Elements Auto-configuration on page 56.
Use the Add Node page to add a BroadWorks node
.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 291
 Figure 142: Add Node

The information on this page includes the following:

Input Box Description

User Name This text box specifies the user name for Secure Shell (SSH) access to the node.

Password This text box specifies the user password for SSH access to the node.

IP Address This text box specifies the node's Internet Protocol (IP) address.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 292
 Input Box Description

BroadWorks Platform This option specifies whether the node is a BroadWorks server.

Auto Detect BroadWorks This check box determines whether the node type is detected by the add node functionality.
Type

Server Type This drop-down list specifies the server type of the node.

Non-BroadWorks Platform This option specifies whether the node is a non-BroadWorks server.

Non-BroadWorks Platform This drop-down list specifies the server type of the node.
Server Type

Group This drop-down list specifies the name of the group associated with the node.

Associated NS (Network This drop-down list specifies the name of the Network Server seed associated with the node.
Server) Seed

SNMP Port This text box specifies the Simple Network Management Protocol (SNMP) port number.

Read Community This text box specifies the read community.

Write Community This text box specifies the write community.

Enable V3 This check box controls whether the SNMP v3 is enabled on the node.

User Name This text box specifies the SNMP v3 user name.

Context Name This text box specifies the SNMP v3 context name.

To add a node:
1) From the Discovery submenu, click Add Node. The Add Node page appears.
2) In the User Name text box, enter the SSH user name.
3) In the Password text box, enter the SSH password.
4) In the IP Address text box, enter the IP address of the node.
5) If the node is a BroadWorks server:
a) Select BroadWorks Platform, or
b) Select Auto Detect BroadWorks Type to let the add node process identify the type of node.
c) Optionally, unselect Auto Detect BroadWorks Type and select the node type from the Server Type
drop-down list.
6) If the node is not a BroadWorks server:
a) Select Non-BroadWorks Platform.
b) Select the node type from the Non-BroadWorks Platform Server Type drop-down list.
7) Select the Group to associate the node with from the drop-down list.

NOTE: The EMS uses group data for clustering and farm association. Therefore, the same group
can be reused upon adding more nodes of the same server cluster or farm. A group must contain only
nodes of the same server type.

8) Select the Associated NS (Network Server) Seed to associate the node with, from the drop-down list.

NOTE: The Network Server seed association allows the display of the node on the corresponding
BroadWorks maps.

9) In the SNMP Port text box, enter the SNMP port number.
10)In the Read Community text box, enter the read community.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 293
 11)In the Write Community text box, enter the write community.
12)If V3 is enabled on the node:
a) Select Enable V3.
b) In the User Name text box, enter the user name.
c) In the Context Name text box, enter the context name.
13)Click Submit to add the node or click Reset to discard the entries.

9.2.2 Refresh Node

Refresh a node that you have modified for changed configurations to take effect.
Use the Refresh Node page to refresh a node.

Figure 143: Refresh Node

The information on this page includes the following:

Input Box Description

Name of the Node This drop-down list specifies the name of the node as displayed on the maps or in the inventory.

SNMP Port This text box specifies the SNMP port number.

SNMP Version This drop-down list specifies the version of SNMP from a drop-down list.

User Name This text box specifies the SNMP v3 user name.

Context Name This text box specifies the SNMP v3 context name.

To refresh a node:
1) From the Discovery submenu, click Refresh Node. The Refresh Node page appears.
2) Select the name of the node from the drop-down list.
3) In the SNMP Port text box, enter the port number.
4) Select the SNMP version from the drop-down list.
5) If the SNMP version value is "V3":
a) In the User Name text box, enter the user name.
b) In the Context Name text box, enter the context name.
6) Click Refresh to refresh the node. The results of the refresh appear.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 294
 Figure 144: Refresh Results (from Admin Tab)

NOTE: Click Reset to reset the default values.

9.2.3 Delete Node

Use the Delete Node page to delete a managed node from the EMS database.

Figure 145: Delete Node

To delete a node:
1) From the Discovery submenu, click Delete Node. The Delete Node page appears.
2) Select the node(s) to delete from the Available Nodes list.
3) Click Add>. The node(s) appears on the Selected Nodes list.

NOTE: Select a node and click Remove to remove a node from the Selected Nodes list.

4) Click Delete. The node is deleted from the database.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 295
9.3 Configuring Settings After First Discovery
Use this section to configure settings after the first discovery.
For more information

9.3.1 Configure Logs

The logging service is helpful when locating bugs and configuration errors, identifying performance issues,
creating audit logs, and tracking server actions. The logging ervice outputs log messages which are stored
in log files in the form of text files (.txt). The default loggers configurations can modified at runtime.
Related information

9.3.2 Configure Security Management

Use the Security Management Configuration page to configure security management parameters.

Figure 146: Security Management Configuration

The information on this page includes the following:

Parameter Description

Maximum Allowed Unsuccessful Login Attempts This parameter specifies the maximum allowed number of
unsuccessful login attempts. Login is blocked when a user
exceeds the maximum number of login attempts. A value of "0"
indicates that there is no maximum. The default is "3".

Security Scheduler Audit Interval (ms) This parameter specifies the time interval at which the status of
a user account must be checked for expiry. When the value "0"
is specified, user accounts are never checked for expiry even if
they are marked to expire. The default is "0".

Change Password after First Login This parameter determines whether the user is forced to change
the password after the first login from a drop-down list. The
default is "false".

To configure the security parameters:

1) Click the Admin tab.
2) From the Configurations submenu, click Security. The Security Management Configuration page
appears.
3) In the Maximum Allowed Unsuccessful Login Attempts input box, enter the maximum number of login
attempts allowed.
4) In the Security Scheduler Audit Intervals (ms) input box, enter the audit interval (in milliseconds).
5) Specify whether the user is forced to change the password after the first login attempt, by selecting the
value from the Change Password after First Login drop-down list.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 296
 6) Click Submit to configure the e-mail parameters, click Reset to reset the previously saved parameters,
or click Cancel to return to the previous page.

9.3.3 Configure Performance Management

Use the Performance Management Configuration page to configure performance management parameters
at the EMS network level. Performance parameters set from this page are applied to all managed nodes.
For any changes to take effect, a restart of the EMS server is required.

Figure 147: Performance Management Configuration

The information on this page includes the following:

Parameter Description

Data Collection Start-up Delay (seconds) This parameter is used to specify the time delay after which the
data collection starts when a polled data (statistic) is created.
If you specify "0" seconds, data collection starts immediately.
Otherwise, it starts after the specified time. This setting is
common for all of the polled data created in the system. The
default is "300" seconds.

Data Collection Clean up Interval (days) This parameter controls the number of days after which tables
are deleted. Collected data is saved in the database in tables.
Each day a new table is created to save the data for the day.
The default is "30" days.

Status Polling Start-up Delay (seconds) This parameter specifies the time delay after which status
polling begins when polling is created or enabled. The default is
"300" seconds.
Use this parameter in cases where you have large networks to
be discovered and you do not want the EMS to be loaded with
both discovery and status polling. By configuring this parameter,
you can postpone the status polling.

Debugging Logs Enabled This parameter allows the enabling or disabling of debugging
logs from a drop-down list. The default is "false".

Data Collection Enabled This parameter allows the enabling or disabling of data
collection from a drop-down list. The default is "true".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 297
 Parameter Description

Status Polling Enabled This parameter allows the enabling or disabling of status polling
from a drop-down list. The default is "true". Status polling
verifies the up/down status of managed objects.

Performance Statistics Auto Reset This parameter allows the enabling or disabling of automatic
reset of performance statistics at every polling cycle from a
drop-down list. The default is "true".

Generate an email upon Health Status Change This parameter allows the enabling or disabling of automatic
generation of an e-mail upon a health status change from a
drop-down list. The default is "true". For information managing
e-mail distribution lists, see Configure E-mail Distribution Lists
on page 338

Number of historical performance reports This parameter specifies the number of historical performance
reports kept. The default is "30" reports.

To configure the performance management parameters:

1) Click the Admin tab.
2) From the Configurations submenu, click Performance. The Performance Management Configuration
page appears.
3) In the Data Collection Start-up Delay (seconds) input box, enter the data collection start-up delay (in
seconds).
4) In the Data Collection Clean up Interval (days) input box, enter the data collection clean up interval (in
days).
5) In the Status Polling Start-up Delay (seconds) input box, enter the status polling start-up delay (in
seconds).
6) Specify whether the debugging logs are enabled by selecting the Debugging Logs Enabled value from
the drop-down list.
7) Specify whether data collection is enabled by selecting the Data Collection Enabled value from the
drop-down list.
8) Specify whether status polling is enabled by selecting the Status Polling Enabled value from the drop-
down list. This parameter enables (or disables) status polling for all managed objects. To change status
polling properties for a particular managed object, use the corresponding Interface/Network/Node/
Group Properties page.
9) Specify whether the performance statistics auto reset is enabled by selecting the Performance Statistics
Auto Reset value from the drop-down list.
10)Specify whether an e-mail is generated upon the change in the health status by selecting the Generate
an email upon Health Status Change value from the drop-down list.
11)In the Number of historical performance reports input box, enter the number of historical reports.
12)Click Submit to configure the e-mail parameters, click Reset to reset the previously saved parameters,
or click Cancel to return to the previous page.

9.3.4 Configure Centralized Syslog

The Centralized Syslog Configuration module controls the forwarding of syslog messages to the EMS,
where they are converted into EMS events.

NOTE: Events that have a severity associated with them produce an alarm.

Syslog is the main logging facility on a UNIX system. Syslog messages are encoded by facility (area
of origin) and level (severity), allowing them to be easily filtered and/or sent to the correct log file.
BroadWorks centralizes syslog capabilities for all managed objects for EMS, allowing you to work with
them in much the same way as network events. For example, you can configure BroadWorks to raise
alarms for syslog messages for a particular level.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 298
 BroadWorks automatically converts syslog messages to EMS events in two steps. First, it identifies which
syslog messages are to be forwarded to the EMS. Second, it converts the received syslog messages to
EMS events.
Use the Centralized Syslog Configuration page to configure syslogs.

Figure 148: Centralized Syslog Configuration

The information on this page includes the following:

Column Description

Parameter The first row of this column is parameter Centralized Syslog

Enabled, which allows the enabling or disabling of the
centralized syslog function.
The remaining parameters in this column display the syslog
facilities supported by centralized syslog.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 299
 Column Description

Value This drop-down list specifies the logging level for the syslog
facility. Values include:
• "none": Select this value if you do not want to log any
messages for the facility.
• "debug": Select this value to display information normally of
use only when debugging a program.
• "info": Select this value to display information messages.
• "notice": Select this value to display messages that may
require special handling.
• "warning": Select this value to display messages that
indicate that an error will occur if action is not taken, for
example, a file system that is 85% full.
• "err": Select this value to display non-urgent failures that
should be reported to administrators. Each item must be
resolved within a given period of time.
• "crit": Select this value to display messages that indicate
failure in a primary system. In terms of troubleshooting, you
need to fix CRITICAL messages before ALERT messages.
• "alert": Select this value to display messages that should be
corrected immediately.
• "emerg": Select this value to display messages that indicate
an emergency condition; that is, the system cannot be used.

NOTE: The list of values is progressive. When you select

a value, all messages with a severity above that value are
included in the logs.

By default, the only messages collected by the EMS for centralized syslog management are auth.err,
daemon.err, kern.err, and local2.warning.
To a modify a syslog:
1) Click the Admin tab.
2) From the Configurations submenu, click Syslog. The Centralized Syslog Configuration page appears.
3) Select the logging value from the drop-down list of each syslog facility.
4) Click Save to save the changes, click Reset to reset the default values, or click Cancel to return to the
previous page.

9.3.5 Configure Auto-Configuration Parameters

Use the Auto-Config Management Configuration page to configure auto-configuration parameters.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 300
 Figure 149: Auto-Config Management Configuration

The information on this page includes the following:

Parameter Description

Audit Interval (hours) This parameter specifies the number of hours between audits.
The default is "24".

Audit Retry Interval (hours) This parameter specifies the number of hours between audit
retry attempts. If during the auto-configuration process some
nodes failed to be configured, another attempt is made to auto-
configure these nodes after the specified interval. The default is
"1".

Transport Protocol This parameter specifies the transport protocol used to perform
the auto-configuration from a drop-down list. The default is
"SSH".

Expected Telnet Login Prompt This parameter specifies the login prompt for Telnet. The default
is "login".

Expected Telnet Password Prompt This parameter specifies the password for logging in to Telnet.
The default is "assword".

Maximum Number of SSH and Telnet Connections in the This parameter specifies the maximum number of active SSH/
System Telnet connections permitted in the EMS. When the maximum
is reached, any new auto-configuration, remote command, or an
SSH/telnet cut-through fails. The default is "40".

Maximum Number of SSH and Telnet Connections per Node This parameter specifies the maximum number of active SSH/
Telnet connections permitted per node. When the maximum is
reached, any new auto-configuration, remote command, or an
SSH/telnet cut-through fails. The default is "10".

Remote Node Login Timeout (secs) This parameter specifies the number of seconds to wait before
returning from a failed attempt to log in to a remote server. The
default is "5".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 301
 Parameter Description

Remote Node Request Execution Timeout (secs) This parameter specifies the number of seconds to wait before
returning from a failed attempt to execute a command on a
remote server. The default is "60".

To configure the auto-config parameters:

1) Click the Admin tab.
2) From the Configurations submenu, click Auto-Config. The Auto-Config Management Configuration
page appears.
3) In the Audit Interval (hours) input box, enter the audit interval.
4) In the Audit Retry Interval (hours) input box, enter the audit retry interval.
5) Select the Transport Protocol value from the drop-down list.
6) In the Expected Telnet Login Prompt input box, enter the expected Telnet login prompt.
7) In the Expected Telnet Password Prompt input box, enter the Telnet password prompt.
8) In the Maximum Number of SSH and Telnet Connections in the System input box, enter the maximum
number of SSH and Telnet connections allowed in the system.
9) In the Maximum Number of SSH and Telnet Connections per Node input box, enter the maximum
number of SSH and Telnet connections allowed per node.
10)Click Submit to configure the e-mail parameters, click Reset to reset the previously saved parameters,
or click Cancel to return to the previous page.

9.3.6 Configure Miscellaneous Settings

Use the Misc Management Configuration page to configure miscellaneous configuration parameters.

Figure 150: Miscellaneous Management Configuration

The information on this page includes the following:

Parameter Description

Network Discovery Reconnection Interval (minutes) This parameter specifies the interval in minutes before a
discovery reconnection is attempted. A discovery reconnection
only occurs when a discovery fails and the rediscovery option
is enabled. When the rediscovery option is not enabled, this
parameter is not used. The default is "60".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 302
 Parameter Description

Listen Port for Client Communication This parameter is used for the communication between the
client and the EMS server. The default is "36002".

FE Secondary Listen Port for Client Communication This parameter is used for the communication between the
client and the EMS Front End (FE). It represents a secondary
port used by optional services. The default is "36001".

RMI Secondary Listen Port for Client Communication This parameter is used for the Telnet/SSH communication
between the client and the active Back End (BE). The default is
"36003".

FE RMI Secondary Listen Port for Client Communication This parameter is used for the Telnet/SSH communication
between the client and the Front End (collocated with the
standby Back End). The default is "36004".

Time Credit (Days) This parameter is used for the BWStaleAccountPolicy and
the login check for the stale account user. The time credit in
days sets the maximum number of days a user account can be
inactive. On successful login, this period of inactivity is reset.
The default is "10".

Group to Exclude from Stale Account Check This parameter is used for excluding a particular group of users
from the stale account logic. Usually, the "Admin" group is
excluded to prevent disabling every account. The default is
"Admin".

To configure the miscellaneous parameters:

1) Click the Admin tab.
2) From the Configurations submenu, click Misc. The Misc Management Configuration page appears.
3) In the Network Discovery Reconnection Interval (minutes) input box, enter the network discovery
reconnection interval (in minutes).
4) In the Listen Port for Client Communication input box, enter the port for listening for client
communications.
5) In the FE Secondary Listen Port for Client Communication input box, enter the FE secondary port for
listening for client communications.
6) In the RMI Secondary Listen Port for Client Communication input box, enter the RMI secondary port for
listening for client communications.
7) In the FE RMI Secondary Listen Port for Client Communication input box, enter the FE RMI secondary
port for listening for client communications.
8) In the Time Credit (Days) input box, enter the time credit (in days).
9) In the Group to Exclude from Stale Account Check input box, specify whether there is a group excluded
from the stale account check.
10)Click Submit to configure the e-mail parameters, click Reset to reset the previously saved parameters,
or click Cancel to return to the previous page.

9.3.7 Configure Fault Management Parameters

Use the Fault Management Configuration page to configure fault management parameters. The Fault
Management Configuration page presents event and alarm parameters you can use to change the default
fault management functionality.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 303
 Figure 151: Fault Management Configuration

The information on this page include the following:

Parameter Description

Event Holding Time (days) This parameter specifies the number of days that events are
maintained in the EMS. The events older than this number of
days are removed from the system. A check for older events
is done once an hour. When a negative value is specified for
the parameter, events are not deleted by EMS based on a time
interval. The default is "7".

Number of Events Managed by EMS This parameter specifies the latest number of events that are
managed by the EMS. The default is "10000".

Drop Traps of Unmanaged Object This parameter specifies whether processing of a Simple
Network Management Protocol (SNMP) trap continues when the
corresponding managed object is in an unmanaged state. When
the value is set to "true", the trap is dropped. When the value is
set to "false", the trap is processed. The default is "false".

Enable Authorization This parameter enables/disables an authorization check when

a user tries to perform a fault management operation, such as
picking up alarms. The authorization checks that a user has
the necessary permission to perform a specific operation. The
default is "true".

Enable Authentication for SNMP v3 Traps This parameter enables/disables authentication for SNMP V3
traps. The default is "false".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 304
 Parameter Description

Acknowledge Inform Request This parameter specifies whether inform requests are
acknowledged from a drop-down list. Inform requests are
unsolicited notifications sent to SNMP managers by agents
or other managers. Usually, these are acknowledged by the
receiving manager. However, these acknowledgments result
in an increase in network traffic. This parameter allows you to
turn the acknowledgment mechanism on and off. The default is
"false".

Delete Clear Alarms Interval (hours) This parameter specifies the number of hours after which alarms
with "clear" (and unchanged) severity are automatically deleted.
The default is "24".
Setting this parameter to "0" results in the immediate deletion
of clear alarms. Specifying a negative value results in no
automatic deletion of clear alarms based on age.
The system performs the initial check for clear alarms one hour
after server start-up. After the initial check, it checks again at
the regular interval specified by this value.

Number of Alarms Managed by EMS This parameter specifies the latest number of alarms that are
managed by the EMS. The default is "10000".

Create Alarm History Objects This parameter specifies whether alarm history objects are
created to track the various operations performed, for example,
the addition, deletion, and update of alarms. The default is
"false".

Remove Annotations on Alarm Deletion This parameter specifies whether the annotations and/or history
of alarms are removed when an alarm is deleted from a drop-
down list. The default is "both".

Remove Corresponding Alarms on Managed Object Deletion This parameter specifies the action taken on an alarm if its
corresponding managed object is deleted.
Possible values are "delete", "clear", and "none". The default is
"delete".

To configure the fault management parameters:

1) Click the Admin tab.
2) From the Configurations submenu, click Fault. The Fault Management Configuration page appears.
3) In the Event Holding Time (days) input box, enter the event holding time in days.
4) In the Number of Events Managed by EMS input box, enter the number of events managed by the
EMS.
5) Specify whether traps are dropped for an unmanaged object by selecting the Drop Traps of
Unmanaged Object value from the drop-down list.
6) Specify whether authorization check is enabled by selecting the Enable Authorization value from the
drop-down list.
7) Specify whether authentication is enabled for SNMP v3 trap by selecting the Enable Authentication for
SNMP v3 Traps value from the drop-down list.
8) Specify whether inform requests are acknowledged by selecting the Acknowledge Inform Request value
from the drop-down list.
9) In the Delete Clear Alarms Interval (hours) input box, specify the number of hours after which cleared
alarms are deleted.
10)In the Number of Alarms Managed by EMS input box, specify the number of alarms managed by the
EMS.
11)Specify whether alarm history objects are created by selecting the Create Alarm History Objects value
from the drop-down list.
12)Specify whether annotations are removed on alarm deletion by selecting the Remove Annotations on
Alarm Deletion value from the drop-down list.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 305
 13)Specify whether the corresponding alarms are removed (cleared) when managed objects are deleted
by selecting the Remove Corresponding Alarms on Managed Object Deletion value from the drop-down
list.
14)Click Submit to configure the e-mail parameters, click Reset to reset the previously saved parameters,
or click Cancel to return to the previous page.

9.4 Configuring Filter Actions, Traps, Events, and Alarms

Overview of Notification Flow
In the EMS, an event is the basic unit of management information that is complete in itself and relates to
an occurrence such as the discovery of an element, status update of an element, or failure in an element.
The events form a repository of information for all the occurrences in the system. The alarms result from
the correlation of events that represent failures or faults in network elements that may need immediate
attention.
Fault Management Architecture
The EMS has a flexible architecture where filters and parsers can be plugged in easily. Filters help in
validating the notifications received from managed elements and also in applying domain specific rules.
Rules can be structured to validate the incoming events based on time(s), threshold(s), or count(s). For
example, transient system failures occur as a normal part of network operation. Rules become quite handy
in these circumstances and can be used to filter out transient network failures. This helps in reducing the
thousands of events to ten or twenty actual problems that need to be addressed. Parsers are simple but
powerful mechanisms that help in disseminating the raw data as fast as possible to the concerned parties,
in a meaningful manner.
The EMS allows automated action to be taken at various levels of the event flow. Some of the actions
supported out of box include e-mail, paging, command execution, custom actions, and so on. Separate
from the automated actions, it has a powerful notification mechanism.
Notifications and Alarms
BroadWorks defines two types of faults: notifications and alarms. Notifications describe punctual events
that can occur throughout the lifetime of the application. Events such as unauthorized access, security
violations, status reports, added/deleted resources, unreachable servers, and software errors can be the
object of notifications. The system health report is a good example of a notification. A monitored device
sends it periodically to provide a snapshot of its health at a certain moment. The severity of this notification
depends on the health of the monitored device.
Alarms warn that the system is currently in an abnormal state, but that the situation could change (for
better or worse) over time. Alarms are raised at the start of the abnormal state and are cleared upon return
to a normal state. They are used to represent events such as connectivity loss, unresponsive software
components, reached threshold limits, and resource exhaustion. Alarms have a state that determines
whether they are On or Off.
For more information

9.4.1 Configure Filter Actions

Whenever an event/alarm enters the Event/Alarm Filter matching a specific criteria, you can configure EMS
to automatically execute some actions. EMS supports the following types of actions:
• Run Command Action: Run a system command on the EMS
• Send Trap Action: Send v1 or v2c trap
• Send E-mail Action: Inform the network administrator through e-mail
• Custom Filter Action: Invoke custom Java class for addressing application-specific needs
Use the Filter Actions page to view, modify, or delete the actions.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 306
 Figure 152: Filter Actions

The information on this page includes the following:

Action Name Description

BwFilterAction BwFilterActionThis filter action is used by both the BWEventFilter event filter and the BWAlertFilter
alarm filter . It manages the severity icon associated with the group icon in the map. When alerts
are received, their associated group is determined based on the source of the alert. The severity
associated with the group is then adjusted based on the severity of the alert being processed.

BWFilterForThreshold This filter action adjusts the event name with the name of the statistics for which the threshold was
crossed. It is associated with the BWEventFilterForThreshold event filter.

BWFilterForSyslog This filter action adds an event name property containing the type/source of the syslog to the
event. For example, when the syslog comes from the ssh daemon, the event name is "sshd". It is
associated with the BWEventFilterForSyslog event filter.

BWFilterForHealth This filter action processes all EMS internally generated health/threshold events. The information
contained in the events is analyzed and used as input to the health functionality. It is associated with
the BWEventFilterForHealth event filter.

BwAudibleAlarmAction This filter action is associated with the BWAudibleAlarm alarm filter. It checks every incoming alarm
against the configured audible alarm filters. In case of a match, the defined audible alarm is played.
For information on configuring audible alarm filters, see Managing Audible Alarms on page 382.

To access the filter actions:

1) Click the Admin tab.
2) From the Configurations submenu, click Filter Actions. The Filter Actions page appears.
To view filter actions of a specific type:
On the Filter Actions page, select the type of actions from the View Actions drop-down menu. The list of
filter actions of that type appears.
To modify an existing filter action:
1) On the Filter Actions page, click the modify icon to the right of the name of the action. The Configure
page corresponding to that action appears.
2) Modify the required fields.
3) Click Submit. The Action list displays the action with the changes.
To delete an existing filter action:
On the Filter Actions page, click the delete icon on the row of the action to delete. Click OK to confirm the
delete operation. The action is removed from the list.
Tasks to perform from this page

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 307
9.4.1.1 Add Suppress Action
Use the Configure Suppress Action page to add a suppress notification. The suppress action type allows
you to suppress (drop) events that match the filter criteria, either altogether or multiple events of the same
type within a given interval.

Figure 153: Configure Suppress Action

The information on this page includes the following:

Input Box Description

Action Name This text box specifies the name of the action.

Suppress All This option indicates how to suppress incoming events. Yes suppresses all subsequent events and
No allows the first event and suppresses subsequent events during the specified interval.

Suppress Interval (in secs.) This text box specifies a numeric value (in seconds) to suppress multiple events for a given interval.
The first event that matches the configured criteria is allowed and all the subsequent events are
suppressed for the given interval. After the suppress interval has elapsed, another event that
matches the criteria is allowed and the subsequent events are again suppressed, and so on.

To add a suppress notification:

1) On the Filter Actions page, click Add Actions: Suppress. The Configure Suppress Action page
appears.
2) In the Action Name input box, enter the name of the notification.
3) To suppress all subsequent events, select Yes. Otherwise, select No and enter the number of seconds
before events are allowed.
4) Click Submit. The Filter Actions page displays this new action on the list of actions.

9.4.1.2 Add Run Command Action

Use the Configure Run Cmd Action page to add a run command action. This action type allows you to
run a command on the server for events that match the filter criteria. It can be used to invoke a reminder
application or any other system command.

Figure 154: Configure Run Cmd Action

The information on this page includes the following:

Input Box Description

Action Name This text box specifies the name of the action.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 308
 Input Box Description

System Command This text box specifies the name of the system command to be executed. The command string
should be a machine-executable program on the server, which does not require a shell (it cannot be
a batch or a shell file).

AbortAfter(Seconds) This text box specifies the time (in seconds) after which the command execution is to be terminated
(that is, the time-out value of the specified command). This value plays an important role if even one
of the above check boxes is checked, since the entire event processing is held up by the command
execution.

Append Output This option controls whether the output of the command is appended to the event message.
Checking either one or both of the check boxes results in the command being run synchronously in
the main event processing thread. This delays all events that follow the event being processed until
the command execution is completed or terminated by time-out.

Append Error This option controls whether the error output from the command is appended to the event message.
Checking either one or both of the check boxes results in the command being run synchronously in
the main event processing thread. This delays all events that follow the event being processed until
the command execution is completed or terminated by time-out.

To add a run command notification:

1) On the Filter Actions page, click Add Actions: Run Cmd. The Configure Run Cmd Action page
appears.
2) In the Action Name input box, enter the name of the action.
3) In the System Command input box, enter the name of the system command to execute.
4) In the AbortAfter(Seconds) input box, enter the number of seconds after which the command execution
is to be terminated.
5) To append the output of the command to the event message, select Append Output.
6) To append any error associated with the command to the event message, select Append Error.
7) Click Submit. The Filter Actions page displays this new action on the list of actions.

9.4.1.3 Add Send Trap Action

Use the Configure Send Trap Action page to send a trap on the receipt of a specific notification.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 309
 Figure 155: Configure Send Trap Action

The information on this page includes the following:

Input Box Description

Action Name This text box specifies the name of the action.

Trap Destination This text box specifies the destination host of the trap.

Destination Port This text box specifies the destination port of the trap.

Community This text box specifies the community value of the trap.

SysUpTime This text box specifies the sysuptime value to use in the trap.

V1 Settings/V2C Settings These input boxes specify the type of the SNMP trap to send.

Enterprise This text box specifies the enterprise object identifier (OID) of the trap.

Generic Type This text box specifies the GT number of the trap (applicable only to SNMP v1).
Generic type value ranges from "0" to "6":
"0" denotes coldStart.
"1" denotes warmStart.
"2" denotes linkDown.
"3" denotes linkUp.
"4" denotes authenticationFailure.
"5 "denotes egpNeighborLoss.
"6" denotes enterprise-specific.

Specific Type This text box specifies the ST number of the trap. This is applicable only to SNMP v1 and when the
Generic Type is specific to the enterprise.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 310
 Input Box Description

Trap OID This text box specifies the OID of the trap that is being sent. This is applicable only to SNMP V2C.

Variable Bindings

OID This text box specifies the OID of the varbind.

OID Type This drop-down list allows the specification of the type of the varbind.

OID Value This text box specifies the value of the varbind.

To add a send trap notification:

1) On the Filter Actions page, click Add Actions: Send Trap. The Configure Send Trap Action page
appears.
2) In the Action Name text box, enter the name of the action.
3) In the Trap Destination text box, enter the trap destination host.
4) In the Destination Port text box, enter the trap destination port.
5) In the Community text box, enter the community value.
6) In the SysUpTime text box, enter the sysuptime value.
7) Click on the type of SNMP trap to send.
8) Configure the SNMP settings:
• For V1 settings:
1) In the Enterprise input box, enter the enterprise OID.
2) In the Generic input box, enter the trap-generic type.
3) In the Specific input box, enter the trap-specific type.
• For V2 settings, in the Trap OID input box, enter the trap OID.
9) To add variable binding to the trap, click Show Varbind Details.
a) Enter the varbind OID.
b) Select the varbind type from the drop-down list.
c) Enter the varbind value.
d) Click Add. The complete value appears in the Variable Bindings input box. Click Modify to change
the value or click Delete to remove the value.
10)Click Submit. The Filter Actions page displays this action on the list of actions.

9.4.1.4 Add Send E-mail Action

This action type allows you to send e-mails when the incoming event matches the filter criteria. Use the
Configure Send E-Mail Action page to send an e-mail of the receipt of a specific notification.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 311
 Figure 156: Configure Send E-mail Action

The information on this page includes the following:

Input Box Description

Action Name This text box specifies the name of the action.

SMTP Server This text box specifies the name (or Internet Protocol [IP] address) of the mail server.

Account Name This text box specifies the user name that the mail server uses for authentication.

Password This text box specifies the password that the mail server uses for authentication.

To Mail ID This text box specifies the destination address to which the e-mail should be sent.

From Mail ID This text box specifies the sender's address from which the e-mail is being sent.

Subject This text box specifies the subject of the e-mail. You can concatenate the available event properties
as required, by selecting them from the input boxes.

Message This input box specifies the contents of the message. You can concatenate the available event
properties by selecting them from the input boxes.

Attachment This text box specifies the absolute path of the attachment to e-mail.

To add a send an e-mail notification:

1) On the Filter Actions page, click Add Actions: Send Email. The Configure Send Email Action page
appears.
2) In the Action Name text box, enter the name of the notification.
3) In the SMTP Server text box, enter the name of the Simple Mail Transfer Protocol (SMTP) server.
4) In the Account Name text box, enter the name of the e-mail account.
5) In the Password text box, enter the password of the e-mail account.
6) In the To Mail ID text box, enter the identification of the e-mail recipient.
7) In the From Mail ID text box, enter the identification of the e-mail sender.
8) In the Subject text box, enter the subject.
9) In the Message input box, enter the message.
10)Enter the path of the attachment (if required).
11)Click Submit. The Filter Actions page displays this notification on the list of notifications.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 312
 In the Subject and Message input boxes variables can be used to insert information obtained from the
alarm/event. The possible variables are described in the following table.
Variable Description

$category This variable corresponds to the alarm/event category. Some of the possible values are
"applicationserver", "mediaserver", "elementmanagementsystem", "profileserver", and
"xtendedservicesplatform".

$entity This variable corresponds to the concatenation of the source and the alarm/event name, for
example, viras03.mtl.broadsoft.com--bwSystemHealthReport where viras03.mtl.broadsoft.com is the
source server and bwSystemHealthReport is the alarm/event name.

$text This variable corresponds to the alarm/event text.

$message This variable is always empty.

$severity This variable corresponds to severity of the alarm/event. It can have the following values:
"1" for Critical, "2" for Major, "3" for Minor, "4" for Warning, "5" for Clear, and "6" for Informational

$source This variable corresponds to the source server of the alarm/event.

$groupName This variable corresponds to the name of the group the source server belongs to.

9.4.1.5 Add Custom Filter Action

NOTE: You can also write your own Java class to perform some actions according to your requirement.
This class can be invoked when the incoming events satisfy the filter criteria. This feature requires Java
coding expertise. To create custom filter actions, contact BroadSoft.

Use the Configure Custom Filter page to create a custom filter action.

Figure 157: Configure Custom Filter

The information on this page includes the following:

Input Box Description

Action Name This text box specifies the name of the action.

User Class This text box specifies the name of the Java class that implements this filter action.

To add a custom filter action:

1) From the Filter Actions page, click Add Actions:Custom Filter. The Configure Custom Filter page
appears.
2) In the Action Name text box, enter the name of the action.
3) In the User Class text box, enter the name of the Java class to associate with this action.
4) Click Submit. The Filter Actions page displays this action on the list of actions.

9.4.2 Configure Trap Parsers

Traps are cryptic messages regarding faults that occurred in an SNMP device. These traps must be
represented in a human-readable form, and more importantly, as administrative messages that completely
define the problem. Since every piece of information available in the fault report can be accessed, it is

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 313
 possible to define the messages exactly as required. When a trap is received, trap parsers generate useful
and appropriate event information. In the overall event flow, a received trap is passed through a level of
trap parsers only if the trap has not been converted into an event object by a trap filter or if the received
trap has not been dropped during trap filtering. The output of a trap parser is an event.

NOTE: By default, all BroadWorks traps are converted into corresponding events by BroadWorks trap
filters; therefore, they do not reach the trap parser level. If you want to overwrite this default behavior,
contact BroadSoft.

The match criteria in the parser determine whether a specific trap matches the trap parser. The search for
matching trap parsers is done based on how the trap parsers are ordered on the list. Once a matching trap
parser is found, an event is generated by applying the corresponding trap parser. Only one trap parser is
applied to a given trap and no other trap parsers are applied to that trap.
Use the Trap Parser Configuration page to view, modify, or delete the trap parsers.

Figure 158: Trap Parser Configuration

The information on this page includes the following:

Parser Name Description

coldStart This parser looks for incoming coldStart traps to populate and raise a corresponding event of a
major severity.

warmStart This parser looks for incoming warmStart traps to populate and raise a corresponding event of an
info severity.

egpNeighborLoss This parser looks for incoming egpNeighborLoss traps to populate and raise a corresponding event
of a minor severity.

authenticationFailure This parser looks for incoming authenticationFailure traps to populate and raise a corresponding
event of a minor severity.

BwCsNotif This parser looks for all incoming Conferencing Server trap notifications. When this type of trap
is received, this parser extracts the relevant parameters from the trap to populate and raise a
Conferencing Server event.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 314
 Parser Name Description

BWDefaultForCS This parser looks for all incoming Conferencing Server trap notifications that have not been parsed
by BwCsNotif. This parser extracts the relevant parameters from the trap to populate and raise a
Conferencing Server event.

NOTE: You should not modify or reorder the default trap parsers that are stopped with your EMS as it
might impact the proper behavior of Fault Management. You should only change trap parsers that have
been added since the system was installed.

To access trap parsers:

1) Click the Admin tab.
2) From the Configurations submenu, click Trap Parsers. The Trap Parsers page appears.
To modify a trap parser that has been added to EMS:
1) On the Trap Parsers page, click on the link of the parser to view. The Modify Trap Parser page appears.
2) Modify the input boxes as required. For information on the input boxes on this page, see Add Trap
Parser on page 315.
3) Click Submit to save the changes, click Reset to revert to the previously saved settings, or click
Cancel to return to the previous page.
To enable a trap parser that has been added to EMS:
1) On the Trap Parsers page, select the parsers to enable.
2) Click Enable. The trap parsers are enabled.
To disable a trap parser that has been added to EMS:
1) On the Trap Parsers page, select the parsers to disable.
2) Click Disable. The trap parsers are disabled.
To delete a trap parser that has been added to EMS:
1) On the Trap Parsers page, select the parsers to delete.
2) Click Delete. The trap parsers are deleted.
Tasks to perform from this page

9.4.2.1 Add Trap Parser

Use the Add New Parser page to add a trap parser.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 315
 Figure 159: Add Trap Parser

The information on this page includes the following:

Input Box Description

Parser Name This input box specifies the name to identify the parser.

Match Criteria (of

incoming traps)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 316
 Input Box Description

Nodes Match criteria based on the source of the received trap matching one of the specified nodes. This is
an optional match criterion.
For an SNMPv1 trap, the agent address returned by the trap is used when matching the property
value. For SNMPv2c, the source address returned by the trap is used when matching the property
value.
Use the comma separator to specify more than one node. You can use the wildcard (*) character
and the negation (!) character in this input box.

Groups Match criteria based on the source of the received trap matching one of the specified groups. This is
an optional match criterion.
For an SNMPv1 trap, the agent address returned by the trap is used when matching the property
value. For SNMPv2c, the source address returned by the trap is used when matching the property
value.
Use the comma separator to specify more than one node. You can not use the wildcard (*)
character and the negation (!) character in this input box.

Enterprise This input box is associated with the SNMP V1 button only. Specify the enterprise object ID (OID)
of the SNMPv1 trap. When specified, the parser is applied only if the incoming trap's enterprise OID
starts with what is specified in this input box.
If the enterprise OID is specified as .1.3.6.1.2.1.11, all the OIDs under this tree are matched for
traps. To avoid this kind of matching, enter the enterprise OID value in angular brackets, such as
<.1.3.6.1.2.1.11> If the value is given as "*", then all the OIDs are matched.

Generic Type This input box is associated with the SNMP V1 button only. Each SNMPv1 trap has a generic type
number that can be specified as a match criterion. When specified, the trap parser is applied only if
the incoming traps match the specified generic type number.

Specific Type This input box is associated with the SNMP V1 button only. Each SNMPv1 trap has a specific type
number that can be specified as a match criterion. When specified, the trap parser is applied only if
the incoming traps match the specific type number.

Trap OID This input box is associated with the SNMP V2C & V3 button only. An SNMP V2C or SNMP V3 trap
is uniquely identified by the trap OID that is associated with the Trap Protocol Data Unit (PDU). This
trap OID can be specified as a match criterion.
The trap parser is applied only if the incoming trap has a value that starts with the OID specified in
this input box. When a trap OID is specified, all traps that start this OID are matched and the trap
parser is applied. If you want to match the exact OID, specify the trap OID within angular brackets
<>.
The wildcard (*) character can be used in this input box.

Event Properties (of output

events)

Severity This drop-down list specifies the state of the event that determines the severity. This severity
determines how an alarm is affected by this event. For a given failure object, the severity specified
for the event correlates with the severity of the corresponding alarm.

Event Details This input box specifies the details of the event. If you type directly into the input box, the content is
saved. Otherwise, you can specify variables. For information on valid variables, see the Variables
table that follows.

Source This input box specifies the source of the event. If you type directly into the input box, the content is
saved. Otherwise, you can specify variables. For information on valid variables, see the Variables
table that follows.

Source -- Alarm Name or This input box specifies the source, alarm name, or category associated with the event. If you
Category type directly into the input box, the content is saved. Otherwise, you can specify variables. For
information on valid variables, see the Variables table that follows.

Category This input box specifies the category associated with the event. If you type directly into the input
box, the content is saved. Otherwise, you can specify variables. For information on valid variables,
see the Variables table that follows.

Group Name This input box specifies the group name associated with the event. If you type directly into the input
box, the content is saved. Otherwise, you can specify variables. For information on valid variables,
see the Variables table that follows.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 317
 Input Box Description

Node This input box specifies the node associated with the event. If you type directly into the input box,
the content is saved. Otherwise, you can specify variables. For information on valid variables, see
the Variables table that follows.

Variables
Variable Description

$Agent SNMP V1 Traps:

If the device corresponding to the agent address returned by the trap has been discovered by the
EMS, this variable fetches the name of the parent corresponding to the interface object matching
the agent address of the trap received. If the device corresponding to the agent address of the
trap has not been discovered, this variable returns the corresponding IP address of the agent
address from which the trap has been received. For example, a trap is received from an agent
and the corresponding device has been discovered by the EMS with the interface object of IF-
webserver and the name of the parent managed object is webserver. In this scenario, %Agent
returns webserver.
If the device is not yet discovered, %Agent returns the IP address, such as 192.168.1.30.
SNMP V2C and V3 Traps:
If the device corresponding to the source address contained by the received trap has already
been discovered by the EMS, this variable fetches the name of the parent that corresponds to the
interface object matching the source address of the received trap. If the device corresponding to
the source address of the trap has not been discovered, this variable returns the IP address of the
source of the trap.

$Community This variable is replaced by the community string of the received trap.

$Enterprise This variable is replaced by the enterprise ID of the received trap. This variable is applicable to
SNMP traps only; for non-SNMP traps, it is replaced with "".

$GenericType This variable is replaced by the generic type of the received trap. This variable is applicable to
SNMP V1 traps only. For non-SNMP traps, it is replaced with "".

$Source If the device corresponding to the source address contained by the received trap has been
discovered by the EMS, this variable fetches the name of the parent that corresponds to the
interface object that matches the source address of the received trap. If the device corresponding to
the source address of the received trap has not been discovered, the corresponding IP address of
the source address is returned.

$SpecificType This variable is replaced by the specific type of the received trap and is applicable to SNMP v1
traps only. For non-SNMP traps, it is replaced with "".

$Uptime This variable is replaced by the uptime value in the received trap.

$TrapOID This variable is replaced by the trap OID of the received trap. This variable is applicable to SNMP
V2C traps only. For non-SNMP traps, it is replaced with "".

$* This variable is replaced by all the variable bindings (both OID and variable values) of the received
trap.

$# This variable is replaced by all the variable binding values (only variable values and not OIDs) of
the received trap.

$N For this variable, N is a non-negative integer. This variable is replaced by the (N+1)th SNMP
variable value in the variable bindings of the received trap. The Index N starts from 0.

@* This variable is replaced by all the OID labels in the variable bindings of the received trap.

@N This variable is replaced by the (N+1)th OID value in the variable bindings of the received trap.
The index count starts from "0". This variable is replaced by the (N+1)th OID label in the variable
bindings of the received trap.

$IP-Source This variable is replaced by the IP address corresponding to the source address of the received
trap.

$IP-Agent This variable is replaced by the IP address corresponding to the agent address of the received trap.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 318
 Variable Description

Special Purpose Tokens

NOTE: The associated object (server, interface, and so on) should have been discovered already
by the EMS for using the following special purpose tags (or variables). This is applicable to all
special purpose tags (or variables) enumerated in this section.

$AgentMO This variable enables access to managed object properties. The tag can be used to access any
properties of the parent managed object for the interface object corresponding to the agent address
of the received trap.

$IF-AgentMO This variable is similar to $AgentMO, except that the properties of the interface MO that
corresponds to the agent address of the received trap can be accessed using this tag. For SNMP
V2C traps, it is exactly the same as $IF-SourceMO.

$IF-Agent This variable is similar to $Agent, except that it results in the interface MO name that corresponds
to the agent address of the trap received. For SNMP V2C traps, it is exactly the same as $IF-
Source.

$SourceMO This variable can be used to access any properties of the parent for the interface object that
corresponds to the source address of the received trap. For example, if you want to access
the pollInterval property of the parent managed object corresponding to the source address
of the received trap and assign it to some property of the event, you must specify the tag as
$SourceMO(pollInterval) against the specific property of the event.

$IF-SourceMO This variable is similar to $SourceMO, except that the properties of the interface MO that
correspond to the source address of the received trap can be accessed using this tag.

$IF-Source This variable is similar to $Source, except that it results in the interface object name that
corresponds to the source address of the received trap.

To add a trap parser:

1) On the Trap Parser Configuration page, click Add Trap parser. The Add New Parser page appears.
2) In the Parser Name input box, enter the name of the parser.
3) Enter the match criteria:
a) To match on a node, in the Nodes input box, enter the node(s).
b) To match on a group,in the Groups input box, enter the group(s).
c) Click on the version type to specify the SNMP version:
• If the SNMP version is V1:
• To match on an enterprise, in the Enterprises input box, enter the enterprise(s).
• To match on a trap generic type, in the Generic input box, enter the generic type.
• To match on a trap specific type, in the Specific input box, enter the specific type.
• If the SNMP version is V2C or V3, enter the trap OID.
4) Enter the values of the event properties. They can be extracted from the incoming trap properties or
new values can be entered.
a) To specify the event severity, select the value from the Severity drop-down list.
b) To specify the event details, in the Event Details input box enter the value of the event details.
c) To specify the source, in the Source Input box enter the value of the source.
d) To specify the source-- alarm name or category, in the Source - Alarm Name or Category input box
enter the value of the source alarm name or category.
e) To specify the category, in the Category input box enter the value of the category.
f) To specify the group name, in the Group Name input box enter the value of the group name.
g) To specify the node, in the Node input box enter the value of the node.
5) Click Submit. TheTrap Parser Configuration page displays this trap parser on the list of trap parsers.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 319
9.4.2.2 Load Trap Parsers

Figure 160: Load Trap Parsers

The information on this page includes the following:

Input Box Description

Overwrites existing Trap This option controls whether the existing trap parsers (with the same matching criteria) are
Parsers overwritten with the new trap parsers in the file.

MIB File Name Rather than specifying the match criteria manually, a MIB with defined traps can be translated to
trap parsers. This text box specifies the name of the MIB file to load.

Filename To load a set of trap parsers previously saved using the Save To File option and add them to the
existing list of trap parsers, you can choose the Load From File option. This text box specifies the
name of the trap parser file to load.

To load trap parsers:

1) On the Trap Parser Configuration page, click Load parsers. The Load Parsers page appears.
2) To overwrite existing trap parsers with the new trap parsers in the file, check Overwrites existing Trap
Parsers.
3) To load trap parsers from a MIB file:
a) In the MIB File name text box, enter the name of the MIB file.

NOTE: This file name should be specified with the path relative to <EMS Home>/mibs directory.
If the MIB depends on any other MIB files, then these dependency files should be mentioned with
spaces in between them, followed by this MIB file. For example, if A-MIB imports B- MIB, which
imports C-MIB (all the files in <EMS Home>/mibs directory), then it should be specified as the
following:
../mibs/C-MIB ../mibs/B-MIB ../mibs/A-MIB
Trap parsers are only created from the last MIB file.

b) Click Load. The trap parsers are loaded. Click Cancel to return to the previous page.
4) To load trap parsers from a file:
a) In the Filename text box, enter the name of the file. Click Cancel to return to the previous page.
b) Click Load. The trap parsers are loaded.

9.4.2.3 Save Trap Parsers to File

Use the Save parsers to a file section to save trap parsers to a file.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 320
 Figure 161: Save Trap Parser

The information on this page includes the following:

Input Box Description

This input box specifies the name of the trap parser file.

To save a trap parser to a file:

1) From the Trap Parser Configuration page, click Save to file. The Save parsers to a file section appears.
2) Enter the name of the file to save the trap parsers to.
3) Click Save to file. The trap parsers are saved to the specified file. Click Cancel to return to the
previous page.

9.4.3 Configure Event Parsers

Use the Event Parsers page to view, modify, or delete the event parsers.
To identify the failure object corresponding to an event, the traps and the input events should be parsed
and the necessary details should be displayed.
The trap parser makes the notifications readable to the user. Event parsers refine the message conveyed
by the events. Though both the trap parser and the event parser seem to function identically, the event
parser converts other types of events, such as threshold events and status poll events, into a readable
format before the events are filtered.
When an event reaches the EMS server, the event parser list is checked to see whether the incoming
event satisfies the match criteria of the event parser. If matched, the event is passed through the
corresponding event parser. The outgoing event from the parser is then matched with the remaining set of
parsers (if any and in sequence). If there are any matches, the event is passed through those parsers as
well. This process continues until all the parsers are scanned.
By default, EMS does not define any default event parser. This means that the properties of all the events
generated by trap filters and parsers are not modified before they reach the event filters.

Figure 162: Event Parsers

To access event parsers:

1) Click the Admin tab.
2) From the Configurations submenu, click Event Parsers. The Event Parsers page appears.
To modify an event parser:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 321
 1) On the Event Parsers page, click on the link of the parser to view. The Modify Event Parser page
appears.
2) Modify the input boxes as required. For information on the input boxes on this page, see Add Event
Parser on page 322.
3) Click Submit to save the changes, click Reset to revert to the previously saved settings, or click
Cancel to return to the previous page.
To enable an event parser:
1) On the Event Parsers page, select the parsers to enable.
2) Click Enable. The event parsers are enabled.
To disable an event parser:
1) On the Event Parsers page, select the parsers to disable.
2) Click Disable. The event parsers are disabled.
To delete an event parser:
1) On the Event Parsers page, select the parsers to delete.
2) Click Delete. The event parsers are deleted.
Tasks to perform from this page

9.4.3.1 Add Event Parser

Use the Add Event Parsers page to add an event parser.

Figure 163: Add Event Parser

The information on this page includes the following:

Input Box Description

Name This text box specifies the name to identify the parser.

Message This text box corresponds to the text field of the event object.

Category This text box categorizes the events and alarms.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 322
 Input Box Description

Domain This text box specifies the domain name of an event.

Network This text box specifies the network name from which the event originated.

Node This text box specifies the node value of an event.

Failure Object This text box tracks problems and identifies objects.

Source This text box identifies the source of an event.

Severity This text box indicates the state of an event.

NOTE: The methodology of using the properties of the trap by means of symbolic notations is similar to
that of trap parsers, except for the following differences:
• To access the values of the Simple Network Management Protocol (SNMP) object identifier (OID) in the
SNMP variable bindings, the notation should start with % and not with $ as in trap parser.
• All the special purpose tags should start with % instead of $ as in trap parser.
• To access the SNMP OID in the SNMP variable bindings, the notation should start with @, which
is same as in trap parser. The values of the trap protocol data unit (PDU) can be used in any of the
columns, except in Tokenizer, in the parser defined. The trap PDU's explanation is the same for trap
parsers, event parsers, and event filters (only % and $ notations differ).

Variables
Variable Description

$severity This variable presents the severity value of the event. Severity values set for an event are
provided in SeverityInfo.conf present in the /conf directory.

$text This variable holds the description of the fault. For example, if the event is for a fault indicating
high processor load, then the text can be set as "Processor load high".

$entity This variable represents the failure object.

$source This variable represents the source of failure. The source input box of the event/alert object should
be the same as that of the name input box of ManagedObject so that the ManagedObject's status
is updated when alerts are generated.

$domain This variable represents the domain name for the event.

$category This variable represents the category of the event.

$network This variable represents the network name from which the event must be raised.

$node This variable represents the node from which the event has been raised.

$groupName This variable represents the group name associated with the event.

Example
Field Match String Tokenizer String Output String Value

Message A query was sent A query was sent Application Server Application
to the Media Server to the Media Server $source$1 failed to Server AppServerA
and no response and no response was communicate with failed to communicate
was received. Media received. Media server Media Server $text with Media Server
Server address: address: $1 SIP Media $1, SIP Media Endpoint 192.168.13.202, SIP
192.168.13.202 SIP Endpoint Session Key: Session Key: $text$2 Media Endpoint Session
Media Endpoint Session $2 Key: callhalf-23673:1
Key: callhalf-23673:1

Source AppServerA $1 - -

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 323
 To add an event parser:
1) On the Event Parser page, click Add Event Parser. The Add Event Parser page appears.
2) Enter the match criteria. The match criteria determine whether the event will be parsed by the given
event parser. If a input box is left blank, it is automatically matched; otherwise, all input boxes (AND
condition applied) must match the input event. To specify the match criteria, the following may be used
in expressions:
• Wildcard Character - Asterisk ( * ): Signifies match 0 or more characters of any value. For example,
*Failed* matches any string containing Failed.
• Negation - Exclamation ( ! ): Used at the start of a input box to specify exclusion of events matching
the succeeding expression. For example, !Failed excludes strings containing Failed. Note that
expressions, such as *Failed, Fai*d, and * have the expected meanings in the match criteria.
3) Enter the tokenizer strings. Tokenizer strings enable you to separate the input box into a series of
tokens that can be used in the output event object. The tokenizer definition is a string with tokens
represented by $1, $2, and so on. Only positive integers are allowed following the dollar sign ($).

NOTE: To identify the replaceable parameter of a specific input box, the token number should be
preceded by the input box. For example, $text$1 indicates the first tokenized string of the input box
"Message". The tokens of any input box can be used in any other input box provided that paragraph (1)
is followed. Tokens are applied for space-separated words only

4) Enter the output strings. The output string of the event parser is an event object that becomes the
modified instance of the incoming event.
The attributes of the event object are defined by the specifications in the event parser. It is necessary
to select correct values, particularly for important attributes, namely failure object (affected entity),
severity, and message text. The properties that should remain unchanged must specifically be noted
by placing a dollar sign followed by the property name. For example, if the text input box should not be
modified, then the value $text should be entered in the output string. To use the values of the incoming
event properties while specifying the output values in the definition column, specify the exact property
name (case sensitive) with a prefixed $. For example, to use the event property "Source", the definition
should be $source. If the particular property has been tokenized and if you intend to use the value of
the token, then the format should be $propertyname$N, where N is the count of the token starting with
1.
When it is necessary to deliberately have a null value for a specific property of the output event, the
output string for that property should be left blank. The default properties of an event that can be used
in the definition column following the dollar sign ($) are category, domain, entity, groupName, helpURL,
network, node, source, severity, and text. While specifying the output values for the event object that is
generated in the input boxes, you can use information in the incoming trap information. The information
in the trap values can be accessed using the specifically designed tokens that represent the values of
the various input boxes present in the trap.
5) To specify your own properties to the event object generated by the event parser, click More. The
Event Parser Configuration page appears. Specify the name and the value of the property in the
Property Name and Match Criteria input boxes respectively.
6) To enter more properties, click More.

NOTE: If a criterion is configured based on the event user property and if no definition is given against
that property, then the user property is dropped in the resulting event. The event property's ID and time
are not configurable using the event parsers. These input boxes are copied to the values as that of the
incoming event object.

7) Click Submit. The Event Parsers page displays this event parser on the list of event parsers.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 324
9.4.3.2 Load Event Parsers
Use the Load Parsers page to load an event parser.

Figure 164: Load Event Parser

The information on this page includes the following:

Input Box Description

Deletes Existing Event This check box controls whether the existing event parsers (with the same matching criteria) are
Parsers overwritten with the new event parsers in the file.

File Name This text box specifies the name of the event parsers file to load.

To load event parsers:

1) From the Event Parser Configuration page, click Load Parsers. The Load Parsers page appears.
2) To overwrite existing parsers with the new parsers in the file, check Deletes Existing Event Parsers.
3) In the File Name text box, enter the name of the event parser file.
4) Click Load to load the event parser file or click Cancel to return to the previous page.

9.4.3.3 Save Event Parsers to File

Use the Save To File section to save event parsers to a file.

Figure 165: Save Event Parser

The information on this page includes the following:

Input Box Description

This input box specifies the name of the event parser file.

To save event parsers to a file:

1) On the Event Parsers page, click Save To file. The Save To File section appears.
2) Enter the name of the file to save the event parsers to.
3) Click Save To file. The event parsers are saved to the specified file. Click Cancel to return to the
previous page.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 325
9.4.4 Configure Event Filters
You can use event filters to configure the EMS to automatically initiate actions for select events. The EMS
supports the following types of filter actions:
• Suppressing multiple events in a given interval
• Running system commands on the server
• Sending e-mails
• Sending traps
• Running custom code to filter events
The processed events are stored in a database and can be viewed in the events viewer. The events viewer
is asynchronously notified as soon as an event is processed. You can configure an event filter using the
event filter configuration. You can use the properties of the event object or the associated trap (if the event
has been generated by a trap) in some of the input boxes, such as the Suppress Event , Run Command,
Send Trap, and Send Email action.
Use the Event Filters page to view, add, modify, or delete the event filters.

Figure 166: Event Filters

The information on this page includes the following:

Filter Name Description

BWEventFilterForThreshold This filter applies to events of the Threshold category. It adjusts the event name with the name of
the statistics for which the threshold was crossed.

BWEventFilterForHealth This filter applies to events of the Health Status category. The information contained in the events is
analyzed and used as input to the health functionality.

BWEventFilter This filter applies to all events. It performs the mapping of certain BroadWorks traps with an info
severity to events that have a severity with criticality (minor, major, critical). Examples of such traps
are bwServerStateTransition, BwPMExecutionServerDeath, BwPMExecutionServerShutdown, and
so on.

BWEventFilterForSyslog This filter applies to events of the Syslog category. It adds an EventName property containing the
type/source of the syslog to the event.

NOTE: You should not modify or delete the default event filters that are shipped with your EMS as it might
impact the proper behavior of EMS Fault Management.

To access event filters:

1) Click the Admin tab.
2) From the Configurations submenu, click Event Filters. The Event Filters page appears.
To modify an event filter:

NOTE: Modify event filters that have only been added since the system was installed.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 326
 1) On the Event Filters page, click on the link of the filter to view. The Configure Event Filter section
appears.
2) Modify the input boxes as required. For information on the input boxes on this page, seeAdd Event
Filter on page 327.
3) Click Submit to save the changes, click Reset to revert to the previously saved settings, or click
Cancel to return to the previous page.
To view an event filter:
On the Event Filters page, click the Filter Name of the filter to view. The Configure Event Filters section
appears. For information on these input boxes, seeAdd Event Filter on page 327.
To delete an event filter:

NOTE: Delete event filters that have only been added since the system was installed.

Click the red "X" on the row of the event to delete on the Events Filters list. The event filter is removed from
the list.
Tasks to perform from this page

9.4.4.1 Add Event Filter

Use the Event Filters page to add or modify an event filter.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 327
 Figure 167: Add Event Filter

The information on this page includes the following:

Input Box Description

Filter Name This text box specifies the name of the event filter.

Source Match criteria based on information about the source of the event so that the events matching a
source can be filtered out.

Severity Match criteria based on the severity of the event, such as critical, major, and so on. You can also
choose the severities from the drop-down list next to the Severity input box.

Message Match criteria based on a message of the incoming event, for example, "Interface failure", "Status
Poll failed", and so on.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 328
 Input Box Description

Category Match criteria based on the category name to which the event belongs.

Domain Match criteria based on an event object property with any domain-specific information. The
information can be based upon the physical location, or the functional or logical categorization of the
source of the event. The domain name of the event displays events of a particular domain.

Network Match criteria based on information about the network to which the source of the event belongs.
Using this criteria, events belonging to a particular network are displayed.

Node Match criteria based on any additional information (name of the node or server) about the source of
the event.

Entity Match criteria based on information about an exact device in which a problem has occurred.

To add an event filter:

1) From the Event Filters page, click Add Filters. The Configure Event Filter section appears.
2) In the Filter Name text box, enter the name of the event filter.
3) To match events based on a source, in the Source text box enter the source.
4) To match events based on severity, in the Severity text box enter the severity.
5) To match events based on a message from the incoming event, in the Message text box enter the
message.
6) To match events based on a category, in the Category text box enter the category.
7) To match events based on a domain, in the Domain text box enter the domain.
8) To match events based on a network, in the Network text box enter the network.
9) To match events based on a node (server), in the Node text box enter the name.
10)To match events based on a specific device, in the Entity text box enter the entity.

NOTE:
The values that you specify in the Match Criteria determine whether the incoming event should be
filtered or not. If this field is left blank, it is automatically matched. For the Event Filter to be applied, all
the match criteria specified must be satisfied. If even one criterion fails, the filter will not be applied. The
following expressions can be used while specifying the match criteria:
• Wildcard - Asterisk (*): Used to signify a match of 0 or more characters of any value. For example,
"Failed*" matches any string starting with "Failed". Expressions, such as "*", "*Failed, or "Fai*led*",
can be used.
• Negation - Exclamation (!): Used at the start of the field to specify exclusion of events matching this
expression. For example, "!Failed" excludes strings starting with "Failed".
• Separator - Comma (,): Used to specify multiple values for a single match criterion by separating
them with commas. For example, "Critical, Major" will match a string which is either "Critical" or
"Major".
The following combinations can be used while specifying match criteria.
• * AND ,: This combination can be used to obtain the combined result of two matching criteria that
signifies a match of 0 or more characters for the given criteria.For example, "(*x,*y)" is tokenized into
"*x" and "*y" and only data ending with x and y is matched.
• ! AND ,: This combination can be used to obtain the exclusion of events matching two criteria. For
example, "(!x,!y)" is considered an AND operation. Hence all data starting with "(x,y)" will not be
matched.
• a,b: This combination is tokenized into two strings "a" and "b". Therefore this criterion matches "a,b"
and also the data "a" and "b".
To specify additional match criteria for the Event Filter, click Click to Add Custom Properties and
complete the following steps:
1) In the Property Name input box, specify the property name.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 329
 2) In the Property Value input box, specify the match criteria. The match criteria specified must be
based on the properties of the View Event Properties on page 176, as well as, "groupName". While
specifying additional criteria, specify only those properties that are in the event object. The name
should exactly match the case of the event object. You can also add event base properties as match
criteria, such as help URL, ID, and time.
3) When you are finished adding properties and values, close the More Properties dialog and then click
OK in the Match Criteria Properties dialog.

11)To include an action with the event filter:

a) To include an existing action, highlight the action in the Available Actions box and click the right
arrow. The action appears in the Associated Actions box. You can reorder the associated actions by
clicking on the up and down arrows.
b) To include a new suppress action, select Suppress Action from the Operations drop-down list. The
Configure Suppress Action window appears. Complete the steps in the Add Suppress Action on
page 308 procedure.
c) To include a new run command action, select Run Cmd Action from the Operations drop-down list.
The Configure Run Cmd Action window appears. Complete the steps in the Add Run Command
Action on page 308 procedure.
d) To include a send trap action, select Send Trap Action from the Operations drop-down list. The
Configure Send Trap Action window appears. Complete the steps in the Add Send Trap Action on
page 309 procedure.
e) To include a send e-mail action, select Send E-mail from the Operations drop-down list. The
Configure Send E-mail Action window appears. Complete the steps in the Add Send E-mail Action
on page 311 procedure.
f) To include a new custom filter action, select Custom Filter Action from the Operations drop-down list.
The Configure Custom Filter Action window appears. Complete the steps in the Add Custom Filter
Action on page 313 procedure.
12)To specify additional match criteria for the event filter, click More Properties and complete these steps:
a) Specify the attribute name in the Attribute Name input box and match criteria in the Property Value
input box.
b) Click More to add additional criteria or click Fewer to remove criteria.
13)Click Submit. The Event Filters page displays this event filter on the list of event filters.

9.4.4.2 Load Event Filters

Use the Load Event Filters section to load event filters.

Figure 168: Load Event Filters

The information on this page includes the following:

Input Box Description

File Name This text box specifies the name of the event filter file to load.

To load event filters:

1) On the Event Filters page, click Load Filters. The Load Filters section appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 330
 2) In the File Name text box, enter the name of the event filter file.
3) Click Load. The event filters are loaded.

9.4.4.3 Save Event Filters to File

Use the Save To File section to save an event filter to a file.

Figure 169: Save Event Filters

The information on this page includes the following:

Input Box Description

File Name This text box specifies the name of the event filter file.

To save event filters to a file:

1) On the Event Filters page, click Save Filters. The Save To File section appears.
2) In the File Name text box, enter the name of the file to save the event filters to.
3) Click Save To File. The event filters are saved to the specified file. Click Cancel to return to the
previous page.

9.4.5 Configure Alarm Filters

Use the Alert Filters page to view, modify, or delete the existing alarm filters.
Events are correlated into alarms. They represent the current status of the various problems on the
network. An alarm filter executes certain corrective actions whenever alarms are received with configurable
matching criteria, such as suppressing multiple alarms in a given interval, running shell commands on the
server system, sending e-mails, sending traps, and executing custom code to filter alarms. Custom code
may be needed in cases where any additional data must be retrieved or specific rules are to be applied in
processing the alarm.
Custom code is also the appropriate mechanism to configure alarm grouping, because it usually requires
user-specific or domain-specific rules. The processed alarms are stored in the database and made
available in the alarm viewer. The alarm viewer is asynchronously notified as soon as the processing of an
alarm is finished. You can configure an alarm filter using the Alarm Filter Configuration page.
You can use alarm filters to configure the EMS to automatically initiate actions for select alarms. The EMS
supports the following types of filter actions:
• Suppressing multiple alarms in a given interval
• Running system commands on the server
• Sending e-mails
• Sending traps
• Running custom code to filter alarms

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 331
 Figure 170: Alarm Filters

The information on this page includes the following:

Filter Name Description

BWAlarmFilter This filter manages the severity icon associated with the group icon in the map. When alarms are
received, their associated group is determined based on the source of the alarm. The severity
associated with the group is then adjusted based on the severity of the alarm being processed.

BWaudibleAlarm This filter checks every incoming alarm against the configured audible alarm filters. In the case of
a match, the defined audible alarm is played. For information on configuring audible alarms, see
Managing Audible Alarms on page 382.

NOTE: You should not modify or delete the default alarm filters that are shipped with your EMS as it might
impact the proper behavior of EMS Fault Management.

To access alarm filters:

1) Click the Admin tab.
2) From the Configurations submenu, click Alarm Filters. The Alarm Filters page appears.
To modify an alarm filter that has been added to EMS:
1) On the Alarm Filters page, click the link of the alarm to view. The Configure Alarm section appears.
2) Modify the input boxes as required. For information on the input boxes on this page, see Add Alarm
Filter on page 332.
3) Click Submit to save the changes, click Reset to revert to the previously saved settings, or click
Cancel to return to the previous page.
To view an alarm filter:
On the Alarm Filter page, click on the name of the filter to view. The Configure Alarm Filter section
appears, displaying the current alarm filter configuration.
To delete an alarm filter:

NOTE: Delete alarm filters that have only been added since the system was installed.

On the Alarm Filters page, click the red "X" in the row of the alarm to delete on the Alarm Filters list. The
alarm filter is removed from the list.
Tasks to perform from this page

9.4.5.1 Add Alarm Filter

Use the Alarm Filters: Configure Alarm Filter section to add or modify an alert filter.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 332
 Figure 171: Alarm Filters: Configure Alarm Filter

The information on this page includes the following:

Input Box Description

Filter Name This text box specifies the name of the alarm filter.

Source Match criteria based on information about the source of the event so that the alarms matching a
source can be filtered out.

Severity Match criteria based on the severity of the alarm, such as critical, major, and so on.

Message Match criteria based on a message of the incoming alarm.

Category Match criteria based on the category name to which the alarm belongs.

Entity Match criteria based on the information about an exact device in which a problem has occurred.

To add an alarm filter:

1) From the Alarm Filters page, click Add Filters. The Configure Alarm Filter section appears.
2) In the Filter Name text box, enter the name of the alarm filter.
3) To match alarms based on a source, in the Source text box enter the source.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 333
 4) To match alarms based on severity, in the Severity text box enter the severity.
5) To match alarms based on a message from the incoming event, in the Message text box enter the
message.
6) To match alarms based on a category, in the Category text box enter the category.
7) To match alarms based on a specific device, in the Entity text box enter the entity.

NOTE:
The values that you specify in the Match Criteria determine whether the incoming event should be
filtered or not. If this field is left blank, it is automatically matched. For the Event Filter to be applied, all
the match criteria specified must be satisfied. If even one criterion fails, the filter will not be applied. The
following expressions can be used while specifying the match criteria:
• Wildcard - Asterisk (*): Used to signify a match of 0 or more characters of any value. For example,
"Failed*" matches any string starting with "Failed". Expressions, such as "*", "*Failed, or "Fai*led*",
can be used.
• Negation - Exclamation (!): Used at the start of the field to specify exclusion of events matching this
expression. For example, "!Failed" excludes strings starting with "Failed".
• Separator - Comma (,): Used to specify multiple values for a single match criterion by separating
them with commas. For example, "Critical, Major" will match a string which is either "Critical" or
"Major".
The following combinations can be used while specifying match criteria.
• * AND ,: This combination can be used to obtain the combined result of two matching criteria that
signifies a match of 0 or more characters for the given criteria.For example, "(*x,*y)" is tokenized into
"*x" and "*y" and only data ending with x and y is matched.
• ! AND ,: This combination can be used to obtain the exclusion of events matching two criteria. For
example, "(!x,!y)" is considered an AND operation. Hence all data starting with "(x,y)" will not be
matched.
• a,b: This combination is tokenized into two strings "a" and "b". Therefore this criterion matches "a,b"
and also the data "a" and "b".
To specify additional match criteria for the Event Filter, click Click to Add Custom Properties and
complete the following steps:
1) In the Property Name input box, specify the property name.
2) In the Property Value input box, specify the match criteria. The match criteria specified must be
based on the properties of the View Alarm Properties on page 186, as well as, "groupName". While
specifying additional criteria, specify only those properties that are in the event object. The name
should exactly match the case of the event object. You can also add event base properties as match
criteria, such as help URL, ID, and time.
3) When you are finished adding properties and values, close the More Properties dialog and then click
OK in the Match Criteria Properties dialog.

8) To include an action with the alarm filter:

a) To include an existing action, highlight the action in the Available Actions box and click the right
arrow. The action appears in the Associated Actions box. You can reorder the associated actions by
clicking on the up and down arrows.
b) To include a new suppress action, select Suppress Action from the Operations: drop-down list. The
Configure Suppress Action window pops up. Complete the steps in the Add Suppress Action on
page 308 procedure.
c) To include a new run command action, select Run Cmd Action from the Operations: drop-down
list. The Configure Run Cmd Action window pops up. Complete the steps in the Add Run Command
Action on page 308 procedure.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 334
 d) To include a send trap action, select Send Trap Action from the Operations: drop-down list. The
Configure Send Trap Action window pops up. Complete the steps in the Add Send Trap Action on
page 309 procedure.
e) To include a send email action, select Send Email Action from the Operations: drop-down list. The
Configure Send EMail Action window pops up. Complete the steps in the Add Send E-mail Action on
page 311 procedure.
f) To include a new custom filter action, select Custom Filter Action from the Operations: drop-down
list. The Configure Custom Filter Action window pops up. Complete the steps in the Add Custom
Filter Action on page 313 procedure.
9) To specify additional match criteria for the alarm filter, click More Properties and complete these steps:
a) Specify the attribute name in the Attribute Name input box and match criteria in the Property Value
input box.
b) Click More to add additional criteria or click Fewer to remove criteria.
10)Click Submit. The Alarm Filters page displays this alarm filter on the list of alarm filters.

9.4.5.2 Load Alarm Filter

Use the Load Alarm Filters section to load alarm filters.

Figure 172: Load Alarm Filters

The information on this page includes the following:

Input Box Description

File Name This text box specifies the name of the alarm filter file to load.

To load alarm filters:

1) On the Alarm Filters page, click Load Filters. The Load Filters section appears.
2) In the File Name text box, enter the name of the alarm filter file.
3) Click Load. The alarm filters are loaded.

9.4.5.3 Save Alarm Filters to File

Use the Save To File section to save alarm filters to a file.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 335
 Figure 173: Save Alarm Filters

The information on this page includes the following:

Input Box Description

File Name This text box specifies the name of the alarm filter file.

To save alarm filters to a file:

1) From the Alarm Filters page, click Save Filters. The Save To File section appears.
2) In the File Name text box, enter the name of the file to save the alarm filters to.
3) Click Save To File. The alarm filters are saved to the specified file. Click Cancel to return to the
previous page.

9.5 Configuring E-mail

Overview
To notify people by e-mail of the availability of a critical patch or to e-mail the automatic performance
reports, you must configure the following:
• E-mail parameters: To specify the e-mail account used to send these messages
• Distribution lists: To create distribution lists of the recipients of these messages
For more information

9.5.1 Configure E-mail Parameters

Use the Email Parameters page to configure the parameters on your e-mail server.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 336
 Figure 174: Email Parameters

The information on this page includes the following:

Input Box Description

SMTP Server Address This text box specifies the address of the SMTP server.

Use Secure Connection This option specifies whether the SMTP server uses a secure connection.

Server Port This text box specifies the server port. The default port value for non-secure connection is "2" and for
secure connection is "465".

Use Secure Authentication This check box specifies whether the server requires user authentication.

User Name This text box specifies the user name of the mail account in the SMTP server.

Password This text box specifies the password of the mail account in the SMTP server.

From Email Address This text box specifies the sender's address.

To Email Address (for Test This text box specifies the destination address used for the Test Mail command
Mail only)

To configure the e-mail account parameters:

1) Click the Admin tab.
2) From the Configurations submenu, click Email Parameters. The Email Parameters page appears.
3) In the SMTP Server Address text box, enter the SMTP server address.
4) If the server uses a secure connection, select SSL.
5) In the Server Port text box, enter the server port.
6) If the server uses a secure connection:
a) Select Use Secure Connection.
b) In the User Name text box, enter the user name.
c) In the Password text box, enter the password.
7) In the From Email Address text box, enter the sender's e-mail address.
8) In the To Email Address (for Test Mail only) text box, enter the destination e-mail address to test this
configuration.
9) Click Test Mail to send a test e-mail to the specified To Email Address.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 337
 10)Click Submit to save the e-mail parameters, click Reset to reset the previously saved parameters, or
click Cancel to return to the previous page.

9.5.2 Configure E-mail Distribution Lists

Use the Email Distribution Management page to configure e-mail distribution lists. The Email Distribution
Management page allows you to manage e-mail distribution lists used for automatic distribution of reports
and other system status information via e-mail. From this page, e-mail distribution lists can be created,
modified, and deleted. By default, the BroadSoft Patch Center Distribution, Health Status Distribution, and
Performance Report Distribution are created empty. These default lists cannot be deleted; however, they
can be modified.
The BroadSoft Patch Center Distribution list is used by the Patch Management feature to notify the
recipients on that list of the availability of a critical patch. For information on configuring e-mail, see
Configure E-mail.
When there is a change in the node or group health status, the EMS automatically sends an e-mail to
notify the users on the Health Status Distribution list. For more information on monitoring health status, see
Monitoring Health Status on page 252.
EMS can also send a periodic performance report via e-mail to the users defined on the Performance
Report Distribution list. For information on distribution lists, see Configure E-mail.

Figure 175: Email Distribution Management

The information on this page includes the following:

Column Description

List This column displays the defined e-mail distribution list.

To access e-mail distribution lists:

1) Click the Admin tab.
2) From the Configurations submenu, click Email Distribution. The Email Distribution Management page
appears.
To modify an e-mail distribution list:
1) On the Email Distribution Management page, click the link on the name to modify on the e-mail
distribution list. The Email Distribution Configuration page appears.
2) To remove an address from the list, select the address and click Delete.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 338
 3) To add an address to the list, enter the e-mail address and click Add.
To delete an e-mail distribution list:
1) On the Email Distribution Management page, select the check box in the row of the e-mail distribution
list to delete.
2) Click Delete List. The distribution list is removed from the list.
Tasks to perform from this page

9.5.2.1 Create Distribution List

Use the Email Distribution Configuration page to create e-mail distribution lists.

Figure 176: Email Distribution Configuration

The information on this page includes the following:

Name Description

Distribution List Name This text box specifies the name of the distribution list.

Email This text box specifies the e-mail address to add to the distribution list.

To create an e-mail distribution list:

1) On the Email Distribution Management page, click Create List. The Email Distribution Configuration
page appears.
2) In the Distribution List Name text box, enter the name of the e-mail distribution list.
3) In the Email text box, enter the e-mail address to add to the list.
4) Click Add.
5) Repeat steps 3 and 4 for each e-mail address to include on the list.

NOTE: To delete an e-mail entry on the list, select the entry and click Delete.

9.6 Managing MIBs

Overview

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 339
 The Management Information Base (MIB) Browser bundled with the EMS is a complete Simple Network
Management Protocol (SNMP) MIB Browser that enables loading, browsing and searching MIBs, walking
the MIB tree, and performing all other SNMP-related functions. The MIB Browser also helps you to view
and operate the data available in a managed device through an SNMP agent.
The MIB Browser provides the following features:
• Enables the saving of MIB Browser settings
• Provides the capability to load and view MIB modules in a MIB tree
• Helps in traversing the MIB tree to view the definitions of each node for a particular object defined in the
MIB
• Enables the performance of basic SNMP operations, such as GET, GETNEXT, GETBULK, and SET
• Provides a user-friendly view of SNMP table data. The table data can be viewed in a separate window
called SNMP Table
• Enables the loading of MIBs at start-up
Using the MIB Browser
Use the MIB Browser page to manage MIBs.
The following figure shows the primary window of the MIB Browser. It consists of command buttons, a left
frame, and a right frame.

Figure 177: MIB Browser

The MIB Browser page includes the following areas:

• The command buttons allow the performance of various operations and settings.
• The left frame holds the selected loaded MIB tree. The MIB tree enables the ability to traverse the
selected MIB tree and view the definition of each MIB node. Click on the Expand All link to allow the
view of the expanded MIB tree.
• The right frame contains input boxes to specify the basic parameters such as host, community, and so
on. It also contains a text area to display the results.
To access the MIB Browser:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 340
 1) Click the Admin tab.
2) From the Tools & Browsers submenu, click MIB Browser. The MIB Browser page appears.
For more information

9.6.1 Configuration
The parameters, such as host and community, can be set in the MIB Browser's main window. The other
parameters are set in the Set Parameters window, which can be accessed by clicking the Parameters
button on the MIB Browser's main window.
Simple Network Management Protocol (SNMP) mandates that the SNMP agents should accept request
messages only if the community string in the message matches its community name. Therefore, the
management application should always communicate with the agents along with the associated community
name. For BroadWorks servers, the default SNMP community names are "public" for read-only (GET) and
read-write (SET) operations.

Figure 178: Set Parameters Window

The information on this window includes the following:

Input Box Description

SNMP Version This text box specifies the SNMP version to be used.

SNMP Port This text box specifies SNMP port. The MIB Browser uses the host name or the IP address of
the device to communicate with the SNMP agent of the device in the specified port number. This
default port value is "8001". By default, all the SNMP request messages are received in this port for
BroadWorks servers.

Timeout (secs) This text box specifies the time interval that the MIB Browser waits for a response message from the
device SNMP agent before timing out.

Retries This text box specifies the number of times a request is sent when a time-out occurs.

Max Repetitions (For This text box specifies the Max Repetitions value required in a GETBULK request. This parameter is
GetBulk) displayed only when the SNMP version is set to "v2c".

Non Repeaters This text box specifies the Non Repeaters value required in a GETBULK request. This parameter is
displayed only when the SNMP version is set to "v2c".

9.6.2 Upload MIB

1) On the MIB Browser page, click Upload MIB. The Upload MIB dialog box appears.
2) Click Select and navigate to the MIB you want to upload.
3) Click Upload to load the MIB. The MIB appears on the drop-down list. Click Cancel to return to the
previous page.

NOTE: When you load a MIB file, the following operations are performed:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 341
 • Parsing and validating the syntax of the MIB module
• Constructing the MIB module into the tree structure
While performing the parsing and validation of the MIB file, if the MIB module fails to conform to the
Structure of Management Information (SMI) standards, then the loading is not done. The MIB file can
contain one or more MIB modules. If the dependency file is not already loaded, the loading also fails.

9.6.3 SNMP Operations

The MIB Browser allows the user to perform the following typical Simple Network Management Protocol
(SNMP) operations: GET, GETNEXT, GETBULK, and SET. To perform any of these operations, it is
essential to specify the object ID, the instance, the host name, and the community string.
Specify the Index
To specify an object to an SNMP agent, both the object ID (which defines the type of object) and the
instance (the specific object of the given type) must be provided. From the MIB you can get the object ID,
to which an instance must be added to completely identify the object of interest. For non-tabular or scalar
objects, the instance is "0".
For example, sysDescr is a scalar object under the system group in RFC 1213-MIB and it should be
specified as sysDescr.0 in the object ID input box of the MIB Browser. In the MIB Browser, this must not
be specified if the MIB is loaded, for example: RFC 1213-MIB. MIB Manager adds it to the selected node
while performing the GET operation.
For tabular objects, the instance is defined in the MIB as an index and it is a sequence of one or more
objects. For example, for ifInOctets of ifTable defined in RFC 1213-MIB, the index is ifIndex (INTEGER)
and may be specified as ifInOctets.1, provided that there is a row with index 1 in the querying agent.
Another example is tcpConnState of tcpConnTable under TCP group of RFC 1213-MIB.
The indexes of the tcpConnTable are tcpConnLocalAddress (IpAddress), tcpConnLocalPort
(INTEGER), tcpConnRemAddress (IpAddress), tcpConnRemPort (INTEGER), and may be
specified as tcpConnState.179.74.15.126.1192.225.226.126.197.80, provided that a row with index
179.74.15.126.1192.225.226.126.197.80 exists in the querying agent, where:
• 179.74.15.126 represents the value of the first index tcpConnLocalAddress (IpAddress).
• 1192 represents the value of the second index tcpConnLocalPort (INTEGER).
• 225.226.126.197 represents the value of the third index tcpConnRemAddress (IpAddress).
• 80 represents the value of the fourth index tcpConnRemPort (INTEGER).
For more information

9.6.3.1 SNMP GET and GETNEXT

1) On the MIB Browser page, select the MIB from the Select MIB drop-down list. The MIB appears in the
MIB Browser.
2) Navigate to the specific object ID (OID) of the variable that you want to query.
3) Click on the variable to select it.
4) Click Get. All objects under the selected MIB object or the specific object, if the MIB node and instance
are specified appear.

NOTE:
If the selected node in the MIB tree has child nodes or columnar nodes, the Get operation performs
SNMP GETNEXT requests to retrieve the values for all the nodes under that subtree.
If the MIB is not loaded in the MIB Manager, the exact numbered OID with full instance (for example
.1.3.6.1.2.1.1.3.0 for sysUpTime), should be specified and the GET operation should be performed.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 342
 5) Click Clear to clear the displayed result values from the MIB Browser text area.

9.6.3.2 SNMP GETBULK

The GETBULK operation is normally used for retrieving a large amount of data, particularly from large
tables. A GETBULK request is made by giving an object identifier (OID) list along with a Max-Repetitions
value and a Nonrepeaters value.
The GETBULK operation performs a continuous GETNEXT operation based on the Max-Repetitions
value. The Nonrepeaters value determines the number of variables on the variable list for which a simple
GETNEXT operation must be done. For the remaining variables, the continuous GETNEXT operation is
done based on the Max-Repetitions value.
In other words, the SNMP GETBULK operation does a simple GETNEXT operation for the first N variable
bindings in the request and does an M GETNEXT operation (continuous) for each of the remaining R
variable bindings on the request list where:
N is the minimum of:
• the value of the Non-Repeaters field in the request.
• the number of variable bindings in the request.
M is the Max-Repetitions field of the request.
R is the maximum of:
• the number of variable bindings in the request.
• zero.
As a result, the total number of varbinds in the response message is (N + M x R).
To perform a GETBULK query:
1) On the MIB Browser page, select the MIB from the Select MIB drop-down list. The MIB appears in the
MIB Browser.
2) Navigate to the specific object ID (OID) of the counter you are looking for (ensuring that this node is
currently operational on the EMS).
3) Click on the counter.
4) Click Parameters.
5) In the Max-Repetitions input box, specify the maximum number of repetitions. This is the number of
lexicographic successors to be returned for the remaining variables on the variable-bindings list. The
default value in this input box is "50".
6) In the Non-Repeaters input box, specify the non-repeaters value. This is the number of variables on the
variable-bindings list for which a single lexicographic successor is to be returned. The default value in
this input box is "0".
7) Click OK to save these settings or click Cancel to return to the previous page.
8) Click Get Bulk. The number of object instances returned is equal to what is contained in the Max-
Repetitions input box.

NOTE: Click Clear to clear the values from the MIB Browser.

9.6.3.3 SNMP SET

1) On the MIB Browser page, select the MIB from the Select MIB drop-down list. The MIB appears in the
MIB Browser.
2) Navigate to the specific object ID (OID) of the variable you want to modify.
3) Click on the variable to select it.
4) In the Set Value text box, enter the new value.
5) Click Set Value. The value is set.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 343
 NOTE: Click Clear to clear the resulting displayed values from the MIB Browser.

9.6.4 Retrieve Table Data

1) On the MIB Browser page, select the MIB from the Select MIB drop-down list. The MIB appears in the
MIB Browser.
2) Navigate to the specific object ID (OID) of the MIB table you want to query.
3) Click on the table to select it.
4) Click Table. A tabular view of the table object appears.

NOTE: If the selected node in the MIB tree is not a table, an error message appears.

5) Click on the X to close the resulting tabular view.

9.7 Viewing Audit Trails

Audit trails enable you to view the operations that have been performed by a user. The audit trails identify
all operations that have been performed, the time, whether the operation was successful, the category, and
the audited object. You should periodically clear the trails after they have been reviewed.
Use the Auth Audit page to view audit trails.

Figure 179: Auth Audit

The information on this page includes the following:

Column Description

UserName This column displays the name of the user.

Operation This column displays the name of the operation performed by

the user.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 344
 Column Description

AuditTime This column displays the time stamp the operation was
performed.

Status This column displays the status of the operation. Valid values
include "SUCCESS" and "FAILURE".

Category This column displays the category of the operation. Valid values
include "Authentication" and "DEFAULT".

To display a list of audit trails:

1) Click the Admin tab.
2) From the Tools & Browsers submenu, click Audit Trails. The Auth Audit page appears with a list of
audit trails.
To sort the list of audits:
On the Auth Audit page, click on the column heading of the column to sort by. The column heading
displays an Up arrow to indicate that the list is sorted in ascending order or a Down arrow to indicate that
the listed is sorted in descending order.
To search for a specific audit:
1) On the Auth Audit page, click Search. The Advanced Search page appears.
2) Select the property on which the search must be performed.
3) Select the condition.
4) Enter the match value in the text box.
5) Click Search. The audits corresponding to the search appear.
For more information

9.7.1 View Audit Trail Details

Use the Audit Details page to view the details of the selected audit trail.

Figure 180: Audit Details

The information on this page includes the following:

Audit Details Description

CATEGORY This row displays the category of the audit. Valid values include
"Authentication" and "DEFAULT".

AUTHAUDITID This row displays the ID number of the audit.

USERNAME This row displays the name of the user who performed the
operation.

AUDITEDOBJ This row displays the name of the operation object.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 345
 Audit Details Description

AUDITTIME This row displays the time stamp of the performed operation.

OPERATION This row displays the name of the operation performed.

STATUS This row displays the status of the operation. Valid values
include "SUCCESS" and "FAILURE".

To view audit details:

From the Audit Auth page, click on the User Name link in the row of the audit trail to display. The Audit
Details page appears.

9.8 Configure License Reporting

Use the License Reporting Configuration page to configure license reporting.

Figure 181: License Reporting Configuration

The information on this page includes the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 346
 Input Box Description

License Data Download This drop-down list provides the ability to select the frequency of the task that collects the data
Frequency Type from the Application Server. Valid values include: "Monthly", "Weekly", "Daily", and "Never". The
default value is "Never".

License Data Download These input boxes provide the ability to select the day of the month, the week day, and the time of
Frequency Value day depending on the frequency type. Valid values include:
• Day of the Month: "1" through 31"
• Week Day: "Monday" through "Sunday"
• Time of Day: "0:00" through "23:00"

License Data Clean Up This input box specifies the number of days after which the collected data is deleted from the EMS.
Interval The default value is "30".

Periodic Reports Clean Up This input box specifies the number of days after which the generated periodic reports are deleted.
Interval The default value is "30".

License Report Display This drop-down list determines if the service license packs or services that are not assigned to any
Empty Count user are included in the report. The default value is "true".

License Data Archive This input box specifies where the collected data is stored on EMS. When the license data archive
Location location is changed, the content of the original directory is moved to the new location specified. If
it does not exist, EMS creates the directory at the time of data collection. The default value is /var/
broadworks/serviceLicenseReporting.

Show Red When License This input box presents the license available content in the color red (to indicate that the licenses
Available Percentage< available are in jeopardy) in the Available and % Remaining columns in both the Purchased
Products Details section and Subscriber Licenses section of the HTML License Reports if their
value is below the specified value. Enter the content as a percentage of the total. The default value
is "10".

NOTE: The license available content is shown in the color yellow when the utilization percentage
is between the red and green thresholds.

Show Green When License This input box presents the license available content in the color green (to indicate adequate)
Available Percentage> in the Available and % Remaining columns in both the Purchased Products Details section and
Subscriber Licenses section of the HTML License Reports if their value is above the specified
value. Enter the content as a percentage of the total. The default value is "15".

NOTE: The license available content is shown in the color yellow when the utilization percentage
is between the red and green thresholds.

Outlying Users Maximum This input box presents the maximum number of users reported in the Outlying Users section of
Number the report. The range of values is "0" through "1000. The default is "100".

Detect Incomplete Match This drop-down list provides the ability to detect the outlying users for the Incomplete Match
Outlying Users category. The default value is "true".

Detect Multiple User Products This drop-down list provides the ability to detect the outlying users for the Multiple User Products
Outlying Users category. Valid values are "true" and "false". The default value is "true".

Detect No Trunk Product This drop-down list provides the ability to detect the outlying users for the No Trunk Product
Outlying Users category. Valid values are "true" and "false". The default value is "true".

Detect No User Product This drop-down list provides the ability to detect the outlying users for the No User Product
Outlying Users category. Valid values are "true" and "false". The default value is "true".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 347
 Input Box Description

Product Precedence Order This is the precedence order of products that is used to determine the product usage. The
precedence can reflect some costs or it can reflect the intention of consuming certain products first.
The listed order is from the most basic to the most advanced. An attempt is made to consume the
most basic products first.
By default, all user products are on the Selected Products Precedence Order list and they are
already ordered from the least expensive to the most expensive. The Available Products list
contains all non-user products purchased by the customer.
For more information on product usage and product precedence, see the Product Usage Analysis
on page 444 page.

NOTE: Since the network-level report is computed when the license data is downloaded from
the Application Servers, a product precedence order change is reflected in the network-level
report only at the next license data download. A product precedence order change takes effect
immediately in Application Server cluster, service provider/enterprise, group, user- level reports.
License data download frequency is defined by the License Data Download Frequency Type and
License Data Download Frequency Value parameters.

To configure license reporting parameters:

1) Click the Admin tab.
2) From the Configurations submenu, click License Reporting. The License Reporting Configuration
page appears.
3) From the License Data Download Frequency Type drop-down list, select the frequency of the data
gathering task.
4) In the License Data Download Frequency Value input box, specify the values or schedule of the data
download.

NOTE: By default, when the EMS applet configures the collect maintenance task that runs on
the Application Server, it automatically schedules the gathering task at the same frequency as the
maintenance task; however, the time that is scheduled is two hours later to ensure the EMS collects the
last file created.

5) In the License Data Clean Up Interval input box, specify when the collected data stored on EMS is
deleted.
6) In the Periodic Reports Clean Up Interval input box, specify when the periodic reports are deleted.
7) In the License Report Display Empty Count drop-down list, determine if empty license packages or
features are included in reports.
8) In the License Data Archive Location input box, specify the location of the archive.
9) In the Show Red When License Available Percentage input box, type the percentage to trigger the
presentation to the color red in the graphs.
10)In the Show Green When License Available Percentage input box, type the percentage to trigger the
presentation to the color green in the graphs.
11)In the Outlying Users Maximum Number input box, type the maximum number of users reported in the
Outlying Users section of the report.
12)In the Detect Incomplete Match Outlying Users drop-down list, select "true" to detect outlying users for
the Incomplete Match category.
13)In the Detect Multiple User Products Outlying Users drop-down list, select "true" to detect the outlying
users for the Multiple User Products category.
14)In the Detect No Trunk Product Outlying Users drop-down list, select "true" to detect the outlying users
for the Multiple User Products category.
15)In the Detect No User Product Outlying Users drop-down list, select "true" to detect the outlying users
for the Multiple User Products category.
16)To order the precedence of the products:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 348
 a) In the Products Precedence input boxes, use the right and left arrows to move products from the
Available Products column to the Selected Products Precedence Order column or vice versa.
b) In the Selected Products Precedence Order column, use the up and down arrows to order the
products. The first one on the list is considered to be the most basic and the last one is considered
to be the most advanced.
17)Click Submit to configure the license reporting, click Reset to reset the previously saved parameters, or
click Cancel to return to the previous page.

9.9 Advanced Administration

Provides advanced administration for the following:

9.9.1 Suppress Superfluous Alarms/Events

EMS displays all of the possible alarms/events on the network. To focus on the alarms/events that you are
particularly interested in, it is useful to suppress unwanted alarms/events.

NOTE: You can also suppress notifications at the origination (for example, a Session Initiation Protocol
[SIP] authentication failure). For more information on alarm threshold and suppression, see the
BroadWorks Alarm Threshold and Suppression Feature Description.

To suppress unwanted events:

NOTE: An example of an alarm that you might want to suppress is the loop trap when the call is
successful (bwForwardDestinationLoop).

1) Click the Fault tab.

2) Select the Network Events menu. The Network Events page appears.
3) Identify the types of events that are superfluous.
4) Create a filter action to suppress events. For a step-by-step procedure to create a suppress action, see
Add Suppress Action on page 308.
5) Create an event filter to match the type of events that you have identified as superfluous. For a step-by-
step procedure to create an alarm filter, see Add Alarm Filter on page 332.To suppress the loop trap,
include the following:
a) Filter Name: Enter the name of the filter, for example, "SuppressForwardDestinationLoop".
b) Message: Enter the text of the trap to use for identification, for example, "User or forward destination
in the forwarding". This text must match the specific text in the Message field of the trap.
c) Select "Suppress Action" from the Operations drop-down list. The Configure Suppress Action dialog
box appears.
d) Enter a unique action name.
e) Click Submit. The new Suppress Action appears in the list of Available Actions.
f) Click the new Suppress Action from the list of Available Actions and click >> to move the action to
the list of Associated Actions.
g) Click Submit. This type of trap will no longer appear in the list of events.

NOTE: Create a separate event filter for each type of event that you want to suppress.

9.9.2 Trigger E-mail at Threshold Crossing

There are situations that warrant notification, for instance, when a threshold is crossed several times. The
following example illustrates how to trigger an e-mail when a threshold is crossed over ten times.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 349
 1) Create a new threshold:
a) Click the Performance tab. The Configure Collection page appears.
b) Click Add Threshold. The Add Threshold page appears.
c) Complete the entries as follows:
a)Kind: Select the kind of threshold.
b)Category: Identify the category to be used when raising the event on threshold crossing.
c)Severity: Identify the event severity to be used when raising the event on threshold crossing.
d)Threshold Type: Identify the type of threshold.
e)Threshold Value: Identify the value of the threshold.
f)Rearm Value: Identify the value at which the threshold is rearmed. A sample of the statistics must
have this value; otherwise, the threshold is not rearmed.
g) Message: Enter the text of the event to be raised upon threshold crossing.
d) Click Submit.
2) Add a new polling object as follows:
a) From the Configure Collection page, click Add Polling Object. The Add Polling Object page
appears.
b) Complete the entries as follows:
a) Enter the name of the polling object.
b) Select "True" from the drop-down list to identify the status of the polling object.
c) Select "True" from the drop-down list to identify the data collection of the polling object.
d) Specify the polling period.
e) Specify the server types for the polling object in the Match Criteria. The possible bwServerType
values are:
• bwserver-net
• bwserver-app
• bwserver-app-web
• bwserver-cds
• bwserver-media
All other servers use their "short name": PS, XSP, XS, and so on.
a) Specify the OID of the PM you want with its name in Data Configuration.
b) Select your threshold in More Properties.
c) Click Add.
d) Click Submit.
3) Create an event filter to look for your threshold event and send yourself an e-mail. For a step-by-step
procedure to create an alarm filter, see Add Alarm Filter on page 332. To look for your threshold event
and send yourself an e-mail:
a) Click the Admin tab.
b) Click Add Filter.
c) Complete the entries as follows:
a) Filter Name: Enter the name of the filter, for example, "EventFilterAuthFailure".
b) Message: Enter the text of the trap to use for identification, for example, "Too many logins". This
text must match the specific text in the Message field of the trap.
d) Select "Send Email Action" from the Operations drop-down list. The Configure Send Email Action
dialog box appears.
e) Complete the entries as follows:
a) Filter Name: Enter the name of the filter, for example, "EventFilterAuthFailure".
b) Action Name: Enter a unique action name.
c) SMTP Server: Enter the address for the SMTP server.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 350
 d) To Mail ID: Enter the address to send the e-mail to.
e) From Mail ID: Enter the address of the sender.
f) Subject: Enter a subject line to include on the e-mail.
g) Message: Enter text that relates to the threshold, for example, $text. $message, $source.
f) Click Submit. The new Send E-mail Action appears on the list of Available Actions.
g) Select the new "Send E-Mail Action" from the list of Available Actions and click >> to move the
action to the list of Associated Actions.
h) Click Submit.
4) If you set the threshold category to be "Threshold", you must reorder the filters as follows:
a) From the Event Filters page, click Save Filters. The Save Event Filters dialog box appears.
b) Move the new filter to the top of the list with the up arrows.
c) Click Save.
When your threshold is crossed, there is an event, and you receive an e-mail similar to the following:

viras03.mtl.broadsoft.com. psOciStatsNbAuthorizationRequestFailures
unspecified Mar
31,2012 09:50:32 AM Too Many login failure Value: 21 Data:
psOciStatsNbAuthorizationRequestFailures : viras03.mtl.broadsoft.com. :
.1.3.6.1.4.1.6431.1.6.8.1.6.0 Threshold Type: max Critical Threshold : 10
Critical Rearm
Value: 6
Email:
Subject: This is a test email
viras03.mtl.broadsoft.com.:.1.3.6.1.4.1.6431.1.6.8.1.6.0
Body:
TIME:Sat Mar 31 10:19:32 EDT 2012
Something related to threshold. Too Many logins
Value: 28 Data:
psOciStatsNbAuthorizationRequestFailures : viras03.mtl.broadsoft.com. :
.1.3.6.1.4.1.6431.1.6.8.1.6.0 Threshold Type: maxCritical Threshold :
10Critical Rearm Value:
0 viras03.mtl.broadsoft.com.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 351
10 Managing Centralized Services

This section provides information on how to use the centralized services to simplify user migration,
maintenance tasks, audible alarms, and service packs.
This section describes the following:
• Performing User Migration on page 352
• Setting Up Maintenance Tasks on page 376
• Managing Audible Alarms on page 382
• Managing Service Packs on page 385

10.1 Performing User Migration

This tool is used to migrate the enterprise/service provider on servers running one of the following
releases:
• Release 14.0 with application patches (APs)
• Release 14.sp1 and higher with APs
Although not all servers involved in the migration need to be at the same release, the source and
destination servers must be at the same release. For instance, the source Application Server cluster must
run the same BroadWorks version as that on the destination Application Server cluster.
The enterprise and service provider migration provides processes and supporting tools to perform the
migration of enterprises and service providers from one Application Server cluster to another. The whole
migration process is run and controlled by the BroadWorks Element Management System (EMS).
In addition to Application Server users, key resources and data from other BroadWorks servers are
migrated. Shared resources, the Network Server, and location information are also migrated. As an
option, the Call Detail Server, Call Center Reporting Server, and Conferencing Server data can be
migrated.
There are many steps involved in such a process and some of these require manipulation of data
contained in the server's database and resource relocation (impacts on licensing, directory numbers [DNs],
devices, and so on). Performing these steps manually can lead to errors that lead to the automation of the
process.
The following figure shows a high-level flow of data migration.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 352
 Figure 182: Data Migration Flow

For more information

10.1.1 Configure User Migration

Use the User Migration Management Configuration panel to migrate users.
The Configure Migration tab shows a table that contains configured migration. The table is empty when no
migration has been configured or when all migration has been deleted.
Clustered Resources Migration: This step includes migrating information on enterprises/service
providers from the source Application Server to the destination Application Server. It involves copying
database-related information on enterprises/service providers from one cluster to another. It also

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 353
 includes copying all the related system prompts/announcements for end users/groups. In addition to the
Application Server, other servers are also considered in this category, that is, the Call Detail Server and the
Conferencing Server. Note that after this step, the enterprise/service provider is still hosted on the source
Application Server cluster; no data is deleted just yet.
Access Devices Migration: This step involves changing the device’s configuration such that devices are
now pointing to the new Application Server cluster.
Shared Resources Migration: This step includes the migration of the Network Server data. In this case,
migration means changing data on the Network Server. There is no data moving from one Network Server
to another.
It should be noted that migrating the enterprises/service providers is performed during a maintenance
window.
Migration Cleanup Phase: Once the first three steps have been successfully completed and validated,
the last step consists of removing the data from the source clustered resources. Since the data is not
deleted before that point, it is always possible for an operator to revert back to the initial configuration at
any point in time.

NOTE: This page is available from the EMS Java application only. Log in to the EMS Java application to
access this page.

Figure 183: User Migration Management

The information on this page includes the following:

Column Description

Name This column specifies the name of the user to migrate.

Enterprises This column specifies the name of the enterprise when there is one enterprise/service provider
selected. Otherwise, it includes the number of enterprises/service providers when there are two or
more enterprises/service providers selected.

Source AS Cluster This column specifies the source Application Server cluster that the user information is migrated
from.

Destination AS Cluster This column specifies the destination Application Server cluster that the user information is migrated
to.

Current State This column specifies the current state of the user migration.

To update a user migration configuration:

1) Log in to the EMS Java client.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 354
 2) From the Administration Tools menu, click User Migration Management. The Configure Migration tab
appears.
3) Select the row that contains the configuration that you would like to update.

NOTE: An active migration configuration (the one being selected for execution) cannot be deleted
and the update is limited depending on the progress of the migration. For example, it is not possible
to change the source and destination Application Server cluster once the Application Server cluster
validation is completed or if it is ongoing. The Network Server is mandatory for the Shared Resources.

4) Click Update. The User Migration Add/Update dialog box appears.

5) Update the required input boxes.
6) Click Apply to save your changes or click Cancel to exit the configuration.
To delete a user migration configuration:
1) Log in to the EMS Java client.
2) From the Administration Tools menu, click User Migration Management. The Configure Migration tab
appears.
3) Select the row that contains the configuration that you would like to delete.

NOTE: An active migration configuration (the one being selected for execution) cannot be deleted
and the update is limited depending on the progress of the migration. For example, it is not possible
to change the source and destination Application Server cluster once the Application Server cluster
validation is completed or if it is ongoing. The Network Server is mandatory for the Shared Resources.

4) Click Delete. The user migration is removed from the list.

5) Click Apply to save your changes or click Cancel to exit the configuration.

10.1.2 Add User Migration Configuration

When adding a configuration all parameters can be set. However, when updating a migration using the
Update button, only some parameters can be changed. The parameters that can be changed depend on
the status of the migration. When the migration has just been created, all parameters can be changed
except the migration name. The migration name can never be changed. When the validation of the
Application Server clusters has been performed, it is no longer possible to change the enterprise/service
provider, the source Application Server cluster, or the destination Application Server cluster. Once the
validation step of a server category (Application Server, Conferencing Server, and Network Server) has
been performed, it is no longer possible to change the parameter for that category.
A configured migration can be deleted from the table by selecting it and clicking the Delete button. When a
migration is deleted, all its associated migration files are deleted.
Use the User Migration Configuration page to migrate users.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 355
 Figure 184: User Migration Configuration

The information on this page includes the following:

Input Box Description

User Migration Name This text box specifies the name of the user migration. It is used to identify the migration. This can
be any sequence of character except the following: * ? ! | \ / ' " { } < > ; , ^ ( ) $ ~. This name is used
for the file name logging as well as directory name where migration files are saved.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 356
 Input Box Description

Enterprises/Service This text box specifies the name(s) of the enterprises/service providers to migrate. This list contains
Providers to Migrate the identities of multiple enterprises/service providers on one line. Identities are separated by a
comma. The enterprise's/service provider’s identity can contain any characters. The leading and
trailing white spaces of the enterprise's/service provider identity are trimmed when the enterprises/
service providers list is parsed and saved to the EMS database. When the enterprise/service
provider identity contains a comma, the identity needs to be in double quotation marks. In the
following example the identity "BroadSoft, Inc." is in quotation marks because the identity includes
a comma:
Enterprise1, "BroadSoft, Inc.", Enterprise 2
Use the Select button to add enterprises/service providers identities to the list. For the Select button
to provide an enterprises/service providers selectable list, the node access data of the source
Application Server cluster needs to be properly configured (BW Web Access credentials).

Source AS Cluster Address This drop-down list specifies the primary server address of the Application Server cluster from
which the enterprise/service provider is migrated. The list is populated using the EMS inventory.

Destination AS Cluster This drop-down list specifies the primary server address of the Application Server cluster to which
Address the enterprise/service provider is migrated. The list is populated using the EMS inventory.

Migrate CDS This check box determines whether the Call Detail Server is migrated.

Source CDS This text box specifies the server address of the Call Detail Server (CDS) from which the data
associated to the migrated enterprise/service provider is taken.

NOTE: The Call Detail Server is not supported in Release 14.sp1.

Destination CDS This text box specifies the destination Call Detail Server address.

NOTE: The Call Detail Server is not supported in Release 14.sp1.

Migrate CCR This check box determines whether the Call Center Reporting Server is migrated.

NOTE: The Call Center Reporting is not supported in Release 14.sp1.

Source CCR This text box specifies the source Call Center Reporting Server address.

NOTE: The Call Center Reporting is not supported in Release 14.sp1.

Destination CCR This text box specifies the destination Call Center Reporting Server address.

NOTE: The Call Center Reporting is not supported in Release 14.sp1.

Migrate CS This check box determines whether the Conferencing Server is migrated.

Source CS This text box specifies the source Conferencing Server address.

Destination CS This text box specifies the destination Conferencing Server address.

Network Server Address This drop-down list specifies the primary server address of the Application Server cluster to which
the enterprise/service provider is migrated. The list is populated using the EMS inventory.

NOTE:
For the migration task to work properly, all cluster resources identified must already be known as EMS
monitored nodes.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 357
 NOTE: The EMS must be able to reach the network elements (NEs) involved in the migration using their
host name. It is recommended to update the /etc/hosts file, when needed, to include the host name to IP
address mapping for these NEs.

To add a user migration configuration:

1) Log in to the EMS Java client.
2) From the Administration Tools menu, click User Migration Management. The Configure Migration tab
appears.
3) Click Add. The User Migration Configuration dialog box appears.
4) In the User Migration Name text box, enter a name for the configuration.
5) For Clustered Resources:
a) Select the source Application Server cluster address from the drop-down list.
b) Enter the enterprises/service providers to migrate or click Select to select enterprises/service
provides from the Enterprises/Service Providers Selection dialog box.
a) Check the enterprises/service providers to migrate.
b) Check the Show Selected Only check box to display only the enterprises/service providers that
have been checked.
c) Click OK to save the selections or Cancel to disregard the changes. The User Migration
Configuration page appears.
c) Select the destination Application Server cluster address from the drop-down list.
d) If you want to migrate the Call Detail Server, select the Migrate CDS check box and enter the
information for the source Call Detail Server and the destination Call Detail Server.
e) If you want to migrate the Call Center Reporting Server (CCRS), select the Migrate CCR check
box, and enter the information for the source Call Center Reporting Server and the destination Call
Center Reporting Server.
f) If you want to migrate the Conferencing Server, select the Migrate CS check box, and enter the
information for the source Conferencing Server and the destination Conferencing Server.
6) For Shared Resources, enter the following information:
• Select the Network Server Address from the drop-down list.

NOTE:
Migrating the Call Detail Server, the Call Center Reporting Server, and the Conferencing Server
are optional. However, the enterprise/service provider, the source, and the destination Application
Server cluster are mandatory.
For the Shared Resources, the Network Server is mandatory.

7) Click Apply to add the migration configuration. A new row is added in the Configured Migration table.
Or, click Cancel to exit the configuration.

10.1.3 Migration Phases

The following sections provide information on each migration phase.
For more information

10.1.3.1 Application Server Migration Phases

To ensure consistent behavior before and after the Application Server migration, there are some
requirements that must be manually validated. The resources defined and used by the migrated enterprise/
service provider on the source Application Server cluster must also be defined on the destination
Application Server cluster. The following resources must be validated:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 358
 • Time zones
• Licensing and trunking call capacity
• Device types used by the enterprise/service provider to be migrated
• Media sets
• System-level voice messaging point of presence (POP)/Internet Message Access Protocol (IMAP)
setup (if enterprise or group POP/IMAP is not used)
• Calling zones
• Network classes of service
• Calling party categories
• Classmark
• Communication Barring profiles
• Route point external systems
• Communication Barring call types
• Communication Barring alternate call indicator
• Report templates
• Application Server sets
• Recording platforms
In addition to the resources, there are some settings on the destination Application Server cluster that must
match the source Application Server cluster. The following is the list of settings:
• System-level password rules
• External authentication settings
• Digit collection settings
• System-wide voice portal number (Note that the migrated service provider/enterprise needs to be
notified of new number.)
• Web branding
• Call Processing policies
• Voice portal passcode rules
• Lightweight Directory Access Protocol (LDAP) directory settings
• Call types/emergency number mappings
• Database permanent and temporary sizes
• Enhanced Call Log destination schema (If Enhanced Call Logs is activated for the enterprise or service
provider being migrated, the Database Server for the destination Application Server cluster must be
configured accordingly.)

NOTE:
The migration tool does not validate the above resources and settings. It is the responsibility of the
operator to ensure resources and settings are properly configured.

Once the above items have been validated, the Application Server migration can take place. The
Application Server migration phase is done in four steps:
1) Application Server cluster validation
2) Application Server cluster migration
3) Application Server cluster file migration
4) Application Server cluster migration check
For each step, certain actions are performed. The number of actions and the time each action takes to
execute vary from one step to another. The following table lists the main actions executed for each step
while in migration mode:
Migration Step Actions

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 359
 Action Description

Application Server Cluster Validation

Software Version Validation It must be verified that the software version and patch level on
the source and destination Application Server clusters are the
same.

Source Application Server Cluster State The cluster must be locked.

Destination Application Server Cluster State The cluster must be locked, the replication must be stopped,
and the primary server must be stopped.

Default Domain The default domain on the source and destination cluster must
match.

Enterprise/Service Provider The enterprise/service provider must exist on the source

Application Server cluster and must not exist on the destination
Application Server cluster.

Activatable Features The list of activatable features on the source and destination
Application Server clusters must match.

DNs Validation The directory numbers (DNs) of the migrated enterprise/service

provider must not already be used on the destination Application
Server cluster.

Service Pack Migration and Trunk Group User Creation Tasks There must not be any service pack migration tasks and no
trunk group user creation task in pending or running state on the
source Application Server cluster.

Number Activation Settings The "useNumberActivation" and "useGroupEnabledActivation"

system parameters must be the same on the source and
destination Application Server clusters.

File System Protocol The "fileSystemProtocol" system parameter must be the same
on the source and destination Application Server clusters.

System Realm The default system realm must be the same on source and
destination Application Server clusters.

Application Server Cluster Migration

Source Application Server Cluster State The cluster must be locked.

Destination Application Server Cluster State The cluster must be locked, the replication must be stopped,
and the primary server must be stopped.

Tables Migration The data from the source Application Server cluster is migrated
to the destination Application Server cluster. There are many
database tables to transfer, each corresponding to an action.
Depending on the size of the database, the execution of these
actions can be time-consuming.

Application Server Cluster File Migration

Files and Scripts Transfer The necessary files and scripts required for the file migration
are transferred to the source and destination Application Server
clusters.

User File Migration The files associated with the migrated users are transferred
from the source to the destination Application Server
cluster. Depending on the number of user files to transfer, this
action can be time-consuming.

Configuration File Migration The files associated with the migrated devices are transferred
from the source to the destination Application Server cluster.
Depending on the number of configuration files to transfer, this
action can be time-consuming.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 360
 Action Description

JWS Configuration File Migration The JWS configuration files associated with the migrated
enterprises/service providers are transferred from the source to
the destination Application Server cluster. This is only applicable
if the JWS configuration files are saved in a file repository
hosted on the source Application Server cluster and the same
configuration (local file repository) exists on the destination
Application Server cluster.

Application Server Cluster Migration Check

None There is no action performed by the tool during this step. An

operator can manually verify that the enterprise/service provider
has been migrated.

For more information

10.1.3.1.1 Start Migration Task
To successfully go through the Application Server migration phase, there are some manual steps that
need to be performed prior to starting the migration. This is done by clicking the Activate button under the
Execute Migration tab. The following list describes the manual steps to perform and the order in which they
have to be performed:
1) Perform a backup on the source and destination primary Application Server. This is done using the
command: bwBackup.pl AppServer <backupFileName>.
2) If the Enhanced Call Logs feature is activated for the enterprise or service provider being migrated,
perform a backup of the destination Database Server (DBS).
3) Perform a backup on the primary source Network Server. This is done using the command:
bwBackup.pl NetworkServer <backupFileName>.
4) On the destination primary Application Server, set the registration extension timer to extend all active
registers for existing destination cluster users. The timer should be set to cover the entire migration
window: AS_CLI/System/Registration> set extensionTimeInSeconds 10800.
5) Lock the source and destination Application Server clusters. This is done using the command: peerctl
lock all.
6) Stop the replication on the destination Application Server cluster. This is done using the command:
peercmd repctl stop.
7) Stop BroadWorks on the destination primary Application Server. This is done using the bwcli from which
the server can be locked and stopped.
10.1.3.1.2 Items Not Migrated
For the Application Server migration, there is some data that is not migrated. The following database items
are not migrated by the tool:
• Subscriptions (both Session Initiation Protocol [SIP] and Media Gateway Control Protocol [MGCP])
• Lawful intercept settings
• SAC group devices, under certain circumstances: SAC group devices are migrated when the attached
access device belongs to a service provider or customer that is being migrated. However, if the SAC
device is attached to a system device, then it is not migrated.
In addition, customer premises equipment (CPE) configuration system default template files are not copied
to the target cluster and need to be manually copied.
10.1.3.1.3 Application Server Migration Completion
Once the Application Server migration is successfully completed, the operator can proceed to the
Conferencing Server migration (if applicable) and Network Server migration phases. At this point, the
source Application Server cluster is no longer required and can safely be unlocked with the following step.
Unlock the source Application Server cluster. This is done using the command: peerctl unlock all.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 361
 Related information
10.1.3.1.3.1 Destination Application Server Cluster State
The state transition of the destination Application Server cluster depends on the testing approach chosen
by the operator. Until the Network Server migration phase is completed, full testing cannot be completed;
however, certain tests can be done prior to Network Server migration. By the end of the migration process,
all eight of the following steps must be completed. In general, the operator would restore the destination
primary Application Server after the Application Server migration phase completes the following steps:
1) Start the replication on the destination primary Application Server. This is done using the command:
repctl start.
2) Start the destination primary Application Server. This is done using the command: startbw.
At this point, the destination primary Application Server is running, but with the database still locked.
The operator continues on through the Network Server migration phase. Once the Network Server
migration phase is completed, the testing phase begins. For post-migration provisioning testing, the
destination primary Application Server needs to be unlocked.
3) Unlock the destination primary Application Server. This is done using the command: peerctl unlock
Once the testing phase is complete, the destination secondary Application Server can then be
synchronized to the primary Application Server via a database import.
4) Stop the destination secondary Application Server. This is done using the bwcli from which the server
can be locked and stopped.
5) Import the database on the destination secondary Application Server. This is done using the command:
importdb.pl appserver <peer> appserver.
6) Start the replication on the destination secondary Application Server. This is done using the command:
repctl start.
7) Unlock the destination secondary Application Server. This is done using the command: peerctl
unlock.
8) Start BroadWorks on the destination secondary Application Server. This is done using the command:
startbw.
10.1.3.1.3.2 Revert Application Server Migration
When the tool is switched to revert migration mode during various Application Server migration steps, the
same steps are executed in reverse order. However, not all the same actions are executed. The following
table shows the actions performed automatically by a revert migration.
Revert Migration Step Actions
Action Description

Application Server Cluster Validation

None This step is not performed in revert migration mode.

Application Server Cluster Migration

None This is a manual step in which an operator must restore the

database on the destination Application Server cluster. For
more information on how to restore from a backup, see the
BroadWorks Maintenance Guide.

Application Server Cluster File Migration

Files and Scripts Transfer The necessary files and scripts required for the "revert" file
migration are transferred to the destination Application Server
cluster.

Removing Files The migrated user files and configuration files are deleted from
the destination Application Server cluster.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 362
10.1.3.2 Database Server Enhanced Call Logs Migration Phase
If the Enhanced Call Logs (ECL) feature is activated, user call logs from one or more enterprises and/or
service providers are recorded on a Database Server (DBS). The Database Server can be shared between
multiple Application Server clusters, and the call logs for each cluster are separated into independent
database schemas.
There is no configuration for the Enhanced Call Logs migration phase. The existence of a Database Server
and enhanced call logs is automatically determined for the migrated enterprise or service provider. The
Enhanced Call Logs migration steps are always present on the Migration tab. They are skipped (marked as
completed) if there a no logs to migrate.
After the Application Server portion of the migration completes, enhanced call logs for new calls are
reported to the Database Server assigned to the destination Application Server cluster. Thus, the source
call log data is effectively static and suitable for migration. Enhanced Call Logs data migration to the
destination Database Server can occur simultaneously with new call reporting.

NOTE: Enhanced Call Logs migration can occur simultaneously with active calls.

Before beginning Enhanced Call Logs migration, there are a few manual preparation steps the operator
must perform. These steps should be completed before Application Server migration begins:
1) Back up the Database Server where the destination Application Server cluster is configured to record
enhanced call logs.
2) Verify that the Enhanced Call Logs schema for the destination Application Server cluster has been
created on the destination Database Server.
3) Verify that the destination Database Server is large enough to accommodate the call log data for the
enterprise or service provider being migrated.

NOTE: The only way to completely revert a failed or aborted Enhanced Call Log migration is to restore
the destination Database Server from a backup.

The migration of enhanced call logs is performed in four steps:

1) Database Server Enhanced Call Logs validation
2) Database Server Enhanced Call Logs migration
3) Database Server Enhanced Call Logs migration check
4) Database Server Enhanced Call Logs cleanup
Database Server Enhanced Call Logs Migration Step Actions
Action Description

Database Server Enhanced Call Logs Validation

Prepare Database (DB) Connection Framework Verify connectivity to the source and destination Database
Servers (DBS) in preparation for migration of enhanced call log
(ECL) data for the enterprise or service provider. It is expected
the operator has performed the manual preparation steps (see
above).

Database Server Enhanced Call Logs Migration

Migrate Customers Migrate the enterprise or service provider entries from the
source to the destination Database Server as identified for the
migration.

Migrate Enterprise Groups Migrate the relevant enterprise group entries from the source to
the destination Database Server. If a service provider is being
migrated, this "action" has no work to perform.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 363
 Action Description

Migrate Users Migrate the relevant user entries from the source to the
destination Database Server.

Query Log Tables Identify the call log tables with data to migrate.

Migrate Logs Migrate the call logs for all relevant users in all identified
tables. This action may take an extended period of time to
complete; the time required to complete it depends on the
number of enhanced call logs users, the call volume, and call
log retention period. If log migration is interrupted due to a
network outage, this action may be reattempted without need for
recovery of the destination database.

Database Server Enhanced Call Logs Migration Check

None There is no action performed by the tool during this step. An

operator can manually verify that enhanced call logs for the
enterprise or service provider have been migrated.

For more information

10.1.3.2.1 Revert Database Server Enhanced Call Logs Migration
Although the migration steps may be reverted, there is no action taken. If enhanced call log migration
is interrupted due to a network outage or if the migration tool is interrupted or aborted, migration may be
reattempted without need for recovery of the destination database.
However, if complete recovery of the destination Database Server (DBS) is desired, manual restoration
from a pre-migration backup is required.

10.1.3.3 Call Detail Server Migration Phase

The Call Detail Server keeps user call logs received from multiple enterprises and service providers. In the
context of user migration, there are two possible configurations:
• First possible configuration: The Call Detail Server is shared between the source and destination
Application Server clusters.
• Second possible configuration: The source and destination Application Server clusters both have their
own Call Detail Server.
In the first configuration, there is no Call Detail Server migration required and the destination Application
Server cluster simply needs to be configured to send its call logs to the same Call Detail Server as the
source Application Server cluster. The logs of the migrated users are preserved since they remain on the
same Call Detail Server.
In the second configuration, the migration tool is used to move the call logs of the migrated users from
a source Call Detail Server to a destination Call Detail Server. The migration tool is also responsible for
removing the migrated call logs from the source Call Detail Server during the cleanup phase. The migration
of the Call Detail Server is done in four steps as follows:
1) Call Detail Server validation
2) Call Detail Server migration
3) Call Detail Server migration check
4) Call Detail Server cleanup

NOTE: During the migration, the source and destination Call Detail Server must be stopped.

Call Detail Server Migration Step Actions

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 364
 Action Description

Call Detail Server Validation

Software Version Validation Verify that the software version and patch level on the source
and destination Call Detail Servers are the same.

Source and Destination Servers State The source and destination servers must be stopped.

Call Detail Server Migration

Source and Destination Servers State The source and destination servers must be stopped.

Table Migration (Call Logs) The call logs from the source server are transferred to the
destination server. During this action, each database table from
the source server is searched for call logs to migrate. Each call
log found is copied to the destination server. Depending on the
number of call logs to migrate, the execution of these actions
can be time-consuming.

Call Detail Server Migration Check

None There is no "action" performed by the tool during this step.

An operator can manually verify that the call logs have been
migrated.

When the migration is complete, the source and destination Call Detail Server can be started.
For more information
10.1.3.3.1 Revert Call Detail Server Migration
For the revert migration mode, the migration steps are executed in reverse order. During these steps, the
migrated call logs are removed from the destination Call Detail Server such that the server is brought back
to the state it was in before the migration. The following table summarizes the actions performed in revert
migration mode.
Revert Migration Step Actions
Action Description

Call Detail Server Validation

None There is no action performed by the tool during this step when in
revert migration mode.

Call Detail Server Migration

Destination Server State The destination server must be stopped.

Remove Migrated Data This action removes all user call logs that have been migrated
from the destination Call Detail Server. Depending on the
number of call logs to remove, this action can be time-
consuming.

Call Detail Server Migration Check

None There is no action performed by the tool during this step when in
revert migration mode.

Once the revert migration is complete, the destination Call Detail Server can be started.

10.1.3.4 Call Center Reporting Server Migration Phase

The Call Center Reporting Server holds call center and agent statistics. For the Call Center Reporting
Server, there are two possible configurations:
• First possible configuration: A Call Center Reporting Server is shared between the source and
destination Application Server clusters.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 365
 • Second possible configuration: The source and destination Application Server clusters both have their
own Call Center Reporting Server.
In the first configuration, there is no Call Center Reporting server migration required, the migrated call
centers are already configured for the Call Center Reporting server. The statistics for the migrated call
centers and agents are preserved since they are on the same Call Center Reporting server.
In the second configuration, the migration tool is used to move the call center and agent statistics of the
migrated users from a source Call Center Reporting Server to a destination Call Center Reporting Server.
The migration tool also removes the migrated statistics from the source Call Center Reporting Server. The
migration of the Call Center Reporting Server is done in four steps as follows:
1) Call Center Reporting Server validation
2) Call Center Reporting Server migration
3) Call Center Reporting Server migration check
4) Call Center Reporting Server cleanup
In the first configuration, there is no Call Center Reporting server migration required, the migrated call
centers are already configured for the Call Center Reporting server. The statistics for the migrated call
centers and agents are preserved since they are on the same Call Center Reporting server.
In the second configuration, the migration tool is used to move the call center and agent statistics of the
migrated users from a source Call Center Reporting server to a destination Call Center Reporting server.
The migration tool also removes the migrated statistics from the source Call Center Reporting server. The
migration of the Call Center Reporting server is done in four steps as follows:
1) Call Center Reporting server validation
2) Call Center Reporting server migration
3) Call Center Reporting server migration check
4) Call Center Reporting server cleanup

NOTE: During the migration, the source and destination Call Center Reporting servers must be stopped.

Call Center Reporting Server Migration Actions

Action Description

Call Center Reporting Server Validation

Software Version Validation Verify that the software version and patch level on the source
and destination Call Center Reporting Servers are the same.

Source and Destination Server State The source and destination servers must be stopped.

Call Center Reporting Server Migration

Source and Destination Server State The source and destination servers must be stopped.

Table Migration (Statistics) The call center and agent statistics from the source server are
transferred to the destination server. During this action, each
database table from the source server is searched for call center
and agent statistics to migrate. Statistics found are copied to
the destination server. Depending on the number of statistics to
migrate, the execution of these actions can be time-consuming.

Update Reporting URL This action updates the reporting Uniform Resource Locator
(URL) of the migrated call center on the destination Application
Server cluster.

Call Center Reporting Server Migration Check

None There is no action performed by the tool during this step. An

operator can manually verify that the statistics have been
migrated.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 366
 Once the migration is complete, the source and destination Call Center Reporting Servers can be started.
For more information
10.1.3.4.1 Revert Call Center Reporting Server Migration
When executing the migration in revert mode, the migrated statistics are removed from the destination Call
Center Reporting Server. At the end of the revert migration, the destination Call Center Reporting Server
is returned to the state it was in before the migration.
The following table summarizes the actions performed for the revert migration mode.
Revert Migration Step Actions
Action Description

Call Center Reporting Server Validation

None There is no action performed by the tool during this step when in
revert migration mode.

Call Center Reporting Server Migration

Destination Server State The destination server must be stopped.

Remove Migrated Data This action removes all statistics associated with the migrated
call centers and users from the destination Call Center
Reporting server. Depending on the number of statistics to
remove, this action can be time-consuming.

Call Center Reporting Server Migration Check

None There is no action performed by the tool during this step when in
revert migration mode.

Once the revert migration is complete, the destination Call Center Reporting Server can be started.

10.1.3.5 Conferencing Server Migration Phase

The migration of the Conferencing Server is done in four steps as follows:
1) Conferencing Server validation
2) Conferencing Server migration
3) Conferencing Server migration check
4) Conferencing Server cleanup
During the Conferencing Server migration, the following items are migrated:
• Bridges
• Conferences
• Delegates
• Documents
However, the migration tool does not support migration of all conferencing-related information. There are
two items the tool cannot migrate (as they are lost during the migration):
• Recordings
• Reports
The tool preserves all the conferencing information while migrating conferences. However, there are some
cases in which certain information cannot be preserved and needs to be regenerated. This is the case
for a conference's passcode. The following two cases describe when the passcodes may need to be
regenerated:
Case 1: Configuration mismatch between source and destination Conferencing Server: The source and
destination do not have the same number of nodes. Each node has its own prefix, so when migrating from

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 367
 a node that does not exist on the destination Conferencing Server, it means that the conference must be
created on another node and therefore, with a new passcode.
Case 2: Passcode already exists: When migrating to a Conferencing Server that already holds bridges
and conferences, it is possible that the passcode of a migrated conference is already in use by an existing
conference. In this case, a new passcode is generated.
In both of these cases, when a new passcode is generated for a migrated conference, an entry is added in
a file. The file is located in:
/var/broadworks/userfiles/SPMigration/<migrationName>/CSModifiedConferences.log.
The <migration name> is the name used when creating the migration in the graphical user interface (GUI).
An operator can use this file to determine whether a conference's passcode has changed and then take
appropriate actions.
The following table shows the actions performed during the Conferencing Server migration phase, in detail.
Conferencing Server Migration Step Actions
Action Description

Conferencing Server Validation

Conferencing Server Addresses Validation This action verifies that the specified Conferencing Server
addresses are valid.

Software Version Validation This action verifies that the software version on the source and
destination Conferencing Servers is the same.

Conferencing Server Configuration This action verifies that the source Conferencing Server stack
and the destination Conferencing Server stack contains the
same number of nodes. When the number is different, a
warning message is displayed to the operator. If the operator
decides to continue with the Conferencing Server migration, it is
possible for the migrated conferences to have their access code
changed.

Conferencing Server Migration

Create Organization This action creates the bridges on the destination Conferencing
Server. The list of bridges to create is obtained from the source
Conferencing Server.

Create Bridge Administrator This action creates the bridge administrator on the destination
Conferencing Server.

Migrate Delegates This action creates the delegates on the destination

Conferencing Server.

Migrate Conference This action creates the conferences on the destination

Conferencing Server.

Conferencing Server Migration Check

None There is no action performed by the tool during this step. An

operator can manually verify that the bridges and conferences
have been migrated.

For more information

10.1.3.5.1 Revert Conferencing Server Migration
In revert migration mode the following automatic actions are performed during various steps of the
Conferencing Server migration phase. During that step the migrated information is removed from the
destination Conferencing Server.
Revert Migration Step Actions

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 368
 Action Description

Conferencing Server Validation

None There is no action performed by the tool during this step when in
revert migration mode.

Conferencing Server Migration

Remove Migrated Data This action removes all the data that has been migrated from the
destination Conferencing Server.

Conferencing Server Migration Check

None There is no action performed by the tool during this step when in
revert migration mode.

10.1.3.6 Network Server Migration Phase

The Network Server migration phase consists of updating the hosting network element (NE) associated
with the migrated enterprise/service provider's information (for example, directory numbers [DNs] and
Uniform Resource Locators [URLs]). The destination hosting NE must be manually configured on the
Network Server prior to commencing the Network Server migration. The source and destination hosting
NEs must be configured in the same way to ensure that calls are routed the same way before and after the
migration.
For the Network Server Migration phase to complete successfully, domains on the Application Server and
Network Server clusters must be synchronized.
The Network Server migration involves three steps:
1) Network Server validation
2) Network Server migration
3) Network Server migration check
There is no cleanup step in this case as there is no information to delete from the Network Server; only the
data is updated.
The following table shows the actions performed during the execution of each step.
Network Server Migration Step Actions
Action Description

Network Server Validation

Validate hosting NE attributes This action checks the attributes of the source and destination
hosting NE. If there are differences, this may impact call
processing on the Network Server. Calls made before and
after the migration may not be routed the same way for the
users in the migrated enterprise. It is suggested to perform
test calls and verify translations (VTRs) to ensure that calls still
complete successfully after the migration, or if possible, review
the attributes on both hosting NEs to confirm that they must be
different.

Validate hosting NE mediaCodecs support This action verifies the mediaCodec support of the source
and destination hosting NEs. In cases where the source and
destination do not have the same support, the call processing
may be impacted on the Network Server. Calls made before
and after the migration cannot be routed the same way for the
users in the migrated enterprise. It is suggested to perform test
calls and VTRs to ensure that calls still complete successfully
after the migration, or if possible, review the mediaCodecs on
both hosting NEs to confirm that they must be different.

Check for duplicate group names This action checks whether the groups of the source hosting NE
already exist on the destination hosting NE.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 369
 Action Description

Network Server Migration

Get migration information This action gathers information that is used by the other actions
for the migration.

DNs migration This action changes the hosting NE associated with the DNs of
the migrated enterprise/service provider.

Extensions migration This action changes the hosting NE associated with the
extensions of the migrated enterprise/service provider.

URLs migration This action changes the hosting NE associated with the URLs of
the migrated enterprise/service provider.

User group and routing policies migration This action changes the hosting NE associated with the user
groups and policies of the migrated enterprise/service provider.

Admin IDs migration This action changes the hosting NE associated with the
administrator IDs of the migrated enterprise/service provider.

Network Server Migration Check

None There is no action performed by the tool during this step. An

operator can manually verify that the hosting NE for the DNs,
extensions, URLs, user group and policies, and administrator
IDs have been changed for the migrated enterprise/service
provider.

NOTE: During the validation actions in the Network Server validation step, a warning message can be
displayed to the operator to inform of the differences between the source and destination hosting NEs. In
these cases, the operator should consider updating the hosting NEs to ensure routing remains the same
after the migration.

For more information

10.1.3.6.1 Revert Network Server Migration
In revert migration mode, the Network Server migration is totally reverted and the Network Server returns
to the state it in was prior to the migration. The following table shows the automatic actions performed for
each steps during a "revert" in the Network Server migration phase.
Revert Network Server Migration Step Actions
Action Description

Network Server Validation

None There is no action performed by the tool during this step when in
revert migration mode.

Network Server Migration

Get Migration Information This action gathers information that is used by the other actions
for the migration.

DNs Migration This action changes the hosting network element (NE)
associated with the directory numbers (DNs) of the migrated
enterprise/service provider.

Extensions Migration This action changes the hosting NE associated with the
extensions of the migrated enterprise/service provider.

URLs Migration This action changes the hosting NE associated with the Uniform
Resource Locators (URLs) of the migrated enterprise/service
provider.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 370
 Action Description

User Group and Routing Policies Migration This action changes the hosting NE associated with the user
groups and policies of the migrated enterprise/service provider.

Administrator IDs Migration This action changes the hosting NE associated with the
administrator IDs of the migrated enterprise/service provider.

Network Server Migration Check

None There is no action performed by the tool during this step when in
revert migration mode.

10.1.3.7 Cleanup Phase

The cleanup phase can be executed in the same maintenance window as the migration or it can be done
at a later date. The cleanup phase should only be done after the destination Application Server cluster has
been restored to full service.
The cleanup phase is done in five steps as follows:
1) Application Server cluster cleanup
2) Database Server Enhanced Call Logs cleanup
3) Call Detail Server cleanup
4) Call Center Reporting Server cleanup
5) Conferencing Server cleanup
The following table shows the actions performed during cleanup phase.
Cleanup Step Actions
Action Description

Application Server Cluster Cleanup

Source Application Server Cluster State The cluster must be locked, the replication must be stopped,
and the primary server must be stopped.

Delete Table Content The data associated with the migrated enterprise/service
provider is deleted from the source Application Server cluster.

Delete User/Configuration Files The user/configuration files associated with the migrated
enterprise/service provider are deleted from the source
Application Server cluster.

Database Server Enhanced Call Logs Cleanup

Query Customers This identifies the enterprise or service provider entries that
were migrated from the source Database Server.

Delete Users This marks the relevant users as deleted in the source Database
Server.

Delete Groups This marks the relevant enterprise groups as deleted in the
source Database Server. If a service provider was migrated,
this "action" has no work to perform.

Delete Customers This marks the identified enterprise or service provider entries
as deleted in the source Database Server.

Tidy Resources This releases database connection resources acquired during

the migration.

Call Detail Server Cleanup

Delete Table Content The call logs associated with the migrated users are deleted
from the source Call Detail Server.

Call Center Reporting Server Cleanup

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 371
 Action Description

Delete Table Content The statistics associated with the migrated call centers and
agents are deleted from the source Call Center Reporting
Server.

Conferencing Server Cleanup

Remove Conference Information This action removes the migrated information from the source
Conferencing Server.

The following sections describe the manual steps an operator must perform before and after the
Application Server cleanup steps. There are no manual steps required for other cleanup steps.
For more information
10.1.3.7.1 Pre-Cleanup Procedure
Before starting the cleanup, the following steps are required to bring the server to a state in which it is
possible to do the cleanup safely.
Before the cleanup:
1) Perform a backup of the primary source Application Server. This is done using the command:
bwBaclup.pl AppServer <backupFileName>.
2) If the Enhanced Call Logs feature is activated for the enterprise or service provider that was migrated,
perform a backup of the source Database Server (DBS).
3) Lock the Application Server source cluster. This is done using the command: peerctl lock all.
4) Stop the replication on the Application Server source cluster. This is done using the command:
peercmd repctl stop.
5) Stop BroadWorks on the primary source Application Server. This is done using the bwcli from which the
server can be locked and stopped.
The Application Server cleanup step can now be safely initiated.
10.1.3.7.2 Post Cleanup Procedure
Once the cleanup steps are completed, the Application Server source cluster can be put back into full
service by following these steps:
1) Start the replication on the primary source Application Server. This is done using the command:
repctl start.
2) Unlock the primary source Application Server. This is done using the command: peerctl unlock.
3) Start BroadWorks on the primary source Application Server. This is done using the command:
startbw.
4) Stop BroadWorks on the secondary source Application Server. This is done using the bwcli from which
the server can be locked and stopped.
5) Import the database on the secondary source Application Server. This is done using the command:
importdb.pl appserver <peer> appserver.
6) Start replication on the secondary source Application Server. This is done using the command: repctl
start.
7) Unlock the secondary source Application Server. This is done using the command: peerctl unlock.
8) Start BroadWorks on the secondary source Application Server. This is done using the command:
startbw.
9) On the destination primary Application Server, reset the registration extension timer to the pre-migration
value as follows: AS_CLI/System/Registration> set extensionTimeInSeconds 0.

10.1.3.8 Migration Files and Logs

During the migration, there are some files generated containing information about the migrated data.
These files are stored on the EMS in the following directory:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 372
 /var/broadworks/userfiles/SPMigration/<migration name>
The <migration name> is the name used when creating the migration in the graphical user interface (GUI).
In addition to migration files, all operations performed during the migration are logged in a log file. The log
file name is tagged using the migration task name and is located in the following directory:
/var/broadworks/logs/emsBE/migration/<migrationName>_MigrationLog.txt

10.1.4 Execute User Migration

Before executing any migration steps, a configured migration must be selected and activated.
Before proceeding with the migration of the enterprise or service provider, a configured migration needs
to be selected and activated. This can be done from the Execute Migration tab of the User Migration
Management panel. When a migration is activated, a few steps are taken to gather information about the
network elements involved in the migration. Basically, the following items are retrieved from the network
element (NE).
• Software version
• Patch level
• User name and password (used to connect to the NE using Telnet/ Secure Shell [SSH])
The user names and passwords (used to connect to NEs using Telnet/SSH) are available from the EMS
configuration.
The Description section presents the operator with information about the steps that are performed.
The description also includes any manual steps that are required to be executed by the operator prior
to the execution of the migration steps. For instance, prior to migrating the Application Server cluster,
the operator must back up the destination Application Server cluster, lock the source and destination
Application Server cluster, and perform some other steps to put the server in a state in which the migration
can take place.
At the bottom of the panel are the Current Action and the progress bar. The Current Action displays the
action that is currently running. The progress bar provides an indication of the percentage of the step
completion. These two indicators provide the operator with feedback on the progress of the execution step.

NOTE: If the current action includes the processing of enterprises/service providers, the identity and
processed counts of enterprises/service providers as well as the total count are added after the current
action name. The progress bar takes into account the amount of enterprises/service providers such that
when 100 percent is reached, all actions for all enterprises/service providers are completed.

The Next button is used to move from one step to another and execute the migration. After the execution
of a step, it is possible to deactivate a migration using the Deactivate button. The migration can be
reactivated at any time and it resumes at the step where it was stopped.
In cases in which the EMS applet is closed or disconnected while a migration is still active, the migration
is not automatically deactivated. The migration remains active until the migration tool is restarted and the
migration is reactivated. When the migration is reactivated, the migration tool informs the operator that
the migration is already activated. This occurs because the migration tool remembers that the migration
has not been deactivated properly. It may also occur in cases in which another user has activated
the migration. The migration tool prompts the operator to see whether it should proceed with a forced
activation. When the operator answers "yes", the migration tool reactivates the migration and displays the
steps and status.

NOTE: Only one migration can be active at a time; therefore, only one user can have a migration
activated.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 373
 Figure 185: Execute Migration

To execute a user migration:

1) Log in to the EMS Java client.
2) From the Administration Tools menu, click User Migration Management. The Configure Migration tab
appears.
3) Click the Execute Migration tab. The Execute Migration dialog box appears.
4) In the Select a migration configuration to activate drop-down list, select a configuration.
5) Click Activate.

NOTE: If any of the items are changed after a migration has been activated, the migration must be
deactivated and then reactivated for the new values to be recognized by the migration tool.

Once the migration is activated, the following occurs:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 374
 • The bottom part of the dialog is updated with the migration status.
• The completed steps are marked with a green check.
• The current step is flagged with an arrow.
6) Click Next to continue with the migration in between each step.
7) To switch the tool to Revert mode, click Revert. The steps are executed backward and it is possible to
undo each step that has been done during the migration.

NOTE: If the cleanup step has already started, it is not possible to undo the migration process.

Once the migration is configured, a row is added to the Configured Migration table.
For more information

10.1.4.1 Subscriber Migration

As previously described, the migration steps are executed using the Next >> button. The current step
to be executed is the one marked with an arrow (→). The arrow moves from one step to the next while
executing a migration. When a step is successfully completed, a green check mark appears beside the
step name. Once all steps have a green check mark, the migration is completed.
As noted at the bottom of the Execute Migration tab, there is a Revert button. This button is used to switch
the migration tool in revert migration mode. When the button is clicked, the buttons change labels so
that the Revert button becomes << Next and the Next >> becomes a Migrate button. Using the << Next
button, it is possible to revert (undo) executed migration steps. To switch back to the migration mode, the
Migrate button must be used. Similar to the migration mode, there are some steps that are “manual” when
in revert migration mode. In this situation, the Description text box lists the necessary manual steps to be
performed by the operator.
The Revert button is not always available. Depending on the actions taken in a specific step, the Revert
button is not always applicable and as a result, it does not appear. Certain revert tasks require manual
steps while others are automatic. Upon reverting, carefully read the text description on any manual
migration step required prior to committing the “revert” by clicking on the Next button.
The migration task is comprised of a number of phases that vary depending on the User Migration
Resource configuration. Each one of the phases can be comprised of multiple steps. Each step can be
comprised of multiple tasks. The migration phases are:
• Application Server migration
• Database Server Enhanced Call Logs migration
• Call Detail Server migration
• Call Center Reporting Server migration
• Conferencing Server migration
• Network Server migration
• Application Server cleanup
• Database Server Enhanced Call Logs cleanup
• Call Detail Server cleanup
• Call Center Reporting Server cleanup Conferencing Server cleanup
For more information
10.1.4.1.1 Access Devices
If Network Server registration and Invite redirection are used by the operator's border element (for
example, session border controllers [SBCs]) to identify the Application Server cluster on which a user is
hosted, the Network Server migration phase automatically re-homes these users to the destination cluster.
Therefore, no access-side changes are required to re-home an access device.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 375
 In all other cases, it is the responsibility of the operator to manually update the enterprise/service
operator's access devices/border elements to re-home all migrated users to the destination Application
Server cluster.
For more information
10.1.4.1.1.1 General Approach
The migration phases and steps are independent and an operator can stop at any step for an unlimited
period of time. In general, due to the fact that the databases need to be locked during the migration task,
it is expected that an operator would complete the migration steps, then perform extensive testing in the
same maintenance window, and then continue with the cleanup steps.
Even though the migration process locks the database during the actual migration, it is highly
recommended that the operator (if possible) institute a provisioning freeze during the migration
maintenance window.
The level of testing required post migration depends on the operator requirements. Call processing
validation can be completed with the destination server still in the database locked state. Basic call
processing tests include items such as:
• Access-side originations from users in the migrated enterprise (requires access device re-homing)
• Network-side terminations to users in the migrated enterprise
• Voice mail deposit and retrieval
• Conferencing Server conferencing (if applicable)
Provisioning validation requires that the destination server be in a database unlocked state. This means
that data from other enterprises on the destination cluster can change as well. It is recommended that the
destination server not be left in an unlocked state until the operator is confident that there will be no revert.
Basic provisioning tests include items such as:
• User addition/user deletion
• BroadWorks client login and service actions (if applicable)
Once all testing is completed and the operator is satisfied that the migration is a success, the Application
Server or Conferencing Server cleanup phase can either be executed during the same maintenance
window or delayed until a subsequent window.
10.1.4.1.1.2 Postpone Cleanup Phases
Since the Application Server source cluster enterprise is effectively isolated after the access devices have
been re-homed and the Network Server migration phase is completed, there is no issue in terms of leaving
the Application Server source cluster enterprise in place until a subsequent maintenance window (in case
an emergency revert is required). In the event of an emergency revert, the operator would re-home the
access devices to the source cluster and run the Network Server migration revert (which does not require a
maintenance window to complete). Once the access devices re-register, service is restored.
Depending on how long the enterprise has been running on the destination cluster, it may not be advisable
to run the Application Server migration revert since this revert entails restoring the Application Server
destination cluster database from the backup created prior to the migration. This would impact all other
users on the system, effectively wiping out any changes done since the migration was completed. Another
approach would be to not run the Application Server revert migration, and instead, manually clean up the
isolated migrated enterprise information from the destination server at a later date.

10.2 Setting Up Maintenance Tasks

The Maintenance Task Setup page provides a centralized interface for configuring the maintenance tasks
of network elements (NE) remotely. You can use it to create a set of maintenance tasks and apply them
uniformly across the entire network all at once. The EMS assists you in scheduling by prohibiting central
processing unit (CPU)-intensive tasks during user-definable peak hours, and automatically determining the

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 376
 start times of the same task on peer NEs. In addition, the EMS can audit the network to report or correct
any discrepancies between what you schedule and what already exists on the network.
The functionality includes the following steps:
• Let an administrator specify the configuration for the desired BroadWorks maintenance task once at the
EMS.
• Let the EMS automatically and remotely configure the BroadWorks maintenance tasks consistently
across its managed elements (MEs).
• Optionally, let the EMS audit the network to automatically report or correct any discrepancies with the
configurations specified at the EMS.
• Allow an administrator to manually rerun the configuration of BroadWorks maintenance tasks according
to node, according to server type, or across the network.
Use the Maintenance Tasks Setup tab from the applet to configure maintenance tasks.

Figure 186: Configure Maintenance Tasks Setup

The information on this page includes the following:

Item Description

Enable Maintenance Task Setup This check box enables/disables automatic invocation upon
BroadWorks discovery. If a new node is added, the behavior
specified here is repeated upon rediscovery. Enabled (default):
The EMS automatically attempts to apply the maintenance task
setup. Disabled: No automatic setup is attempted. You must
manually invoke the EMS maintenance task setup feature.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 377
 Item Description

Daily Maintenance Window This input box sets the daily maintenance window definition.
No CPU-intensive tasks can be scheduled outside of the
maintenance window defined here. By default, the maintenance
window is from midnight to 6 A.M.

Run Audit This check box enables/disables periodic audits to report any
discrepancies between the maintenance tasks configured
at the EMS and those configured on individual NEs. When
enabled, the EMS reuses the existing setup commands from
the NEs to review the current configuration of the maintenance
tasks. Reporting is done from events and alarms where the
category reuses the existing "BW-AutoConfig" value. Results
are reported, per node, once the setup for all maintenance
tasks has completed. If an outstanding alarm exists, the EMS
automatically transforms any info event in a clear event to
support alarm auto-clearing. If automatic overrule is enabled, the
EMS reports an info event if the EMS maintenance task setup
was applied successfully. When automatic overrule is disabled
and the EMS identifies a delta between the EMS configuration
and the NE configuration, the EMS reports an event whose
severity has a criticality. An event of severity info is generated
if no delta is identified. In addition, upon successful completion
of maintenance task setup, the EMS generates an event of
severity info. In case of failure, the EMS generates an event
whose severity has a criticality, which automatically raises an
alarm. Enabled (default): The EMS reports on configuration and
audit results through EMS events and alarms. Disabled: No
reporting is performed and no events related to configuration are
generated by the EMS.

Automatic Overrule This check box enables/disables automatic overrule of

maintenance tasks already configured on NEs. The EMS
attempts to set up all requested maintenance tasks for a
given node at once, even if the setup for one task fails. When
scheduling, the EMS uses an exact match per maintenance
task to compare the existing configuration with the desired one.
When automatic overrule is enabled and the tasks do not match
completely, the EMS deletes the current setup and applies
the requested configuration. In other words, the EMS does
not apply deltas. Enabled: When applying maintenance task
configurations, the EMS overwrites any previous configuration.
Disabled (default): The EMS skips any node where a delta is
identified compared to the existing configuration.

The following table lists the maintenance tasks available for scheduling:
Task Name Description Applicable Server Types CPU-Intensive

dbMaint This maintenance task Application Server, Network Y

updates the database statistics Server
for optimal performance.

autoCleanup This maintenance task All servers Y

archives and cleans up old log
files.

healthmon This maintenance task All Servers N

monitors and reports on the
state of a BroadWorks server.

serviceLicenseCollect This maintenance task collects Application Server Y

service license information.

backup This maintenance task All Servers Y

generates a backup of
BroadWorks server dynamic
data.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 378
 Task Name Description Applicable Server Types CPU-Intensive

regAudit This maintenance task audits Application Server Y

Session Initiation Protocol
(SIP) registrations in the
BroadWorks database.

dbSyncCheck This maintenance task Application Server, Network Y

runs the syncheck_basic.pl Server
tool, which is a lightweight
mechanism to determine
whether two databases are
synchronized.

cpuMon This maintenance task All Servers N

monitors CPU idle percentage
and memory usage.

tech-support This maintenance task All Servers Y

executes the tech-support
command as a background
task.

cpuNum This maintenance task defines All Servers N

the CPU time:
• Spent processing user
code
• Spent processing system
calls or device drivers
• Spent idle

fileCollector This maintenance task All Servers N

transfers logs files from the
server to a log repository.

diskUsage This maintenance task defines All Servers N

the percentage of disk used.

perfStats This maintenance task defines All Servers N

the performance data values
to optimize data storage and to
facilitate storage cleanup.

maxDiskIO This maintenance task defines All Servers N

the average service time of the
disk and the percent of time
the disk is busy.

javaHeap This maintenance task defines All Servers N

the application's Java heap
usage.

dsnUsage This maintenance task defines Application Server, Network N

the usage of the database Server
DSN.

The following table presents typical configurations for the supported maintenance tasks. For more
information, see the BroadWorks Maintenance Guide.
Task ApplicationMedia Network Access EMS Call Xtended Profile Execution Database
Server Server Server Mediation Detail Services Server Server Server
Server Server Platform

AutoCleanupweekly weekly weekly weekly weekly weekly weekly weekly weekly weekly

Healthmon 30 30 30 30 30 30 30 30 30 30
minutes minutes minutes minutes minutes minutes minutes minutes minutes minutes

serviceLicenseCollect
daily N/A N/A N/A N/A N/A N/A N/A N/A N/A

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 379
 Task ApplicationMedia Network Access EMS Call Xtended Profile Execution Database
Server Server Server Mediation Detail Services Server Server Server
Server Server Platform

Backup weekly weekly weekly weekly weekly weekly weekly weekly weekly weekly

RegAudit weekly N/A N/A N/A N/A N/A N/A N/A N/A N/A

DbSyncCheck
daily daily N/A N/A N/A N/A N/A N/A N/A N/A

CpuMon 5 minutes 5 minutes 5 minutes 5 minutes 5 minutes 5 minutes 5 minutes 5 minutes 5 minutes 5 minutes

Tech- daily daily daily daily daily daily daily daily daily daily
support

To modify a task:
1) Log in to the EMS Java applet.
2) From the Administration Tools menu, click Mtc Task Setup. The Mtc Task Setup page appears.
3) Click the task to modify and click Update. The Setup Mtc Task page appears.
4) Modify the task as required.
5) Click Apply.
To add a task:
1) Log in to the EMS Java applet.
2) From the Administration Tools menu, click Mtc Task Setup. The Mtc Task Setup page appears.
3) Click Add. The Setup Mtc Task page appears.
4) Select the task type, the server type to which it applies, its schedule, and the first-peer start time.
5) Click Apply.
To delete a task:
1) Log in to the EMS Java applet.
2) From the Administration Tools menu, click Mtc Task Setup. The Mtc Task Setup page appears.
3) Click the task to delete and click Delete. A confirmation dialog box appears.
4) Click Yes to delete the task or No to return to the previous page.
For more information

10.2.1 Apply Maintenance Task Setup

Use the Mtc Task Setup page to apply the maintenance task to all nodes on the network or to specific
server types (such as Network Servers, Media Servers, and so on). You can also choose to apply the task
to individual nodes only. You can override any maintenance tasks already scheduled for that server or you
can let them stand.
Setting up the performance maintenance task at remote nodes is used to enable data collection at
remote nodes. In addition to existing maintenance tasks, the EMS includes the following performance
maintenance tasks: cpuNum, perfStats, diskUsage, and maxDiskIO (whereby processing enables data
collection at the remote nodes or managed objects). After this step is completed, the individual remote
notes generate local temporary data. By default, the performance task generates local data at five-minute
intervals.
None of the performance maintenance tasks is central processing unit (CPU)-intensive and they apply to
all BroadWorks servers supported by the EMS Maintenance Task Setup feature (including the Application
Server, Web Server, Network Server, Media Server, and Call Detail Server).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 380
 Figure 187: Apply Maintenance Task

The information on this page includes the following:

Input Box Description

Global Parameters This section displays the values you have assigned on the
Configure Maintenance Tasks Setup tab as well as the tasks
available for application.

Configuration Options

Apply Configured Mtc Tasks This option allows you to apply maintenance task setups to all
discovered nodes, to specific nodes, or to specific server types
only.

Select Option This option saves the current maintenance task setup for all
discovered nodes to the EMS server without attempting to apply
the changes. In addition, when you return to the Maintenance
Task Setup page and click the Reset Configured Option button,
the Apply Configured Mtc Tasks to all discovered nodes is
selected automatically.

Apply Only This option saves the current maintenance task setup to the
EMS server without attempting to apply the changes to the local
servers.

Configure Now This option attempts to apply the current maintenance task
setups to the servers or server types you specify.

Reset List This option returns the maintenance task setup to the state you
saved to the EMS server.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 381
 Input Box Description

Reset Configured Option This option returns to the area where you most recently saved
the configuration to the EMS server. This option is useful when
you return to the Maintenance Task Setup properties page, and
want to identify the maintenance task configuration that was
already saved to the EMS server.

To apply a maintenance task:

1) Log in to the EMS Java client.
2) From the Administration Tools menu, click Mtc Task Setup. The Mtc Task Setup page appears.
3) Click the type of configuration to apply.
4) To apply configured maintenance tasks to all discovered nodes on the EMS network, click Select
Option to select the current option, click Configure Now to apply the maintenance tasks immediately,
or click Reset Configured Option to return to the configured defaults.
5) To apply configured maintenance tasks to specific server types on the EMS network, click the server
types and click Apply Only - Server Type to update the configuration or click Configure Now - Server
Type to apply the maintenance tasks immediately.
6) To apply configured maintenance tasks to specific servers on the EMS network, click the servers and
click Apply Only - Specific Nodes to update the configuration or click Configure Now - Specific
Nodes to apply the maintenance tasks immediately.

10.3 Managing Audible Alarms

Use the Audible Alarm Management page to upload an audio file to use as an audible alarm.

Figure 188: Audible Alarm Management

Configure the java.policy to upload a sound file:

1) Add the following entries in your java.policy located under <JAVA_JRE_HOME>/lib/security:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 382
 • permission java.util.PropertyPermission "user.home", "read";
• permission java.io.FilePermission "<USER_HOME>", "read";
• permission java.io.FilePermission "<USER_HOME>\\*", "read";
2) Close and restart the EMS Java client.

To upload a sound file to use as an audible alarm:

1) Place the audio file under the <USER_HOME> directory.
2) Log in to the EMS Java client.
3) From the Administration Tools menu, click Audible Alarm Management. The Audible Alarm
Management page appears.
4) Click Browse to locate the .WAV file.
5) Click Upload. The file uploads. When the file is uploaded, it appears on the Audio Files on Server list.
6) To play the file, click Play.
7) To refresh the list of audio files, click Refresh.
8) To delete a file, click Delete.
9) Close and restart the EMS Java client. The audio file is available to use as an audible alarm.
Tasks to perform from this page

10.3.1 Configure Filters for Audible Alarms

Use the Configure Filters tab to configure filters for audible alarms.

Figure 189: Audible Alarm Management - Configure Filters

The information on this page includes the following:

Column Description

Filter Name This column displays the name of the filter.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 383
 Column Description

Status This column displays the status of the filter.

Audio File This column displays the audio file associated with the filter.

Play Once This column indicates whether the alarm plays once for this
filter.

Severity This column displays the alarm severity associated with the
filter.

Source This column displays the alarm source associated with the filter.

Alarm Name This column displays the alarm name associated with the filter.

Users This column displays the users associated with the filter.

All Users This column indicates whether all users are associated with the
filter.

To configure a filter for an audible alarm:

1) Log in to the EMS Java client.
2) From the Administration Tools menu, click Audible Alarm Management. The Audible Alarm
Management page appears.
3) Click the Configure Filters tab.
4) Click Add. The Audible Alarm Filter Details page appears.
5) In the Filter Name input box, enter the name of the filter.
6) Select the Audio File from the drop-down list.
7) Click Play Once, if you want the audio file to play only once when it is activated.
8) Select the Severity from the drop-down list if you want to associate the severity of an alarm with this
filter.
9) Enter the source in the Source input box if you want to associate the source of an alarm with this filter.
10)Enter the alarm name in the Alarm Name input box if you want to associate the alarm name with this
filter.
11)Select Enabled from the drop-down list if you want to enable this filter.
12)Specify the users to associate with this filter:
• Check specific users, or
• Click All users
13)Click Apply to save this filter or click Cancel to return to the previous page.
To update a filter for an audible alarm:
1) Log in to the EMS Java client.
2) From the Administration Tools menu, click Audible Alarm Management. The Audible Alarm
Management page appears.
3) Click the Configure Filters tab.
4) Click Update. The Audible Alarm Filter Details page appears.
5) Modify the input boxes as required.
6) Click Apply to save this filter or click Cancel to return to the previous page.
To delete a filter for an audible alarm:
1) Log in to the EMS Java client.
2) From the Administration Tools menu, click Audible Alarm Management. The Audible Alarm
Management page appears.
3) Click the Configure Filters tab.
4) Select the alarm to delete.
5) Click Delete. The filter is removed from the list.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 384
 6) Click Apply to save this filter or click Cancel to return to the previous page.

10.4 Managing Service Packs

This feature provides functionality similar to the Service Pack Migration tool available from an Application
Server but for a system-wide capability. The tool allows service pack addition and deletion across multiple
Application Server clusters active on a single BroadWorks system. This tool is delivered on the EMS to
provide a central point for execution.

NOTE: The term "service pack" refers to packages of Call Processing services that can be provisioned to
a BroadWorks user.

Use this section to manage the following Application Server features:

• Service Pack Migration
• Service Pack Management
The service pack migration tool controls the automated batch process, which migrates users from one set
of services or service packs to another. The Service Pack Management tool allows modification of the
services in an existing service pack.
The following figure shows three Application Server clusters managed by a common EMS.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 385
 Figure 190: Application Server Clusters with EMS

The EMS uses the Open Client Interface-Provisioning (OCI-P) commands available for the service pack
migration tool of the Application Server to manage service pack migration tasks.
Since some OCI-P commands used by this feature have changed between releases, the functionality may
differ slightly depending on the selected Application Server clusters, the BroadWorks release, and the
BroadWorks patch level. In all cases, the EMS does not present the Application Servers that do not offer
the necessary OCI-P commands. In addition, they are not accepted when input files are used.
For more information

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 386
10.4.1 About Service Pack Migration
Service Pack Migration
This functionality extends the tool offered by the Application Server to the EMS and provides a centralized
and system-wide service pack migration capability. The feature allows the list of current migration tasks
configured using the EMS to be filtered by status or by Application Server cluster. The list is stored in the
EMS database and is updated by the monitoring process when service pack migration tasks are running.
Completed migration tasks can be cleared from the list by the user when they are no longer needed. A
task on the list can be copied to ease the task of creating data for a migration when the new task is similar
to the copied task on the list.
The EMS Service Pack Migration feature offers centralized and system-wide service pack migration
capability. It offers the same configuration options as the Application Server service pack migration tool.
In addition, the EMS provides the list of Application Server clusters and service providers on which to
schedule the migration tasks.
When a task is created and saved in the database, the EMS waits for the task's scheduled start time
to create the task on the Application Server clusters. This allows task configuration options and the list
of Application Server clusters to be modified until seconds before the task's start time. All service pack
migration task configuration options are available for modification until the migration task is started.
The EMS service pack migration tool schedules the tasks on Application Server clusters using the local
time of each server. The EMS obtains the server's local time and adjusts the monitoring process so that
the task starts at the same time on all clusters.
Migration tasks scheduled to run in the future can be modified. All configuration options for the service
pack migration task can be modified until the migration task has been started. Once the task is processing,
the EMS starts a monitoring process using the Open Client Interface (OCI) to request the migration task
information on each Application Server cluster for each service provider selected for migration. The EMS
parses the information received from the Application Servers and updates the database so that the latest
service pack migration information is available to the user.
The EMS service pack migration tool schedules the tasks on each Application Server cluster using the
local time of each server. When the Application Servers are not located in the same time zone, the
migration task does not start at the same time for all the Application Server clusters. The EMS identifies
the local time of each Application Server and adjusts the monitoring process to start at the same time as
each task. When the first service pack migration task starts, the EMS task status is processing and the
status remains as such until the last service pack migration task completes.
Service Pack Migration States
A migration task moves through a number of states as it executes. The status of a task provides
information about its progression.
Status Description

Awaiting Edits The task was copied from another task and is waiting to be
edited before being scheduled.

Pending The task is scheduled to start at a later time.

Processing The task is running.

Terminating A user canceled the task waiting.

Terminated A user canceled the task.

Terminated with Errors A user stopped the task but the EMS encountered problems
while requesting termination from the Application Servers.

Stopped By System The task was taking too long to complete or had too many
errors. Maximum allowed time and errors are defined when a
task is configured.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 387
 Status Description

Completed The task has run and has finished migrating all selected groups
and users. Note that a completed task can have errors but did
not have enough errors to abort.

The following figure shows the states of a migration task.

Figure 191: States of Migration Task

A task with the status Stopped By System was stopped for one of two reasons:
• The execution time exceeded the time configured for the task. In this case, all work is stopped on each
service provider and Application Server cluster.
• The number of errors exceeded the maximum number of errors allowed for each service provider
configured for this task. In this case, the task stops partially, that is, it stops only for the service provider
that generated too many errors, and continues running for every other service provider and Application
Server cluster. For a detailed view of the task information and to determine which Application Server
cluster and service provider completed and which Application Server cluster and service provider
stopped, refer to the service pack migration task report.
Service Pack Migration Monitoring
Once a service pack migration task configured on the EMS has started, a background thread polls each
Application Server cluster and all the service providers selected for the task at one-minute intervals. This
information is stored in the EMS database and is reflected on the service pack migration task list, on the
task status page, and in the task report. When the monitoring process detects that all Application Server
service pack migration tasks have been completed, stopped, or terminated, it stops monitoring the tasks,
and sends the results report by e-mail if an e-mail address was specified in the task configuration.

10.4.2 Perform Service Pack Migration

The Service Pack Migration feature provides centralized and system-wide service pack migration
capability. It allows service pack migration and management across multiple Application Server clusters
from a single point.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 388
 Use the Service Pack Migration page to perform a service pack migration.

Figure 192: Service Pack Migration

The information on this page includes the following:

Column Description

Description This column specifies the service pack migration task.

Scheduled Start Date This column specifies the day the task begins.

Scheduled Start Time This column specifies the time of day the task begins.

Status This column specifies the status of the service pack migration.

To access service pack migration:

1) Click the Centralized Networking tab.
2) Click the Centralized Services submenu.
3) From the Application Server submenu, click Service Pack Migration. The Service Pack Migration page
appears.
4) To filter the tasks by Application Server cluster, select the cluster you want from the drop-down list.
To filter the tasks by status, select the desired status from the Status drop-down list.
Each listed task is described by the following attributes:
• Description: This is the descriptive name you gave to the task at creation.
• Scheduled Start Date: This is the date on which the task is scheduled to run.
• Scheduled Start Time: This is the time when the task is scheduled to run.
• Status: The status provides information about the progress of the task execution. The possible
status for tasks is as follows:
Status Description

Awaiting Edits The task was copied from another task and is waiting to be
edited before being scheduled.

Pending The task is scheduled to start at a later time.

Processing The task is currently running.

Terminating A user's canceled task is waiting to terminate.

Terminated The task was stopped by a user.

Terminated with Errors The task was stopped by a user but the EMS encountered
problems while requesting termination of tasks from the
Application Servers.

Stopped By System The task was taking too long to complete or had too many
errors. Maximum allowed time and errors are defined in
task configuration.

Completed The task has finished migrating all selected groups and
users. It may have had errors, but not enough to abort.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 389
 Status Description

Expired The task has expired.

To perform a service pack migration task:

1) Click the Centralized Networking tab.
2) From the Centralized Services submenu, click Application Server. The Application Server page
appears.
3) Click Service Pack Migration. The Service Pack Migration page appears.
To report on a service pack migration task:
After a service pack migration task has started, a report file is generated and updated while the task is
processing. The report is stored in directory public_html/webclient/ctrsvc/reports and it can be e-mailed
when the task finishes if an e-mail address was provided when the task was created. The report is a text
file and it is formatted so that it is easily parsed. It contains the following information:
• Task description
• Scheduled Start date (MM/DD/YYYY)
• Scheduled Start time
• Expire after (hours)
• Execution time
• Maximum allowed duration
• Maximum allowed errors
• Results e-mail
• Reporting option
• Service quantity option
• Users selection option
• Users selection services
• Users selection service packs
• Services to remove
• Service packs to remove
• Services to assign
• Service packs to assign
• Task status
• Error counts
• Count of Application Server clusters modified successfully and the number of Application Server
clusters for which all service providers were migrated successfully
• Count of Application Server clusters modified unsuccessfully and the number of Application Server
clusters for which at least one service provider was not migrated successfully
• Count of service providers modified successfully and the number of service providers for which all
groups were migrated successfully
• Count of service providers modified unsuccessfully and the number of service providers for which at
least one group was not migrated successfully
• Count of groups modified successfully and the number of groups for which all users were migrated
successfully
• Count of groups modified unsuccessfully and the number of groups for which at least one user was not
migrated successfully
• Application Server cluster sub-report
• Service provider sub-report
• Group sub-report
To copy a service pack migration task:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 390
 Migration tasks can be copied to create new tasks when they are similar to previous tasks, thus easing the
task creation process.
Use the Copy Migration Task button to create a copy of the selected task or tasks. A copied task
description is initialized to "Copy of <task description>", the task status is Awaiting Edits, and it has no
scheduled date or time. All other task options are the same as those of the original task: Application
Server clusters, service providers, groups, user selection, services to remove, and services to assign.
Once a copy of a task is created, you can modify it as needed.
1) On the Service Pack Migration page, select the task or tasks you want to copy by clicking the check box
to the left of each task to copy.
2) Click Copy Migration Task. Copies of the selected tasks are created and appear on the list with the
status Awaiting Edits.
To delete a service pack migration task:
1) On the Service Pack Migration page, select the task or tasks you want to delete by clicking the check
box to the left of each task to delete.
2) Click Delete Migration Task. The selected tasks are deleted and removed from the list of tasks.
Deletion requests are sent to the Application Servers via Open Client Interface-Provisioning (OCI-P) in
a separate thread and errors are reported in the Fault Management module. When the EMS is unable
to communicate with the Application Server via Open Client Interface (OCI) to delete a service pack
migration task, the EMS generates an event to report the issue.
Tasks to perform from this page:

10.4.2.1 Add Service Pack Migration Task

The service pack migration task creation consists of the following steps, each performed on a separate
page and leading to the next in this order:
1) Configure schedule options
2) Select Application Server clusters
3) Select service providers
4) Select groups
5) Select users
6) Remove user services or service packs
7) Assign user services or service packs
Use the Add Service Pack Migration Task page to create a new migration task.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 391
 Figure 193: Add Service Pack Migration Task

The information on this page includes the following:

Input Box Description

Description This text box specifies the descriptive name for the service pack
migration task.

Schedule Start Date This text box specifies the date and time the service pack
migration task is scheduled to run on each Application Server
cluster.

Results E-mail This text box specifies the e-mail address to notify when the task
is complete (optional).

Expire after (hours) This text box specifies the period of time before a service
pack migration task expires (if it has not started). When a task
reaches its expiration time, it expires if it is still waiting to be
started. If it has been processed or if it has started processing, it
does not expire.

Automatically stop after (hours) This input box specifies the period of time allowed for the
execution of the service migration task. This input box is
intended to prevent service migration tasks from extending
beyond a scheduled maintenance window.

Maximum Errors (per Service Provider) This input box specifies the number of errors permitted for each
service provider before a service migration task terminates
(optional).

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 392
 Input Box Description

Reporting Options Either Report all users in the migrated groups to report on all
users in the group included in the service migration task or
Report only users matching the selection criteria to report on all
users affected by the service migration task (this is the default).

Service Quantity Options Either Automatically increase the allocations to migrated groups
as needed to increase the service quantities of related services
or Terminate the migration for any group with the Service
Quantity Violations to prohibit service pack migration for groups
with inadequate service quantities (this is the default).

To add a service pack migration task:

1) On the Service Pack Migration page, click Add Migration Task. The Add Service Pack Migration Task
page appears.
2) In the Schedule section, type information in the input boxes as required.
3) To save your data and go to the next step, click Next. The Clusters Selection page appears.

NOTE: At any time, you can click Apply to save the changes you made up to this point or click Reset to
clear the selection made on the page.

Tasks to perform from this page:

10.4.2.1.1 Clusters Selection
Use the Clusters Selection page to select the clusters for the service pack migration task.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 393
 Figure 194: Clusters Selection

1) On the Clusters Selection page, select the Application Server clusters where you want to perform
service pack migration.
• For the Mode option, check the mode List to select the Application Server clusters from the provided
list or check File to use an input file containing a list of Application Server clusters.
• If you checked List, select the Application Server clusters from the displayed list or to check all the
Application Server clusters, check the box in the Application Server Clusters title row.
• If you checked File, use the Browse button to find the file. The file must have the following
eXtensible Markup Language (XML) format:
<ServicePackMigration>
<ApplicationServer hostname="mtlas04.mtl.broadsoft.com" />

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 394
 <ApplicationServer hostname="mtl64lin01.mtl.broadsoft.com" />
<ApplicationServer hostname="mtlsoldev2.mtl.broadsoft.com" />
</ServicePackMigration>
When the file format or content is invalid, a message is shown that describes the error that appears
when the Apply or Next button is clicked and the operation is canceled.
Only Application Server clusters managed by the EMS with the supported BroadWorks release or patch
level can be selected.
2) Optionally, to save the selected Application Server clusters in a file for later use, click Generate File.
The file is saved locally and can be reused as an input file for another service pack migration task.
This button is only enabled when at least one Application Server cluster is selected. When selecting
all Application Server clusters, the clusters added to the EMS network after this step are not included.
Similarly, the clusters deleted after this step are not removed from the task and are still monitored by
the EMS for service pack migration status.
3) To save your data and go to the next step, click Next. At any time, you can click Apply to save the
changes you made up to this point or click Reset to clear the information entered on the page.
10.4.2.1.2 Service Providers/Enterprises
Use the Service Providers/Enterprises page to select the service providers on which to perform service
pack migration.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 395
 Figure 195: Service Providers/Enterprises

1) On the Service Providers/Enterprises page, select the service providers for which you want to perform
service pack migration.
• For the Mode option, to select all service providers, check Migrate All; to select service providers
from the list, check Search; to use an input file containing a list of service providers, check File.
• If you checked Search, use the search tool to display a list of service providers, and select the
service providers you want from the provided list.
The search tool provides two criteria: organization ID and name with options Starts With, Contains
and Equals To. The search is executed only on the previously selected Application Server clusters.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 396
 If the EMS is unable to communicate with an Application Server to retrieve the service providers, the
EMS displays a warning on the Service Provider Selection form and generates an event.
• If you checked File, use the Browse button to find the file. The file must have the following
eXtensible Markup Language (XML) format:
<ServicePackMigration>
<ApplicationServer hostname="mtlas04.mtl.broadsoft.com">
<Organization ID="BroadSoft"/>
<Organization ID="Dorval"/>
</ApplicationServer>
<ApplicationServer hostname="mtl64lin01.mtl.broadsoft.com">
<Organization ID="Montreal"/>
<Organization ID="Quebec"/>
</ApplicationServer>
<ApplicationServer hostname="mtlsoldev2.mtl.broadsoft.com">
<Organization ID="St-Laurent"/>
<Organization ID="Laval"/>
</ApplicationServer>
</ServicePackMigration>
If the file format or content is invalid, a message is shown that describes the error that appears when
the Apply or Next button is clicked and the operation is canceled.
2) Optionally, to save the selected service providers in a file for later use, click Generate File. The file is
saved locally and can be reused as an input file for another service pack migration task. This button is
only enabled when at least one Application Server cluster is selected.
3) To save your data and go to the next step, click Next. At any time, you can click Apply to save the
changes you made up to this point or click Reset to clear the information entered on the page.
10.4.2.1.3 Select Groups
Use the Groups page to select the user groups on which to perform the service pack migration.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 397
 Figure 196: Groups

1) On the Groups page, select the groups for which you want to perform service pack migration.
• For the Mode option, to select all groups, check Migrate All; to select groups from the list, check
Search; to use an input file containing a list of groups, check File.
• If you checked Search, use the search tool to display a list of service providers, and select the
service providers you want from the provided list.
The search tool provides two criteria: organization ID and name with options Starts With, Contains,
and Equals To. The search is executed only on the previously selected Application Server clusters.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 398
 The search tool allows a maximum of two criteria that are based on the group ID or name with
the options Starts With, Contains, and Equals To. The search is executed only on the previously
selected service providers.
If the EMS is unable to communicate with an Application Server via the Open Client Interface (OCI)
to retrieve the user groups, the EMS reports a warning on the Group Selection form and generates
an event to report the issue.
• If you checked File, use the Browse button to find the file. The file must have the following
eXtensible Markup Language (XML) format:
ServicePackMigration>
<ApplicationServer hostname="mtlas04.mtl.broadsoft.com">
<Organization ID="BroadSoft">
<Group ID="Platform" name="Platform">
<Group ID="SystemTest" name="System Test">
</Organization>
<Organization ID="Dorval">
<Group ID="Dev" name="Development">
</Organization>
</ApplicationServer>
<ApplicationServer hostname="mtl64lin01.mtl.broadsoft.com">
<Organization ID="Montreal">
<Group ID="Engineering" name="Engineering">
</Organization>
<Organization ID="Quebec">
</Organization>
</ApplicationServer>
<ApplicationServer hostname="mtlsoldev2.mtl.broadsoft.com">
<Organization ID="St-Laurent">
<Group ID="Interns" name="Interns">
</Organization>
<Organization ID="Laval">
</Organization>
</ApplicationServer>
</ServicePackMigration>
If the file format or content is invalid, a message is shown that describes the error that appears when
the Apply or Next button is clicked and the operation is canceled.
2) Optionally, to save the selected groups in a file for later use, click Generate File. The file is saved
locally and can be reused as an input file for another service pack migration task. This button is only
enabled when at least one Application Server cluster is selected.
3) To save your data and go to the next step, click Next. At any time, you can click Apply to save the
changes you made up to this point or click Reset to clear the information entered on the page.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 399
10.4.2.1.4 Select Users
Use the User Selection page to select the users to perform the service pack migration.

Figure 197: User Selection

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 400
 1) On the User Selection page, select the type of users to migrate. Choose from the following options:
• Migrate users who have all of the specified services and service packs.
• Migrate users who have any of the specified services and service packs.
• Migrate users who have none of the specified services and service packs.
The search tool provides two criteria: organization ID and name with options Starts With, Contains,
and Equals To. The search is executed only on the previously selected Application Server clusters.
2) From the provided lists of services and service packs, select those for which you want the above
selected criterion to apply. Only authorized services for the previously selected service providers are
listed. Service packs with the same name and service list but different service providers are shown as
one service pack. Others are listed separately. The list of user services may include services that are
not authorized for some of the selected service providers but may be useful for user selection. When
no service or service pack is selected, all users are included in the migration.
3) To save your data and go to the next step, click Next. At any time, you can click Apply to save the
changes you made up to this point or click Reset to clear the information entered on the page.
10.4.2.1.5 Remove Service Packs and User Services
Use the Service Packs and User Services to Remove page to select the services and service packs to "un-
assign". They are replaced with the services and service packs specified in the next step. The service
packs and user services offered for removal by the EMS are the authorized services that are common to all
the service providers selected earlier.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 401
 Figure 198: Service Packs and User Services to Remove

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 402
 1) On the Service Packs and User Services to Remove page, check the services and service packs you
want to "un-assign". To "un-assign" all service packs, check the Service Packs check box. To "un-
assign" all user services check the User Services check box.
2) To save your data and go to the next step, click Next. At any time, you can click Apply to save the
changes you made up to this point or click Reset to clear the information entered on the page.
10.4.2.1.6 Assign User Services and Service Packs
Use the Service Packs and User Services to Assign page to select the services and service packs to
assign. The listed service packs and user services are the authorized services that are common to all the
service providers selected earlier.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 403
 Figure 199: Service Packs and User Services to Assign

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 404
 1) On the Service Packs and User Services to Assign page, check the services and service packs you
want to assign. To assign all service packs, check the Service Packs check box. To assign all user
services, check the User Services check box.
2) To save your data and go to the next step, click Next. At any time, you can click Apply to save the
changes you made up to this point or click Reset to clear the information entered on the page.
After all the information is provided for the service pack migration task, the task is stored in the EMS
database. The EMS then schedules the monitoring process, which creates the task on selected
Application Server clusters for the selected service providers, and then starts polling those Application
Server clusters.
If the EMS is unable to communicate with an Application Server to create a service pack migration task
or if the migration task is scheduled before the local date and time of an Application Server, the EMS
generates an event to report the issue.

10.4.2.2 Modify Service Pack Migration Task

All service pack migration task configuration options can be modified until the migration task is started. Use
the Modify Service Pack Migration Task page to modify a migration task. The status of the task must be
Pending or Awaiting Edits. The input boxes are divided into seven categories accessible using the tabs at
the top of the modification page.

Figure 200: Modify Service Pack Migration Task

The information on this page includes the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 405
 Input Box Description

Description This text box species the descriptive name for the service pack
migration task.

Start Date This input box species the date for which the service pack
migration task is scheduled to run on each Application Server
cluster.

Start Time This input box species the time of day the service pack
migration task is scheduled to run on each Application Server
cluster.

Results E-mail This text box species the e-mail address to notify when the task
is complete (optional).

Allowed Time (hours) This input box species the period of time allowed for the
execution of the service migration task. This input box is
intended to prevent service migration tasks from extending
beyond a scheduled maintenance window.

Maximum Errors This input box species the number of errors permitted for each
service provider before a service migration task terminates
(optional).

Reporting Options Either Report all users in the migrated groups to report on all
users in the group included in the service migration task or
Report only users matching the selection criteria to report on all
users affected by the service migration task (default).

Service Quantity Options Either Automatically increase the allocations to migrated groups
as needed to increase the service quantities of related services
or Terminate the migration for any group with the Service
Quantity violations to prohibit service pack migration for groups
with inadequate service quantities (default).

To modify a service pack migration task:

1) On the Service Pack Migration page, click the Description link of the task you want to modify (the task
status must be Pending or Awaiting Edits. The Modify Service Pack Migration Task page appears.
2) Modify the input boxes as required. For information on these input boxes, seeAdd Service Pack
Migration Task on page 391.
3) Click Apply. The task is updated and stored in the database. The service pack migration task list is
updated accordingly.

10.4.2.3 Reporting on Service Pack Migration

After a service pack migration task has started, a report file is generated and updated while the task is
processing. The report is stored in the public_html/webclient/ctrsvc/reports directory and it can be e-mailed
when the task finishes if an e-mail address was provided when the task was created. The report is a text
file and it is formatted so that it is easily parsed. It contains the following information:
• Task description
• Start date (MM/DD/YYYY)
• Start time
• Execution time
• Maximum allowed duration
• Maximum allowed errors
• Results e-mail
• Reporting option
• Service quantity option
• Users selection option
• Users selection services
• Users selection service packs

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 406
 • Services to remove
• Service packs to remove
• Services to assign
• Service packs to assign
• Task status error counts
• Count of Application Server clusters modified successfully and the number of Application Server
clusters for which all service providers were migrated successfully
• Count of Application Server clusters modified unsuccessfully and the number of Application Server
clusters for which at least one service provider was not migrated successfully
• Count of service providers modified successfully and the number of service providers for which all
groups were migrated successfully
• Count of service providers modified unsuccessfully and the number of service providers for which at
least one group was not migrated successfully
• Count of groups modified successfully and the number of groups for which all users were migrated
successfully
• Count of groups modified unsuccessfully and the number of groups for which at least one user was not
migrated successfully
• Application Server cluster sub-report
• Service provider sub-report
• Group sub-report
Following is an example of the report file and e-mail format:

Service Pack Migration Task Report

Migration Task Description: Test Task
Start Date: 08/21/2008
Start Time: 01:38 AM
Execution time: 45 minutes
Maximum Allowed Duration: 1 hours
Allowed errors: Unlimited
Results E-Mail: pablo@broadsoft.com
Reporting option: Report all users in the migrated groups
Service quantity option: Automatically increase
Users selection option: Any services
Users selection services: Call Forwarding Always, Call …
Users selection service packs:
Services to remove:
Service packs to remove:
Services to assign:
Service packs to assign: Call Forward Pack

Status: Completed
Errors: 0
AS Clusters Modified Successfully: 1
AS Clusters Modified Unsuccessfully: 1
Service Provider Modified Successfully: 1
Service Provider Modified Unsuccessfully: 1
Groups Modified Successfully: 3
Groups Modified Unsuccessfully: 1

AS Cluster: mtl64lin01.mtl.broadsoft.com
Service Provider: sp1

Migration of group Platform:

21/07/2008 10:13:00:095 : Platform : jfdignard : Did not match selection
criteria

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 407
 21/07/2008 10:13:00:165 : Platform : mgoupil : Migrated successfully
Migration of group Engineering:
21/07/2008 10:15:11:324 : Engineering : eross : Migrated successfully

AS Cluster: mtlsoldev1.mtl.broadsoft.com
Service Provider: sp2

Migration of group Montreal:

21/07/2008 10:13:00:065 : Platform : mjones : Migrated successfully
21/07/2008 10:13:00:095 : Platform : jsmith : System-level feature license
violation

10.4.2.4 Manage Service Pack Migration Tasks

Use the Service Pack Migration Status page to view the details and progress of a specific task. When the
task is in progress, the page refreshes automatically every minute.
To view the status of a service pack migration task:
1) On the Service Pack Migration page, click the Description link of the task for which you want to see the
status page (the task status must not be Pending or Awaiting Edits). The Service Pack Migration Task
Status page for the selected task appears.
2) To view a service pack migration task report, click the click here for task report link. You are
presented with the report.
To terminate a service pack migration task:
1) On the Service Pack Migration page, click the Description link of the task for which you want to see the
status page (the task status must not be Pending or Awaiting Edits). The Service Pack Migration Task
Status page for the selected task appears.
2) Click Terminate.
3) When prompted, confirm your action.
After you have confirmed the action, the EMS sends the terminate request to all the Application
Server clusters of the service pack migration task and sets the task status to "Terminating" until all the
subtasks are terminated.

NOTE: A task that has been stopped cannot be resumed but can be copied and rescheduled.

If the EMS is unable to communicate with an Application Server via the Open Client Interface (OCI) to
terminate a service pack migration task, the task state is set to "Terminated with Errors" and the EMS
generates an event.

10.4.2.5 Manage Service Packs

The Service Pack Management tool extends the capability offered by the Application Server to the EMS for
a centralized and system-wide service pack management capability. This tool is most useful on systems
where service packs are the same across all Application Server clusters. When service packs have the
same name and content, the service pack management allows their modification in one operation.
When you specify the Application Server clusters and the service providers to add or modify a service
pack, the EMS fetches the list of defined service packs and correlates their names and services to find
identical service packs. Identical service packs are listed as one service pack and service packs with
different names or services are listed separately.
The list of user services that can be assigned to a service pack is limited by the service providers'
authorized services. Only user services common to all selected service providers are available in the EMS
Service Pack Management tool.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 408
 When a service pack is modified using the EMS Service Pack Management tool, the service pack is
renamed and the new service pack is created on all the selected Application Server clusters and service
providers that had this original service pack. The EMS creates a service pack migration task that migrates
users for all service providers and on all Application Server clusters that had the original service pack, to
the new service pack. This task must be edited before it can be scheduled.
Use the Service Pack Management page to manage service packs.

Figure 201: Add Service Pack Migration Task

To add/remove a service from a service pack:

1) Click the Centralized Networking tab.
2) From the Application Server submenu, click Service Pack Management. The Service Pack
Management page appears.
3) Select the Application Server clusters on which the service pack is located. Check the check boxes
next to the Application Server clusters you want or to select all the clusters, check the check box next to
the AS Clusters list name.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 409
 4) Click Next. The Service Pack Management – Service Providers/Enterprises page appears.
Figure 202: Service Pack Management – Service Providers/Enterprises

This page is a list page that allows you to search several different ways. The search tool provides two
criteria: Organization ID and Name with options Starts With, Contains, and Equals To.
5) Select the service providers who have the service pack you want. Use the Search tool to display the
service providers. From the list, select the service providers you want or to select all service providers,
check the box in the title row.
6) Click Next. The Service Pack Management – Service Packs page appears displaying the list of
available service packs for the selected Application Server clusters and service providers.
Figure 203: Service Pack Management – Service Packs

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 410
 7) If you want to rename a service pack (optional), click the Rename link and enter the new name for the
service pack.

NOTE: Since the modified service pack must have a different name from the original name, renaming
the original service pack allows you to keep the old name for the modified service pack.

8) To select the service pack you want to modify, click its name. The Service Pack Modification page
appears listing the available services on the left and the services already in the service pack on the
right.

NOTE: The Add Service Pack button navigates you to the Service Packs Add page for additional input
required to create a new service pack. For information, see section Add Service Pack Migration Task
on page 391.
If the EMS is unable to communicate with the Application Server via Open Client Interface-Provisioning
(OCI-P) to fetch the service packs, the EMS displays a warning message and generates an event to
report the issue.
Figure 204: Service Pack Management - Service Packs

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 411
 9) In the New Service Pack Name text box, enter the name of the modified pack.
10)From the list of Available Services, select the service you want to add by clicking its name and then
click Add>.
To select several entries in sequential order, click the first entry, hold down the SHIFT key, and click
the last entry. To select several entries, but not in a particular order, click the entries you want while
holding down the CTRL key.
11)From the list of Services in Pack, select the services you want to remove and then click Remove.
To select several entries in sequential order, click the first entry, hold down the SHIFT key, and click
the last entry. To select several entries, but not in a particular order, click the entries you want while
holding down the CTRL key.
12)Click Done. The Confirmation page appears with the summary of service pack modifications.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 412
 Figure 205: Service Pack Management – Confirmation
13)To complete the service pack modification and schedule the migration task, click Schedule Migration
Task.
The EMS renames the selected service pack and creates a new service pack on every selected cluster
and for every service provider that has the service pack with the same name. A new service pack
migration task is created, which enables the administrator to migrate all users who have the original
service pack to the new service pack. This migration task has the status Awaiting Edits and must be
scheduled.

NOTE: Service packs with the same names across multiple service providers and Application Server
clusters should have the same user services.

If the EMS is unable to communicate with the Application Server to fetch the service pack user service
list, the EMS generates an event to report the issue.
Tasks to perform from this page:
10.4.2.5.1 Create New Service Pack
The Service Packs Add page allows you to create a service pack on the selected Application Server
clusters and for the selected service providers. This page offers a basic service pack configuration
capability including the name and description of the service pack. Options are also available to activate or
deactivate the service pack and to specify the number of times this service pack may be assigned. A list
of available services allows you to choose the user services to include in the service pack. Only the user
services authorized for all selected service providers are listed.
Use the Service Pack Management page to perform a service pack migration.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 413
 Figure 206: Add Service Pack Migration Task

To add a service pack:

1) Click the Centralized Networking tab.
2) From the Application Server submenu, click Service Pack Management. The Service Pack
Management - Clusters page appears.
3) Select the Application Server clusters on which the service pack is to be created. Check the check
boxes next to the Application Server clusters you want or to select all the clusters, check the box next to
the AS Clusters list name
4) Click Next. The Service Pack Management – Service Providers/Enterprises page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 414
 Figure 207: Service Pack Management - Service Providers/Enterprises

This page is a list page that allows you to search several different ways. The search tool provides two
criteria: Organization ID and Name with options Starts With, Contains, and Equals To.
5) Select the service providers who have the service pack you want.
• Use the Search tool to display the service providers.
• From the list, select the service providers you want or to select all service providers, check the box in
the title row.
6) Click Next. The Service Pack Management – Service Packs page appears displaying the list of
available service packs for the selected Application Server clusters and service providers.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 415
 Figure 208: Service Packs
7) Click Add Service Pack. The Service Pack Management – Service Packs Add page appears.
Figure 209: Service Providers/Enterprises

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 416
 8) Enter the name and the description of the new service pack.
9) To make the service pack active, check the Available for Use box.
10)To restrict the number of times this service pack can be assigned, select Limited To and enter the
maximum number of times this service pack may be assigned. Alternatively, to allow an unlimited
number of assignments, select Unlimited.
11)To add a service to the service pack, from the Available Services list, select the service you want by
clicking its name and then click Add>.
To select several entries in sequential order, click the first entry, hold down the SHIFT key, and click
the last entry. To select several entries, but not in a particular order, click the entries you want while
holding down the CTRL key.
12)Click OK. The service pack creation task is launched on the selected Application Server clusters and
service providers.
If the EMS is unable to communicate with an Application Server via the Open Client Interface (OCI) to
create the service pack, the EMS generates an event to report the issue.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 417
11 Managing Software Lifecycle

This section provides information on how to use the software lifecycle management support to facilitate the
management of EMS user accounts and the management of BroadSoft patches.
This section describes the following:
• Modifying EMS User Account on page 418
• Using EMS Patch Support Center on page 424
• Managing Patches for Node on page 429

11.1 Modifying EMS User Account

Use the Modify EMS Account page to modify an EMS user account.

Figure 210: Modify EMS Account

The information on this page includes the following:

Input Box Description

EMS Unix User name This text box specifies the name of the EMS user.

Current Password This text box specifies the current password for the user.

New Password This text box specifies the new password for the user.

Re-type New Password This text box confirms the new password for the user.

Telnet Port This text box specifies the Telnet port.

SSH Port This text box specifies the SSH port.

1) Click the Centralized Networking tab and select the Centralized User submenu.
2) Click Modify EMS Account. The Modify EMS Account page appears.
3) In the EMS Unix User name text box, enter the user name. The default is "emsadmin".
4) In the Current Password text box, enter the current password.
5) In the New Password text box, enter the new password.
6) In the Re-type New Password text box, enter the new password again.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 418
 7) In the Telnet Port name text box, enter the number of the Telnet port. The default is "23".
8) In the SSH Port name text box, enter the number of the SSH port. The default is "22".
9) Click Modify to save these changes or Reset to reset the values to the previous settings.

11.2 Using Patch Management

Overview
The EMS Patch Management feature is used to integrate BroadWorks patches available from the
BroadSoft Patch Center. It is also used to help manage your BroadWorks network elements (NEs)
in addition to providing proactive notification on the availability of critical fixes. From the EMS Patch
Management user interface, you are provided with an integrated and centralized view of what is available
on the BroadSoft Patch Center and the patches already installed on different nodes. The EMS Patch
Management feature provides:
• Automated monitoring and downloading of patches from the BroadSoft Patch Center
• Automated notification for new system critical and defective patches
• Centralized view and management of patches in a BroadWorks EMS domain
This feature provides centralized patching management to better integrate BroadWorks patches from the
BroadSoft Patch Center (currently known as Xchange) and the BroadWorks servers at customer sites.
The aim is to allow BroadSoft customers to more easily manage their BroadWorks network elements
(NEs) while providing proactive notification on the availability of critical fixes.
The user interfaces provide Xchange-like views from the EMS. From these integrated and centralized
views, an operator can easily review what is available from the BroadSoft Patch Center and compare
them with the patches already installed on the different nodes. In addition, the Web Client enhancements
provide centralized patching actions such as applying and removing patches against multiple nodes in
simple point-and-click operations.
The following figure highlights how this feature improves patch management by automating and
centralizing patching operations at the EMS.

Figure 211: Patch Management

This feature includes embedded functionality that runs on a regular basis helping to keep the EMS
information synchronized with (a) the BroadSoft Patch Center and (b) the network elements.
BroadSoft Patch Center Audit Cycle
On a daily basis, the EMS uses directory listing commands to review the list of patches available based on
the list of server releases and server types within its management domain. The information retrieved from
the directory listings allows the EMS to gather the initial set of information for every patch while waiting for
the next scheduled download upon which all patch information becomes available. The EMS also retrieves
the list of defective patches from the BroadSoft Patch Center. Defective patches are patches that were
recalled or re-released by BroadSoft due to potential issues. The EMS marks those patches in its database
and takes appropriate actions.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 419
 In addition to the application patches, the EMS also manages the Software Manager version to ensure that
the latest Software Manager version is always downloaded to the EMS.
In a parallel processing and based on the configured schedule, the EMS automatically downloads newly
available patches. It may be daily, weekly, or monthly. By default, a weekly download occurs. The EMS
downloads patches only if they are related to the BroadWorks server types, BroadWorks releases, and
operating system (OS) releases within its management domain.
The BroadWorks releases include all the currently active releases and all the installed releases that are
newer than the currently active release. This approach allows an operator to view and apply patches as
soon as an NE is ready for upgrade to a newer release (since the EMS starts downloading the patches
related to a BroadWorks release as soon as a newer release is installed).
In addition, the EMS schedules all patches related to BroadWorks releases that are older than the currently
active release for removal. For example, if an EMS manages an Application Server (AS) with the following
configuration:
• Installed BroadWorks Releases: 14.sp1, 14.sp2, and 14.sp3
• Active BroadWorks Release: 14.sp2
… then, the EMS behaves as follows:
1) Download patches for Application Server Releases 14.sp2 and 14.sp3.
2) Schedule patches for Application Server Release 14.sp1 for removal, and after 30 days, remove
patches for Application Server Release 14.sp1.
NE Audit Cycle
On a daily basis, the EMS runs an audit cycle to all network elements to review the following information:
• Installed and active BroadWorks versions
• Software Manager version
• List of installed and active patches
In addition, the NE audit task automatically downloads and installs a new Software Manager to all network
elements upon availability of a newer version.
Defective Patches Management
After the list of defective patches is retrieved from the BroadSoft Patch Center, the EMS automatically
removes recalled patches from the EMS Patch Management when the patch is not applied on any Network
Element (NE). In this case, the EMS generates an “Informational” Patch Management event to notify
the operator about the defective patch removal. In case the patch is applied on one or more NEs, a
“Critical” Patch Management event is generated that lists the NEs from which the recalled patch needs
to be removed. A replacement patch might be associated with a recalled patch, in which case, the EMS
automatically downloads it.
The EMS automatically downloads re-released patches and generates an “Informational” event to notify
the operator about the new available patch version. A “Critical” event is generated when the old patch
version is found on NEs. The re-released patch is uploaded to those NEs.
Some new patches might be required to complete a fix from a previous patch. In this case, the EMS
automatically downloads the additional patches and uploads them to the corresponding NEs.
For more information

11.2.1 Create Patch Schedule

Use the BroadSoft Patch Center Schedule page to create schedule for patch downloads.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 420
 Figure 212: BroadSoft Patch Center Schedule

The information on this page includes the following:

Input Box Description

Frequency Type This drop-down list specifies the frequency of downloads.

Frequency Value This drop-down list specifies the day of the month that downloading occurs.

Week Day This drop-down list specifies the day of the week that downloading occurs.

Time of Day This drop-down list specifies the time of day that downloading occurs.

To create download schedule:

1) On the EMS Patch Support Center page, click BroadSoft Patch Center Schedule. The BroadSoft
Patch Center Schedule page appears.
2) From the Frequency Type drop-down list, select Daily, Weekly, or Monthly.
3) For the Frequency Value, select from the following:
• If you have selected "Daily" for the Frequency Type, select the time of day from the Time of Day
drop-down list.
• If you have selected "Weekly" for the Frequency Type, select the day of the week from the Week
Day drop-down list, and then the time of day from the Time of Day drop-down list.
• If you have selected "Monthly" for the Frequency Type, select the day from the Day of the Month
drop-down list, and then the time of day from the Time of Day drop-down list.

NOTE: The drop-down lists for the Frequency Value are configurable depending on the Frequency
Type you select.

4) Click Submit Schedule to save the schedule, click Reset Data to set the values to the previously
saved schedule, or click Download Patches Now to download the patches immediately.

11.2.2 Configure Download Credentials

Use the BroadSoft Patch Center Credentials page to configure the user name and password used by EMS
when communicating with BroadSoft’s Patch Center.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 421
 Figure 213: BroadSoft Patch Center Credentials

The information on this page includes the following:

Input Box Description

Username This text box specifies the name of the user.

Password This text box specifies the password.

BroadSoft Patch Center Site This text box specifies the address of the optional BroadSoft Patch Center.

BroadSoft Patch Center This text box specifies the address of the optional BroadSoft Patch Center Protocol.
Protocol

To configure the BroadSoft Patch Center Credentials:

1) On the EMS Patch Support Center page, click BroadSoft Patch Center Credentials. The BroadSoft
Patch Center Credentials page appears.
2) In the Username text box, type in a user name.
3) In the Password text box, type in a password.
4) To modify the alternate BroadSoft Patch Center site, in the BroadSoft Patch Center Site text box, type
the new address.
5) To modify the alternate BroadSoft Patch Center protocol, in the BroadSoft Patch Center Protocol text
box, type the new protocol.
6) Click Configure to save your changes or click Reset Data to undo the configuration.

11.2.3 Configure Patch Center E-mails

Use the BroadSoft Patch Center Distribution page to configure a list of e-mail recipients to notify of the
availability of a critical patch.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 422
 Figure 214: BroadSoft Patch Center Distribution

To configure the BroadSoft Patch Center e-mail distribution:

1) On the EMS Patch Support Center page, click BroadSoft Patch Center Emails. The Email
Distribution Configuration page appears.
2) In the Email text box, type the e-mail address.
3) Click Add. The e-mail is added to the list of emails.
4) To remove an e-mail from the list of Configured Emails, select the check box in the Delete column in the
row(s) of the e-mail(s) you want to remove.
5) Click Delete Now to remove the e-mails from the Email list. Click Reset Data to undo any changes you
have made to the Email list.

11.2.4 Configure Software Manager Auto Update

Use the SWManager AutoUpdate page to enable or disable the automatic installation of the Software
Manager.

Figure 215: SWManager AutoUpdate

To configure the Software Manager Auto Update:

1) On the EMS Patch Support Center page, click SWManager AutoUpdate. The SWManager
AutoUpdate page appears.
2) From the Install SWManager Automatically drop-down list, select "true" or "false". If you select "true",
the latest versions of Software Manager are automatically downloaded when they become available.
3) Click Configure AutoUpdate to download the latest Software Manager or click Reset Data to undo any
changes you have made.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 423
11.2.5 Using EMS Patch Support Center
Use the EMS Patch Support Center page to manage the Broadsoft patches available for the nodes
currently managed by the EMS.

Figure 216: Patch Support Center

The information on this page includes the list of available patches for the nodes currently managed by the
EMS:
Column Description

Title This column displays the title of the patch (or patch bundle).

Description This column displays the description of the patch (or patch bundle). In the case where the patch is
not yet downloaded from Broadsoft Patch Center, "NE_GENERATED" is displayed..

Sys Crt This column specifies whether the patch (or patch bundle) impact is critical to the system . The value
"N" represents "No" and the value "Y" represents "Yes".

AS WS This column specifies whether the patch (or patch bundle) affects the Application Server or Web
Server. The value "N" represents "No" and the value "Y" represents "Yes".

Int Aff This column specifies whether the patch (or patch bundle) affects the interface. The value "N"
represents "No" and the value "Y" represents "Yes".

Rst Req This column specifies whether the patch (or patch bundle) requires a restart. The value "N"
represents "No" and the value "Y" represents "Yes".

DB Aff This column specifies whether the patch (or patch bundle) affects the database. The value "N"
represents "No" and the value "Y" represents "Yes".

Date Closed This column displays the date the patch was created.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 424
 To access the EMS Patch Support Center:
1) Click the Centralized Networking tab and select the Patch Management submenu.
2) Click Patch Support Center . The EMS Patch Support Center page appears.
To display patches:
1) On the EMS Patch Support Center page, select the type of servers related to patches from the drop-
down list:
• "All Servers": This value displays patches associated with all servers.
• "cds": This value displays patches associated with the Call Detail Server.
• "ms": This value displays patches associated with the Media Server.
• "PLATFORM": This value displays patches associated with the platform servers (Application Server,
Network Server, and so on).
• "xsp": This value displays patches associated with the Xtended Services Platform.
2) Select the releases related to patches from the drop-down list. The requested patches appear.
To delete a patch:
1) On the EMS Patch Support Center page, select the check box(es) in the row for the patch(es) you
would like to delete.
2) Click Delete Patches…. The selected patch(es) are removed.
Tasks to perform from this page

11.2.5.1 View Patch Details

Use the Patch Properties page to view the details of a patch.

Figure 217: Patch Properties

The information on this page includes the following:

Input Box Description

Title This text box specifies the title of the patch.

Operating System This text box specifies Operating System name.

OS Release This text box specifies the Operating System release.

BroadWorks Server Type This text box specifies the BroadWorks Server type.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 425
 Input Box Description

BroadWorks Version This text box specifies the BroadWorks version.

System Critical This text box appears if the patch is critical.

AS WS Patch Required This text box appears if an Application Server Web Server patch is required.

Interface Affecting This text box appears if the patch affects the interface.

Restart Required This text box specifies whether a restart is required.

Schema Affecting This text box specifies whether the patch affects a schema.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 426
 Input Box Description

EMS Patch Status This text box specifies the EMS patch status:

Patch Status Description

NE_GENERATED This patch status indicates that the patch was

first discovered by the Network Element (NE)
Audit cycle. The patch properties indicate
default values only. Typically, this status
remains until the following two conditions are
met:
1) BroadSoft Patch Center credentials are
configured.
2) Run of the BroadSoft Patch Center Audit
cycle.

NEW This patch status indicates that the patch was

initially discovered by the BroadSoft Patch
Center Audit cycle. This status overwrites any
patch with an NE_GENERATED status. The
patch properties indicate default values only.
This is a transient status.

DOWNLOAD_SCHEDULED This patch status indicates that the patch is

scheduled for the next patch download cycle.
The patch properties indicate default values
only. This status remains until the actual
download occurs.

DOWNLOADED This patch status indicates that the patch is

being entirely downloaded to the EMS disk.
The patch properties indicate default values
only. This is a transient status.

DETAILED_AVAILABLE This patch status indicates that the patch is

available for distribution and application to
network elements. This status remains until the
patch end of life is scheduled.

MISSING_DEPENDENCY This patch status indicates the identification of

missing dependency (from other patches). The
patch properties indicate their actual values.
This status remains until the EMS receives all
missing patches. Once this condition is met,
the status becomes DETAILED_AVAILABLE.

DELETION_SCHEDULED This patch status indicates that the patch

is scheduled for deletion. This status is
automatically set when the EMS discovers that
there is no more NE at this patch version and
thus the patch is no longer required. This can
happen when the NEs is deleted from the EMS
or if the NE’s software is upgraded. This status
remains until the deletion occurs (30 days later).

USER_DELETED This patch status indicates a request by a user

to delete an excluded patch. This is a transient
status.

NOTE: The transient status remains while EMS completes a BroadSoft Patch Center Audit cycle.
Typically, the duration is directly related to the number of patches associated with the EMS span.
That is, the greater the number of patches in an EMS span, the longer a transient status remains.

Is Patch Excluded This text box appears if the patch is excluded.

Description This text box specifies the description of the patch.

Detailed Description Click the link to view the detailed description of the patch.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 427
 Input Box Description

Patched Files Click the link to view the list of patched files.

To view the details of a patch:

On the Patch Support Center page, click the title of the patch you would like to view. The Patch Properties
page appears. The details appear for either a patch bundle, which is the list of application patches in the
selected patch bundle (PB), or an application patch (AP).

11.2.5.2 Create Bundle

Use the Patch Bundle Creation - Confirmation page to create a patch bundle.

Figure 218: Patch Bundle Creation - Confirmation Page

The information on this page includes the following:

Input Box Description

Select OS This drop-down list defines the Operating System. Values include "Linux_vc86_64".

Bundle Name This input box specifies the name of the bundle.

Available Patches This list displays the available patches.

Selected Patches This list displays the selected patches.

To create a bundle:
1) On the EMS Patch Support Center page, select the check box(es) in the row for the patch(es) for which
you would like to create a bundle.
2) Click Create Bundle. The Patch Bundle Creation – Confirmation page appears.
3) From the Select OS drop-down list, select the operating system.
4) Review the Bundle Name.
5) From the Available Patches list, select the patches to bundle, and then click Select > to move them to
the Selected Patches list.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 428
 6) If you would like to remove any patches that you have moved to the Selected Patches list for the
bundle, select these patches from the Selected Patches list and then click < Unselect.
7) Click Reset List to undo any changes you have made.
8) Click Create Bundle to create the patch bundle. Once the bundle has been created, the bundle
creation confirmation appears at the top of the EMS Patch Support Center page with a green check
mark beside the name of the patch bundle.

11.2.5.3 Re-download Patches

Use the Patch re-download - Confirmation Page page to download a patch that has previously been
downloaded.

Figure 219: Patch re-download - Confirmation Page

To re-download a patch:
1) On the Patch Support Center page, select the check box(es) in the row for the patch(es) you would like
to re-download.
2) Click Re-download Patches…. The Patch re-download - Confirmation Page appears.
3) Click Re-download Patches to download the patches or click Back to return to the previous page.

11.2.6 Managing Patches for Node

Use the NE Patch Level page to display a list of patches for a specific network element (NE), node, or
server.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 429
 Figure 220: NE Patch Level

The information on this page includes the following:

Column Description

Node This column specifies the IP address of the node.

OS This column specifies Operating System.

Machine This column specifies the machine name.

Server Type This column specifies the BroadWorks server type.

BW Software Version This column specifies the BroadWorks version.

NB of applied patch(es) This column specifies the number of patches applied to the node.

NE missing critical This column displays whether the NE has any missing critical patches.
patch(es)

NB of missing critical This column displays the number of missing critical patches.
patch(es)

SWManager Version This column displays the Software Manager version running on the node.

OS Release This column specifies the Operating System release.

Last Refresh Date This column specifies the time stamp indicating the last refresh.

To access patches for an NE (server):

1) Click the Centralized Networking tab.
2) From the Patch Management submenu, click NE Patch Level. The NE Patch Level page appears.
To display patches:
1) On the NE Patch Level page, select the type of servers related to patches from the drop-down list:
• "All Servers": This value displays patches associated with all servers.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 430
 • "NS": This value displays patches associated with the Network Server.
• "PS": This value displays patches associated with the Profile Server.
• "AS": This value displays patches associated with the Application Server.
• "XSP": This value displays patches associated with the Xtended Services Platform.
• "MS": This value displays patches associated with the Media Server.
• "CDS": This value displays patches associated with the Call Detail Server.
2) Select the releases related to patches from the drop-down list. The requested patches appear.
To delete a patch:
1) On the NE Patch Level page, select the check box(es) in the row for the patch(es) you would like to
delete.
2) Click Delete Patches…. The selected patch(es) are removed.
Tasks to perform from this page

11.2.6.1 Apply or Remove Patch

Use the Missing PB NE Patch page to apply or remove a patch to or from a server.

Figure 221: Missing PB NE Patch

The information on this page includes the following:

Column Description

Title This column specifies the title of the patch.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 431
 Column Description

EMS Patch Status This input box specifies the EMS patch status:

Patch Status Description

NE_GENERATED This patch status indicates that the patch was

first discovered by the NE Audit cycle. The
patch properties indicate default values only.
Typically, this status remains until the following
two conditions are met:
1) BroadSoft Patch Center credentials are
configured.
2) Run of the BroadSoft Patch Center Audit
cycle.

NEW This patch status indicates that the patch was

initially discovered by the BroadSoft Patch
Center Audit cycle. This status overwrites any
patch with an NE_GENERATED status. The
patch properties indicate default values only.
This is a transient status.

DOWNLOAD_SCHEDULED This patch status indicates that the patch is

scheduled for the next patch download cycle.
The patch properties indicate default values
only. This status remains until the actual
download occurs.

DOWNLOADED This patch status indicates that the patch is

being entirely downloaded to the EMS disk.
The patch properties indicate default values
only. This is a transient status.

DETAILED_AVAILABLE This patch status indicates that the patch is

available for distribution and application to
network elements. This status remains until the
patch end of life is scheduled.

MISSING_DEPENDENCY This patch status indicates the identification of

missing dependency (from other patches). The
patch properties indicate their actual values.
This status remains until the EMS receives all
missing patches. Once this condition is met,
the status becomes DETAILED_AVAILABLE.

DELETION_SCHEDULED This patch status indicates that the patch

is scheduled for deletion. This status is
automatically set when the EMS discovers
that there is no more NE at this patch version
and thus the patch is no longer required. This
can happen when the NEs is deleted from the
EMS or if the NE’s software is upgraded. This
status remains until the deletion occurs (30
days later).

USER_DELETED This patch status indicates a request by a user

to delete an excluded patch. This is a transient
status.

NOTE: The transient status remains while EMS completes a BroadSoft Patch Center Audit cycle.
Typically, the duration is directly related to the number of patches associated with the EMS
span. That is, the greater the number of patches in an EMS span, the longer a transient status
remains.

Description This column specifies a description of the patch.

Sys Crt This column appears if the patch is critical.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 432
 Column Description

AS WS This column appears if an Application Server Web Server patch is required.

Int Aff This column appears if an interface is affected by the patch.

Rst Req This column appears if a restart is required after the patch is installed.

DB Aff This column appears if a database is affected by the patch.

Date Closed This column displays the time stamp indicating when the patch was closed.

To apply a patch (or patches):

1) On the NE Patch Level page, select the node(s) for which you would like the patches applied.
2) Click Apply Patches.
3) Select from the list of Bundles Available and Patches Available by clicking the check box beside the
desired patch or bundle. A pop-up displays the required dependencies needed to apply the selected
patch.
4) Click OK to select the dependencies.

NOTE: The dependents (patches which requires some other patches) check boxes are enabled only if
the check boxes for their dependent (patch required by some other patches) are unchecked.

5) From the Scheduled Date text box, use the calendar to select the date to apply the patches. When
selecting the schedule option, the EMS asks for a final user confirmation before proceeding. If the user
confirms the request, the EMS takes the following actions at each of the selected NEs.
• Uploads any missing patches.
• If patches are missing, immediately refreshes the Patch tool context.
• Schedules the Apply Patch command for the selected patches.
• If required, schedules the NE locking command. The EMS issues an NE locking command only
when the Restart required input box is at "Y" for at least one of the selected patches.
• Schedules the executed patch command.

NOTE: The operation occurs only if the EMS is running at the time of the scheduled execution. The
processing includes a grace period of 15 minutes. The scheduled operation still occurs even if the
EMS was restarted within 15 minutes of the scheduled operation.

6) Select or unselect Force. The Force option allows you to apply the patches in an offline mode.
7) Click Apply Patches to apply the patches. A confirmation dialog box appears.
8) Click OK to apply the patches or click Cancel to cancel the application of the patch.
To remove a patch (or patches):
1) On the NE Patch Level page, select the node(s) for which you would like to remove patches.
2) Click Remove Patches.
3) Select from the list Patches Available by clicking the check box beside the desired patch. A pop-up
displays the required dependents which need to be removed along with the selected patch.
4) Click OK to select the dependents.

NOTE: The dependents (patches which requires some other patches) check boxes are enabled only if
the check boxes for their dependent (patch required by some other patches) are unchecked.

5) From the Scheduled Date text box, use the calendar to select the date on which to remove the patches.
When selecting the schedule option, the EMS asks for a final user confirmation before proceeding. If
the user confirms the request, the EMS takes the following actions at each of the selected NEs:
• Schedules the Remove Patch command for the selected patches.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 433
 • If required, schedules the NE locking command. The EMS issues an NE locking command only
when the Restart required input box is at "Y" for at least one of the selected patches.
• Schedules the executed patch command.
NOTE: The operation occurs only if the EMS is running at the time of the scheduled execution. The
processing includes a grace period of 15 minutes. The scheduled operation still occurs even if the EMS
was restarted within 15 minutes of the scheduled operation.
6) Select or unselect Force. The Force option allows you to apply the patches in an offline mode.
7) Click Remove Patches to remove the patches immediately.

11.2.6.2 Create Patch Report

Use this procedure to create a patch report in a Portable Document Format (PDF) report. The information
that is displayed here matches the information available from the Detailed Patch Level page.
1) On the NE Patch Level page, select the node for which you would like to create a report.
2) Click Create Report…. The Report Preparation Screen page appears.
3) Select the information for the report from the Report components list:
• Summary of information per NEs
• Detailed patch level information
• Patching history
• List patched files
4) Click Generate. The report appears in a PDF format.

11.2.6.3 Refresh Information

Use this procedure to submit an immediate request for all selected network elements (NEs) to refresh the
patch-related data currently stored on the EMS.
1) On the NE Patch Level page, select the check box of the node to refresh.
2) Click Refresh information from NE. The EMS starts an NE Audit cycle. Information is refreshed and
appears for the selected NEs.

11.2.6.4 View or Delete Patch Schedules

Use the View Schedules page to view or delete the download schedules for patches.

Figure 222: View Schedules

The information on this page includes the following:

Column Description

Task Id This column displays the task identification number.

Node List This column displays the list of nodes.

Patch List This column displays the list of patches.

Scheduled Date Time This column displays the scheduled date of each task.

Restart This column specifies whether the server needs to be restarted after the patch is installed.

Task Type This column displays the type of task activity.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 434
 Column Description

Force This column specifies whether a force is required.

Ignore Warn. This column specifies whether warnings are ignored.

To view or delete patch schedules:

1) On the NE Patch Level page, select the NE for which you would like to view or delete patches.
2) To view a schedule, click View Scheduled Tasks. The View Schedules page appears.
3) To delete a schedule, click Delete Scheduled Task. The scheduled task is deleted.

11.2.6.5 View Patch Details for Node

This page displays the details for patches associated with the selected NE. The information is separated
into three tabs: UNDEPLOYED Group, DEPLOYED Group, and EXCLUDED Group. The UNDEPLOYED
Group tab appears by default.
Use the Detailed Patch Level page to view the details of patches for a node.

Figure 223: Detailed Patch Level

The information on this page includes the following:

Column Description

Title This column displays the title of the patch (or patch bundle).

Patch State This column specifies the state of the patch.

Description This column displays a description of the patch (or patch bundle).

Sys Crt This column specifies whether the patch (or patch bundle) affected is critical to the system. The
value "N" represents "No" and the value "Y" represents "Yes".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 435
 Column Description

AS WS This column specifies whether the patch (or patch bundle) affects the Application Server or Web
Server. The value "N" represents "No" and the value "Y" represents "Yes".

Int Aff This column specifies whether the patch (or patch bundle) affects the interface. The value "N"
represents "No" and the value "Y" represents "Yes".

Rst Req This column specifies whether the patch (or patch bundle) requires a restart. The value "N"
represents "No" and the value "Y" represents "Yes".

DB Aff This column specifies whether the patch (or patch bundle) affects the database. The value "N"
represents "No" and the value "Y" represents "Yes".

Date Closed This column displays the date the patch was created.

To view the patches for a node:

On the NE Patch Level page, select the NE for which you would like to view the details of patches. The
Detailed Patch Level page appears. The UNDEPLOYED Group tab appears by default.
To exclude the patches for a node:
1) On the The Detailed Patch Level page, select the check box in the row containing the patch you would
like to exclude.
2) Click Exclude from active management to move the selected undeployed patches to the group of
excluded patches.
The EMS allows this action only when the selected patch is not dependent on any other managed
patch. Otherwise, the dependencies on each patch must be excluded first. Once a patch is excluded, it
can be deleted.
The patch is now listed under the EXCLUDED Group tab.
To view the details of a patch:
On the Detailed Patch Level page, select the check box in the row containing the patch you would like to
view. The Patch Properties page appears. For more information on patch details, see View Patch Details
on page 425.
Tasks to perform from this page
11.2.6.5.1 View Deployed Patches for Node
Use the Detailed Patch Level - DEPLOYED Group tab to view the deployed patches for a node

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 436
 Figure 224: Detailed Patch Level - DEPLOYED Group

For a description of the reference information on this page, see .

To view the undeployed patches for a node:
1) On the NE Patch Level page, select the network element (NE) for which you would like to view the
details of patches. The Detailed Patch Level page appears.
2) Click the DEPLOYED-Group tab. The Detailed Patch Level-DEPLOYED Group tab appears.
To create a bundle:
1) On the NE Patch Level page, click Create Bundle. The Patch Bundle Creation – Confirmation page
appears.
2) From the Select OS drop-down list, select the operating system.
3) Review the Bundle Name.
4) From the Available Patches table, select the patches to bundle, and then click Select> to move them to
the Selected Patches table.
5) If you would like to remove any patches for the bundle, select patches from the Selected Patches table
and then click <Unselect.
6) Click Reset List to undo any changes you have made.
7) Click Create Bundle to create the patch bundle. Once the bundle has been created, the bundle
creation confirmation appears at the top of the EMS Patch Support Center page with a green check
mark beside the name of the patch bundle.
To view the history of a patch:
On the NE Patch Level page, click Patching History. The History page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 437
 Figure 225: History

11.2.6.5.2 Re-include Patch

Use the Detailed Patch Level - EXCLUDED Group tab to include a patch (in active management) that has
previously been excluded.

Figure 226: Detailed Patch Level - EXCLUDED Group

For a description of the reference information on this page, see View Patch Details for Node on page
435.
To view the excluded patches for a node:
1) On the NE Patch Level page, select the NE for which you would like to view the excluded patches. The
Detailed Patch Level page appears.
2) Click the EXCLUDED Group tab. The Detailed Patch Level - EXCLUDED Group tab appears.
To re-include a patch:
On the Detailed Patch Level - EXCLUDED Group tab, click Re-include in active management. The
Detailed Patch Level - UNDEPLOYED Group tab appears on the list with the patch.

11.2.7 BroadSoft Patch Center Substitution

In certain circumstances, where security constraints strictly prohibit a direct connection between a platform
communicating with the production servers and the outside world, an alternate configuration is possible,
in which the EMS expects the patches locally or from an intermediate site. This configuration relies on an
external mechanism for synchronizing the local directory (or the intermediate site) with BroadSoft Patch
Center. This approach assumes that the external mechanism complies with the internal security policies
where the EMS is deployed. Having an internal validation process against released patches is another
reason for applying a BroadSoft Patch Center substitution.
This configuration requires the following changes:
• An EMS administrator must access the BroadSoft Patch Center Credentials page. By default, the
following values can be used:
• BroadSoft Patch Center user name should be set to a valid file (protocol) user name for the
intermediate site.
• BroadSoft Patch Center password should be set to a valid file (protocol) for the intermediate site.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 438
 • BroadSoft Patch Center site should be set to “localhost” or the intermediate site name.
• BroadSoft Patch Center protocol should be set to “file” .
The following figure shows an example from the BroadSoft Patch Center Credentials page. (For Release
15.0, this functionality has a dependency against the patch 84302.)

Figure 227: BroadSoft Patch Center Credentials

The Centralized Patching Management functionality has the following dependencies when using this
configuration:
• The external mechanism must synchronize the files between the following locations:
• From the centralized BroadSoft Patch Center directory for all patches
(<BROADSOFT_PATCH_CENTER_HOME_DIR>/GA/<BroadWorks release number>/<BroadWorks
Server Type>/).
For example, the BroadSoft Patch Center directory is named <customer username>/GA/14.sp3.200/
as for Release 14.sp3 of the BroadWorks Application Server.
• To the local (or intermediate site) EMS directory for all patches (/GA/<BroadWorks release number>/
<BroadWorks Server Type>/).
For example, the local directory is named /GA/14.sp3.200/as for Release 14.sp3 of the BroadWorks
Application Server.
• The synchronization mechanism must include the files named “system-criticalpatches” from all
subdirectories where patches are located.
• The synchronization mechanism must include the file named “defective-patches” that contains the list of
all patches flagged as defective (deprecated, recalled, reissued, rereleased, and so on).
• For supporting software manager management, the external mechanism must also synchronize the files
between the following locations:
• From the centralized BroadSoft Patch Center directory for the software manager binaries
(<BROADSOFT_PATCH_CENTER_HOME_DIR>/GA/co/).
• To the local (or intermediate site) EMS directory /GA/co.
The following figure shows an example of the BroadSoft Patch Center directory structure required by the
EMS Centralized Patching Management.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 439
 Figure 228: BroadSoft Patch Center Directory Structure

The following limitations apply when the Centralized Patching Management functionality uses this
configuration:
• The patch closed date field displayed by the EMS matches the patch transfer date to the local (or
intermediate site) EMS directory.
• The patches relevant to the EMS span of control are duplicated locally (or from the intermediate site)
since this first copy is viewed as the “BroadSoft Patch Center” copy.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 440
12 Managing Licenses

This section provides information on how to use the centralized licensing to manage BroadWorks licenses.
This section describes the following:
• Reporting on Licenses on page 442

12.1 Terminology
Terminology that specifically describes the BroadWorks licensing includes the following:
Add-On Product
An add-on product is equivalent to a service license pack that contains a single service. Add-on products
may be of different types, including user services (such as BroadWorks Receptionist – Office), group-
oriented services (such as Hunt Group or Auto Attendant), or platform services (such as Lawful Intercept or
Deployment Studio).
Business Trunking License Unit Product
A business trunking license unit product is the license unit that determines how many simultaneous
trunking calls are allowed on a given Application Server pair at run time. Business trunking license units
are equivalent to the trunking call capacity. In the license file, it is defined by the license system parameter
named maxTrunkGroupCallCapacity.
Capacities
Capacities on Application Server license files include following properties: Largest group allowed
(groupUserLimit in the license file ), maximum number of groups (numGroupLicense in the license file),
and maximum number of users (userLicense in the license file). A group is consumed if a group is created;
a user is consumed if a user is created and a user in the group is counted as well.
Group Service
A group service is a single service that is assigned to a group. Group services can be counted as virtual
(number of instances).
Group Service License Pack
A group service license pack is a set of group services. An instance of the service license pack is
consumed as soon as one of the services is assigned to a group. In a service license pack, all services are
assigned with the same quantities.
Incomplete Match
An incomplete match is a user who consumes service license packs that could not be found in any product.
Licenses
BroadSoft sells licenses to customers by delivering license files. License files are used to authorize
services, capacities, and even start-up on a given BroadWorks server. License file content and formats are
changed based on the BroadWorks server type and release number.
Outlying Users
Outlying users fall into one of the following categories:
• Multiple user products: a user who consumes more than one user product.
• No user product: a non-trunk user who consumes only products that are not user products, and thus
fails to contain the subscriber license for that user.
• No trunk product: a trunk user who fails to consume a trunk product, and thus fails to contain the
subscriber license for that user.
Product

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 441
 A product contains a list of service licenses with their corresponding relative quantity and service license
pack. There are different types of products: user, trunk, and add-on.
Service License
A service license is a "licensable" entity of given service, it is one of the basic components in the license
file, it has a quantity allocated, and the quantity can be unlimited. A license is consumed if the service
license is assigned.
Service License Pack
A service license pack is a set of service licenses bundled together. A service license pack is identified with
a name assigned to the servicePack in the service license file. One service license can only be assigned to
one service license pack. One service license can exist by itself, without belonging to any service license
pack. A service license is consumed for the entire service license pack as soon as one of the service
licenses in the service license pack is assigned.
User Product
A user product is a set of user (or unlikely group) services, included directly or indirectly (through service
license packs) fulfilling the goal of providing a certain level of functionality for a single user/line.
User Service
A user service is a single service that can be assigned to a user. User services can be assigned to real or
virtual users.
User Service License Pack
A user service license pack is a set of user services. An instance of the service license pack is consumed
as soon as any service from the pack is assigned to a user. In a service license pack, all services are
assigned with the same quantities.

12.2 Reporting on Licenses

This feature allows operators to track their license usage from the EMS to:
• View the license usage of the Application Server
• Schedule periodic license reports
• Create a historical view of license reports
• Create reverse lookup license reports
• Configure the license threshold
• Deliver license reports by e-mail
• Include license usage on a per-product basis
For more information

12.2.1 Overview
With the Centralized License Reporting and Monitoring feature, operators can report and monitor license
usage of Application Server clusters from the EMS web interface.
The feature comprises three main components:
• License data collection, which includes scheduling data generation through the EMS onto the
Application Server and gathering data from the Application Server to the EMS.
• License Reporting, which includes configuring periodic reports and generating usage/reverse lookup
reports.
• Monitoring, which includes configuring and monitoring license thresholds.
The following diagram shows a view of the license data collection process:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 442
 Figure 229: Reporting Process

This process starts after the data generation is configured and the data gathering tasks are defined. The
data generation task results in the creation of a maintenance task on all managed Application Servers.
The data gathering task periodically retrieves ZIP files generated by the Application Server data generation
scheduled task onto the EMS.
The process begins on the Application Server where the scheduler executes the service license collection
at the specified time. A ZIP file that contains the service license and usage data is generated. Then the
EMS periodically retrieves the Application Server clusters' ZIP files. The EMS database is updated with the
related file information.
Once the Application Server license report files are on the EMS, the operator can generate license reports
from the EMS. There are two types of reports: usage report and reverse lookup report. Both report types
can be scheduled to be generated periodically and can optionally be sent by e-mail. Various file formats
are available for license reports. Periodic and reverse lookup reports are saved on the EMS and are
available for consultation.
The usage report is similar to the report generated by the Application Server Service License Report. The
EMS provides the ability to combine multiple Application Server clusters' license usage into a single report.
All clusters' license usages are added together. The product usage can also be included in this report.
The reverse lookup provides a list of Application Server clusters, service providers/enterprises, groups, or
users assigned a particular service or service license pack. One or more services or service license packs
are selected and the generated report provides the list of Application Server clusters, service providers/
enterprises, groups, or users with those services or service license packs assigned.
You can also configure thresholds to monitor the license usage of a product, a license pack, or a specific
service license. Thresholds can be applied for all Application Server clusters, for a specific Application
Server cluster, or for a specific service provider/enterprise.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 443
 License performance counters are introduced as part of this feature to provide access to license usage and
counts through Simple Network Management Protocol (SNMP).

NOTE: Since the support of the product is introduced to the Application Server license in Release 19.0,
there is no product information in the license usage reports for any Application Server running a previous
version (for example, Release 18.0).

Related information

12.2.1.1 Product Usage Analysis

Product usage analysis is the process of determining the product(s) each user consumes, based on the
service license packs used by that user. As opposed to service license packs that cannot overlap each
other in the list of services that they contain, two products can contain the same service license packs,
that is, a service license pack can be found in more than one product. For this reason, the determination of
product(s) that a user consumes can lead to several valid answers that depend on the product precedence
order.
The product precedence defines an ordering of the different products purchased by the customer, from the
most basic to the most advanced. It can be configured from the Configure License Reporting on page 346
page. It is primarily used to discriminate between user products. The configured product precedence order
has a direct impact on the product usage analysis results. This is especially the case when most users are
using a set of services (and in turn, service license packs) that are entirely found in two or more different
products.
The product usage analysis works as follows:
1) Products taken from the license file are ordered from basic to advanced as follows:
a) The alphabetical order is the default.
b) A verification is executed to ensure that if two products are a superset/subset of each other, the
subset product comes first. This is the default order that is used when an operator-configured
product precedence list is not available.
c) The product precedence order list defined on the Configure License Reporting on page 346 page is
retrieved.
d) Products found in the ordered list from step 1.2 but not mentioned in the product precedence order
list from step 1.3, are inserted at the beginning of that list, which is considered more advanced. Note
that the ordering from step 1.2 is preserved.
2) The consumed products are computed by assigning a best-matching set of products to each user as
follows:
a) The list of service license packs used by the user is built.
b) The most basic product that contains the maximum number of service license packs used by the
user is identified. Normally the identified product contains all service license packs in use by the
user. If two or more products contain all the service license packs in use by the user, the most basic
is retained.
c) If no single product contains all the service license packs in use by the user, but two or more
products contain an equal number of service license packs in use by the user, the most basic is
retained. Steps 2.2 and 2.3 are repeated to identify matching product(s) for the remaining service
license packs.
d) The matching products are reported as consumed by the user.
e) The available quantities are decremented.
For additional information on the product usage analysis, see the Service License Reporting Guide.

12.2.2 Configure License Data Collection

To report on license data, you must first gather the information from the Application Server and then
configure the EMS to collect the data.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 444
 1) Configure the Application Server to collect license data:
1) Log in to the EMS Java applet.
2) From the Administration Tools menu, click Mtc Task Setup. The Mtc Task Setup page appears.
3) Select the Configure Maintenance Tasks Setup tab.
4) Click Add. The Setup Mtc Task page appears.
5) From the Maintenance Task Name drop-down list, select "serviceLicenseCollect".
6) In the BW Server Type list, check "Application Server".
7) In the Frequency Type input box, select the frequency.
8) In the Frequency Values input box, select the first-peer start time.

NOTE: The frequency type can be daily, weekly, or monthly and within the range specified by Daily
Maintenance Window input boxes. It is recommended to schedule the License Collection Script to
run daily, during a low-traffic period.

9) Click Apply.

NOTE: If the maintenance task is already scheduled on the Application Server, the EMS overwrites
the current configuration and schedules the task with the new parameters if the Automatic Overrule
check box is selected.

10)Click the Apply Maintenance Task Setup tab.

11)Select the Apply Configure Mtc Tasks per server types option and click on to Application Server to
apply maintenance task setups to all Application Servers. Or, select the Apply Configure Mtc Tasks
to specific node option and select the specific Application Server nodes to apply maintenance task
setups.
12)Click Configure Now. The Confirmation dialog box appears.
13)Click Yes.
14)Click OK.

NOTE: For more information on configuring a maintenance task, see Setting Up Maintenance Tasks
on page 376.

2) Configure the EMS to download data. By default, when the EMS applet configures the maintenance
task, it automatically schedules the gathering task at the same frequency as the maintenance task but
the scheduled time is two hours later to ensure that the EMS collects the last file created. The EMS
task that gathers the files is also configurable via the Web Client. For more information, see Configure
License Reporting on page 346.

12.2.3 Configure Thresholds

You can configure thresholds to receive notifications when an allocated license reaches a certain value.
The monitoring can be based on a particular service or service license pack and can be applied on the
whole network or on a specific Application Server cluster or service provider/enterprise.
The threshold category is automatically set to "License Monitoring" by the EMS.
Once the threshold is added, it also becomes available under Configure Thresholds on page 244 page.
However, it is highly recommended not to perform any operation on the license monitoring threshold from
that page.
The threshold is checked against the collected data, which may be once a day depending on the amount
of Application Server clusters and license data reported by Application Server clusters. A license alarm is
generated when the threshold is crossed; it is cleared when the rearm is crossed unless the Send Clear
option is set to "false".
Associated Statistic

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 445
 Each time a threshold is configured, the EMS creates an associated statistic. This statistic can be viewed
under the Performance tab for a new agent called LicenseMonitoring, which is added when the first license
threshold is created. The name of the statistic is automatically set to the threshold name followed by
"LMPM" with the object identifier (OID) and finished with "Stats". For example, when the threshold name
"test" is created, the associated statistic is called "testLMPM1Stats". The polling period is set to "86400"
seconds to poll the data once a day. If the EMS detects that the threshold created concerns a statistic that
is already created, it only adds the new threshold to the associated statistic.

NOTE: The creation of a license threshold is similar to a performance threshold; however, in addition,
information on the data to monitor must be entered.

Figure 230: Threshold Configuration

The information on this page includes the following:

Column Description

Name Displays the name of the threshold.

To modify a threshold:
1) On the Threshold Configuration page, click the link of the name of the threshold to modify. The
Threshold Modify page appears.
2) Modify the threshold contents.
3) Click Submit to save these changes, Reset to reset the values to the previous settings, or Cancel to
return to the previous page.
To delete a threshold:
1) On the Threshold Configuration page, check the check box for the threshold to delete.
2) Click Delete. The threshold is removed from the list of thresholds.
Tasks to perform from this page

12.2.3.1 Add Threshold

Use the Threshold Configuration page to configure a license usage threshold.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 446
 Figure 231: Threshold Configuration

The information on this page includes the following:

Input Box Description

Value Type This drop-down list determines whether the threshold value is
absolute ("long") or a percentage.

Name This input box specifies the name of the threshold.

Severity This drop-down list specifies the severity of the alarm generated
when the monitored value passes this threshold value. Values
include: "Minor", "Warning", "Clear", "Major", and "Critical".

Threshold type This drop-down list specifies the kind of operation applied on the
value. Values include "Max" and "Min".

Threshold Value This input box specifies the threshold value. Note that the
Rearm Value (the threshold value when the alarm is cleared)
is hard-coded. The Rearm Value equals Threshold Value – 1
when Threshold Type is set to "Max". The Rearm Value equals
Threshold Value + 1 when the Threshold Type is set to "Min".

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 447
 Input Box Description

Send Clear This input box determines whether "Clear" events are generated
on threshold reset from the drop-down list. If the value is set to
"False", when the threshold is reset (rearmed), no information
will be displayed on the Events page.

Message This input box specifies the text that is included in the alarm.

Clear Message This input box specifies the text that is included in the clear
event.

AS Cluster This drop-down list specifies the Application Server cluster.

Service Provider/Enterprise This input box specifies the service provider/enterprise. An

empty value means the threshold is only applied on the
Application Server cluster.

Service License Pack This input box determines whether the threshold is based on the
selected service license pack.

Service License This input box determines whether the threshold is based on the
selected service license.

Product This input box determines whether the threshold is based on the
selected product.

12.2.4 Configure Usage Report

Once the data is transferred to the EMS, it is possible to display usage reports on the selection criteria:
enterprise, group, and user. In addition, it is possible to display a report for all Application Server clusters
in two different ways: separated or combined. The combined report displays the same information as if one
Application Server cluster was selected, but the available and used licenses of each Application Server
cluster are all added. The separated report contains the reports of each individual cluster listed one after
another.
Use the Usage Report Configuration page to configure a usage report.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 448
 Figure 232: Usage Report Configuration

The information on this page includes the following:

Input Box Description

Report Format This input box identifies the format of the report. Valid values include: "HTML", "XML", "CSV", or
"PDF".

Date This drop-down list provides the ability to select the date on which the EMS takes the data to generate
the report. Valid values include all of the available dates for which the EMS has data. If the EMS has
not collected any data yet, thedrop-down list is empty and the other input boxes are disabled.

AS Cluster This drop-down list provides the ability to select the Application Server cluster. It is disabled until the
date is selected. Valid values include the list of all Application Server clusters for which the EMS has
data for the selected date. The value "ALL" displays a network report that contains the information of
all listed Application Server clusters.

Service Provider/ This input box provides the ability to select the service provider/enterprise. It is disabled until the
Enterprise Application Server cluster is selected and not set to "ALL". Auto completion is activated by pressing
the SPACEBAR when the cursor is in the input box. An empty value means that all service providers/
enterprises should be taken into account.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 449
 Input Box Description

Group This input box provides the ability to select the group. It is disabled until a service provider/enterprise
is selected. Auto completion is activated by pressing the SPACEBAR when the cursor is in the input
box. An empty value means that all groups should be taken into account.

User This input box provides the ability to select the user. It is disabled until the group is selected. Auto
completion is activated by pressing the SPACEBAR when the cursor is in the input box. An empty
value means that all users should be taken into account.

Include Product Details This check box determines whether the Purchased Products Detail section of the report contains the
Service License Pack and Quantity columns. It is disabled if there is no product information in the
licenses. The validation is performed on the Application Server cluster on the selected date. When the
Application Server cluster is set to "ALL", at least one cluster must have the product information in the
licenses for this input box to be enabled. The default value is unchecked and the Purchased Products
Detail section of the report does not contain columns Service License Pack and Quantity.

Combine All AS Cluster This check box is only enabled when the Application Server cluster is set to "ALL". If checked, the
Report report is one combined report that sums up all Application Server cluster license values by service
license, subscriber license, trunking call capacity, and product. If unchecked, the report contains a list
of Application Server cluster license reports. The default value is unchecked for a separated report.

NOTE: For the Purchased Products Detail section of the report, only the Application Server clusters
that have product information in the license file are aggregated.

Include Single Service This check box determines whether the report contains the service license list of the service license
Usage Details packs. The default value is unchecked and the report does not contain the service licenses.

Report Name This input box displays the name of the periodic report. It is disabled until Periodic Report Generation
is checked.

Frequency Type This drop-down list provides the ability to select the frequency of the generation of the report. It
is disabled until Periodic Report Generation is checked. Valid values include: "Never", "Monthly",
"Weekly", and "Daily". The default value is "Never".

Frequency Value This input box provides the ability to select the day of the month, the week day, and the time of day
depending on the frequency type. It is disabled until Periodic Report Generation is checked. Valid
values include:
• Day of the Month: 1 through 31
• Week Day: Monday through Sunday
• Time of Day: 0:00 through 23:00

Mail Report This check box provides the ability to send the generated reports to an e-mail distribution list. The e-
mail distribution list is configured under Configure E-mail Distribution Lists on page 338.

To create a usage report:

1) Click the Centralized Networking tab and select the License Reporting submenu.
2) Click Usage Report Configuration. The Usage Report Configuration page appears.
3) In the Report Format drop-down list, select the report format.
4) In the Date drop-down list, select the date.
5) In the AS Cluster drop-down list, select the Application Server cluster(s) to include in the report.
6) In the Service Provider/Enterprise input box, select the service providers (or enterprises) to include in
the report.
7) In the Group input box, select the group(s) to include in the report.
8) In the User input box, select the user(s) to include in the report.
9) To include product usage details in the report, check the Include Product Details check box and select
the products from the drop-down list.
10)To combine the information for all Application Servers in the report, check the Combine All AS Cluster
Report check box.
11)To include the service list of the service license packs in the report, check the Include Single Service
Usage Details check box.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 450
 12)To view the report, click Show. The report appears.
13)To schedule a recurring report:
a) In the Report Name input box, enter the name of the report.
b) From the Frequency Type drop-down list, select the frequency of the generation of the report.
c) In the Frequency Value input boxes, specify the details of the schedule for report generation.

NOTE: If this is a one-off report, select "Never".

14)To mail the report to an e-mail recipient, check the Mail Report check box and select the recipient from
the drop-down list.
15)Click Save to save these changes or Reset to reset the values to the previous settings.
For more information

12.2.4.1 Usage Report Details

Use the Usage Report page to view the usage report.

Figure 233: Usage Report

To view the entire usage report, see HTML License – AS Cluster Report on page 465.
The information on this report includes the following:
Section Description

Header This section displays the date the report was generated and the selected values of the Application
Server cluster.

Purchased Products This section displays a summary of the consumption (percentage of licenses available) of
Dashboard purchased products in a bar chart format.

Purchased Products Detail This section displays the list of all products with the product name, the type, the number
of licenses purchased, the number of licenses used, the number of licenses available, the
percentage of licenses available, a breakdown of the list of licenses available in service license
packs, and the name and quantity of service license packs for each product.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 451
 Section Description

Outlying Users This section displays the outlying users with the following columns: ServiceProvider/Enterprise,
Group, UserId, Reason, Details. The Reason column contains the name of the outlying category.
The Details column lists the applicable packs or products. Outlying users are listed in alphabetical
order based on the service provider/enterprise, group, user ID.
Not all outlying users are listed in the report. The configuration parameter, Outlying Users
Maximum Number, determines the maximum number of users listed. The value "0" is valid and
results in the suppression of the outlying user list in the report. In addition, the Outlying Users
section of the report is not shown if there is no product information in the licenses.

Subscriber Licenses This section displays the number of licenses, the number of licenses used, the number licenses
remaining, and the percentage of licenses remaining by user, trunk group, and group. Note that
the trunk group user does not count as a user license.

Trunking Call Capacity This section displays information on trunking call capacity. The Licensed column indicates the
maximum number of simultaneous trunk group calls that are allowed, that is, the license quantity
of Business Trunking License Units (BTLU). The Used, Available, and % Remaining columns
indicate the number of licenses used, the number licenses remaining, and the percentage of
licenses remaining, respectively. The first row displays trunking call capacity at the system level.
The remaining rows consist of a breakdown of the list for enterprises, service providers, and
groups. The calculation of used BTLUs (Trunking) is based on the following rules:
• The trunking call capacity licensed at the system level can be distributed (assigned) to
enterprise and service providers.
• Any trunking call capacity (in the number of calls) assigned to an enterprise directly consumes
the same number of BTLUs. This is independent from whether or not the trunking call capacity
is in turn assigned to groups of the enterprise.
• Any runking call capacity (in the number of calls) assigned to a service provider has no effect
on the consumption of BTLUs. This number limits the total amount of BTLUs that the service
provider can redistribute to its groups.
• Any trunking call capacity (in number of calls) assigned to a group of a service provider directly
consumes the same number of BTLUs.
Thus, the quantity of used BTLUs at the system level is as follows:
Used = sum (BTLUs assigned to enterprise) + sum (BTLUs assigned to group of a service
provider)

Group Service Licenses This section displays the list of all group license packs and services, including how many of each
are consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs and services, including how many of each are
consumed. It is not displayed when the report is generated for a given user.

User Service Licenses The section displays the hosted users and the trunk users. Both consume user licenses.

The Service column displays the list of services within the service license pack. When the Include Single
Service Usage Details check box is not checked, the list is not displayed and the only row displayed
shows the total of all services. In the example above, the check box was checked. The Licensed and
Available columns are only present when the report is constructed for one cluster or all clusters, but are not
displayed when the report is configured with a service provider/enterprise, group, or user selected.
To view a printable version of the report:
Click Printable View. The report appears in a new window in a printable format. You can print the report
from this window.
To view a PDF version of the report:
Click PDF View. The report appears in a new window in a PDF format. You can print the report from this
window.

12.2.5 Configure Reverse Lookup Report

This report provides a reverse view of the data, depending on the selected criteria. Since the usage report
displays a number of allocated licenses for group and user services, the reverse lookup view displays the

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 452
 list of Application Server clusters, enterprises, groups, or users that has a particular service or service
license pack assigned and depends on the report level selected.
For example, if the report is done for a particular enterprise and the lookup is applied on a user, it shows all
the users for the enterprise that has the service or service license pack assigned. Since the EMS contains
the knowledge of the network, the reverse lookup can also be applied on the Application Server cluster,
and it lists all clusters that have at least one user or group with a service or service license pack assigned
to it.
The report level corresponds to the Application Server cluster, service provider/enterprise, or group
selected. If no Application Server cluster is selected, the report level is "network". The reverse lookup
can be applied on two different criterion: service licenses or service license packs. Multiple selections of
services or service license packs are allowed to produce the report. Since service licenses are separated
into group licenses, virtual licenses, and user licenses, it is only possible to select services at the same
level. The level is shown in parentheses after the service's name. When multiple service licenses or
service license packs are selected, the reverse lookup report displays the list of Application Server
clusters, enterprises, groups, or users that have all of them assigned.
Use the Reverse Lookup Configuration page to configure a reverse lookup report.

Figure 234: Reverse Lookup Configuration

The information on this page includes the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 453
 Input Box Description

Report Name This input box specifies the name of the report.

Report Format This drop-down list identifies the format of the report. Valid values include: "HTML", "XML", "CSV", or
"PDF".

Date This drop-down list provides the ability to select the date on which the EMS takes the data to generate
the report. Valid values include all of the available dates for which the EMS has data. If the EMS has
not collected any data yet, the drop-down list is empty and the other input boxes are disabled.

AS Cluster This drop-down list provides the ability to select the Application Server cluster. It is disabled until
the date is selected. Valid values include the list of all Application Server clusters for which the EMS
has data for the selected date. "ALL" is a possible value to display a network report that contains
information of all listed Application Server clusters.

Service Provider/ This input box provides the ability to select the service provider/enterprise. It is disabled until the
Enterprise Application Server cluster is selected and not set to "ALL". Auto completion is activated by pressing
the SPACEBAR when the cursor is in the input box. An empty value means that all service providers/
enterprises should be taken into account.

Group This input box provides the ability to select the group. It is disabled until a service provider/enterprise
is selected. Auto completion is activated by pressing the SPACEBAR when the cursor is in the input
box. An empty value means that all groups should be taken into account.

Reverse Lookup Level This drop-down list determines whether the report displays the list of clusters, enterprises, groups,
or users. Possible values include "AS Cluster", "Service Provider/Enterprise", "Group", and "User".
The possible values are automatically adjusted depending on whether an Application Server cluster,
service provider/enterprise, or group is selected in the previous input boxes.

Service License-based This input box provides the ability to include service licenses in a reverse lookup report. Click Edit to
Reverse Lookup select the service licenses to include in the reverse lookup from the Service Licenses Selection on
page 455 page.

Service License Pack- This input box provides the ability to include service license packs in a reverse lookup report. Click
based Reverse Lookup Edit to select the service license packs to include in the reverse lookup from the Service License
Packs Selection on page 457 page.

Frequency Type This drop-down list provides the ability to select the frequency of the generation of the report. It
is disabled until Periodic Report Generation is checked. Valid values include "Never", "Monthly",
"Weekly", and "Daily". The default value is "Never".

Frequency Value This input box provides the ability to select the day of the month, the week day, and the time of day
depending on the frequency type. It is disabled until Periodic Report Generation is checked. Valid
values include:
• Day of the Month: 1 through 31
• Week Day: Monday through Sunday
• Time of Day: 0:00 through 23:00.

Mail Report This input box provides the ability to send the generated reports to an e-mail distribution list. The e-
mail distribution list is configured under Configure E-mail Distribution Lists on page 338.

To create a reverse lookup report:

1) Click the Centralized Networking tab and select the License Reporting submenu.
2) Click Reverse Lookup Configuration. The Reverse Lookup Configuration page appears.
3) In the Report Name input box, enter the report name.
4) In the Report Format input box, select the report format.
5) In the Date drop-down list, select the date.
6) In the AS Cluster drop-down list, select the Application Server cluster(s) to include in the report.
7) In the Service Provider/Enterprise input box, select the service providers (or enterprises) to include in
the report.
8) In the Group input box, select the group(s) to include in the report.
9) From the Reverse Lookup Level drop-down list, select the lookup level.
10)To create a reverse lookup on particular services:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 454
 a) Select Service License-based Reverse Lookup.
b) Click Edit. The Service Licenses Selection page appears.
c) Select the services as described on the Service Licenses Selection on page 455 page.
11)To create a reverse lookup on particular license packs:
a) Select Service License Pack-based Reverse Lookup.
b) Click Edit. The Service License Packs Selection page appears.
c) Select the services as described on the Service License Packs Selection on page 457 page.
12)To generate the report, click Generate. The Reverse Lookup Details on page 458 page appears with
the report on the list. Click on the corresponding link to view the report.
13)To schedule a recurring report:
a) In the Report Name input box, enter the name of the report.
b) From the Frequency Type drop-down list, select the frequency of the generation of the report.
c) In the Frequency Value input boxes, specify the details of the schedule for report generation.

NOTE: If this is a one-off report, select "Never".

14)To mail the report to an e-mail recipient, check the Mail Report check box and select the recipient from
the drop-down list.
15)Click Save to save these changes or Reset to reset the values to the previous settings.

12.2.5.1 Service Licenses Selection

Use the Service Licenses Selection page to select the service licenses to include in a reverse lookup
report.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 455
 Figure 235: Service Licenses Selection

The information on this report includes the following:

Section Description

Available Service Licenses This list displays the service licenses that are available to report on.

Selected Service Licenses This list displays the services licenses that are included to report on.

Has One Of This section input box specifies that the report is based on one of the selected service licenses.
Otherwise, it is based on all of the selected service licenses.

To identify the services to include in the Service-based Reverse Lookup Report:

1) In the Available Service Licenses list, select the services to include in the report:
a) Use the right arrow to move a service to the Selected Service Licenses list.

NOTE: You can select more than one service at a time. Press Shift to select several services that
are sequentially listed or press Ctrl to select specific services.

b) To include any of the services in the report (as opposed to all the selected services), click Has One
Of.
2) Click Save to save the changes or click Cancel to disregard the modifications to this page. The
previous page appears.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 456
12.2.5.2 Service License Packs Selection
Use the Service License Packs Selection page to select the service license packs to include in a reverse
lookup report.

Figure 236: Service License Pack Selection

The information on this report includes the following:

Section Description

Available Service License This list displays the service license packs that are available to report on.
Packs

Selected Service License This list displays the service license packs that are included to report on.
Packs

Has One Of This check box specifies that the report is based on one of the selected service license packs.
Otherwise, it is based on all of the selected service license packs.

To identify the service license packs to include in the Service License Pack-based Reverse Lookup
Report:
1) In the Available Service License Packs list, select the service license packs to include in the report:
a) Use the right arrow to move a service license pack to the Selected Service License Packs list.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 457
 NOTE: You can select more than one service license pack at a time. Press Shift to select several
service license packs that are sequentially listed or press Ctrl to select specific service license
packs.

b) To include any of the service license packs in the report (as opposed to all the selected service
license packs), check Has One Of.
2) Click Save to save the changes or click Cancel to disregard the modifications to this page. The
previous page appears.

12.2.5.3 Reverse Lookup Details

Use the Reverse Lookup Report page to view the details of a reverse lookup report.

Figure 237: Reverse Lookup Report

The information on this page includes the following:

Column Description

Header This section displays the report-selected values for the date, Application Server cluster, and names
of the service licenses/service license packs.

AS Cluster ID This section displays the Application Server cluster IDs.

Since it is possible to select multiple service licenses or service license packs, the EMS displays only the
first ten in the header and adds a "…" link that displays all of them.
The list of Application Server clusters, service providers/enterprises, groups, or users can be very long on
a reverse lookup report. The EMS displays the HTML report results on many pages with 50 items per page
separated in two columns. Possible options for the page length are "50", "100", "250", "500", and "1000".
To view a printable version of the report:
Click Printable View. The report appears in a new window in a printable format. You can print the report
from this window.
To view a PDF version of the report:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 458
 Click PDF View. The report appears in a new window in a PDF format. You can print the report from this
window.

12.2.6 View Periodic Report Results

This page displays the list of periodic reports generated using the Usage Report Configuration or Reverse
Lookup Configuration page. These reports are scheduled and each instance is accessible by its history.

NOTE: Non-periodic reverse lookup reports can be accessed through the Reverse Lookup Results page.
For information on reverse lookup reports, see View Reverse Lookup Report Results on page 489.

Use this page to view periodic usage and reverse lookup reports.

Figure 238: Periodic Reports

The information on this page includes the following:

Column Description

Name This column displays the name of the periodic report. It is also a link to access the periodic report
configuration.

View Historical Reports This column displays a link to access the historical reports.

To access the periodic report results:

1) Click the Centralized Networking tab and select the License Reporting submenu.
2) Click Periodic Reports Results. The Periodic Reports Results page appears.
To view the history of a report:
On the Periodic Reports Results page, click the View link on the row of the report to display.

NOTE: The status of the report must be "Completed" to display a link to click.

To view a report:
1) On the Periodic Reports Results page, click the View link on the row of the report to display. The
Historical Report Management page appears.
2) Click the Date link on the row of the report to view. The Usage Report page displays the report.
To delete a report result:
1) On the Periodic Reports Results page, click the View link on the row of the report to display. The
Historical Report Management page appears.
2) Click the check box on the row of the report to delete.
3) Click Delete Report. The report is removed from the list of historical reports.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 459
 To modify the configuration of a report:
1) On the Periodic Reports Results page, click the name of the report configuration to modify.
2) Modify the input boxes as required.
3) Click Save to save these changes or Reset to reset the values to the previous settings.
To delete a report configuration:
1) On the Periodic Reports Results page, to delete a report, click the check box for the report.
2) Click Delete Report. The report is removed from the list of reports.
For more information

12.2.6.1 Examples of Periodic Reports

There are many possible configurations of periodic reports. This section includes examples of the
configuration and formats of periodic reports.
For more information
12.2.6.1.1 HTML License – Network Report
This page displays an example of the License – Network Report in HTML format.

Figure 239: HTML License – Network Report (1)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 460
 Figure 240: HTML License – Network Report (2)

Figure 241: HTML License – Network Report (3)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 461
 Figure 242: HTML License – Network Report (4)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 462
 Figure 243: HTML License – Network Report (5)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 463
 Figure 244: HTML License – Network Report (6)

The information on this report includes the following:

Section Description

Header This section displays the date the report was generated and the selected values of the date,
Application Server cluster, service provider/enterprise, group, and user.

Purchased Products This section displays a summary of the consumption (percentage of licenses available) of
Dashboard purchased products in a bar chart format.

NOTE: This Purchased Products section only aggregates Application Server clusters that have
product information in license files.

Purchased Products Details This section displays the list of all products with the product name, the type, the number of licenses
purchased, the number of licenses used, the number of licenses available, the percentage of
licenses available, a breakdown of the list of licenses available in service license packs, and the
name and quantity of service license packs for each product.

Subscriber Licenses This section displays the number of licenses, the number of licenses used, the number licenses
remaining, and the percentage of licenses remaining by the user, trunk group, and group. Note that
the trunk group user does not count as a user license.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 464
 Section Description

Trunking Call Capacity This section displays information on trunking call capacity. The Licensed column indicates the
maximum number of simultaneous trunk group calls that are allowed, that is, the license quantity
of Business Trunking License Units (BTLU). The Used, Available, and % Remaining columns
indicate the number of licenses used, the number licenses remaining, and the percentage of
licenses remaining, respectively. The first row displays trunking call capacity at the system level.
The remaining rows consist of a breakdown of the list for enterprises, service providers, and groups.
The calculation of used BTLUs (Trunking) is based on the following rules:
• The trunking call capacity licensed at the system level can be distributed (assigned) to
enterprise and service providers.
• Any trunking call capacity (in the number of calls) assigned to an enterprise directly consumes
the same number of BTLUs. This is independent from whether or not the trunking call capacity
is in turn assigned to groups of the enterprise.
• Any runking call capacity (in the number of calls) assigned to a service provider has no effect
on the consumption of BTLUs. This number limits the total amount of BTLUs that the service
provider can redistribute to its groups.
• Any trunking call capacity (in number of calls) assigned to a group of a service provider directly
consumes the same number of BTLUs.
Thus, the quantity of used BTLUs at the system level is as follows:
Used = sum (BTLUs assigned to enterprise) + sum (BTLUs assigned to group of a service provider)

Group Service Licenses This section displays the list of all group license packs and services, including how many are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs and services, including how many of each are
consumed. It is not displayed when the report is generated for a given user.

User Service Licenses The section displays the hosted users and the trunk users. Both consume user licenses.

12.2.6.1.2 HTML License – AS Cluster Report

This page displays an example of the License – AS Cluster Report in HTML format.

Figure 245: HTML License – AS Cluster Report (1)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 465
 Figure 246: HTML License – AS Cluster Report (2)

Figure 247: HTML License – AS Cluster Report (3)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 466
 Figure 248: HTML License – AS Cluster Report (4)

Figure 249: HTML License – AS Cluster Report (5)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 467
 Figure 250: HTML License – AS Cluster Report (6)

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 468
 Figure 251: HTML License – AS Cluster Report (7)

The information on this report includes the following:

Section Description

Header This section displays the date the report was generated and the selected values of the Application
Server cluster.

Purchased Products This section displays a summary of the consumption (percentage of licenses available) of
Dashboard purchased products in a bar chart format.

Purchased Products Detail This section displays the list of all products with the product name, the type, the number of licenses
purchased, the number of licenses used, the number of licenses available, the percentage of
licenses available, a breakdown of the list of licenses available in service license packs, and the
name and quantity of service license packs for each product.

Outlying Users This section displays the outlying users with following columns: ServiceProvider /Enterprise, Group,
UserId, Reason, Details. The Reason column contains the name of the outlying category. The
Details column lists the applicable packs or products. Not all outlying users are listed in the report.
The Outlying Users Maximum Number configuration parameter determines the maximum number of
users to be listed. The value "0" is valid and the result is that the outlying user list does not appear
in the report.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 469
 Section Description

Subscriber Licenses This section displays the number of licenses, the number of licenses used, the number licenses
remaining, and the percentage of licenses remaining by user, trunk group, and group. Note that the
trunk group user does not count as a user license.

Trunking Call Capacity This section displays information on trunking call capacity. The Licensed column indicates the
maximum number of simultaneous trunk group calls that are allowed, that is, the license quantity
of Business Trunking License Units (BTLU). The Used, Available, and % Remaining columns
indicate the number of licenses used, the number licenses remaining, and the percentage of
licenses remaining, respectively. The first row displays trunking call capacity at the system level.
The remaining rows consist of a breakdown of the list for enterprises, service providers, and groups.
The calculation of used BTLUs (Trunking) is based on the following rules:
• The trunking call capacity licensed at the system level can be distributed (assigned) to
enterprise and service providers.
• Any trunking call capacity (in the number of calls) assigned to an enterprise directly consumes
the same number of BTLUs. This is independent from whether or not the trunking call capacity
is in turn assigned to groups of the enterprise.
• Any runking call capacity (in the number of calls) assigned to a service provider has no effect
on the consumption of BTLUs. This number limits the total amount of BTLUs that the service
provider can redistribute to its groups.
• Any trunking call capacity (in number of calls) assigned to a group of a service provider directly
consumes the same number of BTLUs.
Thus, the quantity of used BTLUs at the system level is as follows:
Used = sum (BTLUs assigned to enterprise) + sum (BTLUs assigned to group of a service provider)

Group Service Licenses This section displays the list of all group service license packs and services, including how many are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs and services, including how many of each are
consumed. It is not displayed when the report is generated for a given user.

User Service Licenses The section displays the hosted users and the trunk users. Both consume user licenses.

12.2.6.1.3 HTML License – Service Provider Report

This page displays an example of the License – Service Provider Report in HTML format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 470
 Figure 252: HTML License – Service Provider Report

The information on this page includes the following:

Section Description

Header This section displays the date the report was generated and the selected values of the date,
Application Server cluster, and service provider/enterprise.

Subscriber Licenses This section displays the number of user licenses, trunk group users, and group licenses that the
system can have (licensed), in addition to the number used and how many are left. Note that the trunk
group user does not count as a user license.

Group Service Licenses This section displays the list of all group service license packs and services, including how many are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs. It is not displayed when the report is generated for a
given user.

User Service Licenses The section displays the hosted users and the trunk users.

12.2.6.1.4 HTML License – Group Report

This page displays an example of the License – Group Report in HTML format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 471
 Figure 253: HTML License – Group Report

The information on this page includes the following:

Section Description

Header This section displays the date the report was generated and the selected values of the Application
Server cluster and group.

Subscriber Licenses This section displays the number of user licenses, trunk group users, and group licenses that the
system can have (licensed), in addition to the number used and how many are left. Note that the trunk
group user does not count as a user license.

Group Service Licenses This section displays the list of all group service license packs and services, including how many are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs. It is not displayed when the report is generated for a
given user.

12.2.6.1.5 HTML License – User Report

This page displays an example of the License – User Report in HTML format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 472
 Figure 254: HTML License – User Report

The information on this page includes the following:

Section Description

Header This section displays the date the report was generated and the selected values of the date,
Application Server cluster, and user.

User Service Licenses The section displays the hosted and trunk users.

12.2.6.1.6 CSV License – Network Report

This page displays an example of the License – Network Report in CSV format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 473
 Figure 255: CSV License – Network Report

The information on this report includes the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 474
 Section Description

Header This section displays the date the report was generated and the selected values indicating the date,
Application Server cluster, service provider/enterprise, group, and user.

Purchased Products Detail This section displays the list of all products with the product name, the type, the number of licenses
purchased, the number of licenses used, the number of licenses available, the percentage of
licenses available, a breakdown of the list of licenses available in service license packs, and the
name and quantity of service license packs for each product.

Subscriber Licenses This section displays the number of user licenses, trunk group users, and group licenses that the
system can have (licensed), in addition to the number used and how many are left. Note that the
trunk group user does not count as a user license.

Trunking Call Capacity TThis section displays information on trunking call capacity. The Licensed column indicates the
maximum number of simultaneous trunk group calls that are allowed, that is the quantity of Business
Trunking License Units (BTLU) licenses. The Used, Available, and % Remaining columns indicate
the number of licenses used, the number of licenses remaining, and the percentage of licenses
remaining. The first row displays the trunking call capacity at the system level. Additional rows
display the breakdown for enterprises, service providers, and groups.
The calculation of used BTLUs is based on the following rules:
• Any trunking call capacity licensed at the system-level can be distributed (assigned) to
enterprises and service providers.
• Any trunking call capacity (in number of calls) assigned to an enterprise directly consumes
the same number of BTLUs. This is independent of whether or not the trunking call capacity is
assigned to groups of the enterprise.
• Any trunking call capacity (in number of calls) assigned to a service provider has no effect on the
consumption of BTLUs. This number limits the total amount of BTLUs that the service provider
can redistribute to its groups.
• Any trunking call capacity (in number of calls) assigned to a group of a service provider directly
consumes the same number of BTLUs.
The quantity of used BTLUs at the system-level is:
Used = sum (BTLUs assigned to enterprise) + sum (BTLUs assigned to group within a service
provider)

Group Service Licenses This section displays the list of all group service license packs and services, including how many are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs and services, including how many of each are
consumed. It is not displayed when the report is generated for a given user.

User Service Licenses The section displays the hosted users and the trunk users. Both consume user licenses.

12.2.6.1.7 CSV License – AS Cluster Report

This page displays an example of the License – AS Cluster Report in CSV format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 475
 Figure 256: CSV License – AS Cluster Report

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 476
 The information on this report includes the following:
Section Description

Header This section displays the date the report was generated and the selected values of the Application
Server cluster.

Purchased Products Detail This section displays the list of all products with the product name, the type, the number of licenses
purchased, the number of licenses used, the number of licenses available, the percentage of
licenses available, a breakdown of the list of licenses available in service license packs, and the
name and quantity of service license packs for each product.

Outlying Users This section displays the outlying users with following columns: ServiceProvider/Enterprise, Group,
UserId, Reason, Details. The Reason column contains the name of the outlying category. The Details
column lists the applicable packs or products. Not all outlying users are listed in the report. The
Outlying Users Maximum Number configuration parameter determines the maximum number of
users to be listed. The value "0" is valid and the result is that it does not show the outlying user list in
the report.

Subscriber Licenses This section displays the number of user licenses, trunk group users, and group licenses that the
system can have (licensed) in addition to the number used and how many are left. Note that the
trunk group user does not count as a user license.

Trunking Call Capacity This section displays information on trunking call capacity. The Licensed column indicates the
maximum number of simultaneous trunk group calls that are allowed, that is the quantity of Business
Trunking License Units (BTLU) licenses. The Used, Available, and % Remaining columns indicate
the number of licenses used, the number of licenses remaining, and the percentage of licenses
remaining. The first row displays the trunking call capacity at the system level. Additional rows
display the breakdown for enterprises, service providers, and groups.
The calculation of used BTLUs is based on the following rules:
• Any trunking call capacity licensed at the system-level can be distributed (assigned) to
enterprises and service providers.
• Any trunking call capacity (in number of calls) assigned to an enterprise directly consumes
the same number of BTLUs. This is independent of whether or not the trunking call capacity is
assigned to groups of the enterprise.
• Any trunking call capacity (in number of calls) assigned to a service provider has no effect on the
consumption of BTLUs. This number limits the total amount of BTLUs that the service provider
can redistribute to its groups.
• Any trunking call capacity (in number of calls) assigned to a group of a service provider directly
consumes the same number of BTLUs.
The quantity of used BTLUs at the system-level is:
Used = sum (BTLUs assigned to enterprise) + sum (BTLUs assigned to group within a service
provider)

Group Service Licenses This section displays the list of all group license packs and services, including how many are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs and services, including how many of each are
consumed. It is not displayed when the report is generated for a given user.

User Service Licenses The section displays the hosted users and the trunk users. Both consume user licenses.

12.2.6.1.8 CSV License – Service Provider Report

This page displays an example of the License – Service Provider Report in CSV format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 477
 Figure 257: CSV License – Service Provider Report

The information on this page includes the following:

Section Description

Header This section displays the date the report was generated and the selected values of the date,
Application Server cluster, and service provider/enterprise.

Subscriber Licenses This section displays the number of user licenses, trunk group users, and group licenses that the
system can have (licensed), in addition to the number used and how many are left. Note that the trunk
group user does not count as a user license.

Group Service Licenses This section displays the list of all group license packs and services, including how many are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs. It is not displayed when the report is generated for a
given user.

User Service Licenses The section displays the hosted users and the trunk users.

12.2.6.1.9 CSV License – Group Report

This page displays an example of the License – Group Report in CSV format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 478
 Figure 258: CSV License – Group Report

The information on this page includes the following:

Section Description

Header This section displays the date the report was generated and the selected values of the Application
Server cluster and group.

Subscriber Licenses This section displays the number of user licenses, trunk group users, and group licenses that the
system can have (licensed), in addition to the number used and how many are left. Note that the trunk
group user does not count as a user license.

Group Service Licenses This section displays the list of all group service license packs and services, including how many are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs. It is not displayed when the report is generated for a
given user.

12.2.6.1.10 CSV License – User Report

This page displays an example of the License – User Report in CSV format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 479
 Figure 259: CSV License – User Report

The information on this page includes the following:

Section Description

Header This section displays the date the report was generated and the selected values of the date,
Application Server cluster, and user.

Purchased Products This section displays the list of all products and how many are consumed.

User Service Licenses The section displays the hosted and trunk users.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 480
12.2.6.1.11 XML License – Network Report
This page displays an example of the License – Network Report in XML format.

Figure 260: XML License – Network Report

The information on this report includes the following:

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 481
 Section Description

Header This section displays the date the report was generated and the selected values of the date,
Application Server cluster, service provider/enterprise, group, and user.

Utilization Zones This section displays the thresholds that trigger the presentation of the percentage remaining (of the
licenses and products) in the colors red, yellow, and green.

Products Utilization This section displays the file location of the bar chart images that present the percentage remaining
Dashboard File of the licenses and products.

Purchased License This section displays the list of all products with the product name, the type, the number of licenses
Definition purchased, the number of licenses used, the number of licenses available, the percentage of
licenses available, a breakdown of the list of licenses available in service license packs, and the
name and quantity of service license packs for each product.

Subscriber Licenses This section displays the number of licenses, the number of licenses used, the number licenses
remaining, and the percentage of licenses remaining by user, trunk group, and group. Note that the
trunk group user does not count as a user license.

Trunking Call Capacity This section displays information on trunking call capacity. The Licensed column indicates the
maximum number of simultaneous trunk group calls that are allowed, that is the quantity of Business
Trunking License Units (BTLU) licenses. The Used, Available, and % Remaining columns indicate
the number of licenses used, the number of licenses remaining, and the percentage of licenses
remaining. The first row displays the trunking call capacity at the system level. Additional rows
display the breakdown for enterprises, service providers, and groups.
The calculation of used BTLUs is based on the following rules:
• Any trunking call capacity licensed at the system-level can be distributed (assigned) to
enterprises and service providers.
• Any trunking call capacity (in number of calls) assigned to an enterprise directly consumes
the same number of BTLUs. This is independent of whether or not the trunking call capacity is
assigned to groups of the enterprise.
• Any trunking call capacity (in number of calls) assigned to a service provider has no effect on the
consumption of BTLUs. This number limits the total amount of BTLUs that the service provider
can redistribute to its groups.
• Any trunking call capacity (in number of calls) assigned to a group of a service provider directly
consumes the same number of BTLUs.
The quantity of used BTLUs at the system-level is:
Used = sum (BTLUs assigned to enterprise) + sum (BTLUs assigned to group within a service
provider)

Group Service Licenses This section displays the list of all group license packs and services, including how many of each are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs and services, including how many of each are
consumed. It is not displayed when the report is generated for a given user.

User Service Licenses The section displays the hosted users and the trunk users. Both consume user licenses.

12.2.6.1.12 XML License – AS Cluster Report

This page displays an example of the License – AS Cluster Report in XML format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 482
 Figure 261: XML License – AS Cluster Report

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 483
 The information on this report includes the following:
Section Description

Header This section displays the date the report was generated and the selected values of the Application
Server cluster.

Utilization Zones This section displays the thresholds that trigger the presentation of the percentage remaining (of the
licenses and products) in the colors red, yellow, and green.

Products Utilization This section displays the file location of the bar chart images that present the percentage remaining
Dashboard File of the licenses and products.

Purchased License This section displays the list of all products with the product name, the type, the number of licenses
Definition purchased, the number of licenses used, the number of licenses available, the percentage of
licenses available, a breakdown of the list of licenses available in service license packs, and the
name and quantity of service license packs for each product.

Outlying Users This section displays the outlying users with following columns: ServiceProvider/Enterprise, Group,
UserId, Reason, Details. The Reason column contains the name of the outlying category. The Details
column lists the applicable packs or products. Not all outlying users are listed in the report. The
Outlying Users Maximum Number configuration parameter determines the maximum number of
users to be listed. The value "0" is valid and as a result does not show the outlying user list in the
report.

Subscriber Licenses This section displays the number of user licenses, trunk group users, and group licenses that the
system can have (licensed) in addition to the number used and how many are left. Note that the trunk
group user does not count as a user license.

Trunking Call Capacity This section displays information on trunking call capacity. The Licensed column indicates the
maximum number of simultaneous trunk group calls that are allowed, that is the quantity of Business
Trunking License Units (BTLU) licenses. The Used, Available, and % Remaining columns indicate
the number of licenses used, the number of licenses remaining, and the percentage of licenses
remaining. The first row displays the trunking call capacity at the system level. Additional rows
display the breakdown for enterprises, service providers, and groups.
The calculation of used BTLUs is based on the following rules:
• Any trunking call capacity licensed at the system-level can be distributed (assigned) to
enterprises and service providers.
• Any trunking call capacity (in number of calls) assigned to an enterprise directly consumes
the same number of BTLUs. This is independent of whether or not the trunking call capacity is
assigned to groups of the enterprise.
• Any trunking call capacity (in number of calls) assigned to a service provider has no effect on the
consumption of BTLUs. This number limits the total amount of BTLUs that the service provider
can redistribute to its groups.
• Any trunking call capacity (in number of calls) assigned to a group of a service provider directly
consumes the same number of BTLUs.
The quantity of used BTLUs at the system-level is:
Used = sum (BTLUs assigned to enterprise) + sum (BTLUs assigned to group within a service
provider)

Group Service Licenses This section displays the list of all group license packs and services, including how many of each are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs and services, including how many of each are
consumed. It is not displayed when the report is generated for a given user.

User Service Licenses The section displays the hosted users and the trunk users. Both consume user licenses.

12.2.6.1.13 XML License – Service Provider Report

This page displays an example of the License – Service Provider Report in XML format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 484
 Figure 262: XML License – Service Provider Report

The information on this page includes the following:

Section Description

Header This section displays the date the report was generated and the selected values of the date,
Application Server cluster, and service provider/enterprise.

Subscriber Licenses This section displays the number of user licenses, trunk group users, and group licenses that the
system can have (licensed), in addition to the number used and how many are left. Note that the trunk
group user does not count as a user license.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 485
 Section Description

Group Service Licenses This section displays the list of all group license packs and services, including how many are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs. It is not displayed when the report is generated for a
given user.

User Service Licenses The section displays the hosted users and the trunk users.

12.2.6.1.14 XML License – Group Report

This page displays an example of the License – Group Report in XML format.

Figure 263: XML License – Group Report

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 486
 The information on this page includes the following:
Section Description

Header This section displays the date the report was generated and the selected values of the Application
Server cluster and group.

Subscriber Licenses This section displays the number of user licenses, trunk group users, and group licenses that the
system can have (licensed), in addition to the number used and how many are left. Note that the trunk
group user does not count as a user license.

Group Service Licenses This section displays the list of all group license packs and services, including how many are
consumed. It is not displayed when the report is generated for a given user.

Virtual Service Licenses This section displays the virtual license packs. It is not displayed when the report is generated for a
given user.

12.2.6.1.15 XML License – User Report

This page displays an example of the License – User Report in XML format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 487
 Figure 264: XML License – User Report

The information on this page includes the following:

Section Description

Header This section displays the date the report was generated and the selected values of the date,
Application Server cluster, and user.

User Service Licenses The section displays the hosted and trunk users.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 488
12.2.7 View Reverse Lookup Report Results
This page displays the list of reverse lookup reports generated using the Reverse Lookup Configuration
page. These reports were generated once and are not scheduled to run again. Generated reverse lookup
reports can be deleted from this page. The status of each report is displayed.

NOTE: There can only be one reverse lookup in progress at any time.

Use the Reverse Lookup Results page to display the list of all non-periodic reverse lookup reports.

Figure 265: Reverse Lookup Results

The information on this page includes the following:

Column Description

Name This column displays the name of the reverse lookup report.

Date This column displays the date the report was generated.

Time Started This column displays the time of day the generation of the report began.

Status This column displays the status of the generation of the report.

To access the reverse lookup results:

1) Click the Centralized Networking tab and select the License Reporting submenu.
2) Click Reverse Lookup Results. The Reverse Lookup Results page appears.
To view a report:
On the Reverse Lookup Results page, click the name of the report to display. The Reverse Lookup Report
page displays the report.

NOTE: The status of the report must be "Completed" to display a link to click.

To delete a report:
1) On the Reverse Lookup Results page, to delete a report, click the check box for the report.
2) Click Delete. The report is removed from the list of reverse lookup results.
For more information

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 489
12.2.7.1 Examples of Reverse Lookup Reports
There are many possible configurations of reverse lookup reports. This section includes examples of the
configuration and formats of reverse lookup reports.
For more information
12.2.7.1.1 HTML– Reverse Lookup AS Cluster Report
This page displays an example of the HTML– Reverse Lookup AS Cluster Report in HTML format.

Figure 266: HTML – Reverse Lookup AS Cluster Report

The information on this page includes the following:

Column Description

Header This section displays the report-selected values for the date, Application Server cluster, and names of
the service licenses/service license packs.

AS Cluster ID This section displays the Application Server cluster IDs.

12.2.7.1.2 HTML – Reverse Lookup Service Provider Report

This page displays an example of the Reverse Lookup Service Provider Report for the network in HTML
format.

NOTE: You can also create a report to include the service providers in an Application Server cluster.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 490
 Figure 267: HTML Reverse Lookup Service Provider Report

The information on this page includes the following:

Column Description

Header This section displays the report-selected values for the date, Application Server cluster, and names of
the service licenses/service license packs.

Service Provider/ This section displays the service provider/enterprise IDs.

Enterprise ID

12.2.7.1.3 HTML – Reverse Lookup Group Report

This page displays an example of the Reverse Lookup Group Report in HTML format.

NOTE: You can also create a report to include the groups in an Application Server cluster or for a service
provider.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 491
 Figure 268: HTML Reverse Lookup Group Report

The information on this page includes the following:

Section Description

Header This section displays the report-selected values for the date, Application Server cluster, and names of
the service licenses/service license packs.

Group ID This section displays the list of group IDs.

12.2.7.1.4 HTML – Reverse Lookup User Report

This page displays an example of the Reverse Lookup User Report for the whole network in HTML format.

NOTE: You can also create a report to include the users in an Application Server cluster, service provider,
or group.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 492
 Figure 269: HTML Reverse Lookup User Report

The information on this page includes the following:

Column Description

Header This section displays the report-selected values for the date, Application Server cluster, and names of
the service licenses/service license packs.

User ID This section displays the user IDs.

12.2.7.1.5 CSV – Reverse Lookup AS Cluster Report

This page displays an example of the Reverse Lookup AS Cluster Report in CSV format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 493
 Figure 270: CSV Reverse Lookup AS Cluster Report

The information on this page includes the following:

Column Description

Header This section displays the report-selected values for the date, Application Server cluster, and names of
the service licenses/service license packs.

AS Cluster ID This section displays the Application Server cluster IDs.

12.2.7.1.6 CSV – Reverse Lookup Service Provider Report

This page displays an example of the Reverse Lookup Service Provider Report in CSV format.

NOTE: You can also create a report to include the service providers in an Application Server cluster.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 494
 Figure 271: CSV Reverse Lookup Service Provider Report

The information on this page includes the following:

Column Description

Header This section displays the report-selected values for the date, Application Server cluster, and names of
the service licenses/service license packs.

Service Provider/ This section displays the service provider/enterprise IDs.

Enterprise ID

12.2.7.1.7 CSV – Reverse Lookup Group Report

This page displays an example of the Reverse Lookup Group Report in CSV format.

NOTE: You can also create a report to include the groups in an Application Server cluster or for a service
provider.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 495
 Figure 272: CSV Reverse Lookup Group Report

The information on this page includes the following:

Section Description

Header This section displays the report-selected values for the date, Application Server cluster, and names of
the service licenses/service license packs.

Group ID This section displays the list of group IDs.

12.2.7.1.8 CSV – Reverse Lookup User Report

This page displays an example of the Reverse Lookup User Report in CSV format.

NOTE: You can also create a report to include the users in an Application Server cluster, service provider,
or group.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 496
 Figure 273: CSV Reverse Lookup User Report

The information on this page includes the following:

Column Description

Header This section displays the report-selected values for the date, Application Server cluster, and names of
the service licenses/service license packs.

User ID This section displays the user IDs.

12.2.7.1.9 XML – Reverse Lookup AS Cluster Report

This page displays an example of the Reverse Lookup AS Cluster Report in XML format.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 497
 Figure 274: XML Reverse Lookup AS Cluster Report

The information on this page includes the following:

Column Description

Header This section displays the report-selected values for the date, Application Server cluster, and names of
the service licenses/service license packs.

AS Cluster ID This section displays the Application Server cluster IDs.

12.2.7.1.10 XML – Reverse Lookup Service Provider Report

This page displays an example of the Reverse Lookup Service Provider Report in XML format.

NOTE: You can also create a report to include the service providers in an Application Server cluster.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 498
 Figure 275: XML Reverse Lookup Service Provider Report

The information on this page includes the following:

Column Description

Header This section displays the report-selected values for the date, Application Server cluster, and names of
the service licenses/service license packs.

Service Provider/ This section displays the service provider/enterprise IDs.

Enterprise ID

12.2.7.1.11 XML – Reverse Lookup Group Report

This page displays an example of the Reverse Lookup Group Report in XML format.

NOTE: You can also create a report to include the groups in an Application Server cluster or for a service
provider.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 499
 Figure 276: XML Reverse Lookup Group Report

The information on this page includes the following:

Section Description

Header This section displays the report-selected values for the date, Application Server cluster, and names of
the service licenses/service license packs.

Group ID This section displays the list of group IDs.

12.2.7.1.12 XML – Reverse Lookup User Report

This page displays an example of the Reverse Lookup User Report in XML format.

NOTE: You can also create a report to include the Users in a Application Server cluster, service provider,
or group.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 500
 Figure 277: XML Reverse Lookup User Report

The information on this page includes the following:

Column Description

Header This section displays the report selected values for the date, Application Server cluster, and the
names of the service licenses/service license packs.

User ID This section displays the User IDs.

BROADWORKS EMS ADMINISTRATION GUIDE 10-BD5715-00

©2014 BROADSOFT, INC. PAGE 501