Cisco BroadWorks

Software Management Guide

Document Version 29
Copyright Notice

Copyright© 2023 Cisco Systems, Inc. All rights reserved.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its
affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL:
[Link] Third-party trademarks
mentioned are the property of their respective owners. The use of the word partner does
not imply a partnership relationship between Cisco and any other company. (1721R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not
intended to be actual addresses and phone numbers. Any examples, command display
output, network topology diagrams, and other figures included in the document are shown
for illustrative purposes only. Any use of actual IP addresses or phone numbers in
illustrative content is unintentional and coincidental.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 2 OF 225

Document Revision History

Release Version Reason for Change Date

14.0 1 Updated document for re-branding. March 13, 2006

14.0 1 Updated for EVs 28729, 28471, 28555, 29257, and 30429. March 16, 2006

14.0 1 Corrected syntax of crontab command in 5.4.2 Add /bw March 28, 2006
Partition and 5.2.5 Configure Post-Linux Installation.

14.0 1 Corrected syntax of crontab command in section 5.4.2 Add April 17, 2006
/bw Partition and specified how to create sys user in section
5.2.5 Configure Post-Linux Installation.

14.0 1 Edited changes. June 8, 2006

14.0 1 Added clarification regarding the mandatory use of the June 28, 2006
en_US.ISO8859-1 locale for Solaris and Linux platforms.

14.0 1 Edited changes. July 13, 2006

14.0 1 Updated document with Release 14.0 content. July 28, 2006

14.0 1 Edited changes. August 24, 2006

14.0 2 Updated JASS installation instructions. August 31, 2006

14.0 2 Updated Red Hat Linux version name for EV 36241. September 1, 2006

14.0 2 Updated Solaris 10 Patch cluster requirement. September 6, 2006

14.0 2 Added localization requirement to update procedure. September 8, 2006

14.0 2 Updated document with installation patch and Patch tool September 20, 2006
upgrade.

14.0 2 Updated Patch Tool Upgrade section. October 9, 2006

14.0 2 Updated document following review. October 10, 2006

14.0 2 Edited changes. October 19, 2006

14.0 3 Updated rollback notes for EV 38865. November 1, 2006

14.0 3 Updated document with Client Management System (CMS) December 3, 2006
content.

14.0 3 Added note about nice command. December 7, 2006

14.0 3 Edited changes. December 7, 2006

14.0 4 Updated section [Link] Recommended Patch Cluster for January 16, 2006
EV 39152.

14.0 5 Added service pack. January 25, 2007

14.0 5 Clarified SNMP proxy configuration. February 1, 2007

14.0 5 Updated for EV 42014 (changed to section [Link].1 February 1, 2007

Register with Red Hat Network and changed “–update” to
“--update”).
Added directories for log files to section 8.10 Software
Manager Logging for EV 41417.

14.0 5 Edited changes. February 12, 2007

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 3 OF 225

 Release Version Reason for Change Date

14.0 6 Updated the third-party package list and the procedure to February 15, 2007
install the packages.

14.0 6 Added note for Linux users in section [Link] Time Zone March 15, 2007
Configuration for EV 41497.
Made small changes to sections 8.4.2 Apply Patch via CLI
and 8.5.2 Remove Patch via CLI for EV 41418.

14.0 6 Edited changes. March 28, 2007

14.0 7 Updated section [Link].3 Required Third-Party March 30, 2007

Packages.

14.0 7 Edited changes and published document. May 3, 2007

14.0 8 Fixed issues with Solstice Disk Mirroring. Added a post- May 11, 2007
upgrade reference to config-network to control a file
upload/download for the Media Server.

14.0 8 Corrected table in [Link].19 Configure Basic Maintenance May 9, 2007

Tasks. DbSyncCheck utility should be run daily on the
Network Server and is not applicable to the Media Server
for EV 47355.

14.0 8 Edited changes and published document. May 21, 2007

14.0 9 Added description for /etc/hosts file. Completed net-snmp May 28, 2007
installation.

14.0 9 Added information on how to proxy the ucd-snmp resource May 30, 2007
MIBs on Linux.

14.0 9 Added BEA WebLogic-related information. June 11, 2007

14.0 9 Edited changes and published document. June 26, 2007

14.0 10 Removed Client Management System Model section and August 30, 2007
added section Changes for Release 14.0, Version 10
Document for EV 52542.

14.0 10 Added note in section 4.7 Supported Operating Systems October 09, 2007
for EV 54018.

14.0 10 Added information to fix LANG installation issue, for EV October 22, 2007
54600 in section 5.5 Install Software.

14.0 10 Edited changes and published document. October 24, 2007

14.0 11 Added information on java TZ/DST and tzupdater tool in November 7, 2007
BroadWorks install and upgrade sections.

14.0 11 Added step to run [Link] after upgrade for EV November 14, 2007
54951.

14.0 11 Edited changes and published document. November 14, 2007

14.0 12 Added note in sections [Link] IP Multipathing, Changes December 13, 2007
for Release 14.0, Version 1 Document, and Changes for
Release 14.0, Version 7 Document.

14.0 12 Changed Linux version to v.4 update 6 and Linux swap January 8, 2008
requirement to maximum of 8 GB.

14.0 12 Edited changes and published document. January 14, 2008

14.0 13 Added information on how to assign multiple IP addresses January 17, 2008
to one bonding group in section [Link] IP Multipathing.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 4 OF 225

 Release Version Reason for Change Date

14.0 13 Edited changes and published document. February 12, 2008

14.0 14 Modified section [Link].19 Configure Basic Maintenance March 6, 2008

Tasks to add bwPeriodMaint to EMS and CDS for EV
53221.

14.0 14 Added Appendix on how to add modular flash drive to March 11, 2008
HS21 XM blades.

14.0 14 Corrected list of daemon/services disabled by the March 18, 2008

installation for EV 60104.

14.0 14 Edited changes and published document. March 24, 2008

14.0 15 Made changes to section 14.2 TimesTen Reconfiguration. April 2, 2008

14.0 15 Edited changes and published document. April 3, 2008

14.0 16 Added Xtended Services Platform information. April 4, 2008

14.0 16 Added a clarification around /etc/host definition for Apache April 15 2008
host name.

14.0 16 Added upgrade consideration for flash drive. April 16, 2008

14.0 16 Edited changes and published document. April 16, 2008

14.0 17 Removed BEA sections; added an upgrade best practices May 06, 2008
section; added some upgrade/rollback error handling use
cases.

14.0 17 Added Enabling Boot from the Multiple Mirrored Disks May 27, 2008
[Optional] section.

14.0 17 Added Profile Server impacts. May 27, 2008

14.0 17 Removed references to the Client Management System. June 4, 2008

Edited changes and published document.

15.0 1 Updated document for Release 15.0. June 16, 2008

15.0 1 Added TimesTen SNMP traps configuration. July 16, 2008

15.0 1 Edited changes from Release 14.0 and published July 16, 2008
document.

15.0 2 Updated document with RHEL support. July 24, 2008

15.0 2 Added more information on split disks for DB logging and August 20, 2008
datastore.

15.0 2 Edited changes and published document. August 22, 2008

15.0 3 Added information on Solaris 10 x86_64 support. September 25, 2008

15.0 3 Edited changes and published document. October 1, 2008

15.0 4 Removed a reference to CDS redundancy from section 4.1 October 14, 2008
General Rules for EV 68868.

15.0 4 Added information about installing Network Server in IMS October 17, 2008
or non-IMS mode to section [Link].18 Configure Server in
IMS Mode for EV 69215.

15.0 4 Clarified Red Hat requirements in section 5.2 Install Linux October 22, 2008
for EV 69388.

15.0 4 Edited changes and published document. October 29, 2008

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 5 OF 225

 Release Version Reason for Change Date

15.0 5 Removed “Configure Locale” from this document for EV November 6, 2008
69554.

15.0 5 Corrected typographical errors for EV 69487. November 19, 2008

Edited changes and published document.

15.0 6 Updated section [Link].19 Configure Basic Maintenance November 26, 2008
Tasks for EV 69858.

15.0 6 Updated section for EV 83815. November 28, 2008

15.0 6 Added section 8.11 Software Manager Database Backup December 2, 2008
and Restore for EV 64338.

15.0 6 Modified section 5.2 Install Linux for EV 84357. December 3, 2008

15.0 6 Modified section [Link].4.1 Activate System Activity December 4, 2008

Reporting for EV 86957.

15.0 6 Updated section 15.1 Mirroring Empty Slices for EV 81998. December 9, 2008

15.0 6 Edited changes and published document. December 19, 2008

15.0 7 Updated sections [Link] Solaris IP Multipathing and January 6, 2009

[Link] IP Multipathing for EV 83894.

15.0 7 Updated sections [Link].12 Configure Redundancy and January 12, 2009
13.1 Format of Silent Installation File to include replication
port configuration.

15.0 7 Updated document with Solaris Patch cluster validation. February 2, 2009

15.0 7 Added section 8.2 OS Patching for EV 89698. March 11, 2009

15.0 7 Updated section 6.5.1 New License Installation for EV March 11, 2009
90324.

15.0 7 Updated section [Link].12 Configure Redundancy for EV March 24, 2009
88926 (last sentence in NOTE 1 was removed).

15.0 7 Edited changes and published document. March 26, 2009

15.0 8 Added Pre-Installation Validation tool usage to Upgrade April 23, 2009
Best Practices, for EV 65557.

15.0 8 Edited changes and published document. May 12, 2009

15.0 9 Updated section [Link].19 Configure Basic Maintenance May 19, 2009
Tasks for EV 92902 and section 6.4.3 Media Server-
enabled Interface for EV 93436.

15.0 9 Updated section [Link] IP Multipathing for EV 92724. May 19, 2009

16.0 1 Updated document for Release 16.0. June 3, 2009

16.0 1 Clarified OS Patching/Updating policy. June 10, 2009

16.0 1 Added miimon option as a default IP bonding option in June 26, 2009
Linux.

16.0 1 Clarified intra-cluster replication operating system July 16, 2009

compatibility statement.

16.0 1 Edited changes and published document. July 22, 2009

16.0 2 Updated section 4.6 Installation, Upgrade, and Patch August 7, 2009
Procedures for Redundant Servers for EV 97768.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 6 OF 225

 Release Version Reason for Change Date

16.0 2 Updated section [Link] Name Resolution Configuration August 26, 2009
and section [Link] Name Resolution Configuration for EV
94429.

16.0 2 Updated comments on Solaris 10 support for Release 16.0 September 22, 2009
for EV 99245.

16.0 2 Updated section 13.1 Format of Silent Installation File for September 23, 2009
EV 97357.

16.0 2 Updated the following sections for October 7, 2009

EV 100721:
[Link] IP Multipathing
[Link] Default Router Configuration
[Link] Netmask/Prefix Configuration

16.0 2 Updated section Installing Packages with Yum for EV October 13, 2009
100953.

16.0 2 Updated section 13.1 Format of Silent Installation File for October 13, 2009
EV 98415.

16.0 2 Updated section [Link] Name Resolution Configuration October 22, 2009
and section [Link] Name Resolution Configuration for EV
94429 (further to previous entry).

16.0 2 Updated document for EV 99544. October 26, 2009

16.0 2 Edited changes and published document. November 3, 2009

16.0 3 Updated section 13.1 Format of Silent Installation File for November 10, 2009
EV 93757 (EV failed after publishing).

16.0 3 Updated section 5.3.2 Disk Partitioning for EV 102438. November 18, 2009

16.0 3 Edited changes and published document. November 24, 2009

16.0 4 Replaced references of Boulevard with Xchange in section November 25, 2009
8.2 OS Patching.

16.0 4 Updated section 6.7 Activate New Software Version for EV December 1, 2009
99498.

16.0 4 Updated section 4.2 Installation and Upgrade Order for EV December 3, 2009
103377.

16.0 4 Edited changes and published document. December 3, 2009

16.0 5 Updated section 6.7 Activate New Software Version for EV January 8, 2010
99498.

16.0 5 Added a note about mixing Operating System versions in a January 28, 2010
cluster to section 4.7 Supported Operating Systems.

16.0 5 Edited changes to document. January 28, 2010

16.0 5 Edited changes and published document. February 16, 2010

16.0 6 Clarified the database re-synchronization procedure in February 24, 2010

section 10.2.3 Failure while Rolling Back Application Server
or Network Server Secondary Node for EV 104791.

16.0 6 Edited changes to document. February 24, 2010

16.0 7 Updated section 6.7.1 Upgrade Cisco BroadWorks for EV February 26, 2010
99727.

16.0 7 Edited changes to document. February 26, 2010

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 7 OF 225

 Release Version Reason for Change Date

16.0 8 Fixed spelling error in section [Link].10 Configure March 8, 2010

Database Pre-defined Size.

16.0 8 Clarified disk partitioning requirements for Solaris and Linux March 9, 2010
in section 5.3.2 Disk Partitioning for EV 96360.

16.0 8 Edited changes to document. March 9, 2010

17.0 1 Updated document for Release 17.0. March 20, 2009

17.0 1 Edited changes and published document. March 23, 2010

17.0 2 Updated the upgrade command in section 7.3.1 Roll Back May 7, 2010
to Previous Version for EV 110518.

17.0 2 Made minor editorial changes. May 7, 2010

17.0 2 Updated section 8.11 Software Manager Database Backup May 13, 2010
and Restore for EV 111179.

17.0 2 Updated section 4.1 General Rules for EV 111289. May 25, 2010

17.0 2 Edited changes and published document. June 3, 2010

17.0 3 Added section 5.8.7 How to Proxy HOST_RESSOURCES June 4, 2010

MIB on Linux for EV 105486. (This was later moved to the
Appendix.)

17.0 3 Made minor editorial changes. June 7, 2010

17.0 3 Edited changes and published document June 15, 2010

17.0 4 Updated sections 14.1 Disk Drive Basic Configuration and June 21, 2010
15.1 Mirroring Empty Slices for EV 113774.

17.0 4 Edited changes and published document. July 5, 2010

17.0 5 Clarified disk logging for EVs 113822 and 110907. August 2, 2010

17.0 5 Made editorial changes and updated document for EV August 3, 2010
115423.

17.0 5 Edited changes and published document. July 5, 2010

17.0 6 Updated section [Link].19 Configure Basic Maintenance September 13, 2010
Tasks for EV 114437.

17.0 6 Made minor editorial changes. September 14, 2010

17.0 6 Updated section 5.2.7 Patch Linux for EV 96032. September 16, 2010

17.0 6 Updated patching note for EV 115953. September 24, 2010

17.0 6 Edited changes and published document. September 27, 2010

17.0 7 Updated document for Release 17.sp1. September 28, 2010

17.0 7 Updated document for EV 106778. October 19, 2010

17.0 7 Removed changes for Release 17.sp1. October 19, 2010

17.0 7 Updated document with information about persistentLogs November 4, 2010

configuration and x86_64 hardware support for EV 110727.

17.0 7 Added Linux multi-homing configuration section for EV November 12, 2010
87974.

17.0 7 Made minor editorial changes. November 15, 2010

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 8 OF 225

 Release Version Reason for Change Date

17.0 7 Updated section 6.11.1 Software Activation for EV 125061 January 5, 2011
and updated link to OS patches in section 8.2 OS Patching.

17.0 7 Updated Linux package list for EV 126139. January 21, 2011

17.0 7 Edited changes and published document. January 24, 2011

17.0 8 Updated Linux bonding in section [Link] IP Multipathing February 4, 2011

for EV 108017.

17.0 8 Updated section [Link].4.1 Activate System Activity February 8, 2011

Reporting for EV 126793.

17.0 8 Added section Configure Net-SNMP Host Resources February 24, 2011
Subagent on Solaris for
EV 116654.

17.0 8 Edited changes and published document. March 30, 2011

17.0 9 Updated section [Link].2.1 Installing Packages with Yum April 13, 2011
for EVs 131224 and 131226.

17.0 9 Removed reference to config-network in sections [Link] April 18, 2011

Solaris IP Multipathing and [Link] Netmask/Prefix
Configuration for EV 131989.

17.0 9 Added parameter to [Link] in section 13.1 Format April 19, 2011
of Silent Installation File for EV 131073.

17.0 9 Edited changes and published document. May 9, 2011

17.0 10 Moved section on how to proxy the ucd-snmp resource May 16, 2011
MIBs on Linux to Appendix H.
Moved section on how to proxy the host_ressources MIBs
on Linux to Appendix I, for EV 129600.

17.0 10 Updated Figure 1 Installation and Upgrade Order to add June 3, 2011
Database Server.

17.0 10 Edited changes and published document. June 8, 2011

17.0 11 Updated Linux OS post-install step to disable OOM-Killer June 13, 2011
for EV 143237.

17.0 11 Added note about sudoer to section 5.3 Install Cisco June 15, 2011
BroadWorks for EV 132051.

17.0 11 Updated Linux rpm list for EV 144333. June 22, 2011

17.0 11 Edited changes and published document. July 15, 2011

17.0 12 Updated the Solaris mirroring disk procedure in sections August 15, 2011
5.3.2 Disk Partitioning and Mirror Disks with Solaris Sparc
Volume Manager for EV 116226.

17.0 12 Edited changes and published document. August 29, 2011

17.0 13 Added note to section [Link] IP Multipathing for EV September 13, 2011
131016.

17.0 13 Added clarification for swap size on system with 12 GB of September 28, 2011
memory or less for EV 108246.

17.0 13 Updated sections 6.11.1 Software Activation and 7.3.2 September 29, 2011
Revert to Previous Version for reverting software version
for EV 150660.

17.0 13 Removed server memory requirement in section 5.3 Install September 29, 2011
Solaris 11 for EV 149520.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 9 OF 225

 Release Version Reason for Change Date

18.0 1 Updated document for Release 18.0. October 18, 2011

18.0 1 Updated section [Link] Name Resolution Configuration for October 20, 2011
EV 144590.

18.0 1 Updated section 5.3 Install Cisco BroadWorks for EV October 24, 2011
146548.

18.0 1 Edited changes and published document. October 28, 2011

18.0 2 Reverted the changes for EV 144590 in section [Link] December 15, 2011
Name Resolution Configuration.

19.0 1 Updated sections 5.2.3 Installation Procedure and December 20, 2011
Installing Packages with Yum for EV 155507.
Updated section Enable SNMP Net Subagent and removed
sections 5.8.4 Configure Net-SNMP Subagent on Linux,
5.8.5 Configure Net-SNMP Host Resources Subagent on
Solaris, 5.8.6 Enable TimesTen SNMP Traps Reporting,
Appendix H: How to Proxy UCD-SNMP Resource MIB on
Linux, and Appendix I: How to Proxy
HOST_RESOURCES MIB on Linux for EV 145130.

19.0 1 Removed section on disabling OOM killer for EV 158758. January 30, 2011

19.0 1 Added Solaris 11 documentation for EV 154889. March 15, 2011

19.0 1 Added some recommended Linux packages in section March 28, 2012
5.2.3 Installation Procedure for EV 160398.

19.0 1 Modified section 5.2 Install Linux for EV 163201. April 16, 2012

19.0 1 Added section [Link].14 Configure Application Server ID April 24,2012

for EV 161398.

19.0 1 Restructured section 1 Summary of Changes. May 18, 2012

19.0 1 Updated section 13.1 Format of Silent Installation File for July 12, 2012
EV 169450.

19.0 1 Updated section 6.5.1 New License Installation for EV July 16, 2012
170253.

19.0 1 Removed section on disabling OOM killer for EV 158758. July 30, 2012

19.0 1 Updated section 5.2 Install Linux 9 for EV 171203. August 6, 2012

19.0 1 Updated section [Link].3 Required Third-Party Packages August 30, 2012
for EV 173453.

19.0 1 Updated section 5 Cisco BroadWorks Initial Installation September 4, 2012

Procedure for EV 154206.

19.0 1 Reviewed changes for EV 154206. September 4, 2012

19.0 1 Added section 5.4.1 Adjust Swap Size with ZFS for EV September 9, 2012
163935.
Updated section 5.2.2 Disk Partitioning Options for EV
172945.

19.0 1 Added clarification in section 4.6 Installation, Upgrade, and September 18,2012
Patch Procedures for Redundant Servers for EV 168411.

19.0 1 Updated section [Link] IP Multipathing September 27,2012

for EV 131016.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 10 OF 225

 Release Version Reason for Change Date

19.0 1 Updated section [Link].19 Configure Basic Maintenance September 28,2012

Tasks for EV 175534.
Updated sections 14.2 TimesTen Reconfiguration and 15.2
TimesTen Reconfiguration for EV 175635.

19.0 1 Added the Service Control Function (SCF) server. October 21, 2012

19.0 1 Removed references to the Conferencing Server for EV November 2, 2012

177716.

19.0 1 Edited changes and publish document. November 9, 2012

19.0 2 Updated Appendix D: Database Logging to Different Disk November 14, 2012
on x86_64 Hardware for EV 150865.

19.0 2 Updated section 5.2.2 Disk Partitioning Options for EV November 15,2012
157304.

19.0 2 Added section [Link].15 Hardening Recommendations. November 21, 2012

19.0 2 Updated section [Link].3 Required Third-Party Packages December 4, 2012

for
EV 180243.

19.0 2 Edited changes and published document. December 12, 2012

19.0 3 Updated section 5.2 Install Linux 7 for EV 182760. January 16, 2013

19.0 3 Corrected section numbering. January 16, 2013

19.0 3 Updated section 13 Format of Silent Installation File for EV January 25, 2013
178567.

19.0 3 Edited changes and published document. February 4, 2013

19.0 4 Updated section [Link].4.1 Activate System Activity March 6, 2013

Reporting for EV 186426.

19.0 4 Updated section 4.9 Upgrade Best Practices for EV March 21, 2013
187696.

19.0 4 Edited changes and published document. April 16, 2013

19.0 5 Repaired section numbering for EV 190289. April 19, 2013

19.0 5 Edited changes and published document. April 22, 2013

19.0 6 Updated section Error! Reference source not found. May 13, 2013
REF _Ref356197354 \h \* MERGEFORMAT Error!
Reference source not found. for EV 186963.

20.0 1 Added CIS recommendations to section 5.2.2 Disk June 5, 2013

Partitioning Options.

20.0 1 Updated Appendix C: Non-interactive Installation for EV June 5, 2013

187580.

20.0 1 Updated section 4.6 Installation, Upgrade, and Patch July 25, 2013
Procedures for Redundant Servers for EV 177121 and EV
195736.
Updated sections 5.3 Install Solaris 11 and 5.4 Configure
Solaris OS for EV 191244.

20.0 1 Updated section [Link].19 Configure Basic Maintenance September 17, 2013
Tasks to add missing Database Server (DBS) column for
EV 201523.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 11 OF 225

 Release Version Reason for Change Date

20.0 1 Added section [Link].16 Operating System Hardening September 19, 2013
Recommendations and updated Appendix C: Non-
interactive Installation.

20.0 1 Added Note 5 to section [Link] Host Name Configuration October 8, 2013
Recommendations.

20.0 1 Updated sections 6.7.1 Upgrade Cisco BroadWorks, 7.3.1 October 29, 2013
Roll Back to Previous Version, and 7.3.2 Revert to
Previous Version for EV 198263.

20.0 1 Edited changes and published document. November 10, 2013

20.0 2 Updated document for the WebRTC Server (WRS), November 26, 2013
Messaging Server (UMS), and Sharing Server (USS).

20.0 2 Updated section 5.2.2 Disk Partitioning Options for EV November 26, 2013
208578.

20.0 2 Edited changes and published document. January 27, 2014

20.0 3 Updated section [Link].12 Configure Redundancy for EV February 06, 2014
215116.

20.0 3 Updated section [Link].3 Required Third-Party Packages February 26, 2014
for EV 213768.

20.0 3 Edited changes and published document. March 11, 2014

20.0 4 Updated all references to the Sharing Server (USS) and March 26, 2014
the Messaging Server (UMS).
Edited changes and published document.

20.0 5 Updated section 5.2.2 Disk Partitioning Options for EV May 16, 2014
222828.

20.0 5 Edited changes and published document. May 21, 2014

20.0 6 Updated sections 5.2.7 Patch Linux for EV 225331. May 23, 2014

20.0 6 Updated section [Link].10 Configure Database Pre- June 4, 2014

defined Size for EV 214078.

20.0 6 Updated section 5.1 Install and Configure Operating June 5, 2014
System for EV 226558.

20.0 6 Edited changes and published document. July 17, 2014

21.0 1 Updated section [Link] Configure Cisco BroadWorks July 21, 2014
through Interactive Installation to add Cisco BroadWorks
User Password step for EV 230356.

21.0 1 Updated document for Release 21.0. November 5, 2014

21.0 1 Updated the BroadSoft legal notice and edited changes. November 21, 2014

21.0 1 Rebranded and published document. December 23, 2014

21.0 2 Updated sections 7.3.1 Roll Back to Previous Version and January 6, 2015
8.5.2 Remove Patch via CLI for EV 213799.

21.0 2 Updated section 6.5.1 New License Installation for EV January 19, 2015
246871.

22.0 1 Added section 5.6.5 Enable TimesTen SNMP Traps February 4, 2015
Reporting for EV 228205.

22.0 1 Added section 5.6.7 Configure Net-SNMP Subagent to February 27, 2015
Listen to IPv6 Address on Linux for PR-46872.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 12 OF 225

 Release Version Reason for Change Date

22.0 1 Added section 5.6.8 - Configure SNMP Community String March 16, 2015
for PR-46915.

22.0 1 Updated section [Link].3 Required Third-Party Packages April 28, 2015
to add Network Database Server required packages.

22.0 1 Updated Appendix C: Non-interactive Installation for PR- April 29, 2015
47350.

22.0 1 Updated section 4.7 Supported Operating Systems for PR- June 3, 2015
47532.

22.0 1 Updated section 5.1 Install and Configure Operating June 11, 2015
System for PR-47657.

22.0 1 Updated document with current software versions and June 19, 2015
examples.

22.0 1 Updated section 13.1 Format of Silent Installation File for June 23, 2015
PR-47751.

22.0 1 Updated section [Link].3 Required Third-Party Packages July 16, 2015
to add Netcat package dependency to Network Database
Server and Network Function Manager.

22.0 1 Updated sections 5.1 Install and Configure Operating July 27, 2015
System and 5.2 Install Linux 9 for PR-47930.

22.0 1 Updated section 4.7 Supported Operating Systems for PR- July 29, 2015
47930.

22.0 1 Added section [Link] Net-SNMP Configuration for IPv6 August 10, 2015
for PR-48109.

22.0 1 Updated section 8.4.2 Apply Patch via CLI for PR-48366. September 16, 2015

22.0 1 Updated sections 3 Overview, 4.7 Supported Operating September 16, 2015
Systems, 5.1 Install and Configure Operating System, and
5.2 Install Linux 9 for BW-6879.

22.0 1 Updated section [Link].3 Required Third-Party October 1, 2015

Packages.

22.0 1 Updated section 13.1 Format of Silent Installation File for October 19, 2015
PR-48420.

22.0 1 Updated section 5.2.2 Disk Partitioning Options for PR- October 20, 2015
45595.

22.0 1 Updated section [Link] IP Multipathing for PR-47636. October 23, 2015

22.0 1 Updated section [Link].3 Required Third-Party Packages November 25, 2015
for PR-49098.

22.0 1 Updated section [Link].3 Required Third-Party Packages December 10, 2015
for PR-49277

22.0 1 Updated section [Link].3 Required Third-Party Packages September 26, 2016
to add new dependencies for the Messaging Server.

22.0 1 Added section [Link] /etc/sysconfig/network for PR-50518. September 30, 2016

22.0 1 Updated section 7.3.2 Revert to Previous Version. October 4, 2016

22.0 1 Added section [Link] Optimistic Duplicate Address October 14, 2016
Detection (DAD) Enabling for Bonding IPv6 for PR-51915.

22.0 1 Clarified minimum Linux OS version. November 19, 2016

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 13 OF 225

 Release Version Reason for Change Date

22.0 1 Added section 16 Acronyms and Abbreviations. December 9, 2016

Edited changes and published document.

22.0 2 Updated section [Link] Optimistic Duplicate Address December 20, 2016
Detection (DAD) Enabling for Bonding IPv6 for PR-53823.

22.0 2 Updated section [Link].3 Required Third-Party Packages January 16, 2017
for FR10631.

22.0 2 Editing changes and published document. January 24, 2017

22.0 3 Updated section 4.2 Installation and Upgrade Order to add January 27, 2017
NDS.

22.0 3 Updated section [Link] /etc/hosts for PR-54624. March 6, 2017

22.0 3 Editing changes and published document. March 14, 2017

22.0 4 Updated section [Link].3 Required Third-Party Packages April 12, 2017
for PR-53968.

22.0 4 Updated sections [Link] /etc/hosts and [Link].12 April 18, 2017
Configure Redundancy for PR-55112.

22.0 4 Updated section [Link] /etc/hosts for PR-53374. June 2, 2017

22.0 4 Updated section [Link].3 Required Third-Party Packages June 13, 2017
for PR-54305.

22.0 4 Updated sections [Link] Latest Linux Updates, 5.6.4 Linux June 21, 2017
Updates and [Link].1 Install Packages from DVD
Installation Media for PR-55648.

22.0 4 Editing changes and published document. June 22, 2017

22.0 5 Updated section 5.2.2 Disk Partitioning Options for PR- June 29, 2017
55615.

22.0 5 Updated section 5.2 Install Linux 9 to clarify Linux 7 July 12, 2017
support for PR-55839.

23.0 1 Updated section 6.1 Pre-upgrade Steps for PR-54405 July 14, 2017

23.0 1 Updated section [Link].3 Required Third-Party Packages September 26, 2017
for PR-54254.

23.0 1 Updated section 7 Cisco BroadWorks Rollback/Revert November 1, 2017

Procedures for PR-56282.

23.0 1 Updated section [Link].3 Required Third-Party Packages November 20, 2017
for PR-57121.

23.0 1 Updated section 5.2.2 Disk Partitioning Options for BW- February 19, 2018
13504.

23.0 1 Updated section [Link].12 Configure Redundancy for PR- April 19, 2018
58409.

23.0 1 Updated section 5.2.7 Patch Linux for PR-59073. July 3, 2018

23.0 1 Updated section 5.2.2 Disk Partitioning Options for PR- July 13, 2018
58914.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 14 OF 225

 Release Version Reason for Change Date

23.0 1 Updated section 5.1 Install and Configure Operating September 20, 2018
System for BW-16867.
Updated sections 2 Purpose, 3 Overview and section 4
Cisco BroadWorks Software Management for BE-6883.
Updated section [Link] Additional Software Packages for
PR-59755.

23.0 1 Updated section 6.1.3 Disk Space and DSN Requirements September 24, 2018
for PR-59633.

Version Reason for Change Date

1 Updated document for Release 24.0. May 27, 2019

1 Updated Figure 19 Patch State Management for PR-61423. July 17, 2019

1 Updated section 5.2.2 Disk Partitioning Options for PR-62554. October 28, 2019

1 Removed information about support for Linux 5, as Linux 5 is no longer October 29, 2019
supported in Release 24.0.
Updated section 5.2.6 Move from Red Hat Enterprise Linux 5, 6, 7, or 8 to
Red Hat Enterprise Linux 9.
Rebranded for Cisco.

1 Removed reference to obsolete document in section 4.9 Upgrade Best December 16, 2019
Practices for PR-62879.

1 Updated sections 4.2 Installation and Upgrade Order and 4.4 Cisco December 18, 2019
BroadWorks for PR-62897.

1 Added -noCheck to section 14.2 TimesTen Reconfiguration for PR-62856. December 20, 2019

1 Updated sections 3 Overview, 4.7 Supported Operating Systems, 5.1 February 17, 2020
Install and Configure Operating System, 5.2 Install Linux 9 and 5.6.4 Linux
Updates for BW-22634.

1 Updated section 5.2.3 Installation Procedure for PR-63411. February 27, 2020

1 Updated section 4.7 Supported Operating Systems and added section 4.8 February 28, 2020
Operating System Upgrade Best Practices for PR-63316.

1 Added sections [Link] CPU Frequency Scaling, [Link] Transparent March 23, 2020
Huge Pages for PR-63264.

1 Updated Appendix C: Non-interactive Installation for PR-63521. March 26, 2020

1 Updated sections 5.5.1 Non-interactive Installation, [Link] Post- April 8, 2020

installation Activation Steps, [Link] Start Interactive Installation, [Link].1
Cisco BroadWorks User Name,[Link] Post-installation Activation, 5.6.5
Enable TimesTen SNMP Traps Reporting for PR-63000.

1 Updated sections [Link] CPU Frequency Scaling, [Link] Transparent April 15, 2020
Huge Pages for PR-63742.

1 Updated section [Link].3 Required Third-Party Packages to add psmisc April 16, 2020
package for PR-63701.

1 Updated sections [Link] CPU Frequency Scaling, [Link] Transparent April 29, 2020
Huge Pages for PR-63831.

1 Updated section [Link].3 Required Third-Party Packages for PR-63921. May 12, 2020

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 15 OF 225

 Version Reason for Change Date

1 Updated section [Link].3 Required Third-Party Packages for PR-64152. June 10, 2020

1 Added keywords to document Properties, edited changes, and published July 3, 2020
document.

2 Clarified section [Link] Transparent Huge Pages for PR-64512. August 9, 2020

2 Made minor editorial changes. August 12, 2020

2 Updated Cisco Database Server package list for BW-22346 in section August 24, 2020
[Link].3 Required Third-Party Packages.

2 Edited changes and published document. October 1, 2020

3 Added section 6.10 Additional Considerations when Upgrading an October 6, 2020

Xtended Services Platform/Profile Server (XSP/PS) to the Application
Delivery Platform (ADP).

3 Edited changes and published document. November 25, 2020

4 Updated section 5.2.2 Disk Partitioning Options to clarify EFI partition February 8, 2021
requirement.

4 Updated section 4.7 Supported Operating Systems for PR-65391. February 26, 2021

4 Edited changes and published document. April 16, 2021

5 Updated sections [Link].19 Configure Basic Maintenance Tasks, [Link] April 29, 2021
Configure Cisco BroadWorks through Interactive Installation, and 13
Appendix C: Non-interactive Installation for PR-65633.

5 Updated section 13 Appendix C: Non-interactive Installation for PR- May 6, 2021

65642.

5 Edited changes and published document. May 14, 2021

6 Updated section 8.4.2 Apply Patch via CLI and 8.5.2 Remove Patch via May 31, 2021
CLI for PR-63894.

6 Added note in section 5.5 Install Software for BWKS-462. July 23, 2021

6 Updated section 13.1 Format of Silent Installation File to fix the server type August 6, 2021
list for BWKS-1591.

6 Edited changes and published document. August 16, 2021

7 Updated section [Link].3 Required Third-Party Packages to remove September 6, 2021

unneeded packages from the NFM and NDS lists for BWKS-1706.

7 Updated section [Link].4.1 Activate System Activity Reporting for October 8, 2021
BWKS-2212.

7 Edited changes and published document. October 14, 2021

8 Added section [Link] /etc/systemd/[Link] for BWKS-1826. November 8, 2021

8 Edited changes and published document. November 22, 2021

9 Fixed typos related to Application Delivery Platform for BWKS-3421. February 18, 2022

9 Updated section 10.1 Software Activation – Upgrade-related Error February 22, 2022
Recovery and section 10.2 Software Activation – Rollback-related Error
Recovery for BWKS-539.

9 Reviewed changes. March 1, 2022

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 16 OF 225

 Version Reason for Change Date

9 Updated oracle preinstall package note in section [Link].3 Required March 18, 2022
Third-Party Packages for BWKS-3636.

9 Edited changes and published document. April 5, 2022

10 Updated sections 4.7 Supported Operating Systems and 5.2.6 Move from May 9, 2022
Red Hat Enterprise Linux 5, 6, 7, or 8 to Red Hat Enterprise Linux 9 to
inform the end of support of Linux 6 on Release Independent version.

10 Edited changes and published document. May 19, 2022

11 Updated section [Link].3 Required Third-Party Packages with package June 17,2022
list of DBS on Linux 8.

11 Updated section 6.1.3 Disk Space and DSN Requirements for July 5, 2022
BWKS-4771.

11 Edited changes and published document. July 19, 2022

12 Updated section [Link].3 Required Third-Party Packages for August 10, 2022
BWKS-5315.

12 Edited changes and published document. September 15, 2022

13 Updated section [Link] and Appendix C. Added sections [Link].3, October 25th 2022
[Link].4, [Link].5 and [Link].6 for BWKS-1212

13 Updated section [Link] and Appendix C for BWKS-1212 October 26, 2022

14 Added section 5.4.4 Verify the Signature of Software Image for BWKS- November 14, 2022
4452

15 Added section [Link] Swappiness for BWKS-5886. December 7, 2022

16 Added note in section 5.2.2 Disk Partitioning Options to clarify nodev, January 17, 2023
noexec and nosuid partition options.

16 Added section 5.6.3 Configuration files for log rotation January 17, 2023

17 Updated section 6 Cisco BroadWorks Upgrade Procedure and January 23, 2023
subsections to clarify the flow.

18 Updated document for BWKS-5567 and BWKS-6413: removed references January 31, 2023
to AMS, UMS, USS, UVS, and WRS, changed references to PS and XSP
with ADP when applicable.

18 Added section 5.6.10 Core File Size and Number of Open File Descriptors February 7, 2023
Limits for BWKS-6969.

19 Updated section 5.6.9 Automatically Send Tech-Support Output to Cisco February 13, 2023
to remove obsolete parameter xchangeuser.

20 Updated section 4.7 Supported Operating Systems to remove reference to February 28, 2023
CentOS 8.

21 Updated section 5.6.3 Configuration files for log rotation to add April 4, 2023
/etc/logrotate.d/diagnostic.

22 Updated section 5.2.2 Disk Partitioning Options to increase size of /var April 18, 2023
partition.

23 Clarify upgrade process for ADP applications in section 4.2 Installation and June 9, 2023
Upgrade Order.

24 Updated sections [Link] Latest Linux Updates and [Link].2 Install July 4, 2023
Packages with subscription-manager Utility to fix subscription-manager
command.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 17 OF 225

 Version Reason for Change Date

25 Removed support for Linux 5 and 6 for BWKS-8634 August 10, 2023

26 Adding support for Linux 9. September 14, 2023

27 Updated section [Link].3 Required Third-Party Packages to include October 18, 2023
firewalld package.

27 Updated section 12.1 Format of Silent Installation File to correct key name. November 13, 2023

27 Added section 5.6.8 Configure SNMP Community String and published November 30, 2023
document.

28 Updated section 6 - Cisco BroadWorks Upgrade Procedure to be more December 11, 2023
accurate and up to date.

28 Updated section 4.7 Supported Operating Systems, added section 9 Cisco December 14, 2023
BroadWorks OS In-place Upgrade Procedures for BWKS-8724.

29 Fixed cross-references in section History of Changes. January 9, 2024

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 18 OF 225

Table of Contents

1 Summary of Changes ................................................................................................................. 26

1.1 Changes for version 28 .............................................................................................................. 26
1.2 Changes for Version 27 .............................................................................................................. 26
1.3 Changes for Version 26 .............................................................................................................. 26
1.4 Changes for Version 25 .............................................................................................................. 26
1.5 Changes for Version 24 .............................................................................................................. 26
1.6 Changes for Version 23 .............................................................................................................. 26
1.7 Changes for Version 22 .............................................................................................................. 26
1.8 Changes for Version 21 .............................................................................................................. 26
1.9 Changes for Version 20 .............................................................................................................. 27
1.10 Changes for Version 19 .............................................................................................................. 27
1.11 Changes for Version 18 .............................................................................................................. 27
1.12 Changes for Version 17 .............................................................................................................. 27
1.13 Changes for Version 16 .............................................................................................................. 27
1.14 Changes for Version 15 .............................................................................................................. 27
1.15 Changes for Version 14 .............................................................................................................. 27
1.16 Changes for Version 13 .............................................................................................................. 27
1.17 Changes for Version 12 .............................................................................................................. 28
1.18 Changes for Version 11 .............................................................................................................. 28
1.19 Changes for Version 10 .............................................................................................................. 28
1.20 Changes for Version 9 ................................................................................................................ 28
1.21 Changes for Version 8 ................................................................................................................ 28
1.22 Changes for Version 7 ................................................................................................................ 28
1.23 Changes for Version 6 ................................................................................................................ 28
1.24 Changes for Version 5 ................................................................................................................ 28
1.25 Changes for Version 4 ................................................................................................................ 29
1.26 Changes for Version 3 ................................................................................................................ 29
1.27 Changes for Version 2 ................................................................................................................ 29
1.28 Changes for Version 1 ................................................................................................................ 29
1.29 Changes for Release 23.0 ......................................................................................................... 30
1.30 Changes for Release 22.0 ......................................................................................................... 30
1.31 Changes for Release 21.0 ......................................................................................................... 32
1.32 Changes for Release 20.0 ......................................................................................................... 32
1.33 Changes for Release 19.0 ......................................................................................................... 33
1.34 Changes for Release 18.0 ......................................................................................................... 34
1.35 Changes for Release 17.0 ......................................................................................................... 34
1.36 Changes for Release 16.0 ......................................................................................................... 37
1.37 Changes for Release 15.0 ......................................................................................................... 38
1.38 Changes for Release 14.0 ......................................................................................................... 39
1.39 Changes for Release 13.0 ......................................................................................................... 42

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 19 OF 225

 1.40 Changes for Release 12.0 ......................................................................................................... 43
1.41 Changes for Release 11.1 ......................................................................................................... 43
1.42 Changes for Release 11.0 ......................................................................................................... 43
1.43 Changes for Release 10.0 ......................................................................................................... 44
2 Purpose .......................................................................................................................................... 45
3 Overview ........................................................................................................................................ 46
4 Cisco BroadWorks Software Management............................................................................. 47
4.1 General Rules ............................................................................................................................. 47
4.2 Installation and Upgrade Order .................................................................................................. 48
4.3 Cisco BroadWorks Software Compatibility Rules ..................................................................... 49
4.4 Cisco BroadWorks Release Independent ................................................................................. 49
4.5 Installation, Upgrade, and Patch Procedure for Non-redundant Servers ............................... 49
4.6 Installation, Upgrade, and Patch Procedures for Redundant Servers .................................... 51
4.7 Supported Operating Systems ................................................................................................... 53
4.8 Operating System Upgrade Best Practices .............................................................................. 54
4.9 Upgrade Best Practices .............................................................................................................. 54
5 Cisco BroadWorks Initial Installation Procedure .................................................................. 56
5.1 Install and Configure Operating System.................................................................................... 56
5.2 Install Linux 9............................................................................................................................... 56
5.2.1 Installation Options............................................................................................................. 57
5.2.2 Disk Partitioning Options ................................................................................................... 57
5.2.3 Installation Procedure ........................................................................................................ 60
5.2.4 Mirror Disks with RAID....................................................................................................... 70
5.2.5 Configure Post-Linux Installation ...................................................................................... 70
5.2.6 Move from Red Hat Enterprise Linux 5, 6, 7, or 8 to Red Hat Enterprise Linux 9 ......... 84
5.2.7 Patch Linux ......................................................................................................................... 84
5.3 Install Cisco BroadWorks ........................................................................................................... 85
5.4 Copy Cisco BroadWorks Software on Target Platform ............................................................ 85
5.4.1 Copy from CD .................................................................................................................... 85
5.4.2 Copy from Software Image ............................................................................................... 86
5.4.3 Verify Integrity of Software Image ..................................................................................... 86
5.4.4 Verify the Signature of Software Image............................................................................ 86
5.5 Install Software ............................................................................................................................ 88
5.5.1 Non-interactive Installation ................................................................................................ 88
5.5.2 Interactive Installation ........................................................................................................ 90
5.6 Additional Notes ........................................................................................................................ 100
5.6.1 bwadmin Account Management ..................................................................................... 100
5.6.2 Installation Log Files ........................................................................................................ 100
5.6.3 Configuration files for log rotation ................................................................................... 100
5.6.4 Linux Updates .................................................................................................................. 100
5.6.5 Enable TimesTen SNMP Traps Reporting .................................................................... 101
5.6.6 Time Zone/Daylight Saving Time Version in JRE Software ......................................... 102

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 20 OF 225

 5.6.7 Configure Net-SNMP Subagent to Listen to IPv6 Address on Linux ........................... 102
5.6.8 Configure SNMP Community String ............................................................................... 103
5.6.9 Automatically Send Tech-Support Output to Cisco ....................................................... 104
5.6.10 Core File Size and Number of Open File Descriptors Limits ........................................ 105
5.6.11 Known Limitations ............................................................................................................ 105
6 Cisco BroadWorks Upgrade Procedure ................................................................................ 106
6.1 Pre-upgrade Steps.................................................................................................................... 106
6.1.1 Pre-installation Validation Tool ........................................................................................ 106
6.1.2 Time Zone/Daylight Saving Time Version in JRE Software ......................................... 107
6.1.3 Disk Space and DSN Requirements .............................................................................. 107
6.1.4 YUM Requirements ......................................................................................................... 107
6.1.5 Pre-upgrade Sanity Checks ............................................................................................ 107
6.1.6 Backup your server .......................................................................................................... 108
6.2 Procedural Steps ...................................................................................................................... 108
6.3 Copy Cisco BroadWorks Software on Target Platform .......................................................... 108
6.3.1 Obtain Software Image from Cisco Download............................................................... 108
6.3.2 Verify Integrity of Software Image ................................................................................... 108
6.4 Install Cisco BroadWorks Software ......................................................................................... 109
6.4.1 Impact on the Software Manager.................................................................................... 109
6.5 Post-installation Steps .............................................................................................................. 109
6.5.1 New License Installation .................................................................................................. 109
6.5.2 Upgrade Check ................................................................................................................ 110
6.6 Configure Registration Extension ............................................................................................ 111
6.7 Activate New Software Version................................................................................................ 112
6.7.1 Upgrade Cisco BroadWorks ........................................................................................... 112
6.7.2 Verify Result of Activation................................................................................................ 113
6.7.3 Post-upgrade Sanity Checks .......................................................................................... 113
6.8 Restore Registration Extension ............................................................................................... 113
6.9 Localize Cisco BroadWorks Server (CommPilot Application on Application Server,
Application Delivery Platform and Xtended Services Platform) ............................................. 113
6.10 Additional Considerations when Upgrading an Xtended Services Platform/Profile Server
(XSP/PS) to the Application Delivery Platform (ADP) ............................................................ 114
6.11 Troubleshooting an Installation ................................................................................................ 114
6.11.1 Software Activation .......................................................................................................... 114
6.11.2 Upgrade Sanity Checks................................................................................................... 115
7 Cisco BroadWorks Rollback/Revert Procedures ................................................................ 118
7.1 Procedural Steps ...................................................................................................................... 118
7.2 Configure Registration Extension ............................................................................................ 118
7.3 Change Active Software Version ............................................................................................. 118
7.3.1 Roll Back to Previous Version ......................................................................................... 118
7.3.2 Revert to Previous Version.............................................................................................. 126
7.4 Restore Registration Extension ............................................................................................... 126

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 21 OF 225

 8 Cisco BroadWorks Patching Procedure ............................................................................... 127
8.1 Cisco BroadWorks Application Patch Management .............................................................. 127
8.2 OS Patching .............................................................................................................................. 128
8.3 Install Cisco BroadWorks Patch............................................................................................... 128
8.3.1 Procedural Steps ............................................................................................................. 128
8.3.2 Install Patch ...................................................................................................................... 128
8.3.3 Install Patch Bundle ......................................................................................................... 129
8.4 Apply Cisco BroadWorks Patch ............................................................................................... 130
8.4.1 Procedural Steps ............................................................................................................. 130
8.4.2 Apply Patch via CLI.......................................................................................................... 130
8.4.3 Apply Patch via SNMP .................................................................................................... 132
8.5 Remove Cisco BroadWorks Patch .......................................................................................... 132
8.5.1 Procedural Steps ............................................................................................................. 132
8.5.2 Remove Patch via CLI ..................................................................................................... 133
8.5.3 Remove Patch via SNMP................................................................................................ 135
8.6 Delete Cisco BroadWorks Patch ............................................................................................. 135
8.6.1 Procedural Steps ............................................................................................................. 135
8.6.2 Delete Cisco BroadWorks Patch via CLI........................................................................ 135
8.6.3 Delete Cisco BroadWorks Patch via SNMP .................................................................. 135
8.7 Patch History ............................................................................................................................. 135
8.7.1 Procedural Steps ............................................................................................................. 135
8.7.2 View Patch History via CLI .............................................................................................. 136
8.7.3 View Patch History via SNMP ......................................................................................... 136
8.8 Patch File Modified ................................................................................................................... 136
8.8.1 Procedural Steps ............................................................................................................. 136
8.8.2 View Modified Files via CLI ............................................................................................. 136
8.8.3 View Modified Files via SNMP ........................................................................................ 137
8.9 Upgrade Cisco BroadWorks Software Manager .................................................................... 137
8.10 Software Manager Logging ...................................................................................................... 138
8.11 Software Manager Database Backup and Restore................................................................ 139
9 Cisco BroadWorks OS In-place Upgrade Procedures........................................................ 140
9.1 Oracle Linux 7 to Oracle Linux 8 In-place Upgrade Procedure ............................................. 140
9.1.1 Procedural Steps ............................................................................................................. 140
9.1.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check............................................ 141
9.1.3 Perform a Backup ............................................................................................................ 141
9.1.4 Prepare for the Upgrade .................................................................................................. 141
9.1.5 Run the OS Preupgrade Check ...................................................................................... 143
9.1.6 Upgrade the System ........................................................................................................ 145
9.1.7 Verify the Upgrade ........................................................................................................... 146
9.1.8 Complete Postupgrade Tasks ........................................................................................ 147
9.2 Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 In-place Upgrade Procedure ... 149
9.2.1 Procedural Steps ............................................................................................................. 149

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 22 OF 225

 9.2.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check............................................ 149
9.2.3 Perform a Backup ............................................................................................................ 149
9.2.4 Prepare for the Upgrade .................................................................................................. 150
9.2.5 Run the OS Preupgrade Check ...................................................................................... 152
9.2.6 Upgrade the System ........................................................................................................ 154
9.2.7 Verify the Upgrade ........................................................................................................... 156
9.2.8 Complete Postupgrade Tasks ........................................................................................ 156
9.3 CentOS 7 to Oracle Linux 8 In-place Upgrade Procedure..................................................... 159
9.3.1 Procedural Steps ............................................................................................................. 159
9.3.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check............................................ 160
9.3.3 Perform a Backup ............................................................................................................ 160
9.3.4 Convert CentOS 7 to Oracle Linux 7 .............................................................................. 160
9.3.5 Perform Oracle Linux 7 to Oracle Linux 8 In-place Upgrade ........................................ 161
9.4 CentOS 7 to Red Hat Enterprise Linux 8 In-place Upgrade Procedure ............................... 161
9.4.1 Procedural Steps ............................................................................................................. 161
9.4.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check............................................ 162
9.4.3 Perform a Backup ............................................................................................................ 162
9.4.4 Convert CentOS 7 to Red Hat Enterprise Linux 7 ......................................................... 162
9.4.5
Perform Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 In-place Upgrade
........................................................................................................................................... 165
9.5 Oracle Linux 8 to Oracle Linux 9 In-place Upgrade Procedure ............................................. 165
9.5.1 Procedural Steps ............................................................................................................. 165
9.5.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check............................................ 165
9.5.3 Perform a Backup ............................................................................................................ 166
9.5.4 Prepare for the Upgrade .................................................................................................. 166
9.5.5 Run the OS Preupgrade Check ...................................................................................... 168
9.5.6 Upgrade the System ........................................................................................................ 170
9.5.7 Verify the Upgrade ........................................................................................................... 172
9.5.8 Complete Postupgrade Tasks ........................................................................................ 172
9.6 Red Hat Enterprise Linux 8 to Red Hat Enterprise Linux 9 In-place Upgrade Procedure ... 173
9.6.1 Procedural Steps ............................................................................................................. 173
9.6.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check............................................ 174
9.6.3 Perform a Backup ............................................................................................................ 174
9.6.4 Prepare for the Upgrade .................................................................................................. 174
9.6.5 Run the OS Preupgrade Check ...................................................................................... 177
9.6.6 Upgrade the System ........................................................................................................ 179
9.6.7 Verify the Upgrade ........................................................................................................... 181
9.6.8 Complete Postupgrade Tasks ........................................................................................ 181
9.7 Offline Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 In-place Upgrade
Procedure .................................................................................................................................. 184
9.7.1 Procedural Steps ............................................................................................................. 184
9.7.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check............................................ 184
9.7.3 Perform a Backup ............................................................................................................ 184

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 23 OF 225

 9.7.4 Prepare for the Upgrade .................................................................................................. 185
9.7.5 Run the OS Preupgrade Check ...................................................................................... 187
9.7.6 Upgrade the System ........................................................................................................ 190
9.7.7 Verify the Upgrade ........................................................................................................... 192
9.7.8 Complete Postupgrade Tasks ........................................................................................ 192
9.8 Offline CentOS 7 to Red Hat Enterprise Linux 8 In-place Upgrade Procedure.................... 196
9.8.1 Procedural Steps ............................................................................................................. 196
9.8.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check............................................ 197
9.8.3 Perform a Backup ............................................................................................................ 197
9.8.4 Convert CentOS 7 to Red Hat Enterprise Linux 7 ......................................................... 197
9.8.5 Cleanup after Convert2RHEL ......................................................................................... 201
9.8.6 Perform Offline Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 In-place
Upgrade ............................................................................................................................ 201
9.9 Recovery of OS In-place Upgrade Failures Procedure.......................................................... 201
10 Error Recovery ........................................................................................................................... 202
10.1 Software Activation – Upgrade-related Error Recovery ......................................................... 202
10.1.1 General Cisco BroadWorks Servers Behavior .............................................................. 202
10.1.2 Failure while Upgrading Application Server or Network Server Primary Node ........... 202
10.1.3 Failure while Upgrading Application Server or Network Server Secondary Node ...... 202
10.2 Software Activation – Rollback-related Error Recovery ......................................................... 203
10.2.1 General Cisco BroadWorks Servers Behavior .............................................................. 203
10.2.2 Failure while Rolling Back Application Server or Network Server Primary Node ........ 203
10.2.3 Failure while Rolling Back Application Server or Network Server Secondary Node ... 203
11 Appendix A: Installation Warnings........................................................................................ 205
12 Appendix B: SSL Key and Certification................................................................................ 207
13 Appendix C: Non-interactive Installation ............................................................................. 208
13.1 Format of Silent Installation File ............................................................................................... 208
14 Appendix D: Database Logging to Different Disk on x86_64 Hardware ........................ 214
14.1 Disk Drive Basic Configuration................................................................................................. 214
14.1.1 Linux ................................................................................................................................. 214
14.2 TimesTen Reconfiguration ....................................................................................................... 216
15 References .................................................................................................................................. 220
16 Acronyms and Abbreviations.................................................................................................. 221
Index .................................................................................................................................................... 223

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 24 OF 225

Table of Figures

Figure 1 Installation and Upgrade Order .................................................................................................. 48

Figure 2 Installation, Upgrade, and Patch Procedure for Non-redundant Servers ................................ 50
Figure 3 Installation, Upgrade, and Patch Procedure for Redundant Servers ...................................... 52
Figure 4 Boot Installation Media................................................................................................................ 60
Figure 5 Language Selection .................................................................................................................... 61
Figure 6 INSTALLATION SUMMARY ...................................................................................................... 61
Figure 7 TIME & DATE .............................................................................................................................. 62
Figure 8 SOFTWARE SELECTION ......................................................................................................... 62
Figure 9 INSTALLATION DESTINATION ................................................................................................ 63
Figure 10 Disk Partitioning – Deleting Existing Partitions ........................................................................ 63
Figure 11 Disk Partitioning – Creating Partitions...................................................................................... 64
Figure 12 Disk Partitioning – Confirm Changes ....................................................................................... 65
Figure 13 NETWORK & HOST NAME – Configure ................................................................................ 66
Figure 14 NETWORK & HOST NAME – General ................................................................................... 66
Figure 15 NETWORK & HOST NAME – IPv4 Settings .......................................................................... 67
Figure 16 INSTALLATION SUMMARY – Root Password ...................................................................... 68
Figure 17 System Administration Password ............................................................................................ 68
Figure 18 Begin Installation ....................................................................................................................... 69
Figure 19 Patch State Management .......................................................................................................127

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 25 OF 225

 1 Summary of Changes

The following is the list of changes to the installation and upgrade processes described in
this document.

1.1 Changes for version 28

This version of the document includes the following changes:
• Updated section 4.7 Supported Operating Systems, added section 9 Cisco BroadWorks
OS In-place Upgrade Procedures for BWKS-8724.
• Updated section 6 - Cisco BroadWorks Upgrade Procedure to be more accurate and up
to date.

1.2 Changes for Version 27

This version of the document includes the following changes:
• Updated section [Link].3 Required Third-Party Packages to include firewalld package.
• Added section 5.6.8 Configure SNMP Community String.
• Updated section 12.1 Format of Silent Installation File to correct key name.

1.3 Changes for Version 26

This version of the document includes the following changes:
• Adding support for Linux 9.

1.4 Changes for Version 25

This version of the document includes the following changes:
• Removed support for Linux 5 and 6 for BWKS-8634.

1.5 Changes for Version 24

This version of the document includes the following changes:
• Updated sections [Link] Latest Linux Updates and [Link].2 Install Packages with
subscription-manager Utility to fix subscription-manager command.

1.6 Changes for Version 23

This version of the document includes the following changes:
• Clarify upgrade process for ADP applications in section 4.2 Installation and Upgrade
Order.

1.7 Changes for Version 22

This version of the document includes the following changes:
• Updated section 5.2.2 Disk Partitioning Options to increase size of /var partition.

1.8 Changes for Version 21

This version of the document includes the following changes:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 26 OF 225

 • Updated section 5.6.3 Configuration files for log rotation to add /etc/logrotate.d/diagnostic.

1.9 Changes for Version 20

This version of the document includes the following changes:
• Updated section 4.7 Supported Operating Systems to remove reference to CentOS 8.

1.10 Changes for Version 19

This version of the document includes the following changes:
• Updated section 5.6.9 Automatically Send Tech-Support Output to Cisco to remove
obsolete parameter xchangeuser.

1.11 Changes for Version 18

This version of the document includes the following changes:
• Added section 5.6.10 Core File Size and Number of Open File Descriptors Limits for
BWKS-6969.
• Updated document for BWKS-5567 and BWKS-6413: removed references to AMS, UMS,
USS, UVS, and WRS, changed references to PS and XSP with ADP when applicable.

1.12 Changes for Version 17

This version of the document includes the following change:
• Updated section 6 Cisco BroadWorks Upgrade Procedure and subsections to clarify the
flow.

1.13 Changes for Version 16

This version of the document includes the following changes:
• Added note in section 5.2.2 Disk Partitioning Options to clarify nodev, noexec and nosuid
partition options.
• Added section 5.6.3 Configuration files for log rotation.

1.14 Changes for Version 15

This version of the document includes the following change:
• Added section [Link] Swappiness for BWKS-5886.

1.15 Changes for Version 14

This version of the document includes the following change:
• Add section 5.4.4 Verify the Signature of Software Image for BWKS-4452.

1.16 Changes for Version 13

This version of the document includes the following changes:
• Update section Appendix C: Non-interactive Installation for BWKS-1212.
• Updated section [Link] Configure Cisco BroadWorks through Interactive Installation and
added sections [Link].3, [Link].4, [Link].5 and [Link].6 for BWKS-1212.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 27 OF 225

 1.17 Changes for Version 12
This version of the document includes the following change:
◼ Updated section [Link].3 Required Third-Party Packages for BWKS-5315.

1.18 Changes for Version 11

This version of the document includes the following changes:
◼ Updated section [Link].3 Required Third-Party Packages with package list of DBS
on Linux 8.
◼ Updated section 6.1.3 Disk Space and DSN Requirements for BWKS-4771.

1.19 Changes for Version 10

This version of the document includes the following changes:
◼ Updated sections 4.7 Supported Operating Systems and 5.2.6 Move from Red Hat
Enterprise Linux 5, 6, 7, or 8 to Red Hat Enterprise Linux 9 to inform the end of
support of Linux 6 on Release Independent version.

1.20 Changes for Version 9

This version of the document includes the following changes:
◼ Fixed typos related to the Application Delivery Platform for BWKS-3421.
◼ Updated sections 10.1 Software Activation – Upgrade-related Error Recovery and
10.2 Software Activation – Rollback-related Error Recovery for BWKS-539.
◼ Updated oracle preinstall package note in section [Link].3 Required Third-Party
Packages for BWKS-3636.

1.21 Changes for Version 8

This version of the document includes the following change:
◼ Added section [Link] /etc/systemd/[Link] for BWKS-1826.

1.22 Changes for Version 7

This version of the document includes the following changes:
◼ Updated section [Link].3 Required Third-Party Packages to remove unneeded
packages from the NFM and NDS lists for BWKS-1706.
◼ Updated section [Link].4.1 Activate System Activity Reporting for BWKS-2212.

1.23 Changes for Version 6

This version of the document includes the following changes:
◼ Updated section 8.4.2 Apply Patch via CLI and 8.5.2 Remove Patch via CLI for PR-
63894.
◼ Added note in section 5.5 Install Software for BWKS-462.
◼ Updated section 13.1 Format of Silent Installation File to fix the server type list.

1.24 Changes for Version 5

This version of the document includes the following changes:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 28 OF 225

 ◼ Updated sections [Link].19 Configure Basic Maintenance Tasks, [Link] Configure
Cisco BroadWorks through Interactive Installation, and 13 Appendix C: Non-
interactive Installation for PR-65633.
◼ Updated section 13 Appendix C: Non-interactive Installation for PR-65642.

1.25 Changes for Version 4

This version of the document includes the following changes:
◼ Updated section 5.2.2 Disk Partitioning Options to clarify EFI partition requirement.
◼ Updated section 4.7 Supported Operating Systems for PR-65391.

1.26 Changes for Version 3

This version of the document includes the following changes:
◼ Added section 6.10 Additional Considerations when Upgrading an Xtended Services
Platform/Profile Server (XSP/PS) to the Application Delivery Platform (ADP).

1.27 Changes for Version 2

This version of the document includes the following changes:
◼ Clarified section [Link] Transparent Huge Pages for PR-64512.
◼ Updated Cisco Database Server package list for BW-22346 in section [Link].3
Required Third-Party Packages.

1.28 Changes for Version 1

This version of the document includes the following changes:
◼ Updated sections 3 Overview, 4.7 Supported Operating Systems, 5.1 Install and
Configure Operating System, 5.2 Install Linux 9 and 5.6.4 Linux Updates for BW-
22634.
◼ Updated Figure 19 Patch State Management for PR-61423.
◼ Updated section 5.2.2 Disk Partitioning Options for PR-62554.
◼ Removed information about support for Linux 5, as Linux 5 is no longer supported in
Release 24.0.
◼ Updated section 5.2.6 Move from Red Hat Enterprise Linux 5, 6, 7, or 8 to Red Hat
Enterprise Linux 9.
◼ Removed reference to obsolete document in section 4.9 Upgrade Best Practices for
PR-62879.
◼ Updated sections 4.2 Installation and Upgrade Order and 4.4 Cisco BroadWorks for
PR-62897.
◼ Added -noCheck to section 14.2 TimesTen Reconfiguration for PR-62856.
◼ Updated section 5.2.3 Installation Procedure for PR-63411.
◼ Updated section 4.7 Supported Operating Systems and added section 4.8 Operating
System Upgrade Best Practices for PR-63316.
◼ Added sections [Link] CPU Frequency Scaling, [Link] Transparent Huge Pages
for PR-63264.
◼ Updated Appendix C: Non-interactive Installation for PR-63521.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 29 OF 225

 ◼ Updated sections 5.5.1 Non-interactive Installation, [Link] Post-installation Activation
Steps, [Link] Start Interactive Installation, [Link].1 Cisco BroadWorks User Name,
[Link] Post-installation Activation, 5.6.5 Enable TimesTen SNMP Traps Reporting for
PR-63000.
◼ Updated sections [Link] CPU Frequency Scaling, [Link] Transparent Huge
Pages for PR-63742.
◼ Updated section [Link].3 Required Third-Party Packages to add psmisc package
for PR-63701.
◼ Updated sections [Link] CPU Frequency Scaling, [Link] Transparent Huge
Pages for PR-63831.
◼ Updated section [Link].3 Required Third-Party Packages for PR-63921.

1.29 Changes for Release 23.0

Changes for Release 23.0, Version 1 Document:
This version of the document includes the following changes:
◼ Updated section 7 Cisco BroadWorks Rollback/Revert Procedures for PR-56282.
◼ Updated section [Link].3 Required Third-Party Packages for PR-54254.
◼ Updated section 6.1 Pre-upgrade Steps for PR-54405.
◼ Updated section [Link].3 Required Third-Party Packages for PR-57121.
◼ Updated section 5.2.2 Disk Partitioning Options for BW-13504.
◼ Updated section [Link].12 Configure Redundancy for PR-58409.
◼ Updated section 5.2.7 Patch Linux for PR-59073.
◼ Updated section 5.2.2 Disk Partitioning Options for PR-58914.
◼ Updated section 5.1 Install and Configure Operating System for BW-16867.
◼ Updated sections 2 Purpose, 3 Overview and section 4 Cisco BroadWorks Software
Management for BE-6883.
◼ Updated section [Link] Additional Software Packages for PR-59755.
◼ Updated section 6.1.3 Disk Space and DSN Requirements for PR-59633.

1.30 Changes for Release 22.0

Changes for Release 22.0, Version 5 Document:
This version of the document includes the following changes:
◼ Updated section 5.2.2 Disk Partitioning Options for PR-55615.
◼ Updated section 5.2 Install Linux 9 to clarify Linux 7 support for PR-55839.
Changes for Release 22.0, Version 4 Document:
This version of the document includes the following changes:
◼ Updated sections [Link] Latest Linux Updates, 5.6.4 Linux Updates, and [Link].1
Install Packages from DVD Installation Media for PR-55648.
◼ Updated section [Link].3 Required Third-Party Packages for PR-53968.
◼ Updated sections [Link] /etc/hosts and [Link].12 Configure Redundancy for PR-
55112.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 30 OF 225

 ◼ Updated section [Link] /etc/hosts for PR-53374.
◼ Updated section [Link].3 Required Third-Party Packages for PR-54305.
Changes for Release 22.0, Version 3 Document:
This version of the document includes the following changes:
◼ Updated section 4.2 Installation and Upgrade Order to add NDS.
◼ Updated section [Link] /etc/hosts for PR-54624.
Changes for Release 22.0, Version 2 Document:
This version of the document includes the following changes:
◼ Updated section [Link] Optimistic Duplicate Address Detection (DAD) Enabling for
Bonding IPv6 for PR-53823.
◼ Updated section [Link].3 Required Third-Party Packages for FR-10631.
Changes for Release 22.0, Version 1 Document:
This version of the document includes the following changes:
◼ Added section 5.6.5 Enable TimesTen SNMP Traps Reporting for EV 228205.
◼ Added section 5.6.7 Configure Net-SNMP Subagent to Listen to IPv6 Address on
Linux for PR-46872.
◼ Added section 5.6.9 Automatically Send Tech-Support Output to Cisco for
PR-46915.
◼ Updated section [Link].3 Required Third-Party Packages to add Network Database
Server required packages and add compat-readline5 to the Network Function
Manager required packages list.
◼ Updated Appendix C: Non-interactive Installation for PR-47350.
◼ Updated section 4.7 Supported Operating Systems for PR-47532.
◼ Updated section 5.1 Install and Configure Operating System for PR-47657.
◼ Updated section 13.1 Format of Silent Installation File for PR-47751.
◼ Updated links to JRE software information in section 5.6.6 Time Zone/Daylight Saving
Time Version in JRE Software.
◼ Updated document with current examples.
◼ Updated section [Link].3 Required Third-Party Packages to add Netcat package
dependency to Network Database Server and Network Function Manager.
◼ Updated sections 4.7 Supported Operating Systems, 5.1 Install and Configure
Operating System, and 5.2 Install Linux 9 for PR-47930.
◼ Added section [Link] Net-SNMP Configuration for IPv6 for PR-48109.
◼ Updated sections 3 Overview, 4.7 Supported Operating Systems, 5.1 Install and
Configure Operating System, and 5.2 Install Linux 9 for BW-6879.
◼ Updated section [Link].3 Required Third-Party Packages.
◼ Updated section 13.1 Format of Silent Installation File for PR-48420.
◼ Update section 5.2.2 Disk Partitioning Options for PR-45595.
◼ Update section [Link] IP Multipathing for PR-47636.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 31 OF 225

 ◼ Updated section [Link].3 Required Third-Party Packages for
PR-49098.
◼ Added section [Link] /etc/sysconfig/network for PR-50518.
◼ Updated section 7.3.2 Revert to Previous Version.

1.31 Changes for Release 21.0

Changes for Release 21.0, Version 2 Document:
This version of the document includes the following changes:
◼ Updated sections 7.3.1 Roll Back to Previous Version and 8.5.2 Remove Patch via
CLI for EV 213799.
◼ Updated section 6.5.1 New License Installation for EV 246871.
Changes for Release 21.0, Version 1 Document:
This version of the document includes the following changes:
◼ Updated document for Release 21.0.
◼ Updated section [Link] Configure Cisco BroadWorks through Interactive Installation
to add User Password step for EV 230356.

1.32 Changes for Release 20.0

Changes for Release 20.0, Version 6 Document:
This version of the document includes the following changes:
◼ Updated sections 5.2.7 Patch Linux for EV 225331.
◼ Updated section [Link].10 Configure Database Pre-defined Size for EV 214078.
◼ Updated section 5.1 Install and Configure Operating System for EV 226558.
Changes for Release 20.0, Version 5 Document:
This version of the document includes the following changes:
◼ Updated section 5.2.2 Disk Partitioning Options for EV 222828.
Changes for Release 20.0, Version 4 Document:
This version of the document includes the following changes:
◼ Updated all references to the Sharing Server (USS) and the Messaging Server
(UMS).
Changes for Release 20.0, Version 3 Document:
This version of the document includes the following changes:
◼ Updated section [Link].12 Configure Redundancy for EV 215116.
◼ Updated section [Link].3 Required Third-Party Packages for EV 213768.
Changes for Release 20.0, Version 2 Document:
This version of the document includes the following changes:
◼ Updated document for the WebRTC Server (WRS), Messaging Server (UMS), and
Sharing Server (USS).
◼ Updated section 5.2.2 Disk Partitioning Options for EV 208578.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 32 OF 225

 Changes for Release 20.0, Version 1 Document:
This version of the document includes the following changes:
◼ Added Center for Internet Security (CIS) recommendations to section 5.2.2 Disk
Partitioning Options.
◼ Updated Appendix C: Non-interactive Installation for EV 187580.
◼ Updated section 4.6 Installation, Upgrade, and Patch Procedures for Redundant
Servers for EV 177121 and EV 195736.
◼ Updated sections 5.3 Install Solaris 11 and 5.4 Configure Solaris OS for EV 191244.
◼ Added note to section [Link] Host Name Configuration Recommendations for
EV 170241.
◼ Updated sections 6.7.1 Upgrade Cisco BroadWorks, 7.3.1 Roll Back to Previous
Version, and 7.3.2 Revert to Previous Version for EV 198263.

1.33 Changes for Release 19.0

Changes for Release 19.0, Version 6 Document:
This version of the document includes the following change:
◼ Updated section Error! Reference source not found. Error! Reference source not fo
und. for EV 186963.
Changes for Release 19.0, Version 5 Document:
This version of the document includes the following change:
◼ Repaired section numbering for EV 190289.
Changes for Release 19.0, Version 4 Document:
This version of the document includes the following changes:
◼ Updated section [Link].4.1 Activate System Activity Reporting for EV 186426.
◼ Updated section 4.9 Upgrade Best Practices for EV 187696.
Changes for Release 19.0, Version 3 Document:
This version of the document includes the following changes:
◼ Updated section 5.2 Install Linux for EV 182760.
◼ Corrected section numbering.
◼ Updated section 13.1 Format of Silent Installation File for EV 178567.
Changes for Release 19.0, Version 2 Document:
This version of the document includes the following changes:
◼ Updated section Appendix D: Database Logging to Different Disk on x86_64
Hardware for EV 150865.
◼ Updated section 5.2.2 Disk Partitioning Options for EV 157304.
◼ Added section [Link].15 Hardening Recommendations.
◼ Updated section [Link].3 Required Third-Party Packages for
EV 180243.
Changes for Release 19.0, Version 1 Document:
This version of the document includes the following changes:
◼ Updated section [Link].3 Required Third-Party Packages for EV 173453.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 33 OF 225

 ◼ Added section [Link].14 Configure Application Server I for EV 161398.
◼ Updated sections 5.2.3 Installation Procedure and [Link].2.1 Installing Packages
with Yum for EV 155507.
◼ Updated section Enable SNMP Net Subagent and removed sections 5.8.4 Configure
Net-SNMP Subagent on Linux, 5.8.5 Configure Net-SNMP Host Resources Subagent
on Solaris, 5.8.6 Enable TimesTen SNMP Traps Reporting, Appendix H: How to
Proxy UCD-SNMP Resource MIB on Linux, and Appendix I: How to Proxy
HOST_RESOURCES MIB on Linux for EV 145130.
◼ Removed section on disabling OOM killer for EV 158758.
◼ Added some recommended Linux packages in section 5.2.3 Installation Procedure for
EV 160398.
◼ Modified section 5.2 Install Linux for EV 163201.
◼ Updated section 13.1 Format of Silent Installation File for EV 169450.
◼ Updated section 6.5.1 New License Installation for EV 170253.
◼ Removed section [Link].3 Enable SNMP Net SNMP Subagent.
◼ Updated section 5.2 Install Linux for EV 171203.
◼ Updated section 5 Cisco BroadWorks Initial Installation Procedure for EV 154206.
◼ Updated section [Link] IP Multipathing for EV 131016.
◼ Updated section [Link].19 Configure Basic Maintenance Tasks for EV 175534.
◼ Updated sections 14.2 TimesTen Reconfiguration and 15.2 TimesTen
Reconfiguration for EV 175635.
◼ Removed references to the Conferencing Server for EV 177716.

1.34 Changes for Release 18.0

Changes for Release 18.0, Version 2 Document
This version of the document includes the following changes:
◼ Reverted the changes for EV 144590 in section [Link] Name Resolution
Configuration (removed the requirement to restart the server since at the time of the
procedure Cisco BroadWorks in not installed yet).
Changes for Release 18.0, Version 1 Document
This version of the document includes the following changes:
◼ Updated document for Release 18.0.
◼ Updated section [Link] Name Resolution Configuration for EV 144590.
◼ Updated section 5.3 Install Cisco BroadWorks for EV 146548.

1.35 Changes for Release 17.0

Changes for Release 17.0, Version 13 Document
◼ Updated section [Link] IP Multipathing for EV 131016.
◼ Updated section 5.3.2 Disk Partitioning for EV 108246
◼ Updated sections 6.11.1 Software Activation and 7.3.2 Revert to Previous Version for
reverting software version for EV 150660.
◼ Removed server memory requirement in section 5.3 Install Solaris 11 for EV 149520.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 34 OF 225

 Changes for Release 17.0, Version 12 Document
This version of the document includes the following changes:
◼ Updated Solaris disk mirroring procedure in sections 5.3.2 Disk Partitioning and 5.4
Mirror Disks with Solaris Sparc Volume Manager for EV 116226.
Changes for Release 17.0, Version 11 Document
This version of the document includes the following changes:
◼ Updated Linux rpm list in [Link].2 Manual Installation with DVD and [Link].2.1
Installing Packages with Yum for EV 144333.
◼ Updated Linux OS post install steps to disable OOM-Killer for EV 143237.
◼ Added note about sudoer in section 5.3 Install Cisco BroadWorks for EV 132051.
Changes for Release 17.0, Version 10 Document
This version of the document includes the following changes:
◼ Moved section on How to Proxy UCD-SNMP Resource MIB on Linux to Appendix H;
moved section on How to Proxy the Host_Resources MIBs on Linux to Appendix I, for
EV 129600.
◼ Updated Figure 1 Installation and Upgrade Order to add the Database Server.
Changes for Release 17.0, Version 9 Document
This version of the document includes the following changes:
◼ Updated section [Link].2.1 Installing Packages with Yum for EVs 131224 and
131226.
◼ Removed references to config-network in sections [Link] Solaris IP Multipathing and
[Link] Netmask/Prefix Configuration for EV 131989.
◼ Added a parameter to the list of valid parameters for [Link] in section 13.1
Format of Silent Installation File for EV 131073.
Changes for Release 17.0, Version 8 Document
This version of the document includes the following changes:
◼ Updated Linux bonding in section [Link] IP Multipathing for EV 108017.
◼ Updated section [Link].4.1 Activate System Activity Reporting for EV 126793.
◼ Added section Configure Net-SNMP Host Resources Subagent on Solaris for
EV 116654.
Changes for Release 17.0, Version 7 Document
This version of the document includes the following changes:
◼ Updated section [Link].2 Manual Installation with DVD and section [Link].2.1
Installing Packages with Yum for EV 126139.
◼ Updated sections 5.2 Install Linux and added section 5.6.4 Linux Updates for
EV 106778.
◼ Updated sections 5.2.2 Disk Partitioning, 5.2.4 Mirror Disks with RAID, 13.1.1 Solaris
x86_64, 13.2 Linux, 14 Appendix D: Database Logging to Different Disk on x86_64
Hardware, and added section 5.2.5 Mirror Disks with RAID for EV 110727.
◼ Updated section 5.2.5 Configure Post-Linux Installation to include a requirement to
disable Address Resolution Protocol (ARP) between interfaces on a multi-homed
server for EV 87974.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 35 OF 225

 ◼ Updated section 6.11.1 Software Activation for EV 125061 and updated link to OS
patches in section 8.2 OS Patching.
Changes for Release 17.0, Version 6 Document
This version of the document includes the following changes:
◼ Updated section [Link].19 Configure Basic Maintenance Tasks for EV 114437.
◼ Update patching note for EV 115953.
◼ Updated section 5.2.7 Patch Linux for EV 96032.
Changes for Release 17.0, Version 5 Document
This version of the document includes the following changes:
◼ Updated Appendix D: Database Logging to Different Disk for EVs 113822 and
110907.
◼ Updated section 5.2.1 Installation Options for EV 115423.
Changes for Release 17.0, Version 4 Document
This version of the document includes the following changes:
◼ Updated sections 14.1 Disk Drive Basic Configuration and 15.1 Mirroring Empty
Slices for EV 113774.
Changes for Release 17.0, Version 3 Document
This version of the document includes the following changes:
◼ Added section 5.8.7 How to Proxy HOST_RESSOURCES MIB on Linux for
EV 105486. (This was later moved to the Appendix.)
Changes for Release 17.0, Version 2 Document
This version of the document includes the following changes:
◼ Updated the upgrade command in section 7.3.1 Roll Back to Previous Version for
EV 110518.
◼ Updated section 8.11 Software Manager Database Backup and Restore for
EV 111179.
◼ Updated section 4.1 General Rules for EV 111289.
Changes for Release 17.0, Version 1 Document
This version of the document includes the following change:
◼ Updated document for Release 17.0.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 36 OF 225

 1.36 Changes for Release 16.0
Changes for Release 16.0, Version 8 Document
This version of the document includes the following changes:
◼ Fixed spelling error in section [Link].10 Configure Database Pre-defined Size.
◼ Clarified disk partitioning requirements for Solaris and Linux in section 5.3.2 Disk
Partitioning for EV 96360.
Changes for Release 16.0, Version 7 Document
This version of the document includes the following changes:
◼ Updated section 6.7.1 Upgrade Cisco BroadWorks for EV 99727.
Changes for Release 16.0, Version 6 Document
This version of the document includes the following changes:
◼ Clarified the database re-synchronization procedure in section 10.2.3 Failure while
Rolling Back Application Server or Network Server Secondary Node for EV 104791.
Changes for Release 16.0, Version 5 Document
This version of the document includes the following changes:
◼ Added clarification regarding the mix of Operating System versions in a database
cluster to section 4.7 Supported Operating Systems.
◼ Updated section 6.7 Activate New Software Version for EV 99498.
Changes for Release 16.0, Version 4 Document
This version of the document includes the following changes:
◼ Updated section 4.2 Installation and Upgrade Order for EV 103377.
◼ Updated section 6.7 Activate New Software Version for EV 99498.
◼ Replaced references of Boulevard with Xchange in section 8.2 OS Patching.
Changes for Release 16.0, Version 3 Document
This version of the document includes the following changes:
◼ Updated section 13.1 Format of Silent Installation File for EV 97357, which failed after
publishing.
◼ Updated section 5.3.2 Disk Partitioning for EV 102438.
Changes for Release 16.0, Version 2 Document
This version of the document includes the following changes:
◼ Updated section 4.6 Installation, Upgrade, and Patch Procedures for Redundant
Servers for EV 97768.
◼ Updated section [Link] Name Resolution Configuration and section [Link] Name
Resolution Configuration for EV 94429.
◼ Updated Solaris 9 support for EV 99245.
◼ Updated section 13.1 Format of Silent Installation File for EV 97357.
◼ Updated the following sections for EV 100721: [Link] /etc/sysconfig/network, [Link]
Default Router Configuration, and [Link] Netmask/Prefix Configuration.
◼ Updated section [Link].2.1 Installing Packages with Yum for EV 100953.
◼ Updated section 13.1 Format of Silent Installation File for EV 98415.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 37 OF 225

 ◼ Updated section 14.2 TimesTen Reconfiguration for EV 99544.
Changes for Release 16.0, Version 1 Document
This version of the document includes the following changes:
◼ Updated document for Release 16.0.
◼ Added miimon
◼ option as a default IP bonding option in Linux.
◼ Added clarification on OS compatibility and replication.

1.37 Changes for Release 15.0

Changes for Release 15.0, Version 9 Document
This version of the document includes the following changes:
◼ Updated section [Link].19 Configure Basic Maintenance Tasks for EV 92902.
◼ Updated section 6.4.3 Media Server-enabled Interface for EV 93436.
◼ Updated section [Link] IP Multipathing for EV 92724.
Changes for Release 15.0, Version 8 Document
This version of the document includes the following changes:
◼ Added Pre-Installation Validation tool usage to Upgrade Best Practices for EV 65557.
Changes for Release 15.0, Version 7 Document
This version of the document includes the following changes:
◼ Updated section 6.5.1 New License Installation for EV 90324.
◼ Removed information about canonical host name in section [Link].12 Configure
Redundancy for EV 88926.
◼ Added section 8.2 OS Patching for EV 89698.
◼ Added instruction to run config-network after configuring the IP Multipathing on a
server running Cisco BroadWorks already, in sections [Link] Solaris IP Multipathing
and [Link] IP Multipathing for EV 83894.
◼ Updated sections [Link].12 Configure Redundancy and 13.1 Format of Silent
Installation File to include replication port configuration.
◼ Updated section [Link] Recommended Patch Cluster to add a note on when to
perform a Solaris patch cluster update.
Changes for Release 15.0, Version 6 Document
This version of the document includes the following changes:
◼ Added the check_dbpages task to section [Link].19 Configure Basic Maintenance
Tasks for EV 69858.
◼ Updated section 15.2 TimesTen Reconfiguration for EV 83815.
◼ Added section 8.11 Software Manager Database Backup and Restore for EV 64338.
◼ Modified section 5.2 Install Linux for EV 84357.
◼ Modified section [Link].4.1 Activate System Activity Reporting for EV 86957.
◼ Updated section 15.1 Mirroring Empty Slices for EV 81998.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 38 OF 225

 Changes for Release 15.0, Version 5 Document
This version of the document includes the following changes:
◼ Corrected typographical errors for EV 69487.
◼ Removed “Configure Locale” from this document for EV 69554.
Changes for Release 15.0, Version 4 Document
This version of the document includes the following changes:
◼ Clarified Red Hat requirements in section 5.2 Install Linux for EV 69388.
◼ Removed a reference to Call Detail Server (CDS) redundancy in section 4.1 General
Rules.
◼ Added information about installing Network Server in IMS or non-IMS mode to section
[Link].18 Configure Server in IMS Mode for EV 69215.
Changes for Release 15.0, Version 3 Document
This version of the document includes the following change:
◼ Added Solaris 10 x86_64 support.
Changes for Release 15.0, Version 2 Document
This version of the document includes the following change:
◼ Added missing RHEL 5 support.
Changes for Release 15.0, Version 1 Document
The Release 15.0 Version 1.0 document was created from the Release 14.0 Version 17
document and then modified as follows:
◼ Updated for Release 15.0 functionality
◼ Linux 5: Added support for Red Hat Linux Enterprise 5.

1.38 Changes for Release 14.0

Changes for Release 14.0, Version 17 Document
This version of the document includes the following changes:
◼ Added an upgrade best practices section.
◼ Added an upgrade/rollback error handling use cases section.
◼ Added Profile Server information.
◼ Removed references to the Client Management System.
Changes for Release 14.0, Version 16 Document
This version of the document includes the following changes:
◼ Clarified the host name order in the /etc/hosts file for Apache server name.
◼ Added Xtended Services Platform information.
◼ Added section 15.3 Pre-Release 15 Upgrade Considerations.
Changes for Release 14.0, Version 15 Document
This version of the document includes the following changes:
◼ Made changes to section 14.2 TimesTen Reconfiguration.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 39 OF 225

 Changes for Release 14.0, Version 14 Document
This version of the document includes the following changes:
◼ Modified section [Link].19 Configure Basic Maintenance Tasks to add
bwPeriodMaint to the Element Management System (EMS) and Call Detail Server
(CDS) for EV 53221.
◼ Added Appendix on how to add modular flash drive to HS21 XM blades.
◼ Corrected list of daemon/services disabled by the installation for EV 60104.
Changes for Release 14.0, Version 13 Document
This version of the document includes the following change:
◼ Added details on assigning multiple IP addresses to a bonding group to section
[Link] IP Multipathing.
Changes for Release 14.0, Version 12 Document
This version of the document includes the following changes:
◼ Added note in sections [Link] IP Multipathing, Changes for Release 14.0, Version 1
Document, and Changes for Release 13.0.
◼ Changed Linux version to v.4 update 6 and Linux swap requirement to maximum of
8 GB.
Changes for Release 14.0, Version 11 Document
This version of the document includes the following changes:
◼ Added information on java TZ/DST and tzupdater tool in Cisco BroadWorks install and
upgrade sections.
◼ Added step to run [Link] after upgrade for EV 54951.
Changes for Release 14.0, Version 10 Document
This version of the document includes the following change:
◼ Added a section that describes the dependencies between the operating systems for
the different server types.
◼ Removed the Client Management System Model section for EV 52542.
Changes for Release 14.0, Version 9 Document
This version of the document includes the following change:
◼ Added information on the optional use of BEA WebLogic on the Application Server,
Network Server, and Web Server.
Changes for Release 14.0, Version 8 Document
This version of the document includes the following changes:
◼ Solved issue with the partitioning scheme and the Solaris Solstice Disk Suite.
◼ Corrected table in [Link].19 Configure Basic Maintenance Tasks. DbSyncCheck
utility should be run daily on the Network Server, and is not applicable to the Media
Server for EV 47355.
Changes for Release 14.0, Version 7 Document
This version of the document includes the following change:
◼ Updated section [Link].3 Required Third-Party Packages for EV 42643.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 40 OF 225

 Changes for Release 14.0, Version 6 Document
This version of the document includes the following changes:
◼ The third-party package list and the procedure to install the packages were updated.
◼ A note was added for Linux users in section [Link] Time Zone Configuration for
EV 41497.
◼ Small changes were made to sections 8.4.2 Apply Patch via CLI and 8.5.2 Remove
Patch via CLI for EV 41418.
Changes for Release 14.0, Version 5 Document
This version of the document includes the following changes:
◼ Service pack was added.
◼ SNMP proxy configuration was clarified.
◼ Section [Link].1 Register with Red Hat Network was updated and “–update” was
changed to “--update” for EV 42014.
◼ Section 8.10 Software Manager Logging was updated and directories were added for
log files for EV 41417.
Changes for Release 14.0, Version 4 Document
This version of the document includes the following change:
◼ Section [Link] Recommended Patch Cluster was updated for EV 39152.
Changes for Release 14.0, Version 3 Document
This version of the document includes the following changes:
◼ Client Management System: A Client Management System installation procedure
has been added to the guide, which affects section 4 Cisco BroadWorks Software
Management (added Client Management System to the upgrade flow).
◼ Made minor updates including an update to the rollback notes for EV 38865, as well
as information added for the nice command.
Changes for Release 14.0, Version 2 Document
Minor updates were made to the document, which included an update for the Patch tool
upgrade.
Changes for Release 14.0, Version 1 Document
The Release 14.0 Version 1.0 document was created from Release 13.0 Version 7.0
document and then modified as follows:
◼ Solaris 10: Included a description of Solaris 9 to Solaris 10 upgrade and as well as
how the OS services are enabled and disabled in Solaris 9 and Solaris 10.
◼ Linux: Changed the document to highlight the fact that hardware RAID is
recommended with Cisco BroadWorks but software RAID is not. Specified that
interface bonding should not be enabled when there is only one switch module
installed on a blade center.

NOTE: On the IBM 3550 Platform, the /etc/[Link] file required the following line:
options bond0 miimon=100 mode=1" instead of "options bond0 mode=1

Otherwise, the bond interface does not work.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 41 OF 225

 ◼ SSL: Added a note to indicate that Cisco BroadWorks must be restarted when
changing Apache certificates.
◼ Cisco BroadWorks Patching: Changed the document to describe the patching
model introduced in Release 14.0.
◼ Cisco BroadWorks Release 14.0, Version 1: Changed the document to reflect
functionality of Release 14.0 software version.

1.39 Changes for Release 13.0

◼ Changes for Release 13.0, Version 7 Document describes how to add the sys user
needed for the crontab command for Linux and corrects the syntax of the crontab
command for Solaris in sections [Link].1 Activate System Activity Reporting and
[Link].4.1 Activate System Activity Reporting respectively.
Changes for Release 13.0, Version 6 Document
◼ Corrected the syntax of the crontab command in sections [Link].1 Activate System
Activity Reporting and [Link].4.1 Activate System Activity Reporting respectively.
◼ Clarified that Cisco BroadWorks requires Red Hat Enterprise Linux WS (v. 4) (for 64-
bit processors). In addition, the list of packages required by Cisco BroadWorks has
been updated.
Changes for Release 13.0, Version 5 Document
This is a maintenance version, which provides clarification for the following procedures:
◼ Rollback: In case of rollback from Release 13.0 MPx, all MPs must be removed prior
to a rollback to a previous release of Cisco BroadWorks, that is, rollback to Release
12.0, 11.1, or 11.0.
Changes for Release 13.0, Version 4 Document
This is a maintenance version. It provides clarification for certain procedures as follows:
◼ Linux: Clarified the fact that Hardware RAID is recommended. Specified that
interface bonding should not be enabled when there is only one switch module
installed on a blade center.

NOTE: On the IBM 3550 Platform, the /etc/[Link] file requires the following line:
options bond0 miimon=100 mode=1" instead of "options bond0 mode=1

Otherwise, the bond interface does not work.

◼ SSL: Added a note to indicate that Cisco BroadWorks must be restarted when
changing Apache certificates.
Changes for Release 13.0, Version 3 Document
This is a maintenance version. It provides clarification for certain procedures as follows:
◼ Upgrade: Included a note about a potential pre-upgrade script for a given release.
◼ Linux: Modified the Linux third-party software list. Added a missing package and
replaced the 64-bit package for the 32-bit package listed.
◼ Installation: Clarified the DSN size versus physical memory information.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 42 OF 225

 Changes for Release 13.0, Version 1 Document
This version was created from the Release 12.0, Version 2.0 document and then modified
as follows:
◼ Linux Support: The installation section was restructured to support both Linux and
Solaris.
◼ Partitioning: The default-partitioning scheme for Solaris was modified.

1.40 Changes for Release 12.0

Changes for Release 12.0, Version 1.0 Document
This version was created from the Release 11.1, Version 1.0 document and then modified
as follows:
◼ New Maintenance Task: Tech-support can now be run as a daily maintenance task.
◼ Web Server: This document describes the impact of moving from a pre-release 12.0
to Release 12.0, for the Web Server. In addition, the high-level process has been
enhanced so that Web Servers are upgraded in proper sequence (versus Application
Servers).
◼ Non-interactive Upgrades: A new appendix has been added, listing parameters as
well as the format of attributes in the [Link] file.
◼ Recommended DSN Size: It is now recommended that the size of the DSN for the
Application Server and Network Server should not exceed 25% of the physical
memory available on the target server.
◼ Call Detail Server: This document includes the Call Detail Server.
◼ Disk Mirroring Procedure: Updated the procedure for Solaris 9.
◼ Registration Time Extension: Before upgrading a redundant Application Server
cluster, the SIP registration extension should be configured. After the upgrade, the
SIP registration extension should be restored to its value prior to the upgrade.

1.41 Changes for Release 11.1

Changes for Release 11.1, Version 1 Document
This version was created from Release 11.0 Version 1 and then modified as follows:
◼ Self-extracting Installation: Added changes regarding self-extracting software
installation and MD5 checksum verification, which impacts fresh installs and upgrade
sections.
◼ Removed Limitations: Limitations for Release 8 to Release 9 upgrades were
removed from the document.

1.42 Changes for Release 11.0

Changes for Release 11.0, Version 1 Document
This version was created from Release 10, Version 1 and then modified as follows:
◼ Element Management System: Added references to the Element Management
System to section 4.
◼ Patching: The patch installation procedure may not apply for a specific patch. The
release notes of the patch should always be consulted first. Also, added information
indicating that the server does not have to be locked to delete a patch, but simply
reset.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 43 OF 225

 ◼ Summary: Removed the changes summary for Release 9 and 9.1.
◼ Maintenance Tasks: Added new maintenance tasks.
◼ Solaris 9: References to Solaris 8 were replaced with references to Solaris 9. A
section was added on how to upgrade a system from Solaris 8 to Solaris 9.
◼ Release 8: Removed references to Release 8 from the document because Release
8 to 11 upgrades are not supported. Modified the upgrade and rollback sections.
◼ JASS: JASS installation option was added to the list of installation options.

1.43 Changes for Release 10.0

Changes for Release 10.0, Version 1 Document
This version was created from Release 9.1, Version 1 document and then modified as
follows:
◼ Web Server: References to the Web Server were added to this document.
◼ Relay Server: References to the Relay Server were removed from this document.
◼ Conferencing Server: References to the Conferencing Server were added to this
document.
◼ Installation Logs Directory: The installation logs are now stored under
/var/broadworks/logs/installation.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 44 OF 225

 2 Purpose

This document explains how a carrier or system provider administers software on a Cisco
BroadWorks server or a system of Cisco BroadWorks servers.
The document is to be used by system providers to meet software management
requirements. The procedures in this document apply to all Cisco BroadWorks servers.
This guide includes the following Cisco BroadWorks procedures:
◼ Initial installation of Cisco BroadWorks software
◼ Upgrade to a newer version of software
◼ Downgrade to a previous version of software
◼ Installation and removal of software patches
In addition, this document also describes the following procedures, related to non-Cisco
BroadWorks software:
◼ Operating system installation
◼ Operating system configuration
◼ Additional Linux configuration procedures
Note that this document is not intended to supplement or replace the hardware
manufacturer’s instructions for equipment installation, maintenance, and support. In fact,
this document assumes the system provider has a clear understanding of the IBM
hardware and that the system provider has been trained in Linux (UNIX) system
administration.
This document is specifically related to Release 25.0 and Release Independent versions
of Cisco BroadWorks. This information is subject to change without notice. For updated
information, consult the Cisco BroadWorks release notes and the appropriate Cisco
personnel.
Although this document contains information regarding the Cisco BroadWorks system, it is
important that all customers follow the appropriate support procedures for issue resolution.
Regarding issues for Sun hardware, consult your Sun reseller or support representative.
Regarding issues for IBM hardware, consult your IBM reseller or support representative.
Regarding Cisco BroadWorks issues, follow the support procedures provided.
Cisco welcomes your contributions to improving our support and reference materials. If
you encounter issues with the Cisco BroadWorks product that you feel warrant inclusion in
this guide, follow the customer support procedure for contacting Cisco.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 45 OF 225

 3 Overview

The Cisco BroadWorks Software Management Guide provides procedures to install a new
Cisco BroadWorks system, as well as upgrade an existing Cisco BroadWorks installation.
It is intended for the Linux based systems (any differences in the procedures are
highlighted in the document). For the list of OS versions supported by Cisco BroadWorks
in Release 25.0 and Release Independent, see section 4.7 Supported Operating Systems.

NOTE 1: Many of the procedures to install and upgrade Cisco BroadWorks software are
common across each of the Cisco BroadWorks servers; however, exceptions are listed when
applicable.

NOTE 2: The Cisco BroadWorks Element Management System has been deprecated and is no
longer available starting from Cisco BroadWorks Release 23.0; the functionality it provided by
the Cisco BroadWorks Network Function Manager, available as a release-independent server.

This document covers the following topics:

◼ Cisco BroadWorks Software Management Overview – Describes the high-level
procedures and the relationship between servers. It is important to read and
understand this section before starting the installation.
◼ Cisco BroadWorks Initial Installation Procedure – Describes the procedure to
install Cisco BroadWorks software on a server for the first time (which means that you
are not upgrading from a previous release). This section includes the procedure to
install a server for a stand-alone configuration and to install a server for a redundant
configuration. It also covers Linux configuration.
◼ Cisco BroadWorks Upgrade Procedure – Describes how to upgrade a specific
Cisco BroadWorks server. This procedure describes how to upgrade servers
deployed in a stand-alone configuration as well as for servers that are deployed in
redundant configuration.
◼ Cisco BroadWorks Rollback Procedure – After a server has been upgraded, Cisco
BroadWorks allows for a seamless “rollback” to the previous version of software. This
section describes how to roll back to a previous release of software for both stand-
alone servers and redundant servers.
◼ Cisco BroadWorks Patching Procedure – Describes the procedure to apply and
remove Cisco BroadWorks software patches.
◼ Memory Requirements on Upgrade – Describes memory requirements for an
upgrade.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 46 OF 225

 4 Cisco BroadWorks Software Management

This section describes the high-level principles for Cisco BroadWorks software
management.

4.1 General Rules

In general, installation, upgrade, and patching procedures are common for all Cisco
BroadWorks servers. This simplifies software management procedures significantly and
reduces the time required for installations or upgrades.
For all servers, software management can be controlled either through the command line
interface (CLI) or through the Simple Network Management Protocol (SNMP) agent. This
allows for local software management (through the CLI) or remote software management
(either through a telnet CLI session or through an SNMP-based network management
system).
Although software management procedures are generally common for all servers,
redundancy is engineered differently for each type of server. The Application Server is
deployed redundantly in a primary/secondary mode whereby data is synchronized
between the paired servers. The Media Server is deployed using N+1 redundancy,
whereby each server is managed independently of other servers. The Xtended Service
Platform Servers are deployed as a pool of independent servers. The Application Delivery
Platform, Profile Server, Network Server, and Database Server are deployed using N+1
redundancy, whereby data are synchronized between all servers. This results in minor
differences in software management procedures. These differences are clearly explained
in the procedures in this document.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 47 OF 225

4.2 Installation and Upgrade Order
The following flowchart shows the order in which the different servers should be installed
or upgraded. This order guarantees meeting the requirements of the Cisco BroadWorks
software compatibility matrix available from Cisco.

Figure 1 Installation and Upgrade Order

NOTE 1: Application Delivery Platform hosting release-independent applications are upgraded

before the Application Server. Application Delivery Platform hosting release-anchored
applications are upgraded after the Application Server.

NOTE 2: For the installation and upgrade order in an IMS deployment, see the Cisco
BroadWorks XS Mode Configuration Guide.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 48 OF 225

 The following table contains the abbreviations for server names.
Abbreviation Server Name

ADP Application Delivery Platform

AS Application Server

DBS Database Server

MS Media Server

NDS Network Database Server

NFM Network Function Manager

NS Network Server

PS Profile Server

SCF Service Control Function

XS Execution Server

Xsp Xtended Services Platform

Note that not all servers are necessarily part of a system configuration. When a server is
not applicable to a customer configuration, the upgrade rule should be ignored. For
example, for a Cisco BroadWorks system deployed without a Service Control Function
server, upgrade rules specific to those servers would be ignored.
The Media Server and Network Server installation can be done in parallel or in any order.

4.3 Cisco BroadWorks Software Compatibility Rules

The flowchart from the previous section provides a high-level view of the software
compatibility rules between Cisco BroadWorks servers. In general, the Network Server,
and Media Server are backward compatible with two versions of the Application Server.
This implies the version N of the Network Server or Media Server can be used with
version N, N-1, or N-2 of the Application Server. For more information, see the Cisco
BroadWorks compatibility matrix available from Cisco.

4.4 Cisco BroadWorks Release Independent

Cisco BroadWorks release-independent software (for example, Rel_2019.12_1.050) is the
same as Cisco BroadWorks software (in terms of installation and upgrade). A release-
independent software can be freshly installed, and it can be used to upgrade a release
that is currently running. All the procedures and processes described in this guide apply to
software releases as well as release-independent software. There is no particular order
required during new version deployments as long as the new version of the individual
server type meets the requirements of the compatibility matrix for the existing server types
in the system.

4.5 Installation, Upgrade, and Patch Procedure for Non-redundant Servers

The following figure shows the Cisco BroadWorks installation, upgrade, and patching
procedure for all non-redundant Cisco BroadWorks server configurations.
Non-redundant configuration applies to the Media Server for both commercial and non-
commercial deployments. The Media Server is usually deployed using N+1 redundancy
pools, whereby all servers are equal and no data is shared between the servers.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 49 OF 225

 This procedure also applies to Xtended Services Platform servers. These are usually
deployed as a pool of independently managed servers.
This procedure may also apply to some non-commercial Application Server and Network
Server deployments, although the Application Server and Network Server are typically
deployed in a redundant configuration.

Figure 2 Installation, Upgrade, and Patch Procedure for Non-redundant Servers

Installing a new software version has no impact on the active software version. Few
software versions can be installed on a single Cisco BroadWorks server at any given time.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 50 OF 225

4.6 Installation, Upgrade, and Patch Procedures for Redundant Servers
One of the key underlying elements of the Cisco BroadWorks redundancy solution is the
data synchronization between the peer servers in a cluster. In all redundant configurations
except for the Database Server, the installation and upgrade procedures require that the
Cisco BroadWorks software be activated first on the primary server of a cluster.
Otherwise, the procedure for upgrading a single network element is the same as
upgrading a non-redundant server.
The following figure shows the Cisco BroadWorks installation, upgrade, and patching
procedure for redundant Application Delivery Platform servers, Application Servers,
Network Servers, and Profile Servers. An operator must view the cluster as a system and
run system-level commands. The following flowchart describes at a high level, the
upgrade procedure for a redundant system.

NOTE: For geo-redundant Database Servers, maintenance operations on the primary server
result in an automatic switch over to the standby site. Therefore, although not always technically
required, to reduce the number of role switches during upgrades it is generally recommended to
start with the standby site first. Furthermore, when upgrading to a new Oracle database third-
party component version, upgrading the standby site first is required and strictly enforced. For
more information, see the Cisco BroadWorks Database Server Configuration Guide.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 51 OF 225

 Figure 3 Installation, Upgrade, and Patch Procedure for Redundant Servers

NOTE 1: Configuration and restoration of the registration extension applies to Application

Server upgrades/rollbacks only.

NOTE 2: Software activation is automatically done for a fresh installation when an operator first
logs in to Cisco BroadWorks as a Cisco BroadWorks administrator. In addition, it is very
important to install the software for all members of a Cisco BroadWorks cluster before logging in
as a Cisco BroadWorks administrator on the primary server.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 52 OF 225

 4.7 Supported Operating Systems
As of Release 24.0, only the Linux operating system is supported. This document
describes the required configuration steps along with the different exceptions inherent to
this operating system.
The following table presents the operating systems and their versions supported by Cisco
BroadWorks in Release 24.0 and Release Independent.
OS Version Architecture

Red Hat Enterprise Linux 7.x Intel Xeon x86_64

8.x Intel Xeon x86_64

9.x Intel Xeon x86_64

CentOS 7.x Intel Xeon x86_64

Oracle Linux 7.x Intel Xeon x86_64

8.x Intel Xeon x86_64

9.x Intel Xeon x86_64

NOTE 1: The RHEL 7.x Advanced Platform version can be used instead of the RHEL 7.x Server
version and can be considered a supported Cisco BroadWorks RHEL 7.x version. Cisco
BroadWorks does not require any of the extra capabilities that the RHEL 7.x Advanced Platform
version provides. The same applies to RHEL 8.x Advanced Platform.
NOTE 2: Cisco validates performance on Red Hat Enterprise, CentOS, and Oracle Linux using
the generically delivered kernel with default settings/modules (except as otherwise specified in
this and/or other Cisco documentation). Other kernels/OS functionality (tuning/specialized
performance modules) have not been specifically tested by Cisco with Cisco BroadWorks. An
example of a specialized kernel is the Unbreakable Enterprise Kernel (UEK) provided by Oracle.
NOTE 3: For a given operating system on a particular CPU architecture, it is acceptable to mix
different versions of that operating system. For example, in a cluster, it is acceptable to have
nodes with Linux 7, and Linux 8.
NOTE 4: For the Database Server operating system requirements, see the Cisco BroadWorks
Database Server Configuration Guide.
NOTE 5: Linux 8 is only supported starting with Release Independent 2020.07, Release 23.0
Application Server, Network Server, Profile Server and Xtended Services Platform installed with
installation patch ip20230331 and application patch ap385046.
NOTE 6: Linux 6 is no longer supported starting with Release Independent 2023.05.
NOTE 7: Linux 9 is only supported starting with Release Independent 2023.09.
NOTE 8: The Database Server (DBS) is not supported on Linux 9.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 53 OF 225

 4.8 Operating System Upgrade Best Practices
When upgrading the Linux distribution (as may be required prior to a Cisco BroadWorks
version upgrade), Cisco recommends the following be considered:
◼ Reviewing release notes/documentation of the new OS version for performance
related features/functionality enabled as part of the new version. A review of
functionality whose defaults have changed between revisions should be closely noted.
◼ Having a lab system that replicates the production environment (OS distribution
version/Cisco BroadWorks release).
− Verifying the upgrade procedure on the lab system.
− Validating server performance characteristics are unchanged.
− Verifying the rollback/revert of the OS distribution components.
◼ Always performing OS distribution upgrades during a predetermined maintenance
window (during non-busy hours).
◼ Always doing the upgrade of the OS distribution in a different maintenance window
from the Cisco BroadWorks release upgrade.
◼ Upgrading the distribution on one instance of each server type before rolling out the
upgrade to the full Cisco BroadWorks complex is strongly suggested.
− “Soaking” at a minimum over one business day (during the heaviest call traffic) is
recommended.
◼ Verifying that any required distribution repositories for the upgrade/rollback are
available in the production environment.

4.9 Upgrade Best Practices

Successful upgrades are critical to the success of an operating company. As such, it is
expected that an upgrade is a very smooth and controlled process where the procedures
are automated and well tested. This is exactly what Cisco provides. However, even if this
is the case, each deployment is unique. A deployment is made unique by the deployment
model (a minimum set of servers versus all servers, non-IMS versus IMS, and so on), the
service offering (enterprise versus residential versus trunking, and so on), and even by
some of the basic corporate rules (firewall settings, network management requirements,
and so on).
Considering the criticality of an upgrade along with the uniqueness of each deployment, it
is very important for an operator to adhere to the following best practice
recommendations:
◼ The first thing to do is to run the Pre-Installation Validation tool. This tool, available
from Cisco, can be run ahead of time prior to the actual upgrade activity, such that
potential upgrade roadblocks can be addressed ahead of time. Make sure to use the
latest version of the tool for the release you are about to install.
◼ Always perform upgrades during a predetermined maintenance window (during non-
busy hours).
◼ Have a lab system that replicates the production environment, that is, the same server
mix, access devices, session border control (SBC), firewall, service profile, and so on,
and perform all upgrades on the lab system first.
◼ Get assistance from Cisco or at minimum, notify Cisco of any plan of major upgrades.
◼ Always get the latest installation patch from Cisco for a given release.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 54 OF 225

 ◼ Always get the latest Software Manager from Cisco and install it prior to starting the
upgrade process.
◼ Always download and install the latest patch bundle (not applicable to release-
independent versions of the software) prior to activating a new version of Cisco
BroadWorks.
◼ Always read the following documents (focusing on the Summary of Changes section)
during the upgrade planning phase:
– Cisco BroadWorks Method of Procedure
– Cisco BroadWorks Release Notes
– Cisco BroadWorks Maintenance Guide
– Cisco BroadWorks Server Security Guide
– Cisco BroadWorks System Engineering Guide
◼ Always upgrade one node at a time, that is, make sure that you never are in a
situation in which more than one node of a cluster is down at any given time.
In case of failure, if a recovery cannot be made, contact Cisco Support.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 55 OF 225

 5 Cisco BroadWorks Initial Installation Procedure

Installing Cisco BroadWorks involves the following major tasks:

◼ Install and Configure Operating System
◼ Install Linux 9
◼ Install Cisco BroadWorks
◼ Copy Cisco BroadWorks Software on Target Platform
◼ Install Software
◼ Additional Notes

5.1 Install and Configure Operating System

For each operating system (OS), the high-level procedure consists of the following steps:
◼ OS installation
◼ Disk mirroring configuration
◼ UFS logging
◼ Post-OS installation configuration
◼ Enable system activity reporting
◼ Modify security attributes
For the list of operating systems supported in Release 24.0, see section 4.7 Supported
Operating Systems.
The installation details of the latest Linux OS versions are presented in the next sections.

5.2 Install Linux 9

Prerequisites (for new installations)
◼ Red Hat Enterprise Linux Server 9.x (for 64-bit processors) installation DVDs
◼ Oracle Linux (OL) 9.x (for 64-bit processors) installation DVDs

NOTE 1: The Red Hat Enterprise Linux 9 (latest update available) is recommended for new
installations. However, Red Hat Enterprise Linux 7 is still supported with Cisco BroadWorks
Release 24.0. When updating a Cisco BroadWorks server running on Red Hat Enterprise Linux
7 to Release 24.0, a Red Hat upgrade is not required.

NOTE 2: Oracle Linux (OL) 9 (latest update available) is recommended for new installations.
However, Oracle Linux 7 is still supported with Cisco BroadWorks Release 24.0. When updating
a Cisco BroadWorks server running on Oracle Linux 7 to Release 24.0, an Oracle Linux upgrade
is not required.

The following sections describe the Linux configuration steps necessary to install Cisco
BroadWorks. An operator should proceed with the standard Linux installation and use the
configuration described in this section.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 56 OF 225

 NOTE: When installing the OS on a virtual host as part of a virtual configuration, see the Cisco
BroadWorks Virtualization Configuration Guide, as there are some steps specific to this
configuration.

5.2.1 Installation Options

Cisco BroadWorks requires the following Linux installation parameters to be selected. The
installation options are presented in the order in which the installation prompts them,
assuming the installation is performed using the graphical mode. Note that the disk
partitioning requirements are described in the following section.
Installation Option Required Setting for Cisco BroadWorks

Installation language English (United States).

Time & Date Configure time zone as required for the system being installed.

KEYBOARD English (US).

Language Support English (United States).

Installation Source Local media.

Software Selection Minimal Install.

Installation Destination Custom partitioning.

Kdump Enabled.

Network configuration Connect automatically.

Manual IPv4 and/or IPv6 configuration (IP address, network mask,
gateway, Domain Name Server [DNS], and not Dynamic Host
Configuration Protocol [DHCP]).

Root password Administrator root password.

NOTE: When installing the OS on a virtual host as part of a virtual configuration, the package
installation selection is different as the virtualization package is required. For more information,
see the Cisco BroadWorks Virtualization Configuration Guide.

5.2.2 Disk Partitioning Options

During the Linux installation, the custom partitioning option shall be used. The hardware
platform-independent disk partition scheme for Cisco BroadWorks Linux is described in
the following table.
Base partitions
These partitions are applicable to all options.

Partition Size

/boot 1GB

/boot/efi 200 MB
The EFI System Partition is required for UEFI-based platforms that no
longer use the legacy Master Boot Record (MBR) partition table.
Some UEFI firmware still supports “Legacy” boot mode that can be selected
instead.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 57 OF 225

 Base partitions
These partitions are applicable to all options.

Partition Size

swap 1.5 times the amount of RAM on the server up to a maximum of 8 GB.

Option 1: CIS partitions

This configuration matches the CIS partitioning requirements.

Partition Size

/home 1 GB

/tmp 1 GB

/var 5 GB

/var/log 1 GB

/var/log/audit 1 GB

/var/tmp 1 GB

/ 14 GB

/bw Remaining space on the disk

Option 2: Separate / partition

This configuration is used to isolate the OS installation from the Cisco BroadWorks application. Note
that the bwadmin home account ends up in the / partition.

Partition Size

/ 14 GB

/bw Remaining space on the disk

Option 3: A single / partition

This configuration simplifies the disk management.

Partition Size

/ The whole disk

NOTE 1: Given the number of variables involved, this level of partitioning granularity can more
readily lead to space exhaustion of these separate partitions that might require partition resizing.

NOTE 2: For Cisco BroadWorks Application Server platforms that can be equipped with more
than two disks or HS21 XM blades equipped with 8 GB flash drive, it is recommended to set up a
partition on a dedicated disk (mirroring recommended) or flash drive for the TimesTen database
log files (/persistentLogs). The size of this partition should be a minimum of 6 GB, but in practice
should be set to the space available on the entire disk. The install prompts the user to see
whether this partition is present. For more information, see Appendix D: Database Logging to
Different Disk on x86_64 Hardware.

NOTE 3: Cisco supports the optional use of Logical Volume Manager (LVM) to manage disks. If
used, the physical volumes should map to separate disks for the logical volumes that support the
/bw, / and /persistentLogs mount points respectively.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 58 OF 225

 NOTE 4: The Database Server swap requirements are slightly different and can be configured
with as much as 32 GB of swap space. For more information, see the Cisco BroadWorks
Database Server Configuration Guide.

NOTE 5: For all BroadWorks servers, the /bw partition must be mounted without using the
nodev, noexec, or the nosuid options.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 59 OF 225

 5.2.3 Installation Procedure
The installation steps are illustrated using Red Hat Enterprise Linux Server 9 screen shots.
However, the steps also apply to the OL 9 installation.
1) Insert the Red Hat Enterprise Linux installation media (DVD) and boot the server.

Figure 4 Boot Installation Media

2) When the Red Hat Enterprise Linux boot screen appears, press ENTER.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 60 OF 225

 Figure 5 Language Selection

3) On the language selection screen, select English (United States) as the language for
the installation process and then click Continue.

Figure 6 INSTALLATION SUMMARY

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 61 OF 225

 4) On the INSTALLATION SUMMARY screen, click TIME & DATE.

Figure 7 TIME & DATE

5) On the TIME & DATE screen, select the appropriate region and then click Done.
6) On the INSTALLATION SUMMARY screen, click SOFTWARE SELECTION.

Figure 8 SOFTWARE SELECTION

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 62 OF 225

 7) On the INSTALLATION SUMMARY screen, click INSTALLATION DESTINATION.

Figure 9 INSTALLATION DESTINATION

8) On the INSTALLATION DESTINATION screen, select the device(s) you want to install
to, select Custom, and then click Done.

Figure 10 Disk Partitioning – Deleting Existing Partitions

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 63 OF 225

 9) On the MANUAL PARTITIONING screen, click existing partition, click –, check Delete all
file systems which are only used by the Red Hat Enterprise Linux 9.1 for x86_64, and
then click Delete It.

Figure 11 Disk Partitioning – Creating Partitions

10) Create the necessary partitions. For more information, see the section on Linux disk
partitioning requirements in this guide. To add a partition, on the MANUAL
PARTITIONING screen, select partitioning schema Standard Partition, click +, and then
enter the required information in the dialog box that appears.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 64 OF 225

 Figure 12 Disk Partitioning – Confirm Changes

11) The installer prompts you to confirm your settings. Click Accept Changes to allow the
installer to partition the hard drive.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 65 OF 225

 Figure 13 NETWORK & HOST NAME – Configure

Figure 14 NETWORK & HOST NAME – General

12) On the NETWORK & HOST NAME screen, enter the host name, select the
connection (Ethernet enp0s3), and then click Configure. The Network Connections
dialog box appears.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 66 OF 225

 13) In the dialog box that appears, select the General tab, and then check Connect
automatically with priority.

Figure 15 NETWORK & HOST NAME – IPv4 Settings

14) To configure the IPv4 settings, select the IPv4 Settings tab and enter the following
information:
– From the Method drop-down menu, select Manual.
– Click Add. In the Addresses text box, enter the IP address, network mask, and
gateway address.
– Enter a comma-separated list of DNS servers in the DNS servers text box, and a
comma-separated list of domains in the Search domains text box for any domains
to include in name server lookups.
– Check Require IPv4 addressing for this connection to complete.
15) If required, configure IPv6 settings on the IPv6 Settings tab.
16) Click Save.
17) Close the Network Connections dialog box and click Done on the NETWORK &
HOST NAME screen.

NOTE: If bonding configuration is required, it can be performed once the operating system
installation has been completed.

18) On the INSTALLATION SUMMARY screen, click Root Password.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 67 OF 225

 Figure 16 INSTALLATION SUMMARY – Root Password

19) On the system administration password screen, enter and confirm the system
administration root password and then click Done.

Figure 17 System Administration Password

20) On the INSTALLATION SUMMARY screen, click Begin Installation.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 68 OF 225

 Figure 18 Begin Installation

21) When the installation is complete, eject the installation media, and then reboot the
server.
22) After the installation reboot, set the firewalld default zone to “trusted”:
[root@mtl64lin15 ~]# firewall-cmd --set-default-zone trusted

23) Set the SELINUX parameter to “permissive” or “disabled” in the file

/etc/sysconfig/selinux.

NOTE: The “permissive” mode is required for Center for Internet Security (CIS) compliance.

24) Reboot the server for the changes to take effect.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 69 OF 225

 5.2.4 Mirror Disks with RAID
Hardware RAID level 1 is supported by the x86_64 hardware recommended by Cisco.
Hardware RAID can be enabled on a server at boot time during the setup phase. Red Hat
Enterprise Linux does support HostRAID capability and it is transparent to an operator.
For the maintenance procedures related to Hardware RAID and for more information, see
the x86_64 hardware documentation for the specific server.

5.2.5 Configure Post-Linux Installation

Perform the following configuration steps on all server types unless otherwise specified:
◼ Latest Linux updates
◼ Disk logging
◼ /etc/hosts
◼ /etc/sysconfig/network
◼ IP multipathing
◼ Default router configuration
◼ Host name configuration (this step is not required on the Media Server)
◼ Network traffic security (this step is not required on the Media Server)
◼ Name resolution configuration
◼ Time zone configuration
◼ OS service configuration
◼ Additional software packages

NOTE: The steps may differ depending on the targeted server type.

[Link] Latest Linux Updates

After an installation, the first task to perform is to update Red Hat with the latest available
updates. To do this, you must first register your copy of Linux with the Red Hat network.
This is done by running the command subscription-manager register --auto-
attach as root. Once you are registered, you can run the dnf update command as root.
This command updates all installed packages.

NOTE 2: Running a Media Server on a hyper-threaded processor typically results in poor real-
time performance. This can be identified by reviewing the msRtpFramesSkipped statistic, which
would increase extremely slowly, if at all. It is highly recommended that you disable the hyper-
threading capabilities in the BIOS.

[Link] File System Logging

File system logging is part of the XFS file system used by Linux. To take advantage of this
feature, nothing should be enabled.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 70 OF 225

 [Link] /etc/hosts
The /etc/hosts file must be updated on the server as follows:
◼ Item “[Link]” must be removed.
◼ Item “loghost” may be added in /etc/hosts against the default hosts.
◼ In case where both IPv4 and IPv6 are supported, localhost must be added before
localhost6.
◼ The FQDN must be the first column for the interface and must map to the hostname.
The FQDN also must resolve to the same interface that the hostname.
Example (after Linux installation)
[root@mtl64lin15 ~]# more /etc/hosts
# Do not remove the following line, or various programs
# that require network functionality will fail.
[Link] [Link] localhost
[Link] [Link] mtl64lin15

Example (after required change)

[root@mtl64lin15 ~]# more /etc/hosts
# Do not remove the following line, or various programs
# that require network functionality will fail.
[Link] localhost
# For IPv6 uncomment the following line.
#::1 localhost6
[Link] [Link] mtl64lin15 loghost

[Link] /etc/sysconfig/network
Although this is generally taken care of by the OS installer, in some cases such as when
using prebaked OS images for virtualized cloud environment, the /etc/sysconfig/network
HOSTNAME field must be updated to the same hostname specified in the /etc/hosts file.
Example (after Linux installation)
[root@mtl64lin15 ~]# cat /etc/sysconfig/network
NETWORKING=yes
HOSTNAME=localhost

Example (after required change)

[root@mtl64lin15 ~]# cat /etc/sysconfig/network
NETWORKING=yes
HOSTNAME=[Link]

[Link] /etc/systemd/[Link]
Starting with Linux 7.0, journald is enabled and logs are stored in memory by default. To
force logs to be stored on disk, uncomment and set “Storage=persistent” in
/etc/systemd/[Link]. To activate the change, restart the systemd-journald service.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 71 OF 225

 [Link] IP Multipathing
Linux IP multipathing/bonding allows for binding multiple network interfaces into a single
channel/network interface card (NIC), using a special kernel module called bonding that
can provide networking fault tolerance. A bonded interface can operate in many modes.
Generally, using mode=1 active/standby mode is recommended where traffic is sent over
one NIC until that NIC is unavailable, in which case all traffic uses the other bond member.
A member (for example, a NIC) of the bonded interface is deemed unavailable in the
following cases:
◼ NIC card failure
◼ NIC card to switch communication failure (for example, cable pulled)
◼ Switch failure
Bonding does not detect any uplink failures, such as a switch losing its connectivity to the
rest of the network. Many switches support the uplink Link state tracking/monitoring, which
can be used to turn all ports down in case of an uplink failure, thus triggering bonding
failure detection. For information on enabling Link state tracking/monitoring if this
functionality is required, consult your switch vendor documentation.

NOTE: Applies to bonding service ONLY. Bonding should only be enabled on the system
where the secondary NIC (or switch module in the case of a Blade Center) is present.
Otherwise, major performance problems may be observed.

The following is an example of bonding configuration; however, other options and

configurations exist.
Using IP multipathing/bonding requires the following:
◼ Load the bonding module
◼ Define a bonding device
◼ Associate the NIC with a bonding device
◼ Disable ARP traffic between interfaces on different networks
◼ Enable bonding
Load the bonding module in the kernel with the modprobe command if it is not already
loaded, and verify with the modinfo command.
[root@mtl32lin10]# modprobe --first-time bonding
[root@mtl32lin10]# modinfo bonding

To define a bonding device, add a logical interface called “mybond0” of type bond with
name mybond0, bonding parameters (miimon 100, mode active-backup, primary enp0s3),
IP address [Link]/24, and gateway [Link], issue the following command.
[root@mtl32lin10]# nmcli con add type bond con-name mybond0 ifname
mybond0 miimon 100 mode active-backup primary enp0s3 ip4 [Link]/24
gw4 [Link]

This command has added a bond device and created ifcfg-mybond0 file in the
/etc/sysconfig/network-scripts directory with all necessary directives.
[root@mtl32lin10 network-scripts]# cat /etc/sysconfig/network-
scripts/ifcfg-mybond0
DEVICE=mybond0

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 72 OF 225

 NAME=mybond0
IPADDR=[Link]
PREFIX=24
ONBOOT=yes
BOOTPROTO=none
GATEWAY=[Link]
TYPE=Bond
BONDING_MASTER=yes
UUID=d164095e-ce89-41b0-b7fe-efca1410ba59
DEFROUTE=yes
IPV4_FAILURE_FATAL=no
IPV6INIT=yes
IPV6_AUTOCONF=yes
IPV6_DEFROUTE=yes
IPV6_PEERDNS=yes
IPV6_PEERROUTES=yes
IPV6_FAILURE_FATAL=no
BONDING_OPTS=”miimon=100 mode=active-backup primary=enp0s3”

It is possible to assign more than one IP address to a bonding device. The active NIC of
the bonding group then answers to both (or more) IP addresses. To achieve this, create a
config script named “ifcfg-mybond0:1” (ifcfg-mybond0:2, and so on for multiple addresses)
in the /etc/sysconfig/network-scripts/ directory.
[root@mtl32lin10 network-scripts]# cat /etc/sysconfig/network-
scripts/ifcfg-mybond0:1
IPADDR=[Link]
NETMASK=[Link]

To prevent packets from being sent over wrong interfaces/network, it is required to disable
ARP traffic between interfaces on different. This can be done by modifying the
/etc/[Link] file on the Linux server (assuming two NICs enp0s3 and enp0s8):
[Link].arp_ignore = 1
[Link].enp0s3.arp_ignore = 1
[Link].enp0s8.arp_ignore = 1

[Link].arp_announce = 2
[Link].enp0s3.arp_announce = 2
[Link].enp0s8.arp_announce = 2

For IPv6 only network, it is required to disable the IPv6 accept_ra functionality (accept
router advertisements) to prevent an additional IPv6 address from being assigned to the
bonding device by the router. This can be done by modifying the /etc/[Link] file on the
Linux server (assuming bonding device mybond0).
[Link]=0
[Link].mybond0.accept_ra=0

The two NICs, which are part of the same bonding device, must now be associated with it.
This is done by issuing the following two commands.
[root@mtl32lin10]# nmcli con add type bond-slave ifname enp0s3 master
mybond0
[root@mtl32lin10]# nmcli con add type bond-slave ifname enp0s8 master
mybond0

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 73 OF 225

 Note that as no con-name was given for the slaves, the name was derived from the
interface name by prepending the type. Two bond slave devices have been added with
two files ifcfg-bond-slave-enp0s3 and ifcfg-bond-slave-enp0s8 in the
/etc/sysconfig/network-scripts directory with all necessary directives.
[root@mtl32lin10 network-scripts]# cat /etc/sysconfig/network-
scripts/ifcfg-bond-slave-enp0s3
DEVICE=enp0s3
NAME=bond-slave-enp0s3
ONBOOT=yes
MASTER=mybond0
SLAVE=yes
TYPE=Ethernet
[root@mtl32lin10 network-scripts]# cat /etc/sysconfig/network-
scripts/ifcfg-bond-slave-enp0s8
DEVICE=enp0s8
NAME=bond-slave-enp0s8
ONBOOT=yes
MASTER=mybond0
SLAVE=yes
TYPE=Ethernet

To bring up a bond, the slaves must be brought up first, as follows.

[root@mtl32lin10]# nmcli con up bond-slave-enp0s3
onnection/14)
[root@mtl32lin10]# nmcli con up bond-slave-enp0s8
Connection successfully activated (D-Bus active path: /
[root@mtl32lin10]# nmcli con up mybond0
[root@mtl32lin10]# systemctl restart network

Use the ip command to view the status of the network configuration.

[root@mtl32lin10 ~]# ip link show
lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN mode
DEFAULT
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
enp0s3: <BROADCAST,MULTICAST,SLAVE,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast
master mybond0 state UP mode DEFAULT qlen 1000
link/ether 08:00:27:39:75:de brd ff:ff:ff:ff:ff:ff
enp0s8: <BROADCAST,MULTICAST,SLAVE,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast
master mybond0 state UP mode DEFAULT qlen 1000
link/ether 08:00:27:39:75:de brd ff:ff:ff:ff:ff:ff
mybond0: <BROADCAST,MULTICAST,MASTER,UP,LOWER_UP> mtu 1500 qdisc noqueue
state UP mode DEFAULT
link/ether 08:00:27:39:75:de brd ff:ff:ff:ff:ff:ff

[Link] Default Router Configuration

The default network gateway IP address is defined against each interface in
/etc/sysconfig/network-scripts/ifcfg-<interface> or against the bonding interface.
[root@mtl32lin10 network-scripts]# cat /etc/sysconfig/network-
scripts/ifcfg-bond0
DEVICE=bond0
NAME=bond0
IPADDR=[Link]
PREFIX=24
ONBOOT=yes
BOOTPROTO=none
GATEWAY=[Link]

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 74 OF 225

 TYPE=Bond
BONDING_MASTER=yes
UUID=d164095e-ce89-41b0-b7fe-efca1410ba59
DEFROUTE=yes
IPV4_FAILURE_FATAL=no
IPV6INIT=yes
IPV6_AUTOCONF=yes
IPV6_DEFROUTE=yes
IPV6_PEERDNS=yes
IPV6_PEERROUTES=yes
IPV6_FAILURE_FATAL=no

[Link] Netmask/Prefix Configuration

The netmask/prefix is defined against each interface in /etc/sysconfig/network-scripts/ifcfg-
<interface> or against the bonding interface.
[root@mtl32lin10 network-scripts]# cat /etc/sysconfig/network-
scripts/ifcfg-bond0
DEVICE=bond0
NAME=bond0
IPADDR=[Link]
PREFIX=24
ONBOOT=yes
BOOTPROTO=none
GATEWAY=[Link]
TYPE=Bond
BONDING_MASTER=yes
UUID=d164095e-ce89-41b0-b7fe-efca1410ba59
DEFROUTE=yes
IPV4_FAILURE_FATAL=no
IPV6INIT=yes
IPV6_AUTOCONF=yes
IPV6_DEFROUTE=yes
IPV6_PEERDNS=yes
IPV6_PEERROUTES=yes
IPV6_FAILURE_FATAL=no

[Link] Name Resolution Configuration

If the system provider has configured Domain Name Server (DNS) as part of the Linux
installation process, the following steps are required.
Create /etc/[Link] with the following content.
domain <your network domain name>
nameserver <IP address of primary DNS>
nameserver <IP address of secondary DNS>
options timeout:1 attempts:2 # reduce DNS timeout to 3 seconds

Verify and modify /etc/[Link] as required to include the following line:

hosts: files dns

[Link] Time Zone Configuration

To verify the time zone currently set on your server, run the clock command.
[root@mtl32lin10 America]# clock

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 75 OF 225

 Thu 25 Jun 2015 03:35:49 PM EDT -0.379744 seconds

To identify which time zone is closest to your present location, use the timedatectl
command with the list-timezones command line option. For example, to list all available
time zones in America, type:
[root@mtl32lin10]# timedatectl list-timezones | grep America
America/Adak
America/Anchorage
America/Anguilla
America/Antigua
America/Araguaina
America/Argentina/Buenos_Aires
…

To change the time zone to the most appropriate region, use the timedatectl command
with the set-timezones command line, and set the hardware clock by executing,
“/sbin/hwclock –systohc”. For example, to change the time zone to America/Los_Angeles,
type the following as root:
[root@mtl32lin10]# timedatectl set-timezone America/Los_Angeles
[root@mtl32lin10 America]# /sbin/hwclock --systohc
[root@mtl32lin10 America]# clock
Thu 25 Jun 2015 04:50:11 PM PDT -0.733611 seconds

[Link] Net-SNMP Configuration for IPv6

When the Cisco BroadWorks server is to be used in an IPv6-only network, some
additional configuration is required to enable Net-SNMP on the IPv6 interface.
1) Edit /etc/ snmp/[Link] and add the following content (in bold).
# Agent listening interface/address
agentaddress udp:161
agentaddress udp6:161

# [Link] source community

com2sec notConfigUser default public
com2sec6 notConfigUser default public

2) Once the change has been done, restart the Net-SNMP agent using the following
command.
service snmpd restart

3) In order to allow the Cisco BroadWorks SNMP agent to communicate with the Net-
SNMP agent, change all occurrences of localhost in the file
/usr/local/broadworks/bw_base/conf/[Link] to localhost6 (or equivalent).
<SNMP_PROXY>
<MASTER_AGENT>
<NAME>BroadWorks Master SNMP Agent</NAME>
<DESCRIPTION>Media Server Master SNMP Agent</DESCRIPTION>
<TRAP_LISTENING_PORT>20162</TRAP_LISTENING_PORT>
<STATUS>On</STATUS>
<CLI>MediaServer</CLI>
<OID>.[Link].4.1.6431.1.3</OID>
<MIB>/usr/local/broadworks/bw_base/conf/BW-
[Link]</MIB>

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 76 OF 225

 </MASTER_AGENT>
<SUB_AGENT>
<NAME>Net-Snmp</NAME>
<DESCRIPTION>Linux MIB-II sub agent</DESCRIPTION>
<HOST>localhost6</HOST>
<PORT>161</PORT>
<OID>.[Link].2.1</OID>
<CLI>Mib-II</CLI>
<STATUS>ON</STATUS>
<START></START>
<STOP></STOP>
…

[Link] Optimistic Duplicate Address Detection (DAD) Enabling for Bonding IPv6 Interface
When the Cisco BroadWorks server is to be used in an IPv6 network with bonding
interfaces, it is required to enable Optimistic Duplicate Address Detection. Optimistic DAD
provides optimizations to the IPv6 DAD process. It minimizes address configuration delays
in the successful case and reduces disruption as far as possible in the failure case.
Modern kernels have this feature disabled by default. To enable it, set optimistic_dad for
each required interface explicitly and then restart the network service. The following is an
example of enabling optimistic_dad on interface eth0.
[root@mtl32lin10]# echo "[Link].eth0.optimistic_dad=1" >>
/etc/[Link] ; sysctl -p /etc/[Link]
[root@mtl32lin10]# service network restart

[Link] CPU Frequency Scaling

For Cisco BroadWorks to function properly, the CPU frequency scaling governor must be
set to performance on the server. See your Operating System documentation on how to
set the CPU frequency scaling governor.
At installation of Cisco BroadWorks, the CPU frequency scaling governor is automatically
set to performance. A warning is displayed if the set operation fails.
When Cisco BroadWorks is started, it generates an SNMP trap of severity critical if the
CPU frequency scaling governor is not set to performance.

[Link] Transparent Huge Pages

For Cisco BroadWorks to function properly, Transparent Huge Pages must be disabled on
the server. See your Operating System documentation to disable Transparent Huge
Pages. Typically, adding the “transparent_hugepage=never” kernel configuration
parameter in the bootloader configuration file (grub) is sufficient.
At installation of Cisco BroadWorks, if Transparent Huge Pages is not disabled at boot
time (grub), a warning is displayed. If Transparent Huge Pages (THP) is disabled in the
boot configuration (grub), but is currently enabled (manually, for example) on the target
system for installation, the installation process will disable THP on the fly. A warning is
displayed if the disabling operation fails.
When Cisco BroadWorks is started, it generates an SNMP trap of severity high if
Transparent Huge Pages is not disabled.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 77 OF 225

 [Link] Additional Software Packages
For Cisco BroadWorks to function properly, some additional software packages must be
installed on the server. The required packages are listed in section [Link].3 Required
Third-Party Packages.
A package presence on a server can be tested using the rpm utility. To see the list of all
installed packages, use the rpm –qa command. To query a specific package, use rpm –qf
<packageName>.

NOTE: If any packages are missing, the installation of Cisco BroadWorks may not function
properly or may not work at all. You MUST install these packages prior to installing Cisco
BroadWorks.

There are two methods used to install the packages. The first is to use the packages
found on the installation CDs using the dnf package manager. The other is to use the
subscription-manager command and the dnf package manager. The following two
sections provide information on how to proceed with each of these methods.

[Link].1 Install Packages from DVD Installation Media

Follow the steps in this section to install the required software packages from the
installation DVD.
1) Insert the DVD into the system and make sure that the media is mounted (use the
mount /media/cdrom command if it is not automatically mounted).
2) Create a text file called [Link] in the /etc/[Link].d directory.
# vi /etc/[Link].d/[Link]

3) Add the following text to the file.

[redhatdvd]
name=Red Hat App Stack
baseurl=[Link]
enabled=1

4) Save the file and exit the editor.

5) Next, import the RPM Package Manager (RPM) public key and execute the dnf
package installation command with the list of required packages (for more information,
see section [Link].3 Required Third-Party Packages).
# rpm --import /media/cdrom/RPM-GPG-KEY-redhat-release

dnf install <list_of_packages>

NOTE 1: After installing the required third-party packages, it is recommended to run the
command dnf update to ensure the latest version of the packages is installed on the server. This
requires Internet access.

NOTE 2: If one of the required third-party packages cannot be found on the physical media, it is
in the online repository (see section [Link].2 Install Packages with subscription-manager
Utility).

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 78 OF 225

[Link].2 Install Packages with subscription-manager Utility
To install the required packages from the Red Hat customer portal, run the “subscription-
manager register” command to register your system, execute the “subscription-manager
list --available” command to determine the pool ID of a subscription that you require, the
pool ID is listed on a line beginning with Pool ID, attach the appropriate subscription to
your system by entering a command as follows: “subscription-manager attach --
pool=pool_id”, and then execute the dnf command with the list of required packages
(for more information, see section [Link].3 Required Third-Party Packages).
# subscription-manager register -–auto-attach
# subscription-manager list --available
# subscription-manager attach –-pool=pool_id

...

# dnf install <list_of_packages>

[Link].3 Required Third-Party Packages

This section provides the list of software packages that must be installed on Cisco
BroadWorks platform and the dnf commands used to install them. The packages are listed
in the order in which they must be installed.
Some packages must be installed on all servers. In addition, several more packages must
be installed on the Database Server, Network Function Manager, and Network Database
Server.
The following table lists the packages that must be installed on all servers.
Package Application

bash Bash

bind-utils bind-utils

chrony chrony

expect expect

firewalld firewalld

gawk gawk

gdb gdb

initscripts initscripts

iproute iproute

libaio aio lib

libgomp libgomp

libnsl libnsl

logrotate logrotate

lsof lsof

net-snmp snmpd

net-tools net-tools

openssh openssh

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 79 OF 225

 Package Application

openssl openssl

perl perl

perl-Getopt-Long Getopt::Long Perl module

psmisc psmisc

procps-ng procps-ng

rsync rsync

sssd sssd

stunnel stunnel

sudo sudo

sysstat sar

tar tar

unzip unzip

nss nss

ntpstat ntpstat

Use the following command to install those packages.

dnf install bash.x86_64 bind-utils.x86_64 chrony.x86_64 expect.x86_64
[Link] initscripts.x86_64 iproute.x86_64 libaio.i686
libaio.x86_64 libgomp.x86_64 libnsl.x86_64 logrotate.x86_64 lsof.x86_64
gawk.x86_64 net-snmp.x86_64 net-tools.x86_64 gdb.x86_64 openssh.x86_64
perl.x86_64 [Link] psmisc.x86_64 procps-ng.x86_64
openssl.x86_64 sssd.x86_64 stunnel.x86_64 sudo.x86_64 rsync.x86_64
sysstat.x86_64 tar.x86_64 unzip.x86_64 nss.x86_64 [Link]

It is also recommended to install the following additional packages (useful for

troubleshooting issues on the server).
Package Application

pcp-system-tools dstat

nmap nmap

tmux tmux
Use the
following command to install those packages.
dnf install nmap.x86_64 tmux.x86_64 pcp-system-tools.x86_64

For Database Server installation, the following additional packages are required.
Package Application

at Job spooling tools

1
compat-libstdc++-33 gcc libs

Bind-utils Bind-utils

expect expect

1
The 64-bit and the 32-bit versions must be installed.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 80 OF 225

 Package Application

bc An arbitrary precision calculator

language.

compat-libcap1 libcap

glibc1 gcc
1
glibc-devel gcc

kmod Linux kernel module management

utilities.

kmod-libs Libraries to handle kernel module

loading and unloading.

ksh Korn shell.

1
libaio aio lib

libaio-devel1 aio lib

libgcc1 gcc
1
libstdc++ gcc

libstdc++-devel gcc

libxcb Interface to X Window system protocol

libX11 X11 client-side library

libXau X11 authorization library

libXi X11 Input extension library

libXtst X11 Record extension library

make make

nfs-utils Kernel NFS server and related tools

perl-parent Establish an ISA relationship with base

classes at compile time.

perl-XML-Parser Perl module for parsing XML

documents.

perl-Env Perl module that imports environment

variables as scalars or arrays.

smartmontools Set of utility programs to control and

monitor computer storage systems.

sysstat sysstat

Use the following command to install the packages.

# dnf install bind-utils wget expect perl-Getopt-Long tar bc binutils
elfutils-libelf elfutils-libelf-devel fontconfig-devel glibc glibc-devel
ksh libaio libaio-devel libXrender libX11 libXau libXi libXtst libgcc
libnsl librdmacm libstdc++ libstdc++-devel libxcb libibverbs make
policycoreutils policycoreutils-python-utils smartmontools sysstat

NOTE: On Oracle Linux 7 and 8, the oracle-database-preinstall-19c package is also required.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 81 OF 225

 For Network Function Manager installation, the following additional packages are required.
Package Application

perl-DBI Perl DBI

perl-Digest-MD5 Perl Digest MD5

perl-Time-HiRes Perl time high resolution

zip Zip

libtool-ltdl Runtime libraries for GNU Libtool

Dynamic Module Loader

Use the following command to install the packages.

# dnf install perl-DBI.x86_64 perl-Digest-MD5.x86_64 perl-Time-
HiRes.x86_64 zip.x86_64 libtool-ltdl.x86_64

For Network Database Server and Messaging Server installation, the following additional
packages are required.
Package Application

perl-DBI Perl DBI

perl-Digest-MD5 Perl Digest MD5

perl-Time-HiRes Perl time high resolution

Use the following command to install the packages.

# dnf install perl-DBI.x86_64 perl-Digest-MD5.x86_64 perl-Time-
HiRes.x86_64

[Link].4 Enable System Activity Reporting

Linux can be configured to automatically collect historical system activity data, which can
be accessed using the sar command. Information collected includes the following:
◼ CPU use
◼ Buffer use
◼ Disk I/O transfers
◼ File access
◼ Paging
◼ Inter-process communications
◼ Queue manipulation
◼ System call activity
System activity reporting should be enabled on all Cisco BroadWorks servers to provide
the last 30-day historical view of system activity.
[Link].4.1 Activate System Activity Reporting
System activity reporting is enabled by default; however, it is performed every 10 minutes.
This needs to be changed so that it is performed every 5 minutes.
As root, perform the following steps to edit the OS sar confiruration.
# export SYSTEMD_EDITOR=/usr/bin/vi
# systemctl edit [Link]

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 82 OF 225

 Add this information to the configuration file and save the file.
[Unit]
Description=Run system activity accounting tool every 5 minute

[Timer]
OnCalendar=
OnCalendar=*:00/5

Reload the configuration and confirm it is active using these commands.

# systemctl daemon-reload
# systemctl cat [Link]
# systemctl status [Link]

[Link].4.2 View System Activity Report Results

System activity reporting can be viewed using the sar command.
To see current day processor usage on a server:
[root@mtl32lin10 sa]# sar
Linux 2.6.18-400.1.1.el5 ([Link]) 06/19/2015

02:38:17 PM CPU %user %nice %system %iowait %steal %idle

02:38:20 PM all 0.17 0.00 0.00 0.00 0.00 99.83
02:38:23 PM all 0.00 0.00 0.00 0.00 0.00 100.00
Average: all 0.08 0.00 0.00 0.00 0.00 99.92

For a detailed explanation of all sar options and fields, consult the Linux sar main pages.
For full performance readings (including swap usage and paging), use the sar –A option.
This is very useful when debugging performance issues.
$sar –A

You can look at the previous day’s performance by specifying the file you want to view.
$sar –f /var/log/sa/sa22

This command would provide the sar statistics for the twenty-second day of the month.

[Link] Swappiness
At installation of Cisco BroadWorks, the swappiness is automatically set to the
recommended value. Swappiness can be set to values between 0 and 100, inclusive. A
low value means the kernel will try to avoid swapping as much as possible where a higher
value instead will make the kernel aggressively try to use swap space. The recommended
value for Cisco BroadWorks is 10 except for the Network Database Server for which the
recommended swappiness value is 1.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 83 OF 225

 5.2.6 Move from Red Hat Enterprise Linux 5, 6, 7, or 8 to Red Hat Enterprise Linux 9
In Release 24.0, Linux 5 and Linux 6 are no longer supported on any Cisco BroadWorks
servers. As such, customers running Cisco BroadWorks on Linux 5 or Linux 6, need to
move to a later version. (Moving to Red Hat Enterprise Linux 9 is recommended).
Although Release 24.0 supports Red Hat Enterprise Linux 7 and 8, a customer may
decide to move existing Cisco BroadWorks servers to Red Hat Enterprise Linux 9.
The following table shows which Cisco BroadWorks release is supported on which version
of the operating system.
BroadWorks Linux Linux Linux Linux Linux
Release 5 6 7 8 9

21.0 X X

22.0 X X X

23.0 X X

24.0/2020.07+ X X

2023.05+ X X

2023.09+ X X X

In general, Red Hat does not support upgrades between major Linux releases and
indicates that a customer is more likely to have a consistent experience by backing up
their data and then re-installing Red Hat Enterprise Linux 9 over the previous Red Hat
Enterprise Linux installation. As such, Cisco strongly recommends following this Server
Rebuild approach.
The Server Rebuild approach consists of building a new server running Red Hat
Enterprise Linux 9, with the same networking configuration (for example, IP address, and
host name), Cisco BroadWorks release, and patch level as the server it is replacing. The
procedure for adding the new server to the network is covered in the Cisco BroadWorks
Maintenance Guide, Cisco BroadWorks Server Restoration section, with the exception
that in this case the new server is running a different OS version from the server it is
replacing.

5.2.7 Patch Linux

Cisco BroadWorks servers are not deployed as hardware appliances, and as such, the
customer is free to update the Linux OS following whatever OS update process they
currently follow for other Linux servers. A general recommendation would be to update all
packages/rpms at least once a year. This can be done running, as root, the dnf update
command. This command updates all installed packages (including the kernel package).

NOTE: Cisco supports kernel updates on all server types except for the Database Server. The
Database Server requires a third-party kernel module that must match the running kernel. For
more information, see the Cisco BroadWorks Database Server Configuration Guide.

To ensure there are no interactions with the Cisco BroadWorks application, a periodic
validation is performed of the latest operating systems rpms by updating them on every
Cisco BroadWorks server type and performing regression testing. The list of rpms with
version information and date of validation is provided in a text file available from Cisco.
Any adverse interactions between Cisco BroadWorks and the rpm update results in the
generation of a customer alert.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 84 OF 225

 NOTE: Before proceeding with Linux patching, ensure that Cisco BroadWorks is at the latest
patch level. While the periodic validation on the latest Linux updates is performed, issues can be
found and fixed through Cisco BroadWorks patches.

5.3 Install Cisco BroadWorks

Prerequisites
◼ The server is installed with recommended partitioning, operating system, and IP
networking configurations.
◼ Installation bin file and installation patch.
The steps required to install Cisco BroadWorks on a stand-alone server and on a
redundant server configuration are the same except that they must be done in a specific
order. The following steps cover both configurations.
1) Copy the Cisco BroadWorks software on the target platform.
2) Install the software. For redundant configuration, the primary server must be installed
first, and then the secondary server can be installed.
3) Perform post-installation activation. For redundant configuration, the post installation
activation must be done first on the primary server and then on the secondary server.
4) Start Cisco BroadWorks. For redundant configuration, Cisco BroadWorks must be
started first on the primary server and then on the secondary server.

NOTE 1: The Cisco BroadWorks installation expects to find the sudoer file in /etc/sudoer or in
/usr/local/etc/sudoer. If the file is not in one of the expected locations, the installation fails to
perform the necessary modifications, preventing the server from running.

NOTE 2: The Cisco BroadWorks installation expects the date and time to be properly set on the
server. The installation of some components fails if the date is set in the past.

5.4 Copy Cisco BroadWorks Software on Target Platform

Cisco BroadWorks can be delivered using either CD or software image.

5.4.1 Copy from CD

To install from a CD:
1) Insert the CD in the server CD drive.
2) Change directory to the install directory /cdrom/cdrom0/.
3) Change user to root.
# cd /cdrom/cdrom0
# ls
AS_Rel_22.0_1.[Link]-x86_64.bin
[Link]-x86_64.[Link]
# su
password: *****

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 85 OF 225

 5.4.2 Copy from Software Image
A software image is typically obtained from an FTP site. The installation procedure
consists of the following steps:
1) FTP the software image to a directory called /bw/install.
2) Make the software image executable.
3) Change user to root.
# cd /bw/install
# ls
AS_Rel_22.0_1.[Link]-x86_64.bin
[Link]-x86_64.[Link]
# chmod +x AS_Rel_22.0_1.[Link]-x86_64.bin
# su
password: *****

5.4.3 Verify Integrity of Software Image

Software image integrity can be verified by comparing the MD5 checksum of the software
with a reference provided by Cisco.
Run the md5sum tool against the software image.
Validate that the checksum matches the one in the Cisco BroadWorks md5sum file.
# md5sum AS_Rel_22.0_1.[Link]-x86_64.bin
9497bf1ad82bfda405756cb1b7a7afa7 AS_Rel_22.0_1.[Link]-x86_64.bin

# cat AS_Rel_22.0_1.[Link]-x86_64.md5sum
9497bf1ad82bfda405756cb1b7a7afa7 AS_Rel_22.0_1.[Link]-x86_64.bin

# md5sum [Link]-x86_64.[Link]
e6cce7dc5671b357601978c9b318d22c [Link]-
x86_64.[Link]

# cat [Link]-x86_64.tar.md5sum
e6cce7dc5671b357601978c9b318d22c [Link]-
x86_64.[Link]

NOTE 1: The administrator should not install Cisco BroadWorks software when the MD5
checksum of the software image and the reference provided with Cisco BroadWorks do not
match. It is recommended to re-try the software image download. If the problem persists, contact
Cisco Support.

NOTE 2: For the release-independent servers, there is no installation patch required for the
installation.

5.4.4 Verify the Signature of Software Image

Software built and released by Cisco is signed to ensure the validity and the source of the
file. If the software’s signature cannot be verified or if it is invalid, the software should not
be used and should be deleted immediately.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 86 OF 225

 The Software Manager has the responsibility to verify the signature of server installation
binaries and applications. To ensure the Software Manager to be installed on the server is
valid and properly enforces verification of the software signature, the certificate inside the
signature of the Software Manager is verified to make sure the signature is from Cisco. If
the certificate of signature is from Cisco, the Software Manager is verified against its
signature. If the Software Manager is valid, the Software Manager is installed. Using the
installed Software Manager, the server installation binary is validated and when successful
the server installation binary file is installed. The validation of the signature of applications
is automatically checked at installation time by Software Manager. The following are the
details of signature verification.

[Link] Verify the Certificate of Software Manager Signature

The operator verifies the certificate inside the Software Manager signature with the
following command. The subject entity identifies the certificate is from Cisco. The issuer
entity indicates the signing Certificate authority (CA) of Cisco certificate is from IdenTrust.
# openssl cms -verify -in swmanager_1037842.sig -inform der -cmsout -print
CMS_ContentInfo:
......
issuer: C=US, O=IdenTrust, CN=TrustID EV Code Signing CA 3
......
subject: C=US, ST=California, L=San
Jose/serialNumber=C4682478/jurisdictionC=US/jurisdictionST=California/b
usinessCategory=Private Organization, O=Cisco Systems Inc., OU=Cisco
Systems Inc., CN=Cisco Systems Inc.
......

[Link] Verify the Software Manager against Its Signature

The operator verifies the Software Manager against its signature with the following
command. If the Software Manager is valid, the installation can be executed.
# openssl cms -verify -noverify -binary -content swmanager_1037842.bin -in
swmanager_1037842.sig -inform der >/dev/null
Verification successful

The operator installs the Software Manager with the following command and makes sure
the installation is successful.
#./swmanager_1037842.bin

NOTE: When using sudo command to install Software Manager, the command is as follows:
$sudo bash –c ./swmanager_1037842.bin

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 87 OF 225

 [Link] Verify the Signature of Server Installation Binary
The operator verifies the signature of the server installation binary with the following
command as bwadmin user. If the server installation binary is valid, the installation can be
executed.
$ /usr/local/broadworks/swmanager/sbin/[Link]
ADP_Rel_2022.11_1.[Link]-x86_64.bin
Verifying...
Verified OK

[Link] Verify the Signature of Application

The signature of application is automatically verified at installation time by Software
Manager.

5.5 Install Software

The Cisco BroadWorks software installation is designed to support both non-interactive
and interactive modes. The Cisco BroadWorks installation is a self-extracting installation,
which, among other validations, validates the integrity of the software image. However, an
installation is aborted, for example, when the CD is corrupted or when the software image
only partially downloads. The locale configured and installed on the system is also
validated. When the locale is not properly installed or configured, the installation aborts. In
cases where the installation aborts because of the locale but the locale was properly
installed, the failure is due to the LANG environment variable not being set for the root
user. In this case, the LANG must be set manually prior to running the installation bin file
as follows:
# LANG=en_US
# export LANG

NOTE: Cisco BroadWorks Unix users’ locale must always remain set to en_US to ensure proper
monitoring and operation.

In both modes, an installation patch is required. Such a patch contains the latest fixes
required for a successful installation. The installation patch file is specified using the –
patch option. Following are examples on how to specify an installation patch file for both
modes.

NOTE: The latest Installation patch, downloaded from the Cisco, must be used for the
installation.

5.5.1 Non-interactive Installation

The non-interactive installation uses an installation configuration file. This file is typically
built by Cisco using information gathered from the customer site survey. In this case, the
operator must copy the configuration file to the server, along with the license files. It is
recommended that the operator create an install directory under /bw and copy information
to that directory.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 88 OF 225

 The operator invokes the installation bin file to start the installation. The operator must give
the name of the installation configuration file (full path) for the non-interactive installation to
work as follows:
# ./AS_Rel_22.0_1.[Link]-x86_64.bin –patch
/bw/install/[Link]-x86_64.[Link]
/bw/install/installation_hostxzy.conf

NOTE 1: The –patch option is mandatory and requires the full path of the patch file.

NOTE 2: For configuration file parameters, see Appendix C: Non-interactive Installation.

At this point, the installation:

◼ Verifies that the system is properly configured (based on operating system
requirements).
◼ Extracts the software image to directory /var/broadworks/<version>.
◼ Verifies that the installation configuration file is compatible with the server.
◼ Creates the BroadWorks administrator user account that is specified in the installation
configuration file. If the user account already exists, the installation automatically
resets the password to the specified value.
◼ Performs the installation.
◼ Applies the basic configuration (including licensing).

[Link] Post-installation Activation Steps

Once the installation is complete, the operator is asked to log out and log back in to the
system using the specified BroadWorks administrator user account.

NOTE: For Cisco BroadWorks redundant systems, prior to logging back into the system as
bwadmin, you must ensure that the secondary server is at the same installation state as the
primary server. This means that both the primary and secondary servers are at the point
whereby they are ready for post-installation. Some basic software components are required on
all nodes to allow the installation to automatically configure all nodes in the system.

The following installation steps are then required:

1) Configure Secure Shell (SSH) (if required).
2) Configure SSL key and certificate (if required).
3) User is prompted for the license files, if they were not copied during the installation.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 89 OF 225

 5.5.2 Interactive Installation
The interactive installation prompts the operator for some basic system configuration
attributes. To simplify this process, all configuration attributes are in one step.

[Link] Start Interactive Installation

The operator invokes the installation bin file to start the installation.
# ./AS_Rel_22.0_1.[Link]-x86_64.bin –patch
/bw/install/[Link]-x86_64.[Link]

NOTE: The –patch option is mandatory and it requires the full path of the patch file.

At this point, the installation process:

◼ Verifies that the system is properly configured (based on operating system
requirements).
◼ Copies the software image to the directory /var/broadworks/<version>.
◼ Prompts the operator for the target system configuration.
◼ Prompts the operator for the Cisco BroadWorks administrator username and
password. Creates the Cisco BroadWorks administrator user account. If the user
account already exists, the installation automatically resets the password to the
specified value.
◼ Performs the installation.
◼ Applies basic configuration, including licensing.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 90 OF 225

 [Link] Configure Cisco BroadWorks through Interactive Installation
This section provides a list of configurable attributes for Cisco BroadWorks. Note that not
all elements apply to all types of Cisco BroadWorks servers. The following table provides a
list of configurable attributes along with a server applicability matrix:
Configuration Applicable To
Steps
ADP AS MS NS Xsp PS DBS XS SCF NDS DTS

Cisco x x x x x x x x x x x
BroadWorks
user

Cisco x x x x x x x x x x x
BroadWorks
User password

System x x
administrator
User Name

System x x
administrator
Password

Times Ten x x x
Database User
Password

Maria DB x
schema user
password

Configure NTP x x x x x x x x x x x

Configure Cisco x x x x x x x x x x x
BroadWorks
license zip file

Configure x x
database pre-
defined size

External disk for x

database
logging

Configure x x x x
network
redundancy

Configure x
system domain

Configure x
server default
aliases

Configure x
Application
Server ID

Configure x x x x x x x x x x x
operating
system
hardening

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 91 OF 225

Configuration Applicable To
Steps
ADP AS MS NS Xsp PS DBS XS SCF NDS DTS

Configure Cisco x
BroadWorks
hardening

Configure x x
server in IMS
mode

Configure x
default dial
plans

Configure x
DATA

Configure FRA x

Oracle Unix x
user password

Oracle x
database
system
password

[Link].1 Cisco BroadWorks User Name

Specify the user name for the default Cisco BroadWorks administrator. The default is
bwadmin.
Please provide a BroadWorks username? [bwadmin]

[Link].2 Cisco BroadWorks User Password

Specify the user password for the default Cisco BroadWorks administrator.
Please provide a password for bwadmin:******
Confirm the password:******

[Link].3 System administrator User Name

Specify the user name for the default system administrator. The default is admin.
Please provide a BroadWorks username? [admin]

[Link].4 System administrator User Password

Specify the password for the default system administrator.
Please provide a password for admin:******
Confirm the password:******

[Link].5 Times Ten Database User Password

Specify the user password for the Times Ten User.
WARNING:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 92 OF 225

 *** TimesTen database user password MUST be the same on replicated
peers ***
Please provide a password for the TimesTen database user:**
Confirm the password:**

[Link].6 MariaDB schema User Password

Specify the user password for the Times Ten User.
Please provide a password for the MariaDB database user:*****
Confirm the password:*****

[Link].7 Configure NTP

Network Time Protocol (NTP) is used to synchronize the system clocks between servers.
An operator can choose one of the following:
◼ Do not configure NTP through the Cisco BroadWorks installation (enter “n”).
Do you want to configure NTP? (y/n) [y]? n

◼ Configure one of the Cisco BroadWorks servers as an NTP server.

Do you want to configure NTP? (y/n) [y]?
Is this server going to be a NTP server? (y/n) [n]? y

◼ Configure Cisco BroadWorks to use an external server.

Do you want to configure NTP? (y/n) [y]?
Is this server going to be a NTP server? (y/n) [n]?
What is the NTP address, hostname, or FQDN? [] x.x.x.x

NOTE: NTP must be configured to ensure proper functionality of data redundancy between
Cisco BroadWorks servers within a cluster.

[Link].8 LDAP
Cisco BroadWorks centralized administrator accounts functionality is based on UNIX
Lightweight Directory Access Protocol (LDAP) functionality. At installation time, LDAP
components are installed by default. The LDAP components are installed on the NFM and
can be configured from the NFM CLI. The LDAP client is installed on all servers. By
default, LDAP is only installed and not activated. The script and CLI configuration are
required to enable and activate LDAP for the centralized user.

[Link].9 Configure Cisco BroadWorks License zip File

The installation can be configured to automatically install the Cisco BroadWorks license
zip file. To do this, the Cisco BroadWorks license zip file must have been copied to the
Cisco BroadWorks server before using the install-broadworks command.
Do you wish to configure a license file (zip file path)? (y/n) [n]
What is the license file path?[] /export/home/bwadmin/[Link]

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 93 OF 225

[Link].10 Configure Database Pre-defined Size
Cisco BroadWorks allows an operator to configure the Database Store Name (DSN) and
Temp sizes.
Select the database DSN size....
Available DSN sizes in MB (128 256 512 1024) [512]
Available TEMP sizes in MB (64 128 170 256) [170]

NOTE 1: The DSN size (not counting the TEMP size) is calculated based on the amount of
RAM available on the server. For more information, see the Database Usage section of the
Cisco BroadWorks System Engineering Guide.

NOTE 2: The default TEMP size value corresponding to the selected DSN size should always
be selected.

[Link].11 External Disk for Database Logging

An external disk can be used to store the TimesTen log files for improved performance.
The installer has detected the presence of /persistentLogs.
Do you want to put the TimesTen log files in that disk? (y/n) [y]?

For more information, see Appendix D: Database Logging to Different Disk on x86_64
Hardware.

[Link].12 Configure Redundancy

Cisco BroadWorks allows an operator to configure redundant primary and secondary
servers.
If a redundant configuration is desired, simply enter “y” when prompted by Cisco
BroadWorks. The operator is then prompted for specific information with which to
configure the primary and secondary servers.
[Link].12.1 Application Server and Network Server Redundancy
[Link].12.1.1 Configure Primary Server

Data redundancy server settings:

Current server hostname is MTLAS04.
Primary server hostname is MTLAS04.
Currently configured peer(s) (list of hostname/address):
MTLAS04/MTLAS04 (primary)
Do you want to configure redundancy? (y/n) [y]?

Will this server be a member of a redundant cluster? (y/n) [y]?

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.

You must enter a list of hostname/address pairs identifying each peer.

The hostnames should be the servers' canonical hostname

(to know the canonical hostname of a server, type 'hostname'

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 94 OF 225

 at the command prompt). The hostname for the primary server
is retrieved automatically.

The addresses must be routable and will be used when configuring

replication. They can be hostnames, decimal dotted IP addresses,
or fully qualified domain names.

Note that it is possible to add a server to an existing cluster

without re-installing the existing servers. Please consult the
documentation.

What is the ADDRESS of THIS server? [MTLAS04]

Data redundancy server settings:
Current server hostname is MTLAS04.
Primary server hostname is MTLAS04.
Currently configured peer(s) (list of hostname/address):
MTLAS04/MTLAS04 (primary)

Enter an additional peer hostname (q to quit, c to clear the list):

MTLAS01
Enter peer address: MTLAS01

Enter an additional peer hostname (q to quit, c to clear the list): q

Please provide a TimesTen replication port [17888]

NOTE 1: When entering the peer host name and address, the host name used must be the one
corresponding to the server hostname entry found in the file /etc/hosts.

NOTE 2: The file /etc/hosts must contain all peer host names and addresses.

NOTE 3: The recommended TimesTen replication port is “17888”. However, it is possible to set
it to any value.

[Link].12.1.2 Configure Secondary Server

Do you want to configure redundancy? (y/n) [y]?

Will this server be a member of a redundant cluster? (y/n) [y]?

Is this server the primary peer (the first one installed) (y/n) [y]?n

This server is a secondary server. All that is needed to configure

redundancy is the routable address of the primary server.

What is the routable address of the PRIMARY server? [] MTLAS04

NOTE: The routable address of the primary server must correspond to the address entered on
the primary at the following question: What is the ADDRESS of THIS server? If the IP address
was entered, enter the IP address. Otherwise, use the hostname.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 95 OF 225

[Link].13 Configure System Domain
The default system domain for an Application Server can be specified at installation time.
Now select a system domain name. This will be used as the default
virtual domain used by the Application Server.

Enter the system domain [[Link]]:

[Link].14 Configure Application Server ID

The Application Server ID is used to handle service provider/enterprise ID and group ID
collisions that may occur when multiple Application Server clusters are used with the same
Enhanced Call Logs Repository. Every call log in the Enhanced Call Logs Repository is
tagged with the Application Server ID of the Application Server that created the call log. It
is also used by Meet-Me Conferencing when recordings are saved on the File Repository.
The value entered here is also accessible through the CLI (at the AS_CLI/
System/ApplicationServerId level).
Enter a unique name for the Application Server Id (Using the application
server's hosting NE name on the network server is highly recommended):

[Link].15 Hardening Recommendations

The operator is allowed to apply the Cisco hardening recommendations on the Application
Server.
Do you wish to apply all BroadSoft hardening recommendations? (y/n) [y]?

These recommendations are defined in the Cisco BroadWorks System Configuration

Guide.

[Link].16 Operating System Hardening Recommendations

The operator is allowed to apply the operating system hardening recommendations on all
Cisco BroadWorks servers.
Do you wish to apply all Operating System hardening recommendations?
(y/n) [y]?

[Link].17 Configure Server Default Aliases (Network Server Only)

Cisco BroadWorks allows an operator to define additional server aliases.
Do you wish to (re-)configure aliases for this server? (y/n) [y]?

Server alias list:

NONE

Select an action
1 - Add to the list
2 - Delete element from the list
3 - Quit

Selection ? 1
Enter an alias value, type quit to ignore: NetServer3

Server alias list:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 96 OF 225

 Alias
NetServer3

Select an action
1 - Add to the list
2 - Delete element from the list
3 - Quit

Selection ? 3

[Link].18 Configure Server in IMS Mode

The Application Server may or may not be deployed in IP Multimedia Subsystem (IMS)
mode. When the Application Server is deployed as part of an IMS, “yes” must be
answered to the following question:
Is this server deployed in IMS mode? (y/n) [n]?

The Network Server is rarely installed in IMS mode. For a regular IMS deployment with the
Network Server, the Network Server works as an adjunct to the Application Server and
should be installed in non-IMS mode.
In very rare circumstances, the Network Server may be installed in IMS mode (and the
useEnhancedNetworkTranslations property should be enabled on the Application Server).
In such a case, the Network Server works as an IMS Application Server performing the
redirect function for translations and routing.

[Link].19 Configure Basic Maintenance Tasks

Once a Cisco BroadWorks system is fully installed, the tasks can be viewed from the CLI
(at the CLI/Maintenance/Scheduler level). The operator is then able to add, delete, or
modify the attributes of a scheduled maintenance task.

[Link].20 Configure Default Dial Plans (Network Server Only)

The Cisco BroadWorks Network Server contains a list of country code-specific dial plans.
The installation can be configured to automatically install the default dial plan(s).
Do you wish to (re-)configure default dial plans for this server? (y/n)
[y]?

Dial plans to be automatically installed:

NONE

Select an action
1 - Add to the list
2 - Delete element from the list
3 - Quit
Selection ? 1
Select a dial plan
1 - Australian dial plan - Country Code(61)
2 - Japan dial plan - Country Code(81)
3 - North American dial plan - Country Code(1)
4 - Singapore dial plan - Country Code(65)
5 - Quit

Selection ? 3

Dial plans to be automatically installed:

DialPlan

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 97 OF 225

 North American dial plan - Country Code(1)

Select an action
1 - Add to the list
2 - Delete element from the list
3 - Quit
Selection ? 3

[Link] Post-installation Activation

NOTE: For Cisco BroadWorks redundant systems, before logging back in to the system as
bwadmin, you must ensure the secondary server is at the same installation state as the primary
server. This means that both primary and secondary servers are at the point whereby they are
ready for post-install activation. Some basic software components are required on all nodes to
allow the installation to automatically configure all nodes in the system.

Once the installation is complete, the server can be automatically rebooted. After the
reboot or even if a reboot is not required, you must log in as the previously specified
BroadWorks administrator user to complete the installation. Note for redundant
installations, this post-install step should be completed only after having installed Cisco
BroadWorks on all peers.
The installation is completed with the following steps:
1) Configure SSH (if required).
2) Configure SSL key and certificate (if required).
3) Prompted for license files, if they were not copied during installation.
4) Cisco BroadWorks is ready for operation.

[Link] Start Cisco BroadWorks

Cisco BroadWorks can be started from the Cisco BroadWorks CLI under the
/Maintenance/ManagedObjects level.
CLI> maintenance; managedobject
CLI/Maintenance/ManagedObjects> start

Monitoring the state of the Cisco BroadWorks server is also done from the CLI under the
same level.
AS_CLI/Maintenance/ManagedObjects> get broadworks
BroadWorks Managed Objects
==========================

* Server:
Identity..............: AS
Version...............: Rel_22.0_1.1123
Administrative State..: Unlocked

* Applications:
Name Version Deployed Administrative State
Effective State
=========================================================================
==============
ExecutionAndProvisioning 22.0_1.1123 true Unlocked
Unlocking

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 98 OF 225

 FlashPolicy 22.0_1.1123 true Unlocked
Stopped
OpenClientServer 22.0_1.1123 true Unlocked
Stopped
WebContainer 22.0_1.1123 true Unlocked
Unlocked

4 entries found.

* Hosted Applications:
Name Version Context Path Deployed
================================================================
CommPilot 22.0_1.1123 / true
DeviceManagementFiles 22.0_1.1123 /DeviceManagement true
JWSFiles 22.0_1.1123 /FileRepos true
MediaFiles 22.0_1.1123 /media true
OCIFiles 22.0_1.1123 /ocifiles true
OCIOverSoap 22.0_1.1123 /webservice true

6 entries found.

During the start-up phase, the server automatically transfers from the administrative state
Locked to Starting to Unlocked. Once the server reaches the Unlocked state, it is ready for
operation.

[Link] Installation Sanity Checks

The healthmon tool should always be run following an installation of a Cisco BroadWorks
server.
For non-redundant installations, the tool should not report any errors, and all processes on
the system should be up and running. Follow the recommendations when failures are
detected.
MTLAS05$ healthmon -l
Partition monitoring [....................]
BroadWorks monitoring [....................]
...
--------------------------------
System Health Report Page
BroadWorks Server Name : MTLAS05
Date and time : Thu Jun 18 17:52:12 EDT 2015
Report severity : NOTIFICATION
Upgrade check severity : NOTIFICATION
Server type : AppServer
Server state : Unlock
--------------------------------

No abnormal condition detected.

When installing the secondary server in a redundant configuration, the tool should not
report any errors, and all processes on the system should be up and running. Follow the
recommendations when failures are detected.
bwadmin@mtl64lin04$ healthmon -l
Partition monitoring [....................]
BroadWorks monitoring [....................]
...
--------------------------------
System Health Report Page
BroadWorks Server Name : mtl64lin04
Date and time : Thu Jun 18 17:52:12 EDT 2015

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 99 OF 225

 Report severity : NOTIFICATION
Upgrade check severity : NOTIFICATION
Server type : AppServer
Server state : Unlock
--------------------------------

No abnormal condition detected.

5.6 Additional Notes

5.6.1 bwadmin Account Management

The bwadmin user account is the basic account used to manage the Cisco BroadWorks
application. As stated in the details of the procedure, this is done to provide the installation
with full authority over the account, thus providing full automation capability. However, this
rule does not apply to upgrades. For more information on user accounts, see the Cisco
BroadWorks UNIX User Account Configuration Guide.

5.6.2 Installation Log Files

Installation logs can be very useful for troubleshooting malfunctioning systems. The
following is the list of files that are generated during a BroadWorks installation:
◼ /var/broadworks/logs/installation/[Link]: Log of the
session that is sent to the operator standard output.
◼ /var/broadworks/logs/installation/[Link]: High-level
view of installation steps executed during the installation.
◼ /var/broadworks/logs/installation/[Link]: List of
warnings generated during the installation of Cisco BroadWorks. Warnings are copied
into a separate file providing easy access following an installation.

5.6.3 Configuration files for log rotation

The configuration file for log rotation is modified and new configuration files are added
during the installation of BroadWorks. On all servers, new entries are added into
/etc/[Link] for log files [Link] and [Link]. Each log file entry's attributes
specifies the size per logging file of 10Mb, and the number of file rotation (5).

For the Network Function Manager, additional entries are also added into
/etc/[Link] for log files [Link] (Cyrus SASL) and [Link] (OpenLDAP). These
attributes specify the size per logging file of 10Mb, and the number of file rotation (5).

For the Network Function Manager and the Network Database Server, log rotation entries
are also created in /etc/logrotate.d/mariadb for log files [Link] and [Link].
These log files have a daily rotation and are kept for 30 days.

For the Media Server Diagnostics interface (used by Prometheus), log rotation entries are
also created in /etc/logrotate.d/diagnostic for log files [Link] and [Link].
These log files have a daily rotation and are kept for 30 days.

5.6.4 Linux Updates

It is recommended to keep your OS up to date by performing Linux updates (dnf update).
It is possible while performing the updates that some files altered during the Cisco
BroadWorks installation, may be reverted to their original state. In some cases, this may
lead to breaking some of the Cisco BroadWorks behavior.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 100 OF 225

 5.6.5 Enable TimesTen SNMP Traps Reporting
It is possible to enable SNMP traps reporting from the TimesTen subagent and proxy
them through the Cisco BroadWorks SNMP agent to all configured monitoring managers.

NOTE: This procedure requires “super user” privileges and causes downtime.

1) As user with BroadWorks administrator role, stop the Cisco BroadWorks SNMP
agent.
snmpdctl stop

2) As root, stop the TimesTen daemon.

/etc/init.d/tt_daemon stop

3) As user with BroadWorks administrator role, edit the

/usr/local/broadworks/bw_base/conf/[Link] file:
a. Inside the MASTER_AGENT tag, note the value of the
TRAP_LISTENING_PORT. This port value is where the TimesTen subagent
must send its traps to be proxied by the Cisco BroadWorks SNMP agent.
b. Add the following block right before the final closing SNMP_PROXY tag.
<SUB_AGENT>
<NAME>TimesTen</NAME>
<DESCRIPTION>TimesTen SubAgent</DESCRIPTION>
<HOST></HOST>
<PORT></PORT>
<OID>[Link].4.1.5549</OID>
<CLI>TimesTen</CLI>
<STATUS>ON</STATUS>
<START></START>
<STOP></STOP>
<MIB>/usr/local/broadworks/bw_base/conf/[Link]</MIB>
<COMMUNITY>public</COMMUNITY>
<CLI_VISIBLE>False</CLI_VISIBLE>
</SUB_AGENT>

4) As root, create and/or edit the /var/TimesTen/[Link] file to configure the TimesTen
SNMP subagent. The -trapport value should be the value found in step 3a.
#---- [Link] file start ----
# Enable SNMP trap generation
-enabled 1

# By default, community is "public"

-community "public"

# Default trap destination is "localhost" and default

# destination SNMP trap port is 20162 for BroadWorks SNMP
# agent.
-trapdest "localhost"
-trapport 20162
#---- [Link] file end ----

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 101 OF 225

 5) As root, restart the TimesTen daemon.
/etc/init.d/tt_daemon start

6) As user with BroadWorks administrator role, start the Cisco BroadWorks SNMP
agent.
snmpdctl start

5.6.6 Time Zone/Daylight Saving Time Version in JRE Software

Cisco BroadWorks servers are Java technology-based applications, which, in general,
must know the exact time in a given location. Since Time Zone (TZ) and Daylight Saving
Time (DST) policies are set by national and regional governments, they can change at any
time. It is important to ensure that the Java Runtime Environment (JRE) software that
comes packaged with the Cisco BroadWorks software contains the required TZ and DST
information for your operating region.
Since TZ and DST policies can change after a new Cisco BroadWorks version is
released, it is the customer’s responsibility to ensure the installed version contains all
relevant TZ and DST information.
The Cisco BroadWorks active JRE software version can be obtained from the operating
system (OS) prompt by running:
$ java –version
java version "1.7.0_21"
Java(TM) SE Runtime Environment (build 1.7.0_21-b11)
Java HotSpot(TM) 64-Bit Server VM (build 23.21-b01, mixed mode)

This JRE version would be JRE 7u21. This information can be compared to the
information at [Link]
[Link], which shows the TZ/DST data changes that are included in different JRE
software versions.
If any required TZ/DST data is missing in the Cisco BroadWorks-installed JRE version, the
JRE TZ/DST data should be updated by running the tzupdater tool. Tool download and
instructions can be found at [Link]
[Link].

5.6.7 Configure Net-SNMP Subagent to Listen to IPv6 Address on Linux

On Linux servers, the Net-SNMP subagent only listens on IPv4 addresses by default. To
configure Net-SNMP subagent to listen on IPv6 address, the following lines must be
added to the Net-SNMP configuration file /etc/snmp/[Link]. Note that the lines to be
added are shown in bold. The Net-SNMP subagent must be restarted (service snmpd
restart) for these changes to take effect.
agentaddress udp:161
agentaddress udp6:161

# [Link] source community

com2sec notConfigUser default public
com2sec6 notConfigUser default public

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 102 OF 225

 5.6.8 Configure SNMP Community String
The SNMP Community String, configured for the Net-SNMP subagent within the
/etc/snmp/[Link] configuration file, must be identical to the value set in the
[Link] file, located in the /usr/local/broadworks/bw_base/conf/ directory. This
is a requirement for the proper functioning of the system, ensuring effective
communication between the BroadWorks SNMP Agent and the Net-SNMP sub-agent.
Therefore, it is crucial to have matching Community String values in both configuration
files. By default, the SNMP Community String is set as "public".
Here is an excerpt from /etc/snmp/[Link]:
agentaddress udp:161
agentaddress udp6:161

# [Link] source community

com2sec notConfigUser default public
com2sec6 notConfigUser default public

Here is an example of /usr/local/broadworks/bw_base/conf/[Link]:

<SNMP_PROXY>
<MASTER_AGENT>
<NAME>BroadWorks Master SNMP Agent</NAME>
<DESCRIPTION>Configuration MIB</DESCRIPTION>
<TRAP_LISTENING_PORT>20162</TRAP_LISTENING_PORT>
<STATUS>On</STATUS>
<CLI>ConfigurationManagement</CLI>
<OID>.[Link].4.1.6431.1.1.5</OID>

<MIB>/usr/local/broadworks/bw_base/conf/[Link]</MIB>
<CLI_VISIBLE>True</CLI_VISIBLE>
</MASTER_AGENT>
<SUB_AGENT>
<NAME>Net-Snmp</NAME>
<DESCRIPTION>Linux MIB-II sub agent</DESCRIPTION>
<HOST>localhost</HOST>
<PORT>161</PORT>
<OID>.[Link].2.1</OID>
<CLI>Mib-II</CLI>
<STATUS>ON</STATUS>
<START></START>
<STOP></STOP>
<MIB>/usr/local/broadworks/bw_base/conf/[Link]</MIB>
<COMMUNITY>public</COMMUNITY>
<CLI_VISIBLE>True</CLI_VISIBLE>
</SUB_AGENT>
<SUB_AGENT>
<NAME>Net-Snmp-Ucd</NAME>
<DESCRIPTION>Linux UCD-SNMP sub agent</DESCRIPTION>
<HOST>localhost</HOST>
<PORT>161</PORT>
<OID>.[Link].4.1.2021</OID>
<CLI>UCD-SNMP</CLI>
<STATUS>ON</STATUS>
<START></START>
<STOP></STOP>
<MIB>/usr/local/broadworks/bw_base/conf/[Link]</MIB>
<COMMUNITY>public</COMMUNITY>
<CLI_VISIBLE>True</CLI_VISIBLE>
</SUB_AGENT>
<SUB_AGENT>

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 103 OF 225

 <NAME>HostRessources</NAME>
<DESCRIPTION>Linux HOST-RESSOURCES sub agent</DESCRIPTION>
<HOST>localhost</HOST>
<PORT>161</PORT>
<OID>.[Link].2.1.25</OID>
<CLI>HostRessources</CLI>
<STATUS>ON</STATUS>
<START></START>
<STOP></STOP>
<MIB>/usr/local/broadworks/bw_base/conf/HOST-RESOURCES-
[Link]</MIB>
<COMMUNITY>public</COMMUNITY>
<CLI_VISIBLE>True</CLI_VISIBLE>
</SUB_AGENT>
</SNMP_PROXY>

5.6.9 Automatically Send Tech-Support Output to Cisco

If needed, the output of the tech-support script can be automatically sent to Cisco by
email. This is configured in [Link] under /usr/local/broadworks/bw_base/conf. The
tech-support script reads this configuration file and sends the tech-support output file, if
enabled. Note that the option –dailyDump of tech-support must be used.
Following are the global parameters that must be set in [Link] to send the email.

Parameter Mandatory Default Value Description

mailserver No Mail server addresses Mail server to send the email. It

is only required if your
organization requires mail to
traverse an internal server
before leaving your network.

A techsupport configuration entry is then needed with the following parameters.

Parameter Mandatory Default Value Description

enabled Yes No default value Enable or disable sending an e-

mail for tech-support output.

to No autotechsupport@[Link] Destination. The destination list

must include
autotechsupport@[Link].

from No techsupport@[Link] Sender. The sender must be

techsupport@[Link].

subject No BroadWorks Server Tech- It must be “BroadWorks Server

Support Tech-Support”.

body No Tech-Support is attached. Text included in the e-mail. No

restriction.

attachment No Daily output file from tech- Any files can be attached to the
support e-mail.

Some fields can have more than one value. To add a value, replicate the tag as follows.
<to>autotechsupport@[Link]</to>
<to>secondaddress@[Link]</to>

The following example sends the tech-support information using all the default values.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 104 OF 225

 <techsupport enable="true">
</techsupport>

5.6.10 Core File Size and Number of Open File Descriptors Limits
At installation of Cisco BroadWorks,
• the maximum core file size is set to 8388608 KB (8 GB) for all server types except
the Media Server for which it is set to unlimited.
• the maximum number of open file descriptors is set to 64000 for all server types
except the Application Delivery Platform and Xtended Services Platform for which
it is set to 150000.

5.6.11 Known Limitations

There are no known limitations.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 105 OF 225

 6 Cisco BroadWorks Upgrade Procedure

Prerequisites:
◼ The server has an installed and configured version of a Cisco BroadWorks server.
◼ /usr/local/broadworks/bw_base UNIX soft link must exist and be defined to point to the
Cisco BroadWorks software version from which to upgrade.
◼ To determine the required patch level of the Cisco BroadWorks software version from
which to upgrade, consult the release notes of the target software version.

6.1 Pre-upgrade Steps

6.1.1 Pre-installation Validation Tool

This self-extractable tool can be executed ahead of time prior to the actual upgrade
activity, such that potential upgrade roadblocks can be addressed ahead of time. It is
available from Cisco Download.
Launch the tool using the following command.
./bw-preInstallCheck-Rel_<year>-<version>.bin

During execution, the tool generates log output to the screen and into a file available at the
following location.
/var/broadworks/logs/installation/pre_install_check.[Link]

Once the validation is completed, the results are printed as follows (in the case of a
successful validation).
#########################################################################
RESULTS

Pre-Install check validation SUCCESSFUL

NOTE: Upgrade will be allowed to the following destination releases:

2023
2024

NOTE: Don't forget to install the latest SWManager

#########################################################################

After a successful validation, the actual upgrade can be performed. However, particular
attention must be paid to notes, especially the list of allowed destination releases for
upgrade. Upgrade attempt to an invalid destination release is rejected at installation time.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 106 OF 225

 In the event of a failed validation, error(s) must be corrected prior to performing the actual
upgrade. The tool must be re-executed until all errors are fixed. The following is an
example of the results of a non-successful validation.
#########################################################################
RESULTS

Pre-Install check validation FAILED

The following error(s) MUST be fixed prior to perform upgrade:

FAIL=>A BroadWorks version must be installed to run the Pre-Install Check
script.
SOLUTION=>Perform a fresh install.
FAIL=>There is no BWORKS user with ssh configured on this server.
SOLUTION=>Run config-ssh for a valid BWORKS user

#########################################################################

NOTE: Remember that if the pre-installation validation tool fails, then it is impossible to perform
a successful upgrade.

6.1.2 Time Zone/Daylight Saving Time Version in JRE Software

For information on how to check and update the time zone and daylight saving time for the
JRE, see section 5.6.6 Time Zone/Daylight Saving Time Version in JRE Software.

6.1.3 Disk Space and DSN Requirements

It is important to have enough disk space available prior to starting the Cisco BroadWorks
installation. During the upgrade, disk space is checked during the following phases:
◼ Software Installation Phase: The self-extracting installer provided by Cisco checks
for available disk space, which is required to perform the installation. When there is
not enough space, the installer stops immediately and asks the operator to free up
disk space. The disk space required depends on the server type being installed and is
typically less than 2 GB.
◼ Software Activation Phase: When software is activated on an Application Server or
Network Server, additional validation is performed to verify that there is enough space
to hold temporary data, which is required when migrating the TimesTen database
between two releases of Cisco BroadWorks. The required temporary disk space for
the Application Server and Network Server is equal to twice the DSN size as defined
in the /var/TimesTen/[Link] file. For example, 2 GB of free disk space is required
to upgrade a DSN with a size of 1 GB.
In addition, for the Application Server and Network Server, the DSN permanent size in use
must be below 90 percent of the allocated permanent size before the upgrade.

6.1.4 YUM Requirements

New BroadWorks releases often require the installation of OS level packages. For this to
happen all servers need be able to install packages required by the installer via YUM. If
YUM is not allowed to access the internet to retrieve the suitable packages, OS level
packages must be installed manually.

6.1.5 Pre-upgrade Sanity Checks

See section 6.11.2 - Upgrade Sanity Checks.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 107 OF 225

 6.1.6 Backup your server
Prior to any server upgrade, it is recommended to take a backup and log a tech-support
from prior to upgrade.

6.2 Procedural Steps

The steps required to upgrade Cisco BroadWorks on a stand-alone server and on a
redundant server configuration are the same and they must be done in a specific order.
The following steps cover both configurations.
1) Copy the Cisco BroadWorks software on the target platform.
2) Install the software.
3) Perform post installation steps.
4) Configure registration extension (Application Server only).
5) Activate the new Cisco BroadWorks version. For redundant configuration, the primary
server must be activated first followed by the secondary servers.
6) Restore registration extension (Application Server only).
7) Localize the server (Application Server only).

6.3 Copy Cisco BroadWorks Software on Target Platform

6.3.1 Obtain Software Image from Cisco Download

Along with the software image (.bin), also download the associated MD5 (.md5sum) file.

6.3.2 Verify Integrity of Software Image

Software image integrity can be verified by comparing the MD5 checksum of the software
with a reference provided by Cisco.
1) Run the md5sum tool against the software image.
2) Validate that the checksum matches the one in the Cisco BroadWorks md5sum file.
# md5sum NS_Rel_2023.12_1.[Link]-x86_64.bin
4a45433e5acfb1b5280382a8af2799e2 NS_Rel_2023.12_1.[Link]-x86_64.bin

# cat NS_Rel_2023.12_1.[Link]-x86_64.md5sum
4a45433e5acfb1b5280382a8af2799e2 NS_Rel_2023.12_1.[Link]-x86_64.bin

NOTE 1: The administrator should not install Cisco BroadWorks software when the MD5
checksum of the software image and the reference provided with Cisco BroadWorks do not
match. It is recommended to re-try the software image download. If the problem persists, contact
Cisco Support.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 108 OF 225

 6.4 Install Cisco BroadWorks Software

NOTE 1: The procedure documented in this section has no impact on the already installed and
running Cisco BroadWorks version. The currently running version does not need to be stopped.

NOTE 2: For a system upgrade, it is recommended to perform the procedure documented in

this section on all your Cisco BroadWorks servers before activating the new software version.

Execute the installation bin file to start the installation.

# ./NS_Rel_2023.12_1.[Link]-x86_64.bin

At this point, the installation:

◼ Verifies that the system is properly configured (based on operating system
requirements).
◼ Copies the software image to directory /var/broadworks/<version>.
◼ Recognizes that the system is being upgraded.
◼ Performs the installation.
◼ Applies basic configuration (including licensing).
Repeat for all servers in the cluster.

6.4.1 Impact on the Software Manager

The Software Manager provides control over the Cisco BroadWorks Software: it allows
activating applications and server software.
Installing BroadWorks includes updating the Software Manager to the version that is
bundled with the software image. For the latest version of the Software Manager, see the
Cisco download web site.
For more information on the Software Manager and on how to perform its upgrade, see
section 8.9 Upgrade Cisco BroadWorks Software Manager.

6.5 Post-installation Steps

6.5.1 New License Installation

Once the installation of the new software version is complete and prior to the upgrade, the
existing license files may have to be replaced with new ones.

NOTE: New license files are typically required when upgrading between two major releases of
Cisco BroadWorks.

The following shows two ways of installing new license files. Both are equivalent.
Manual installation of new license files
If required, the following warning is given at the end of the installation:
+++WARNING --- 1001 <You may have to install new license files>

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 109 OF 225

 Sample manual license installation:
bwadmin@ns01$ cd /usr/local/broadworks/NS_Rel_2023.12_1.230/bin/
bwadmin@ns01$ ./[Link] /bw/install/R2023_licenses.zip
Done.
bwadmin@ns01$

NOTE: This is the method to use when performing an upgrade from Xtended Services
Platform/Profile Server (XSP/PS) to the Application Delivery Platform (ADP).

Another manual approach to install license files

Follow these steps:
1) Go to the CLI CLI/System/Licensing/LicenseManager/LicenseStore> level.
2) Import the license.
CLI/System/Licensing/LicenseManager/LicenseStore> import
/bw/install/R2023_license.zip
Done.

NOTE: This method does not work when performing an upgrade from Xtended Services
Platform/Profile Server (XSP/PS) to the Application Delivery Platform (ADP).

6.5.2 Upgrade Check

Before activating the new software, it is recommended to perform an upgrade check to
ensure the server is in a state where the upgrade succeeds. This check is done through
the CLI using the command upgradeCheck found under Maintenance/Tool. The following
is an example of the output for an upgradeCheck.
NS_CLI/Maintenance/Tools> upgradeCheck NS_Rel_2023.12_1.230
Executing from /usr/local/broadworks/bw_base/bin/[Link].
Executing from
/usr/local/broadworks/NS_Rel_2023.12_1.230/bin/[Link].

This is a dry-run upgrade.

2023.12.12 11:42:52:232 EDT

Event: Log Start

Host: ns01
Filename: [Link].2023.12_1.230.20231212_114252.log
BW Version: 2023.12_1.230

[Message] BroadWorks SW Manager checking NS server version

2023.12_1.230...

BroadWorks SW Manager checking NS server version 2023.12_1.230...

Checking license file information
Checking configuration file presences
Checking [Link] file
Checking version presences
Checking Broadworks version dependencies
Checking target Broadworks version present
Checking for available disk space

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 110 OF 225

 Space required = 1024 Mb
[done]
Checking System configuration
BW Daemon configuration validation
testing /etc/xinetd.d... [done]
Validating MoDaemon
Checking upgrade compatibility
Checking for dangling softlink
Running /usr/local/broadworks/NS_Rel_2023.12_1.230/bin/preUpgradeCheck

####### Startup Parameters IP Addresses Check START #######

####### Startup Parameters IP Addresses Check END #######

####### Device Username check for duplicate START #######

No need to check for duplicate device username.

Upgrading from release 22 or later

####### Device Username check for duplicate END #######

####### Database Manual Connections START #######

No manual database connections detected..

####### Database Manual Connections END #######

####### /etc/hosts Validation START #######

The file /etc/hosts contains an entry for ns01
####### /etc/hosts Validation END #######
Waiting for maintenance tasks to complete if any
Checking sshd configuration
Checking for critical patches
Checking for feature patches conformity between source and target
version
Checking TimesTen permanent memory size
Checking version of active TimesTen

####### Database Impacts Check START #######

No database impacts detected: datastore will not be unloaded,

replication will not be restarted, database will not be imported on non-
primary nodes.

####### Database Impacts Check END #######

Validating snmpd status
setactiveserver command successfully executed.

Dry-run upgrade completed.

NS_CLI/Maintenance/Tools>

6.6 Configure Registration Extension

NOTE: The steps in this section are applicable to Application Server upgrades only.

Note for future reference the value of the extensionTimeInSeconds attribute under
AS_CLI>System/Registration.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 111 OF 225

 Set this attribute to a value that corresponds to the total time spent upgrading the
Application Server cluster. It is recommended to set it to “10800” (that is, 3 hours).
Replication pushes this change to the remaining servers in the cluster.

6.7 Activate New Software Version

NOTE 1: The procedure documented in this section impacts the running Cisco BroadWorks
version. The currently running version is stopped as part of this action.

NOTE 2: For Cisco BroadWorks redundant systems, you MUST activate the new software
version on the cluster primary server first.

NOTE 3: For systems with customized prompts, announcement wav files must be manually
propagated to the sysprompts directory of the new release before activating the new software
version. For more information, see the Cisco BroadWorks Announcement Guide.

Similarly, for systems requiring localization, the target release localization files must be manually
modified after activating the new software version. For more information, see the Cisco
BroadWorks Application Server Web Portal Customization and Localization Guide.

6.7.1 Upgrade Cisco BroadWorks

The activation of the new Cisco BroadWorks software version is done from the Cisco
BroadWorks CLI (bwcli). At the end of installation phase, the Cisco BroadWorks installer
displays the following warning that describes the required steps to activate the new
software version.
+++WARNING --- 1002 <You will need to manually activate the new software
version>

ssh keys between peer servers need to be fully meshed for a successful
upgrade.
If you are not sure that your keys are properly meshed, you can rerun
the following as bwadmin:

config-ssh -createKeys

Then, go to the BroadWorks CLI, change the active software version and
reset the server to make this new BroadWorks software version the active
one:

CLI> maintenance; managedobject

CLI/Maintenance/ManagedObjects> lock
CLI/Maintenance/ManagedObjects> set activeSoftwareVersion server <server
type> <version>

Note that the lock action may take a few minutes. Either wait for the
server to be locked, or use the following command to force the lock:
CLI/Maintenance/ManagedObjects> lock force

Note that:
◼ Waiting for the server to be in the Lock state ensures that currently active calls are not
impacted by the upgrade.
◼ A server in the Locking state (on its way to the Lock state) does not accept any new
calls.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 112 OF 225

 ◼ After activating the new Cisco BroadWorks software version, it is mandatory to exit
the CLI before issuing new CLI commands.
Monitoring of the state of the Cisco BroadWorks server is also done from the CLI under
the Maintenance/ManagedObjects level:
CLI/Maintenance/ManagedObjects> get broadworks
…
Admin state : Unlocked

When a server is manually locked using the lock command, it must be manually unlocked
using the unlock command. During the startup phase, the server automatically transfers to
its configured state. If the server was locked prior to the startup phase, it will remain locked
even after the startup phase is completed. On the other hand, if the server was unlocked
prior to the startup it will transition to the unlock state once the startup phase is completed.

6.7.2 Verify Result of Activation

The activation logs are displayed when activating from the CLI agent. For the SNMP
upgrade or for references, the logs can be obtained from
/var/broadworks/logs/maintenance/ setactiveserver<server version><date>.log file.

6.7.3 Post-upgrade Sanity Checks

Repeat the same health verifications that have been done before the upgrade.
See section 6.11.2 - Upgrade Sanity Checks.

6.8 Restore Registration Extension

NOTE: The steps in this section are applicable to Application Server upgrades only.

Set the value of the extensionTimeInSeconds attribute under

AS_CLI>System/Registration to the value noted prior to activating the new software
version.
Replication pushes the modification to the remaining servers in the cluster.

6.9 Localize Cisco BroadWorks Server (CommPilot Application on Application

Server, Application Delivery Platform and Xtended Services Platform)
Default labels used by the Cisco BroadWorks CommPilot web portal are stored in a series
of .properties files within the /usr/local/broadworks/bw_base/conf directory (for example,
[Link]). For each language supported by the server, a
corresponding file exists whose file name is terminated with a language descriptor (for
example, BroadworksLabels_en_US.properties).
The upgrade procedure does not overwrite existing English-language files. Consequently,
the labels and navigation menus that appear in the English web portal continue to use the
strings and values configured for the previous release. New features and functionality may
therefore be unavailable.
After upgrading your server, you must localize the .properties files for all languages you
intend to support, including English.
For more information on localizing the Cisco BroadWorks web portal, see the Cisco
BroadWorks Application Server Web Portal Customization and Localization Guide.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 113 OF 225

 6.10 Additional Considerations when Upgrading an Xtended Services
Platform/Profile Server (XSP/PS) to the Application Delivery Platform (ADP)
The Application Delivery Platform supports upgrades from the Xtended Services Platform
and Profile Server. However, to preserve the functionalities, all the corresponding
applications that are active or deployed on the current Xtended Services Platform and
Profile Server release must be pre-downloaded to /usr/local/broadworks/apps before the
actual upgrade. If one of the deployed applications is not pre-downloaded, the pre-
upgrade check reports an error, and the upgrade process is aborted.
To make sure the required applications are pre-downloaded, the pre-upgrade check uses
the following rules:
◼ For release independent applications, one and only one release-independent version
of the application is present.
◼ For release anchored applications, one and only one release anchored version of the
application is present.
Failure to respect one of these rules will make the upgrade check fail.
At the end of the upgrade process, the server is converted to an Application Delivery
Platform and all applications that were in the deployed state on the former Xtended
Services Platform/Profile Server are deployed and ready to use on the Application
Delivery Platform.

[Link] License installation

Before upgrading to the Application Delivery Platform a new license must be installed
manually as follows:
/usr/local/broadworks/<ADP Version>/bin/[Link]
/export/home/bwadmin/[Link]

Note that the [Link] script to use is the one located under the ADP directory tree.

6.11 Troubleshooting an Installation

6.11.1 Software Activation

When the software activation is performed via the CLI or SNMP, logs are captured in the
/var/broadworks/logs/maintenance directory in a file called setactiveserver<server
version><date>.log. The operator can monitor the state of the software activation by
entering a tail –l on the latest log file in that directory (ls –ltr lists the log file from the oldest
to the newest).
If the operator sees errors reported while monitoring the logs, it may be required to revert
to the previous version of Cisco BroadWorks. This can be performed from the CLI using
the following command:
NS_CLI/Maintenance/ManagedObjects> set force activeSoftwareVersion server
<server type> <server version> revert <backup>

An operator must make sure no one else is performing maintenance tasks on the server
and that the Cisco BroadWorks server is not currently being reset. If so, the operator can
bring back the server from a Maintenance state to a Running state by deleting the
following file: /usr/local/broadworks/.[Link].

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 114 OF 225

 NOTE: In cases where a failure occurs during the upgrade, it is recommended to return to the
previous release using one of the approaches presented in section 7 Cisco BroadWorks
Rollback/Revert Procedures.

6.11.2 Upgrade Sanity Checks

Verifying the health of your server before and after each major transition:
◼ Before/after installing a new version of BroadWorks
◼ Before/after upgrading BroadWorks
This allows to isolate and troubleshoot the cause of eventual errors.

[Link] Using healthmon

The healthmon tool should always be used following an installation of a Cisco
BroadWorks server.
For non-redundant installations, the tool should not report any errors, and all processes on
the system should be up and running. Follow the recommendations when failures are
detected.
bwadmin@mtlas05$ healthmon –l
...
System Health Report Page
BroadWorks Server Name : mtlas05
Date and time : Mon Jul 20 15:18:35 EDT 2015
Report severity : NOTIFICATION
Upgrade check severity : NOTIFICATION
Server type : AppServer
Server state : Unlock
--------------------------------

No abnormal condition detected.

--------------------------------

When installing the secondary server in a redundant configuration, the tool should not
report any errors, and all processes on the system should be up and running. Follow the
recommendations when failures are detected.
System Health Report Page
BroadWorks Server Name : mtlas06
Date and time : Mon Jul 20 15:23:07 EDT 2015
Report severity : NOTIFICATION
Upgrade check severity : NOTIFICATION
Server type : NetServer
Server state : Unlock
--------------------------------

No abnormal condition detected.

--------------------------------

For a redundant configuration, the synchronization check script can be executed on the
secondary to ensure both primary and secondary servers are synchronized.
bwadmin@[Link]$ synchcheck_basic.pl -a

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 115 OF 225

 Report:
synchcheck_basic.pl started Thu Jun 18 14:14:58 EDT 2015
Performing basic comparison between datastores AppServer on
[Link] (local) and AppServer on
[Link]
Databases appear in sync

Peer Name State

============================================================
[Link] Synchronized
[Link] Synchronized
checkPeer command successfully executed.

Recommended Actions:
None

[Link] Using BroadWorks commands

Use the following commands to validate your current version, configuration, as well as the
proper functioning of the system:
◼ showrun
◼ bwshowver
◼ frepctl --status
◼ repctl status
◼ mdbctl status (where applicable)
◼ synchcheck_basic.pl -a (where applicable)

[Link] Functionality relevant to your deployment – Network Server

◼ Validate PSTN inbound 302 redirect.
◼ Validate Application Server outbound 302 redirect.
◼ Validate Application Server MSS request/response.
◼ Validate CLI access (log in and go to NS_CLI/System/Device/HostingNE; enter the
get command).
◼ Validate web access to the Network Server (if enabled).
◼ Validate user lookup from an ADP using NS mode communication by simply logging
in to an ADP.

[Link] Functionality relevant to your deployment – Application Server

◼ Validate SIP outbound calling.
◼ Validate MGCP outbound calling.
◼ Validate PSTN to SIP user inbound calling.
◼ Validate PSTN to MGCP user inbound calling.
◼ Validate voice mail leaving/retrieval (voice portal).
◼ Validate CommPilot originations/terminations.
◼ Validate CLI access (go to AS_CLI/System/Alias and use the get command).
◼ Validate direct web access to the Application Server

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 116 OF 225

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 117 OF 225
 7 Cisco BroadWorks Rollback/Revert Procedures

Prerequisites:
◼ An installed and fully configured version of Cisco BroadWorks is operating on the
server.
◼ The /usr/local/broadworks/bw_base UNIX soft link must exist and be defined to point
to the Cisco BroadWorks software version from which to roll back.
◼ The previous Cisco BroadWorks software version directory must exist
(/usr/local/broadworks/<previous version>) to allow a rollback to the previous Cisco
BroadWorks software version.

NOTE: For the release-independent servers, apart from the Network Server, the rollback
operation is not supported. A revert operation must be performed.

7.1 Procedural Steps

1) Configure the registration extension (Application Server only).
2) Change the active Cisco BroadWorks version.
3) Restore the registration extension (Application Server only).

7.2 Configure Registration Extension

NOTE: The steps in this section are applicable only to Application Server upgrades.

Note for future reference the value of the extensionTimeInSeconds attribute under
AS_CLI>System/Registration.
Set this attribute to a value that corresponds to the total time spent upgrading the
Application Server cluster. It is recommended to set it to 10800 (that is, 3 hours).
Replication pushes this change to the remaining servers in the cluster.

7.3 Change Active Software Version

There are two approaches to returning to a previous software version: Rolling Back and
Reverting Back. Both are shown in the following sections.

NOTE: For Cisco BroadWorks redundant systems, you MUST activate the new software version
on the cluster primary server first.

7.3.1 Roll Back to Previous Version

Rolling back consists of a reversed migration of the database schema, which persists all
changes from the current release to the previous release.
Rolling back to an older Cisco BroadWorks software version is done from the Cisco
BroadWorks command line interface or over SNMP. The following example shows the
steps required to roll back to an older software version through CLI.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 118 OF 225

 CLI> maintenance; managedobject
CLI/Maintenance/ManagedObjects> lock
CLI/Maintenance/ManagedObjects> set activeSoftwareVersion server NS
21.0_1.551
Note that the lock action may take a few minutes. Either wait for the
server to be locked, or use the following command to force the reset:
CLI/Maintenance/ManagedObjects> set force activeSoftwareVersion server NS
21.0_1.551

NOTE: To roll back the Xtended Services Platform and the Profile Server, see the Xtended
Services Platform Configuration Guide and Profile Server Platform Configuration Guide.

Note that waiting for the server to be in the Lock state ensures that currently active calls
are not affected by the upgrade. A server in the Locking state (on its way to the Lock state)
does not accept any new calls. After rolling back to a previous version, it is mandatory to
exit the CLI before issuing new CLI commands.
The following is an example of a successful rollback log.
NS_CLI/Maintenance/ManagedObjects> set activesoftwareversion server NS
21.0_1.551

+++ WARNING +++ WARNING +++ WARNING +++

This command will change the active software version of NS to 21.0_1.551.
NOTE that this action will cause downtime.
Continue?

Please confirm (Yes, Y, No, N): y

BroadWorks SW Manager checking NS server version 21.0_1.551...
Checking [Link] file
Checking for available disk space
Space required = 256 Mb
Checking on /bw... [done]
Checking System configuration
BW Daemon configuration validation
testing /etc/xinetd.d... [done]
Validating MoDaemon
Checking for dangling softlink
...Monitoring directory tree starting at: /var/broadworks

####### Startup Parameters IP Addresses Check START #######

####### Startup Parameters IP Addresses Check END #######

Checking maintenance tasks
Checking sshd configuration
Checking for critical patches
Checking TimesTen permanent memory size
BroadWorks SW Manager activating NS server version 21.0_1.551...
Stopping BroadWorks...

Broadcast message from bworks (Thu Jun 25 13:55:58 2015):

===== BROADWORKS CONTROL --- STOP INITIATED ON MTL64LIN24 =====

BroadWorks control script version 20.sp1
Stopping BroadWorks...
Stopping tomcat...
Stopping apache...
Stopping nsExecution...
Stopping nsProvisioning...

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 119 OF 225

 Waiting for core processes to terminate..............
... Done.
Stopping remotexla...
Waiting for core processes to terminate.......
... Done.

Currently running BroadWorks Application processes:

Currently running BroadWorks Platform processes:

BroadWorks Configuration Agent process monitor (pid=30199)

BroadWorks Configuration Agent (pid=30220)
BroadWorks Software Manager (pid=2493)
BroadWorks SNMP Agent process monitor (pid=30681)
BroadWorks SNMP Agent (pid=30722)
Executing Server specific pre-Switching...
Server specific pre-Switching...
[DONE]
Executing 3rd Party Switching Pre-Platform...
/usr/local/perl/perl_base -> /usr/local/perl/5.14.4
/usr/local/java/java_base -> /usr/local/java/jdk1.7.0_21a
/usr/local/apache/apache_base -> /usr/local/apache/2.2.24a
/usr/local/tomcat/tomcat_base -> /usr/local/tomcat/6.0.36
/usr/local/ssl/ssl_base -> /usr/local/ssl/1.0.1h
Switching OpenLDAP version from 2.4.26d to 2.4.26e
[done]
Reloading ldconfig
Updating Third Party Tools...
Updating tomcat
3rd Party Switching Pre-Platform...
[DONE]
Executing Platform Switching...
Shutting down bwsnmpd... [ok]
Shutting down configd... [ok]

Copying over old version configuration files

preserving file conf/[Link]...
preserving file conf/[Link]...
preserving file conf/[Link]...
preserving file conf/configdb/[Link]...
preserving file conf/[Link]...
preserving file conf/[Link]...
preserving file conf/namedefs...
preserving file conf/[Link]...
preserving file conf/[Link]...
preserving file conf/[Link]...
preserving file conf/[Link]...
/usr/local/broadworks/bw_base ->
/usr/local/broadworks/NS_Rel_21.0_1.551
unlink /usr/local/broadworks/bw_base...
[done]
link /usr/local/broadworks/bw_base...
[done]
copy .[Link]...
[done]
Linking [Link]...[done]

Applying all configuration patches

...patching with 21.0.6 [passed]
...patching with 21.0.170 [passed]
...patching with 21.0.204 [passed]

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 120 OF 225

 ...patching with 21.0.265 [passed]
...patching with 21.0.380 [passed]
...patching with 21.0.412 [passed]
...patching with 21.0.414 [passed]
...patching with 21.0.464 [passed]
...patching with 21.0.470 [passed]
...patching with 21.0.505 [passed]
...patching with 21.0.510 [passed]
[Link] utility version 21.0

Applying all patches.

...patching with Rel_21.0/v1.6/ [passed]
...patching with Rel_21.0/v1.398/ [passed]
...patching with Rel_21.0/v1.470/ [passed]
...patching with Rel_21.0/v1.517/ [passed]
...patching with Rel_21.0/v1.534/ [passed]
...patching with Rel_21.0/v1.555/ [passed]

[Link] utility [done]

Setting system info values
Patching configuration... [ok]

Starting configd... [ok]

[Link] utility version 21.0

[Link] utility [done]

Starting bwsnmpd... [ok]
Starting lmd... [ok]
Platform Switching...
[DONE]
Executing 3rd Party Switching Post-Platform...
3rd Party Switching Post-Platform...
[DONE]
Executing Database Switching...

---- BroadWorks database setup utility version 20.0 ----

=> Gathering data <=

in progress [..........]
=> Checking for perm size usage <=
Perm Size Usage = 30% (limit is at 75%)
=> Checking for available disk space <=
Perm = 128 Temp = 42
Space required [78
Mb]
Checking on /bw...
[done]
=> Checking fragmentation level <=
Fragmentation Percentage
[0]
Current maintenance...
[NS_Rel_20.sp1_1.606]
=> Backing up NS_Rel_20.sp1_1.606 database <=
Target is
/var/broadworks/backup/NS_Rel_20.sp1_1.606.150625135819_migrate.backup
Backing up
[done]
=> Settings <=
Target BroadWorks version
[NS_Rel_21.0_1.551]
Data store name
[NetworkServer]

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 121 OF 225

 TimesTen version
[[Link].6]
Installation type
[upgrade]
{
Upgrading from
[NS_Rel_20.sp1_1.606]
Previous TimesTen version
[[Link].0]
}
Redundant System
[false]
=> Destroying old stores <=
Unloading DSN from RAM...
[done]
Destroying /bw/broadworks/persistent/NetworkServer...
[done]
Current maintenance...
[NS_Rel_21.0_1.551]
=> Updating [Link] <=
Ensuring PermSize=128... [done]
Ensuring TempSize=42... [done]
Softlink /var/TimesTen/[Link] ->
/var/TimesTen/[Link].NS_Rel_21.0_1.551...[done]
Softlink /var/TimesTen/[Link] ->
/var/TimesTen/[Link].NS_Rel_21.0_1.551...[done]
=> Changing active TimesTen version <= [done]
=> Destroying old stores <=
Unloading DSN from RAM...
[done]
Restoring ...
[done]
Loading database in memory...
[done]
=> Patching the previous data schema <=
[Link] utility version 21.0

Applying all patches.

...patching with NS_Rel_21.0/v1.1/ [passed]
...patching with NS_Rel_21.0/v1.47/ [passed]
...patching with NS_Rel_21.0/v1.50/ [passed]
...patching with NS_Rel_21.0/v1.52/ [passed]
...patching with NS_Rel_21.0/v1.128/ [passed]
...patching with NS_Rel_21.0/v1.355/ [passed]
...patching with NS_Rel_21.0/v1.426/ [passed]
...patching with NS_Rel_21.0/v1.505/ [passed]
...patching with NS_Rel_21.0/v1.521/ [passed]

[Link] utility [done]

Logs are kept in /var/broadworks/logs/setup under [Link],

[Link] and [Link]
Defragmentation required
[No]
=> Unlocking current BroadWorks server <=
Unlocking...
[done]
=> Verifying database paging <=

=> Ensuring database is loaded in memory <=

Current maintenance...
[NS_Rel_21.0_1.551]

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 122 OF 225

 Setting ram policy to always
[done]
==== BroadWorks database setup [DONE] ====

Linking TimesTen [Link] in 3rdParty... [done]

Database Switching...
[DONE]
Executing Server specific Switching...

Auto configuring the network server

----> Policy Deployer Utility version 1.5 <----

There are no new policy in

/usr/local/broadworks/NS_Rel_21.0_1.551/policies/deployable/...
Nothing to do.

Optimizing this Broadworks system for optimal performance

The following aliases are already defined:

[ [Link], [Link], [Link], [Link],
NS1, mtl64lin24 ]
Now setting the following optimizations:
sipNumEncoderThreads = 2
redirectNumCallThreads = 2
redirectNumNonCallThreads = 2
sipNumCallReceiveThreads = 2
sipNumNonCallReceiveThreads = 2
asrNumReceiveThreads = 1

Optimization completed.

==> Dial plan installation <==

The following dial plans are already installed:

CC Name
--------------
1 NADP
1 NADP_E164
1 NADPCAC
1 NADPSUFX
1 NADPSUFXCAC
1 NADPSUFXE164

==> Dial plan installation completed! <==

Server specific Switching...
[DONE]
Executing Application Switching...
BroadWorks SW Manager activating NSExecutionAndProvisioning version
21.0_1.551...
BroadWorks SW Manager preserving files of NSExecutionAndProvisioning...
BroadWorks SW Manager applying patches to NSExecutionAndProvisioning...
[Link] utility version 21.0

[Link] utility [done]

[Link] utility version 21.0

[Link] utility [done]

BroadWorks SW Manager activating WebContainer version 21.0_1.551...
BroadWorks SW Manager preserving files of WebContainer...
Reinitializing tomcat dynamically-generated files...

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 123 OF 225

 Linking [Link]...
Linking [Link]...
Linking [Link]...
BroadWorks SW Manager applying patches to WebContainer...
[Link] utility version 21.0

[Link] utility [done]

[Link] utility version 21.0

Applying all patches.

...patching with Rel_21.0/v1.171/ [passed]

[Link] utility [done]

BroadWorks SW Manager activating NSPortal version 21.0_1.551...
BroadWorks SW Manager preserving files of NSPortal...
BroadWorks SW Manager applying patches to NSPortal...
[Link] utility version 21.0

[Link] utility [done]

[Link] utility version 21.0

[Link] utility [done]

Application Switching...
[DONE]
Executing Server specific post-Switching...
Server specific post-Switching...
[DONE]
Server specific pre-Switching Validation...
[DONE]
3rd Party Switching Pre-Platform Validation...
[DONE]
Platform Switching Validation...
[DONE]
3rd Party Switching Post-Platform Validation...
[DONE]
Database Switching Validation...
[DONE]
Server specific Switching Validation...
[DONE]
Application Switching Validation...
[DONE]
Server specific post-Switching Validation...
[DONE]
--> Starting BroadWorks <--

Broadcast message from bworks (Thu Jun 25 14:00:44 2015):

===== BROADWORKS CONTROL --- START INITIATED ON MTL64LIN24 =====

BroadWorks control script version 21.0
Starting BroadWorks...
Starting remotexla...
Starting nsExecution...
Starting nsProvisioning...
Starting tomcat...
Starting apache...
Starting [done]

NS_CLI/Maintenance/ManagedObjects>

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 124 OF 225

 [Link] Additional Notes about Rollback
It is important to note that data rollback is supported by Cisco BroadWorks. This means
that:
◼ The database data ReleaseR.Y is downgraded in to a ReleaseR.X data schema,
where Y is greater than X.
◼ Generally, the following occurs when rolling back to a previous version on an
Application Server:
– All data associated with new or modified functionality is removed.
– Any configuration changes made in these areas are lost.
– Access device templates added in a new release are not deleted but are made
obsolete.
– Users assigned to these devices continue to be assigned to these devices, but no
new devices of this type can be added.
In some special cases, data is returned to default values or not returned to its original state
in a rollback. These cases are documented in the Cisco BroadWorks Release Notes.

[Link] Special Case for Applications Managing Oracle Schema

Some of applications deployed on a Profile Server are managing an Oracle schema
located remotely on a Database Server. Following is the current list of these applications:
◼ CCReportingDBManagement
◼ EnhancedCallLogsDBManagement
◼ EnhancedCallLogsDBManagement-XS-TAS
◼ Provisioning
When a rollback is executed on a Profile Server where one or more of these applications
are deployed, the application code itself is rolled back, but the schema is not. This
behavior ensures the compatibility between the schemas and applications throughout the
rollback procedure, when two or more peers are connecting to the same schema for
instance.
When all the servers connecting to those schemas are properly rolled back, the rollback of
the schema must be done from the Profile Server CLI, under each deployed application.
PS_CLI/Applications/CCReportingDBManagement> rollbackSchemas

This command will rollback the following Schema(s):

--> bweccr
Are you sure you want to continue?

Please confirm (Yes, Y, No, N): y

Rollbacking CCReportingDBManagement Schema(s) from

CCReportingDBManagement_20.sp1_1.613 to
CCReportingDBManagement_19.sp1_1.590
{
[Link] utility version 21.0

Applying all patches.

...patching with Rel_20.1/v1.613/ [passed]
...patching with Rel_20.1/v1.612/ [passed]
...patching with Rel_20.1/v1.611/ [passed]
...patching with Rel_20.1/v1.610/ [passed]

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 125 OF 225

 ...patching with Rel_20.1/v1.609/ [passed]
...patching with Rel_20.1/v1.608/ [passed]
...patching with Rel_20.1/v1.607/ [passed]
...patching with Rel_20.0/v1.599/ [passed]
...patching with Rel_20.0/v1.598/ [passed]
...patching with Rel_20.0/v1.585/ [passed]
...patching with Rel_20.0/v1.552/ [passed]
...patching with Rel_20.0/v1.545/ [passed]
...patching with Rel_20.0/v1.514/ [passed]
...patching with Rel_20.0/v1.451/ [passed]
...patching with Rel_20.0/v1.413/ [passed]
...patching with Rel_20.0/v1.382/ [passed]

[Link] utility [done]

}
...Done

7.3.2 Revert to Previous Version

Reverting back returns to the previous version while restoring the database using the
latest previous release database backup (unless otherwise specified). Following is an
example of a revert invocation. The BackupFileName is optional, when not specified, the
latest backup of the previous release is used. When specified, the full path to the backup
file is required.
NS_CLI/Maintenance/ManagedObjects> set force activeSoftwareVersion server
<server type> <server version> revert <backup file>

For the Network Database Server (NDS) and Network Function Manager (NFM), the
MariaDB database must be restored manually using the previous release database
backup after the revert operation completed. Special considerations must be taken when
reverting a cluster of Network Database Server (NDS) or Network Function Manager
(NFM) nodes. For detailed steps to revert to a previous version, see the Cisco
BroadWorks Network Database Server Configuration Guide.

NOTE: If the return to the previous release is occurring during the same maintenance window
as the upgrade, it is recommended to use the revert method to save to reverse schema
migration time and ensure that the system is exactly as it was prior to the upgrade. After
reverting to a previous version, it is mandatory to exit the CLI before issuing new CLI commands.

7.4 Restore Registration Extension

NOTE: The steps in this section are only applicable to Application Server upgrades.

At the AS_CLI>System/Registration level, set the value of the extensionTimeInSeconds

attribute to the value noted prior to activating the new software version.
Replication pushes the modification to the remaining servers in the cluster.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 126 OF 225

 8 Cisco BroadWorks Patching Procedure

Prerequisite:
◼ Cisco BroadWorks is fully operational and is configured on the server.
The management of patches on a Cisco BroadWorks server is done through the Software
Manager. The Software Manager is a stand-alone piece of software that is installed on the
server. The patching functionality is accessible from the CLI under the
Maintenance/Patching level. The Software Manager handles patch “apply” and “remove”
operations, patch dependency check, patch history tracking, as well as all the Cisco
BroadWorks server operations needed (for example, stop/start, database
replication/backup/restore, peering).
Each Application Patch (AP) addresses a single Cisco BroadWorks issue. APs can be
packaged together to create a Patch Bundle (PB). APs and PBs can be applied and
removed by the Software Manager provided that dependencies between patch are valid.

NOTE: For the release-independent servers, the Cisco BroadWorks patching operations are not
supported.

8.1 Cisco BroadWorks Application Patch Management

This section describes the procedures to manage Cisco BroadWorks software patches.
The following figure illustrates the state machine of the patch management.

InstalledMissing
Dependencies
Dependency
missing
Apply
Dependency Dependency Installed
missing found
Pending Active Execute
Remove

Copy patch to
/var/broadworks/patches Installed

Delete Active
Patch
found
Patch
not found
Delete Remove
Apply

Missing Execute Active Pending

Patch
not found
Installed

Figure 19 Patch State Management

Patch state management is driven by commands issued from the Cisco BroadWorks
command line interface (CLI). The following list describes each state:
◼ Installed: By copying a patch file to the directory /var/broadworks/patches, the patch
becomes installed. By deleting a patch file from the directory /var/broadworks/patches,
that patch is removed from the system. In both cases, the CLI refresh command is
required to update the patch state. In the first case, the patch state is set to Installed.
In the other case, the patch is deleted and no other operations can be performed on
that patch.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 127 OF 225

 ◼ Installed Pending Active: Once installed, a patch is ready to be applied. A patch is
applied using the appropriate command from the CLI. Once applied, the patch enters
the Installed Pending Active state. In this state, there is still no action performed on the
system; the patch is simply marked as ready for activation.
◼ Active: The execute command from the CLI triggers the actual activation of the
patch. Depending on the state of the installed software (Active Disabled or Active
Enabled, or even Installed), and whether or not the patch requires a reset, different
operations are performed when the patch transitions to the Active state. For example,
some patches require that the server be stopped to perform database or schema
changes.
◼ Active Pending Installed: The steps described for patch activation also apply for
patch removal. When the patch is removed, and before the patch goes back into the
Installed state, the patch transitions to the Active Pending Installed state.
◼ Installed Missing Dependencies: While refreshing the list of patches installed on
the system, each patch dependency is validated. When a patch dependency is
missing, the patch state is set to “InstalledMissingDependency”. In this state, no
operation can be performed on that patch. To leave this state, the missing patch
dependency must be installed.
◼ Missing: The missing dependencies required by patches that are
“InstalledMissingDependency” are virtually created, while refreshing, with the
“Missing” state. In this state, no operations can be performed on the patch. To leave
this state, the patch must be installed.

NOTE: The patch installation procedure may not apply for certain patches. You must always
refer to the Release Notes delivered with the patch before using the procedure in this section.

8.2 OS Patching
Cisco BroadWorks software is always validated against the latest Red Hat update. If any
problems are found, a special bulletin is issued to customers. Therefore, it is safe for
customers to deploy the latest cluster or Linux updates. In fact, prior to any upgrade, it is
recommended to upgrade a server to the latest update since most likely newer versions of
Cisco BroadWorks are not validated against old Linux configurations. The latest testing of
OS patch bundles can be obtained from Cisco.

8.3 Install Cisco BroadWorks Patch

8.3.1 Procedural Steps

Install the Cisco BroadWorks software patch onto the target platform.

8.3.2 Install Patch

A software patch is typically retrieved from an FTP site. The procedure consists of:
◼ The software patch is sent by FTP to a directory called /var/broadworks/patches.
◼ The patch is validated to ensure it is visible to the Cisco BroadWorks application.
An operator can validate that a patch was properly installed either through the Cisco
BroadWorks CLI or by querying the Cisco BroadWorks Maintenance MIB via SNMP.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 128 OF 225

 From the CLI, go to the CLI/Maintenance/Patching level and enter the refresh command
followed by the listPatch command. The loaded patch should appear in the table of
patches with its state set to “Installed”.
AS_CLI> maintenance; patching
AS_CLI/Maintenance/Patching> refresh
Please wait while the database is updating (this could take up to a few
minutes depending on the number of patches and the activity on the
server).

.........

Patch database updated successfully.

NS_CLI/Maintenance/Patching> listPatch
Patch Name State
=========================================================================
[Link].21.0.551.ap240784 active
[Link].21.0.551.ap245579 active
[Link].21.0.551.ap235252 active
[Link].21.0.551.ap245468 active
[Link].21.0.551.ap245441 active
[Link].21.0.551.ap245148 active
[Link].21.0.551.ap244265 active
[Link].21.0.551.ap244020 active
[Link].21.0.551.ap242300 active
[Link].21.0.551.ap235960 active
[Link].21.0.551.ap235252 active
[Link].21.0.551.ap215990 active

12 entries found.

NS_CLI/Maintenance/Patching>

To verify that a patch has been successfully loaded via SNMP, an operator can monitor
the server-applied patch table.
View the list of applied Cisco BroadWorks patches. Monitor the bwSoftwarePatchTable
table.
OID:
[Link].
[Link].

8.3.3 Install Patch Bundle

A patch bundle is a collection of individual patches. As with patches, patch bundles are
retrieved from an FTP site. The procedure to load a patch bundle is as follows:
◼ The software patch bundle is sent by FTP to a directory called:
/var/broadworks/patches.
◼ The patch bundle is validated to ensure it is visible to the Cisco BroadWorks
application.
An operator can validate that a patch was properly installed either through the Cisco
BroadWorks CLI or by querying the Cisco BroadWorks Maintenance MIB via SNMP.
From the CLI, go to the CLI/Maintenance/Patching level and enter the refresh command
followed by the listBundle command. The loaded patch bundle should appear. To view all
patches installed through the patch bundle, enter the listPatch command.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 129 OF 225

 PS_CLI> maintenance; patching
PS_CLI/Maintenance/Patching> refresh
Please wait while the database is updating (this could take up to a few
minutes depending on the number of patches and the activity on the
server).

Patch database updated successfully.

PS_CLI/Maintenance/Patching> listBundle
Patch Bundle Name
========================================================================
[Link].21.sp1.551.pb20150318093230
1 entry found.

To verify that patches contained within the patch bundle have been successfully loaded
via SNMP, an operator can monitor the server-applied patch table.
View the list of applied Cisco BroadWorks patches. Monitor the bwSoftwarePatchTable
table.
OID:
.[Link].
[Link]
The patches in the patch bundle have the column bwSoftwarePatchBundle set to the
patch bundle name.

8.4 Apply Cisco BroadWorks Patch

8.4.1 Procedural Steps

NOTE 1: For Cisco BroadWorks redundant systems, you MUST apply the new patch on the
cluster primary server first.

NOTE 2: Patches must be installed before they can be applied.

Apply a Cisco BroadWorks patch.

8.4.2 Apply Patch via CLI

Cisco BroadWorks software patches can be managed from the Cisco BroadWorks
command line interface (CLI) under the Maintenance/Patching level. An operator can
apply one or more patches at a time as well as a patch bundle. To apply a patch or a
patch bundle, an operator must use the apply command followed by the execute
command. Prior to performing the execute command, the server administrative state must
be set to “Locked” using the command lock from the CLI Maintenance/ManagedObjects.
Alternatively, the force option of the execute command can be specified. However, not all
patches require the server to be locked, only those requiring a restart.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 130 OF 225

 When the execute command is performed, if a maintenance task is running, the command
waits up to 10 minutes for the maintenance task to complete. After that delay, if the
maintenance task is still running, the execute command is aborted. The check against
running maintenance tasks is not performed when the force option is used.
The following is an example of apply and execute commands.

NOTE: Be aware that executing a patch operation can provide important information to the
operator.

AS_CLI> maintenance; patching

AS_CLI/Maintenance/Patching> apply [Link].21.0.551.ap232938
...Done

AS_CLI/Maintenance/Patching> apply [Link].21.0.551.pb2015062532363

...Done

AS_CLI/Maintenance/Patching> execute force

[Link].21.0.551.ap343864
This patch contains inter-server dependencies to the following
patches -> [Link].21.0.551.ap343864
For full functionality provided in this patch it is required that
the inter-server dependency is applied and activated.

Software version AS_Rel_21.0_1.551

-----------------------------------
Number of patching operations (apply/remove): 4
BroadWorks is currently active.
Server must be restarted, which could cause downtime.
Database will be updated.

--> Important Patch Information <--

[Link].21.0.551.ap343864
This patch contains inter-server dependencies to the following
patches -> [Link].21.0.551.ap343864
For full functionality provided in this patch it is required that
the inter-server dependency is applied and activated.

Please confirm (Yes, Y, No, N): y

==> Gathering information for the operation <==

--> Patch in pending state <--
Building patch list... [done]
discovering system environment... [done]
Setting:
{
ServerType [AS]
BroadWorks versions [AS_Rel_21.0_1.551]
Patch List [[Link].21.0.551.ap232938]
[[Link].21.0.551.ap339351]
[[Link].21.0.551.ap342089]
[[Link].21.0.551.ap246376]
Redundant system: [false]
}
--> Executing Patch Operations for Active Enabled version
AS_Rel_21.0_1.551 <--

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 131 OF 225

 --> Validating Patches <--
Validating [Link].21.0.551.ap232938 [done]
Validating [Link].21.0.551.ap339351 [done]
Validating [Link].21.0.551.ap342089 [done]
Validating [Link].21.0.551.ap246376 [done]
--> Stopping Broadworks <--
Stopping [done]
--> Performing Patch Operations <--
Applying [Link].21.0.551.ap232938
{
installing db patch... [done]
applying db patch... [done]
applying java changes... [done]
}
Applying [Link].21.0.551.ap339351
{
applying binary changes... [done]
applying java changes... [done]
}
Applying [Link].21.0.551.ap342089
{
installing db patch... [done]
applying db patch... [done]
applying java changes... [done]
}
Applying [Link].21.0.551.ap246376
{
installing db patch... [done]
applying db patch... [done]
applying java changes... [done]
applying scripts changes... [done]
}
--> Starting Broadworks <--
Starting [done]
--> Executed Patch Operations for Active Enabled version
AS_Rel_21.0_1.551 <--

To view the status of all patches applied on a system, enter the listpatch command from
the CLI.

8.4.3 Apply Patch via SNMP

Applying a patch or patch bundle through SNMP is not yet available.

8.5 Remove Cisco BroadWorks Patch

You can remove a patch that has already been applied. The patch can then be re-applied
or deleted from the server.

8.5.1 Procedural Steps

NOTE: For Cisco BroadWorks redundant systems, you MUST remove the applied patch on the
cluster primary server first.

Remove the Cisco BroadWorks patch.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 132 OF 225

 8.5.2 Remove Patch via CLI
Cisco BroadWorks software patches can be managed from the Cisco BroadWorks
command line interface (CLI) under the Maintenance/Patching level. To remove a patch,
multiple patches, or a patch bundle, which have already been applied, an operator must
use the remove command followed by the execute command. Prior to performing the
execute command, the server administrative state must be set to Locked using the
command lock from the CLI Maintenance/ManagedObjects. Alternatively, the force option
of the execute command can be specified. However, not all patches require the server to
be locked, only those requiring a restart.
When the execute command is performed, if a maintenance task is running, the command
waits up to 10 minutes for the maintenance task to complete. After that delay, if the
maintenance task is still running, the execute command is aborted. The check against
running maintenance tasks is not performed when the force option is used.
The following is an example of the remove and execute commands.
AS_CLI/Maintenance/Patching> remove [Link].21.0.505.ap348720
...Done

AS_CLI/Maintenance/Patching> remove [Link].21.0.551.pb2015061611111

...Done

AS_CLI/Maintenance/Patching> execute force

Software version AS_Rel_21.0_1.551
-----------------------------------
Number of patching operations (apply/remove): 4
BroadWorks is currently active.
Server must be restarted, which could cause downtime.
Database will be updated.

Please confirm (Yes, Y, No, N): y

==> Gathering information for the operation <==

--> Patch in pending state <--
Building patch list... [done]
discovering system environment... [done]
Setting:
{
ServerType [AS]
BroadWorks versions [AS_Rel_21.0_1.551]
Patch List [[Link].21.0.505.ap348720]
[[Link].21.0.551.ap314351]
[[Link].16.0.505.ap305862]
[[Link].16.0.505.ap324553]
Redundant system: [false]
}
--> Executing Patch Operations for Active Enabled version
AS_Rel_21.0_1.551 <--
--> Validating Patches <--
Validating [Link].21.0.505.ap348720 [done]
Validating [Link].21.0.551.ap314351 [done]
Validating [Link].21.0.551.ap305862 [done]
Validating [Link].21.0.551.ap324553 [done]
--> Stopping Broadworks <--
Stopping [done]
--> Performing Patch Operations <--
Removing [Link].21.0.551.ap348720
{
removing db patch... [done]
removing java changes... [done]

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 133 OF 225

 }
Removing [Link].21.0.551.ap314351
{
removing java changes... [done]
restoring backed out files... [done]
}
Removing [Link].21.0.551.ap305862
{
removing db patch... [done]
removing java changes... [done]
}
Removing [Link].21.0.551.ap324553
{
removing db patch... [done]
removing java changes... [done]
removing added files... [done]
restoring backed out files... [done]
}
--> Starting Broadworks <--
Starting [done]
--> Executed Patch Operations for Active Enabled version
AS_Rel_21.0_1.551 <--

To determine whether a patch has been successfully removed, an operator can query the
server using the listPatch command.

[Link] Special Case for Oracle Database Patches

When a patch contains a database patch for a schema residing on a Database Server, the
removal of the patch does not actually roll back the schema change. However, the
database patch is marked as “rollback pending” for later removal. This behavior ensures
the compatibility between the schemas and the applications, when two or more peers are
connecting to the same schema for instance.
Once the patch is removed from every peer, the rollback of the schema can be executed
from the application level in the CLI.
PS_CLI/Applications/CCReportingDBManagement> rollbackSchemas pending

This command will rollback the following Schema(s):

--> bweccr
Are you sure you want to continue?

Please confirm (Yes, Y, No, N): y

Detecting rollback pending patches from

CCReportingDBManagement_20.sp1_1.606 20.1 build 613
{
--> patch v1.613 detected
}

Rolling back CCReportingDBManagement Schema(s) from

CCReportingDBManagement_20.sp1_1.613 to
CCReportingDBManagement_20.sp1_1.612
{
[Link] utility version 21.0

Applying all patches.

...patching with Rel_20.1/v1.613/ [passed]

[Link] utility [done]

}

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 134 OF 225

 ...Done

8.5.3 Remove Patch via SNMP

Removing patch or patch bundle through SNMP is not yet available.

8.6 Delete Cisco BroadWorks Patch

Deleting a patch consists of deleting all references to the patch in the system. To re-install
a deleted patch, an operator has to re-install it.

8.6.1 Procedural Steps

Delete the Cisco BroadWorks patch.

8.6.2 Delete Cisco BroadWorks Patch via CLI

Cisco BroadWorks software patches can be managed from the Cisco BroadWorks CLI
under the Maintenance/Patching level. To delete a patch that has already been removed,
an operator must delete the patch file from the /var/broadworks/patches directory and
enter the following commands.
AS_CLI> maintenance; patching
AS_CLI/Maintenance/Patching> refresh
Please wait while the database is updating (this could take up to a few
minutes depending on the number of patches and the activity on the
server).

.........

Patch database updated successfully.

AS_CLI/Maintenance/Patching> listPatch
Patch Name State
=========================================================================
[Link].21.0.551.ap333333 installed
1 entry found.

To view that a patch has been successfully deleted; an operator can query the server
using the listpatch command as shown in the previous example.

8.6.3 Delete Cisco BroadWorks Patch via SNMP

A patch cannot be deleted through SNMP.

8.7 Patch History

You can view the patch activity for a server by viewing the patch history. All state
operations performed on a patch are saved in the history.

8.7.1 Procedural Steps

List the patch history.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 135 OF 225

 8.7.2 View Patch History via CLI
Cisco BroadWorks software patch history can be viewed from the Cisco BroadWorks CLI
under the Maintenance/Patching level. To view the patch history an operator must enter
the following commands.
AS_CLI> maintenance; patching
AS_CLI/Maintenance/Patching> patchHistory
Date Patch Name Resulting State
=========================================================================
2015-06-16 06:43:15.268 [Link].21.0.551.ap230168 installed
2015-06-16 08:44:10.02 [Link].21.0.551.ap230168 deleted
2015-06-16 08:45:49.957 [Link].21.0.551.ap230168 installed
2015-06-17 10:53:45.766 [Link].21.0.551.ap230169 installed
2015-06-17 11:02:33.054 [Link].21.0.551.ap230169 deleted
2015-06-17 11:12:31.254 [Link].21.0.551.ap230169 installed
2015-06-17 14:35:03.269 [Link].21.0.5515.ap230168 installedPendingActive
2015-06-17 16:12:28.83 [Link].21.0.551.ap230170 installed
2015-06-18 08:35:58.352 [Link].21.0.551.ap230169 installedPendingActive
2015-06-18 08:40:14.228 [Link].21.0.551.ap230169 installed
2015-06-18 09:12:29.706 [Link].21.0.551.ap230169 deleted
2015-06-25 07:13:40.543 [Link].21.0.551.ap230168 installed
2015-06-25 07:13:44.2 [Link].21.0.551.ap230168 installedPendingActive
2015-06-25 07:13:56.106 [Link].21.0.551.ap230168 installed
2015-07-31 07:14:03.462 [Link].21.0.551.ap230168 installedPendingActive
2015-07-31 09:26:45.34 [Link].21.0.551.ap230168 installed
2015-07-31 09:27:00.248 [Link].21.0.551.ap230170 installedPendingActive
17 entries found.

8.7.3 View Patch History via SNMP

To view the patch history via SNMP, an operator can monitor the server patch history
table.
View the history of applied Cisco BroadWorks patches: Monitor the
bwSoftwarePatchHistoryTable table.
OID:
.[Link].
[Link]

8.8 Patch File Modified

Each patch installed on a server modifies existing files or adds new files. The impacted
files can be viewed.

8.8.1 Procedural Steps

List all files impacted by the installed patches.

8.8.2 View Modified Files via CLI

The files modified or added by the installed Cisco BroadWorks patch can be viewed from
the Cisco BroadWorks CLI under the Maintenance/Patching level. To view the modified
files an operator must enter the following commands:
NS_CLI> maintenance; patching
NS_CLI/Maintenance/Patching> getmodifiedfile bwsystem
Patch Name Modified File

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 136 OF 225

 =========================================================================
=======
[Link].20.sp1.606.ap208563
/usr/local/broadworks/NS_Rel_20.sp1_1.606/bin/[Link]
[Link].20.sp1.606.ap211350
/usr/local/broadworks/NS_Rel_20.sp1_1.606/bin/[Link]
[Link].20.sp1.606.ap216748
/usr/local/broadworks/NS_Rel_20.sp1_1.606/bin/[Link]
[Link].21.0.551.ap235252
/usr/local/broadworks/NS_Rel_21.0_1.551/bin/[Link]
[Link].21.0.551.ap247533
/usr/local/broadworks/NS_Rel_21.0_1.551/bin/[Link]
[Link].21.0.551.ap339196
/usr/local/broadworks/NS_Rel_21.0_1.551/bin/[Link]
[Link].21.0.551.ap342324
/usr/local/broadworks/NS_Rel_21.0_1.551/bin/[Link]
7 entries found.

8.8.3 View Modified Files via SNMP

To view a patch modified file via SNMP, an operator can monitor the server patch
impacted file table.
View the files modified or added by applied Cisco BroadWorks patches. Monitor the
bwSoftwarePatchImpactedFileTable table.
OID:
.[Link].
[Link]

8.9 Upgrade Cisco BroadWorks Software Manager

The Software Manager can be upgraded independently of the Cisco BroadWorks
application or as part of the Cisco BroadWorks application installation. When upgraded
independently of the Cisco BroadWorks application, a self-extracting installation file is
used. This is a non-interactive step whereas root the self-extracting bin file is run. It is
suggested to save the bin file in /bw/install and set the file as executable.
# cp swmanager_538018.bin /bw/install
# cd /bw/install
# chmod +x swmanager_538018.bin

NOTE 1: It is recommended to get the latest version of the Software Manager prior to installing
and applying patches on a software release.

NOTE 2: Performing a Software Manager upgrade does not affect service. Only the patching
functionality of the server is impacted during the upgrade; other service areas are not impacted.

Following is an example of a self-extracting installation upgrade of the Software Manager.

[root@mtl64lin12 install]# swmanager_538018.bin
==> SW Manager installation <==
SW Manager version 538018
Built on [Link] on Wed Jun 10 10:23:33 2015

Launching installation:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 137 OF 225

 Gathering OS name... [Linux]
Gathering architecture... [x86_64]
Skipping md5 checksum validation.
Validating permission... [done]
SELinux configuration... [done]
Validating structure... [done]
Validating disk space
Space Available on / for SW Manager: 14271464
Space Available on / for SW Manager: 14271464
Validating disk space [done]
Extracting... [done]
Installing SW Manager on [Link]...

Installing SW Manager

Installing new SW Manager version 538018

Stopping SW Manager Service [done]
Backing up SWManager database [done]
Backup file location:
/usr/local/broadworks/swmanager/dbbackup/SWManagerBackup_538018_2015_6_16_11_
21_10.[Link]
swmanager_538018.[Link] --> /usr/local/broadworks/swmanager...
Successfully imported properties from old version to new version.
Starting SW Manager [done]

Moving logs to
/var/broadworks/logs/installation/swmanager_installation.[Link]

Current Software Manager version information can be obtained using the swmanshowver
command.
bwadmin@[Link]$ swmanshowver
SWManager version: 538018

8.10 Software Manager Logging

The Software Manager generates various log files depending on the action it performs.
There are three types of log files: Software Manager activity logs, Software Manager
execute logs, and Software Manager system logs.
The Software Manager activity log file name is prefixed with patchActivities. This file
contains information about the detailed operations of the Software Manager. A new activity
log file is created at each Software Manager restart. The Software Manager activity log
files are stored in /var/broadworks/logs/swmanager/swmanagerActivities_YYYY.[Link]-
[Link].
When performing patching activities, the Software Manager logs the patch execution logs
in a log file prefixed with patchExecute. This log file contains the output of the execute
command. For each execute command performed, there is a patchExecute file created.
The execute log files are stored in
/var/broadworks/logs/swmanager/patchExecute_YYYYMMDD_HHMMSS.log.
Finally, there is the system logs file. This file contains information about system
commands the Software Manager undertakes while performing the execute command.
The file name of this file is prefixed with patchOutput. For each execute command
performed, there is a patchOutput file created. The log files are stored in
/var/broadworks/logs/swmanager/patchOutput_YYYYMMDD_HHMMSS.log.
The Software Manager stores the upgrade logs in the /var/broadworks/logs/installation/
swmanager_installation.[Link] directory.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 138 OF 225

 8.11 Software Manager Database Backup and Restore
The Software Manager includes two scripts used to back up and restore the Software
Manager database:
◼ [Link]:
The [Link] script creates a backup file of the Software Manager
database. The script is located in /usr/local/broadworks/swmanager/sbin.
◼ [Link]:
The [Link] script restores the Software Manager database from the
backup file created by the [Link] script. The script is located in
/usr/local/broadworks/swmanager/sbin.

NOTE: The backup file should only be used with the same revision of the Software Manager
with which it was created. Both the [Link] and the [Link] include the
Software Manager revision number in the name of the backup file.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 139 OF 225

 9 Cisco BroadWorks OS In-place Upgrade Procedures

The OS in-place upgrade procedures presented in these sections are based on the OS in-
place upgrade documentation provided by Red Hat Enterprise Linux and Oracle Linux. In
any case, the procedures documented in this document are a replacement of the OS
vendor procedures.
Prerequisites:
◼ The server has an installed and configured version of a Cisco BroadWorks.

NOTE1: Cisco BroadWorks OS in-place upgrade is only supported starting with Release
Independent 2023.12, Release 24.0 Application Server, Release 23.0 Application Server,
Network Server, Profile Server and Xtended Services Platform installed with application patch
ap385424.

NOTE 2: The Database Server (DBS) is not supported to perform OS in-place upgrade.

NOTE 3: For the server without a Cisco BroadWorks version installed, it is recommended to
fresh install OS, see section 5 Cisco BroadWorks Initial Installation Procedure.

NOTE 4: All Cisco BroadWorks OS in-place upgrade procedures must be done during the
maintenance window.

NOTE 5: The recommended approach for OS in-place upgrade is with a direct connection to the
official repository. However, in cases where such a configuration is not possible, an offline
approach is possible. The offline OS in-place upgrade procedures are provided for CentOS 7 to
Red Hat Enterprise Linux 7 and Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 as
example. The other OS in-place upgrade paths are similar.

NOTE 6: The procedures are for Cisco BroadWorks applications, if customer is running other
applications, it is the customer’s responsibility to identify the issues and fix them.

9.1 Oracle Linux 7 to Oracle Linux 8 In-place Upgrade Procedure

9.1.1 Procedural Steps

1) Run Cisco BroadWorks pre OS in-place upgrade check.
2) Perform a backup.
3) Prepare for the upgrade.
4) Run the OS preupgrade check.
5) Upgrade the system.
6) Verify the upgrade.
7) Complete postupgrade tasks.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 140 OF 225

 9.1.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check
Run Cisco BroadWorks pre OS in-place upgrade check script with the parameter to
specify which OS version upgrade to, for example if upgrading to Linux 8, the OS version
upgrade to parameter is “8.0”. Make sure pre OS in-place upgrade check is successful. If
the pre OS in-place upgrade check fails, the BroadWorks version either needs to be
upgraded first to support the new OS version, or it is unsupported BroadWorks server, for
example DBS.
$ [Link] 8.0
You are about to run pre OS in-place upgrade check to Linux version
8.0

*********************************************************************
**********
Do you want to continue? (y/n) [n]?y
Starting pre OS in-place Upgrade Check.

Success! Pre OS in-place upgrade check passed!

After resolving all pre OS in-place upgrade check issues, rerun the script and confirm
that there are no issues outstanding.

9.1.3 Perform a Backup

Perform a system backup of Cisco BroadWorks server and store to external location.
$ [Link]
Perform a backup of system configuration file.
# cp /etc/[Link] /bw/install/[Link]
# cp /etc/security/limits.d/[Link] /bw/install/20-
[Link]
# cp /etc/cron.d/sysstat /bw/install/[Link]
# cp /etc/snmp/[Link] /bw/install/[Link]
# cp /etc/[Link] /bw/install/[Link]
If environment available, take a VM snapshot of Cisco BroadWorks server.

9.1.4 Prepare for the Upgrade

[Link] Start NetworkManager

Edit the network script corresponding to the interface for SSH access, for example
/etc/sysconfig/network-scripts/ifcfg-enp0s3, enable the network manager and add DNS
servers if they are not present. In the following example, replace the DNS server IP
address “[Link]” with actual DNS IP address:
NM_CONTROLLED=yes
DNS1=[Link]
Start NetworkManager:
# systemctl enable NetworkManager
# systemctl start NetworkManager

[Link] Verify the System Locale

Verify that the system locale is set to en_US.UTF-8.
# cat /etc/[Link]
If the locale is not set correctly, use the following command to configure it.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 141 OF 225

 # localectl set-locale LANG=en_US.UTF-8

[Link] Remove the Versionlock Plugin

The Versionlock plugin is a plugin that holds back packages from being upgraded to
newer versions. If the plugins used to lock packages to a specific version, clear the lock as
shown:
# yum versionlock clear

[Link] Partition /var Size is Too Small

When /var is configured as a partition and the size is too small, for example 2 GB, the OS
in-place upgrade is not possible:
# df -h /var
Filesystem Size Used Avail Use% Mounted on
/dev/sda5 2.0G 1.6G 498M 76% /var
There are two possible methods for fixing the size of the /var partition:
1) Increase the size of /var partition, the recommended /var partition size is 10 GB, the
operator may need to reach the OS vendor for support.
2) If increasing the size of /var partition is not possible, temporarily relocate the
/var/cache/yum, /var/cache/dnf and /var/lib/leapp directories to a bigger partition with
10GB of free space to avoid space exhaustion issue. For example, creating
/bw/lib/leap, /bw/cache/yum, /bw/cache/dnf directories and making soft link from
/bw/lib/leapp to /var/lib/leap, /bw/cache/yum to /var/cache/yum, /bw/cache/dnf to
/var/cache/dnf:
# rm -rf /var/cache/yum /var/cache/dnf /var/lib/leapp
# mkdir -p /bw/lib/leapp /bw/cache/yum /bw/cache/dnf
# ln -s /bw/lib/leapp /var/lib/leapp
# ln -s /bw/cache/yum /var/cache/yum
# ln -s /bw/cache/dnf /var/cache/dnf

[Link] Update to Latest OS Package

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Update all system packages to the latest versions with Yum.
# yum update -y
When the updates are completed, reboot the system.
# reboot

[Link] Install the Leapp Utility

Install the Leapp utility and its supporting repositories.
# yum install -y leapp --enablerepo=ol7_leapp,ol7_latest

[Link] Temporarily Disable Antivirus Software

Temporarily disable antivirus software to prevent the upgrade from failing.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 142 OF 225

 9.1.5 Run the OS Preupgrade Check
The OS preupgrade check ensures that the system is cleared of issues that might impede
the upgrade. It does not change the system but creates an assessment report that
identifies risks to upgrading. The report also provides recommendations for resolving
those risks.
An operator must ensure that the recommended remedies are completed to clear risks
that are labeled high and can inhibit the upgrade process.

[Link] Grant root SSH Login Permission

Grant root SSH login permissions in the /etc/ssh/sshd_config file.
PermitRootLogin yes

[Link] Run the OS Preupgrade Command

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Run the leapp preupgrade command to start the OS preupgrade process.
# leapp preupgrade --oraclelinux
Example output:
============================================================
UPGRADE INHIBITED
============================================================

Upgrade has been inhibited due to the following problems:

1. Inhibitor: Missing required answers in the answer file
Consult the pre-upgrade report for details and possible remediation.

============================================================
UPGRADE INHIBITED
============================================================

Debug output written to /var/log/leapp/[Link]

============================================================
REPORT
============================================================

A report has been generated at /var/log/leapp/[Link]

A report has been generated at /var/log/leapp/[Link]

============================================================
END OF REPORT
============================================================

Answerfile has been generated at /var/log/leapp/answerfile

A [Link] file and an answerfile are created, and debug information is saved in
a [Link] log file.

[Link] Examine the Leapp Report

Examine the [Link] file. The report provides a summary of the issues and offers
solutions to resolve them.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 143 OF 225

 # cat /var/log/leapp/[Link]
Identify any high-risk entries marked as Risk Factor: high (inhibitor). These high-risk
entries will prevent an upgrade from completing and must be resolved.
Address the reported high risks, run the preupgrade command again. In the regenerated
report, verify that all high risks are cleared.
The following are only examples to fix high risk entries, the operator may need to reach
the OS vendor for support:
3) Disable Unused Network Interfaces
Disable unused interfaces on the server, for example eth1, ...
# rm -Rf /etc/sysconfig/network-scripts/ifcfg-eth1
4) Rename Legacy Network Interfaces
Rename legacy interfaces in file /etc/udev/rules.d/[Link], if the file does
not exist, create the file. For example, to rename eth0 to enp0s4, the following line in the
file contains eth0 MAC address (ATTR{address}=="08:00:27:d4:32:87"), but the name
“eth0” ( NAME="eth0" ) is renamed to “enp0s4” (NAME="enp0s4"), make sure the name
does not conflict with another existing network interface name.
SUBSYSTEM=="net", ACTION=="add", DRIVERS=="?*",
ATTR{address}=="08:00:27:d4:32:87", NAME="enp0s4"
Rename /etc/sysconfig/network-scripts/ifcfg-eth0 to /etc/sysconfig/network-scripts/ifcfg-
enp0s4, change the device name in the /etc/sysconfig/network-scripts/ifcfg-enp0s4, for
example “DEVICE=eth0” to “DEVICE=enp0s4”, and make sure eth0 MAC address is
defined, for example “HWADDR=08:00:27:d4:32:87”.
DEVICE=enp0s4
HWADDR=08:00:27:d4:32:87
NM_CONTROLLED=no
BOOTPROTO=dhcp
ONBOOT=yes
PEERDNS=no
When the rename completes, reboot the system.
# reboot
5) Remove Unused Third-party Packages
Remove unused third-party packages on the server, for example sysvinit-tools, uname26.
Before removing sysvinit-tools package, reinstall python-six, python-ipaddress, python-
backports, python-sssdconfig.
# yum reinstall -y python-six python-ipaddress python-backports
python-sssdconfig
# yum remove sysvinit-tools uname26 -y

[Link] Provide Information to the Leapp Answerfile

In addition to completing the recommendations of /var/log/leapp/[Link], operator
must also provide answers to all the items in /var/log/leapp/answerfile
# cat /var/log/leapp/answerfile
Example output:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 144 OF 225

 [remove_pam_pkcs11_module_check]
# Title: None
# Reason: Confirmation
# =================== remove_pam_pkcs11_module_check.confirm
==================
# Label: Disable pam_pkcs11 module in PAM configuration?
If no, the upgrade process will be interrupted.
# Description: PAM module pam_pkcs11 is no longer available in
OL-8 since it was replaced by SSSD.
# Type: bool
# Default: None
# Available choices: True/False
# Unanswered question. Uncomment the following line with your answer
# confirm =

Based on the example, each verification check is identified with a section heading in
square brackets, such as remove_pam_pkcs11_module_check. The heading is followed
by descriptions of the issue and the valid responses to address the issue.
Run “leapp answer“ command on the specific section that needs correcting. For example,
to confirm the PAM module verification, use the following command:
# leapp answer --section remove_pam_pkcs11_module_check.confirm=True
Verify the answerfile has been modified.
# cat /var/log/leapp/answerfile
Example output:
[remove_pam_pkcs11_module_check]
confirm = True

[Link] Re-run the OS Preupgrade Command

Re-Run the preupgrade command anytime to generate the report files and ensure
required items in the Leapp report and answerfile are addressed.

9.1.6 Upgrade the System

After the /var/log/leapp/answerfile has been properly completed and the
/var/log/leapp/[Link] is verified no longer reports high risks, upgrade the system.

[Link] Verify the Current OS and Kernel Version

For comparison to after the upgrade, verify the current OS and kernel version of the
system.
Check the Oracle Linux version running on the system.
# cat /etc/oracle-release
Check the kernel version used.
# uname -r

[Link] Run the Upgrade Command

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Run the upgrade command with the appropriate command argument.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 145 OF 225

 # leapp upgrade --oraclelinux
The upgrade process returns to the command prompt when finished. It takes around 15
minutes.
Example output:
The downloaded packages were saved in cache until the next successful
transaction.
You can remove cached packages by executing 'dnf clean packages'.
==> Processing phase 'InterimPreparation'
====> * efi_interim_fix
Adjust EFI boot entry for first reboot
====> * initram_disk_generator
Creates the upgrade initram disk
====> * add_upgrade_boot_entry
Add new boot entry for Leapp provided initramfs.
A reboot is required to continue. Please reboot your system.

Debug output written to /var/log/leapp/[Link]

============================================================
REPORT
============================================================

A report has been generated at /var/log/leapp/[Link]

A report has been generated at /var/log/leapp/[Link]

============================================================
END OF REPORT
============================================================

Answerfile has been generated at /var/log/leapp/answerfile

NOTE: If operator has not addressed the answerfile items and Risk Factor: high
(inhibitor) entries in the [Link] file, the process will terminate back to command line and
inform about the issues encountered.

[Link] Reboot System

When the upgrade completes, reboot the system.
# reboot
While the system reboots, monitor the progress on the console. At the completion of the
boot process, the utility automatically proceeds with upgrading packages. This operation
takes a while to complete and includes multiple automatic reboots.

9.1.7 Verify the Upgrade

[Link] Examine the Leapp Report

The upgrade process also updates the answerfile, [Link], and creates a leapp-
[Link] log file.
Examine the /var/log/leapp/[Link] and fulfill any important recommendations to
be completed after the upgrade process.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 146 OF 225

 [Link] Verify the New OS and Kernel Version
Verify the system's new OS version, type:
# cat /etc/oracle-release
Oracle Linux Server release 8.8
Check the system's kernel version, type this command to verify that the kernel contains
the el9 substring:
# uname –r
5.4.17-2136.324.5.3.el8uek.x86_64
Identify the system's default kernel contains the el8 substring with the following command:
# grubby --default-kernel
/boot/vmlinuz-5.4.17-2136.324.5.3.el8uek.x86_64

9.1.8 Complete Postupgrade Tasks

[Link] Update DNS server

Edit the /etc/[Link] to make sure DNS servers are present, for example:
search [Link]
nameserver [Link]

[Link] Re-install Removed Packages

Re-install removed packaged and start the related system services:
# dnf install network-scripts xinetd net-snmp initscripts -y
# systemctl start network
# systemctl enable network
# systemctl start xinetd
# systemctl enable xinetd
# systemctl start snmpd
# systemctl enable snmpd

[Link] Remove Residual Packages and Files from the Previous Oracle Linux
1) Edit /etc/dnf/[Link] by removing or commenting out exclude= lines that refer
to leapp packages, for example:
#exclude=python2-leapp,snactor,leapp-upgrade-el7toel8,leapp
2) Remove all packages from the exclude list:
# dnf config-manager --save --setopt exclude=''
3) Use commands such as rpm -qa to list packages that can be removed:
# rpm -qa | grep el7
# rpm -qa | grep leapp
4) Use the dnf remove command to remove the packages listed by the queries.
# dnf remove <package name>
5) Remove all remaining upgrade-related data from the system:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 147 OF 225

 # rm -rf /var/log/leapp /root/tmp_leapp_py3 /var/lib/leapp
# [ -e /bw/lib/leapp ] && rm -rf /bw/lib/leap
# [ -e /bw/cache ] && rm -rf /bw/cache /var/cache/dnf /var/cache/yum

[Link] Disable YUM Repositories Whose Packages are not Oracle Linux 8-Compatible
Disable YUM repositories whose packages are not Oracle Linux 8-compatible.
Repositories managed by RHSM are handled automatically. To disable these repositories:
# dnf config-manager --set-disabled <repository_id>
Replace repository_id with the repository ID. The repository_id can be checked using
command "dnf repolist", for example "epel".
# dnf config-manager --set-disabled epel

[Link] Restore System Configuration Files

Restore system configuration files from backup:
# [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/[Link]
# [ -e /bw/install/[Link] ] && cp /bw/install/20-
[Link] /etc/security/limits.d/[Link]
# [ -e /bw/install/[Link] ] && cp /bw/install/[Link]
/etc/cron.d/sysstat
# [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/snmp/[Link]
# [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/[Link]
# sysctl -p

[Link] Stop NetworkManager

Edit the network script corresponding to the interface for SSH access, for example
/etc/sysconfig/network-scripts/ifcfg-enp0s3, and disable the network manager:
NM_CONTROLLED=no
Stop NetworkManager:
# systemctl stop NetworkManager

[Link] Run BroadWorks Post OS In-place Upgrade Script

Shutdown BroadWorks applications, start config agent and run post OS in-place upgrade
script.
# /usr/local/broadworks/bw_base/bin/[Link]
# sudo -u bworks /usr/local/broadworks/bw_base/bin/configdctl start
# /usr/local/broadworks/bw_base/sbin/[Link]

[Link] Reboot System

Shutdown BroadWorks applications and reboot system.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 148 OF 225

 # /usr/local/broadworks/bw_base/bin/[Link]
# reboot

[Link] Operating System Hardening

If Cisco BroadWorks operating system hardening was enabled on old Linux version, after
OS in-place upgrade, the operator needs to run Cisco BroadWorks operating system
hardening on new Linux version.
# /usr/local/broadworks/bw_base/sbin/[Link] -mode autofix

9.2 Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 In-place Upgrade
Procedure

9.2.1 Procedural Steps

1) Run Cisco BroadWorks pre OS in-place upgrade check.
2) Perform a backup.
3) Prepare for the upgrade.
4) Run the preupgrade check.
5) Upgrade the system.
6) Verify the upgrade.
7) Complete postupgrade tasks.

9.2.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check

Run Cisco BroadWorks pre OS in-place upgrade check script with the parameter to
specify which OS version upgrade to, for example if upgrading to Linux 8, the OS version
upgrade to parameter is “8.0”. Make sure pre OS in-place upgrade check is successful. If
the pre OS in-place upgrade check fails, the BroadWorks version either needs to be
upgraded first to support the new OS version, or it is unsupported BroadWorks server, for
example DBS.
$ [Link] 8.0
You are about to run pre OS in-place upgrade check to Linux version
8.0

*********************************************************************
**********
Do you want to continue? (y/n) [n]?y
Starting pre OS in-place Upgrade Check.

Success! Pre OS in-place upgrade check passed!

After resolving all pre OS in-place upgrade check issues, rerun the script and confirm
that there are no issues outstanding.

9.2.3 Perform a Backup

Perform a system backup of Cisco BroadWorks server and store to external location.
$ [Link]
Perform a backup of system configuration file.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 149 OF 225

 # cp /etc/[Link] /bw/install/[Link]
# cp /etc/security/limits.d/[Link] /bw/install/20-
[Link]
# cp /etc/cron.d/sysstat /bw/install/[Link]
# cp /etc/snmp/[Link] /bw/install/[Link]
# cp /etc/[Link] /bw/install/[Link]
If environment available, take a VM snapshot of Cisco BroadWorks server.

9.2.4 Prepare for the Upgrade

[Link] Start NetworkManager

Edit the network script corresponding to the interface for SSH access, for example
/etc/sysconfig/network-scripts/ifcfg-enp0s3, enable the network manager and add DNS
servers if they are not present. In the following example, replace the DNS server IP
address “[Link]” with actual DNS IP address:
NM_CONTROLLED=yes
DNS1=[Link]
Start NetworkManager:
# systemctl enable NetworkManager
# systemctl start NetworkManager

[Link] Verify the System Locale

Verify that the system locale is set to en_US.UTF-8.
# cat /etc/[Link]
If the locale is not set correctly, use the following command to configure it.
# localectl set-locale LANG=en_US.UTF-8

[Link] Verify that the System is Subscribed Using Subscription-Manager

Check if there is a Red Hat Enterprise Linux Server subscription attached to the system.
# subscription-manager list --installed
+-------------------------------------------+
Installed Product Status
+-------------------------------------------+
Product Name: Red Hat Enterprise Linux Server
Product ID: 69
Version: 7.9
Arch: x86_64
Status: Subscribed
If not, attach a subscription using the following command.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 150 OF 225

 # subscription-manager register
# subscription-manager attach --auto

[Link] Enable RHEL 7 ‘Base & Extra’ Repositories

# subscription-manager repos --enable rhel-7-server-rpms --enable rhel-7-
server-extras-rpms

[Link] Set the Red Hat Subscription Manager to Use the Latest RHEL 7
# subscription-manager release --unset

[Link] Remove the Versionlock Plugin

The Versionlock plugin is a plugin that holds back packages from being upgraded to
newer versions. If the plugins used to lock packages to a specific version, clear the lock as
shown:
# yum versionlock clear

[Link] Partition /var Size is Too Small

When /var is configured as a partition and the size is too small, for example 2 GB, the OS
in-place upgrade is not possible:
# df -h /var
Filesystem Size Used Avail Use% Mounted on
/dev/sda5 2.0G 1.6G 498M 76% /var
There are two possible methods for fixing the size of the /var partition:
1) Increase the size of /var partition, the recommended /var partition size is 10 GB, the
operator may need to reach the OS vendor for support.
2) If increasing the size of /var partition is not possible, temporarily relocate the
/var/cache/yum, /var/cache/dnf and /var/lib/leapp directories to a bigger partition with
10GB of free space to avoid space exhaustion issue. For example, creating
/bw/lib/leap, /bw/cache/yum, /bw/cache/dnf directories and making soft link from
/bw/lib/leapp to /var/lib/leap, /bw/cache/yum to /var/cache/yum, /bw/cache/dnf to
/var/cache/dnf:
# rm -rf /var/cache/yum /var/cache/dnf /var/lib/leapp
# mkdir -p /bw/lib/leapp /bw/cache/yum /bw/cache/dnf
# ln -s /bw/lib/leapp /var/lib/leapp
# ln -s /bw/cache/yum /var/cache/yum
# ln -s /bw/cache/dnf /var/cache/dnf

[Link] Update to Latest OS Package

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Update all system packages to the latest versions with Yum.
# yum update -y
When the updates are completed, reboot the system.
# reboot

[Link] Install the Leapp Utility

Install the Leapp utility.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 151 OF 225

 # yum install -y leapp-upgrade

[Link] Temporarily Disable Antivirus Software

Temporarily disable antivirus software to prevent the upgrade from failing.

9.2.5 Run the OS Preupgrade Check

The OS preupgrade check ensures that the system is cleared of issues that might impede
the upgrade. It does not change the system but creates an assessment report that
identifies risks to upgrading. The report also provides recommendations for resolving
those risks.
An operator must ensure that the recommended remedies are completed to clear risks
that are labeled high and can inhibit the upgrade process.

[Link] Grant root SSH Login Permission

Grant root SSH login permissions in the /etc/ssh/sshd_config file.
PermitRootLogin yes

[Link] Run the OS Preupgrade Command

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Run the leapp preupgrade command to start the preupgrade process.
# leapp preupgrade
Example output:
============================================================
UPGRADE INHIBITED
============================================================

Upgrade has been inhibited due to the following problems:

1. Inhibitor: Missing required answers in the answer file
Consult the pre-upgrade report for details and possible remediation.

============================================================
UPGRADE INHIBITED
============================================================

Debug output written to /var/log/leapp/[Link]

============================================================
REPORT
============================================================

A report has been generated at /var/log/leapp/[Link]

A report has been generated at /var/log/leapp/[Link]

============================================================
END OF REPORT
============================================================

Answerfile has been generated at /var/log/leapp/answerfile

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 152 OF 225

 A [Link] file and an answerfile are created, and debug information is saved in
a [Link] log file.

[Link] Examine the Leapp Report

Examine the [Link] file. The report provides a summary of the issues and offers
solutions to resolve them.
# cat /var/log/leapp/[Link]
Identify any high-risk entries marked as Risk Factor: high (inhibitor). These high-risk
entries will prevent an upgrade from completing and must be resolved.
Address the reported high risks, run the preupgrade command again. In the regenerated
report, verify that all serious risks are cleared.
The following are only examples to fix high risk entries, the operator may need to reach
the OS vendor for support:
1) Disable Unused Network Interfaces
Disable unused interfaces on the server, for example eth1, ...
# rm -Rf /etc/sysconfig/network-scripts/ifcfg-eth1
2) Rename Legacy Network Interfaces
Rename legacy interfaces in file /etc/udev/rules.d/[Link], if the file does
not exist, create the file. For example, to rename eth0 to enp0s4, the following line in the
file contains eth0 MAC address (ATTR{address}=="08:00:27:d4:32:87"), but the name
“eth0” ( NAME="eth0" ) is renamed to “enp0s4” (NAME="enp0s4"), make sure the name
does not conflict with another existing network interface name.
SUBSYSTEM=="net", ACTION=="add", DRIVERS=="?*",
ATTR{address}=="08:00:27:d4:32:87", NAME="enp0s4"
Rename /etc/sysconfig/network-scripts/ifcfg-eth0 to /etc/sysconfig/network-scripts/ifcfg-
enp0s4, change the device name in the /etc/sysconfig/network-scripts/ifcfg-enp0s4, for
example “DEVICE=eth0” to “DEVICE=enp0s4”, and make sure eth0 MAC address is
defined, for example “HWADDR=08:00:27:d4:32:87”.
DEVICE=enp0s4
HWADDR=08:00:27:d4:32:87
NM_CONTROLLED=no
BOOTPROTO=dhcp
ONBOOT=yes
PEERDNS=no
When the rename completes, reboot the system.
# reboot
3) Unload the No Longer Supported Kernel Modules
Unload the kernel modules that are no longer supported in RHEL 8.
# lsmod | grep -q pata_acpi && rmmod pata_acpi
4) Increase LEAPP_OVL_SIZE
For any partition that uses XFS with the ftype option set to 0 (check with command:
xfs_info /PATH/TO/DEVICE | grep ftype), Leapp is creating a file of a specific size to
proceed with the upgrade. By default, the size of that file is 2048 MB. In case the size
needs to be increased, Leapp informs you in the pre-upgrade report that the environment
variable needs to be specified. The following example set LEAPP_OVL_SIZE to 3072.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 153 OF 225

 # export LEAPP_OVL_SIZE=3072
5) Remove Unused Third-party Packages
Remove unused third-party packages on the server, for example sysvinit-tools, uname26.
# yum remove sysvinit-tools uname26 -y

[Link] Provide Information to the Leapp Answerfile

In addition to completing the recommendations of /var/log/leapp/[Link], operator
must also provide answers to all the items in /var/log/leapp/answerfile
# cat /var/log/leapp/answerfile
Example output:
[remove_pam_pkcs11_module_check]
# Title: None
# Reason: Confirmation
# =================== remove_pam_pkcs11_module_check.confirm
==================
# Label: Disable pam_pkcs11 module in PAM configuration?
If no, the upgrade process will be interrupted.
# Description: PAM module pam_pkcs11 is no longer available in
OL-8 since it was replaced by SSSD.
# Type: bool
# Default: None
# Available choices: True/False
# Unanswered question. Uncomment the following line with your answer
# confirm =

Based on the example, each verification check is identified with a section heading in
square brackets, such as remove_pam_pkcs11_module_check. The heading is followed
by descriptions of the issue and the valid responses to address the issue.
Run “leapp answer“ command on the specific section that needs correcting. For example,
to confirm the PAM module verification, use the following command:
# leapp answer --section remove_pam_pkcs11_module_check.confirm=True
Verify the answerfile has been modified.
# cat /var/log/leapp/answerfile
Example output:
[remove_pam_pkcs11_module_check]
confirm = True

[Link] Re-run the OS Preupgrade Command

Re-Run the preupgrade command anytime to generate the report files and ensure
required items in the Leapp report and answerfile are addressed.

9.2.6 Upgrade the System

After the /var/log/leapp/answerfile has been properly completed and the
/var/log/leapp/[Link] is verified no longer reports high risks, upgrade the system.

[Link] Verify the Current OS and Kernel Version

For comparison to after the upgrade, verify the current OS and kernel version of the
system.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 154 OF 225

 Check the Red Hat Enterprise Linux version running on the system.
# cat /etc/redhat-release
Check the kernel version used.
# uname -r

[Link] Run the Upgrade Command

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Run the upgrade command with the appropriate command argument.
# leapp upgrade
The upgrade process returns to the command prompt when finished. It takes around 15
minutes.
Example output:
The downloaded packages were saved in cache until the next successful
transaction.
You can remove cached packages by executing 'dnf clean packages'.
==> Processing phase 'InterimPreparation'
====> * efi_interim_fix
Adjust EFI boot entry for first reboot
====> * initram_disk_generator
Creates the upgrade initram disk
====> * add_upgrade_boot_entry
Add new boot entry for Leapp provided initramfs.
A reboot is required to continue. Please reboot your system.

Debug output written to /var/log/leapp/[Link]

============================================================
REPORT
============================================================

A report has been generated at /var/log/leapp/[Link]

A report has been generated at /var/log/leapp/[Link]

============================================================
END OF REPORT
============================================================

Answerfile has been generated at /var/log/leapp/answerfile

NOTE: If operator has not addressed the answerfile items and Risk Factor: high
(inhibitor) entries in the [Link] file, the process will terminate back to command line and
inform about the issues encountered.

[Link] Reboot System

When the upgrade completes, reboot the system.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 155 OF 225

 # reboot
While the system reboots, monitor the progress on the console. At the completion of the
boot process, the utility automatically proceeds with upgrading packages. This operation
takes a while to complete and includes multiple automatic reboots.

9.2.7 Verify the Upgrade

[Link] Examine the Leapp Report

The upgrade process also updates the answerfile, [Link], and creates a leapp-
[Link] log file.
Examine the /var/log/leapp/[Link] and fulfill any important recommendations to
be completed after the upgrade process.

[Link] Verify the New OS and Kernel Version

Verify the system's new OS version, type:
# cat /etc/redhat-release
Red Hat Enterprise Linux release 8.8 (Ootpa)
Check the system's kernel version, type this command to verify that the kernel contains
the el8 substring:
# uname -r
4.18.0-477.27.1.el8_8.x86_64
Identify the system's default kernel contains the el8 substring with the following command:
# grubby --default-kernel
/boot/vmlinuz-4.18.0-477.27.1.el8_8.x86_64
Verify that the correct product is installed:
# subscription-manager list --installed
+-----------------------------------------+
Installed Product Status
+-----------------------------------------+
Product Name: Red Hat Enterprise Linux for x86_64
Product ID: 479
Version: 8.8
Arch: x86_64
Status: Subscribed
Verify that the release version is set to the expected target OS version immediately after
the upgrade. For example:
# subscription-manager release
Release: 8.8

9.2.8 Complete Postupgrade Tasks

[Link] Update DNS server

Edit the /etc/[Link] to make sure DNS servers are present, for example:
search [Link]
nameserver [Link]

[Link] Re-install Removed Packages

Re-install removed packaged and start the related system services:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 156 OF 225

 # dnf install network-scripts xinetd net-snmp initscripts -y
# systemctl start network
# systemctl enable network
# systemctl start xinetd
# systemctl enable xinetd
# systemctl start snmpd
# systemctl enable snmpd

[Link] Remove Remaining Leapp Packages

Edit /etc/dnf/[Link] by removing or commenting out exclude= lines that refer
to leapp packages, for example:
#exclude=python2-leapp,snactor,leapp-upgrade-el7toel8,leapp
Remove all packages from the exclude list:
# dnf config-manager --save --setopt exclude=''

[Link] Remove Remaining RHEL 7 Packages

1) Determine old kernel versions:
# cd /lib/modules && ls -d *.el7*
2) Remove weak modules from the old kernel. If there are multiple old kernels, repeat
the following step for each kernel:
# [ -x /usr/sbin/weak-modules ] && /usr/sbin/weak-modules --remove-
kernel <version>
Replace <version> with the kernel version determined in the previous step, for
example:
# [ -x /usr/sbin/weak-modules ] && /usr/sbin/weak-modules --remove-
kernel 3.10.0-1160.102.1.el7.x86_64

NOTE: Ignore the following error message, which is generated if the kernel
package has been previously removed:

/usr/sbin/weak-modules: line 1081: cd: /lib/modules/<version>/weak-updates: No such file or

directory

3) Remove the old kernel from the boot loader entry. If there are multiple old kernels,
repeat this step for each kernel:
# /bin/kernel-install remove <version> /lib/modules/<version>/vmlinuz
Replace version with the kernel version determined in the previous step, for example:
# /bin/kernel-install remove 3.10.0-1160.102.1.el7.x86_64
/lib/modules/3.10.0-1160.102.1.el7.x86_64/vmlinuz
4) Locate remaining RHEL 7 packages:
# rpm -qa | grep -e '\.el[67]' | grep -vE '^(gpg-
pubkey|libmodulemd|katello-ca-consumer)' | sort
5) Remove remaining RHEL 7 packages, which are determined in the previous step,
and the kernel-workaround package from the RHEL 8 system:
# dnf remove <Packages_from_above_output> -y
# dnf remove kernel-workaround -y
6) Remove remaining Leapp dependency packages:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 157 OF 225

 # dnf remove leapp-deps-el8 leapp-repository-deps-el8 -y
7) Remove any remaining empty directories:
# rm -rf /lib/modules/*el7*
8) Remove all remaining upgrade-related data from the system:
# rm -rf /var/log/leapp /root/tmp_leapp_py3 /var/lib/leapp
# [ -e /bw/lib/leapp ] && rm -rf /bw/lib/leap
# [ -e /bw/cache ] && rm -rf /bw/cache /var/cache/dnf /var/cache/yum

[Link] Disable YUM Repositories Whose Packages are not RHEL 8-Compatible
Disable YUM repositories whose packages are not RHEL 8-compatible. Repositories
managed by RHSM are handled automatically. To disable these repositories:
# dnf config-manager --set-disabled <repository_id>
Replace repository_id with the repository ID. The repository_id can be checked using
command "dnf repolist", for example "epel".
# dnf config-manager --set-disabled epel

[Link] Replace the Old Rescue Kernel and Initial RAM Disk with the Current Kernel and Disk
1) Remove the existing rescue kernel and initial RAM disk:
# rm /boot/vmlinuz-*rescue* /boot/initramfs-*rescue*
2) Reinstall the current kernel to recover the rescue kernel and related initial RAM disk:
# dnf reinstall -y kernel-core-$(uname -r)
3) Verify that the old kernels have been removed from the bootloader entry:
# grubby --info=ALL | grep "\.el7" || echo "Old kernels are not
present in the bootloader."
Old kernels are not present in the bootloader.
4) Verify that the previously removed rescue kernel and rescue initial RAM disk files
have been created for the current kernel:
# ls /boot/vmlinuz-*rescue* /boot/initramfs-*rescue*
/boot/[Link]
/boot/vmlinuz-0-rescue-235879164e60964589a8083599251678

# lsinitrd /boot/initramfs-*rescue*.img | grep -qm1 "$(uname -

r)/kernel/" && echo "OK" || echo "FAIL"
OK
5) Verify the rescue boot entry refers to the existing rescue files. See the grubby output:
# grubby --info $(ls /boot/vmlinuz-*rescue*)
index=1
kernel="/boot/vmlinuz-0-rescue-235879164e60964589a8083599251678"
args="ro crashkernel=auto rhgb quiet"
root="UUID=edd8dba7-198f-4e31-9215-349d0a7637ab"
initrd="/boot/initramfs-0-rescue-
[Link]"
title="Red Hat Enterprise Linux (0-rescue-
235879164e60964589a8083599251678) 8.8 (Ootpa)"
id="235879164e60964589a8083599251678-0-rescue"

[Link] Restore System Configuration Files

Restore system configuration files from backup:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 158 OF 225

 # [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/[Link]
# [ -e /bw/install/[Link] ] && cp /bw/install/20-
[Link] /etc/security/limits.d/[Link]
# [ -e /bw/install/[Link] ] && cp /bw/install/[Link]
/etc/cron.d/sysstat
# [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/snmp/[Link]
# [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/[Link]
# sysctl -p

[Link] Stop NetworkManager

Edit the network script corresponding to the interface for SSH access, for example
/etc/sysconfig/network-scripts/ifcfg-enp0s3, and disable the network manager:
NM_CONTROLLED=no
Stop NetworkManager:
# systemctl stop NetworkManager

[Link] Run BroadWorks Post OS In-place Upgrade Script

Shutdown BroadWorks applications, start config agent and run post OS in-place upgrade
script.
# /usr/local/broadworks/bw_base/bin/[Link]
# sudo -u bworks /usr/local/broadworks/bw_base/bin/configdctl start
# /usr/local/broadworks/bw_base/sbin/[Link]

[Link] Reboot System

Shutdown BroadWorks applications and reboot system.
# /usr/local/broadworks/bw_base/bin/[Link]
# reboot

[Link] Operating System Hardening

If Cisco BroadWorks operating system hardening was enabled on old Linux version, after
OS in-place upgrade, the operator needs to run Cisco BroadWorks operating system
hardening on new Linux version.
# /usr/local/broadworks/bw_base/sbin/[Link] -mode autofix

9.3 CentOS 7 to Oracle Linux 8 In-place Upgrade Procedure

9.3.1 Procedural Steps

1) Run Cisco BroadWorks pre OS in-place upgrade check.
2) Perform a backup.
3) Convert CentOS 7 to Oracle Linux 7.
4) Perform Oracle Linux 7 to Oracle Linux 8 in-place upgrade.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 159 OF 225

 9.3.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check
Run Cisco BroadWorks pre OS in-place upgrade check script with the parameter to
specify which OS version upgrade to, for example if upgrading to Linux 8, the OS version
upgrade to parameter is “8.0”. Make sure pre OS in-place upgrade check is successful. If
the pre OS in-place upgrade check fails, the BroadWorks version either needs to be
upgraded first to support the new OS version, or it is unsupported BroadWorks server, for
example DBS.
$ [Link] 8.0
You are about to run pre OS in-place upgrade check to Linux version
8.0

*********************************************************************
**********
Do you want to continue? (y/n) [n]?y
Starting pre OS in-place Upgrade Check.

Success! Pre OS in-place upgrade check passed!

After resolving all pre OS in-place upgrade check issues, rerun the script and confirm
that there are no issues outstanding.

9.3.3 Perform a Backup

Perform a system backup of Cisco BroadWorks server and store to external location.
$ [Link]
If environment available, take a VM snapshot of Cisco BroadWorks server.

9.3.4 Convert CentOS 7 to Oracle Linux 7

[Link] Check the CentOS Version

Get the version of CentOS.
# cat /etc/redhat-release
# cat /etc/os-release
Both commands show the instance is running CentOS 7.

[Link] Partition /var Size is Too Small

When /var is configured as a partition and the size is too small, for example 2 GB, the OS
in-place upgrade is not possible:
# df -h /var
Filesystem Size Used Avail Use% Mounted on
/dev/sda5 2.0G 1.6G 498M 76% /var
There are two possible methods for fixing the size of the /var partition:
1) Increase the size of /var partition, the recommended /var partition size is 10 GB, the
operator may need to reach the OS vendor for support.
2) If increasing the size of /var partition is not possible, temporarily relocate the
/var/cache/yum, /var/cache/dnf and /var/lib/leapp directories to a bigger partition with
10GB of free space to avoid space exhaustion issue. For example, creating
/bw/lib/leap, /bw/cache/yum, /bw/cache/dnf directories and making soft link from
/bw/lib/leapp to /var/lib/leap, /bw/cache/yum to /var/cache/yum, /bw/cache/dnf to
/var/cache/dnf:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 160 OF 225

 # rm -rf /var/cache/yum /var/cache/dnf /var/lib/leapp
# mkdir -p /bw/lib/leapp /bw/cache/yum /bw/cache/dnf
# ln -s /bw/lib/leapp /var/lib/leapp
# ln -s /bw/cache/yum /var/cache/yum
# ln -s /bw/cache/dnf /var/cache/dnf

[Link] Update to Latest OS Package

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Update all system packages to the latest versions with Yum.
# yum update -y
When the updates are completed, reboot the system.
# reboot

[Link] Download and Run centos2ol Script

Download the [Link] script.
# curl -O
[Link]
Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Run the [Link] script and wait for it to complete.
# bash [Link]

[Link] Reboot System

# reboot

[Link] Confirm System Convert to Oracle Linux

Check the distribution version and kernel details.
# cat /etc/os-release
# cat /etc/oracle-release
# cat /etc/redhat-release
# uname -r

9.3.5 Perform Oracle Linux 7 to Oracle Linux 8 In-place Upgrade

Perform 9.1 Oracle Linux 7 to Oracle Linux 8 In-place Upgrade Procedure excluding the
perform a backup step since the backup has been done in 9.3.3 Perform a Backup.

9.4 CentOS 7 to Red Hat Enterprise Linux 8 In-place Upgrade Procedure

9.4.1 Procedural Steps

1) Run Cisco BroadWorks Pre OS in-place upgrade check.
2) Perform a backup.
3) Convert CentOS 7 to Red Hat Enterprise Linux 7.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 161 OF 225

 4) Perform to Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 in-place
upgrade.

9.4.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check

Run Cisco BroadWorks pre OS in-place upgrade check script with the parameter to
specify which OS version upgrade to, for example if upgrading to Linux 8, the OS version
upgrade to parameter is “8.0”. Make sure pre OS in-place upgrade check is successful. If
the pre OS in-place upgrade check fails, the BroadWorks version either needs to be
upgraded first to support the new OS version, or it is unsupported BroadWorks server, for
example DBS.
$ [Link] 8.0
You are about to run pre OS in-place upgrade check to Linux version
8.0

*********************************************************************
**********
Do you want to continue? (y/n) [n]?y
Starting pre OS in-place Upgrade Check.

Success! Pre OS in-place upgrade check passed!

After resolving all pre OS in-place upgrade check issues, rerun the script and confirm
that there are no issues outstanding.

9.4.3 Perform a Backup

Perform a system backup of Cisco BroadWorks server and store to external location.
$ [Link]
If environment available, take a VM snapshot of Cisco BroadWorks server.

9.4.4 Convert CentOS 7 to Red Hat Enterprise Linux 7

[Link] Check the CentOS Version

Get the version of CentOS.
# cat /etc/redhat-release
# cat /etc/os-release
Both commands show the instance is running CentOS 7.

[Link] Partition /var Size is Too Small

When /var is configured as a partition and the size is too small, for example 2 GB, the OS
in-place upgrade is not possible:
# df -h /var
Filesystem Size Used Avail Use% Mounted on
/dev/sda5 2.0G 1.6G 498M 76% /var
There are two possible methods for fixing the size of the /var partition:
1) Increase the size of /var partition, the recommended /var partition size is 10 GB, the
operator may need to reach the OS vendor for support.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 162 OF 225

 2) If increasing the size of /var partition is not possible, temporarily relocate the
/var/cache/yum, /var/cache/dnf and /var/lib/leapp directories to a bigger partition with
10GB of free space to avoid space exhaustion issue. For example, creating
/bw/lib/leap, /bw/cache/yum, /bw/cache/dnf directories and making soft link from
/bw/lib/leapp to /var/lib/leap, /bw/cache/yum to /var/cache/yum, /bw/cache/dnf to
/var/cache/dnf:
# rm -rf /var/cache/yum /var/cache/dnf /var/lib/leapp
# mkdir -p /bw/lib/leapp /bw/cache/yum /bw/cache/dnf
# ln -s /bw/lib/leapp /var/lib/leapp
# ln -s /bw/cache/yum /var/cache/yum
# ln -s /bw/cache/dnf /var/cache/dnf

[Link] Update to Latest OS Package

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Update all system packages to the latest versions with Yum.
# yum update -y
When the updates are completed, reboot the system.
# reboot

[Link] Install Convert2RHEL

Download the Red Hat GPG key.
# curl -o /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release
[Link]
Download the SSL certificate of the [Link] server, which contains the
Convert2RHEL repositories.
# curl --create-dirs -o /etc/rhsm/ca/[Link]
[Link]
Install the Convert2RHEL repository file.
# curl -o /etc/[Link].d/[Link]
[Link]
Install the Convert2RHEL.
# yum -y install convert2rhel

[Link] Register and Subscribe to a RHEL System

There are two methods of registering and subscribing the system during the conversion:
3) Provide the organization ID and activation key in the /etc/[Link] file. This
method is preferred when converting many systems or when automating the
conversion process using scripts. Ask the organization administrator to create an
activation key.
[subscription_manager]
org = <organization_ID>
activation_key = <activation_key>

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 163 OF 225

 4) Provide the Red Hat Account username and password key in the /etc/[Link]
file. Any user who is accessing RHEL packages using Red Hat CDN (Content
Delivery Network) through RHSM (Red Hat Subscription Management) can use this
method.
[subscription_manager]
username = <username>
password = <password>

[Link] Run the Pre-conversion Analysis

To assess whether the system can be converted to RHEL, run the RHEL pre-conversion
analysis. The pre-conversion analysis generates a report that summarizes potential
problems and suggests recommended solutions.
# export CONVERT2RHEL_DISABLE_TELEMETRY=1
# convert2rhel analyze
After the analysis is complete, review the status and details of each completed test in the
pre-conversion report in the terminal. Non-successful tests contain a description of the
issue, a diagnosis of the possible cause of the issue, and, if applicable, a recommended
remediation.
Example output:

========== Warning (Review and fix if needed) ==========

(WARNING) PACKAGE_UPDATES::PACKAGE_NOT_UP_TO_DATE_MESSAGE - Outdated

packages detected
Description: Please refer to the diagnosis for further information
Diagnosis: The system has 4 package(s) not updated based on the
enabled system repositories.
List of packages to update: openssh-server openssh openssh-clients.

Not updating the packages may cause the conversion to fail.

Consider updating the packages before proceeding with the conversion.
Remediation: [No further information given]

After reviewing the report and resolving all reported issues, rerun the analysis and confirm
that there are no issues outstanding.

[Link] Run Convert2RHEL Utility

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Run convert2rhel utility and wait for it to complete.
# convert2rhel

[Link] Reboot System

Shutdown BroadWorks applications and reboot.
# /usr/local/broadworks/bw_base/bin/[Link]
# reboot

[Link] Remove Third-party Package from Previous OS

Remove third-party packages from the original OS that remained unchanged (typically
packages that do not have a RHEL counterpart). To get a list of these packages, use:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 164 OF 225

 # yum list extras --disablerepo="*" –-enablerepo=<RHEL_RepoID>
Replace RHEL_RepoID with your repository in the above command. The RHEL_RepoID
can be checked using command "yum repolist", for example "rhel-7-server-rpms".
Remove third-party packages from the original OS use:
# yum remove <package name> -y

[Link] Confirm System Switch to Red Hat Enterprise Linux

Check the distribution version and kernel details.
# cat /etc/os-release
# cat /etc/redhat-release
# uname -r

9.4.5 Perform Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 In-place
Upgrade
Perform 9.2 Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 In-place Upgrade
Procedure excluding the perform a backup step since the backup has been done in 9.4.3
Perform a Backup.

9.5 Oracle Linux 8 to Oracle Linux 9 In-place Upgrade Procedure

9.5.1 Procedural Steps

1) Run Cisco BroadWorks pre OS in-place upgrade check.
2) Perform a backup.
3) Prepare for the upgrade.
4) Run the preupgrade check.
5) Upgrade the system.
6) Verify the upgrade.
7) Complete postupgrade tasks.

9.5.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check

Run Cisco BroadWorks pre OS in-place upgrade check script with the parameter to
specify which OS version upgrade to, for example if upgrading to Linux 8, the OS version
upgrade to parameter is “8.0”. Make sure pre OS in-place upgrade check is successful. If
the pre OS in-place upgrade check fails, the BroadWorks version either needs to be
upgraded first to support the new OS version, or it is unsupported BroadWorks server, for
example DBS.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 165 OF 225

 $ [Link] 9.0
You are about to run pre OS in-place upgrade check to Linux version
9.0

*********************************************************************
**********
Do you want to continue? (y/n) [n]?y
Starting pre OS in-place Upgrade Check.

Success! Pre OS in-place upgrade check passed!

After resolving all pre OS in-place upgrade check issues, rerun the script and confirm
that there are no issues outstanding.

9.5.3 Perform a Backup

Perform a system backup of Cisco BroadWorks server and store to external location.
$ [Link]
Perform a backup of system configuration file.
# cp /etc/security/limits.d/[Link] /bw/install/20-
[Link]
# cp /etc/cron.d/sysstat /bw/install/[Link]
# cp /etc/snmp/[Link] /bw/install/[Link]
If environment available, take a VM snapshot of Cisco BroadWorks server.

9.5.4 Prepare for the Upgrade

[Link] Migrate Legacy Network Scripts

Edit the network script corresponding to the interface for SSH access, for example
/etc/sysconfig/network-scripts/ifcfg-enp0s3, enable the network manager and add DNS
servers if they are not present. In the following example, replace the DNS server IP
address “[Link]” with actual DNS IP address:
NM_CONTROLLED=yes
DNS1=[Link]
Start NetworkManager:
# systemctl enable NetworkManager
# systemctl start NetworkManager
Reboot system:
# reboot
Migrate legacy network scripts with the following command.
# nmcli connection migrate

[Link] Update DNS server

Edit the /etc/[Link] to make sure DNS servers are present, for example:
search [Link]
nameserver [Link]

[Link] Verify the System Locale

Verify that the system locale is set to en_US.UTF-8.
# cat /etc/[Link]
If the locale is not set correctly, use the following command to configure it.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 166 OF 225

 # localectl set-locale LANG=en_US.UTF-8

[Link] Disable root SSH Login Permission

Ensure that SSH root login is disabled in the /etc/ssh/sshd_config file by verifying that the
comment mark (#) is at the beginning of the following line, as shown.
#PermitRootLogin yes

[Link] Disable AllowZoneDrifting in the Firewall Configuration

Disable AllowZoneDrifting in the firewall configuration file to prevent the Leapp upgrade
from being blocked.
# sed -i "s/^AllowZoneDrifting=.*/AllowZoneDrifting=no/"
/etc/firewalld/[Link]

[Link] Remove the Versionlock Plugin

The Versionlock plugin is a plugin that holds back packages from being upgraded to
newer versions. If the plugins used to lock packages to a specific version, clear the lock as
shown:
# dnf versionlock clear

[Link] Partition /var Size is Too Small

When /var is configured as a partition and the size is too small, for example 2 GB, the OS
in-place upgrade is not possible:
# df -h /var
Filesystem Size Used Avail Use% Mounted on
/dev/sda5 2.0G 1.6G 498M 76% /var
There are two possible methods for fixing the size of the /var partition:
1) Increase the size of /var partition, the recommended /var partition size is 10 GB, the
operator may need to reach the OS vendor for support.
2) If increasing the size of /var partition is not possible, temporarily relocate the
/var/cache/yum, /var/cache/dnf and /var/lib/leapp directories to a bigger partition with
10GB of free space to avoid space exhaustion issue. For example, creating
/bw/lib/leap, /bw/cache/yum, /bw/cache/dnf directories and making soft link from
/bw/lib/leapp to /var/lib/leap, /bw/cache/yum to /var/cache/yum, /bw/cache/dnf to
/var/cache/dnf:
# rm -rf /var/cache/yum /var/cache/dnf /var/lib/leapp
# mkdir -p /bw/lib/leapp /bw/cache/yum /bw/cache/dnf
# ln -s /bw/lib/leapp /var/lib/leapp
# ln -s /bw/cache/yum /var/cache/yum
# ln -s /bw/cache/dnf /var/cache/dnf

[Link] Update to Latest OS Package

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Update all system packages to the latest versions with Yum.
# dnf update -y
When the updates are completed, reboot the system.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 167 OF 225

 # reboot

[Link] Install the Leapp Utility

Install the Leapp utility and its supporting repositories.
# dnf install -y leapp-upgrade

[Link] Temporarily Disable Antivirus Software

Temporarily disable antivirus software to prevent the upgrade from failing.

9.5.5 Run the OS Preupgrade Check

The OS preupgrade check ensures that the system is cleared of issues that might impede
the upgrade. It does not change the system but creates an assessment report that
identifies risks to upgrading. The report also provides recommendations for resolving
those risks.
An operator must ensure that the recommended remedies are completed to clear risks
that are labeled high and can inhibit the upgrade process.

[Link] Run the OS Preupgrade Command

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Run the leapp preupgrade command to start the preupgrade process.
# leapp preupgrade --oraclelinux
Example output:
============================================================
UPGRADE INHIBITED
============================================================

Upgrade has been inhibited due to the following problems:

1. Inhibitor: Missing required answers in the answer file
Consult the pre-upgrade report for details and possible remediation.

============================================================
UPGRADE INHIBITED
============================================================

Debug output written to /var/log/leapp/[Link]

============================================================
REPORT
============================================================

A report has been generated at /var/log/leapp/[Link]

A report has been generated at /var/log/leapp/[Link]

============================================================
END OF REPORT
============================================================

Answerfile has been generated at /var/log/leapp/answerfile

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 168 OF 225

 A [Link] file and an answerfile are created, and debug information is saved in
a [Link] log file.

[Link] Examine the Leapp Report

Examine the [Link] file. The report provides a summary of the issues and offers
solutions to resolve them.
# cat /var/log/leapp/[Link]
Identify any high-risk entries marked as Risk Factor: high (inhibitor). These high-risk
entries will prevent an upgrade from completing and must be resolved.
Address the reported high risks, run the preupgrade command again. In the regenerated
report, verify that all serious risks are cleared.
The following are only examples to fix high risk entries, the operator may need to reach
the OS vendor for support:
1) Disable Unused Network Interfaces
Disable unused interfaces on the server, for example eth1, ...
# rm -Rf /etc/sysconfig/network-scripts/ifcfg-eth1
2) Install the “vdo” Package.
# dnf install -y vdo
3) Set LEAPP_OVL_IMG_FS_EXT4
# export LEAPP_OVL_IMG_FS_EXT4=1
4) Remove Unused Third-party Packages
Remove unused third-party packages on the server, for example sysvinit-tools, uname26.
# yum remove sysvinit-tools uname26 -y

[Link] Provide Information to the Leapp Answerfile

In addition to completing the recommendations of /var/log/leapp/[Link], operator
must also provide answers to all the items in /var/log/leapp/answerfile
# cat /var/log/leapp/answerfile
Example output:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 169 OF 225

 [check_vdo]
# Title: None
# Reason: Confirmation
# ============================= check_vdo.confirm
=============================
# Label: Are all VDO devices, if any, successfully
converted to LVM management?
# Description: Enter True if no VDO devices are present on the
system or all VDO devices on the system have been successfully
converted to LVM management. Entering True will circumvent check of
failures and undetermined devices. Recognized VDO devices that have
not been converted to LVM management can still block the upgrade
despite the [Link] VDO devices must be converted to LVM
management before upgrading.
# Reason: To maximize safety all block devices on a
system that meet the criteria as possible VDO devices are checked to
verify that, if VDOs, they have been converted to LVM management. If
the devices are not converted and the upgrade proceeds the data on
unconverted VDO devices will be inaccessible. In order to perform
checking the 'vdo' package must be installed. If the 'vdo' package is
not installed and there are any doubts the 'vdo' package should be
installed and the upgrade process re-run to check for unconverted VDO
devices. If the check of any device fails for any reason an upgrade
inhibiting report is generated. This may be problematic if devices
are dynamically removed from the system subsequent to having been
identified during device discovery. If it is certain that all VDO
devices have been successfully converted to LVM management this
dialog may be answered in the affirmative which will circumvent block
device checking.
# Type: bool
# Default: None
# Available choices: True/False
# Unanswered question. Uncomment the following line with your answer
# confirm =

Based on the example, each verification check is identified with a section heading in
square brackets, such as check_vdo. The heading is followed by descriptions of the issue
and the valid responses to address the issue.
Run “leapp answer“ command on the specific section that needs correcting. For example,
to confirm a True response to the question “Are all VDO devices, if any, successfully
converted to LVM management?”, use the following command:
# leapp answer --section check_vdo.confirm=True
Verify the answerfile has been modified.
# cat /var/log/leapp/answerfile
Example output:
[check_vdo]
confirm = True

[Link] Re-run the OS Preupgrade Command

Re-Run the preupgrade command anytime to generate the report files and ensure
required items in the Leapp report and answerfile are addressed.

9.5.6 Upgrade the System

After the /var/log/leapp/answerfile has been properly completed and the
/var/log/leapp/[Link] is verified no longer reports high risks, upgrade the system.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 170 OF 225

 [Link] Verify the Current OS and Kernel Version
For comparison to after the upgrade, verify the current OS and kernel version of the
system.
Check the Oracle Linux version running on the system.
# cat /etc/oracle-release
Check the kernel version used.
# uname -r

[Link] Run the Upgrade Command

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Run the upgrade command with the appropriate command argument.
# leapp upgrade --oraclelinux
The upgrade process returns to the command prompt when finished. It takes around 15
minutes.
Example output:
The downloaded packages were saved in cache until the next successful
transaction.
You can remove cached packages by executing 'dnf clean packages'.
==> Processing phase 'InterimPreparation'
====> * efi_interim_fix
Adjust EFI boot entry for first reboot
====> * initram_disk_generator
Creates the upgrade initram disk
====> * add_upgrade_boot_entry
Add new boot entry for Leapp provided initramfs.
A reboot is required to continue. Please reboot your system.

Debug output written to /var/log/leapp/[Link]

============================================================
REPORT
============================================================

A report has been generated at /var/log/leapp/[Link]

A report has been generated at /var/log/leapp/[Link]

============================================================
END OF REPORT
============================================================

Answerfile has been generated at /var/log/leapp/answerfile

NOTE: If operator has not addressed the answerfile items and Risk Factor: high
(inhibitor) entries in the [Link] file, the process will terminate back to command line and
inform about the issues encountered.

[Link] Reboot System

When the upgrade completes, reboot the system.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 171 OF 225

 # reboot
While the system reboots, monitor the progress on the console. At the completion of the
boot process, the utility automatically proceeds with upgrading packages. This operation
takes a while to complete and includes multiple automatic reboots.

9.5.7 Verify the Upgrade

[Link] Examine the Leapp Report

The upgrade process also updates the answerfile, [Link], and creates a leapp-
[Link] log file.
Examine the /var/log/leapp/[Link] and fulfill any important recommendations to
be completed after the upgrade process.

[Link] Verify the New OS and Kernel Version

Verify the system's new OS version, type:
# cat /etc/oracle-release
Oracle Linux Server release 9.2
Check the system's kernel version, type this command to verify that the kernel contains
the el9 substring:
# uname -r
5.15.0-200.131.27.el9uek.x86_64
Identify the system's default kernel contains the el9 substring with the following command:
# grubby --default-kernel
/boot/vmlinuz-5.15.0-200.131.27.el9uek.x86_64

9.5.8 Complete Postupgrade Tasks

[Link] Re-install Removed Packages

Re-install removed packaged and start the related system services:
# dnf install net-snmp initscripts -y
# systemctl start snmpd
# systemctl enable snmpd

[Link] Remove Residual Packages and Files from the Previous Oracle Linux
1) Edit /etc/dnf/[Link] by removing or commenting out exclude= lines that refer
to leapp packages, for example:
#exclude=snactor,leapp-upgrade-el8toel9,python3-leapp,leapp
2) Remove all packages from the exclude list:
# dnf config-manager --save --setopt exclude=''
3) Use commands such as rpm -qa to list packages that can be removed:
# rpm -qa | grep el8
# rpm -qa | grep leapp
4) Use the dnf remove command to remove the packages listed by the queries.
# dnf remove <package name> -y
5) Remove all remaining upgrade-related data from the system:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 172 OF 225

 # rm -rf /var/log/leapp /root/tmp_leapp_py3 /var/lib/leapp
# [ -e /bw/lib/leapp ] && rm -rf /bw/lib/leap
# [ -e /bw/cache ] && rm -rf /bw/cache /var/cache/dnf /var/cache/yum

[Link] Disable Command not Available in /etc/virc

Edit /etc/virc and comment the command which is not available in OL 9: “let
skip_defaults_vim=1”:
" let skip_defaults_vim=1

[Link] Restore System Configuration Files

Restore system configuration files from backup:
# [ -e /bw/install/[Link] ] && cp /bw/install/20-
[Link] /etc/security/limits.d/[Link]
# [ -e /bw/install/[Link] ] && cp /bw/install/[Link]
/etc/cron.d/sysstat
# [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/snmp/[Link]
# sysctl -p

[Link] Run BroadWorks Post OS In-place Upgrade Script

Shutdown BroadWorks applications, start config agent and run post OS in-place upgrade
script.
# /usr/local/broadworks/bw_base/bin/[Link]
# sudo -u bworks /usr/local/broadworks/bw_base/bin/configdctl start
# /usr/local/broadworks/bw_base/sbin/[Link]

[Link] Reboot System

Shutdown BroadWorks applications and reboot system.
# /usr/local/broadworks/bw_base/bin/[Link]
# reboot

[Link] Operating System Hardening

If Cisco BroadWorks operating system hardening was enabled on old Linux version, after
OS in-place upgrade, the operator needs to run Cisco BroadWorks operating system
hardening on new Linux version.
# /usr/local/broadworks/bw_base/sbin/[Link] -mode autofix

9.6 Red Hat Enterprise Linux 8 to Red Hat Enterprise Linux 9 In-place Upgrade
Procedure

9.6.1 Procedural Steps

1) Run Cisco BroadWorks pre OS in-place upgrade check.
2) Perform a backup.
3) Prepare for the upgrade.
4) Run the preupgrade check.
5) Upgrade the system.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 173 OF 225

 6) Verify the upgrade.
7) Complete postupgrade tasks.

9.6.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check

Run Cisco BroadWorks pre OS in-place upgrade check script with the parameter to
specify which OS version upgrade to, for example if upgrading to Linux 8, the OS version
upgrade to parameter is “8.0”. Make sure pre OS in-place upgrade check is successful. If
the pre OS in-place upgrade check fails, the BroadWorks version either needs to be
upgraded first to support the new OS version, or it is unsupported BroadWorks server, for
example DBS.
$ [Link] 9.0
You are about to run pre OS in-place upgrade check to Linux version
9.0

*********************************************************************
**********
Do you want to continue? (y/n) [n]?y
Starting pre OS in-place Upgrade Check.

Success! Pre OS in-place upgrade check passed!

After resolving all pre OS in-place upgrade check issues, rerun the script and confirm
that there are no issues outstanding.

9.6.3 Perform a Backup

Perform a system backup of Cisco BroadWorks server and store to external location.
$ [Link]
Perform a backup of system configuration file.
# cp /etc/security/limits.d/[Link] /bw/install/20-
[Link]
# cp /etc/cron.d/sysstat /bw/install/[Link]
# cp /etc/snmp/[Link] /bw/install/[Link]
If environment available, take a VM snapshot of Cisco BroadWorks server.

9.6.4 Prepare for the Upgrade

[Link] Migrate Legacy Network Scripts

Edit the network script corresponding to the interface for SSH access, for example
/etc/sysconfig/network-scripts/ifcfg-enp0s3, enable the network manager and add DNS
servers if they are not present. In the following example, replace the DNS server IP
address “[Link]” with actual DNS IP address:
NM_CONTROLLED=yes
DNS1=[Link]
Start NetworkManager:
# systemctl enable NetworkManager
# systemctl start NetworkManager
Reboot system:
# reboot
Migrate legacy network scripts with the following command.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 174 OF 225

 # nmcli connection migrate

[Link] Update DNS server

Edit the /etc/[Link] to make sure DNS servers are present, for example:
search [Link]
nameserver [Link]

[Link] Verify the System Locale

Verify that the system locale is set to en_US.UTF-8.
# cat /etc/[Link]
If the locale is not set correctly, use the following command to configure it.
# localectl set-locale LANG=en_US.UTF-8

[Link] Disable root SSH Login Permission

Ensure that SSH root login is disabled in the /etc/ssh/sshd_config file by verifying that the
comment mark (#) is at the beginning of the following line, as shown.
#PermitRootLogin yes

[Link] Disable AllowZoneDrifting in the Firewall Configuration

Disable AllowZoneDrifting in the firewall configuration file to prevent the Leapp upgrade
from being blocked.
# sed -i "s/^AllowZoneDrifting=.*/AllowZoneDrifting=no/"
/etc/firewalld/[Link]

[Link] Verify that the System is Subscribed Using Subscription-Manager

Check if there is a Red Hat Enterprise Linux Server subscription attached to the system.
# subscription-manager list --installed
+-------------------------------------------+
Installed Product Status
+-------------------------------------------+
Product Name: Red Hat Enterprise Linux for x86_64
Product ID: 479
Version: 8.8
Arch: x86_64
Status: Subscribed
Status Details:
If not, attach a subscription using the following command.
# subscription-manager register
# subscription-manager attach --auto

[Link] Enable RHEL 8 ‘Base & Extra’ Repositories

# subscription-manager repos --enable rhel-8-for-x86_64-baseos-rpms -
-enable rhel-8-for-x86_64-appstream-rpms

[Link] Set the System Release Version

For systems subscribed using RHSM, lock the system to the desired source OS version.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 175 OF 225

 # subscription-manager release --set <source_os_version>
Replace <source_os_version> with the OS product version determined in the previous
step, for example.
# subscription-manager release --set 8.8

[Link] Remove the Versionlock Plugin

The Versionlock plugin is a plugin that holds back packages from being upgraded to
newer versions. If the plugins used to lock packages to a specific version, clear the lock as
shown:
# dnf versionlock clear

[Link] Partition /var Size is Too Small

When /var is configured as a partition and the size is too small, for example 2 GB, the OS
in-place upgrade is not possible:
# df -h /var
Filesystem Size Used Avail Use% Mounted on
/dev/sda5 2.0G 1.6G 498M 76% /var
There are two possible methods for fixing the size of the /var partition:
1) Increase the size of /var partition, the recommended /var partition size is 10 GB, the
operator may need to reach the OS vendor for support.
2) If increasing the size of /var partition is not possible, temporarily relocate the
/var/cache/yum, /var/cache/dnf and /var/lib/leapp directories to a bigger partition with
10GB of free space to avoid space exhaustion issue. For example, creating
/bw/lib/leap, /bw/cache/yum, /bw/cache/dnf directories and making soft link from
/bw/lib/leapp to /var/lib/leap, /bw/cache/yum to /var/cache/yum, /bw/cache/dnf to
/var/cache/dnf:
# rm -rf /var/cache/yum /var/cache/dnf /var/lib/leapp
# mkdir -p /bw/lib/leapp /bw/cache/yum /bw/cache/dnf
# ln -s /bw/lib/leapp /var/lib/leapp
# ln -s /bw/cache/yum /var/cache/yum
# ln -s /bw/cache/dnf /var/cache/dnf

[Link] Update to Latest OS Package

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Update all system packages to the latest versions with Dnf.
# dnf update -y
When the updates are completed, reboot the system.
# reboot

[Link] Install the Leapp Utility

Install the Leapp utility.
# dnf install -y leapp-upgrade

[Link] Temporarily Disable Antivirus Software

Temporarily disable antivirus software to prevent the upgrade from failing.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 176 OF 225

 9.6.5 Run the OS Preupgrade Check
The OS preupgrade check ensures that the system is cleared of issues that might impede
the upgrade. It does not change the system but creates an assessment report that
identifies risks to upgrading. The report also provides recommendations for resolving
those risks.
An operator must ensure that the recommended remedies are completed to clear risks
that are labeled high and can inhibit the upgrade process.

[Link] Run the OS Preupgrade Command

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Run the leapp preupgrade command to start the preupgrade process.
# leapp preupgrade
Example output:
============================================================
UPGRADE INHIBITED
============================================================

Upgrade has been inhibited due to the following problems:

1. Inhibitor: Missing required answers in the answer file
Consult the pre-upgrade report for details and possible remediation.

============================================================
UPGRADE INHIBITED
============================================================

Debug output written to /var/log/leapp/[Link]

============================================================
REPORT
============================================================

A report has been generated at /var/log/leapp/[Link]

A report has been generated at /var/log/leapp/[Link]

============================================================
END OF REPORT
============================================================

Answerfile has been generated at /var/log/leapp/answerfile

A [Link] file and an answerfile are created, and debug information is saved in
a [Link] log file.

[Link] Examine the Leapp Report

Examine the [Link] file. The report provides a summary of the issues and offers
solutions to resolve them.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 177 OF 225

 # cat /var/log/leapp/[Link]
Identify any high-risk entries marked as Risk Factor: high (inhibitor). These high-risk
entries will prevent an upgrade from completing and must be resolved.
Address the reported high risks, run the preupgrade command again. In the regenerated
report, verify that all serious risks are cleared.
The following are only examples to fix high risk entries, the operator may need to reach
the OS vendor for support:
1) Disable Unused Network Interfaces
Disable unused interfaces on the server, for example eth1, ...
# rm -Rf /etc/sysconfig/network-scripts/ifcfg-eth1
2) Install the “vdo” Package.
# dnf install -y vdo
3) Increase LEAPP_OVL_SIZE
For any partition that uses XFS with the ftype option set to 0 (check with command:
xfs_info /PATH/TO/DEVICE | grep ftype), Leapp is creating a file of a specific size to
proceed with the upgrade. By default, the size of that file is 2048 MB. In case the size
needs to be increased, Leapp informs you in the pre-upgrade report that the environment
variable needs to be specified. The following example set LEAPP_OVL_SIZE to 3072.
# export LEAPP_OVL_SIZE=3072
4) Remove Unused Third-party Packages
Remove unused third-party packages on the server, for example sysvinit-tools, uname26.
# yum remove sysvinit-tools uname26 -y

[Link] Provide Information to the Leapp Answerfile

In addition to completing the recommendations of /var/log/leapp/[Link], operator
must also provide answers to all the items in /var/log/leapp/answerfile
# cat /var/log/leapp/answerfile
Example output:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 178 OF 225

 [check_vdo]
# Title: None
# Reason: Confirmation
# ============================= check_vdo.confirm
=============================
# Label: Are all VDO devices, if any, successfully
converted to LVM management?
# Description: Enter True if no VDO devices are present on the
system or all VDO devices on the system have been successfully
converted to LVM management. Entering True will circumvent check of
failures and undetermined devices. Recognized VDO devices that have
not been converted to LVM management can still block the upgrade
despite the [Link] VDO devices must be converted to LVM
management before upgrading.
# Reason: To maximize safety all block devices on a
system that meet the criteria as possible VDO devices are checked to
verify that, if VDOs, they have been converted to LVM management. If
the devices are not converted and the upgrade proceeds the data on
unconverted VDO devices will be inaccessible. In order to perform
checking the 'vdo' package must be installed. If the 'vdo' package is
not installed and there are any doubts the 'vdo' package should be
installed and the upgrade process re-run to check for unconverted VDO
devices. If the check of any device fails for any reason an upgrade
inhibiting report is generated. This may be problematic if devices
are dynamically removed from the system subsequent to having been
identified during device discovery. If it is certain that all VDO
devices have been successfully converted to LVM management this
dialog may be answered in the affirmative which will circumvent block
device checking.
# Type: bool
# Default: None
# Available choices: True/False
# Unanswered question. Uncomment the following line with your answer
# confirm =

Based on the example, each verification check is identified with a section heading in
square brackets, such as check_vdo. The heading is followed by descriptions of the issue
and the valid responses to address the issue.
Run “leapp answer“ command on the specific section that needs correcting. For example,
to confirm a True response to the question “Are all VDO devices, if any, successfully
converted to LVM management?”, use the following command:
# leapp answer --section check_vdo.confirm=True
Verify the answerfile has been modified.
# cat /var/log/leapp/answerfile
Example output:
[check_vdo]
confirm = True

[Link] Re-run the OS Preupgrade Command

Re-Run the preupgrade command anytime to generate the report files and ensure
required items in the Leapp report and answerfile are addressed.

9.6.6 Upgrade the System

After the /var/log/leapp/answerfile has been properly completed and the
/var/log/leapp/[Link] is verified no longer reports high risks, upgrade the system.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 179 OF 225

 [Link] Verify the Current OS and Kernel Version
For comparison to after the upgrade, verify the current OS and kernel version of the
system.
Check the Red Hat Enterprise Linux version running on the system.
# cat /etc/redhat-release
Check the kernel version used.
# uname -r

[Link] Run the Upgrade Command

Shutdown BroadWorks applications.
# /usr/local/broadworks/bw_base/bin/[Link]
Run the upgrade command with the appropriate command argument.
# leapp upgrade
The upgrade process returns to the command prompt when finished. It takes around 15
minutes.
Example output:
The downloaded packages were saved in cache until the next successful
transaction.
You can remove cached packages by executing 'dnf clean packages'.
==> Processing phase 'InterimPreparation'
====> * efi_interim_fix
Adjust EFI boot entry for first reboot
====> * initram_disk_generator
Creates the upgrade initram disk
====> * add_upgrade_boot_entry
Add new boot entry for Leapp provided initramfs.
A reboot is required to continue. Please reboot your system.

Debug output written to /var/log/leapp/[Link]

============================================================
REPORT
============================================================

A report has been generated at /var/log/leapp/[Link]

A report has been generated at /var/log/leapp/[Link]

============================================================
END OF REPORT
============================================================

Answerfile has been generated at /var/log/leapp/answerfile

NOTE: If operator has not addressed the answerfile items and Risk Factor: high
(inhibitor) entries in the [Link] file, the process will terminate back to command line and
inform about the issues encountered.

[Link] Reboot System

When the upgrade completes, reboot the system.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 180 OF 225

 # reboot
While the system reboots, monitor the progress on the console. At the completion of the
boot process, the utility automatically proceeds with upgrading packages. This operation
takes a while to complete and includes multiple automatic reboots.

9.6.7 Verify the Upgrade

[Link] Examine the Leapp Report

The upgrade process also updates the answerfile, [Link], and creates a leapp-
[Link] log file.
Examine the /var/log/leapp/[Link] and fulfill any important recommendations to
be completed after the upgrade process.

[Link] Verify the New OS and Kernel Version

Verify the system's new OS version:
# cat /etc/redhat-release
Red Hat Enterprise Linux release 9.2 (Plow)
Check the system's kernel version, type this command to verify that the kernel contains
the el9 substring:
# uname -r
5.14.0-284.30.1.el9_2.x86_64
Identify the system's default kernel contains the el substring with the following command:
# grubby --default-kernel
/boot/vmlinuz-5.14.0-284.30.1.el9_2.x86_64
Verify that the correct product is installed:
# subscription-manager list --installed
+-----------------------------------------+
Installed Product Status
+-----------------------------------------+
Product Name: Red Hat Enterprise Linux for x86_64
Product ID: 479
Version: 9.2
Arch: x86_64
Status: Subscribed
Verify that the release version is set to the expected target OS version immediately after
the upgrade. For example:
# subscription-manager release
Release: 9.2

9.6.8 Complete Postupgrade Tasks

[Link] Re-install Removed Packages

Re-install removed packaged and start the related system services:
# dnf install net-snmp initscripts -y
Edit /etc/snmp/[Link] by adding square brackets around the ipv6 localhost address,
for example “udp6:::1:161” to “udp6:[::1]:161”:
agentAddress udp:[Link]:161,udp6:[::1]:161
Start the related system services:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 181 OF 225

 # systemctl start snmpd
# systemctl enable snmpd

[Link] Remove Remaining Leapp Packages

Edit /etc/dnf/[Link] by removing or commenting out exclude= lines that refer
to leapp packages, for example:
#exclude=leapp-upgrade-el8toel9,leapp,snactor,python3-leapp
Remove all packages from the exclude list:
# dnf config-manager --save --setopt exclude=''

[Link] Remove Remaining RHEL 8 Packages

1) Locate remaining RHEL 8 packages:
# rpm -qa | grep -e '\.el[78]' | grep -vE '^(gpg-
pubkey|libmodulemd|katello-ca-consumer)' | sort
2) Remove remaining RHEL 8 packages, which are determined in the previous step,
from the RHEL 9 system:
# dnf remove <Packages_from_above_output> -y
3) Remove remaining Leapp dependency packages:
# dnf remove leapp-deps-el9 leapp-repository-deps-el9 -y
4) Remove all remaining upgrade-related data from the system:
# rm -rf /var/log/leapp /root/tmp_leapp_py3 /var/lib/leapp
# [ -e /bw/lib/leapp ] && rm -rf /bw/lib/leap
# [ -e /bw/cache ] && rm -rf /bw/cache /var/cache/dnf /var/cache/yum

[Link] Disable DNF Repositories Whose Packages are not RHEL 9-Compatible
Disable DNF repositories whose packages are not RHEL 9-compatible. Repositories
managed by RHSM are handled automatically. To disable these repositories:
# dnf config-manager --set-disabled <repository_id>
Replace repository_id with the repository ID. The repository_id can be checked using
command "dnf repolist", for example "rhel-8-for-x86_64-baseos-rpms".

[Link] Disable Command not Available in /etc/virc

Edit /etc/virc and comment the command which is not available in RHEL 9: “let
skip_defaults_vim=1”:
" let skip_defaults_vim=1

[Link] Replace the Old Rescue Kernel and Initial RAM Disk with the Current Kernel and Disk
1) Remove the existing rescue kernel and initial RAM disk:
# rm /boot/vmlinuz-*rescue* /boot/initramfs-*rescue*
2) Reinstall the current kernel to recover the rescue kernel and related initial RAM disk:
# dnf reinstall -y kernel-core-$(uname -r)
3) Verify that the previously removed rescue kernel and rescue initial RAM disk files
have been created for the current kernel:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 182 OF 225

 # ls /boot/vmlinuz-*rescue* /boot/initramfs-*rescue*
/boot/[Link]
/boot/vmlinuz-0-rescue-8e06e9cddaa74e17a0e744973f3e1236

# lsinitrd /boot/initramfs-*rescue*.img | grep -qm1 "$(uname -

r)/kernel/" && echo "OK" || echo "FAIL"
OK
4) Verify the rescue boot entry refers to the existing rescue files. See the grubby output:
# grubby --info $(ls /boot/vmlinuz-*rescue*)
index=1
kernel="/boot/vmlinuz-0-rescue-861ad08029aefc4aa03dc83d9001b448"
args="ro crashkernel=auto spectre_v2=retpoline
[Link]=VolGroup/lv_root [Link]=VolGroup/lv_swap rhgb quiet
transparent_hugepage=never [Link]=0 [Link]=0 selinux=0"
root="/dev/mapper/VolGroup-lv_root"
initrd="/boot/initramfs-0-rescue-
[Link]"
title="Red Hat Enterprise Linux (0-rescue-
861ad08029aefc4aa03dc83d9001b448) 9.2 (Plow)"
id="861ad08029aefc4aa03dc83d9001b448-0-rescue"

[Link] Restore System Configuration Files

Restore system configuration files from backup:
# [ -e /bw/install/[Link] ] && cp /bw/install/20-
[Link] /etc/security/limits.d/[Link]
# [ -e /bw/install/[Link] ] && cp /bw/install/[Link]
/etc/cron.d/sysstat
# [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/snmp/[Link]
# sysctl -p

[Link] Run BroadWorks Post OS In-place Upgrade Script

Shutdown BroadWorks applications, start config agent and run post OS in-place upgrade
script.
# /usr/local/broadworks/bw_base/bin/[Link]
# sudo -u bworks /usr/local/broadworks/bw_base/bin/configdctl start
# /usr/local/broadworks/bw_base/sbin/[Link]

[Link] Reboot System

Shutdown BroadWorks applications and reboot system.
# /usr/local/broadworks/bw_base/bin/[Link]
# reboot

[Link] Operating System Hardening

If Cisco BroadWorks operating system hardening was enabled on old Linux version, after
OS in-place upgrade, the operator needs to run Cisco BroadWorks operating system
hardening on new Linux version.
# /usr/local/broadworks/bw_base/sbin/[Link] -mode autofix

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 183 OF 225

 9.7 Offline Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 In-place
Upgrade Procedure
When there is no direct connection to the Internet for Cisco BroadWorks server, it is
possible to run Cisco BroadWorks OS in-place upgrade offline. This section illustrates the
steps for offline Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 in-place
upgrade.

9.7.1 Procedural Steps

1) Run Cisco BroadWorks pre OS in-place upgrade check.
2) Perform a backup.
3) Prepare for the upgrade.
4) Run the preupgrade check.
5) Upgrade the system.
6) Verify the upgrade.
7) Complete postupgrade tasks.

9.7.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check

Run Cisco BroadWorks pre OS in-place upgrade check script with the parameter to
specify which OS version upgrade to, for example if upgrading to Linux 8, the OS version
upgrade to parameter is “8.0”. Make sure pre OS in-place upgrade check is successful. If
the pre OS in-place upgrade check fails, the BroadWorks version either needs to be
upgraded first to support the new OS version, or it is unsupported BroadWorks server, for
example DBS.
[offline system] $ [Link] 8.0
You are about to run pre OS in-place upgrade check to Linux version
8.0

*********************************************************************
**********
Do you want to continue? (y/n) [n]?y
Starting pre OS in-place Upgrade Check.

Success! Pre OS in-place upgrade check passed!

After resolving all pre OS in-place upgrade check issues, rerun the script and confirm
that there are no issues outstanding.

9.7.3 Perform a Backup

Perform a system backup of Cisco BroadWorks server and store to external location.
[offline system] $ [Link]
Perform a backup of system configuration file.
[offline system] # cp /etc/[Link] /bw/install/[Link]
[offline system] # cp /etc/security/limits.d/[Link]
/bw/install/[Link]
[offline system] # cp /etc/cron.d/sysstat /bw/install/[Link]
[offline system] # cp /etc/snmp/[Link]
/bw/install/[Link]
[offline system] # cp /etc/[Link] /bw/install/[Link]
If environment available, take a VM snapshot of Cisco BroadWorks server.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 184 OF 225

 9.7.4 Prepare for the Upgrade

[Link] Start NetworkManager

Edit the network script corresponding to the interface for SSH access, for example
/etc/sysconfig/network-scripts/ifcfg-enp0s3, enable the network manager and add DNS
servers if they are not present. In the following example, replace the DNS server IP
address “[Link]” with actual DNS IP address:
NM_CONTROLLED=yes
DNS1=[Link]
Start NetworkManager:
[offline system] # systemctl enable NetworkManager
[offline system] # systemctl start NetworkManager

[Link] Verify the System Locale

Verify that the system locale is set to en_US.UTF-8.
[offline system] # cat /etc/[Link]
If the locale is not set correctly, use the following command to configure it.
[offline system] # localectl set-locale LANG=en_US.UTF-8

[Link] Create Yum Repository Configuration for Red Hat Enterprise Linux 7 with an ISO
1) Create a target directory to mount ISO image:
[offline system] # mkdir -p /media/rhel7/server
2) Download the Red Hat Enterprise Linux 7 installation ISO, copy to the internal Cisco
BroadWorks system.
3) Mount the Red Hat Enterprise Linux 7 installation ISO image:
[offline system] # mount -o loop /path/to/rhel-server-7.9-x86_64-
[Link] /media/rhel7/server
4) Check the numeric value found on the first line of the .discinfo file from the mount
directory:
[offline system] # head -n1 /media/rhel7/server/.discinfo
5) As the system will only be updated offline, all the internet-based repositories must be
removed, the operator can move these repositories to a backup location:
[offline system] # mkdir /repo-bak
[offline system] # mv /etc/[Link].d/*.repo /repo-bak
6) Create a new file in the /etc/[Link].d/ directory, named for instance
[Link], and add a content in the following form:
[rhel7-Server]
mediaid=1656416131.186722
name=RHEL7-Server-baseos
baseurl=[Link]
gpgkey=[Link]
enabled=1
gpgcheck=1
Replace media_id with the numeric value found in in /media/rhel7/server/.discinfo.
7) The operator needs an online system to download the Red Hat GPG key.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 185 OF 225

 [online system] # curl -o /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release
[Link]
8) The operator copies the /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release to the
internal Cisco BroadWorks system.
[offline system] # scp vm:/etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release
/etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release

[Link] Remove the Versionlock Plugin

The Versionlock plugin is a plugin that holds back packages from being upgraded to
newer versions. If the plugins used to lock packages to a specific version, clear the lock as
shown:
[offline system] # yum versionlock clear

[Link] Partition /var Size is Too Small

When /var is configured as a partition and the size is too small, for example 2 GB, the OS
in-place upgrade is not possible:
[offline system] # df -h /var
Filesystem Size Used Avail Use% Mounted on
/dev/sda5 2.0G 1.6G 498M 76% /var
There are two possible methods for fixing the size of the /var partition:
1) Increase the size of /var partition, the recommended /var partition size is 10 GB, the
operator may need to reach the OS vendor for support.
2) If increasing the size of /var partition is not possible, temporarily relocate the
/var/cache/yum, /var/cache/dnf and /var/lib/leapp directories to bigger partition to avoid
space a exhaustion issue, for example creating /bw/lib/leap, /bw/cache/yum,
/bw/cache/dnf directories and making soft link from /bw/lib/leapp to /var/lib/leap,
/bw/cache/yum to /var/cache/yum, /bw/cache/dnf to /var/cache/dnf:
[offline system] # rm -rf /var/cache/yum /var/cache/dnf /var/lib/leapp
[offline system] # mkdir -p /bw/lib/leapp /bw/cache/yum /bw/cache/dnf
[offline system] # ln -s /bw/lib/leapp /var/lib/leapp
[offline system] # ln -s /bw/cache/yum /var/cache/yum
[offline system] # ln -s /bw/cache/dnf /var/cache/dnf

[Link] Update to Latest OS Package

Shutdown BroadWorks applications.
[offline system] #
/usr/local/broadworks/bw_base/bin/[Link]
Update all system packages to the latest versions with Yum.
[offline system] # yum update -y
Install latest kernel. The operator needs an online system of the same Source Major
Release to download the kernel packages, for example if Source Major Release is RHEL
7.9, an online system running RHEL 7.9 is required to download the latest RHEL 7.9
kernel packages. In the example, kernel-3.10.0-1160.105.1.el7.x86_64 is the latest
kernel version for RHEL 7.9.
[online system] # yum --downloadonly --downloaddir=./ install kernel-
3.10.0-1160.105.1.el7.x86_64
The operator transfers the downloaded kernel package to the internal Cisco BroadWorks
systems and install it.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 186 OF 225

 [offline system] # yum install kernel-3.10.0-1160.105.1.el7.x86_64.rpm
-y
When the updates and the installation of latest kernel are completed, reboot the system.
[offline system] # reboot

[Link] Install the Leapp Utility

Cisco BroadWorks server needs the latest leapp packages for the upgrade. The operator
needs an online system of the same Source Major Release to download the packages, for
example if Source Major Release is RHEL 7.9, need RHEL 7.9 online system to download
RHEL 7.9 leapp packages.
[online system] # subscription-manager repos --enable rhel-7-server-rpms
--enable rhel-7-server-extras-rpms
[online system] # yum --downloadonly --downloaddir=./ install leapp-
upgrade
The operator transfers the downloaded packages to the internal Cisco BroadWorks
systems and install them.
[offline system] # yum install <all the rpms previously downloaded>

[Link] Temporarily Disable Antivirus Software

Temporarily disable antivirus software to prevent the upgrade from failing.

9.7.5 Run the OS Preupgrade Check

The OS preupgrade check ensures that the system is cleared of issues that might impede
the upgrade. It does not change the system but creates an assessment report that
identifies risks to upgrading. The report also provides recommendations for resolving
those risks.
An operator must ensure that the recommended remedies are completed to clear risks
that are labeled high and can inhibit the upgrade process.

[Link] Grant root SSH Login Permission

Grant root SSH login permissions in the /etc/ssh/sshd_config file.
PermitRootLogin yes

[Link] Run the OS Preupgrade Command

Shutdown BroadWorks applications.
[offline system] #
/usr/local/broadworks/bw_base/bin/[Link]

Mount the Red Hat Enterprise Linux 7 installation ISO image:

[offline system] # mount -o loop /path/to/rhel-server-7.9-x86_64-
[Link] /media/rhel7/server

Download the Target Major Release Binary DVD, copy to the internal Cisco BroadWorks
system. For example, the following steps use the ISO of Target Major Release RHEL 8.9
locally at /path/to/[Link].

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 187 OF 225

 Run the leapp preupgrade command offline with an iso to start the preupgrade process.
[offline system] # leapp preupgrade --no-rhsm --iso /path/to/rhel-8.9-
[Link]
Example output:
============================================================
UPGRADE INHIBITED
============================================================

Upgrade has been inhibited due to the following problems:

1. Inhibitor: Missing required answers in the answer file
Consult the pre-upgrade report for details and possible remediation.

============================================================
UPGRADE INHIBITED
============================================================

Debug output written to /var/log/leapp/[Link]

============================================================
REPORT
============================================================

A report has been generated at /var/log/leapp/[Link]

A report has been generated at /var/log/leapp/[Link]

============================================================
END OF REPORT
============================================================

Answerfile has been generated at /var/log/leapp/answerfile

A [Link] file and an answerfile are created, and debug information is saved in
a [Link] log file.

[Link] Examine the Leapp Report

Examine the [Link] file. The report provides a summary of the issues and offers
solutions to resolve them.
[offline system] # cat /var/log/leapp/[Link]
Identify any high-risk entries marked as Risk Factor: high (inhibitor). These high-risk
entries will prevent an upgrade from completing and must be resolved.
Address the reported high risks, run the preupgrade command again. In the regenerated
report, verify that all serious risks are cleared.
The following are only examples to fix high risk entries, the operator may need to reach
the OS vendor for support:
1) Disable Unused Network Interfaces
Disable unused interfaces on the server, for example eth1, ...
[offline system] # rm -Rf /etc/sysconfig/network-scripts/ifcfg-eth1
2) Rename Legacy Network Interfaces

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 188 OF 225

 Rename legacy interfaces in file /etc/udev/rules.d/[Link], if the file does
not exist, create the file. For example, to rename eth0 to enp0s4, change the line
containing eth0 MAC address (ATTR{address}=="08:00:27:d4:32:87") and update the
name attribute “eth0” ( NAME="eth0" ) with the new name “enp0s4” (NAME="enp0s4"),
make sure the name does not conflict with another existing network interface name.
SUBSYSTEM=="net", ACTION=="add", DRIVERS=="?*",
ATTR{address}=="08:00:27:d4:32:87", NAME="enp0s4"
Rename /etc/sysconfig/network-scripts/ifcfg-eth0 to /etc/sysconfig/network-scripts/ifcfg-
enp0s4, change the device name in the /etc/sysconfig/network-scripts/ifcfg-enp0s4, for
example “DEVICE=eth0” to “DEVICE=enp0s4”, and make sure eth0 MAC address is
defined, for example “HWADDR=08:00:27:d4:32:87”.
DEVICE=enp0s4
HWADDR=08:00:27:d4:32:87
NM_CONTROLLED=no
BOOTPROTO=dhcp
ONBOOT=yes
PEERDNS=no
When the rename completes, reboot the system.
[offline system] # reboot
3) Unload the No Longer Supported Kernel Modules
Unload the kernel modules that are no longer supported in RHEL 8.
[offline system] # lsmod | grep -q pata_acpi && rmmod pata_acpi
4) Increase LEAPP_OVL_SIZE
For any partition that uses XFS with the ftype option set to 0 (check with command:
xfs_info /PATH/TO/DEVICE | grep ftype), Leapp is creating a file of a specific size to
proceed with the upgrade. By default, the size of that file is 2048 MB. In case the size
needs to be increased, Leapp informs you in the pre-upgrade report that the environment
variable needs to be specified. The following example set LEAPP_OVL_SIZE to 3072.
[offline system] # export LEAPP_OVL_SIZE=3072
5) Remove Unused Third-party Packages
Remove unused third-party packages on the server, for example sysvinit-tools, uname26.
Before removing sysvinit-tools package, reinstall python-six, python-ipaddress, python-
backports, python-sssdconfig.
[offline system] # yum reinstall -y python-six python-ipaddress
python-backports python-sssdconfig
[offline system] # yum remove sysvinit-tools uname26 -y

[Link] Provide Information to the Leapp Answerfile

In addition to completing the recommendations of /var/log/leapp/[Link], operator
must also provide answers to all the items in /var/log/leapp/answerfile
[offline system] # cat /var/log/leapp/answerfile
Example output:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 189 OF 225

 [remove_pam_pkcs11_module_check]
# Title: None
# Reason: Confirmation
# =================== remove_pam_pkcs11_module_check.confirm
==================
# Label: Disable pam_pkcs11 module in PAM configuration?
If no, the upgrade process will be interrupted.
# Description: PAM module pam_pkcs11 is no longer available in
OL-8 since it was replaced by SSSD.
# Type: bool
# Default: None
# Available choices: True/False
# Unanswered question. Uncomment the following line with your answer
# confirm =

Based on the example, each verification check is identified with a section heading in
square brackets, such as remove_pam_pkcs11_module_check. The heading is followed
by descriptions of the issue and the valid responses to address the issue.
Run “leapp answer“ command on the specific section that needs to be addressed. For
example, to confirm the PAM module verification, use the following command:
[offline system] # leapp answer --section
remove_pam_pkcs11_module_check.confirm=True
Verify the answerfile has been modified.
[offline system] # cat /var/log/leapp/answerfile
Example output:
[remove_pam_pkcs11_module_check]
confirm = True

[Link] Re-run the OS Preupgrade Command

Re-Run the preupgrade command anytime to generate the report files and ensure
required items in the Leapp report and answerfile are addressed.

9.7.6 Upgrade the System

After the /var/log/leapp/answerfile has been properly completed and the
/var/log/leapp/[Link] is verified and no longer reports high risks, upgrade the
system.

[Link] Verify the Current OS and Kernel Version

For comparison to after the upgrade, verify the current OS and kernel version of the
system.
Check the Red Hat Enterprise Linux version running on the system.
[offline system] # cat /etc/redhat-release
Check the kernel version used.
[offline system] # uname -r

[Link] Run the Upgrade Command

Shutdown BroadWorks applications.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 190 OF 225

 [offline system] #
/usr/local/broadworks/bw_base/bin/[Link]
Run the upgrade command to upgrade the system offline with an iso
[offline system] # leapp upgrade --no-rhsm --iso /path/to/rhel-8.9-
[Link]
The upgrade process returns to the command prompt when finished. It takes around 15
minutes.
Example output:
The downloaded packages were saved in cache until the next successful
transaction.
You can remove cached packages by executing 'dnf clean packages'.
==> Processing phase 'InterimPreparation'
====> * efi_interim_fix
Adjust EFI boot entry for first reboot
====> * initram_disk_generator
Creates the upgrade initram disk
====> * add_upgrade_boot_entry
Add new boot entry for Leapp provided initramfs.
A reboot is required to continue. Please reboot your system.

Debug output written to /var/log/leapp/[Link]

============================================================
REPORT
============================================================

A report has been generated at /var/log/leapp/[Link]

A report has been generated at /var/log/leapp/[Link]

============================================================
END OF REPORT
============================================================

Answerfile has been generated at /var/log/leapp/answerfile

NOTE: If operator has not addressed the answerfile items and Risk Factor: high
(inhibitor) entries in the [Link] file, the process will terminate back to command line and
inform about the issues encountered.

[Link] Reboot System

When the upgrade completes, reboot the system.
[offline system] # reboot
While the system reboots, monitor the progress on the console. At the completion of the
boot process, the utility automatically proceeds with upgrading packages. This operation
takes a while to complete and includes multiple automatic reboots.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 191 OF 225

 9.7.7 Verify the Upgrade

[Link] Examine the Leapp Report

The upgrade process also updates the answerfile, [Link], and creates a leapp-
[Link] log file.
Examine the /var/log/leapp/[Link] and fulfill any important recommendations to
be completed after the upgrade process.

[Link] Verify the New OS and Kernel Version

Verify the system's new OS version, type:
[offline system] # cat /etc/redhat-release
Red Hat Enterprise Linux release 8.8 (Ootpa)
Check the system's kernel version, type this command to verify that the kernel contains
the el8 substring:
[offline system] # uname -r
4.18.0-477.27.1.el8_8.x86_64
Identify the system's default kernel contains the el8 substring with the following command:
[offline system] # grubby --default-kernel
/boot/vmlinuz-4.18.0-477.27.1.el8_8.x86_64

9.7.8 Complete Postupgrade Tasks

[Link] Update DNS server

Edit the /etc/[Link] to make sure DNS servers are present, for example:
search [Link]
nameserver [Link]

[Link] Create Yum Repository for Red Hat Enterprise Linux 8 with an ISO
Once the OS is upgraded to Red Hat Enterprise Linux 8, for systems that are
disconnected from the Internet, using the yum update or dnf update command with
the Linux installation ISO image is an easy and quick way to upgrade systems to the latest
minor version. The following steps illustrate the upgrading process with RHEL 8.9 as
example:
1) Create a target directory to mount ISO image:
[offline system] # mkdir -p /media/rhel8/server
2) Download the Red Hat Enterprise Linux 8 installation ISO, copy to the internal Cisco
BroadWorks system.
3) Mount the Red Hat Enterprise Linux installation ISO image:
[offline system] # mount -o loop /path/to/rhel-8.9-x86_64-[Link]
/media/rhel8/server
4) Check the numeric value found on the first line of the .discinfo file from the mount
directory:
[offline system] # head -n1 /media/rhel8/server/.discinfo
5) As the system will only be updated offline, all the internet-based repositories must be
removed:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 192 OF 225

 [offline system] # rm -f /etc/[Link].d/*.repo
6) Create a new file in the /etc/[Link].d/ directory, named for instance
[Link], and add a content in the following form:
[rhel8-Server-baseos]
mediaid=1698675913.54258
name=RHEL8-Server-baseos
baseurl=[Link]
gpgkey=[Link]
enabled=1
gpgcheck=1

[rhel8-Server-appstream]
mediaid=1698675913.54258
name=RHEL8-Server-appstream
baseurl=[Link]
gpgkey=[Link]
enabled=1
gpgcheck=1
Replace media_id with the numeric value found in /media/rhel8/server/.discinfo.

[Link] Re-install Removed Packages

Re-install removed packaged and start the related system services:
[offline system] # dnf install network-scripts xinetd net-snmp
initscripts -y
[offline system] # systemctl start network
[offline system] # systemctl enable network
[offline system] # systemctl start xinetd
[offline system] # systemctl enable xinetd
[offline system] # systemctl start snmpd
[offline system] # systemctl enable snmpd

[Link] Remove Remaining Leapp Packages

Edit /etc/dnf/[Link] by removing or commenting out exclude= lines that refer
to leapp packages, for example:
#exclude=python2-leapp,snactor,leapp-upgrade-el7toel8,leapp
Remove all packages from the exclude list:
[offline system] # dnf config-manager --save --setopt exclude=''

[Link] Remove Remaining RHEL 7 Packages

1) Determine old kernel versions:
[offline system] # cd /lib/modules && ls -d *.el7*
2) Remove weak modules from the old kernel. If there are multiple old kernels, repeat
the following step for each kernel:
[offline system] # [ -x /usr/sbin/weak-modules ] && /usr/sbin/weak-
modules --remove-kernel <version>
Replace <version> with the kernel version determined in the previous step, for
example:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 193 OF 225

 [offline system] # [ -x /usr/sbin/weak-modules ] && /usr/sbin/weak-
modules --remove-kernel 3.10.0-1160.102.1.el7.x86_64

NOTE: Ignore the following error message, which is generated if the kernel
package has been previously removed:

/usr/sbin/weak-modules: line 1081: cd: /lib/modules/<version>/weak-updates: No such file or

directory

3) Remove the old kernel from the boot loader entry. If there are multiple old kernels,
repeat this step for each kernel:
[offline system] # /bin/kernel-install remove <version>
/lib/modules/<version>/vmlinuz
Replace version with the kernel version determined in the previous step, for example:
[offline system] # /bin/kernel-install remove 3.10.0-
1160.102.1.el7.x86_64 /lib/modules/3.10.0-
1160.102.1.el7.x86_64/vmlinuz
4) Locate remaining RHEL 7 packages:
[offline system] # rpm -qa | grep -e '\.el[67]' | grep -vE '^(gpg-
pubkey|libmodulemd|katello-ca-consumer)' | sort
5) Remove remaining RHEL 7 packages, which are determined in the previous step,
and the kernel-workaround package from the RHEL 8 system:
[offline system] # dnf remove <Packages_from_above_output> -y
[offline system] # dnf remove kernel-workaround -y
6) Remove remaining Leapp dependency packages:
[offline system] # dnf remove leapp-deps-el8 leapp-repository-deps-
el8 -y
7) Remove any remaining empty directories:
[offline system] # rm -rf /lib/modules/*el7*
8) Remove all remaining upgrade-related data from the system:
[offline system] # rm -rf /var/log/leapp /root/tmp_leapp_py3
/var/lib/leapp
[offline system] # [ -e /bw/lib/leapp ] && rm -rf /bw/lib/leap
[offline system] # [ -e /bw/cache ] && rm -rf /bw/cache
/var/cache/dnf /var/cache/yum

[Link] Disable YUM Repositories Whose Packages are not RHEL 8-Compatible
Disable YUM repositories whose packages are not RHEL 8-compatible. Repositories
managed by RHSM are handled automatically. To disable these repositories:
[offline system] # dnf config-manager --set-disabled <repository_id>
Replace repository_id with the repository ID. The repository_id can be checked using
command "dnf repolist", for example "epel".
[offline system] # dnf config-manager --set-disabled epel

[Link] Replace the Old Rescue Kernel and Initial RAM Disk with the current kernel and disk
1) Remove the existing rescue kernel and initial RAM disk:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 194 OF 225

 [offline system] # rm /boot/vmlinuz-*rescue* /boot/initramfs-*rescue*
2) Reinstall the current kernel to recover the rescue kernel and related initial RAM disk:
[offline system] # dnf reinstall -y kernel-core-$(uname -r)
3) Verify that the old kernels have been removed from the bootloader entry:
[offline system] # grubby --info=ALL | grep "\.el7" || echo "Old
kernels are not present in the bootloader."
Old kernels are not present in the bootloader.
4) Verify that the previously removed rescue kernel and rescue initial RAM disk files
have been created for the current kernel:
[offline system] # ls /boot/vmlinuz-*rescue* /boot/initramfs-*rescue*
/boot/[Link]
/boot/vmlinuz-0-rescue-235879164e60964589a8083599251678

[offline system] # lsinitrd /boot/initramfs-*rescue*.img | grep -qm1

"$(uname -r)/kernel/" && echo "OK" || echo "FAIL"
OK
5) Verify the rescue boot entry refers to the existing rescue files. See the grubby output:
[offline system] # grubby --info $(ls /boot/vmlinuz-*rescue*)
index=1
kernel="/boot/vmlinuz-0-rescue-235879164e60964589a8083599251678"
args="ro crashkernel=auto rhgb quiet"
root="UUID=edd8dba7-198f-4e31-9215-349d0a7637ab"
initrd="/boot/initramfs-0-rescue-
[Link]"
title="Red Hat Enterprise Linux (0-rescue-
235879164e60964589a8083599251678) 8.8 (Ootpa)"
id="235879164e60964589a8083599251678-0-rescue"

[Link] Restore System Configuration Files

Restore system configuration files from backup:
[offline system] # [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/[Link]
[offline system] # [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/security/limits.d/[Link]
[offline system] # [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/cron.d/sysstat
[offline system] # [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/snmp/[Link]
[offline system] # [ -e /bw/install/[Link] ] && cp
/bw/install/[Link] /etc/[Link]
[offline system] # sysctl -p

[Link] Stop NetworkManager

Edit the network script corresponding to the interface for SSH access, for example
/etc/sysconfig/network-scripts/ifcfg-enp0s3, and disable the network manager:
NM_CONTROLLED=no
Stop NetworkManager:
[offline system] # systemctl stop NetworkManager

[Link] Run BroadWorks Post OS In-place Upgrade Script

Shutdown BroadWorks applications, start config agent and run post OS in-place upgrade
script.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 195 OF 225

 [offline system] #
/usr/local/broadworks/bw_base/bin/[Link]
[offline system] # sudo -u bworks
/usr/local/broadworks/bw_base/bin/configdctl start
[offline system] # /usr/local/broadworks/bw_base/sbin/post-
[Link]

[Link] Reboot System

Shutdown BroadWorks applications and reboot system.
[offline system] #
/usr/local/broadworks/bw_base/bin/[Link]
[offline system] # reboot

[Link] Operating System Hardening

If Cisco BroadWorks operating system hardening was enabled on old Linux version, after
OS in-place upgrade, the operator needs to run Cisco BroadWorks operating system
hardening on new Linux version.
# /usr/local/broadworks/bw_base/sbin/[Link] -mode autofix

[Link] Cleanup after OS In-place Upgrade

After the OS upgrade, delete the mounted folder, and disable the local repository and
recover the original one.
1) Run the following commands to disable the folder mounting to local ISO file.
[offline system] # cd /
[offline system] # umount /media/rhel7/server
2) Delete the ISO image and mount point.
[offline system] # rm -rf /path/to/rhel-server-7.9-x86_64-[Link]
/media/rhel7/server
3) Clean the cache and check available upgrades.
[offline system] # yum clean all
[offline system] # yum check-update

9.8 Offline CentOS 7 to Red Hat Enterprise Linux 8 In-place Upgrade Procedure
When there is no direct connection to the Internet for Cisco BroadWorks server, it is
possible to run Cisco BroadWorks OS in-place upgrade offline. This section illustrates the
steps for offline CentOS 7 to Red Hat Enterprise Linux 8 in-place upgrade.

9.8.1 Procedural Steps

1) Run Cisco BroadWorks Pre OS in-place upgrade check.
2) Perform a backup.
3) Convert CentOS 7 to Red Hat Enterprise Linux 7.
4) Perform to Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 in-place
upgrade.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 196 OF 225

 9.8.2 Run Cisco BroadWorks Pre OS In-place Upgrade Check
Run Cisco BroadWorks pre OS in-place upgrade check script with the parameter to
specify which OS version to upgrade to, for example if upgrading to Linux 8, the OS
version parameter is “8.0”. Make sure pre OS in-place upgrade check is successful. If the
pre OS in-place upgrade check fails, the BroadWorks version either needs to be upgraded
first to support the new OS version, or it is unsupported BroadWorks server, for example
DBS.
[offline system] $ [Link] 8.0
You are about to run pre OS in-place upgrade check to Linux version
8.0

*********************************************************************
**********
Do you want to continue? (y/n) [n]?y
Starting pre OS in-place Upgrade Check.

Success! Pre OS in-place upgrade check passed!

After resolving all pre OS in-place upgrade check issues, rerun the script and confirm
that there are no issues outstanding.

9.8.3 Perform a Backup

Perform a system backup of Cisco BroadWorks server and store to external location.
[offline system] $ [Link]
If environment available, take a VM snapshot of Cisco BroadWorks server.

9.8.4 Convert CentOS 7 to Red Hat Enterprise Linux 7

[Link] Check the CentOS Version

Get the version of CentOS.
[offline system] # cat /etc/redhat-release
[offline system] # cat /etc/os-release
Both commands show the instance is running CentOS 7.

[Link] Partition /var Size is Too Small

When /var is configured as a partition and the size is too small, for example 2 GB, the OS
in-place upgrade is not possible:
[offline system] # df -h /var
Filesystem Size Used Avail Use% Mounted on
/dev/sda5 2.0G 1.6G 498M 76% /var
There are two possible methods for fixing the size of the /var partition:
1) Increase the size of /var partition, the recommended /var partition size is 10 GB, the
operator may need to reach the OS vendor for support.
2) If increasing the size of /var partition is not possible, temporarily relocate the
/var/cache/yum, /var/cache/dnf and /var/lib/leapp directories to bigger partition to avoid
space a exhaustion issue, for example creating /bw/lib/leap, /bw/cache/yum,
/bw/cache/dnf directories and making soft link from /bw/lib/leapp to /var/lib/leap,
/bw/cache/yum to /var/cache/yum, /bw/cache/dnf to /var/cache/dnf:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 197 OF 225

 [offline system] # rm -rf /var/cache/yum /var/cache/dnf /var/lib/leapp
[offline system] # mkdir -p /bw/lib/leapp /bw/cache/yum /bw/cache/dnf
[offline system] # ln -s /bw/lib/leapp /var/lib/leapp
[offline system] # ln -s /bw/cache/yum /var/cache/yum
[offline system] # ln -s /bw/cache/dnf /var/cache/dnf

[Link] Create Yum Repository for CentOS 7 with an ISO

1) Create a target directory to mount ISO image:
[offline system] # mkdir -p /media/centos7/server
2) Download the CentOS 7 installation ISO, copy to the internal Cisco BroadWorks
system.
3) Mount the CentOS 7 installation ISO image:
[offline system] # mount -o loop /path/to/CentOS-7-x86_64-DVD-
[Link] /media/centos7/server
4) Check the numeric value found on the first line of the .discinfo file from the mount
directory:
[offline system] # head -n1 /media/centos7/server/.discinfo
5) As the system will only be updated offline, all the internet-based repositories must be
removed, the operator can move these repositories to a backup location:
[offline system] # mkdir /repo-bak
[offline system] # mv /etc/[Link].d/*.repo /repo-bak
6) Create a new file in the /etc/[Link].d/ directory, named for instance
[Link], and add a content in the following form:
[centos7-Server]
mediaid=1603728831.612616
name=CENTOS7-Server-baseos
baseurl=[Link]
gpgkey=[Link]
enabled=1
gpgcheck=1
gpgcheck=1
Replace media_id with the numeric value found in /media/centos7/server/.discinfo.

[Link] Update to Latest OS Package

Shutdown BroadWorks applications.
[offline system] #
/usr/local/broadworks/bw_base/bin/[Link]
Update all system packages to the latest versions with Yum.
[offline system] # yum update -y
When the updates are completed, reboot the system.
[offline system] # reboot

[Link] Install Convert2RHEL

Cisco BroadWorks server needs the latest convert2rhel packages for the upgrade. The
operator needs an online system of the same Source Major Release to download the
packages, for example if Source Major Release is CentOS 7.9, need CentOS 7.9 online
system to download CentOS 7.9 convert2rhel packages.
Download the Red Hat GPG key.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 198 OF 225

 [online system] # curl -o /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release
[Link]
Download the SSL certificate of the [Link] server, which contains the
Convert2RHEL repositories.
[online system] # curl --create-dirs -o /etc/rhsm/ca/[Link]
[Link]
Install the Convert2RHEL repository file.
[online system] # curl -o /etc/[Link].d/[Link]
[Link]
Install the Convert2RHEL.
[online system] # yum --downloadonly --downloaddir=./ install
convert2rhel
The operator transfers the packages to the internal Cisco BroadWorks system and install
them.
[offline system] # yum install <all of the rpms previously
downloaded>
The operator copies the /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release to the internal
Cisco BroadWorks system.
[offline system] # scp vm:/etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release
/etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release

[Link] Create Yum Repository for Red Hat Enterprise Linux 7 with an ISO
1) Create a target directory to mount ISO image:
[offline system] # mkdir -p /media/rhel7/server
2) Download the Red Hat Enterprise Linux 7 installation ISO, copy to the internal Cisco
BroadWorks system.
3) Mount the Red Hat Enterprise Linux 7 installation ISO image:
[offline system] # mount -o loop /path/to/rhel-server-7.9-x86_64-
[Link] /media/rhel7/server
4) Check the numeric value found on the first line of the .discinfo file from the mount
directory:
[offline system] # head -n1 /media/rhel7/server/.discinfo
5) Edit file [Link] in the /etc/[Link].d/ directory, and add section [rhel7-
Server] after section [centos7-Server] in the following form:
[centos7-Server]
mediaid=1603728831.612616
name=CENTOS7-Server-baseos
baseurl=[Link]
gpgkey=[Link]
enabled=1
gpgcheck=1

[rhel7-Server]
mediaid=1656416131.186722
name=RHEL7-Server-baseos
baseurl=[Link]
gpgkey=[Link]
enabled=1
gpgcheck=1
Replace media_id with the numeric value found in /media/rhel7/server/.discinfo.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 199 OF 225

 [Link] Run the Pre-conversion Analysis
To assess whether the system can be converted to RHEL, run the RHEL pre-conversion
analysis offline with local repositories created in previous step. The pre-conversion
analysis generates a report that summarizes potential problems and suggests
recommended solutions.
[offline system] # export CONVERT2RHEL_DISABLE_TELEMETRY=1
[offline system] # convert2rhel analyze --no-rhsm --enablerepo rhel7-
Server --enablerepo centos7-Server
After the analysis is complete, review the status and details of each completed test in the
pre-conversion report in the terminal. Non-successful tests contain a description of the
issue, a diagnosis of the possible cause of the issue, and, if applicable, a recommended
remediation.
Example output:

========== Warning (Review and fix if needed) ==========

(WARNING) PACKAGE_UPDATES::PACKAGE_NOT_UP_TO_DATE_MESSAGE - Outdated

packages detected
Description: Please refer to the diagnosis for further information
Diagnosis: The system has 4 package(s) not updated based on the
enabled system repositories.
List of packages to update: openssh-server openssh openssh-clients.

Not updating the packages may cause the conversion to fail.

Consider updating the packages before proceeding with the conversion.
Remediation: [No further information given]

After reviewing the report and resolving all reported issues, rerun the analysis and confirm
that there are no issues outstanding.

[Link] Run Convert2RHEL Utility

Shutdown BroadWorks applications.
[offline system] #
/usr/local/broadworks/bw_base/bin/[Link]
Run convert2rhel utility offline with local repositories created in previous step and wait for
it to complete.
[offline system] # export
CONVERT2RHEL_UNSUPPORTED_INCOMPLETE_ROLLBACK=1
[offline system] # convert2rhel --no-rhsm --enablerepo rhel7-Server --
enablerepo centos7-Server

[Link] Reboot System

Shutdown BroadWorks applications and reboot.
[offline system] #
/usr/local/broadworks/bw_base/bin/[Link]
[offline system] # reboot

[Link] Remove Third-party Package from Previous OS

Remove third-party packages from the original OS that remained unchanged (typically
packages that do not have a RHEL counterpart). To get a list of these packages, use:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 200 OF 225

 [offline system] # yum list extras --disablerepo="*" –-
enablerepo=<RHEL_RepoID>
Replace RHEL_RepoID with your repository in the above command. The RHEL_RepoID
can be checked using command "yum repolist", for example "rhel-7-server-rpms".
Remove third-party packages from the original OS use:
[offline system] # yum remove <package name> -y

[Link] Confirm System Switch to Red Hat Enterprise Linux

Check the distribution version and kernel details.
[offline system] # cat /etc/os-release
[offline system] # cat /etc/redhat-release
[offline system] # uname -r

9.8.5 Cleanup after Convert2RHEL

After the Convert2RHEL, delete the mounted folder, and disable the local repository and
recover the original one.
1) Run the following commands to disable the folder mounting to local ISO file.
[offline system] # cd /
[offline system] # umount /media/centos7/server
2) Edit file [Link] in the /etc/[Link].d/ directory, and remove section
[centos7-Server]
3) Delete the ISO image and mount point.
[offline system] # rm -rf /path/to/CentOS-7-x86_64-[Link]
/media/centos7/server
4) Mount the Red Hat Enterprise Linux 7 installation ISO image:
[offline system] # mount -o loop /path/to/rhel-server-7.9-x86_64-
[Link] /media/rhel7/server
5) Clean the cache and check available upgrades.
[offline system] # yum clean all
[offline system] # yum check-update

9.8.6 Perform Offline Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 In-place
Upgrade
Perform 9.7 Offline Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 In-place
Upgrade Procedure excluding the perform a backup step since the backup has been done
in 9.8.3 Perform a Backup.

9.9 Recovery of OS In-place Upgrade Failures Procedure

In the event of OS in-place upgrade failures, there are two options:
◼ Resolve the problem that was faced in the Leapp report and Leapp answer files
during the OS in-place upgrade and retry the OS in-place upgrade.
-or-
◼ Cancel the OS in-place upgrade. When OS and BroadWorks work properly, do
nothing, otherwise perform the recovery path which involves restoring VM snapshot if
available, or perform system recovery following disaster recovery strategy of Cisco
BroadWorks Maintenance Guide.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 201 OF 225

 10 Error Recovery

This section describes a list of scenarios and server behavior upon the detection of an
error during an upgrade, rollback, or patching activity of Cisco BroadWorks. The goal of
this section is to capture the expected state of a server at the end of the maintenance
activity.

10.1 Software Activation – Upgrade-related Error Recovery

10.1.1 General Cisco BroadWorks Servers Behavior

In the event of a failure during the software activation phase of Cisco BroadWorks (on an
upgrade), the installation tools always revert the application to its starting point.

10.1.2 Failure while Upgrading Application Server or Network Server Primary Node
In the event of an Application Server or Network Server primary node failure during the
software activation phase, the application and the database are automatically reverted to
their initial conditions.
Starting from Release 25.0 for the Application Server and Release 2022.02 for the
Network Server, the reverted primary server is automatically re-synchronized to its peers
and cluster replication is restarted, effectively restoring the cluster to its pre-upgrade state.
Prior to Release 25.0 for the Application Server and Release 2022.02 for the Network
Server, at the end of the revert process, even if the application is in a stable state, both the
primary server and its peer’s databases are out of synchronization. There are two options
at this point:
◼ Resolve the problem that was faced during the activation and retry the activation.
-or-
◼ Cancel the upgrade and resynchronize the peer databases. This latter action is
performed on each secondary peer by:
– Stopping Cisco BroadWorks (stopbw)
– Stopping replication (repctl stop)
– Importing the database from the primary server ([Link])
– Starting replication (repctl start)
– Starting Cisco BroadWorks (startbw)

10.1.3 Failure while Upgrading Application Server or Network Server Secondary Node
In the event of an Application Server or Network Server secondary node failure during the
software activation phase, the application and the database are automatically reverted to
their initial conditions.
It is important to note, however, that at this point, even if the application is in a stable state,
the primary server and its peers are at different releases, and hence the databases are out
of synchronization. There are two options at this point:
◼ Resolve the problem that was faced during the activation and retry the activation.
-or-

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 202 OF 225

 ◼ Cancel the upgrade, rollback the primary server, and resynchronize the peer
databases. This latter action is performed for each secondary node by applying the
operations described in the previous section.

10.2 Software Activation – Rollback-related Error Recovery

10.2.1 General Cisco BroadWorks Servers Behavior

In the event of a failure during the rollback phase of Cisco BroadWorks, the installation
tools always revert the application to its starting point.

10.2.2 Failure while Rolling Back Application Server or Network Server Primary Node
In the event of an Application Server or Network Server primary node failure during the
rollback phase, the application and the database are automatically reverted to the source
release. For example, if rolling back from Release 22.0 to Release 21.0, and there is a
failure, the Application Server ends up at Release 22.0 with the auto-backup that was
generated during the rollback from Release 22.0 to Release 21.0.
Starting from Release 25.0 for the Application Server and Release 2022.02 for the
Network Server, the reverted primary server is automatically re-synchronized to its peers
and cluster replication is restarted, effectively restoring the cluster to its pre-rollback state.
Prior to Release 25.0 for the Application Server and Release 2022.02 for the Network
Server, at the end of the revert process, even if the application is in a stable state, both the
primary server and its peers' databases are out of synchronization.
At this point, there are three options:
◼ Resolve the problem that you faced during the activation and retry the activation.
-or-
◼ Perform a revert instead of a rollback if there is an up-to-date pre-upgrade backup to
revert with.
-or-
◼ Cancel the rollback and resynchronize the peer databases. You perform this action on
each secondary peer by:
– Stopping Cisco BroadWorks (stopbw)
– Stopping replication (repctl stop)
– Importing the database from the primary server ([Link])
– Starting replication (repctl start)
– Starting Cisco BroadWorks (startbw)

10.2.3 Failure while Rolling Back Application Server or Network Server Secondary Node
In the event of an Application Server or Network Server secondary node failure during the
rollback phase, the application and the database are automatically reverted to the source
release. For example, if rolling back from Release 22.0 to Release 21.0, and there is a
failure, the Application Server ends up at Release 22.0 with the auto-backup that was
generated during the rollback from Release 22.0 to Release 21.0. That is, an import of the
primary server database is not performed.
It is important to note, however, that at this point, even if the application is in a stable state,
the primary server and its peer(s) are at different releases and hence, the databases are
out of synchronization. There are two options at this point:

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 203 OF 225

 ◼ Resolve the problem that was faced during the activation and retry the activation.
-or-
◼ Cancel the rollback, then upgrade the primary server, and resynchronize the peer
databases. This latter action is performed for each secondary node by applying the
operations described in the previous section 10.2.2 Failure while Rolling Back
Application Server or Network Server Primary Node.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 204 OF 225

 11 Appendix A: Installation Warnings

This section provides a list of possible warnings generated during a Cisco BroadWorks
installation. The warnings are copied into the
/var/broadworks/logs/installation/[Link]
file.
+++WARNING --- 1001 <You may have to install new license files>

If BroadSoft provided you with new license files, the following command
line will need to be run prior to activating the new software version:
cd /usr/local/broadworks/AS_Rel_22.0_1.1123/bin; ./[Link]
/path/to/[Link]

+++WARNING --- 1002 <You will need to manually activate the new software
version>

ssh keys between peer servers need to be fully meshed for a successful
upgrade.
If you are not sure that your keys are properly meshed, you can rerun
the following as bwadmin:

config-ssh -createKeys

Then, go to the BroadWorks CLI, change the active software version and
reset the server to make this new BroadWorks software version the active
one:

CLI> maintenance; managedobject

CLI/Maintenance/ManagedObjects> lock
CLI/Maintenance/ManagedObjects> set activeSoftwareVersion server AS
22.0_1.1123

Note that the lock action may take a few minutes. Either wait for the
server to be locked, or use the following command to force the lock:
CLI/Maintenance/ManagedObjects> lock force

+++WARNING --- 1003 <NTP automatic server configuration problem>

The installation could not find file /etc/inet/[Link] and as a

result could not automatically configure NTP.

Please refer to BroadWorks Software Management Guide for a description of

the procedure to manually configure NTP.

+++WARNING --- 1004 <NTP automatic client configuration problem>

The installation could not find file /etc/inet/[Link] and as a

result could not automatically configure NTP.

Please refer to BroadWorks Software Management Guide for a description

of the procedure to manually configure NTP.

+++WARNING --- 1005 <SYSLOG automatic configuration problem>

It appears that /etc/[Link] contains an entry for [Link].

Beware that TimesTen uses that to print debug information.
It is highly recommended that you remove/replace the following
line from /etc/[Link] (in UPPERCASE, preceded by ====>):

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 205 OF 225

 <output from syslog file>
To activate the change, issue the following command as root:

'pkill -HUP syslogd'

+++WARNING --- 1006 <TCP_wrapper automatic configuration problem>

Please make sure TCP Wrapper is properly configured. SSHD, TELNET, FTP
and
TFTP are currently using TCP Wrapper, but no hosts were automatically
configured in the hosts.[allow|deny] configuration files. Currently, the
following are allowed (from /etc/[Link]):

#By default, allow all but bwMoDaemon and bwMoDaemonRoot

ALL EXCEPT [Link]: ALL
[Link]: localhost

And the following are denied (from /etc/[Link]):

ALL:ALL

+++WARNING --- 1010 <Unreachable Primary peer>

The Primary peer address cannot be resolved: $ [Link]

Make sure your name resolution service is properly configured or that

this name is added to the server /etc/hosts file.

You must fixed this problem before re-logging as bwadmin to complete

the installation.

+++WARNING --- 1011 <Unreachable peer>

The secondary peer address cannot be resolved: $ [Link]

Make sure your name resolution service is properly configured or that

this name is added to the server /etc/hosts file.

This problem must be fixed for redundancy to properly function.

+++WARNING --- 1050 <Interface missing for IP address configuration>

Failed to configure IP address in [Link].

There is no interface configured (/var/broadworks/[Link]).
Please configure the IP address using the CLI command:
AS_CLI/System/StartupParam>set publicIPAddress <ip address>

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 206 OF 225

 12 Appendix B: SSL Key and Certification

The SSL key and certification for Apache are as follows:

◼ Creation of server encryption keys: A key size of 1024 is recommended.
◼ Certificate Signed Request (CSR): Generate a CSR that can be submitted to a
valid Certificate Authority for generation of a CA signed-certificate. The CSR step
should be skipped if the system provider has generated a CSR prior to the installation.
◼ Creation of a self-signed certificate: The self-signed certificate can be used until it is
replaced with the CA signed-certificate. Administrators are prompted for the
Distinguished Name (DN) to be used in the certificate. Administrators are also
prompted to select a pass phrase to protect the server key. Cisco BroadWorks does
not provide pass phrase support. The server key is inherently protected by its
placement in a protected directory. The administrator should NOT select a pass
phrase and should answer “no” to the question, “Would you like to encrypt? [Y/N]”.

NOTE: For more information, see the Cisco BroadWorks SSL Support Options Guide.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 207 OF 225

 13 Appendix C: Non-interactive Installation

13.1 Format of Silent Installation File

The following shows an example of an installation configuration file. This file represents an
installation configuration file that can be used to install a Cisco BroadWorks server.
#
# This file was auto-generated by the BroadWorks [Link] tool
# Created on: Tue Jul 21 07:44:43 2015
#
BROADWORKS_USERNAME=adminbw
BWKEY=adminbw
SERVER_TYPE=NetworkServer
USESSL=true
FULLSSL=false
REDHOSTNAME=MTLNS01
REDPRIMARYHOSTNAME=MTLNS01
REDUNDANTSERVER=true
REDPRIMARY=true
REDPEERS={MTLNS01->MTLNS01,MTLNS02->MTLNS02,}
REDREPPORT=17888
HAS_DATABASE=true
DSN_SIZE=512
TEMP_SIZE=170
JASS=true
FTP_ON=true
TFTP_ON=false
TELNET_ON=true
NTP_CONFIG=CLIENT
NTP_SERVER=chablis
LICENSE_FILE=/export/home/bwadmin-old/license-backup/[Link]
INTERFACE=1,qfe0,[Link],[Link],true,true,true
INTERFACE=2,qfe1,[Link],solns,false,false
DIALPLAN.1=TRUE
ALIAS=ns1
APACHEHOSTNAME=[Link]
SERVER_DSN=NetworkServer
SERVER_CLIENT_DSN=NetworkServerClient
MAINTENANCE_DSN=Maintenance
MAINTENANCE_CLIENT_DSN=MaintenanceClient
SERVER_PHYSICAL_STORE=NetworkServer
HARDENING=true
OS_HARDENING=true
SKIP_PROMPT=false

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 208 OF 225

 The file uses a KEY=VALUE format, where the KEY can be one of the following formats.
Key Description Applicable Servers Value and Format

GENERAL

SERVER_TYPE The type of server to ALL CHOICE = {

install. ApplicationDeliveryPlatform,
ApplicationServer,
DatabaseServer,
ExecutionServerDataless,
MediaServer,
NetworkDatabaseServer,
NetworkFunctionManager,
NetworkServer,
ProfileServer,
ServiceControlFunction,
VideoServer,
WebRTCServer,
XtendedServicesPlatform }

LICENSE_FILE The license file path (zip ALL STRING

file path), where the
license zip file can be
found on the server.

SKIP_PROMPT Skip user input prompts, ALL CHOICE= {true, false}

enabling a non-
interactive install.

OS

BROADWORKS_ The Cisco BroadWorks ALL STRING

USERNAME default administrator user
ID.

BWKEY The Cisco BroadWorks ALL STRING

default administrator user
ID’s password in base64.

JASS Indicate if the Cisco ALL CHOICE= {true, false}

BroadWorks JASS-
specific packaging
should be applied or not
to the target server.

FTP_ON Specify if the FTP access ALL CHOICE= {true, false}

should be disabled.

TELNET_ON Specify if telnet access ALL CHOICE= {true, false}

should be disabled.

TFTP_ON Specify if TFTP should ALL CHOICE= {true, false}

be enabled.

TFTP_ROOT_DIR If TFTP_ON=true, this is ALL STRING

used to specify the target
TFTP root directory.

NTP_CONFIG Specify if the server is to ALL CHOICE= {CLIENT,

be a NTP client or SERVER}
server.

NTP_SERVER If NTP_CONFIG = ALL STRING

CLIENT, specify the NTP
server address.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 209 OF 225

 Key Description Applicable Servers Value and Format

INTERFACE Define the configuration ApplicationServer, Values of ID, interfaceName,

for each interface on the NetworkServer address, apacheHostname,
server (with one entry ElementManagement is Enabled, isPrimaryWsf,
per interface). System isMediaServer
Where:
▪ ID is an integer {0, 1, 2, …}
▪ interfaceName: STRING
▪ address: STRING
▪ isEnabled: CHOICE=
{true,false}
▪ isPrimaryWsf: CHOICE=
{true,false}
▪ isMediaServer: CHOICE=
{true,false}

VIRTUALIZATION_ON Specify if this server is a ALL CHOICE= {true, false}

virtualized server.

VIRTUALIZATION_ Specify the hostname/IP ALL STRING

HOST address of the virtualized
host server (VLS)

VIRTUALIZATION_ Specify if the fetching of ALL CHOICE= {true, false}

SKIP_FETCH the host certificate
should be skipped. When
set to true the certificate
will not be fetched during
the installation and thus
must be manually
transferred after the
installation. When set to
false the installation
becomes interactive and
the host’s bwadmin
password will be asked
to complete the transfer
of the certificate.

OS_HARDENING Indicate if operating ALL CHOICE= {true, false}

system hardening
configuration is applied
during installation.

Redundancy

REDUNDANTSERVER Specify if this server is ApplicationServer, CHOICE= {true, false}

deployed as part of a NetworkServer,
redundant cluster or not. WebServer,
ElementManagement
System

REDHOSTNAME The peer name (host ApplicationServer, STRING

name) of the target NetworkServer,
server. WebServer,
ElementManagement
System

REDPRIMARYHOST The peer name of the ApplicationServer, STRING

NAME cluster primary server. NetworkServer,
WebServer,
ElementManagement
System

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 210 OF 225

 Key Description Applicable Servers Value and Format

REDPRIMARY Specify if this server is a ElementManagement CHOICE= {true, false}

primary server. This System
parameter is required
even in a non-redundant
configuration in which
case the value is “true”.

REDPEERS The list of peers, which ApplicationServer, Comma separated

only applies to a primary NetworkServer, STRINGS wrap within {}, for
server. WebServer, example:
ElementManagement {STRING, STRING, …, }
System

REDREPPORT The port number ApplicationServer, STRING

TimesTen uses for NetworkServer
replication only applies to
a primary server.

Database

HAS_DATABASE Indicates if this server ALL CHOICE= {true, false}

has a database. true: Must be “true” for the
ApplicationServer and
NetworkServer.
false: otherwise

SERVER_DSN This applies when ApplicationServer, CHOICE=

HAS_DATABASE =true, NetworkServer {ApplicationServer,
name of the server DSN. NetworkServer}

SERVER_CLIENT_ This applies when ApplicationServer, CHOICE=

DSN HAS_DATABASE =true, NetworkServer {ApplicationServerClient,
name of the client DSN. NetworkServerClient}

MAINTENANCE_DSN This applies when ApplicationServer, CHOICE= {Maintenance}

HAS_DATABASE =true, NetworkServer
name of the maintenance
DSN.

MAINTENANCE_ This applies when ApplicationServer, CHOICE=

CLIENT _DSN HAS_DATABASE =true, NetworkServer {MaintenanceClient}
name of the maintenance
client DSN.

SERVER_PHYSICAL_S This applies when ApplicationServer, CHOICE=

TORE HAS_DATABASE =true, NetworkServer {ApplicationServerClient,
name of the database NetworkServerClient}
storage file.

DSN_SIZE This applies when ApplicationServer, For a list of valid DSN sizes,
HAS_DATABASE =true, NetworkServer see section [Link].10
database total size. Configure Database Pre-
defined Size.

TEMP_SIZE This applies when ApplicationServer, For a list of valid TEMP DSN
HAS_DATABASE =true, NetworkServer sizes, see section [Link].10
temporary store size. Configure Database Pre-
defined Size.

MYSQL_INIT_SIZE Specify the initial size of CallDetailServer, CHOICE= {500M, 1G, 5G,
the MySQL database. ElementManagement 20G, 35G}
System

Application Server

VIRTUALDOMAIN Specify the Application ApplicationServer STRING

Server virtual domain.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 211 OF 225

 Key Description Applicable Servers Value and Format

IMS_MODE Indicate if this server ApplicationServer CHOICE= {true, false}

runs in IMS mode

USE_TT_LOG_DIR The directory used to ApplicationServer, CHOICE= {true, false}

store the database logs NetworkServer
is
/usr/local/broadworks/$b
w_version/persistentLogs
.

APP_SERVER_ID Specify the Application ApplicationServer STRING

Server ID.

HARDENING Indicate if security and ApplicationServer CHOICE= {true, false}

call processing
hardening configuration
is applied during
installation.

Network Server

[Link] Installs the default dial NetworkServer CHOICE= {TRUE}

plan for the country code The list of supported default
specified by the CC dial plans is augmented for
value, for example, 1. each release of Cisco
BroadWorks. The list of
default dial plans can be
obtained from the file
[Link] located in
/usr/local/broadworks/bw_ba
se/persistent/setup/dataoptio
nal/.

ALIAS The name of a valid alias NetworkServer STRING

for this server. There can
be 0 or more alias
entries.

Database Server

DBS_DB_BASE_ The name of the DatabaseServer STRING

NAME database base (default:
bwCentralizedDb).

ORAUSERKEY Base64 encoded DatabaseServer STRING

password of oracle Unix
user

ORASYSKEY Base64 encored DatabaseServer STRING

password of oracle sys
database user

REDUNDANTSERVER Indicate if this server is DatabaseServer CHOICE= {true, false}

part of a georedundant
Data Guard
configuration.

PRIMARY_DBS Indicate if this server is in DatabaseServer CHOICE= {true, false}

the primary site.

DBS_DATAGUARD_ Indicate the peer name DatabaseServer STRING

PEER of the georedundant
Data Guard peer.

DBS_ASM_DATA Specify the list of ASM DatabaseServer STRING

disks in the DATA disk
group. This is a comma-
separated list.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 212 OF 225

 Key Description Applicable Servers Value and Format

DBS_ASM_DATA_ Indicate the ASM DATA DatabaseServer CHOICE= {NORMAL,

REDUNDANCY disk group redundancy EXTERNAL}
type (NORMAL or
EXTERNAL).

DBS_ASM_RECO Specify the list of ASM DatabaseServer STRING

disks in the FRA disk
group. This is a comma-
separated list.

DBS_ASM_RECO_ Indicate the ASM FRA DatabaseServer CHOICE= { NORMAL,

REDUNDANCY disk group redundancy EXTERNAL }
type (NORMAL or
EXTERNAL).

DBS_ASM_CRS_ Indicate the CRS DATA DatabaseServer CHOICE= { NORMAL,

REDUNDANCY disk group redundancy EXTERNAL }
type (NORMAL or
EXTERNAL).
Only used in cluster
deployment.

DBS_IPV6_ONLY Indicate if this DBS is DatabaseServer CHOICE= {true, false}

deployed on an IPv6-only
network.

BWKEY BroadWorks user All STRING

password, Base64.

ADMIN_USERNAME System administrator ID. AS, NS STRING

ADMINKEY System administrator AS, NS STRING

initial password, Base64.

TTKEY TimesTen schema user’s AS, NS, DTS STRING

password, Base64.

MDBKEY MariaDB bwadmin user’s NFM, NDS STRING

password, Base64.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 213 OF 225

 14 Appendix D: Database Logging to Different Disk on x86_64 Hardware

This section presents a procedure for writing database log files to a different disk on a
server housed on x86_64 hardware. For optimum performance, the hardware used for
Cisco BroadWorks Application Servers requires that TimesTen database log files be
written to a dedicated drive and not to the existing hard drive. Depending on your specific
hardware requirements, you may write the database logs to an alternate volume/device as
long as the log files are hosted on a separate physical disk.
This split-disk architecture is supported as part of the standard release installation. This
section outlines flash drive installation and configuration procedure which is comprised of
the following two components:
◼ Disk Drive Basic Configuration: Physical installation, drive formatting, and partition
mounting
◼ TimesTen Reconfiguration: Changing [Link] file to alter logging to use the
newly installed flash drive, activating the changes
For server clusters already in production, the entire procedure (flash drive basic
configuration and TimesTen reconfiguration) should be completed on the primary server
with validation that the server is functioning properly before proceeding to the secondary
server. For new servers, prior to Cisco BroadWorks installation, only section 14.1 Disk
Drive Basic Configuration must be completed as the installer automatically takes care of
the rest of the configuration.

14.1 Disk Drive Basic Configuration

The following sections present the detailed steps for configuring the disk drive on Linux
Operating System (OS).

14.1.1 Linux
This section describes how to configure a separate disk for database logging, using as an
example, an 8 GB modular flash drive recommended (for example) for IBM HS21 XM
blades running Linux OS. Disk drive basic configuration can be done prior to Cisco
BroadWorks installation for new systems or post-Cisco BroadWorks installation for
existing deployment.
1) Physically install the 8 GB modular flash drive following the instruction provided with
the device.
2) Once the server has rebooted, confirm the flash drive is visible by executing the fdisk
–l command as root. The drive should appear as the /dev/sdb1 device.
[root@as20-hs21 bwadmin]# fdisk -l

Disk /dev/sda: 73.4 GB, 73407488000 bytes

255 heads, 63 sectors/track, 8924 cylinders
Units = cylinders of 16065 * 512 = 8225280 bytes

Device Boot Start End Blocks Id System

/dev/sda1 * 1 13 104391 83 Linux
/dev/sda2 14 778 6144862+ 82 Linux swap
/dev/sda3 779 8924 65432745 83 Linux

Disk /dev/sdb: 8399 MB, 8399978496 bytes

64 heads, 32 sectors/track, 8010 cylinders
Units = cylinders of 2048 * 512 = 1048576 bytes

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 214 OF 225

 Device Boot Start End Blocks Id System
/dev/sdb1 * 1 8010 8202224 83 WIN95,FAT32

3) As root, reformat the drive.

[root@as20-hs21 bwadmin]# fdisk /dev/sdb

Command (m for help): p

Disk /dev/sdb: 8399 MB, 8399978496 bytes

64 heads, 32 sectors/track, 8010 cylinders
Units = cylinders of 2048 * 512 = 1048576 bytes

Device Boot Start End Blocks Id System

/dev/sdb1 1 8010 8202224 83 Linux

Command (m for help): d

Selected partition 1
Command (m for help): w

4) At this point, you have a device without any partition. Create a blank partition.
[root@as21-hs21 bwadmin]# fdisk /dev/sdb

Command (m for help): n

Command action
e extended
p primary partition (1-4)
p
Partition number (1-4): 1
First cylinder (1-8010, default 1):
Using default value 1
Last cylinder or +size or +sizeM or +sizeK (1-8010, default 8010):
Using default value 8010

Command (m for help): a

Partition number (1-4): 1

Command (m for help): p

Disk /dev/sdb: 8399 MB, 8399978496 bytes

64 heads, 32 sectors/track, 8010 cylinders
Units = cylinders of 2048 * 512 = 1048576 bytes

Device Boot Start End Blocks Id System

/dev/sdb1 * 1 8010 8202224 83 Linux

Command (m for help): w

The partition table has been altered!

Calling ioctl() to re-read partition table.

5) As root, format the new partition by issuing the mke2fs/dev/sdb1 command.

root@as20-hs21$ mke2fs /dev/sdb1

6) Create a mount point for the partition. Make a backup of /etc/fstab; then as root edit
file fstab and add the following line:
/dev/sdb1 /persistentLogs auto defaults 1 3

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 215 OF 225

 7) Reboot the server and confirm that the auto-mount was successful.
bwadmin@as20-hs21$ cd /persistentLogs

bwadmin@as20-hs21$ df .
Filesystem 1K-blocks Used Available Use% Mounted on
/dev/sdb1 8073380 92084 7571188 2% /persistentLogs

8) As root, change /persistentLogs permissions.

root@as20-hs21$ chmod 777 /persistentLogs

9) For existing installations, complete the TimesTen reconfiguration steps (outlined in the
following section) on the primary server before proceeding to the secondary server.
For new installation, the flash drive can be on the secondary server before the Cisco
BroadWorks installation and TimesTen reconfiguration.

14.2 TimesTen Reconfiguration

Prior to beginning this part of the procedure, Cisco BroadWorks should be properly
installed and fully functional on both the primary and secondary servers. For fresh installs,
this means performing the usual Cisco BroadWorks installation following the steps
outlined in this document. Once both servers are installed, ensure that healthmon –d
returns no errors. This part of the procedure should always be executed on the primary
server first.
1) Create the softlink back to the /persistentLogs directory that is used by TimesTen. As
bwadmin, use the ln –s command to create a symbolic link from
/var/broadworks/persistentLogs to /persistentLogs.
bwadmin@as20-hs21$ ln -s /persistentLogs /var/broadworks/persistentLogs

2) On the primary server, back up the existing database.

bwadmin@as20-hs21$ [Link] AppServer BACKUP_PREFLASH.bkp

3) As bwadmin, on both primary and secondary servers, lock the database using the
peerctl lock command.
bwadmin@as20-hs21$ peerctl lock

4) The application and replication are stopped and the TimesTen database is unloaded.
bwadmin@as20-hs21$ stopbw
bwadmin@as20-hs21$ repctl stop
bwadmin@as20-hs21$ [Link] unload

5) As root, make a backup of in /var/TimesTen/[Link] and modify the file by adding

the parameter LogDir=/var/broadworks/persistentLogs. Make sure to modify the
[Appserver], [Maintenance], and [TTAdmin] DSN entries. The following is a sample of
the post configuration.
[ODBC Data Sources]
AppServer=TimesTen 11.2.1 Driver
AppServerClient=TimesTen 11.2.1 Client Driver
Maintenance=TimesTen 11.2.1 Driver
MaintenanceClient=TimesTen 11.2.1 Client Driver

##############################################################
# Data source for AppServer

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 216 OF 225

 ##############################################################
[AppServer]
Driver=/usr/local/TimesTen/tt_base/lib/[Link]
DataStore=/var/broadworks/persistent/AppServer
AutoCreate=0
CkptFrequency=600
CkptLogVolume=160
CkptRate=16
Connections=256
DurableCommits=0
ExclAccess=0
Isolation=1
LockLevel=0
Logging=1
LogBufMB=100
LogFileSize=8
LogPurge=1
MatchLogOpts=0
MemoryLock=0
OverWrite=0
PermSize=12288
Preallocate=0
Temporary=0
TempSize=4096
ThreadSafe=1
WaitForConnect=0
TypeMode=1

LogDir=/var/broadworks/persistentLogs

############################################################
# Data source for AppServerClient
###########################################################
[AppServerClient]
TTC_SERVER=localhost_domainsocket
TTC_SERVER_DSN=AppServer

##########################################################
# Data source for AppServer
##########################################################
[Maintenance]
Driver=/usr/local/TimesTen/tt_base/lib/[Link]
DataStore=/var/broadworks/persistent/AppServer
AutoCreate=0
CkptFrequency=600
CkptLogVolume=160
CkptRate=16
Connections=256
DurableCommits=0
ExclAccess=0
Isolation=1
LockLevel=0
Logging=1
LogBufMB=100
LogFileSize=8
LogPurge=1
MatchLogOpts=0
MemoryLock=0
OverWrite=0
PermSize=12288
Preallocate=0

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 217 OF 225

 Temporary=0
TempSize=4096
ThreadSafe=1
WaitForConnect=0
TypeMode=1
LogDir=/var/broadworks/persistentLogs

##############################################################
# Data source for AppServerClient
##############################################################
[MaintenanceClient]
TTC_SERVER=localhost_domainsocket
TTC_SERVER_DSN=Maintenance

#####################################################################
# Data source for TTADMIN
#####################################################################
[TTAdmin]
Driver=/usr/local/TimesTen/tt_base/lib/[Link]
DataStore=/var/broadworks/persistent/AppServer
AutoCreate=0
CkptFrequency=600
CkptLogVolume=160
CkptRate=16
Connections=256
DurableCommits=0
ExclAccess=0
Isolation=1
LockLevel=0
Logging=1
LogBufMB=100
LogFileSize=8
LogPurge=1
MatchLogOpts=0
MemoryLock=0
OverWrite=0
PermSize=12288
Preallocate=0
Temporary=0
TempSize=4096
ThreadSafe=1
WaitForConnect=0
TypeMode=1
LogDir=/var/broadworks/persistentLogs

6) Depending on whether the server is a primary server or a secondary server, do the

following:
– For the primary server, the backed up database is restored. Then replication and
the application are restarted.
bwadmin@as20-hs21$ [Link] AppServer BACKUP_PREFLASH.bkp
bwadmin@as20-hs21$ repctl start
bwadmin@as20-hs21$ startbw

– For secondary server, an import from the primary server is performed. Then
replication and the application are restarted.
bwadmin@as21-hs21$ [Link] –noBackup -noCheck AppServer as20-hs21
AppServer
bwadmin@as21-hs21$ repctl start
bwadmin@as21-hs21$ startbw

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 218 OF 225

 7) As bwadmin, on both primary and secondary servers, make sure the databases are
unlocked using the peerctl unlock command.
bwadmin@as20-hs21$ peerctl unlock

8) Verify that the server has started properly and that the database can be accessed by
logging into the CLI. Make sure that healthmon –d reports no errors.
9) Make sure the /var/broadworks/persistentLogs contains one or more TimesTen log
files.
bwadmin@as20-hs21$cd /var/broadworks/persistentLogs
bwadmin@as20-hs21$ ls –lrt
-rw-rw-rw- 1 root root 3014656 Mar 11 13:49 AppServer.log379

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 219 OF 225

 15 References

None.

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 220 OF 225

 16 Acronyms and Abbreviations

ADP Application Delivery Platform

AP Application Patch
ARP Address Resolution Protocol
AS Application Server
ASM Automatic Storage Management
CCR Call Center Reporting
CDS Call Detail Server
CIS Center for Internet Security
CLI Command Line Interface
CMS Client Management System
CPU Central Processing Unit
CRS Call Recording Server
CSR Certificate Signed Request
DAD Duplicate Address Detection
DBS Database Server
DN Distinguished Name
DNS Domain Name Server
DSN Database Store Name
DST Daylight Savings Time
EMS Element Management System
FTP File Transfer Protocol
HZS Hazelcast Server
IMS IP Multimedia Subsystem
JASS JumpStart Architecture and Security Scripts
JRE Java Runtime Environment
LDAP Lightweight Directory Access Protocol
LVM Logical Volume Manager
MBR Master Boot Record
MIB Management Information Base
MS Media Server
NDS Network Database Server
NFM Network Function Manager
NIC Network Interface Card
NS Network Server

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 221 OF 225

 NTP Network Time Protocol
OS Operating System
PB Patch Bundle
PS Profile Server
RAC Real Application Cluster
RAID Redundant Array of Independent Disks
RHEL Red Hat Enterprise Linux
RPM RPM Package Manager
SBC Session Border Control
SCF Service Control Function
SIP Session Initiation Protocol
SNMP Simple Network Management Protocol
SSH Secure Shell
SSL Secure Sockets Layer
TCP Transmission Control Protocol
TFTP Trivial File Transfer Protocol
TZ Time Zone
VLS Virtualized Licensing Server
VM Virtual Machine
XFS X File System
XS Execution Server
XSA Execution Server Amplify
Xsp Xtended Services Platform
ZFS Z File System

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 222 OF 225

Index

/etc/hosts, 68 Default dial plans, 94

/etc/sysconfig/network, 68 Default directory for Cisco BroadWorks license
files, 90
Activating new software version, 107
Default router, 71
Additional software packages, 75, 76 Name resolution, 72
Administrative account, bwadmin, 97 Net SNMP Subagent on Linux, 99
Apache, SSL key, and certification, 139 Netmask, 72
Application Server Net-SNMP for IPv6, 73
ID, configuring, 93 NTP, 90
IMS mode, 94 Registration extension, 107
bwadmin account management, 97 Server default aliases, 93
Changes, 24 Server in IMS mode, 94
System domain, 93
Active software version, 112
Time zone, 72
Cisco BroadWorks
Copying Cisco BroadWorks software on target
Copying software on target platform, 82
Error recovery, 134 platform, 82, 104
General rules, 45 From CD, 82, 104
Installation From software image, 83
Interactive, 86 Verifying integrity of software image, 83, 104
Non-interactive, 85 Database logging
Non-redundant servers, 47 Different disk on x86_64 Hardware, 146
Order, 46 Disk drive basic configuration, Linux, 146
Prerequisites, 82 x86_64 Hardware, 146
Redundant servers, 49 Daylight Saving Time version in JRE software, 103
Software, 85 Default
Patching Dial plans, 94
Non-redundant servers, 47 Directory for license files, 90
Procedures, 121 Router configuration, 71
Redundant servers, 49 Disk drive basic configuration, 146
Rollback procedures, 112
Disk mirroring, 67
Service pack, 47
Software compatibility rules, 47 Disk space requirements, 103
Software management, 45 Document changes, 24
Upgrade DSN requirements, 103
Non-redundant servers, 47 Enabling
Order, 46 System activity reporting, 79
Procedure, 102 TimesTen SNMP traps reporting, 98
Redundant servers, 49 Error recovery, 134
User name, 89 Rollback-related, 135
Cisco BroadWorks patch Software activation, 134, 135
Applying, 124 Upgrade-related, 134
Deleting, 129 External disk for database logging, 91
History, 129
Failure upgrading Application and Network Server
Installing, 122
Primary node, 134, 135
Modifying file, 130
Secondary node, 134, 135
Removing, 126
Software Manager database backup and File system logging, 67
restore, 133 Flash drive basic configuration, TimesTen
Software Manager logging, 132 reconfiguration, 148
Upgrading Software Manager, 131 Installing
Configuring bwadmin account management, 97
Application Server ID, 93 Cisco BroadWorks
Basic maintenance tasks, 94 Copying software on target platform, 82
Data redundancy, 91 From CD, 104
Database pre-defined size, 91 Interactively, 86

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 223 OF 225

 Log files, 97 Patch management, 121
Major tasks, 54 Patching
Non-interactively, 85 Applying patch
Prerequisites, 82 Steps, 124
Software, 85 Via CLI, 124
Warnings, 137 Via SNMP, 126
Enabling system activity reporting, 79 Deleting patch
JRE software, 99 Steps, 129
Linux, 54 Via CLI, 129
Additional software packages, 75, 76 Via SNMP, 129
Booting from media, 58 History, steps, 129
Disk mirroring with Solstice DiskSuite, 67 Installing patch, 122
Disk partitioning, 56 Bundle, 123
Moving from Red Hat Enterprise 5 or 6 to Steps, 122
7, 81 Linux, 81
Postinstallation configuration, 67 Modifying file, steps, 130
Setting parameters, 55 OS, 122
Operating system, overview, 54 Procedures, 121
Sanity, checking, 96 Removing patch
Time zone/daylight saving time, 99 Steps, 126
Interactive installation Via CLI, 127
Configuring, 88 Via SNMP, 129
Post-installation, 95 Viewing
Sanity checks, 96 Modified files
Starting, 86 Via CLI, 130
Starting Cisco BroadWorks, 95 Via SNMP, 131
IP multipathing, 69 Patch history
IPv6, Net-SNMP configuration, 73 Via CLI, 130
Known limitations, 101 Via SNMP, 130
LDAP Post-installation, 86, 95
Client, 90 Post-Linux
Master server, 90 /etc/hosts, 68
Linux /etc/sysconfig/network, 68
Configuring disk drive for database logging, 146 Default router configuration, 71
Configuring Net SNMP subagent, 99 IP multipathing, 69
Installing, 54 Name resolution configuration, 72
Additional software packages, 75, 76 Netmask configuration, 72
Booting from installation media, 58 System logging, 67
Disk partitioning, 56 Time zone configuration, 72
Post installation configuration, 67 Preinstallation validation tool, 102
Setting parameters, 55 Primary node, failure upgrading, 134, 135
Patching, 81 Purpose, 43
Updates, 67, 97 Red Hat Enterprise Linux, moving to version 7, 81
Upgrading Red Hat Enterprise to version 7, 81
Red Hat packages, installing
Log files, Cisco BroadWorks installation, 97 From DVD, 75
Moving Red Hat Enterprise Linux 5 or 6 to Linux 7, With subscription manager, 76
81 Redundant servers, installing, upgrading, and
Name resolution configuration, 72 patching, 49
Netmask configuration, 72 Registration extension, 107, 109, 120
Net-SNMP configuration for IPv6, 73 Restoring registration extension, 109
Network Server Rollback procedure, 112
Default aliases, 93 Additional notes, 119
New software, 107 Changing active software version, 112
Non-interactive installation, 85, 140 Configuring registration extension, 112
Non-redundant servers, installing, upgrading, Previous version, 112, 120
Registration extension, 112
patching procedure, 47
Restoring registration extension, 120
OS patching, 122 Steps, 112
OS, booting from installation media, 58 Rollback-related error recovery

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 224 OF 225

 Failure upgrading Application and Network Installation, 110
Server Software activation, 110
Primary node, 135 Upgrading sanity checks, 110
Secondary node, 135 Updating
General servers, 135 Linux, 67, 97
Sanity checks Upgrade-related error recovery
Installation, 96 Failure upgrading Application and Network
Troubleshooting, 110 Server
Secondary node, failure upgrading, 134, 135 Primary node, 134
Service pack, 47 Secondary node, 134
Silent installation file format, 140 General servers, 134
Software Upgrading
Activation, troubleshooting, 110 Best practices, 52
Compatibility rules, 47 Cisco BroadWorks, 108
Management overview, 44 Disk space and DSN requirements, 103
Installing Cisco BroadWorks software, 105
Software packages, required for Cisco BroadWorks,
Localizing Cisco BroadWorks server, 109
75, 76 Over Telnet/SSH
Starting Activating new software, 107
Cisco BroadWorks, 95 Configuring registration extension, 107
Interactive installation, 86 Restoring registration extension, 109
Supported operating systems, 51 Post-installation, 105
System activity report, 79 Preinstallation validation tool, 102
Enabling, 79 Preupgrade steps, 102
Viewing results, 80 Procedure, 102, 103
System domain, configuring, 93 Time zone/Daylight Saving Time version in JRE
Tech support, sending information to Cisco, 100 software, 103
Troubleshooting
Third-party software packages, 75, 76 Sanity checks, 110
Time zone Software activation, 110
Configuration, 72 Validation tool, 102
Version in JRE software, 99, 103
Verifying software image integrity, 83, 104
TimesTen
Warnings, installation, 137
Reconfiguration, 148
SNMP traps reporting, 98 x86_64 Hardware, database logging, different disk,
Troubleshooting, 110 146

CISCO BROADWORKS SOFTWARE MANAGEMENT GUIDE PAGE 225 OF 225