Professional Documents
Culture Documents
Release 20.0
Document Version 13
WWW.BROADSOFT.COM
BroadWorks® Guide
Copyright Notice
Copyright© 2018 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, Suite 350, Gaithersburg, MD 20878.
BroadSoft reserves the right to make changes without prior notice.
Trademarks
Any product names mentioned in this document may be trademarks or registered
trademarks of BroadSoft or their respective companies and are hereby acknowledged.
This document is printed in the United States of America.
14.0 1 Updated document for re-branding. March 15, 2006 Robb Surridge
14.0 1 Reformatted styles for re-branding. April 24, 2006 Roberta Boyle
14.0 1 Added material to section 9.1 Automatic June 28, 2006 Robb Surridge
Backups for EV 31273, added sys.odbc.ini
file to backup list; added paragraph to
section 9.1.3 Restore Auto-Backup.
INFO corrected to UPDATE for EV 31765
for bwAuditAbnormalCall-Termination in
section 19.3.6.4 SIP/MGCP Traps.
Added recommendation for
check_dbpages.pl script in section 10.5.4
Update TimesTen Database Paging
Information for EV 33301.
Corrected examples in section 6.1.2 View
System Alarms for EVs 33243 and 33195.
Updated section 14 Install BroadWorks
License Files for EV 32926.
Corrected importdb.pl example in section
10.3 Database Import for EV 34367.
14.0 1 Updated document with Release 14.0 July 20, 2006 Mario Goupil
content.
14.0 2 Added disaster recovery strategies, and August 29, 2006 Robb Surridge
minor textual updates to correct EV 34678.
14.0 2 Added CommonPersistency input channel September 11, 2006 Maxime Larose
parameters.
14.0 3 Added new section for EV 37043, (section March 15, 2007 Roberta Boyle
21.28 Software Manager Utilities).
Changed note for EV 37037 in section
8.1.1 Display Full Details about Active
Software Versions and added text about
-showPatch option in section 21.5
bwshowver.
Added warning in section 21.23 stopbw for
EV 39877.
14.0 4 Modified document based on Release 14 May 11, 2007 Tony Pilote
config-network changes.
14.0 5 Added BEA WebLogic information. June 12, 2007 Martin Bernier
14.0 5 Edited changes and published document. June 20, 2007 Andrea Fitzwilliam
14.0 6 Corrected log file names for BEA for June 26, 2007 Martin Bernier
EV 49826.
14.0 6 Added section on removing peer from July 3, 2007 Roberta Boyle
redundant system for EV 50350.
14.0 6 Edited changes and published document. July 6, 2007 Andrea Fitzwilliam
14.0 7 Updated section 9.1.3 Restore Auto- July 12, 2007 Martin Bernier
Backup to indicate that the backup restore
must be executed as root when done in the
system root directory for EV 50841.
14.0 7 Updated section 20.9 config-network to July 27, 2007 Patricia Renaud
add a note for HTTP Alias CLI command
for EV 38723.
14.0 7 Edited changes and published document. July 27,2007 Patricia Renaud
14.0 8 Updated section 5.3.3 Enable TimesTen August 30, 2007 Roberta Boyle
Logs for EV 49372.
14.0 9 Added missing CMS-related information in September 18, 2007 Tony Pilote
section 4 BroadWorks Processes.
14.0 9 Edited changes and published document. September 18, 2007 Patricia Renaud
14.0 10 Updated section 20.9 config-network for October 9, 2007 Roberta Boyle
EV 50203.
14.0 10 Added section 22.2 Adjust BroadWorks October 9, 2007 Roberta Boyle
Daylight Savings Time for EV 50504.
14.0 10 Updated section 14 Install BroadWorks October 16, 2007 Roberta Boyle
License Files for EV 54430.
14.0 10 Changed DevDebug to Debug in section October 16, 2007 Roberta Boyle
5.1.1 Log Severity for EV 53781.
14.0 10 Edited changes and published document. October 29, 2007 Andrea Fitzwilliam
14.0 11 Updated BEA Java GC logs information. February 8, 2008 Martin Bernier
14.0 11 Edited changes and published document. February 12, 2008 Andrea Fitzwilliam
14.0 12 Added section 9.1.1 Configure Basic February 13, 2008 Roberta Boyle
Maintenance Tasks for EV 59029.
14.0 12 Updated section 5.1.7 Media Server for February 20, 2008 Roberta Boyle
EV 59375.
14.0 12 Created section Optimization TimesTen March 13, 2008 Roberta Boyle
Checkpoint for EV 59930.
14.0 12 Edited changes and published document. March 24, 2008 Andrea Fitzwilliam
14.0 13 Added section 12.2.3.4 Xtended Services April 4, 2008 Martin Bernier
Platform Replacement.
14.0 13 Edited changes and published document. April 16, 2008 Andrea Fitzwilliam
14.0 14 Added a description of all the input May 1, 2008 Tony Pilote
channels used by BroadWorks.
14.0 14 Edited changes and published document. May 2, 2008 Andrea Fitzwilliam
14.0 15 Added Profile Server impacts. May 27, 2008 Yves Racine
14.0 15 Edited changes and published document. May 2, 2008 Andrea Fitzwilliam
15.0 1 Updated document for Release 15.0. July 9, 2008 Mario Goupil
15.0 1 Edited changes since Release 14.0, July 16, 2008 Andrea Fitzwilliam
removed references to CMS, and
published document.
15.0 2 Added configuration of CCR allowed proxy October 7, 2008 Frederic Lelievre
URLs in config-network tool and changed
Apache/Tomcat log files locations.
15.0 2 Added section 17 Change BCCT Listening October 31, 2008 Yves Racine
Ports for EV 62498.
15.0 2 Edited changes and published document. November 21, 2008 Andrea Fitzwilliam
15.0 3 Updated section 11.5.2 Element November 28, 2008 Goska Auerbach
Management System for EV 65145.
15.0 3 Updated section 12 Disaster Recovery January 14, 2009 Roberta Boyle
Strategy for EV 87423.
15.0 3 Added section 11.1.3 TimesTen January 14, 2009 Frederic Lelievre
Replication Port Number.
15.0 3 Edited changes and published document. February 5, 2009 Andrea Fitzwilliam
15.0 4 Updated section 11.5.1 Application Server, March 12, 2009 Patrick Nadeau
Network Server for EV 48848.
15.0 4 Edited changes and published document. March 23, 2009 Andrea Fitzwilliam
15.0 5 Updated server recovery procedure to April 16, 2009 Mark Kushnir
include information on file synchronizing.
15.0 5 Edited changes and published document. April 23, 2009 Andrea Fitzwilliam
15.0 6 Made minor change to section 9.1.1 May 15, 2009 Goska Auerbach
Configure Basic Maintenance Tasks for
EV 89729.
16.0 1 Removed the manual step of importing May 25, 2009 Yves Racine
data from peer as this is now automatically
done by the script config-redundancy in
section 11.5.3 Profile Server.
16.0 1 Updated document for Release 16.0. May 25, 2009 Mario Goupil
16.0 1 Edited changes and published document. July 22, 2009 Andrea Fitzwilliam
17.0 1 Updated document for Release 17.0 and October 28, 2009 Roberta Boyle
added section 20 BroadWorks Application
Server Time Zone Support for EV 101825.
17.0 1 Updated section 10.5.1 Change TimesTen February 9, 2010 Goska Auerbach
Database Size for EV 106025.
17.0 1 Updated document for Release 17.0. March 22, 2010 Mario Goupil
17.0 1 Edited changes and published document. April 12, 2010 Andrea Fitzwilliam
17.0 2 Updated section 12.2.3 BroadWorks April 30, 2010 Goska Auerbach
Server Restoration Procedure for
EV 109374.
17.0 2 Edited changes and published document. May 18, 2010 Andrea Fitzwilliam
17.0 3 Updated section 19.1.1.2 Healthmon File July 20, 2010 Goska Auerbach
System Check for EV 112653.
17.0 3 Edited changes and published document. July 23, 2010 Andrea Fitzwilliam
17.0 4 Updated section 19.3 BroadWorks SNMP August 4, 2010 Tony Pilote
Trap Monitoring for EV 115577.
17.0 4 Added clarification for maintenance tasks August 9, 2010 Tony Pilote
in section 9 Scheduled Maintenance Tasks
for EV 115892.
Updated sections 11.1.2 TimesTen
Replication Monitoring and 11.2.2 MySQL
Replication Monitoring for EV 112000.
17.0 4 Added section 9.10 Service License September 10, 2010 David Moriconi
Collect and updated document for
EV 114437.
17.0 4 Made minor editorial changes. September 14, 2010 Goska Auerbach
17.0 4 Updated section 10.5.1 Change TimesTen September 24, 2010 Goska Auerbach
Database Size for EV 118789.
17.0 4 Updated document with Release 17.sp1 September 29, 2010 Frederic Lelievre
information.
17.0 4 Edited changes and published document. November 1, 2010 Andrea Fitzwilliam
17.0 5 Updated section 10.3 Database Import for November 2, 2010 Goska Auerbach
EV 120645.
17.0 5 Updated section 22.2 Adjust BroadWorks December 10, 2010 Mario Goupil
Daylight Savings Time for EV 123592.
17.0 6 Updated section 10.5.6 Import TimesTen January 24, 2011 Mario Goupil
Datastores between Different Operating
Systems for EV 114783.
17.0 6 Updated section 21.12 dbUpdateStats.sh January 31, 2011 Tony Pilote
for EV 124825.
Updated section 12.2.3.3 Network Server,
Application Server, and Messaging Server
Replacement for EVs 113264 and 122851.
Updated section 11.5.1 Application Server,
Network Server, and Messaging Server for
EV 116345.
17.0 6 Edited changes and published document. March 8, 2011 Jessica Boyle
17.0 7 Updated section 7.10.1 Healthmon for March 16, 2011 Hang Tran
EV 129579.
17.0 7 Removed section about recreating the April 19, 2011 Mario Goupil
database by executing the nms.sh script
for EV 119909.
17.0 7 Added section 22.3 Change Media Server May 3, 2011 Mario Goupil
Kernel Selection on Linux to add steps to
change kernel selection for EV 121030.
17.0 7 Updated section 19.1.6.1 Collecting Heap June 9,2011 Mark Kushnir
Size Indicator for EV 143495
17.0 7 Updated section 9.1.1 Configure Basic June 14, 2011 Goska Auerbach
Maintenance Tasks for EV 143768.
17.0 7 Edited changes and published document. June 27, 2011 Jessica Boyle
17.0 8 Removed section 21.12 db.UpdateStats.sh July 18, 2011 Mario Goupil
and updated section 9.4 Database
Statistics Update for EV 124825.
17.0 8 Edited changes and published document. July 27, 2011 Jessica Boyle
17.0 9 Updated section 16 Change IP Address or August 30, 2011 David Moriconi
Host Name for EV 148587.
17.0 9 Added warning in section 10.5.1 Change September 27, 2011 Mario Goupil
TimesTen Database Size for EV 145227.
17.0 9 Corrected CLI reference from NetServ to September 29, 2011 Mario Goupil
NetworkServer for EV 150714.
17.0 9 Added CDS/CCRS restoration procedure September 29, 2011 François Isabelle
in section 12.2.3.6 Call Detail Server/Call
Center Reporting Server for EV 125022.
17.0 9 Updated section 12.2.3 BroadWorks September 30, 2011 David Moriconi
Server Restoration Procedure for
EV 144853.
17.0 9 Updated section 21.19 resizeDSN for October 12, 2011 Mario Goupil
EV 151585.
18.0 1 Updated document for Release 18.0. October 16, 2011 Mario Goupil
18.0 1 Updated section 16 Change IP Address, October 19, 2011 Goska Auerbach
Host Name, FQDN Name, Gateway, or
DNS Server for EV 144590.
18.0 1 Edited changes and published document. October 21, 2011 Andrea Fitzwilliam
18.0 2 Updated section 19.1.6.1 Collecting Heap October 24, 2011 Mario Goupil
Size Indicator for EV 147625.
18.0 2 Edited changes and published document. November 4, 2011 Jessica Boyle
18.0 3 Updated section 10.5.6 Import TimesTen November 8, 2011 Frederic Lelievre
Datastores between Different Operating
Systems to include UID and PWD
parameters.
18.0 3 Added section 12.2.3.7 Element November 22, 2011 David Moriconi
Management System to cover the disaster
recovery process for the EMS for
EV 130651.
18.0 3 Updated section 10.5.6 Import TimesTen November 30, 2011 Frederic Lelievre
Datastores between Different Operating
Systems to define UID and PWD
parameters as lowercase.
18.0 3 Updated section 12.2.3.7 Element January 11, 2012 David Moriconi
Management System for EV 130651.
18.0 3 Updated section 16 Change IP Address, January 16, 2012 David Moriconi
Host Name, FQDN Name, Gateway, or
DNS Server for EV 154921.
18.0 3 Edited changes and published document. January 25, 2012 Jessica Boyle
18.0 4 Edited changes and published document. February 16, 2012 Jessica Boyle
18.0 5 Updated section 11.5 Add New Peer to March 21,2012 François Isabelle
Redundant System for EV 162349.
18.0 5 Removed references to the Conferencing March 27, 2012 François Isabelle
Server for EV 154846.
18.0 5 Edited changes and published document. April 10, 2012 Jessica Boyle
18.0 6 Updated section 12.2.3.3 Network Server, April 17, 2012 Mario Goupil
Application Server, and Messaging Server
Replacement to add rsync command for
IpDeviceConfig files for EV 164187.
18.0 6 Edited changes and published document. April 27, 2012 Jessica Boyle
18.0 7 Updated section 11.5 Add New Peer to June 15, 2012 François Isabelle
Redundant System for EV 162349.
18.0 7 Updated section 21.8 config-hostname for July 18, 2012 Mario Goupil
EV 169451.
18.0 7 Updated section 12.2.3.3 Network Server, August 2, 2012 Goska Auerbach
Application Server, and Messaging Server
Replacement for EV 165887.
18.0 7 Edited changes and published document. August 24, 2012 Jessica Boyle
18.0 8 Updated section 9.1.1 Configure Basic September 5,2012 François Isabelle
Maintenance Tasks for EV 164026.
18.0 8 Updated section 12.2.3.2 Network Server, September 13, 2012 François Isabelle
Application Server, and Messaging Server
Replacement for EV 167728.
19.0 1 Added section 10.6.3 Regain Disk Space September 18, 2012 Hang Tran
Used by MySQL InnoDB Tablespace Files.
19.0 1 Updated section 9 Scheduled Maintenance September 28, 2012 Goska Auerbach
Tasks for EV 175534.
19.0 1 Updated section 7.9 Restore BroadWorks October 15, 2012 Goska Auerbach
Server to In-service for EV 176540.
19.0 1 Added Service Control Function (SCF) October 21 2012 Mario Goupil
server.
19.0 1 Updated section 12 Disaster Recovery October 24, 2012 David Moriconi
Strategy for EV 168478.
19.0 1 Updated section 9.1.3 Restore Auto- October 25, 2012 David Moriconi
Backup for EV 148461.
19.0 1 Modified section 10.6.3 Regain Disk Space November 2, 2012 David Moriconi
Used by MySQL InnoDB Tablespace Files
for EV 164733.
19.0 1 Edited changes and published document. November 16, 2012 Patricia Renaud
19.0 2 Added bwLoadHarderning.pl tool definition. November 21, 2012 Frederic Lelievre
19.0 2 Adding new peerctl commands in section November 30, 2012 Frederic Lelievre
21.16 peerctl for EV 113764.
19.0 2 Edited changes and published document. March 1, 2013 Joan Renaud
19.0 3 Updated section 9.2 Automatic Disk June 17, 2013 Jerry Zhang
Cleanup for EV 189686.
19.0 3 Updated section 11.5.1 Application Server, August 25, 2013 Mario Goupil
Network Server for EV 197735.
19.0 3 Edited changes and published document. September 20, 2013 Jessica Boyle
19.0 4 Added section 21.29 configdctl for September 24, 2013 Frederic Lelievre
EV 202216.
19.0 4 Edited changes and published document. October 23, 2013 Jessica Boyle
20.0 1 Updated section 8.3 Switch Active October 29, 2013 Jerry Zhang
Software Version for EV 198263. Updated
section 12.2.3.1 Media Server
Replacement for EV 205360.
20.0 1 Edited changes and published document. December 13, 2013 Joan Renaud
20.0 2 Updated document for the WebRTC December 14, 2013 Mario Goupil
Server, Messaging Server, and Sharing
Server.
Removed references to the Call Detail
Server.
20.0 2 Edited changes and published document. January 27, 2014 Patricia Renaud
20.0 3 Updated section 21.23 stopbw for January 29, 2014 Frederic Lelievre
EV 191707.
20.0 3 Edited changes and published document. February 4, 2014 Jessica Boyle
20.0 4 Updated section 21.16 peerctl for March 7, 2014 Mario Goupil
EV 218395.
20.0 4 Updated all references to the Sharing March 26, 2014 Joan Renaud
Server (USS) and the Messaging Server
(UMS).
Edited changes and published document.
20.0 5 Updated section 16.4 Update Application May 3, 2014 Mario Goupil
Server Call Processing Routing Information
for EV 221793.
20.0 5 Made minor editorial changes and July 25, 2014 Joan Renaud
published document.
20.0 6 Added section 12.2.3.8 Execution Server November 18, 2014 Mario Goupil
Replacement for EV 241916.
20.0 6 Updated sections 22.1 Add Memory to December 2, 2014 Goska Auerbach
BroadWorks Server and 12.2.3
BroadWorks Server Restoration Procedure
for EV 240907.
20.0 6 Updated sections 12.2.3.4 Xtended December 10, 2014 Goska Auerbach
Services Platform Replacement and
12.2.3.4 Profile Server Replacement for
EV 232459.
20.0 6 Updated sections 5.1.7 Sample Debug December 30, 2014 Mario Goupil
Configuration File and 5.1.8 Platform
Daemons Logging for EV 216892.
20.0 6 Edited changes and published document. February 2, 2015 Joan Renaud
20.0 7 Updated section 22.1 Add Memory to February 5, 2015 Goska Auerbach
BroadWorks Server for EV 216897.
Updated section 9 Scheduled Maintenance
Tasks for EV 239421.
20.0 7 Updated section 10.5.1 Change TimesTen February 10, 2015 Goska Auerbach
Database Size for EV 244136.
20.0 7 Edited changes and published document. March 3, 2015 Andrea Fitzwilliam
20.0 8 Updated section 12.2.3 BroadWorks March 18, 2015 Goska Auerbach
Server Restoration Procedure for
PR-44949.
20.0 8 Edited changes and published document. March 31, 2015 Jessica Boyle
20.0 9 Updated the following sections for June 5, 2015 Goska Auerbach
PR-47532: 10.1.1 Manual Database
Backup, 10.3 Database Import, 10.6.2
Start and Stop MySQL Database Daemon,
and 16.13 Update EMS Redundancy
Configuration.
20.0 9 Updated section 5 Logs for PR-47819. July 9, 2015 Goska Auerbach
20.0 9 Updated section 11.1.1 TimesTen July 29, 2015 Goska Auerbach
Database Synchronization for PR-47884.
20.0 9 Updated section 10.5.6 Import TimesTen August 26, 2015 Goska Auerbach
Datastores between Different Operating
Systems for PR-48290.
20.0 9 Edited changes and published document. October 10, 2015 Joan Renaud
20.0 10 Updated section 7.9.2 Redundant Systems October 15, 2015 Goska Auerbach
for PR-48695.
20.0 10 Updated section 10.3.1 Import Database November 11, 2015 Goska Auerbach
on Application Server, Element
Management System, Network Server, or
Messaging Server for PR-48912,
20.0 10 Edited changes and published document. January 21, 2016 Jessica Boyle
20.0 11 Updated section 11.5.1 Application Server, October 13, 2016 Goska Auerbach
Network Server, and Messaging Server for
PR-51605.
20.0 11 Updated section 11.5.1 Application Server, March 7, 2017 Goska Auerbach
Network Server, and Messaging Server for
PR-54578.
20.0 11 Updated section 12.2.3.2 Application March 16, 2017 Goska Auerbach
Server Replacement for PR-54802.
20.0 11 Edited changes and published document. March 28, 2017 Jessica Boyle
20.0 12 Updated sections 7.8.2 Redundant June 20, 2017 Goska Auerbach
Systems and 7.9.2 Redundant Systems for
PR-55512.
20.0 12 Updated section 16 Change IP Address, June 22, 2017 Goska Auerbach
Host Name, FQDN Name, Gateway, or
DNS Server and added section 16.2
Restart BroadWorks Software Manager for
PR-55554.
20.0 12 Updated section 10.5.5 Compact the July 31, 2017 Goska Auerbach
Database for PR-55962.
20.0 12 Edited changes and published document. August 7, 2017 Jessica Boyle
20.0 13 Added section 16 Uninstall Obsolete Third- November 15, 2017 Goska Auerbach
Party Components for PR-55193.
20.0 13 Edited changes and published document. January 18, 2018 Jessica Boyle
1 Overview....................................................................................................................................... 20
2 Summary of Changes ................................................................................................................ 21
2.1 Changes for Release 20.0 ........................................................................................................ 21
2.2 Changes for Release 19.0 ........................................................................................................ 23
2.3 Changes for Release 18.0 ........................................................................................................ 23
2.4 Changes for Release 17.0 ........................................................................................................ 24
2.5 Changes for Release 16.0 ........................................................................................................ 26
2.6 Changes for Release 15.0 ........................................................................................................ 26
2.7 Changes for Release 14.0 ........................................................................................................ 27
2.8 Changes from Release 13.0 ..................................................................................................... 29
2.9 Changes from Release 12.0 ..................................................................................................... 29
2.10 Changes from Release 11.1 ..................................................................................................... 29
2.11 Changes from Release 10.0 ..................................................................................................... 30
3 Maintenance Recommendations ............................................................................................. 31
4 BroadWorks Processes............................................................................................................. 32
5 Logs .............................................................................................................................................. 35
5.1 BroadWorks Debug Logs .......................................................................................................... 38
5.1.1 Log Severity ...................................................................................................................... 39
5.1.2 Log Input Channels .......................................................................................................... 39
5.1.3 Input Channel Attributes Channels .................................................................................. 51
5.1.4 Enable or Disable BroadWorks Debug Logging ............................................................. 52
5.1.5 Output Channel attributes ................................................................................................ 52
5.1.6 Log Rotation...................................................................................................................... 53
5.1.7 Sample Debug Configuration File.................................................................................... 53
5.1.8 Platform Daemons Logging ............................................................................................. 54
5.2 BroadWorks UNIX Command Execution Logging .................................................................. 54
5.3 Miscellaneous Logs ................................................................................................................... 55
5.3.1 Solaris System Logs ......................................................................................................... 55
5.3.2 Linux System Logs ........................................................................................................... 55
5.3.3 Enable TimesTen Logs .................................................................................................... 55
5.3.4 Apache Logs ..................................................................................................................... 55
5.3.5 Tomcat Logs ..................................................................................................................... 55
5.3.6 Oracle Logs ....................................................................................................................... 55
6 Fault and Performance Measurements .................................................................................. 56
6.1 Alarms ........................................................................................................................................ 56
6.1.1 Open System Alarms ....................................................................................................... 56
6.1.2 View System Alarms ........................................................................................................ 57
6.1.3 View and Set CLI Alarm Backlog Size ............................................................................ 58
6.1.4 Enable and Disable Real-Time Alarms Echoing............................................................. 59
Routine maintenance of the system includes procedures for all BroadWorks servers. For
questions about these procedures, contact support@broadsoft.com.
For maintenance and care of Sun equipment, see the Sun reference manuals. For
partner devices, see the manufacturer’s documentation.
This section describes the changes to this document for each release and document
version.
An operator should always use the following rules to maintain a BroadWorks server:
Always use maintenance scripts and procedures provided by BroadSoft.
Always refer to BroadWorks support personnel before installing any third-party
software that has not been distributed with the BroadWorks application.
When scripts are used to maintain a server, you should always keep the /tmp
directory as empty as possible because the /tmp is shared with the /swap partition on
the server.
− Filling up the /tmp partition could cause a server’s performance to significantly
decline and may even cause it to stop functioning.
− It is recommended to use a directory other than /tmp to put temporary files and to
erase them at the end of a maintenance task.
All BroadWorks servers are composed of many processes. These processes can be
associated with the following categories:
Application – The application processes are those that provide the BroadWorks
functionality, for example, the ExecutionAndProvisioning process on the Application
Server.
Platform – The platform processes are those that provide external integration or
addition.
The following table provides a list of applications and their corresponding processes
installed with BroadWorks and it indicates which processes go with the different types
of servers. Note that you can find the expansion of abbreviations for server names in the
Abbreviations for Server Names table, which follows.
ExecutionAnd execution AS
Provisioning
provisioning
remotexla
AMSSignalingGateway AMS
keepalived AMS
MediaStreaming msfe MS
NSExecutionAndProvisioning nsExecution NS
nsProvisioning
remotexla
Provisioning provisioning PS
subscriberAgent
subscriberAgent
DBSObserver dbsObserver PS
CCReportingDBManagement ccReportingDB PS
Management
EnhancedCallLogsDB enhancedCallLogsDB PS
Management Management
emSS7MAP
emSS7Platform
ss7CAP
ss7CAPBridge
ss7MAP
ss7MAPBridge
ss7OAMBridge
ss7Platform
imp
muc
ipcfe
stun
AS Application Server
MS Media Server
NS Network Server
PS Profile Server
XS Execution Server
All application processes are monitored through the BroadWorks process monitor. If the
monitored process dies, the process monitor automatically restarts it. The healthmon
monitoring task validates that all deployed applications have all their processes running
and notifies the operator through an alarm if one of the processes listed above is not
present for a specific server. To view the list of BroadWorks application processes
running on a server, an operator can issue the showrun command from a UNIX prompt.
Example
bwadmin@mtl64lin12.mtl.broadsoft.com$ showrun
Currently running BroadWorks Application processes:
OCS process monitor (pid=12577)
OCS (pid=12656)
apache process monitor (pid=12499)
apache (pid=12644)
execution process monitor (pid=12426)
execution (pid=12957)
flashPolicy process monitor (pid=12547)
flashPolicy (pid=12585)
provisioning process monitor (pid=12453)
provisioning (pid=12992)
remotexla process monitor (pid=12404)
remotexla (pid=12430)
tomcat process monitor (pid=12476)
tomcat (pid=12513)
BroadWorks supports full logging capability. Certain logs are system-controlled, whereas
others are on all the time, and other logs such as debug logging, can be modified to
provide more information when required. BroadWorks application-related log files that
reside under /var/broadworks/logs include the following.
The following table lists logs related to clustered server configuration and maintenance
activities. Only applicable servers are listed.
Log File Location
Event Type
AS NS EMS PS SCF UMS
For all servers, the server state management-related logs are located in the
maintenance/MoExtensionsXXXXXX.log file.
WARNING: Increasing the logging level affects server performance. Therefore, turn on input
channels with caution. By default, only the protocol input channels are on.
WARNING: Be very careful when editing the logging configuration on the Application Server or
Network Server.
WARNING: Setting these parameters with incorrect values can lead to severe performance
degradations. Do NOT modify these settings unless requested by BroadSoft personnel.
PS_CLI/Applications/BroadworksFileRepos/Logging/InputChannels> ?
0) get : show InputChannels-related attributes
1) set : modify InputChannels-related attributes
2) clear : clear InputChannels-related attributes
PS_CLI/Applications/BroadworksFileRepos/Logging/InputChannels> get
Name Enabled Severity
===========================================
BWCommunicationUtility true
FileRepos true
Generic true
3 entries found.
12 entries found.
Attribute Definition
Name “File” to indicate to the logging framework to use the file output channel.
File Prefix The string that the log file starts with.
The size the file should grow to before it is closed and a new file is created.
File Size
The size is set in MB.
NumberOfFiles The amount of files to store before the oldest file is deleted.
It is recommended to augment the number of log files when the disk size permits it. This
makes sure that log files are kept for a longer period of time, which allows better
troubleshooting when required. The formula for defining the total number of Execution
Server and Provisioning Server logs is as follows:
The Provisioning Server should never be more than 20% of the Execution Server
logs. The Execution Server generates many more logs per minute, so it reaches it
maximum much more quickly than the Provisioning Server does.
The total of Execution Server and Provisioning Server logs should never be more than
33% of the total partition size on which the logs are residing. This makes sure that
other applications have available disk space for their logs and the logs would not
conflict with the Application Server database.
There are log files for each day of the month such as, Aspmd, Snaspmd, Snmpas,
Snmptraps.log, XSOutput##.log, and PSOutput##.log. The day of the month is appended
to the file name, and these files are stored until they are overwritten the next month. There
are also Application Server and Provisioning Server logs that are rotated by size and are
deleted when the configured number of files to store is reached. Delete unnecessary old
files (files not currently being written to).
<OutputChannels>
<OutputChannel Name="Stdout" Enabled="False" />
<OutputChannel Name="File" Dir="/var/broadworks/logs/swmanager/"
FilePrefix="swmanagerActivities_" FileSizeMegs="30" NumberOfFiles="200"
Enabled="True" />
</OutputChannels>
</Log>
To apply the changes, reset the syslogd daemon (/etc/rc2.d/ S74syslog script).
6.1 Alarms
The Network Server, Application Server, Provisioning Server, Execution Server, and
Media Server provide alarms. The complete list of alarms can be found in the
BroadWorks Fault and Alarm Interface Specification Guide.
BroadWorks generated faults can be one of the following severities:
Alarm Level Action Necessary
Informational None
Low Check the affected system area; this alarm typically indicates a problem with
connectivity, and the redundancy of the system may be in jeopardy.
Medium Check the affected system area; this alarm typically indicates a problem with
connectivity, and the redundancy of the system may be in jeopardy.
Example:
Open
Using port 30002...
...Done
Type
Get
None.
Type
get TrapSeverity <= Medium
1 alarm(s) found
NOTE: When alarms occur, they appear in the window from which this command was invoked.
To avoid interrupting other CLI commands, open a separate window.
Example
clear
Result
...Done
NOTE: When the counter rolls over its maximum value, the current comparison level is also
rolled over, to continue generating the alarms at every “offset” increment.
In this example, “Synch API auth failures” is the description that appears in the Problem
Text field of the threshold alarm and “syncNbAuthorizationFailures” is the counter
monitored by the threshold mechanism. The alarm raises with each new synch API
authorization failure (initial value = 1, offset value = 1).
In this example, “Unassigned numbers” is the description that appears in the Problem Text
field of the threshold alarm and “systemNbUnassignedDNs” is the value of the threshold
gauge. The alarm is raised whenever the number of unassigned numbers goes outside of
the range (100, 200).
or
delete gauge systemNbUnassignedDNs
NOTE: If there are multiple thresholds for the same counter/gauge, then a list of thresholds
appear with the corresponding indexes. Use the Delete command (again) with the appropriate
index as an additional parameter on the command line.
or
set gauge systemNbUnassignedDNs status inactive
NOTE: If there are multiple thresholds for the same counter/gauge, then a list of thresholds
appear with the corresponding indexes. Use the Set command (again) with the appropriate
index as an additional parameter on the command line. For example, set counter
syncNbAuthorizationFailures status inactive rowIndex 0.
For instance, the following names align with the examples provided in the example
included in the previous description column:
MGCPStatsRestartInProgressIns
ttNbFailedCheckpoints
NOTE: The local host address (127.0.0.1) must be included in the SNMP Agent’s access list.
6.3.1.2 Examples
Type:
cd /system
Type:
AS_CLI/Monitoring/PM/Execution> ls –r
6.3.4.1 Examples
Type:
Get
-------------------------------------------------------------------------
executionServer/callpModule/callpStats/
-------------------------------------------------------------------------
*bwCallpNetworkOriginationAttempts 4
*bwCallpNetworkTerminationAttempts 5
*bwCallpNetworkTerminationsAnswered 4
*bwCallpUserOriginationAttempts 6
*bwCallpUserTerminationAttempts 9
*bwCallpUserTerminationsAnswered 7
*bwCallpEmergencyCallAttempts 0
*bwCallpEmergencyCallAlarms 0
* Server:
Identity..............: AS
Version...............: Rel_17.0_1.446
Administrative State..: Unlocked
* Applications:
Name Version Deployed Administrative State Effective
State
===================================================================================
====
ExecutionAndProvisioning 17.0_1.446 true Unlocked
Unlocked
FlashPolicy 17.0_1.446 true Unlocked
Stopped
OpenClientServer 17.0_1.446 true Unlocked
Stopped
WebContainer 17.0_1.446 true Unlocked
Unlocked
4 entries found.
* Hosted Applications:
Name Version Context Path Deployed
================================================================
CommPilot 17.0_1.446 /CommPilot true
DeviceManagementFiles 17.0_1.446 /DeviceManagement true
JWSFiles 17.0_1.446 /FileRepos true
MediaFiles 17.0_1.446 /media true
OCIFiles 17.0_1.446 /ocifiles true
5 entries found.
* Server:
Identity..............: AS
Version...............: Rel_17.0_1.446
Administrative State..: Locked
* Applications:
Name Version Deployed Administrative State Effective
State
===================================================================================
====
ExecutionAndProvisioning 17.0_1.446 true Unlocked
Locked
FlashPolicy 17.0_1.446 false Unlocked
Stopped
OpenClientServer 17.0_1.446 false Unlocked
Stopped
WebContainer 17.0_1.446 true Unlocked
Locked
4 entries found.
* Hosted Applications:
Name Version Context Path Deployed
================================================================
CommPilot 17.0_1.446 /CommPilot true
DeviceManagementFiles 17.0_1.446 /DeviceManagement true
JWSFiles 17.0_1.446 /FileRepos true
MediaFiles 17.0_1.446 /media true
OCIFiles 17.0_1.446 /ocifiles true
5 entries found.
NOTE: The CLI can be used to query the server and application states without the server
running and without logging in to the CLI.
From the CLI Maintenance/ManagedObjects level, type get broadworks. The result
displays (sample provided).
BroadWorks Managed Objects
==========================
* Server:
Identity..............: AS
Version...............: Rel_17.0_1.430
Administrative State..: Unlocked
* Applications:
Name Version Deployed Administrative State Effective State
=======================================================================================
ExecutionAndProvisioning 17.0_1.430 true Unlocked Unlocked
FlashPolicy 17.0_1.430 true Unlocked Unlocked
OpenClientServer 17.0_1.430 true Unlocked Unlocked
WebContainer 17.0_1.430 true Unlocked Unlocked
4 entries found.
* Hosted Applications:
Name Version Context Path Deployed
================================================================
CommPilot 17.0_1.430 /CommPilot true
DeviceManagementFiles 17.0_1.430 /DeviceManagement true
JWSFiles 17.0_1.430 /FileRepos true
MediaFiles 17.0_1.430 /media true
OCIFiles 17.0_1.430 /ocifiles true
5 entries found.
Individual CLI operations are described in the following subsections. Unless otherwise
mentioned, no restart is necessary for any operation. All changes are effective
immediately.
NOTE: Installation of applications can only be performed on the Xtended Services Platform.
The first step in the application life cycle is the installation. For the installation of
applications that are not prepackaged with the Xtended Services Platform, the application
file (.war or .bwar) must be copied to a local temporary directory on the server, for
example, /tmp. Using the CLI, in the Maintenance/ManagedObjects level, invoke the
install command, providing the full path name of the application file. Note that the name of
the file is irrelevant to the Xtended Services Platform. All the descriptive and operational
data used by the Xtended Services Platform are inside the file. By default, prepackaged
applications are located in the /usr/local/broadworks/apps directory.
An application is made unique by its name and its version, both of which are defined in the
internal deployment descriptor (in the .war/.bwar). For web application, the deployment
descriptor is the web.xml file. On the other hand, the BroadWorks application deployment
descriptor is in the broadworks.xml file. The Xtended Services Platform enforces
uniqueness of applications and does not allow installation of two applications with the
same name/version.
Following is an example of an installation of an application.
XSP_CLI/Maintenance/ManagedObjects> install application /tmp/Xsi-
Actions_5.0.war
Broadworks SW Manager installing Xsi-Actions_5.0.war...
- Performing basic validation
. Valid application structure
. Name : Xsi-Actions
. Description: BroadWorks Xtended Services Interface
. Version : 5.0
...Done
XSP_CLI/Maintenance/ManagedObjects>
During the installation process, the application file is validated and, if valid, it is internally
copied and installed. Once the application is installed, the file used to install the
application is no longer required and can be deleted.
After being installed, either the application can be activated to make it configurable or it
can be uninstalled.
NOTE: Applications with an automatic upgrade mode are installed by default when the
BroadWorks server is installed. Such applications cannot be uninstalled.
When activating an application, the name and version are mandatory. The contextPath
parameter is only required when activating a web application. It must not be specified
when activating a BroadWorks application.
Multiple instances of the same web application can be activated using different context
paths. However, a single activation of a BroadWorks application is allowed.
Once activated, applications can be configured. Configuration is done through the CLI
from the application-specific context. This context can be found under the application
context as illustrated in the following example.
AS_CLI/Applications> ?
0) CommPilot : go to level CommPilot
1) DeviceManagementFiles : go to level DeviceManagementFiles
2) ExecutionAndProvisioning : go to level ExecutionAndProvisioning
3) JWSFiles : go to level JWSFiles
4) MediaFiles : go to level MediaFiles
5) OCIFiles : go to level OCIFiles
6) OCIOverSoap : go to level OCIOverSoap
7) OpenClientServer : go to level OpenClientServer
AS_CLI/Applications/CommPilot> ?
0) CCRSProxyUrls : go to level CCRSProxyUrls
1) GeneralSettings : go to level GeneralSettings
2) Logging : go to level Logging
3) RelativeUrl : go to level RelativeUrl
4) WebBranding : go to level WebBranding
As shown in the example, all the activated applications are listed as subcontext. Note
however, that not all applications support configuration.
AS_CLI/Maintenance/ManagedObjects>
7.2.4 Undeployment
Applications can be undeployed when they are no longer required. Web applications can
be undeployed without restriction; however, before being undeployed, BroadWorks
applications must be stopped. Undeploying an application is done with the command
undeploy invoked from the CLI level Maintenance/ManagedObjects. For web
applications, the context path must be specified and for BroadWorks applications, the
application name must be used. Following are some examples.
AS_CLI/Maintenance/ManagedObjects> undeploy application FlashPolicy
BroadWorks SW Manager un-deploying FlashPolicy...
...Done
* Server:
Identity..............: AS
Version...............: Rel_17.0_1.446
Administrative State..: Unlocked
* Applications:
Name Version Deployed Administrative State
Effective State
=========================================================================
==============
ExecutionAndProvisioning 17.0_1.446 true Unlocked
Unlocked
4 entries found.
* Hosted Applications:
Name Version Context Path Deployed
================================================================
CommPilot 17.0_1.446 /CommPilot true
DeviceManagementFiles 17.0_1.446 /DeviceManagement true
JWSFiles 17.0_1.446 /FileRepos true
MediaFiles 17.0_1.446 /media true
OCIFiles 17.0_1.446 /ocifiles true
OCIOverSoap 17.0_1.446 /ociSOAP false
6 entries found.
AS_CLI/Maintenance/ManagedObjects>
NOTE: Undeploying the BroadWorks Web Container application affects all web applications.
The web applications are no longer running.
7.2.6 Uninstallation
Installed applications that are no longer required can be uninstalled. This removes all files
related to this application from the server. Only applications in Installed state can be
uninstalled. Furthermore, only applications having their upgrade mode set to “Manual”
can be uninstalled. Those with an automatic upgrade mode cannot be uninstalled as they
are part of the server configuration and they are upgraded with the platform. An
application is uninstalled using the uninstall command form the CLI, in the
Maintenance/ManagedObjects level. The uninstall command requires an application and
a version. Following is an example of an uninstallation of a web application.
XSP_CLI/Maintenance/ManagedObjects> uninstall application Xsi-Actions 5.0
Broadworks SW Manager un-installing Xsi-Actions version 5.0...
...Done
XSP_CLI/Maintenance/ManagedObjects>
NOTE 1: It is not necessary to log in to the CLI. The server automatically goes to the Unlocked
administrative state after starting.
NOTE 2: The server can also be started from the UNIX prompt as bwadmin using the startbw
command.
On the Application Server and Network Server, a check of the database replication lagging
state for the cluster occurs at startup. For a description of the database replication lagging
state, see section 11.1.1 TimesTen Database Synchronization.
AS_CLI/Maintenance/ManagedObjects>
WARNING: Stopping a server results in that server refusing any new incoming requests. This
puts the server in an administrative Disabled state.
The BroadWorks server can be stopped at either the UNIX prompt or CLI.
NOTE: It is not necessary to log in to the CLI. The server cannot be stopped from the CLI
unless a traffic lock has first been performed.
3) From the CLI Maintenance/ManagedObjects level, type stop. The results display
(sample provided).
AS_CLI/Maintenance/ManagedObjects> stop
AS_CLI/Maintenance/ManagedObjects>
AS_CLI/Maintenance/ManagedObjects>
AS_CLI/Maintenance/ManagedObjects>
* Server:
Identity..............: AS
Version...............: Rel_17.0_1.440
Administrative State..: Unlocked
* Applications:
Name Version Deployed Administrative State Effective State
=======================================================================================
ExecutionAndProvisioning 17.0_1.440 true Unlocked Unlocked
FlashPolicy 17.0_1.440 false Unlocked Stopped
OpenClientServer 17.0_1.440 false Unlocked Stopped
WebContainer 17.0_1.440 true Unlocked Unlocked
4 entries found.
* Hosted Applications:
Name Version Context Path Deployed
================================================================
CommPilot 17.0_1.440 /CommPilot true
DeviceManagementFiles 17.0_1.440 /DeviceManagement true
JWSFiles 17.0_1.440 /FileRepos true
MediaFiles 17.0_1.440 /media true
OCIFiles 17.0_1.440 /ocifiles true
5 entries found.
AS_CLI/Maintenance/ManagedObjects>
NOTE: From the UNIX prompt, type the showrun command to view BroadWorks-related
processes.
WARNING: Locking a server results in that server refusing any new incoming requests. This
takes the server operationally out-of-service.
NOTE: Configuration changes can be made while the server is in the Locked state (unless the
database is locked using a separate procedure, if applicable).
From the CLI Maintenance/ManagedObjects level, type lock. The following response
appears (sample provided).
+++ WARNING +++ WARNING +++ WARNING +++
This command will lock the server. Note that this action could cause
downtime. Continue?
The server is in the Locking administrative state while there are sessions in progress. No
new sessions can be started though. The server becomes Locked when the last session
terminates.
The server administrative state can be verified at the Maintenance/ManagedObjects level
by typing get broadworks.
…Done
The server administrative state can be verified using the get broadworks command.
WARNING: Restarting a server results in that server refusing any new incoming requests until
the server restarts.
NOTE: A server transitions to the Locked state only once all active sessions are terminated.
Use the lock force command from the CLI Maintenance/ManagedObjects level to force the
administration state to go to Locked.
3) From the CLI Maintenance/ManagedObjects level, type stop. The server is now
prepared to power down. If a power down is required, the following step should be
followed to ensure a graceful shutdown of the server.
4) Log in (or su -) as root.
5) At the UNIX prompt, type # sync.
6) At the UNIX prompt, type # shutdown –y –g0 –i5. The server powers down.
NOTE: Terminate all active sessions to allow the server to make the transition to the Locked
state. Use the lock force command from the CLI Maintenance/ManagedObjects level to force
the administration state to Locked.
NOTE: This step is for Application Server and Network Server only.
4) From the CLI System/Peering/Peers level, type get to verify the server database
state is Locked.
NOTE: This step is for Application Server and Network Server only.
NOTE: If the server was locked prior to being shut down, its state is still Locked after the power-
up as the administration state is persisted. Unlock the server using the unlock command.
5) From the CLI Maintenance/Tools level, type healthmon. Report severity displays
“Notification”, indicating that all BroadWorks subcomponents are up and running
properly.
NOTE: If the server was locked prior to being shut down, its state is still Locked after the power-
up as the administration state is persisted. Unlock the server using the unlock command.
5) From the CLI System/Peering/Peers level, type get to verify the server database
state is Locked.
NOTE: This step is for Application Server and Network Server only.
6) From the CLI Maintenance/Tools level, type healthmon. Assuming normal server
conditions, the report severity displays “Notification”, indicating that all BroadWorks
subcomponents are up and running properly.
7) From the CLI Maintenance/ManagedObjects level, type lock to make sure that new
calls are handled by the remaining in service cluster peer. The server transitions from
the Unlocked to Locking state before finally entering the Locked state.
8) From the CLI Maintenance/ManagedObjects level, type get broadworks to verify
that the server administration state is Locked.
NOTE: Terminate all active sessions to allow the server to make the transition to the Locked
state. Use the lock force command from the CLI Maintenance/ManagedObjects level to
force the administration state to Locked.
11) From the CLI Maintenance/Tools level, type importdb <remote server
hostaddress> to import the database from the peer server.
NOTE: Because the BroadWorks application has been stopped, the CLI login command fails.
The Maintenance/Tools CLI level is accessible without CLI login. The importdb <remote server
hostaddress> parameter must be the same as the UNIX host name of the active server.
12) From the UNIX prompt, to start replication, type $ repctl start.
13) From the UNIX prompt, to unlock the database, type $ peerctl unlock.
14) From the CLI Maintenance/ManagedObjects level, type start to start the server.
NOTE: Because the BroadWorks application is stopped, the CLI login command fails. The
Maintenance/ManagedObjects CLI level is accessible without CLI login. The server can also be
restarted from the UNIX prompt with the startbw command.
15) From the CLI Maintenance/ManagedObjects level, type unlock to make sure the
server can accept new calls. The server transitions from the Locked to Unlocking
state before finally entering the Unlocked state.
16) From the CLI Maintenance/ManagedObjects level, type get broadworks full
Verify the administration state is Unlocked and the operational state is Enabled.
17) From the CLI System/Peering/Peers level, type get to verify that the server database
state is Unlocked.
NOTE: This step is for Application Server and Network Server only.
18) From the CLI Maintenance/Tools level, type healthmon to verify the report severity
displays “Notification”, indicating that all BroadWorks subcomponents are up and
running properly.
7.10.1 Healthmon
The healthmon tool is available on all BroadWorks servers. You use this tool to report the
list of processes in trouble, if any, and monitor key system components. For the
Application Server and Network Server, healthmon also monitors the state of the database
and redundancy. Database out-of-sync condition detection, database replication lagging
detection, and database notification lagging detection are part of the healthmon command.
NOTE: The tool can be used in two distinct modes: Report to console or report over SNMP. In
the latter case, an SNMP trap is sent to the list of managers configured on the server. The
severity of the trap varies based on the state of the system. A trap is sent when no failure
conditions are detected. (Trap severity is NOTIFICATION.) This mechanism can be invoked
through a Solaris cron job.
MTLAS01$ healthmon –h
Depending on the server type, different actions could be set for the Actions parameters in
healthmon.properties. The following table lists the supported actions.
Action Supported Servers
7.10.2 Tech-support
The tech-support tool is available on all BroadWorks servers. You use this tool to report
the server software version, BroadWorks and Solaris processes status, Internet Protocol
(IP) configuration, redundancy status, and other diagnostics.
Log in as bwadmin to access this tool. The –help option provides the command format
information.
This section provides procedures to manage software versions. In this section all
examples provided are for the Network Server; however they also apply to BroadWorks
servers.
NOTE: The procedure to upgrade the server with a new software version is described in the
Installation and Upgrade Guide for that particular server. The final step of an upgrade procedure
can be performed from the Maintenance/ManagedObjects CLI level. Then the new version can
be activated or a previous version can be reactivated should there be a problem with the new
version.
Patching Info:
Active Patches: 0
NOTE: BroadWorks software version information can also be viewed from the UNIX prompt as
bwadmin using the bwshowver command. For a list of all applied patches, the bwshowver
–showPatch option can be used.
2 entries found.
* Applications:
Name Version Install Date Upgrade Mode
Description Status
================================================================================
================================
NSExecutionAndProvisioning 17.0_1.444 Apr 3, 2010 Automatic Provides
3 entries found.
9 entries found.
NOTE: Restarting a server results in that server refusing any new incoming requests until the
server restarts.
1) From the CLI Maintenance/ManagedObjects level, type lock to (traffic) lock the
server. This ensures the remaining service handles all new calls. The server
transitions from the Unlocked to Locking state before finally entering the Locked state.
2) From the CLI Maintenance/ManagedObjects level, type get broadworks to verify
the server administration state is Locked.
NOTE: Terminate all active sessions to allow the server to make the transition to the Locked
state. Use the lock force command from the CLI Maintenance/ManagedObjects level to force
the administration state to Locked.
NOTE: Additional logs for the server restart and software version switch are written to file
/var/broadworks/logs/maintenance/setactiveserver_XXXXXXXXXXXX.log.
4) Exit the CLI after the activation of the new BroadWorks software version. This is
mandatory before issuing new CLI commands.
There are certain tasks that can be scheduled on all BroadWorks servers. These tasks
are listed in the following tables.
Applicable To
Schedule
Access Application Database Element Execution Media
Tasks Mediation Server Server Management Server Server
Server System
Applicable To
Schedule Network Profile Service Xtended Messaging Sharing WebRTC
Tasks Server Server Control Services Server Server Server
Function Platform
Server
AS_CLI/Maintenance/Scheduler> h add
The ADD command is used to add a new scheduled task.
WARNING: Tasks should not be scheduled to run at the same time. Running all tasks at the
same time may affect server performance.
NOTE 3: All maintenance tasks produce a daily log file located under /var/broadworks/logs/cron.
Database X X X
/var/broadworks/
X
userfiles
/usr/local/broad
works/bw_base/ X X X X X X
conf/*
/var/TimesTen/
X
sys.odbc.ini*
Web
applications
Server
Database X X
/var/broadworks/
userfiles
/usr/local/broad
works/bw_base/ X X X X X X X
conf/*
/var/TimesTen/
X X
sys.odbc.ini*
Web applications X X
The script deletes all old backup files. Backups should be transferred off the server for
safekeeping.
To configure automatic backups to run once a day at 3:30 A.M., from the CLI
Maintenance/Scheduler level, type add backup daily 3 30.
… where:
YYYY is the year
ddd is the day of year
HH is the hour of day
mm is the minute
SS is the second
MM is the month
DD is the day of month
… where:
YYYY is the year
ddd is the day of year
HH is the hour of day
mm is the minute
SS is the second
MM is the month
DD is the day of month
bwadmin@MTLNS01$ ls
2006010082501-20060110-5294-NS_Rel_14.0_1.240-MTLNS01-80fcc530.tar
bwadmin@MTLNS01$ stopbw
bwadmin@MTLNS01$ ls
2006010082501-20060110-5294-NS_Rel_14.0_1.240-MTLNS01-80fcc530.tar
usr/
usr/local:
broadworks/
usr/local/broadworks:
bw_base/
usr/local/broadworks/bw_base:
persistent/
usr/local/broadworks/bw_base/persistent:
backups/
usr/local/broadworks/bw_base/persistent/backups:
2006010082501-20060110-11469-MTLNS01-80fcc530-database
bwadmin@MTLNS01$ startbw
/tmp All files older than two (2) days are deleted.
/var/tomcat/logs All files older than thirty (30) days are deleted.
/var/broadworks/logs/* All files older than thirty (30) days are deleted.
All files older than two (2) days are compressed.
NOTE: For the directory /var/broadworks/logs/*, the action applies to all directories under
/var/broadworks/logs.
Backups are executed as a UNIX cron job. Control the schedule with the
bwAutoCleanup.sh script or from the CLI.
For example, to set the cleanup to run once a week on Sunday at 4:30 A.M., from the CLI
Maintenance/Scheduler level, type add autoCleanup day sunday 4 30.
When the AutoCleanup task is run on a Database Server, the following files for Oracle
logs, traces, and alerts under the /u01/app/oracle/diag directory structure are compressed
(in addition to the log files under the /var/broadworks/logs directory):
Audit Dump
Database Instance traces
ASM Instance traces
WARNING 1: If you disable the bwPeriodmaint.sh task from the scheduler, the database may
exhibit performance issues.
WARNING 2: When the dbUpdateStats.sh script is running, it may prevent provisioning from
working. Make sure the script is scheduled to run outside of the busy hours.
WARNING 3: The time it takes to execute the dbUpdateStats.sh depends on the size of the
database and the hardware on which the application works. The execution can take a few
seconds up to a few minutes.
WARNING 4: This task also runs the check_dbpages task; therefore, both tasks should not be
scheduled at the same time.
9.9 Tech-support
Run the tech-support maintenance task on a daily basis. The output of the tech-support
daily task is stored in the /var/broadworks/logs/monitoring directory.
2) Type del <task ID>. The following response appears (sample provided).
...Done
BroadWorks uses TimesTen on the Application Server, Network Server, and Messaging
Server, MySQL on the Element Management System, and Oracle on the Database
Server.
All databases are delivered with Structured Query Language (SQL) clients and a set of
maintenance tools. In general, BroadSoft recommends the use of the commands
described in this document. All database-related issues or questions should be directed to
the BroadSoft Support line.
Maintenance procedures for Oracle are slightly different from those used for TimesTen
and MySQL. For more information on Database Server maintenance procedures, see the
BroadWorks Database Server Configuration Guide.
2) To run the backup, type $ bwBackup.pl <dsn> <file>. DSN is the datastore
name (for example, NetworkServer, AppServer, ElementManagementSystem) and
file is the file name for the backup (including the path). Example:
Hostname$ bwBackup.pl NetworkServer /var/dbbackup/Rel20.0/Nsbackup.bak
The database can also be manually backed up from the CLI Maintenance/Tools level.
The DSN (datastore name) is not required.
NS_CLI/Maintenance/Tools> ?
0) backupdb : Backups the content of the BroadWorks TimesTen datastore
1) healthmon : Reports the status of the system
2) importdb : Imports the content of a remote TimesTen database
3) restoredb : Restores the content of the BroadWorks TimesTen datastore
4) tech-support : Captures the status of the system for troubleshooting
5) upgradeCheck : Performs pre-upgrade validation
WARNING: This procedure overwrites the Application Server, Element Management System,
Network Server, or Messaging Server database with the backed-up version. The existing data is
lost.
To restore the database, an existing backup must be present on the server. The restore
fails if there are processes attached to the database. Such processes can include
BroadWorks, replication daemons, and TimesTen (ttIsql) or MySQL database client tools.
NOTE: Terminate all active sessions to allow the server to make the transition to the Locked
state. Use the lock force command form the CLI Maintenance/ManagedObjects level to force
the administration state to Locked.
3) From the UNIX prompt, type $ stopbw to stop the BroadWorks server.
4) If the server is part of a redundant cluster, stop the TimesTen replication (from the
UNIX prompt, type $ repctl stop).
5) Restore the desired database (using the bwRestore.pl command from the UNIX
prompt or from the CLI Maintenance/Tools level).
Example:
$ bwRestore.pl NetworkServer /var/dbbackup/Rel10.0/backup06.bak
6) If the server is part of a redundant cluster, restart TimesTen replication (from the UNIX
prompt, type $ repctl start).
7) Restart the BroadWorks Server (from the UNIX prompt type $ startbw).
NOTE: For a redundant cluster, restoring a database on just one peer results in a database out-
of-sync condition. A database import is required on the other peer to make sure a return to
database in-sync state.
4) If you want to restore the backup files to their original directories, change your working
directory to the system root directory (/). Otherwise, the backup files are simply
extracted relative to the directory from which you run the tar xvf command. Type:
$ cd /
5) To extract the database backup file from the automatic backup tar file, from the UNIX
prompt, type:
$ tar xvfP AutoBackupFileName.tar
/usr/local/broadworks/bw_base/persistent/backups/DatabaseBackupFileName
WARNING: This procedure overwrites the Application Server, Element Management System,
Network Server, or Messaging Server database with the backed-up version. The existing data is
lost.
A database can be imported from a cluster peer member. This can be used to make sure
that the databases across all peers are in-sync.
The import fails if there are processes attached to the database. Such processes can
include BroadWorks, replication daemons, and TimesTen (ttIsql) or MySQL client
tools. The import requires that the TimesTen or MySQL replication daemon is running on
the peer server.
The following command can be used to import a database.
$ importdb.pl [-noWarning] <local dsn> <remote host address> <remote dsn>
...then the remote host name should be set to “192.168.13.102”. It is always the peer’s
peerctl address.
NOTE: The loghost must be associated with this peer in the /etc/hosts file.
NOTE: Terminate all active sessions to allow the server to make the transition to the Locked
state. Use the lock force command form the CLI Maintenance/ManagedObjects level to
force the administration state to Locked.
3) Stop the BroadWorks Server (from the UNIX prompt type $ stopbw).
4) Lock the database on the server (from the UNIX prompt type $ peerctl lock).
5) Stop TimesTen replication, if the server is part of a redundant cluster (from the UNIX
prompt type $ repctl stop).
6) Import the database from the cluster peer (using the importdb.pl command from the
UNIX prompt or from the CLI Maintenance/Tools level). Example:
$ importdb.pl NetworkServer myhost.mycompany.com NetworkServer
7) Restart TimesTen replication, if the server is part of a redundant cluster (from the
UNIX prompt, type $ repctl start).
8) Unlock the database on the server (from the UNIX prompt type $ peerctl
unlock).
9) Restart the BroadWorks server (from the UNIX prompt, type $ startbw).
DANGER: This procedure destroys the existing Application Server, Element Management
System, Network Server, or Messaging Server database and installs a fresh database. This
command should NEVER be run on a production server unless under the direct supervision of
BroadSoft Support.
NOTE: For a redundant cluster, restoring a database on just one peer results in a database
out-of-sync condition. A database import is required on the other peer to ensure a return to
database in-sync state.
********************************************************************
*
WARNING - WARNING - WARNING - WARNING - WARNING - WARNING
........]
=> Checking for perm size usage <=
Perm Size Usage = 6% (limit is at 55%)
=> Checking for available disk space <=
Perm = 128 Temp = 42
Space required [16 Mb]
Checking on /bw... [done]
=> Creating bw_base link... [done]
=> Settings <=
Target BroadWorks version [NS_Rel_16.0_1.500]
Data store name [networkserver]
TimesTen version [7.0.5.9.0]
Force installation [true]
Installation type [fresh install]
Redundant System [false]
Current maintenance... [NS_Rel_16.0_1.500]
=> Installing the latest data schema <=
Creating tables... [done]
Loading basic data... [done]
=> Now configuring replication <=
Adding ns1/ns1... [done]
Setting primary peer (ns1)... [done]
Setting replication port (17888)... [done]
=> Setting IMS mode options <=
setting IMS mode to false... [done]
=> Setting platform mode options <=
=> Checking crontab for DB periodic maintenance <=
Crontab entry already present
=> Verifying database paging <=
=> Ensuring database is loaded in memory <=
Current maintenance... [NS_Rel_16.0_1.500]
Setting ram policy to always [done]
==== BroadWorks database setup [DONE] ====
WARNING 1: This procedure can be used to increase or decrease the database size and
should only be run with the assistance of BroadSoft Support personnel.
WARNING 2: During this procedure, the servers are locked, preventing provisioning changes
and device registration.
An operator shall use the resizeDSN tool packaged with the BroadWorks server to change
the database size. This following procedure provides the steps required to change the
database store name (DSN) size on an Application Server, a Network Server, or a
Messaging Server cluster. For safety, make a backup of the database before starting the
procedure. Always start the procedure on the primary server and then execute it on the
secondary servers. The procedure must be executed on one server at a time.
The following step must ONLY be run on the primary server:
1) Lock all servers in the cluster ($peerctl lock all).
The remainder of the procedure must be executed on the primary server first. Once
completed on the primary server, the remainder of the procedure must be executed on all
servers in the cluster, one at a time:
2) Stop BroadWorks on the server ($stopbw).
3) Stop replication on the server ($repctl stop).
4) Unload the database from memory ($timesten.pl unload).
5) Log in as root ($su).
6) Go to the BroadWorks bin directory (#cd
/usr/local/broadworks/bw_base/bin).
7) Run the resizeDSN command (#./resizeDSN).
During the execution of the resizeDSN command, when prompted with the question
“Do you want to back up the database (optional when increasing the DSN size) (y/n)
[y]?”, it is recommended to answer “n” (no) when the DSN size is increased. When
you answer no, the DSN is resized and then the TimesTen database is loaded. When
you answer yes, a backup is made, followed by a question about whether to restore
the safety backup, which adds unnecessary time to the activity.
8) Come back as bwadmin (#exit).
9) Restart replication on the server ($repctl start).
10) Unlock the server ($peerctl unlock).
NOTE: This procedure automatically runs weekly and should not run manually unless under the
supervision of BroadSoft Support personnel. Running this procedure can affect performance.
WARNING: The TimesTen database is started automatically upon server power up or reboot.
The database should not be manually stopped unless under direct supervision from BroadSoft
Support.
The database cannot be stopped if processes are attached to the database. Such
processes can include BroadWorks, replication daemons, and TimesTen tools like
ttIsql.
To stop the TimesTen database daemon, run the following commands:
1) Stop the BroadWorks server (from the UNIX prompt type $ stopbw).
2) Stop TimesTen replication if server is part of a redundant cluster (from the UNIX
prompt type $ repctl stop).
3) Log in (su -) as root and run the following commands:
# cd /etc/init.d/
# ./tt daemon stop
NOTE: It is recommended to run the check_dbpages.pl with the modify option during hours of
low traffic volume, as it temporarily locks the database.
NOTE 2: There is no way to take a backup image obtained through bwBackup.pl and restore it
directly on a server that has an operating system different from that of the server from which the
backup was obtained.
Where
SOURCE_NODE is the address of the source node
DSN is AppServer or NetworkServer depending on the BroadWorks
server type
PORT depends on the TT version, 16003 (can be obtained from
ttStatus)
6) Change the host name in the database using peerctl (from the UNIX prompt type
peerctl set).
7) In case the SOURCE_NODE was in a redundant configuration, from ttIsql on the
TARGET_NODE, drop the previous replication schema (from ttIsql, do drop
replication BW.REP;).
Once the procedure is completed, it is recommended to perform the following steps on the
SOURCE_NODE:
1) Import the database from its peer (from the UNIX prompt, type importdb.pl).
2) Start the replication (from the UNIX prompt, type repctl start).
3) Start BroadWorks (from the UNIX prompt, type startbw).
Following is a sample execution of the procedure described in this sub-section.
bwadmin@mtlsoldev1$ ttMigrateCS -c -v0 -connStr "TTC_Server=mtl64lin16;
TTC_Server_DSN=AppServer; TCP_Port=16003; UID=bw; PWD=bw"
/var/broadworks/backup/remote_db_backup.ttm
bwadmin@mtlsoldev1$ bwRestore.pl AppServer
/var/broadworks/backup/remote_db_backup.ttm -migrate
bwRestore.pl version 14.2.0
NOTE: The following change is required on boxes with more than 32 CPUs, in other words, on
T2000 boxes. It should be implemented on these boxes across the board.
On certain servers that are large, the default number of connections provided to TimesTen
is not enough. This information can be retrieved by running the tech-support script and
looking at the TimesTen Server information and status section in the following example.
This section provides information about TimesTen including the number of connections.
Example:
TimesTen status report as of Sun Oct 16 10:05:20 2011
NOTE: This procedure automatically runs every night at 2:15 A.M. and should not be run
manually unless under the supervision of BroadSoft Support personnel. Running this procedure
can affect performance.
WARNING: The MySQL database is started automatically upon server power up or reboot. The
database should not be manually stopped unless under direct supervision from BroadSoft
Support.
The MySQL database daemon is controlled through the following command run as root.
service mysql_daemon [stop | start | restart]
The database cannot be stopped if processes are attached to the database. Such
processes can include BroadWorks, replication daemons, and MySQL tools such as
mysql.
To stop the MySQL database daemon, run the following commands:
1) Stop the BroadWorks server (from the UNIX prompt type $ stopbw).
2) Stop MySQL replication if server is part of a redundant cluster (from the UNIX prompt
type $ repctl stop).
3) Log in (su -) as root and run the following commands.
# service mysql_daemon stop
NOTE: For a redundant cluster, restoring a database on just one peer results in a database out-
of-sync condition. A database import is required on the other peer to ensure a return to
database in-sync state.
WARNING: Stopping TimesTen Replication can result in cluster member databases becoming
out-of-sync. Replication should only be stopped when indicated in a BroadWorks maintenance
procedure or under the supervision of BroadSoft Support personnel.
In addition to an out-of-sync condition, failure to run replication on all cluster peers at all
times can possibly lead to longer re-synchronization times once replication is re-enabled
later. The Application Server, Network Server, and Messaging Server track three states
related to the database:
Replication State – For each peer in the cluster, the state of whether file replication
and database replication are running is tracked.
Database Replication Lagging State – The database retains transactions (and their
associated log files) if they have not been successfully replicated to all remote peers.
If a peer is shut down (entire server shut down, including replication) for maintenance
for an extended period and replication is not turned off on the operating server, a high
number of transaction files are retained by replication on the operating server. This
can cause excessive disk space usage and result in a long time for databases to re-
synchronize when the previously shut down server is re-instated. For each peer in the
cluster, the number of database transaction log files retained by replication is tracked.
Also tracked are whether an excessive number of transaction log files have been
retained by replication and whether an import resynchronizes the databases faster
than replication.
This threshold is defined at 90% of 360 transaction files (that is, 324 files).
Database Notification Lagging State – The database retains transactions (and their
associated log files) if associated notifications have not been delivered to the
application. If database notifications have not been delivered to the application, or if
there is an excess of database notifications, a high number of transaction log files are
retained by database notification. This can cause excessive disk space usage,
resulting in the application cache not being synchronized with the database, and
points to a possible defect in the notification delivery mechanism. For each peer in
the cluster, the number of database transaction log files retained by notification is
tracked. Also tracked is whether an excessive number of transaction log files have
been retained by notification.
WARNING: BroadWorks must be stopped on the server prior to stopping and starting, or
restarting the replication. When the replication is restarted on the BroadWorks primary server
(the server hosting the most up to date database), all peers must be imported from that primary
server.
NOTE: As seen in the sample output above, repctl stop pushes transactions held by replication
to all peers in the cluster. If the transactions held by replication could not be pushed to all peers
in the cluster, the following warning is generated.
WARNING: Outstanding transactions could not be replicated to all remote peers. Databases
are out-of-synch. Run repctl status for more details on replication status. If required, import the
database from the appropriate cluster member to all other cluster members to synchronize the
system.
NOTE 2: repctl start checks the replication lagging state on all servers in the cluster.
If replication is found to be lagging on any server in the cluster, the following message is
displayed:
WARNING: Replication is lagging on one of the servers in the cluster. Invoke repctl status for
more details. Use database import to synchronize with the server exhibiting replication lagging.
Replication State
MTLAS04: (filerep: started) (database: started)
MTLAS01: (filerep: started) (database: started)
The number after the File Replication PID field is the RSYNC PID number. If no number is
present, file replication is not running on the local server. The Replication Agent Policy
field provides information on the state of TimesTen Replication on the local server. A
value of “always” indicates the replication is running. A value of “never” indicates the
replication is not running.
The state of database replication and file replication for all peers in the cluster is output
under the title “Replication State” as shown in the example above. The entries are
prefixed by the canonical host name of each peer.
--------------------------------
Recommendations
---------------
--------------------------------
Healthmon also checks the database replication lagging state and database notification
lagging state. Lagging results in the following recommendations.
--------------------------------
System Health Report Page
BroadWorks Server Name: as2
Date and time : Fri Jun 6 13:44:19 EDT 2003
Report severity : CRITICAL
Server type : AppServer
--------------------------------
NOTE: Healthmon should be set up as a scheduled task running at least once an hour.
WARNING: If the repctl status indicates replication is not running, Healthmon indicates that a
remote server is not receiving replication updates, or repctl status/healthmon indicates that
database replication lagging exists at one of the peers in the cluster and the databases need to
be resynchronized. Database resynchronization is accomplished using the Import Database
procedure. In general, the import is run on the secondary server.
NOTE: A change to a replication port only takes effect after the replication is bounced.
Therefore, changing the port MUST be done during a maintenance window.
NS_CLI/System/Peering> get
replicationPort = 19999
On the secondary server for the Application Server or each peer (one at a time) on the
Network Server, and Messaging Server, perform the steps according to the following
commands (6 through 10):
6) Stop BroadWorks.
bwadmin@MTLNS02$ stopbw
It is also possible to view the currently used replication port using bwListPortInUse
script as follows.
bwadmin@MTLNS01$ bwListPortInUse
Usage Type Port Internal
----------------------------------------------------------------
SNMP agent UDP 8001 N
SNMP agent trap server TCP 30002 Y
MO daemon TCP 7120 Y
MO root daemon TCP 7121 Y
Patch Tool TCP 2223 N
Patch Tool (Perl) TCP 2224 Y
TimesTen Main Daemon TCP 16003 N
Replication port TCP 19999 N
Naming service port TCP 1050 Y
SIP listening port UDP 5060 N
MSS listening port UDP 5677 N
ASR listening port UDP 5090 N
WARNING: Stopping MySQL replication can result in cluster member databases becoming out-
of-sync. Replication should only be stopped when indicated in a BroadWorks maintenance
procedure or under the supervision of BroadSoft Support personnel.
In addition to an out-of-sync condition, failure to run replication on all cluster peers at all
times can possibly lead to longer re-synchronization times when replication is re-enabled
later. The Element Management System tracks the states of the master and slave
connection to the database. Under normal operation, the state is set to “Waiting for
master to send event”.
Replication can be stopped or started from the CLI System/Peering level or from the
UNIX prompt, using the repctl command.
To stop the MySQL replication daemon:
From the UNIX prompt, type $ repctl stop. The following response appears (sample
provided).
bwadmin@virems01.mtl.broadsoft.com$ repctl stop
Shutting down Redundancy/Replication
File Replication:
Stopping File Replication... [done]
Database Redundancy:
Stopping Database Redundancy... [done]
WARNING: Outstanding transactions could not be replicated to all remote peers. Databases
are out-of-synch. Run repctl status for more details on replication status. If required, import the
database from the appropriate cluster member to all other cluster members to synchronize the
system.
NOTE: The replication daemon can be bounced (stopped/started) in single step using the repctl
restart option.
Redundancy/Replication Status
-----------------------------
File Replication pid(s) = 10336
Datastore name = WebNmsDB
Replication Agent Policy : always
Replication State
virems01.mtl.broadsoft.com: (filerep: true)(database: true)
virems02.mtl.broadsoft.com: (filerep: true)(database: true)
The number after the File Replication PID field is the RSYNC PID number. If no number is
present, file replication is not running on the local server. The Replication Agent Policy
field provides information on the state of MySQL Replication on the local server. A value
of “always” indicates the replication is running. A value of “never” indicates the replication
is not running.
The state of database replication and file replication for all peers in the cluster is output
under the title “Replication State” as shown in the example above. The entries are
prefixed by the canonical host name of each peer.
Is this server the primary peer (the first one installed) (y/n) [y]?
This server is the primary peer. Its installation is a bit more involved
and requires you to enter the list of all peers in the cluster. These
other peers (secondaries) will use this information to configure
themselves.
When run on the secondary server, the installation process automatically retrieves the
cluster information from the primary server. The only input required is the routable
address of the primary server.
…
Will this server be a member of a redundant cluster? (y/n) [n]?y
Is this server the primary peer (the first one installed) (y/n) [y]?n
Secure Shell (SSH) is installed on all Network Servers, Application Servers, and
Messaging Servers to support the need for automated replication control to issue remote
commands from one server to the other in a secure manner. During installation, keys are
automatically exchanged between the peers.
NOTE: The data received by the backup server (SNMP traps) during the failed heartbeat
interval is kept and committed into the database once the backup server takes over the active
server. This implies that there should not be any data lost for as long as the network elements
send their data to both Element Management System servers simultaneously.
Is this server the primary peer (the first one installed) (y/n) [y]?
This server is the primary peer. Its installation is a bit more involved
and requires you to enter the list of all peers in the cluster. These
other peers (secondaries) will use this information to configure
themselves.
NOTE: The CLI runs as the bworks user, which cannot write to all directories on the server.
Creating and using a temporary directory to store the ASDump information is then
recommended.
3) Transfer the asdump.txt file to the Network Server bwadmin home directory. The file
should be transferred as text.
4) From the Network Server CLI System/Util/ASUpload level, type:
upload <hostingNeName> /export/home/bwadmin/asdump.txt
/var/broadworks/log.txt
1) Install the new server following the instructions for the installation of a stand-alone
server provided by BroadSoft in the BroadWorks Software Management Guide.
NOTE 1: Make sure that all servers from the cluster and the newly installed server have SSH
keys configured properly. For more information, see section 11.9.2 Configure SSH Between
BroadWorks Servers.
NOTE 2: BroadWorks must not be running on the newly installed server (run stopbw).
NOTE: This procedure can also be used to configure two stand-alone servers as one single
cluster. Take into account that one of the stand-alone servers is referenced in this guide as the
cluster server while the other is designated as the new stand-alone node.
3) Verify that the new stand-alone node has been added correctly with peerctl ls.
4) On the new stand-alone node, run peerctl add <hostname> <ipaddress> where
<hostname> is the primary server host name.
5) On the new stand-alone node, run peerctl setPrimary <hostname> where
<hostname> is the primary server host name.
6) Verify that the primary site is properly identified on the new stand-alone with peerctl
ls.
7) Restart the replication on all existing members of the cluster, by running the following
commands on one cluster member at a time.
(a) Stop BroadWorks with stopbw --force
(b) Restart replication with repctl restart.
(c) Start BroadWorks with startbw.
8) On the new stand-alone node, import the database by running importdb.pl
<LocalDSN> <RemotePeer> <RemoteDSN> and press Enter when prompted.
9) Restart the replication on the newly added node with command repctl restart.
10) For the Network Server, update the Network Server routing alias list by adding the
newly added peer.
11) Start BroadWorks on the newly added node with command startbw.
Following is a sample of this procedure.
bwadmin@vm81$ peerctl ls
HOSTNAME/ADDRESS State
--------------------------------------------------------------------------------
vm81/vm81 primary,unlocked
vm05/vm05 unlocked
vm04/vm04 unlocked
bwadmin@vm81$
bwadmin@vm04$ importdb.pl
The system is now redundant. You can re-use this procedure to add any number of
additional stand-alone servers to a cluster.
NOTE: Make sure that all servers are of the same release.
NOTE: Do not log in to the new peer as bwadmin until step 3, which follows.
2) On the primary server, run setup-redundancy and add a new peer when
prompted. The following is a sample of this procedure.
bwadmin@shoule [/usr/local/broadworks/bw_base/bin]$ ./setup-redundancy
Checking current redundancy set-up
Is this server the primary peer (the first one installed) (y/n) [y]?y
This server is the primary peer. Its installation is a bit more involved
and requires you to enter the list of all peers in the cluster. These
other peers (secondaries) will use this information to configure
themselves.
===================================================
Basic settings:
===================================================
Type Ctrl-c to abort installation
Re-spawning as root...
INFO: configuring redundancy from a BroadWorks upgrade to
EMS_Rel_15.0_1.200
done
nohup: redirecting stderr to stdout
Starting mysqld daemon with databases from
/usr/local/mysql/mysql_base/var
Done.
3) Log in as bwadmin and perform the post installation on the new peer.
----------------------------------------------
---- SSH CONFIGURATION TOOL version 2.2.15 ----
-> Setting default settings <-
Setting 'StrictHostKeyChecking no'
-> DNS Sanity test <-
[###############]
[...............]
-> Peer reachability test <-
[###]
[...]
-> Creating SSH keys <-
Creating keys for bwadmin@PS02...
3) On the new server, import the file repository files from the existing peer. As the
bwadmin user, run the following command on the new server.
$ rsync -vazurSHl <peerServer>:<file repository root>/. <file repository
root>/.
NOTE: For the Application Server, there are only two nodes; removing one leaves you with a
non-redundant configuration.
To correct the situation, the following commands should be entered at the prompt on the
primary server.
$ repctl stop
$ config-ssh –createKeys <redsrv1> <redsrv2> …
$ repctl start
NS_CLI/System/Peering> peer
NS_CLI/System/Peering/Peers> get
HostName Address State
=========================================================================
mtl64lin17.mtl.broadsoft.com mtl64lin17.mtl.broadsoft.com unlocked
mtl64lin10.mtl.broadsoft.com mtl64lin10.mtl.broadsoft.com unlocked
2 entries found.
For more information on how to use a pass phrase, see the OPENSSH
documentation available from www.openssh.org.
SSH configuration utility is used to create ssh keys for every peer
within a cluster. The utility then propagates the ssh keys to all peers
to facilitate access between each other. Any UNIX system that has
ksh, ssh and rsync installed can use this utility script.
Option
------
-createKeys is used to create ssh keys for every peer
NOTE: Pass phrases are like passwords and should be changed on a periodic basis.
Whenever pass phrases change, public identities need to be redistributed for SSH to continue
working.
If you issue the SSH bwadmin@serverName command, the command is run on the
server serverName.
Example:
$ ssh bwadmin@as4 /usr/local/broadworks/bw_base/bin/repctl status
Redundancy/Replication Status
File Replication pid =
Datastore name = ApplicationServer
Replication Agent Policy = manual
Replication Manually Started = false
Disaster recovery, defined as the ability to return servers and applications to their working
states following unexpected physical damage or system failures causing data loss, is an
issue that encompasses the high-level design and maintenance of entire back-end
infrastructures. As such, it is outside the direct scope of BroadWorks maintenance and
best considered in close collaboration with your IT department (and in light of best
practices within the industry). However, certain general approaches and guidelines can
be considered with respect to BroadWorks servers.
Disaster recovery from the BroadWorks perspective entails two stages, first creating a
replacement server platform with matching operating system (OS) and BroadWorks
software level, and then recreating the user information and configuration data of the
BroadWorks component and reintegrating the server into the BroadWorks network.
Replacement servers must have the same settings as the servers they replace,
incorporating all the following elements:
OS image
OS patches
UNIX/LINUX host name
IP address(es) and configuration
/etc/hosts file
/etc/hostname.* files
DNS configuration
NTP configuration
Security configuration (for example, JASS)
BroadWorks release
BroadWorks patch level
While the platform type of the server is not required to remain the same, it is
recommended that the new server have the same hardware footprint (CPUs, RAM).
Application Servers, Network Servers, and Messaging Servers do require that the new
server have the same OS type as the old server (Solaris or Linux).
If servers have multiple IP interfaces, then the replacement servers must also have the
same interfaces available and they must be defined.
NOTE: On the BroadWorks Database Server, the restoration of the centralized database can be
significantly longer, depending on size of the database and the speed of the I/O subsystem. It is
recommended to evaluate the restoration time in a lab environment to determine realistic time
requirements.
NOTE: Starting with Release 18.0, Web Server (HTTP) certificates and keys are now backed up
by the system backup and they do not have to be manually backed up when they are changed
by the service provider.
12.2.2 Licensing
To start the BroadWorks application on the replacement server, you require license files
that contain the hostid of the replacement server. To obtain new license files, contact
BroadSoft. If you use pre-configured recovery servers (either hot-standby, or pre-
configured OS standby, described above), you may be able to get the host IDs of the
standby servers added to existing license files, to avoid having to change license files in
the event of a swap. For more information, contact your BroadSoft Project Manager.
2) Copy the last BroadWorks system backup created from the server to be replaced, to
any directory on the replacement server. As the bwadmin user, run the following
commands.
bwadmin@host$ gunzip <backupfile_name.gz>
bwadmin@host$ tar xvf <backupfile_name>
This restores the last backup of the production server's configuration information to
the replacement server. Because the backup .tar file stores the relative paths of all
included files, you need to extract the archive (restore the server) from an appropriate
directory. If you want to restore files to the directory in which they were originally
located when the backup was made, perform the restore from the system root
directory (/). Otherwise, the backup files are simply extracted relative to the directory
from which you run the tar xvf command.
Note that the restore operation should be executed as root when performed from the
system root directory (/).
3) Make sure that valid license.txt and license.sig files are in place in the
/usr/local/broadworks/bw_base/conf directory.
2) If required, install BroadWorks on the replacement server and patch it to the level of
the active peer.
3) Stop the BroadWorks application, replication, the SNMP agent, the License Manager,
and the Configuration Agent on the replacement server if they are running.
bwadmin@ne1$ stopbw
bwadmin@ne1$ repctl stop
bwadmin@ne1$ snmpdctl stop
bwadmin@ne1$ lmdctl stop
bwadmin@ne1$ configdctl stop
4) Re-mesh the SSH keys. On all peers, clean up the .ssh directory by running the
following.
bwadmin@ne1$ rm -Rf /export/home/bwadmin/.ssh
bwadmin@ne2$ rm -Rf /export/home/bwadmin/.ssh
<other_peer_server> can be the host name of the peer if the /etc/hosts file on the
current host is configured properly with the peer host name.
6) Reconfigure database replication peers.
If any peer server is still in service, as bwadmin, run the peerctl ls command on the
existing peer server host to get a list of peers. Following is an example output of
peerctl ls from the existing server.
bwadmin@ne2$ peerctl ls
HOSTNAME/ADDRESS State
-----------------------------------------------------------------------
ne1/ne1 unlocked
ne2/ne2 primary,locked
If the replacement server is the primary, the peerctl add command is only needed to
add the existing peer, which is the secondary.
8) Verify that the information is consistent across all peers, with the exception of the state
on the new peer, which indicates “unlocked” while it shows “locked” on all other peers.
bwadmin@ne1$ peercmd peerctl ls
==== BroadWorks Network Command Spawning Tool version 1.2 ====
9) Copy the last BroadWorks system backup created from the server to be replaced to
any directory on the replacement server. If you want to restore files to the directory in
which they were originally located when the backup was made, perform the restore
from the system root directory (/). As the root user, run the following commands.
root@ne1$ gunzip <backupfile_name.gz>
root@ne1$ tar xvf <backupfile_name>
NOTE: The path to SSH may vary. On Linux, SSH is typically located under /usr/bin/ssh
instead of /usr/local/bin/ssh. If both files are available, /usr/bin/ssh should be used.
11) If the Application Server had been localized, web localization should be automatically
preserved from the system backup; however, any tone or announcement
customization is not part of the system backup and must be recreated. These can be
copied from the existing server. Depending on how localization was performed, these
custom files can be in a number of locations as follows:
− /var/broadworks/AS_Rel<xxxxxx>/sysprompts
− /var/broadworks/userfiles/<country_locale>
− /var/broadworks/userfiles/tones
12) Start the Configuration Agent, the License Manager, and the SNMP agent by running
the following command on the new replacement server.
bwadmin@ne1$ configdctl start
bwadmin@ne1$ lmdctl start
bwadmin@ne1$ snmpdctl start
13) Make sure that valid license.zip file is installed on the server (install-licen se.pl
/path/to/license.zip).
14) If stopped, restart the BroadWorks replication on the remaining peer.
bwadmin@ne2$ repctl restart
15) Import the database from the existing peer server. As the bwadmin user, run the
following command on the replacement server.
bwadmin@ne1$ importdb.pl [appserver <peer_ADDRESS> appserver]
20) Verify that the information is consistent across all peers, with every peer unlocked.
bwadmin@ne1$ peercmd peerctl ls
NOTE: If the former secondary server (ne2) was set as primary during this procedure and was
restarted for maintenance reasons before the end of the procedure, a lock and unlock cycle
(AS_CLI/Maintenance/ManagedObjects>) is required to restart the redundancy link.
2) If required, install BroadWorks on the replacement server, and patch it to the level of
the active peer.
3) Stop the BroadWorks application, replication, and the Configuration Agent on the
replacement server if it is running.
bwadmin@ne1$ stopbw
bwadmin@ne1$ repctl stop
bwadmin@ne1$ configdctl stop
4) Re-mesh the SSH keys. On all peers, cleanup the .ssh directory by running the
following.
bwadmin@ne1$ rm -Rf /export/home/bwadmin/.ssh
bwadmin@ne2$ rm -Rf /export/home/bwadmin/.ssh
<other_peer_server> can be the host name of the peer if the /etc/hosts file on the
current host is configured properly with the peer host name.
6) Reconfigure database replication peers.
If any peer server is still in service, as bwadmin, run the peerctl ls command on the
existing peer server host to get a list of peers. Following is an example output of
peerctl ls from the existing server.
bwadmin@ne2$ peerctl ls
HOSTNAME/ADDRESS State
-----------------------------------------------------------------------
ne1/ne1 unlocked
ne2/ne2 primary,locked
On the replacement server, you must make sure that the peer list is the same as it is
on the in-service peer.
8) Verify that the information is consistent across all peers, with the exception of the state
on the new peer, which indicates “unlocked” while it shows “locked” on all other peers.
bwadmin@ne1$ peercmd peerctl ls
==== BroadWorks Network Command Spawning Tool version 1.2 ====
9) Copy the last BroadWorks system backup created from the server to be replaced to
any directory on the replacement server. If you want to restore files to the directory in
which they were originally located when the backup was made, perform the restore
from the system root directory (/). As the root user, run the following commands.
root@ne1$ gunzip <backupfile_name.gz>
root@ne1$ tar xvf <backupfile_name>
10) On the Network Server, the only files that are replicated across peer servers are the
web branding files. Any web-branding file that was changed on the existing/running
Network Servers since the system backup is automatically resynchronized to the new
server within a short period (less than 30 minutes).
11) Start the Configuration Agent by running the following command.
bwadmin@ne1$ configdctl start
12) Make sure that valid license.txt and license.sig files are in place in the
/usr/local/broadworks/bw_base/conf directory.
13) Restart the BroadWorks replication on the already active peer(s).
bwadmin@ne2$ repctl restart
14) Import the database from the existing peer server. As the bwadmin user, run the
following command on the replacement server.
bwadmin@ne1$ importdb.pl [networkserver <peer_ADDRESS> networkserver]
If the peer server is not in service, restore the database that was included in the last
BroadWorks system backup archive.
Note that repctl start also starts file replication, which makes sure that any user files
that have changed since the last BroadWorks system backup (for example, greetings)
are replicated to the replacement server within the first 10 minutes of operation.
The syncheck_basic.pl is used to detect discrepancies between the databases on the
peer. If an error is reported, follow the recommendation to re-sync the database. Any
attempt to use the replacement peer in a redundant configuration depends on
properly synchronized databases.
16) Unlock the BroadWorks database on every peer.
bwadmin@ne2$ peercmd peerctl unlock
19) If the server replaced was originally the primary server, set it back as primary.
bwadmin@ne1$ peerctl setPrimary ne1
20) Verify that the information is consistent across all peers, with every peer unlocked.
bwadmin@ne1$ peercmd peerctl ls
2) Copy the last BroadWorks system backup created from the server to be replaced, to
any directory on the replacement server. As the bwadmin user, run the following
commands.
bwadmin@host$ gunzip <backupfile_name.gz>
bwadmin@host$ tar xvf <backupfile_name>
This restores the last backup of the production server’s configuration information to
the replacement server. Because the backup .tar file stores the relative paths of all
included files, you must extract the archive (restore the server) from an appropriate
directory. If you want to restore files to the directory in which they were originally
located when the backup was made, perform the restore from the system root
directory (/). Otherwise, the backup files are simply extracted relative to the directory
from which you run the tar xvf command.
6) Start BroadWorks.
bwadmin@host$ startbw
2) Re-mesh the SSH keys. On all peer servers, as root, run the following.
bwadmin@host$ rm -Rf /export/home/bwadmin/.ssh
<other_peer_server> can be the host name of the peer if the /etc/hosts file on the
current host is configured properly with the peer host name.
3) Configure the replication peers on the new replacement server.
If the peer server is still in service, as bwadmin, run the peerctl ls command on
the existing peer server host to get a list of peers. Following is an example of a
peerctl ls from the existing server.
bwadmin@host$ peerctl ls
HOSTNAME/ADDRESS
On the replacement server, you must make sure that the peer list is the same as it is
on the in-service peer.
For example, if the server to be replaced has the host name ps1, the existing peer list
on the existing server should have one entry present set to “ps1”. However, that entry
may have a different host name defined, in which case you have to set it correctly.
Following is an example of the replacement server peerctl ls output.
bwadmin@host$ peerctl ls
HOSTNAME/ADDRESS State
-----------------------------------------------------------------------
Given the previous examples, the following commands would be run on the
replacement server to set the peers properly.
bwadmin@host$ peerctl add ps2
4) Copy the last BroadWorks system backup created from the server to be replaced to
any directory on the replacement server. As the root user, run the following
commands.
bwadmin@host$ gunzip <backupfile_name.gz>
bwadmin@host$ tar xvf <backupfile_name>
This restores the last backup of the production server’s configuration information to
the replacement server. Since the backup .tar file stores the relative paths of all
included files, you must extract the archive (restore the server) from an appropriate
directory. If you want to restore files to the directory in which they were originally
located when the backup was made, then perform the restore from the system root
directory (/). Otherwise, the backup files are simply extracted relative to the directory
from which you ran the tar xvf command.
NOTE: HTTPS certificates and keys are not backed up by the system backup. Information
stored in /var/broadworks/ssl/certs /var/broadworks/ssl/private should be backed up and stored
remotely whenever they are changed by the provider. The HTTPS certificate and keys must be
manually restored on the new server.
6) Make sure that valid license.txt and license.sig files are in place in the
/usr/local/broadworks/bw_base/conf directory.
7) Import the file repository files from the existing peer server, since they are not included
in the system backup. As the bwadmin user, run the following command on the
replacement server.
bwadmin@host$ rsync -vazurSHl <peerServer>:<file repository root>/. <file
repository root>/.
NOTE: The replacement server must be installed as a stand-alone server before proceeding
with the following steps.
2) Re-mesh the SSH keys. On all peer servers, as root, run the following.
bwadmin@host$ rm -Rf /export/home/bwadmin/.ssh
<other_peer_server> can be the host name of the peer if the /etc/hosts file on the
current host is configured properly with the peer host name.
4) Configure the replication peers on the new replacement server.
If the peer server is still in service, as bwadmin, run the peerctl ls command on
the existing peer server host to get a list of peers. Following is an example of a
peerctl ls from the existing server.
bwadmin@host$ peerctl ls
PEER Role Status
========================================
ems01 PRIMARY NOTRUNNING
ems02 SECONDARY ACTIVE
On the replacement server, you must make sure that the peer list is the same as it is
on the in-service peer.
For example, if the server to be replaced was the primary server, you must configure
the replacement server as primary with the same peer name. To configure the
redundancy, run the following command on the replacement server as bwadmin.
bwadmin@host$ /usr/local/broadworks/bw_base/bin/setup-redundancy
If the new replacement server is the primary server, you need to reset the database
replication configuration on both servers by running the following command as
bwadmin. If the replacement server is the secondary server, the database replication
information is already reset.
bwadmin@host$ /usr/local/broadworks/bw_base/bin/reset-redundancy.pl
This restores the last backup of the production server's configuration information to
the replacement server. Since the backup .tar file stores the relative paths of all
included files, you must extract the archive (restore the server) from an appropriate
directory. If you want to restore files to the directory in which they were originally
located when the backup was made, perform the restore from the system root
directory (/). Otherwise, the backup files are simply extracted relative to the directory
from which you ran the tar xvf command.
7) Start the Configuration Agent.
bwadmin@host$ configdctl start
8) Import the database on the new replacement server. As bwadmin, run the following
command.
bwadmin@host$ /usr/local/broadworks/bw_base/bin/importdb.pl <other server
hostname>
9) If the server to be replaced has LDAP enabled and was the primary server, restore
the LDAP database on the replacement server. The LDAP database was backed up
with the last BroadWorks system backup and it is located under
/var/broadworks/backup. As root, run the following command.
bwadmin@host$ /usr/local/broadworks/bw_base/bin/bwLdapRestore.pl
<BackupFile>
10) Make sure that valid license.txt and license.sig files are in place in the
/usr/local/broadworks/bw_base/conf directory.
11) If applications were manually deployed or undeployed on the server to be replaced,
deploy or undeploy them again on the replacement server.
12) Start the replication on both servers and start BroadWorks on the replacement server.
bwadmin@host$ repctl start
bwadmin@host$ startbw
2) Copy the last BroadWorks system backup created from the server to be replaced, to
any directory on the replacement server. As the bwadmin user, run the following
commands.
bwadmin@host$ gunzip <backupfile_name.gz>
bwadmin@host$ tar xvf <backupfile_name>
NS_CLI/Applications/NSPortal/GeneralSettings> set
userCookieSupportEnabled false
*** Warning: The WebContainer application needs to be restarted for the
changes
to take effect ***
NS_CLI/Applications/NSPortal/GeneralSettings> set
userCookieSupportEnabled true
*** Warning: The WebContainer application needs to be restarted for the
changes
to take effect ***
The BroadWorks licensing files are copied to the proper BroadWorks directories. Note
that your BroadWorks license includes software from other companies. For details,
consult your license agreement from BroadSoft.
The software CD is ejected and the user is prompted to enter the license CD into the CD
drive. If the BroadWorks licensing files are not located on a CD, then the directory path
containing the license files can be entered instead. Note that the root password is
required for the license file installation.
Follow these steps:
1) su to root and launch the install-license.pl script.
2) # cd /cdrom/cdrom0/<BW release>/install.
3) # ./install-license-pl <BW release>. The following response appears
(sample provided).
-----------------------------------------------------
Install license files to NS_Rel_14.0_1.538
Hit 'q' if you do not have a license CD or wish to skip this step,
Done
The license installer script automatically installs the BroadWorks license files license.sig
and license.txt in /usr/local/broadworks/<BW version>/conf.
However, in the event that the license installer script would either not be called or would
not be successful, the following steps should be executed as root.
4) Log in as (or su to) root.
5) Copy the BroadWorks license files (license.txt and license.sig) from the license-
backup directory to the configuration directory.
# cd /export/home/bwadmin/license-backup
# cp license.* /usr/local/broadworks/<BW release>/conf
6) After copying the license files in the conf directory, you need to activate it. For
Network Servers and Application Servers, log in to the CLI and execute the set
command under /System/Licensing.
AS_CLI/System/Licensing> set
As BroadWorks servers are upgraded, old BroadWorks versions are not deleted but they
remain on the server. BroadSoft recommends that after an upgrade, the current active
version and the last version should be kept on the server (at a minimum). Older
BroadWorks versions can be uninstalled using the following procedure.
To uninstall an obsolete server version (for example, NS_Rel_19.0_1.131 on the Network
Server):
1) Log in (or su -) to root.
2) Change the directory (cd) to
/var/broadworks/<current_release>/uninstall and run the uninstall-
bwserver.pl script.
3) Type # /uninstall-bwserver.pl -r. The “-r” option directs the script to
remove the corresponding /var/broadworks release directory. The following response
appears (sample provided).
#./uninstall-bwserver.pl -r
Select which release to remove (0 to stop the process)
0 - none
1 - NS_Rel_11.0_1.131
2 - NS_Rel_12.0_1.411
3 - NS_Rel_13.0_1.362
4 - NS_Rel_14.0_1.606
As BroadWorks servers are upgraded, third-party components are also upgraded. It is not
typically required to uninstall these old components. However, it might be interesting to
get rid of old software binaries as they become obsolete when free disk space becomes
an issue.
To uninstall an obsolete third-party component, the specific./uninstall-
<component>.pl script must be used.
1) Log in (or su -) to root.
2) Change the directory (cd) to /var/broadworks/<current_release>/uninstall and run the
./uninstall-<component>.pl script.
3) Select the version of the component to remove and confirm operation.
[root@as1.example.org /] cd
/var/broadworks/AS_Rel_22.0_1.1123/uninstall
0 - none
1 - jdk1.7.0_99
2 - jdk1.8.0_102b
NOTE: These scripts run some basic verifications to ensure that the selected third-party
component version is not currently used and can be safely deleted. However, removing the
previous version of a component might prevent future attempts to rollback BroadWorks from
succeeding if the target release still requires it.
Alternatively, these scripts can be invoked with an argument specifying the version to
remove.
1) Invoke the script with a version argument.
[root@as1.example.org /] cd /var/broadworks/AS_Rel_22.0_1.1123/uninstall
Application Server:
1) Stop BroadWorks.
2) Configure the IP networking information at the UNIX level.
3) Restart BroadWorks Software Manager.
4) Update the BroadWorks network configuration.
5) Re-configure redundancy routing, if required.
6) Update the Application Server call processing routing information.
7) Update the Application Server address information on the Network Server, if required.
8) Update the Application Server address information on the Open Client Server (OCS)
application, and Xtended Services Platform, if required.
9) Re-run the EMS auto-discover process, if applicable.
10) Start BroadWorks.
Media Server:
1) Stop BroadWorks.
2) Configure the IP networking information at the UNIX level.
3) Restart BroadWorks Software Manager.
4) Update the BroadWorks network configuration.
5) If deployed with the Network Server Media Server Selection policy:
6) Update the Media Server address on the Network Server, if required.
7) If NOT deployed with the Network Server Media Server Selection policy:
Update the Media Server address on the Application Server, if required,
Network Server:
1) Stop BroadWorks.
2) Configure the IP networking information at the UNIX level.
3) Restart BroadWorks Software Manager.
4) Update the BroadWorks network configuration.
5) Re-configure redundancy routing, if required.
6) Update the Network Server routing alias list, if required.
7) Re-run the EMS auto-discover process, if applicable.
8) Update the Network Server address information on the Application Server, Open
Client Server application, and Xtended Services Platform, if required.
9) Start BroadWorks.
Profile Server:
1) Stop BroadWorks.
2) Configure the IP networking information at the UNIX level.
3) Restart BroadWorks Software Manager.
4) Update the BroadWorks network configuration.
5) Update the Profile Server HTTP Server configuration, creating new HTTP servers for
the new IP and deleting old ones. This is done from the
PS_CLI/Interface/Http/HttpServer CLI level. For more information, see the
BroadWorks Profile Server Configuration Guide.
6) Update the Profile Server HTTP Alias with the new host name as required. This is
done from the PS_CLI/Interface/Http/HttpAlias CLI level. For more information, see
the BroadWorks Profile Server Configuration Guide.
7) Update the Profile Server address information on the Xtended Services Platform, if
required.
8) Update the notification subsystem configuration, if required.
9) Update the Profile Server address information on the Network Server, if required.
10) Rerun the EMS auto-discover process, if applicable.
Execution Server:
1) Stop BroadWorks.
2) Configure the IP networking information at the UNIX level.
3) Restart BroadWorks Software Manager.
4) Update the BroadWorks network configuration.
5) Update the notification subsystem configuration.
6) Update the OCI provisioning network access list on the Profile Server.
7) Update the Execution Server address information on the Network Server, if required.
8) Rerun the EMS auto-discover process, if applicable.
9) Start BroadWorks.
Messaging Server:
1) Stop BroadWorks.
2) Configure the IP networking information at the UNIX level.
3) Restart BroadWorks Software Manager.
4) Update the BroadWorks network configuration.
5) Rerun the EMS auto-discover process, if applicable.
6) Start BroadWorks.
Sharing Server:
1) Stop BroadWorks.
2) Configure the IP networking information at the UNIX level.
3) Restart BroadWorks Software Manager.
4) Update the BroadWorks network configuration.
5) Rerun the EMS auto-discover process, if applicable.
6) Start BroadWorks.
WebRTC Server:
1) Stop BroadWorks.
2) Configure the IP networking information at the UNIX level.
3) Restart BroadWorks Software Manager.
4) Update the BroadWorks network configuration.
5) Rerun the EMS auto-discover process, if applicable.
6) Start BroadWorks.
Database Server:
NOTE 2: In a geographically redundant configuration, the host name change must be done
while the site status is “standby” and while the DBSObserver is shut. Host name modification of
the primary site is not supported.
To change the Database Server host name, the following sequence must be executed.
1) On the Profile Server, stop the DBSObserver (if configured).
bwadmin@ps$ stopbw DBSObserver
2) On the Database Server, create a hostname alias using the new host name. This can
be done by adding a CNAME record to your DNS or by adding the new host name to
the host name line in /etc/hosts, as shown in the following example.
# Do not remove the following line, or various programs
# that require network functionality will fail.
127.0.0.1 localhost.localdomain localhost
NOTE: This alias must be available to all sites in the redundant configuration and must be
defined before the old name; otherwise, during reconfiguration the old name is still used.
3) While keeping BroadWorks running, run the following command and follow the
instructions it provides.
bwadmin@oldname$ sitectl config hostname=newname.example.com
Checking parameters... [DONE]
4) Stop BroadWorks.
bwadmin@newname$ stopbw
5) Drop the old host name from the name service configuration, keeping only the new
name.
# Do not remove the following line, or various programs
# that require network functionality will fail.
127.0.0.1 localhost.localdomain localhost
8) Update the Database Server address information on the Profile Server and Execution
Server, if required.
9) Start the DBSObserver, if applicable.
10) Manually add the Database Server to the EMS configuration.
NOTE: Read the introduction section before executing the steps described in this section, as
other actions may be required.
MTLNS04$ startswman.pl
Starting SW Manager version: 635548
2 entries found.
The httpAlias level allows the definition of host alias for a given interface.
NS_CLI/Interface/Http/HttpAlias> get
Interface Alias Cluster FQDN
========================================================
192.168.12.66 myAlias.mtl.broadsoft.com
1 entry found.
Finally, the HttpBinding level allows the specification as to which web application is bind on
which interface. This functionality can be used to restrict the availability of a web
application on a specific interface. By default, httpBinding is empty, allowing any web
application to run on any interface/port combinations.
NS_CLI/Interface/Http/HttpBinding> get
Interface Port Application Name
=======================================
192.168.12.66 80 NSPortal
1 entry found.
NOTE: Read the introduction section prior to executing the steps described in this section, as
other actions may be required.
The Application Server, Network Server, and Messaging Server redundancy routing
configuration have to be modified when changing a server host name or IP address. This
is done from the UNIX prompt, by executing the peerctl command.
It is important to execute the commands in the following order:
1) Stop replication on all servers of the cluster using Repctl stop.
2) Execute the peerctl command on all servers of the cluster.
The following is an example of the peerctl command.
MTLNS04$ peerctl
Usage:
(When the hostname is optional, omitting it means the current peer)
[-dsn <dsn>] ls
[-dsn <dsn>] add <hostname> <address> <repType(0=master;1=slave)>
[-dsn <dsn>] set <originalhostname> <hostname> <address>
<repType(0=master;1=slave)>
[-dsn <dsn>] del <hostname>
[-dsn <dsn>] lock [<hostname>|all]
[-dsn <dsn>] unlock [<hostname>|all]
[-dsn <dsn>] setPrimary [<hostname>]
[-dsn <dsn>] waitAllLocked <timeout in minutes (typically 12)>
NOTE: Locking a server can be almost immediate or may take up to 10+
minutes
depending on server activity.
publicIPAddress This is the default IP address used by the Application Server for the
SIP stack and other applications. On a server with a single NIC, this is
the only parameter configured.
NOTE: It is important to validate and change (if required) the parameters listed above whenever
an IP address or host name is changed for an Application Server.
NOTE: Read the introduction section before executing the steps described in this section, as
other actions may be required.
The Application Server IP address could be configured on the Network Server. After
making changes to the IP address on the Application Server, the Network Server may also
need to be updated. If the Application Server address on the Network Server is an FQDN
or an alias, this step can be skipped.
1) Log in to the Network Server command line interface.
2) Go to the NS_CLI/System/Device/HostingNE/Address> level.
3) Add the new IP address of the Application Server.
4) Delete the old IP address of the Application Server.
The following is an example of updating the Application Server IP address on the
Network Server.
NS_CLI/System/Device/HostingNE/Address> g
Retrieving data… Please wait…
HostingNe NodeID Address type cost weight port
transport
=======================================================================
==
AS1 0 192.168.12.6 DualRouting 1 99 5060
tcp
1 entry found.
NS_CLI/System/Device/ResourceNE/Address> add AS1 0 192.168.12.7
DualRouting 1 99 5060 tcp
…Done
NS_CLI/System/Device/HostingNE/Address> g
Retrieving data… Please wait…
1 entry found.
NOTE: Read the introduction section prior to executing the steps described in this section, as
other actions may be required.
The Network Server IP address can be configured on the Application Server. After
making changes to the IP address on the Network Server, the Application Server may also
need to be updated. If the Network Server address on the Network Server is an FQDN or
an alias, this step can be skipped.
1) Log in to the Application Server command line interface.
2) Go to the AS_CLI/System/Device/NetworkServers/Routing level.
3) Add the new IP address of the Network Server.
4) Delete the old IP address of the Network Server.
The following is an example of updating the Application Server IP address on the
Network Server.
AS_CLI/System/Device/NetworkServers/Routing> get
Net Address Port Transport Poll OpState Description
=========================================================================
192.168.12.80 5060 UDP false enabled MTLNS01-DNSlong
1 entry found.
AS_CLI/System/Device/NetworkServers/Routing> add 192.168.12.70 tcp
description “MTLNS04-DNSlong” port 5060
…Done
NOTE: Read the introduction section prior to executing the steps described in this section, as
other actions may be required.
The Network Server aliases may need to be updated when modifying a Network Server IP
address.
1) Log in to the Network Server command line interface.
2) Go to the NS_CLI/System/Alias level.
3) Add the new address or domain to the Network Server alias list.
4) Delete the old IP address or domain from the Network Server alias list.
NS_CLI/System/Alias> get
127.0.0.1
192.168.13.80
NOTE: Read the introduction section prior to executing the steps described in this section, as
other actions may be required.
A Network Server for Media Server Selection can also use the Media Server IP address.
After making changes to the IP address on the Media Server, the Network Server needs
to be updated as well.
1) Log in to the Network Server command line interface.
2) Go to NS_CLI/System/Device/ResourceNE/Address level.
3) Add the new IP address of the Media Server.
4) Delete the old IP address of the Media Server.
The following is an example of updating the Media Server IP address on the Network
Server.
NS_CLI/System/Device/ResourceNE/Address> g
Retrieving data… Please wait…
Resource NE Address Cost Weight Port Transport
MS1 192.168.12.6 1 10 5679 tcp
NS_CLI/System/Device/ResourceNE/Address> g
Retrieving data… Please wait…
Resource NE Address Cost Weight Port Transport
MS1 192.168.12.7 1 10 5679 tcp
1 entry found.
NOTE: Read the introduction section prior to executing the steps described in this section, as
other actions may be required.
The Media Server IP address is most likely being used by an Application Server to stream
media. After changing the IP address on the Media Server, the Application Server needs
to be updated as well.
1) Log in to the Application Server command line interface.
2) Go to the AS_CLI/System/CallP/Routing/MediaServerSelection/MediaServerDevice
level.
3) Add the new IP address of the Media Server.
4) Delete the old IP address of the Media Server.
The following is an example of updating the Media Server IP address on the
Application Server.
AS_CLI/System/CallP/Routing/MediaServerSelection/MediaServerDevice> get
Net Address Port Transport Description
===========================================
192.168.1.1 5060 TCP
1 entry found.
AS_CLI/System/CallP/Routing/MediaServerSelection/MediaServerDevice>add
192.168.1.2 tcp port 5060
…Done
AS_CLI/System/CallP/Routing/MediaServerSelection/MediaServerDevice>delet
e 192.168.1.1
…Done
AS_CLI/System/CallP/Routing/MediaServerSelection/MediaServerDevice> get
Net Address Port Transport Description
===========================================
192.168.1.2 5060 TCP
1 entry found.
NOTE: Read the introduction section prior to executing the steps described in this section, as
other actions may be required.
When updating the Application Server and/or Network Server IP address, the
Communication Utility IP address on the Application Server, Xtended Services Platform,
and/or EMS (if applicable) must be updated.
1) Log in to the BroadWorks command line interface.
2) Go to the System/CommunicationUtility/DefaultSettings level.
3) Depending on the mode, change the IP address of either the primary or secondary
Application Server or the Network Server.
NOTE: Read the introduction section prior to executing the steps described in this section, since
other actions may be required.
The Xtended Services Platform address must be properly configured for the Location
Server function on the Network Server to work. After making changes to the IP address
on the Xtended Services Platform, the Network Server must be updated as well.
1) Log in to the Network Server command line interface.
2) Go to the NS_CLI/System/Device/XSPServerFarm/Address level.
3) Add the new IP address of the Xtended Services Platform.
4) Delete the old IP address of the Xtended Services Platform.
The following is an example of an update of the Xtended Services Platform IP
address on the Network Server.
NS_CLI/System/Device/XSPServerFarm/Address> get
XSPServerFarm NodeID Address type cost weight
============================================================
WSF 0 192.168.12.16 Access 1 50
WSF 0 mtlws01 Alias - -
WSF 1 192.168.12.18 Access 1 50
WSF 1 mtlws02 Alias - -
4 entries found.
NS_CLI/System/Device/XSPServerFarm/Address> get
XSPServerFarm NodeID Address type cost weight
============================================================
WSF 0 192.168.12.16 Access 1 50
WSF 0 mtlws01 Alias - -
WSF 1 192.168.23.12 Access 1 50
WSF 1 mtlws02 Alias - -
4 entries found.
NOTE: Read the introduction section prior to executing the steps described in this section, as
other actions may be required.
NOTE: Read the introduction section prior to executing the steps described in this section as
other actions may be required.
On a redundant EMS system, redundancy information such as the peer host name and
address need to be modified to represent the new environment. Run the update-
redundancy.pl script from the UNIX prompt on all peers.
./bwUpdatePeerInformation.pl
Usage: bwUpdatePeerInformation.pl oldValue newValue
This script is used when the hostname or the IP address has changed for
one peer.
Parameters
-------
oldValue - The previous value.
newValue - The new value.
Example:
./ bwUpdatePeerInformation.pl ems01 ems02
Updating local peer address.........[Ok]
Updating peer hostname..............[Ok]
Updating peer address...............[Ok]
Updating db replication info........[Already up-to-date]
Updating privileges.................[Ok]
NOTE: Read the introduction section prior to executing the steps described in this section, as
other actions may be required.
On the redundant EMS system, the database must be synchronized on all peers to make
sure that the replication is not lagging. If an IP address has changed, the database may
no longer be synchronized.
Import the database on the peer that has changed their IP or host name (using the
importdb.pl command from the UNIX prompt).
Network Server:
1) Exit all CLIs.
2) Restart BroadWorks.
19.1 Background
During installation and configuration of disk mirroring using Solstice DiskSuite, the Mdlogd
daemon has been set up to report problems via SNMP traps, in addition to logging them to
/var/adm/messages. These traps, in conjunction with use of DiskSuite status commands,
provide background information for maintenance actions to be taken. This section
describes the more common maintenance and administration tasks related to the mirrored
configuration used by BroadWorks. For more information, see the Solstice DiskSuite
Users Guide and the Solstice DiskSuite Reference Guide.
Solstice DiskSuite provides commands to track maintenance states and to administer
mirrors and submirrors. It also provides commands to track states and to administer
metadatabase replicas.
The following example shows re-enabling of the /bw slice on the secondary disk.
#metareplace -e d14 c0t1d0s4
NOTE: All servers should be running with key resource indicators that are within acceptable
ranges. Acceptable ranges for each of the key resource indicators listed above are defined in
the BroadWorks System Engineering Guide.
20.1.1.1.2 SNMP
On Solaris systems, file system usage can also be monitored through SNMP by polling
the Sun Management Center (SMC) mib file register krUFSFileSystemGroup.
On Linux systems, file system usage can also be monitored through SNMP by polling the
UCD-SNMP-MIB.txt MIB file register dskPercent.
Average 27 5 14 53
Total CPU Busy percentage for any given five-minute interval would be equal to %usr +
%sys.
Historical SAR results are stored in /var/adm/sa on Solaris systems and /var/log/sa on
Linux systems. Historic files can be viewed using the sar –f <filename> option.
20.1.2.1.2 vmstat
The vmstat utility can be used to manually gather averaged CPU information.
To collect five-minute averaged CPU usage, from the UNIX/LINUX prompt type vmstat
300 <count>. The <count> parameter would be the number collections to perform.
Example:
as1$ vmstat 300 5
kthr memory page disk faults cpu
r b w swap free re mf pi po fr de sr m1 m1 m1 m2 in sy cs us sy id
0 0 0 3351880 162248 30 160 23 3 4 0 1 1 0 5 1 420 506 738 3 2 95
0 0 0 3489880 255752 51 322 0 1 1 0 0 1 0 3 1 411 2242 1454 3 2 95
0 0 0 3490504 255328 31 197 0 1 1 0 0 1 0 3 1 367 1845 1392 2 1 97
0 0 0 3494720 257776 15 88 0 1 1 0 0 1 0 3 1 377 1584 1408 2 1 97
0 0 0 3492504 257352 66 436 1 2 2 0 0 2 0 4 2 395 2637 1478 5 2 92
The number of CPUs on Solaris servers can be obtained using the uname –X command.
The number of CPUs on Linux servers can be obtained using the cat /proc/cpuinfo
command.
… indicates that 796196K is the heap size after a full GC collection and 1572800K is the
maximum heap size. After this full collection, 796196/1572800 or 51% of the 1.5 GB heap
is in use.
To obtain the maximum post-collection heap size for a given day, the XSOutputXX.log
files should be analyzed. The post full collection heap sizes throughout the day can be
obtained using a simple awk statement such as:
$ cat XSOutput24.log |awk '$2=="[CMS-concurrent-reset:"{getline;print}' >> post-
coll-heap.out
You can now obtain the maximum post-collection heap size from the post-coll-heap.out
file. For example, if post-coll-heap.out contains the following.
bwadmin@serv1$ sar –W
63741.292: [GC 163741.292: [ParNew: 24448K->0K(24512K), 0.0691374 secs]
608826K->588221K(1572800K), 0.0693588 secs]
164113.614: [GC 164113.615: [ParNew: 24448K->0K(24512K), 0.0709264 secs]
606385K->585812K(1572800K), 0.0711760 secs]
164490.619: [GC 164490.619: [ParNew: 24448K->0K(24512K), 0.0677227 secs]
608213K->587808K(1572800K), 0.0679470 secs]
164862.511: [GC 164862.511: [ParNew: 24448K->0K(24512K), 0.0831934 secs]
606974K->586070K(1572800K), 0.0834866 secs]
165226.308: [GC 165226.308: [ParNew: 24448K->0K(24512K), 0.2493387 secs]
606804K->586216K(1572800K), 0.2496168 secs]
165603.667: [GC 165603.667: [ParNew: 24448K->0K(24512K), 0.0679746 secs]
610465K->589446K(1572800K), 0.0682067 secs]
… 589446K is the maximum post-collection heap size for that day and 1572800K is the
configured maximum heap size.
NOTE: Database size monitoring for the Database Server (Oracle database) is done through
File System Monitoring.
PERM_ALLOCATED_SIZE: 141312
PERM_IN_USE_SIZE: 69966
PERM_IN_USE_HIGH_WATER: 70412
TEMP_ALLOCATED_SIZE: 43008
TEMP_IN_USE_SIZE: 12693
TEMP_IN_USE_HIGH_WATER: 16276
MS_CLI/Monitoring/PM/MediaServer> get
smtp/secondary/msSecondarySmtpErrors
*msSecondarySmtpErrors 0
MS_CLI/Monitoring/PM/MediaServer> get
sip/msSipStatsInvite200OKRetransmitsOuts
*msSipStatsInvite200OKRetransmitsOuts 1027
MS_CLI/Monitoring/PM/MediaServer> get
sip/msSipStatsRequestRetransmittedIns
*msSipStatsRequestRetransmittedIns 43622
(1) bwNSSystemInternalQueueIndex
(2) bwNSSystemInternalQueueName
(3) bwNSSystemInternalQueueSize
(4) bwNSSystemInternalQueueTimeAvg
(5) bwNSSystemInternalQueueTimeMin
(6) bwNSSystemInternalQueueTimeMax
(7) bwNSSystemInternalQueueTimeMaxTimestampMSB
(8) bwNSSystemInternalQueueLengthCurrent
(9) bwNSSystemInternalQueueLengthAvg
(10) bwNSSystemInternalQueueLengthMax
(11) bwNSSystemInternalQueueLengthMaxTimestampMSB
(12) bwNSSystemInternalQueueLengthMaxTimestampLSB
(13) bwNSSystemInternalQueueTimeMaxTimestampLSB
(1)
(2) (3) (4) (5) (6) (7) (8) (9) (10)
(11) (12) (13)
Although all queue statistics serve a purpose, the following have a direct impact on call
processing and should be monitored.
SipRedirectSessionManager – These queue statistics refer to the Network Server call
processing thread. This thread processes the incoming INVITEs and provides a
redirection response. A delay in this queue would translate to a delay in
inbound/outbound PSTN calls.
SIP EncodeQ – This queue statistic is related to the encoding and building of outgoing
SIP messages. A delay in this queue results in outgoing messages being backed up.
SIP DecodeQ – This queue statistic is related to the decoding of incoming SIP messages.
A delay in this queue results in incoming messages being backed up.
The two parameters to monitor for each queue are as follows:
bwSystemInternalQueueTimeAvg – The average queue holding time. Note that this
value is in 1/1000 milliseconds, that is, divide by 1000 for the value in milliseconds. It is
recommended that it should be polled and reset once every 15 minutes. High average
queue delays during server busy hour could be an indication of a performance problem.
bwSystemInternalQueueTimeMax – The queue delay high-water mark. It should be
polled and reset once every 15 minutes. Consistent hourly high-water marks (for
example, four polling intervals) of more than one second or any single high-water mark of
more than five seconds should be reported to BroadSoft Support.
NS_CLI/Monitoring/PM/NetworkServer> pwd
broadworks/nsExecutionServer/protocol/sip/
(1) errStatID
(2) errStatName
(3) errStatNbOccurences
This table can (optionally) be polled once a day for trending purposes.
Not all treatment codes report a problem. For example, invld is pegged when a user dials
an invalid number and therefore it is not representative of a problem, while unkgw would
indicate a problem, since it means that the requesting device is not known to the Network
Server. As such, only occurrences of following treatments must be investigated:
bdgwy – bad gateway
bdreq – not acceptable
frbdn – Network Server refuses to process the request
noimp – functionality not supported
nserr – Network Server error
reqto – Network Server request timeout
sbovf – service bus re-enter overflow
srvto – Network Server timeout
srvun – Network Server unavailable
(1) neStatID
(2) neStatName
(3) neStatNbSIPRequests
(4) neStatNbSIPRequestsFailures
(5) neStatNbMSSRequests
(6) neStatNbMSSRequestsFailures
This table can (optionally) be polled once a day for trending purposes.
neStatNbSIPRequests – This counter allows monitoring the amount of traffic the Network
Server is receiving for all known nodes. If useDomainForSubscriberAddress is set to
“true” on the Application Server, the Network Server tracks INVITEs per user domain, not
per Application Server identity.
Performance Measurement Int Node Type Threshold
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
In general, SIP signaling delays provide a view on any delays that are affecting call
processing. The Application Server does provide Execution Server process internal
queue statistics as well. Even though these delays should be covered in the SIP signaling
delays, monitoring Execution Server internal queue statistics is recommended.
AS_CLI/Monitoring/PM/ApplicationServer> get
-------------------------------------------------------------------------
broadworks/executionServer/systemModule/internalStats/
-------------------------------------------------------------------------
*bySystemInternalQueueResets 0
bwSystemInternalQueueTable:
(1) bwSystemInternalQueueIndex
(2) bwSystemInternalQueueName
(3) bwSystemInternalQueueSize
(4) bwSystemInternalQueueTimeAvg
(5) bwSystemInternalQueueTimeMin
(6) bwSystemInternalQueueTimeMax
(7) bwSystemInternalQueueTimeMaxTimestampMSB
(8) bwSystemInternalQueueLengthCurrent
(9) bwSystemInternalQueueLengthAvg
(10) bwSystemInternalQueueLengthMax
(11) bwSystemInternalQueueLengthMaxTimestampMSB
(12) bwSystemInternalQueueLengthMaxTimestampLSB
(13) bwSystemInternalQueueTimeMaxTimestampLSB
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
System-wide call processing statistics are available to help monitor system performance.
Example:
AS_CLI/Monitoring/PM/ApplicationServer> pwd
broadworks/executionServer/callpModule/callpStats/
AS_CLI/Monitoring/PM/ApplicationServer> get
bwCallpNetworkOriginationAttempts
*bwCallpNetworkOriginationAttempts 2365
AS_CLI/Monitoring/PM/ApplicationServer> get
bwCallpUserOriginationAttempts
*bwCallpUserOriginationAttempts 3008
AS_CLI/Monitoring/PM/ApplicationServer> get
bwCallpUserTerminationsAnswered
*bwCallpUserTerminationsAnswered 2542
AS_CLI/Monitoring/PM/ApplicationServer> get
bwCallpNetworkOriginationAttempts
*bwCallpNetworkOriginationAttempts 2379
AS_CLI/Monitoring/PM/ApplicationServer> get
bwCallpNetworkTerminationAttempts
*bwCallpNetworkTerminationAttempts 3454
AS_CLI/Monitoring/PM/ApplicationServer> get
bwCallpNetworkTerminationsAnswered
*bwCallpNetworkTerminationsAnswered 1971
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
NOTE: This section is valid for the Profile Server as well (Provisioning application).
Release 13.0 introduced the open client interface (OCI) for unified provisioning. All
provisioning transactions initiated regardless of source (web, CLI, or external third party
OCI client) go through the OCI. There are performance measurements that can be
monitored to track provisioning performance.
Example:
AS_CLI/Monitoring/PM/ApplicationServer> pwd
broadworks/provisioningServer/psOciModule/psOciStats/
AS_CLI/Monitoring/PM/ApplicationServer> get
psOciStatsMaxRequestResponseTime
*psOciStatsMaxRequestResponseTime 6685
OCI Messages Per Second (Key Performance Indicator) – OCI MPS rate can be used
to identify changes in provisioning traffic.
OCI_MPS= Delta [psOciStatsNbUpdateRequests + psOciStatsNbQueryRequests +
psOciStatsNbAuthorizationRequests] / Polling_Interval_In_Seconds
psOciStatsRequestResponseTime – This gauge indicates the average time (in
milliseconds based on a rolling average of the last 100 samples) it takes to process an
OCI request.
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
There are SIP-related and MGCP performance measurements that can be used to
monitor system performance.
AS_CLI/Monitoring/PM/ApplicationServer> pwd
broadworks/executionServer/sipModule/sipStats/
AS_CLI/Monitoring/PM/ApplicationServer> get
bwMGCPStatsMaxDialToneDelay
*bwMGCPStatsMaxDialToneDelay 578
AS_CLI/Monitoring/PM/ApplicationServer> get
bwMGCPStatsSetupSignalDelay
*bwMGCPStatsSetupSignalDelay 89
AS_CLI/Monitoring/PM/ApplicationServer> get
bwMGCPStatsMaxSetupSignalDelay
*bwMGCPStatsMaxSetupSignalDelay 4276
AS_CLI/Monitoring/PM/ApplicationServer> get
bwMGCPStatsAnswerSignalDelay
bwMGCPStatsAnswerSignalDelay 17
AS_CLI/Monitoring/PM/ApplicationServer> get
bwMGCPStatsMaxAnswerSignalDelay
*bwMGCPStatsMaxAnswerSignalDelay 255
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
The Application Server keeps track of SIP retry percentages to network-side nodes such
as Media Servers, Network Servers, other Application Servers, and PSTN interconnection
nodes (softswitch or network gateways).
AS_CLI/Monitoring/PM/ApplicationServer> pwd
broadworks/executionServer/sipModule/sipStats/
AS_CLI/Monitoring/PM/ApplicationServer> get
bwSipStatsMsgRetryToNeTable
bwSipStatsMsgRetryToNeTable:
(1) bwSipStatsMsgRetryToNeID
(2) bwSipStatsMsgRetryToNeAddr
(3) bwSipStatsMsgRetryToNePercentage
This table should be polled daily to get a view of retry percentages to various nodes. A
retry percentage more than two percent to any network-side node should be investigated.
Session border controllers show up in the list as well. The retry percentage to these
nodes should be ignored since they include retries to access devices.
Performance Measurement Int Node Type Threshold
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
The Application Server tracks responses to all SIP methods received and sent. This can
be useful in “trending” responses to monitor for changes in call processing behavior (that
is, a sudden increase in a specific negative response).
AS_CLI/Monitoring/PM/ApplicationServer> get
bwSipStatsInviteResponsesTable
bwSipStatsInviteResponsesTable:
(1) bwSipStatsInviteResponseCodeValue
(2) bwSipStatsInviteResponseIns
(3) bwSipStatsInviteResponseOuts
NOTE: This section is valid for the Profile Server as well (Provisioning application).
Release 13.0 introduced the BroadWorks Common Control Transport (BCCT) protocol.
BCCT is used to transport OCS to Application Server OSS/OCI messages, Application
Server to Network Server NSSYNC messages, third-party OCI provision systems, and
some internal functions such as protocol monitoring. BCCT queue statistics can optionally
be monitored.
Example:
AS_CLI/Monitoring/PM/ApplicationServer> get -r
-------------------------------------------------------------------------
-----
broadworks/provisioningServer/psSystemModule/psInternalStats/
-------------------------------------------------------------------------
-----
*psSystemInternalQueueResets 0
psSystemInternalQueueTable:
(1) psSystemInternalQueueIndex
(2) psSystemInternalQueueName
(3) psSystemInternalQueueSize
(4) psSystemInternalQueueTimeAvg
(5) psSystemInternalQueueTimeMin
(6) psSystemInternalQueueTimeMax
(7) psSystemInternalQueueTimeMaxTimestampMSB
(8) psSystemInternalQueueLengthCurrent
(9) psSystemInternalQueueLengthAvg
(10) psSystemInternalQueueLengthMax
(11) psSystemInternalQueueLengthMaxTimestampMSB
(12) psSystemInternalQueueLengthMaxTimestampLSB
(13) psSystemInternalQueueTimeMaxTimestampLSB
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
The Application Server uses defined SMTP servers to send e-mail for features such as
Call Notify and Voice Messaging Notification. The Application Server tries the primary
SMTP server; if that server does not respond within 30 seconds, the Application Server
tries the secondary server.
AS_CLI/Monitoring/PM/ApplicationServer> get -r
--------------------------------------------------
broadworks/executionServer/smtpModule/smtpStats/
--------------------------------------------------
*bwSMTPTotalPrimaryEmailSendAttempts 559
*bwSMTPTotalSecondaryEmailSendAttempts 0
*bwSMTPPrimaryUnSuccessfulEmailSendAttempts 0
*bwSMTPSecondaryUnSuccessfulEmailSendAttempts 0
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
When using BroadWorks Voice Messaging, the Application Server is responsible for
connecting to the user’s mail server and downloading messages that are played back via
the voice portal. Each time a user logs in to the voice portal, the Application Server
connects as a mail client to the user’s mail account using the provisioned credentials.
Voice messaging retrieval statistics can be monitored.
Example:
AS_CLI/Monitoring/PM/ApplicationServer> get -r
-------------------------------------------------------------------------
-----
broadworks/executionServer/imsModule/imsStats/
-------------------------------------------------------------------------
-----
*bwIMSSuccessfulConnectionAttempts 285
*bwIMSUnsuccessfulConnectionAttempts 4
*bwIMSSuccessfulDownLoadAttempts 350
Broadworks/executionServer/databaseModule/databaseStats/timesTen/
-------------------------------
*bwXSUpdateCount 3568
*bwXSQueryCount 43165
broadworks/provisioningServer/psDatabaseModule/psDatabaseStats/psTimesTen
--------------------------------
*bwPSUpdateCount 6702
*bwPSQueryCount 21992
bwSystemHealthReport:
Sent when healthmon task has been activated.
bwDatabaseSyncReport:
Sent when the synchcheck_basic.pl task has been activated on Application Servers,
Network Servers, and Messaging Servers.
The synchcheck_basic.pl does a quick non-service impacting comparison of the
number of table rows in two peer databases.
Should be scheduled to run once a night (off-peak hours) on the secondary server.
Do not activate on the primary server.
A trap is only sent whenever the script executes. It is notification severity when
databases are the same and critical severity when a discrepancy is detected.
NOTE: Before escalating this trap to BroadSoft Support, manually run synchcheck_basic.pl
again. It is possible that during the snapshot test, not all replicated information was pushed, or
that tables were in flux.
msSmtpFailure
Media Server could not relay the recorded voice messaging e-mail through the
requested SMTP server.
Usually indicative of a problem on the SMTP server.
msMemAllocFailure
Media Server IVR process does not have enough memory.
Every instance of this trap means that the Media Server could not allocate memory for
the call and the call fails.
IVR memory can be increased under CLI level MS_CLI/Service/IVR, parameter
memorySize.
msNoPortAvailableErrors
This trap occurs every time a request comes to the Media Server and it cannot
process it due to licensing limits.
The Application Server should route advance to the next Media Server.
From Release 12 and higher, the number of ports a Media Server can support is
calculated based on hardware type. The different port numbers are defined in file
/usr/local/broadworks/bw_base/conf/hardware_cap.csv. If the hardware type is not
known, the Media Server calculates the maximum number of ports based on number
of CPUs and CPU speed.
bwNSSynchUpdateFailureError
The Network Server could not process a synchronization request from an Application
Server (for example, to add or delete an enterprise, group, or user).
The reason text should provide a clear explanation as to why the synchronization
failed. A synchronization failure results in a failure on the Application Server for that
specific task.
One of the main causes for synchronization errors once an Application Server and
Network Server have been synchronized is attempting to assign a directory number
(DN) to an Application Server user that does not meet the valid NDC format for that
country code.
bwLicenseThreshold
This trap is generated when a Network Server reaches 80% of the license file defined
transactions per time period value.
Once a Network Server hits the maximum transactions in the defined time period
window, it returns a SIP “503 Service Unavailable” to all SIP requests.
This condition can be the result of a routing loop between the PSTN and BroadWorks.
For example, the PSTN considers that a number is owned by BroadWorks and
BroadWorks considers that the number is owned by the PSTN and the routingNE has
an off-net policy that causes the call to route back to the PSTN.
bwNSCallGotTreatment
This informational severity trap is not necessarily indicative of a problem, but it could
be used as a flag whenever the Network Server hits a specific treatment.
On the Network Server under NS_CLI/System/CallP/Treatment>, you can enable
which treatments result in a trap. By default, all are enabled.
You may want to disable all traps and then enable only ones for treatments for which
you are most interested. For example, “unkgw” means the Network Server received a
SIP request from a device it does not recognize.
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
The Application Server must be able to reach defined SMTP server(s) to support features
such as Call Notify and Call Center Statistics Reporting. If none of the defined SMTP
servers can be reached, a bwSMTPConnectivityFailure trap is generated.
The Application Server Voice Messaging service uses a standard POP3/IMAP protocol to
store user’s voice mail. The Application Server must be connected to the user’s mail
server account to retrieve messages and manage the mailbox. Any one of the following
traps would indicate a problem related to Application Server Voice Messaging service for a
user:
bwIMSConnectionFailure
bwIMSRetrieveMessageError
bwIMSRetrieveMailBoxInfoError
bwIMSUpdateMailBoxError
bwIMSCloseConnectionError
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
bwMediaServerNotResponding
This trap is generated when a Media Server fails to respond to an Application Server
request in the allotted time. On the initial INVITE to the Media Server, the Application
Server uses the re-transmission parameters defined under the CLI level
AS_CLI/System/CallP/Routing/MediaServerSelection> MediaServerTimerLength.
By default, this timer is set to 1500 milliseconds. In general, a Media Server should
respond back within 1.5 seconds. Occurrences of this trap must be investigated to see if
the timer needs to be increased for a specific network.
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
These traps are generated on the Application Server in the event of a failure to push
user/group additions/deletions to the Network Server.
bwNSSynchronizationConnectivityFailure
The Application Server could not open a TCP socket (or the established socket failed) to
the Network Server. An occasional occurrence of this trap is not an issue. The
Application Server re-opens the socket to the NetworkServer. However, continuous
occurrence of this trap indicates a connection problem and it must be escalated to
BroadSoft Support.
bwNSSynchronizationFailure
This trap is generated on the Application Server when an attempt to synchronize a
group/user addition/deletion failed. The trap contains detailed information about the
failure. There should be a corresponding trap on the Network Server as well.
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
These traps are generated on a per-call basis by the Application Server. Most are
classified as low severity, but a carrier should understand why they are occurring.
bwAuditAbnormalCallTermination
The Application Server audits (send a re-INVITE or UPDATE) every active call. If the
endpoint fails to respond, this trap is generated and the CDR release cause indicates an
AbnormalCallTermination reason. Session audit is controlled at the following CLI levels:
AS_CLI/System/CallP/SessionAudit> active = true
AS_CLI/Interface/SIP> sessionAuditAllowed = true
A session audit should NOT be disabled, as this can lead to a hanging session. The
default session audit interval is 10 minutes for every call. The interval is controlled with the
following CLI parameter (in seconds):
AS_CLI/System/CallP/SessionAudit> interval = 600
If you are experiencing a large number of these traps, it can indicate an interoperability
issue with a specific device type.
bwSipServiceUnavailableReceived
This trap is generated in the event of an endpoint returning a 5xx SIP response. An
endpoint returning a 5xx response (for example, 500 or 503) generally means that the
device could not handle the call and depending on when the 5xx is received either results
in a call failure or the Application Server route advancing to the next contact.
This trap must be investigated by the carrier as it is indicative of a potential issue in the
network (for example, a device problem or no circuits were available on the PSTN
interconnect).
bwSipMaxRetriesExceeded
This trap indicates that the Application Server tried to send a SIP message to a device and
the device did not respond within the allotted time allowed in SIP. This can be considered
normal when a device is no longer available (for example, a SIP phone is unplugged).
When there are a large number of these traps, it must be investigated by the carrier.
bwSipAuthenticationFailure
This trap is generated when a SIP user has authentication enabled and the authentication
process fails. This is indicative of devices trying to register without the proper credentials.
These should be investigated by the carrier to determine the source device.
NOTE: This section is valid for the Execution Server as well (ExecutionDataless application).
The following traps are generated on the Application Server whenever a serious problem
occurs with one of the call processing internal threads. The thread should be restarted
automatically, but any occurrence of these traps needs to be escalated to BroadSoft
Support to make sure the root cause of the thread death is understood.
bwForcedExitDueToHungThread
bwCallPThreadAutoRestart
Less serious than a thread death, a call processing thread can be delayed. A delay
can occur for various reasons. The following trap is generated whenever one of the
existing call processing threads is delayed for more than 2.5 seconds.
bwThreadDelayDetected
Any occurrence of this trap needs to be escalated to BroadSoft Support to make sure
the root cause of the thread death is understood.
AS_CLI/Maintenance/Scheduler> get
Id Name Date Day Hour Minute
===========================================================
2 healthmon - - - 30
2 entries found.
Under usual operating conditions, healthmon sends a SNMP trap with severity equal to
Informational. If healthmon detects a problem, the trap severity reflects the severity of the
problem and provides recommendation text on how to proceed.
Following is a sample output when replication is not running.
--------------------------------
System Health Report Page
BroadWorks Server Name: as1
Date and time : Thu Aug 7 09:56:41 EDT 2003
Report severity : CRITICAL
Server type : AppServer
--------------------------------
Replication: a remote server is not receiving replication updates.
Databases may be out-of-synch.
--------------------------------
Recommendations
---------------
Replication must be started on all remote servers (repctl start). If
databases are out-of-synch, they must be re-synchronized first (with the
importdb.pl tool). Please refer to the BroadWorks Maintenance Guide for
detailed procedures.
--------------------------------
Following is a sample output when database replication lagging and notification lagging
are detected.
--------------------------------
System Health Report Page
BroadWorks Server Name: as2
Date and time : Fri Jun 6 13:44:19 EDT 2003
Report severity : CRITICAL
Server type : AppServer
--------------------------------
Recommendations
---------------
Replication is severely lagging on one of the servers in the cluster. If
the system is being operated in standalone mode, turn off replication.
Otherwise, import the database from the server exhibiting the lagging to
ensure prompt data synchronization.
Healthmon, when run with the -d option, provides details on database replication lagging
and database notification lagging. For more information, see the healthmon description in
section 11.1.2 TimesTen Replication Monitoring.
The healthmon script can also be run manually from the UNIX prompt or from the
command line interface under AS_CLI/Maintenance/Tools. Healthmon should be
manually run on all servers after any maintenance task has been performed.
Redundancy/Replication Status
-----------------------------
File Replication pid(s) = 29846
Datastore name = AppServer
Replication Agent Policy : always
Replication State
MTLAS04: (filerep: started) (database: started)
MTLAS01: (filerep: started) (database: started)
A Replication Agent policy set to “always” indicates that the replication process is running.
A Replication Agent policy set to “never” indicates that the replication process is not
running. The File Replication pid represents the process ID used by the RSYNC process.
AS_CLI/Monitoring/PM/ApplicationServer> get
-----------------------------------------------------------------
broadworks/executionServer/redundancyModule/redundancyStats/
------------------------------------------------------------------
nbOfMigratedUsers 2
The system provider should set up threshold alarms to provide SNMP traps when the
number of migrated users crosses a certain threshold. Two threshold alarms should be
configured, one for low severity and the other for medium severity. The low severity trap
provides an indicator for an acceptable amount of migrations. The medium severity trap
provides an indicator that a large number of users have been migrated and should be
investigated.
Depending on network reliability, the high and low notification values may need to be
adjusted based on the service provider’s network.
Once a migration problem has been identified, the actual migrated users can be identified
using the CLI under the System/Redundancy/MigratedUsers level. This information can
be helpful to identify the root cause of the problem.
AS_CLI/System/Redundancy/MigratedUsers> get
User ID
======================
fred@vox.com
mkushnir@broadsoft.com
NOTE: The synchcheck_full.pl script performs a row-by-row comparison of the peer databases.
This script severely affects performance in that it locks both peer databases during the compare.
In addition, synchcheck_full.pl requires twice the amount of the database size memory free on
the server running the script, since the peer database is imported and compared in memory. It is
not recommended to run synchcheck_full.pl on a production server.
The valid time zones supported by the BroadWorks Application Servers are stored in the
following configuration files:
TimeZoneAlias.conf
TimeZoneAliasLabels.conf
TimeZoneAlias.conf contains a list of valid time zones. Each line has a time zone ID
display name and a supported flag. If the supported flag is set to “Y”, then the time zone
can be used by users and groups. All time zones used in BroadWorks should be included
in the TimeZoneAlias.conf file. A system default time zone can be configured for the
Application Server that is running BroadWorks. The default time zone is also a supported
time zone even if it is not included in the TimeZoneAlias.conf file.
TimeZoneAliasLabels.conf contains a list of labels for those supported time zones in the
TimeZoneAlias.conf file. Each line contains two values; the first one is the time zone
display name, which has to match the display name value in the TimeZoneAlias.conf file.
The second value is the label used to display the time zones. For more information on
how to localize this file for multiple languages, refer to the BroadWorks Web Portal
Customization and Localization Guide.
The list of supported time zones are returned by the
SystemTimeZoneGetListRequest OCI-P command, and can be viewed on the web
portal as a drop-down list wherever the time zone can be assigned. This includes the
Group Profile, User Profile, and Call Center Profile pages.
When a time zone is assigned to a user or group for example, it is validated against the list
of supported time zones as mentioned above. However, after a time zone is assigned, it
can become invalid after one (but not limited to) of the following changes:
The time zone is removed from the TimeZoneAlias.conf file or not “supported” any
longer.
The system default time zone is not in the TimeZoneAlias.conf and has been
changed.
The time zone name is changed in java following a system/java upgrade.
If a group has an invalid time assigned, the system default time zone is returned as part of
the group profile, when requested. If a user (real user or virtual user such as call center or
hunt group) has an invalid time zone, the group time zone (or the system default time zone
if the group time zone is invalid) is returned as part of the user profile.
When adding or modifying a user or a group, only the valid time zones can be assigned or
modified.
22.1 bwBackup.pl
Usage – bwBackup.pl <dsn> <file>
NOTE: A database backup can also be initiated from the CLI /Maintenance/Tools level using the
backupdb command.
Description – This script backs up the content of the BroadWorks TimesTen datastore to
the specified directory. Database backups can be initiated with the application running.
22.2 bwCPUMon
Usage – bwCPUMon [-h]
Description – CPU monitoring script (for CPU idle percentage, and memory usage) that
can be used to automatically generate a trap with severity level depending on the
configured idle time threshold that has been surpassed. This script should be set up via
the CLI as a configurable maintenance task at five-minute intervals.
The generated BroadWorks traps are:
bwCPUIdleTimeLimitReached (multiple thresholds)
bwMemoryLimitReached (one threshold)
22.3 bwListPortInUse
Usage – bwListPortInUse
Description – This tool provides a list of all ports transmission control protocol (TCP) and
user datagram protocol (UDP) configured to be used by BroadWorks.
Sample of bwListPortInUse:
Usage Type Port Internal
-------------------------------------------------------------------
SNMP agent UDP 8001 N
SNMP agent trap server TCP 30002 Y
MO daemon TCP 7120 Y
MO root daemon TCP 7121 Y
SW Manager TCP 2223 N
SW Manager (Perl) TCP 2224 Y
TimesTen Main Daemon TCP 17003 N
XLA Server TCP 2048 Y
Replication port TCP 17888 N
ASR interface UDP 5090 N
CAP Server TCP 2206 N
MGCP interface UDP 2727 N
SMDI server UDP 11234 N
SIP listening port UDP 5060 N
NOTE: A database restore can also be initiated from the CLI /Maintenance/Tools level using the
restoredb command.
Description – This script restores the content of the BroadWorks TimesTen datastore
from the specified directory. The content must have previously been backed up with
bwBackup.pl.
There can be no connection to the database when restoring a database (the application
must be stopped and replication must also be stopped). Logs for the database restore
can be found in /var/broadworks/restore.log.
22.5 bwshowver
Usage – bwshowver
Description – This script is used to view the active BroadWorks release and applied
patches. For a list of applied patches, use the bwshowver –showPatch option.
Sample of bwshowver:
bwadmin@viras01.mtl.broadsoft.com$ bwshowver
AS version Rel_17.0_1.430
Patching Info:
Active Patches: 0
22.6 bwTestDaemon.pl
Usage – bwTestDaemon.pl [-h]
Description – This command should be used to validate that the MoDaemon and
MoDaemonRoot are properly configured and operational on the target server.
Sample of bwTestDeamon.pl:
bwadmin@MTLAS04$ bwTestDaemon.pl
************************************************************
* BroadWorks bwTestDaemon.pl *
* *
* Version: 1.0 *
************************************************************
Validating data
Validating configuration
Validating bwMoDaemon
... Found port value: 7120
Validating bwMoDaemonRoot
... Found port value: 7121
Done
22.7 check_dbpages.pl
Usage – check_dbpages.pl <dsn> <detect|modify>
Description – This utility is used to optimize the paging in the database. The detect
option can be used to check if any table is either undersized or oversized, and the modify
command is used to perform the optimization.
NOTE: This script should be executed during a maintenance window as it causes the database
to be temporarily locked.
************WARNING************
connect "dsn=networkserver";
Connection successful:
DSN=NetworkServer;UID=bwadmin;DataStore=/usr/local/broadw
orks/bw_base/persistent/NetworkServer;AutoCreate=0;LogFileSize=8;DurableC
ommits=
0;WaitForConnect=0;DRIVER=/usr/local/TimesTen/tt_base/lib/libtten.so;SMPO
ptLevel
=1;LogBuffSize=8192;Authenticate=0;PermSize=128;TempSize=42;
(Default setting AutoCommit=1)
run /tmp/tmp_file.sql;
exit;
Disconnecting...
Done.
Data Gathering
What is the new hostname? [as1]^C
as1$ config-hostname ?
---- Hostname Configurator version 1.0 ----
Data Gathering
What is the new hostname? [as1]
What is the new address? [as1.lab.broadsoft.com]
Changing system hostname
Please enter root password:
Setting new hostname to as1… [done]
now processing /etc/hosts… [done]
now processing /etc/nodename… [done]
now processing /etc/net/ticlts/hosts… [done]
now processing /etc/net/ticots/hosts… [done]
now processing /etc/net/ticotsord/hosts… [done]
now processing /etc/hostname.dmfe0… [done]
22.9 config-redundancy
Usage – config-redundancy
Description – This utility is used to add a peer to a cluster. It calls the config-ssh utility.
22.10 config-ssh
Usage –./config-ssh [-createKeys | -remote] peer1 peer2 …
Description – This is an SSH configuration utility that is used to create keys, propagate
them to other peers, and ensure connectivity between the peers.
Options:
createKeys allows SSH keys to be created for each peer
remote requests that peers do not iterate down to other peers
peer1 peer2 … are the FQDN (equal to host name) of all peers.
WARNING: The dbsetup script is wrapped by other BroadWorks scripts and should not be run
unless requested by BroadSoft Support.
Description – This script encompasses all aspects of database setup. It may perform
one or more of the following steps depending on the desired configuration:
Backs up the datastore to upgrade.
Installs a fresh datastore, meaning that tables are created and basic data fill is added
(using the -install option).
Populates the list of redundant peers.
Locks all redundant servers before performing an upgrade.
Unlocks the current server once an install or upgrade is complete.
Upgrades a previous datastore (the backup version is restored in the new location
and patches are applied).
It uses directly or indirectly the following scripts:
applyPatches.sh
dbpatch.sh
peerctl
bwBackup.pl
bwRestore.pl
applyPatches.sh
22.12 getDbSize.pl
Usage – getDbSize.pl <dsn>
Where – dsn - Datastore name (either CallCenterRDB, radius, or WebNmsDB)
Description – This tool provides the MySQL database size of the given datastore name.
It is available for the Element Management System.
22.13 healthmon
Usage – healthmon <-h|-v|-s|-l|-c> [-p] [-d] [5,10,15,20,30,60,120,720,1440,remove,show]
Options – Options are as follows:
-h: print this usage note
-v: print the version of the script
-s: generate a report and send the result through an SNMP trap
-l: generate a local to screen
-p: test only the disk partitions status
-d: generate a detailed trace of all the tests executed
22.14 importdb.pl
Usage – importdb.pl <local dsn> <remote hostname> <remote dsn>
Where:
local dsn – Local datastore name (either AppServer or NetworkServer)
remote host name – Remote server UNIX host name
remote dsn – Remote datastore name (either AppServer or NetworkServer)
NOTE: A database import can also be initiated from the CLI Maintenance/Tools level using the
importdb command.
Description – This script imports the content of a remote database in the specified
datastore. The remote server must have its replication enabled. Logs for the database
import can be found in /var/broadworks/importdb.log.
[Execution Completed]
bwadmin@ems2$
22.15 installdialplan.sh
Usage – ./installdialplan.sh <NS version> [--run-once]
Description – This script is used to install new dial plans on the Network Server. Dial
plan files can be created offline and loaded by placing the new dial plan in the
/usr/local/broadworks/bw_base/persistent/setup/dataoptional directory and updating the
choice.lst with the new entry.
Sample of $ ./installdialplan.sh NS_Rel_8.0_1.43:
CC Name
--------------
1 NADP
1 NADP_E164
1 NADPCAC
Which dial plan would you like to install (enter number only)? 65
To ensure that replication can function properly, you must generate ssh
keys for
the new routing address '192.168.13.172' by using the 'config-ssh -
createKeys' utility
As indicated, ssh keys, for the new interface must be generated as follows.
bwadmin@mtlsol25$ config-ssh -createKeys bwadmin@<new-replication-
address-on-Prim> bwadmin@<new-replication-address-on-Secondary>
If you want to clear the routing address and put back the initial settings, execute the
following command.
bwadmin@mtlsol25$ peerctl clearReplicationAddress MTLSOL-25
WARNING: When the cluster is locked through the peerctl lock all command, the device
registrations and provisioning changes are prevented.
22.18 repctl
Usage – /usr/local/broadworks/bw_base/bin/repctl {start|stop|restart|status}
Description – This script is used to start, stop, and get the status of file and database
replication. This script should always be used to start and stop replication as it performs a
cleanup. SSH must be properly configured before starting replication. Failing to configure
SSH leads to broken file replication. A lock file is created in /var/broadworks/lock/repctl to
prevent multiple instances from running simultaneously.
Sample of status when replication is started:
bwadmin@mtl64lin10.mtl.broadsoft.com$ repctl status
Redundancy/Replication Status
-----------------------------
File Replication pid(s) = 4011
Datastore name = NetworkServer
Replication Agent Policy : always
Replication State
mtl64lin10.mtl.broadsoft.com: (filerep: started) (database: started)
mtl64lin17.mtl.broadsoft.com: (filerep: started) (database: started)
Redundancy/Replication Status
-----------------------------
File Replication pid(s) =
Datastore name = NetworkServer
Replication Agent Policy : manual
Replication Manually Started : False
Replication State
mtl64lin10.mtl.broadsoft.com: (filerep: stopped) (database: stopped)
mtl64lin17.mtl.broadsoft.com: (filerep: stopped) (database: stopped)
22.19 resizeDSN
Usage – resizeDSN
WARNING: The resizeDSN tool requires the application to be stopped. This tool should be
used with caution and only used following an explicit acknowledgement from BroadSoft Support
personnel.
Description – This command can be used to resize the Application Server, Network
Server, or Messaging Server DSN. This tool can only be run as root.
NOTE: For information on database sizing, see the BroadWorks System Engineering Guide.
22.20 showrun
Usage – showrun
Description – This script is used to view all active BroadWorks processes. An empty list
means the application is not running.
Example of showrun:
bwadmin@MTLAS01$ showrun
tnameserver (pid=2296)
22.21 startbw
Usage – startbw
Description – This script is used to start the BroadWorks application. As part of the
startup sequence, this script also checks if database replication is lagging on any peers in
the cluster.
Example of startbw:
bwadmin@mtl64lin12.mtl.broadsoft.com$ startbw
BroadWorks control script version 17.0
Starting BroadWorks...
22.22 frepctl
Usage – frepctl <-start|-stop|-restart> [-daemon] [-once] [peer list] [-i, --interval timeInSec,
default 600] [-v, --verbose] [-h, --help]
WARNING: The rep.conf file should only be modified after consulting BroadSoft Support
personnel. Adding new directories to file replication may affect system performance. This script
is called from the repctl script and under normal conditions, should not be run manually.
Description – This command is used to start RSYNC file replication. This command
starts ssh-agent, holds SSH passphrase, and iterates over the list of configured peers to
synchronize configured files. Files or directories can be added or removed from file
synchronization in /usr/local/broadworks/bw_base/conf/rep.conf. In rep.conf, comments
are supported (comments start with a #) and entries can be a specific file or a directory.
For a directory, you must add a “.” to clearly specify that it is the content that is replicated.
Logs reside in /var/broadworks/logs/rsync/frepXX.log, where XX is the current day. A lock
file is created in /var/broadworks/lock/frepctl.pid to prevent multiple instances from running
simultaneously.
Example conf/rep.conf:
#File replication list
#[2001-22-13 Basic file replication configuration]
/bw/local/broadworks/bw_base/public_html/.
/bw/local/broadworks/bw_base/conf/DebugConfig.xml
***FAILURE***
***Some processes did not terminate gracefully
***Killing -9 (may result in broken pipes)…
This occurs because some processes take more time to shut down. If the showrun command
does not give any running process after the stopbw, everything is fine.
Example stopbw:
bwadmin@mtl64lin12.mtl.broadsoft.com$ stopbw
BroadWorks control script version 17.0
Stopping BroadWorks...
22.25 synchcheck_full.pl
Usage – synchcheck_full.pl
WARNING: This script can take ten minutes or longer and keeps servers locked while running.
Description – This script for redundant Application and Network Servers ensures that the
specified local database is identical to the remote databases.
All local and remote servers are locked while the script runs, so it should only be run in
periods of low system usage. No changes to the databases take effect while the script is
running.
22.26 ttStatus
Usage – ttStatus
Description – This tool provides information on the TimesTen databases in the system.
Connections to the database indicate that the database is in use. These connections are
related to the TimesTen replication daemon, the BroadWorks application, or a manual
connection via ttIsql.
Example ttStatus:
bwadmin@viras01.mtl.broadsoft.com$ ttStatus
TimesTen status report as of Sun Oct 16 10:23:15 2011
22.27 bwLoadHardening.pl
Usage – bwLoadHardening.pl
Description – This tool is used to modify the system configuration with the BroadSoft
hardening recommendations as defined in the BroadWorks System Configuration Guide.
22.28.1 backup-swmanager.pl
Usage – backup-swmanager.pl [-h | -help | <filename>]
Description – This script is used to back up the Software Manager database. The
backup file is stored in /usr/local/broadworks/swmanager/dbbackup. This script is located
in /usr/local/broadworks/swmanager/sbin.
NOTE: Backing up the patch tool database can cause a loss of information and it should be
done only when the patch tool is stopped.
22.28.2 restore-swmanager.pl
Usage – restore-swmanager.pl [<filename>]
Description – This script is used to restore a Software Manager database file created by
the backup-patchtool.pl script. The backup file includes the Software Manager database
and it should only be used with the same Software Manager revision that was used to
back it up. The backup-swmanager.pl script includes the Software Manager revision
number in the name of the backup file. This script is located in
/usr/local/broadworks/swmanager/sbin.
22.29 configdctl
Usage – configdctl {start | stop | stopnow | restart | status}
Description – This script is used to control the configuration agent daemon.
This command is used to start, stop, restart, and get the status of the configuration agent
daemon.
NOTE: The configuration agent must not be stopped while BroadWorks is running. This can
lead to unexpected behavior.
23.2.1 Description
In 2005 and 2006, Daylight Saving Time (DST) began for most of the United States at
2 A.M. on the first Sunday of April. Then time reverted to standard time at 2 A.M. on the
last Sunday of October.
United States and Canada are extending Daylight Saving Time from 2007, and other
regions and countries in North America may follow. The new start date is the second
Sunday in March (currently the first Sunday in April) and the new end date is the first
Sunday in November (currently the last Sunday in October).
Year DST Begins 2 a.m. DST Ends 2 a.m.
First Sunday in April) (Last Sunday in October)
==== ========================== ===============
2005 April 3 October 30
2006 April 2 October 29
NOTE: The DST changes to the start and end date began March 2007.
23.2.3 Solution
Solaris SPARC:
Solaris 8 with time zone patch 109809-11 or later, and libc patch 108993-52 or later
Solaris 9 with time zone patch 113225-18 or later, and libc patch 112874-33 or later
Solaris 10 with time zone patch 122032-03 or later, and libc patch 119689-07 or later
Solaris x86:
Solaris 10 with time zone patch 141517-05 or later, and libc patch 118855-15 or later
Linux:
Red Hat Enterprise Linux 4 – tzdata-2005m-1.EL4 is required. Connect to Red Hat Linux
and download this via the up2date command. For more information, read
http://kbase.redhat.com/faq/docs/DOC-4368.
After using the up2date command, users must set the /bin/nice setuid bit: # chmod ug+s
/bin/nice. After running the chmod command as root, restart BroadWorks (reference Alert
222646).
tzupdater Tool